Commands
Onteon CLI - commands¶
Application¶
delete¶
Name
onteoncli-application-delete - The delete command tries to delete application by id or name with version (in format '
Synopsis
onteoncli application delete [-h] [--output\=] [-v\=
Description
The delete command tries to delete application by id or name with version (in format '
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Application's id or name with version ('
get¶
Name
onteoncli-application-get - The get command tries to find application by id or name with version (in format '
Synopsis
onteoncli application get [-h] [--output\=] [-v\=
Description
The get command tries to find application by id or name with version (in format '
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Application's id or name with version ('
list¶
Name
onteoncli-application-list - The list command lists all applications with pagination.
Synopsis
onteoncli application list [-h] [--application-name\=
Description
The list command lists all applications with pagination.
Options
--application-name\=
Filter applications by application's name.
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
--page\=
Page number.
--per-page\=
Number of items per page.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
application-change¶
create¶
Name
onteoncli-application-change-create - The create command creates new application change.
Synopsis
onteoncli application-change create [-h] [--output\=] [-v\=
Description
The create command creates new application change.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Old application's id.
New application's id.
application-instance¶
create¶
Name
onteoncli-application-instance-create - The create command creates new application's instance on node.
Synopsis
onteoncli application-instance create [-h] [--output\=] [-v\=
Description
The create command creates new application's instance on node.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Application's id.
Node's id.
delete¶
Name
onteoncli-application-instance-delete - The delete command deletes application instance by id.
Synopsis
onteoncli application-instance delete [-h] [--output\=] [-v\=
Description
The delete command deletes application instance by id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Application instance's id.
details¶
Name
onteoncli-application-instance-details - The details command shows application instance's details.
Synopsis
onteoncli application-instance details [-h] [--output\=] [-v\=
Description
The details command shows application instance's details.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Application instance's id.
execute-action¶
Name
onteoncli-application-instance-execute-action - The execute-action command executes action on application's instance by id.
Synopsis
onteoncli application-instance execute-action [-h] [--output\=][-v\=
Description
The execute-action command executes action on application's instance by id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Application's instance id.
Name of action.
get¶
Name
onteoncli-application-instance-get - The get command finds application instance by id.
Synopsis
onteoncli application-instance get [-h] [--output\=] [-v\=
Description
The get command finds application instance by id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Application instance's id.
list¶
Name
onteoncli-application-instance-list - The list command lists all application instances with pagination.
Synopsis
onteoncli application-instance list [-h] [--node-id\=
Description
The list command lists all application instances with pagination.
Options
-h, --help
Show this help message and exit.
--node-id\=
Filter application instances by node's id.
--output\=
Output format. Supported values: text, json.
--page\=
Page number.
--per-page\=
Number of items per page.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
restart¶
Name
onteoncli-application-instance-restart - The restart command restarts application's instance by id.
Synopsis
onteoncli application-instance restart [-h] [--output\=] [-v\=
Description
The restart command restarts application's instance by id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Application's instance id.
start¶
Name
onteoncli-application-instance-start - The start command starts application's instance by id.
Synopsis
onteoncli application-instance start [-h] [--output\=] [-v\=
Description
The start command starts application's instance by id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Application's instance id.
stop¶
Name
onteoncli-application-instance-stop - The stop command stops application's instance by id.
Synopsis
onteoncli application-instance stop [-h] [--output\=] [-v\=
Description
The stop command stops application's instance by id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Application's instance id.
terminate¶
Name
onteoncli-application-instance-terminate - The terminate command stops forcibly application's instance by id.
Synopsis
onteoncli application-instance terminate [-h] [--output\=] [-v\=
Description
The terminate command stops forcibly application's instance by id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Application's instance id.
application-registry¶
list¶
Name
onteoncli-application-registry-list - The list command lists all entries in application registry with pagination.
Synopsis
onteoncli application-registry list [-h] [--output\=] [--page\=
Description
The list command lists all entries in application registry with pagination.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
--page\=
Page number.
--per-page\=
Number of items per page.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
upload¶
Name
onteoncli-application-registry-upload - The upload command sends file to application registry.
Synopsis
onteoncli application-registry upload [-h] [--output\=] [-v\=
Description
The upload command sends file to application registry.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
File to upload.
completion¶
Name
onteoncli-completion - The completion command generates completion script for bash or zsh.
Synopsis
onteoncli completion [-h]
Description
The completion command generates completion script for bash or zsh.
Options
-h, --help
Show this help message and exit.
config¶
get-distribution¶
Name
onteoncli-config-get-distribution - The get-distribution command gets distribution config.
Synopsis
onteoncli config get-distribution [-h] [--output\=] [-v\=
Description
The get-distribution command gets distribution config.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
get-edge-balancer¶
Name
onteoncli-config-get-edge-balancer - The get-edge-balancer command gets edge balancer config.
Synopsis
onteoncli config get-edge-balancer [-h] [--output\=] [-v\=
Description
The get-edge-balancer command gets edge balancer config.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
get-inner-balancer¶
Name
onteoncli-config-get-inner-balancer - The get-inner-balancer command gets inner balancer config.
Synopsis
onteoncli config get-inner-balancer [-h] [--output\=] [-v\=
Description
The get-inner-balancer command gets inner balancer config.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
get-ssl¶
Name
onteoncli-config-get-ssl - The get-ssl command gets SSL config.
Synopsis
onteoncli config get-ssl [-h] [--output\=] [-v\=
Description
The get-ssl command gets SSL config.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
set-distribution¶
Name
onteoncli-config-set-distribution - The set-distribution command sets distribution config.
Synopsis
onteoncli config set-distribution [-h]--default-check-if-node-can-accept-new-applica tion-instance-script-id\=
Description
The set-distribution command sets distribution config.
Options
--default-check-if-node-can-accept-new-application-instance-script-id\=
--default-select-application-instance-to-remove-script-id\=
--default-select-node-for-new-application-instance-script-id\=
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
set-edge-balancer¶
Name
onteoncli-config-set-edge-balancer - The set-edge-balancer command sets edge balancer config.
Synopsis
onteoncli config set-edge-balancer [-h]--http-external-communication\=
Description
The set-edge-balancer command sets edge balancer config.
Options
-h, --help
Show this help message and exit.
--http-external-communication\=
--http-external-communication-proxy\=
--http-local-communication\=
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
set-inner-balancer¶
Name
onteoncli-config-set-inner-balancer - The set-inner-balancer command sets inner balancer config.
Synopsis
onteoncli config set-inner-balancer [-h]--http-external-communication\=
Description
The set-inner-balancer command sets inner balancer config.
Options
-h, --help
Show this help message and exit.
--http-external-communication\=
--http-external-communication-proxy\=
--http-local-communication\=
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
set-ssl¶
Name
onteoncli-config-set-ssl - The set-ssl command sets SSL config.
Synopsis
onteoncli config set-ssl [-h]--certificate-api-client-common-name\=
Description
The set-ssl command sets SSL config.
Options
--certificate-api-client-alternative-names[=
--certificate-api-client-common-name\=
--certificate-api-client-country-name\=
--certificate-api-client-email-address\=
--certificate-api-client-expiration-time-in-days\=
--certificate-api-client-locality-name\=
--certificate-api-client-organization-name\=
--certificate-api-client-organizational-unit-name\=
--certificate-api-client-private-key-size\=
--certificate-api-client-rotation-time-in-days\=
--certificate-api-client-state-or-province-name\=
--certificate-api-intermediate-alternative-names[=
--certificate-api-intermediate-common-name\=
--certificate-api-intermediate-country-name\=
--certificate-api-intermediate-email-address\=
--certificate-api-intermediate-expiration-time-in-days\=
--certificate-api-intermediate-locality-name\=
--certificate-api-intermediate-organization-name\=
--certificate-api-intermediate-organizational-unit-name\=
--certificate-api-intermediate-private-key-size\=
--certificate-api-intermediate-rotation-time-in-days\=
--certificate-api-intermediate-state-or-province-name\=
--certificate-api-root-ca-alternative-names[=
--certificate-api-root-ca-common-name\=
--certificate-api-root-ca-country-name\=
--certificate-api-root-ca-email-address\=
--certificate-api-root-ca-expiration-time-in-days\=
--certificate-api-root-ca-locality-name\=
--certificate-api-root-ca-organization-name\=
--certificate-api-root-ca-organizational-unit-name\=
--certificate-api-root-ca-private-key-size\=
--certificate-api-root-ca-rotation-time-in-days\=
--certificate-api-root-ca-state-or-province-name\=
--certificate-api-server-alternative-names[=
--certificate-api-server-common-name\=
--certificate-api-server-country-name\=
--certificate-api-server-email-address\=
--certificate-api-server-expiration-time-in-days\=
--certificate-api-server-locality-name\=
--certificate-api-server-organization-name\=
--certificate-api-server-organizational-unit-name\=
--certificate-api-server-private-key-size\=
--certificate-api-server-rotation-time-in-days\=
--certificate-api-server-state-or-province-name\=
--certificate-edge-balancer-client-alternative-names[=
--certificate-edge-balancer-client-common-name\=
--certificate-edge-balancer-client-country-name\=
--certificate-edge-balancer-client-email-address\=
--certificate-edge-balancer-client-expiration-time-in-days\=
--certificate-edge-balancer-client-locality-name\=
--certificate-edge-balancer-client-organization-name\=
--certificate-edge-balancer-client-organizational-unit-name\=
--certificate-edge-balancer-client-private-key-size\=
--certificate-edge-balancer-client-rotation-time-in-days\=
--certificate-edge-balancer-client-state-or-province-name\=
--certificate-edge-balancer-intermediate-alternative-names[=
--certificate-edge-balancer-intermediate-common-name\=
--certificate-edge-balancer-intermediate-country-name\=
--certificate-edge-balancer-intermediate-email-address\=
--certificate-edge-balancer-intermediate-expiration-time-in-days\=
--certificate-edge-balancer-intermediate-locality-name\=
--certificate-edge-balancer-intermediate-organization-name\=
--certificate-edge-balancer-intermediate-organizational-unit-name\=
--certificate-edge-balancer-intermediate-private-key-size\=
--certificate-edge-balancer-intermediate-rotation-time-in-days\=
--certificate-edge-balancer-intermediate-state-or-province-name\=
--certificate-edge-balancer-root-ca-alternative-names[=
--certificate-edge-balancer-root-ca-common-name\=
--certificate-edge-balancer-root-ca-country-name\=
--certificate-edge-balancer-root-ca-email-address\=
--certificate-edge-balancer-root-ca-expiration-time-in-days\=
--certificate-edge-balancer-root-ca-locality-name\=
--certificate-edge-balancer-root-ca-organization-name\=
--certificate-edge-balancer-root-ca-organizational-unit-name\=
--certificate-edge-balancer-root-ca-private-key-size\=
--certificate-edge-balancer-root-ca-rotation-time-in-days\=
--certificate-edge-balancer-root-ca-state-or-province-name\=
--certificate-edge-balancer-server-alternative-names[=
--certificate-edge-balancer-server-common-name\=
--certificate-edge-balancer-server-country-name\=
--certificate-edge-balancer-server-email-address\=
--certificate-edge-balancer-server-expiration-time-in-days\=
--certificate-edge-balancer-server-locality-name\=
--certificate-edge-balancer-server-organization-name\=
--certificate-edge-balancer-server-organizational-unit-name\=
--certificate-edge-balancer-server-private-key-size\=
--certificate-edge-balancer-server-rotation-time-in-days\=
--certificate-edge-balancer-server-state-or-province-name\=
--certificate-inner-balancer-client-alternative-names[=
--certificate-inner-balancer-client-common-name\=
--certificate-inner-balancer-client-country-name\=
--certificate-inner-balancer-client-email-address\=
--certificate-inner-balancer-client-expiration-time-in-days\=
--certificate-inner-balancer-client-locality-name\=
--certificate-inner-balancer-client-organization-name\=
--certificate-inner-balancer-client-organizational-unit-name\=
--certificate-inner-balancer-client-private-key-size\=
--certificate-inner-balancer-client-rotation-time-in-days\=
--certificate-inner-balancer-client-state-or-province-name\=
--certificate-inner-balancer-intermediate-alternative-names[=
--certificate-inner-balancer-intermediate-common-name\=
--certificate-inner-balancer-intermediate-country-name\=
--certificate-inner-balancer-intermediate-email-address\=
--certificate-inner-balancer-intermediate-expiration-time-in-days\=
--certificate-inner-balancer-intermediate-locality-name\=
--certificate-inner-balancer-intermediate-organization-name\=
--certificate-inner-balancer-intermediate-organizational-unit-name\=
--certificate-inner-balancer-intermediate-private-key-size\=
--certificate-inner-balancer-intermediate-rotation-time-in-days\=
--certificate-inner-balancer-intermediate-state-or-province-name\=
--certificate-inner-balancer-root-ca-alternative-names[=
--certificate-inner-balancer-root-ca-common-name\=
--certificate-inner-balancer-root-ca-country-name\=
--certificate-inner-balancer-root-ca-email-address\=
--certificate-inner-balancer-root-ca-expiration-time-in-days\=
--certificate-inner-balancer-root-ca-locality-name\=
--certificate-inner-balancer-root-ca-organization-name\=
--certificate-inner-balancer-root-ca-organizational-unit-name\=
--certificate-inner-balancer-root-ca-private-key-size\=
--certificate-inner-balancer-root-ca-rotation-time-in-days\=
--certificate-inner-balancer-root-ca-state-or-province-name\=
--certificate-inner-balancer-server-alternative-names[=
--certificate-inner-balancer-server-common-name\=
--certificate-inner-balancer-server-country-name\=
--certificate-inner-balancer-server-email-address\=
--certificate-inner-balancer-server-expiration-time-in-days\=
--certificate-inner-balancer-server-locality-name\=
--certificate-inner-balancer-server-organization-name\=
--certificate-inner-balancer-server-organizational-unit-name\=
--certificate-inner-balancer-server-private-key-size\=
--certificate-inner-balancer-server-rotation-time-in-days\=
--certificate-inner-balancer-server-state-or-province-name\=
--certificate-internal-client-alternative-names[=
--certificate-internal-client-common-name\=
--certificate-internal-client-country-name\=
--certificate-internal-client-email-address\=
--certificate-internal-client-expiration-time-in-days\=
--certificate-internal-client-locality-name\=
--certificate-internal-client-organization-name\=
--certificate-internal-client-organizational-unit-name\=
--certificate-internal-client-private-key-size\=
--certificate-internal-client-rotation-time-in-days\=
--certificate-internal-client-state-or-province-name\=
--certificate-internal-intermediate-alternative-names[=
--certificate-internal-intermediate-common-name\=
--certificate-internal-intermediate-country-name\=
--certificate-internal-intermediate-email-address\=
--certificate-internal-intermediate-expiration-time-in-days\=
--certificate-internal-intermediate-locality-name\=
--certificate-internal-intermediate-organization-name\=
--certificate-internal-intermediate-organizational-unit-name\=
--certificate-internal-intermediate-private-key-size\=
--certificate-internal-intermediate-rotation-time-in-days\=
--certificate-internal-intermediate-state-or-province-name\=
--certificate-internal-root-ca-alternative-names[=
--certificate-internal-root-ca-common-name\=
--certificate-internal-root-ca-country-name\=
--certificate-internal-root-ca-email-address\=
--certificate-internal-root-ca-expiration-time-in-days\=
--certificate-internal-root-ca-locality-name\=
--certificate-internal-root-ca-organization-name\=
--certificate-internal-root-ca-organizational-unit-name\=
--certificate-internal-root-ca-private-key-size\=
--certificate-internal-root-ca-rotation-time-in-days\=
--certificate-internal-root-ca-state-or-province-name\=
--certificate-internal-server-alternative-names[=
--certificate-internal-server-common-name\=
--certificate-internal-server-country-name\=
--certificate-internal-server-email-address\=
--certificate-internal-server-expiration-time-in-days\=
--certificate-internal-server-locality-name\=
--certificate-internal-server-organization-name\=
--certificate-internal-server-organizational-unit-name\=
--certificate-internal-server-private-key-size\=
--certificate-internal-server-rotation-time-in-days\=
--certificate-internal-server-state-or-province-name\=
--certificates-management-enabled\=
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
--ssl-mode-api\=
--ssl-mode-edge-balancer\=
--ssl-mode-inner-balancer\=
--ssl-mode-internal\=
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
distribution¶
create¶
Name
onteoncli-distribution-create - The create command creates new distribution with specified data.
Synopsis
onteoncli distribution create [-h] [--application-id\=
Description
The create command creates new distribution with specified data.
Options
--application-id\=
Distribution's application's id.
--check-if-node-can-accept-new-application-instance-script-id\=
Distribution's checkIfNodeCanAcceptNewApplicationInstance script's id.
-h, --help
Show this help message and exit.
--number-of-instances\=
Distribution's number of application instances.
--output\=
Output format. Supported values: text, json.
--select-application-instance-to-remove-script-id\=
Distribution's selectApplicationInstanceToRemove script's id.
--select-node-for-new-application-instance-script-id\=
Distribution's selectNodeForNewApplicationInstance script's id.
--type\=
Distribution's type.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
create-from-file¶
Name
onteoncli-distribution-create-from-file - The create-from-file command creates new distribution with configuration specified if file.
Synopsis
onteoncli distribution create-from-file [-h] [--output\=] [-v\=
Description
The create-from-file command creates new distribution with configuration specified if file.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Distribution's definition file.
delete¶
Name
onteoncli-distribution-delete - The delete command deletes distribution by id.
Synopsis
onteoncli distribution delete [-h] [--output\=] [-v\=
Description
The delete command deletes distribution by id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Distribution's id.
get¶
Name
onteoncli-distribution-get - The get command finds distribution by id.
Synopsis
onteoncli distribution get [-h] [--output\=] [-v\=
Description
The get command finds distribution by id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Distribution's id.
list¶
Name
onteoncli-distribution-list - The list command lists all distributions with pagination.
Synopsis
onteoncli distribution list [-h] [--output\=] [--page\=
Description
The list command lists all distributions with pagination.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
--page\=
Page number.
--per-page\=
Number of items per page.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
set-application-id¶
Name
onteoncli-distribution-set-application-id - The set-application-id command updates distribution with new application's id.
Synopsis
onteoncli distribution set-application-id [-h] [--output\=] [-v\=
Description
The set-application-id command updates distribution with new application's id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Distribution's id.
Distribution's new application's id.
set-check-if-node-can-accept-new-application-instance-script-id¶
Name
onteoncli-distribution-set-check-if-node-can-accept-new-application-instance-script-id - The set-check-ff-node-can-accept-new-application-instance-script-id command updates distribution with new checkIfNodeCanAcceptNewApplicationInstance script's id.
Synopsis
onteoncli distribution set-check-if-node-can-accept-new-application-instance-script-id [-h][--output\=] [-v\=
Description
The set-check-ff-node-can-accept-new-application-instance-script-id command updates distribution with new checkIfNodeCanAcceptNewApplicationInstance script's id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Distribution's id.
Distribution's new checkIfNodeCanAcceptNewApplicationInstance script's id.
set-number-of-instances¶
Name
onteoncli-distribution-set-number-of-instances - The set-number-of-instances command updates distribution with new number of application instances.
Synopsis
onteoncli distribution set-number-of-instances [-h] [--output\=][-v\=
Description
The set-number-of-instances command updates distribution with new number of application instances.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Distribution's id.
Distribution's new number of application instances.
set-select-application-instance-to-remove-script-id¶
Name
onteoncli-distribution-set-select-application-instance-to-remove-script-id - The set-select-application-instance-to-remove-script-id command updates distribution with new selectApplicationInstanceToRemove script's id.
Synopsis
onteoncli distribution set-select-application-instance-to-remove-script-id [-h][--output\=] [-v\=
Description
The set-select-application-instance-to-remove-script-id command updates distribution with new selectApplicationInstanceToRemove script's id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Distribution's id.
Distribution's new selectApplicationInstanceToRemove script's id.
set-select-node-for-new-application-instance¶
Name
onteoncli-distribution-set-select-node-for-new-application-instance - The set-select-node-for-new-application-instance command updates distribution with new selectNodeForNewApplicationInstance script's id.
Synopsis
onteoncli distribution set-select-node-for-new-application-instance [-h][--output\=] [-v\=
Description
The set-select-node-for-new-application-instance command updates distribution with new selectNodeForNewApplicationInstance script's id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Distribution's id.
Distribution's new selectNodeForNewApplicationInstance script's id.
set-type¶
Name
onteoncli-distribution-set-type - The set-type command updates distribution with new type.
Synopsis
onteoncli distribution set-type [-h] [--output\=] [-v\=
Description
The set-type command updates distribution with new type.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Distribution's id.
Distribution's new type.
login¶
Name
onteoncli-login - The login command authorizes access to cluster.
Synopsis
onteoncli login [-h] [--client-certificate\=
Description
The login command authorizes access to cluster.
Options
--client-certificate\=
--client-id\=
--client-private-key\=
--cluster-url\=
--disable-hostname-verification\=
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
--scope\=
--trusted-certificates\=
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
login-service¶
Name
onteoncli-login-service - The login-service command authorizes access to cluster for service accounts.
Synopsis
onteoncli login-service [-h] [--client-certificate\=
Description
The login-service command authorizes access to cluster for service accounts.
Options
--client-certificate\=
--client-id\=
--client-private-key\=
--client-secret\=
--cluster-url\=
--disable-hostname-verification\=
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
--scope\=
--trusted-certificates\=
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
node¶
details¶
Name
onteoncli-node-details - The details command shows node's details.
Synopsis
onteoncli node details [-h] [--output\=] [-v\=
Description
The details command shows node's details.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Node's id.
disconnect¶
Name
onteoncli-node-disconnect - The disconnect command disconnects node by id.
Synopsis
onteoncli node disconnect [-h] [--output\=] [-v\=
Description
The disconnect command disconnects node by id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Node's id.
get¶
Name
onteoncli-node-get - The get command finds node by id.
Synopsis
onteoncli node get [-h] [--output\=] [-v\=
Description
The get command finds node by id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Node's id.
list¶
Name
onteoncli-node-list - The list command lists all nodes with pagination.
Synopsis
onteoncli node list [-h] [--output\=] [--page\=
Description
The list command lists all nodes with pagination.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
--page\=
Page number.
--per-page\=
Number of items per page.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
set-zone-id¶
Name
onteoncli-node-set-zone-id - The set-zone-id command updates node with new zone id.
Synopsis
onteoncli node set-zone-id [-h] [--output\=] [-v\=
Description
The set-zone-id command updates node with new zone id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Node's id.
Node's new zone id.
role¶
create-from-file¶
Name
onteoncli-role-create-from-file - The create-from-file command creates new role with specified name.
Synopsis
onteoncli role create-from-file [-h] [--output\=] [-v\=
Description
The create-from-file command creates new role with specified name.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Role's definition file.
delete¶
Name
onteoncli-role-delete - The delete command tries to delete role by id at first and then by name if not found.
Synopsis
onteoncli role delete [-h] [--output\=] [-v\=
Description
The delete command tries to delete role by id at first and then by name if not found.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Role's name or id.
get¶
Name
onteoncli-role-get - The get command tries to find role by id at first and then by name if not found.
Synopsis
onteoncli role get [-h] [--output\=] [-v\=
Description
The get command tries to find role by id at first and then by name if not found.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Role's name or id.
list¶
Name
onteoncli-role-list - The list command lists all roles with pagination.
Synopsis
onteoncli role list [-h] [--output\=] [--page\=
Description
The list command lists all roles with pagination.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
--page\=
Page number.
--per-page\=
Number of items per page.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
update¶
Name
onteoncli-role-update - The update command updates role with new definition.
Synopsis
onteoncli role update [-h] [--output\=] [-v\=
Description
The update command updates role with new definition.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Role's id.
Role's definition file.
script¶
content¶
Name
onteoncli-script-content - The content command returns content of script with provided id.
Synopsis
onteoncli script content [-h] [--output\=] [-v\=
Description
The content command returns content of script with provided id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Script's id.
create¶
Name
onteoncli-script-create - The create command creates new script with specified name, scriptType and content from scriptFile.
Synopsis
onteoncli script create [-h] [--output\=] [-v\=
Description
The create command creates new script with specified name, scriptType and content from scriptFile.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Script's name.
Script's type.
Script's file.
delete¶
Name
onteoncli-script-delete - The delete command tries to delete script by id.
Synopsis
onteoncli script delete [-h] [--output\=] [-v\=
Description
The delete command tries to delete script by id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Script's id.
get¶
Name
onteoncli-script-get - The get command tries to find script by id.
Synopsis
onteoncli script get [-h] [--output\=] [-v\=
Description
The get command tries to find script by id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Script's id.
list¶
Name
onteoncli-script-list - The list command lists all scripts with pagination.
Synopsis
onteoncli script list [-h] [--output\=] [--page\=
Description
The list command lists all scripts with pagination.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
--page\=
Page number.
--per-page\=
Number of items per page.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
set-content¶
Name
onteoncli-script-set-content - The set-content command updates script with new content.
Synopsis
onteoncli script set-content [-h] [--output\=] [-v\=
Description
The set-content command updates script with new content.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Script's id.
Script's file.
set-name¶
Name
onteoncli-script-set-name - The set-name command updates script with new name.
Synopsis
onteoncli script set-name [-h] [--output\=] [-v\=
Description
The set-name command updates script with new name.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Script's id.
Script's new name.
ssl¶
init-communication¶
Name
onteoncli-ssl-init-communication - The init-balancer-communication command creates new SSL keys and certificates required for balancer's communication.
Synopsis
onteoncli ssl init-communication [-h][--certificate-api-client-common-name\=
Description
The init-balancer-communication command creates new SSL keys and certificates required for balancer's communication.
Options
--certificate-api-client-alternative-names[=
--certificate-api-client-common-name\=
--certificate-api-client-country-name\=
--certificate-api-client-email-address\=
--certificate-api-client-expiration-time-in-days\=
--certificate-api-client-locality-name\=
--certificate-api-client-organization-name\=
--certificate-api-client-organizational-unit-name\=
--certificate-api-client-private-key-size\=
--certificate-api-client-rotation-time-in-days\=
--certificate-api-client-state-or-province-name\=
--certificate-api-intermediate-alternative-names[=
--certificate-api-intermediate-common-name\=
--certificate-api-intermediate-country-name\=
--certificate-api-intermediate-email-address\=
--certificate-api-intermediate-expiration-time-in-days\=
--certificate-api-intermediate-locality-name\=
--certificate-api-intermediate-organization-name\=
--certificate-api-intermediate-organizational-unit-name\=
--certificate-api-intermediate-private-key-size\=
--certificate-api-intermediate-rotation-time-in-days\=
--certificate-api-intermediate-state-or-province-name\=
--certificate-api-root-ca-alternative-names[=
--certificate-api-root-ca-common-name\=
--certificate-api-root-ca-country-name\=
--certificate-api-root-ca-email-address\=
--certificate-api-root-ca-expiration-time-in-days\=
--certificate-api-root-ca-locality-name\=
--certificate-api-root-ca-organization-name\=
--certificate-api-root-ca-organizational-unit-name\=
--certificate-api-root-ca-private-key-size\=
--certificate-api-root-ca-rotation-time-in-days\=
--certificate-api-root-ca-state-or-province-name\=
--certificate-api-server-alternative-names[=
--certificate-api-server-common-name\=
--certificate-api-server-country-name\=
--certificate-api-server-email-address\=
--certificate-api-server-expiration-time-in-days\=
--certificate-api-server-locality-name\=
--certificate-api-server-organization-name\=
--certificate-api-server-organizational-unit-name\=
--certificate-api-server-private-key-size\=
--certificate-api-server-rotation-time-in-days\=
--certificate-api-server-state-or-province-name\=
--certificate-edge-balancer-client-alternative-names[=
--certificate-edge-balancer-client-common-name\=
--certificate-edge-balancer-client-country-name\=
--certificate-edge-balancer-client-email-address\=
--certificate-edge-balancer-client-expiration-time-in-days\=
--certificate-edge-balancer-client-locality-name\=
--certificate-edge-balancer-client-organization-name\=
--certificate-edge-balancer-client-organizational-unit-name\=
--certificate-edge-balancer-client-private-key-size\=
--certificate-edge-balancer-client-rotation-time-in-days\=
--certificate-edge-balancer-client-state-or-province-name\=
--certificate-edge-balancer-intermediate-alternative-names[=
--certificate-edge-balancer-intermediate-common-name\=
--certificate-edge-balancer-intermediate-country-name\=
--certificate-edge-balancer-intermediate-email-address\=
--certificate-edge-balancer-intermediate-expiration-time-in-days\=
--certificate-edge-balancer-intermediate-locality-name\=
--certificate-edge-balancer-intermediate-organization-name\=
--certificate-edge-balancer-intermediate-organizational-unit-name\=
--certificate-edge-balancer-intermediate-private-key-size\=
--certificate-edge-balancer-intermediate-rotation-time-in-days\=
--certificate-edge-balancer-intermediate-state-or-province-name\=
--certificate-edge-balancer-root-ca-alternative-names[=
--certificate-edge-balancer-root-ca-common-name\=
--certificate-edge-balancer-root-ca-country-name\=
--certificate-edge-balancer-root-ca-email-address\=
--certificate-edge-balancer-root-ca-expiration-time-in-days\=
--certificate-edge-balancer-root-ca-locality-name\=
--certificate-edge-balancer-root-ca-organization-name\=
--certificate-edge-balancer-root-ca-organizational-unit-name\=
--certificate-edge-balancer-root-ca-private-key-size\=
--certificate-edge-balancer-root-ca-rotation-time-in-days\=
--certificate-edge-balancer-root-ca-state-or-province-name\=
--certificate-edge-balancer-server-alternative-names[=
--certificate-edge-balancer-server-common-name\=
--certificate-edge-balancer-server-country-name\=
--certificate-edge-balancer-server-email-address\=
--certificate-edge-balancer-server-expiration-time-in-days\=
--certificate-edge-balancer-server-locality-name\=
--certificate-edge-balancer-server-organization-name\=
--certificate-edge-balancer-server-organizational-unit-name\=
--certificate-edge-balancer-server-private-key-size\=
--certificate-edge-balancer-server-rotation-time-in-days\=
--certificate-edge-balancer-server-state-or-province-name\=
--certificate-inner-balancer-client-alternative-names[=
--certificate-inner-balancer-client-common-name\=
--certificate-inner-balancer-client-country-name\=
--certificate-inner-balancer-client-email-address\=
--certificate-inner-balancer-client-expiration-time-in-days\=
--certificate-inner-balancer-client-locality-name\=
--certificate-inner-balancer-client-organization-name\=
--certificate-inner-balancer-client-organizational-unit-name\=
--certificate-inner-balancer-client-private-key-size\=
--certificate-inner-balancer-client-rotation-time-in-days\=
--certificate-inner-balancer-client-state-or-province-name\=
--certificate-inner-balancer-intermediate-alternative-names[=
--certificate-inner-balancer-intermediate-common-name\=
--certificate-inner-balancer-intermediate-country-name\=
--certificate-inner-balancer-intermediate-email-address\=
--certificate-inner-balancer-intermediate-expiration-time-in-days\=
--certificate-inner-balancer-intermediate-locality-name\=
--certificate-inner-balancer-intermediate-organization-name\=
--certificate-inner-balancer-intermediate-organizational-unit-name\=
--certificate-inner-balancer-intermediate-private-key-size\=
--certificate-inner-balancer-intermediate-rotation-time-in-days\=
--certificate-inner-balancer-intermediate-state-or-province-name\=
--certificate-inner-balancer-root-ca-alternative-names[=
--certificate-inner-balancer-root-ca-common-name\=
--certificate-inner-balancer-root-ca-country-name\=
--certificate-inner-balancer-root-ca-email-address\=
--certificate-inner-balancer-root-ca-expiration-time-in-days\=
--certificate-inner-balancer-root-ca-locality-name\=
--certificate-inner-balancer-root-ca-organization-name\=
--certificate-inner-balancer-root-ca-organizational-unit-name\=
--certificate-inner-balancer-root-ca-private-key-size\=
--certificate-inner-balancer-root-ca-rotation-time-in-days\=
--certificate-inner-balancer-root-ca-state-or-province-name\=
--certificate-inner-balancer-server-alternative-names[=
--certificate-inner-balancer-server-common-name\=
--certificate-inner-balancer-server-country-name\=
--certificate-inner-balancer-server-email-address\=
--certificate-inner-balancer-server-expiration-time-in-days\=
--certificate-inner-balancer-server-locality-name\=
--certificate-inner-balancer-server-organization-name\=
--certificate-inner-balancer-server-organizational-unit-name\=
--certificate-inner-balancer-server-private-key-size\=
--certificate-inner-balancer-server-rotation-time-in-days\=
--certificate-inner-balancer-server-state-or-province-name\=
--certificate-internal-client-alternative-names[=
--certificate-internal-client-common-name\=
--certificate-internal-client-country-name\=
--certificate-internal-client-email-address\=
--certificate-internal-client-expiration-time-in-days\=
--certificate-internal-client-locality-name\=
--certificate-internal-client-organization-name\=
--certificate-internal-client-organizational-unit-name\=
--certificate-internal-client-private-key-size\=
--certificate-internal-client-rotation-time-in-days\=
--certificate-internal-client-state-or-province-name\=
--certificate-internal-intermediate-alternative-names[=
--certificate-internal-intermediate-common-name\=
--certificate-internal-intermediate-country-name\=
--certificate-internal-intermediate-email-address\=
--certificate-internal-intermediate-expiration-time-in-days\=
--certificate-internal-intermediate-locality-name\=
--certificate-internal-intermediate-organization-name\=
--certificate-internal-intermediate-organizational-unit-name\=
--certificate-internal-intermediate-private-key-size\=
--certificate-internal-intermediate-rotation-time-in-days\=
--certificate-internal-intermediate-state-or-province-name\=
--certificate-internal-root-ca-alternative-names[=
--certificate-internal-root-ca-common-name\=
--certificate-internal-root-ca-country-name\=
--certificate-internal-root-ca-email-address\=
--certificate-internal-root-ca-expiration-time-in-days\=
--certificate-internal-root-ca-locality-name\=
--certificate-internal-root-ca-organization-name\=
--certificate-internal-root-ca-organizational-unit-name\=
--certificate-internal-root-ca-private-key-size\=
--certificate-internal-root-ca-rotation-time-in-days\=
--certificate-internal-root-ca-state-or-province-name\=
--certificate-internal-server-alternative-names[=
--certificate-internal-server-common-name\=
--certificate-internal-server-country-name\=
--certificate-internal-server-email-address\=
--certificate-internal-server-expiration-time-in-days\=
--certificate-internal-server-locality-name\=
--certificate-internal-server-organization-name\=
--certificate-internal-server-organizational-unit-name\=
--certificate-internal-server-private-key-size\=
--certificate-internal-server-rotation-time-in-days\=
--certificate-internal-server-state-or-province-name\=
--edge-balancer-http-external-communication\=
--edge-balancer-http-external-communication-proxy\=
--edge-balancer-http-local-communication\=
-h, --help
Show this help message and exit.
--inner-balancer-http-external-communication\=
--inner-balancer-http-external-communication-proxy\=
--inner-balancer-http-local-communication\=
--output\=
Output format. Supported values: text, json.
--ssl-mode-api\=
Mode of API HTTP communication. Possible values: disable, one-way, two-way.
--ssl-mode-edge-balancer\=
Mode of edge balancer HTTP communication. Possible values: disable, one-way, two-way.
--ssl-mode-inner-balancer\=
Mode of inner balancer HTTP communication. Possible values: disable, one-way, two-way.
--ssl-mode-internal\=
Mode of internal HTTP communication. Possible values: disable, one-way, two-way.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
ssl-certificate¶
create-from-file¶
Name
onteoncli-ssl-certificate-create-from-file - The create-from-file command creates new SSL certificate from file.
Synopsis
onteoncli ssl-certificate create-from-file [-h] --group\=
Description
The create-from-file command creates new SSL certificate from file.
Options
--group\=
SSL certificate's group.
-h, --help
Show this help message and exit.
--name\=
SSL certificate's name.
--output\=
Output format. Supported values: text, json.
--purpose\=
SSL certificate's purpose.
--ssl-certificate-file\=
SSL certificate's file.
--ssl-key-id\=
SSL key's id used to generate certificate.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
delete¶
Name
onteoncli-ssl-certificate-delete - The delete command tries to delete SSL certificate by id.
Synopsis
onteoncli ssl-certificate delete [-h] [--output\=] [-v\=
Description
The delete command tries to delete SSL certificate by id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
SSL certificate's id.
generate¶
Name
onteoncli-ssl-certificate-generate - The generate command generates new SSL certificate.
Synopsis
onteoncli ssl-certificate generate [-h] --common-name\=
Description
The generate command generates new SSL certificate.
Options
--alternative-name\=
Certificate subject's alternative names. Can be used multiple times.
--common-name\=
Certificate subject's common name.
--country-name\=
Certificate subject's country name.
--email-address\=
Certificate subject's email address.
--group\=
SSL certificate's group.
-h, --help
Show this help message and exit.
--locality-name\=
Certificate subject's locality name.
--name\=
SSL certificate's name.
--organization-name\=
Certificate subject's organization name.
--organization-unit-name\=
Certificate subject's organization unit name.
--output\=
Output format. Supported values: text, json.
--purpose\=
SSL certificate's purpose.
--signing-certificate-id\=
Certificate's id used to sign created certificate.
--ssl-key-id\=
SSL key's id used to create certificate.
--state-or-province-name\=
Certificate subject's state or province name.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
--valid-day\=
Number of days certificate will be valid.
get¶
Name
onteoncli-ssl-certificate-get - The get command tries to find SSL certificate by id.
Synopsis
onteoncli ssl-certificate get [-h] [--output\=] [-v\=
Description
The get command tries to find SSL certificate by id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
SSL certificate's id.
get-raw-data¶
Name
onteoncli-ssl-certificate-get-raw-data - The get-raw-data command tries to find SSL certificate by id and returns raw data.
Synopsis
onteoncli ssl-certificate get-raw-data [-h] [--output\=] [-v\=
Description
The get-raw-data command tries to find SSL certificate by id and returns raw data.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
SSL certificate's id.
list¶
Name
onteoncli-ssl-certificate-list - The list command lists all SSL certificates with pagination.
Synopsis
onteoncli ssl-certificate list [-h] [--output\=] [--page\=
Description
The list command lists all SSL certificates with pagination.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
--page\=
Page number.
--per-page\=
Number of items per page.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
valid¶
Name
onteoncli-ssl-certificate-valid - The valid command lists all valid SSL certificates with provided group and purpose with pagination.
Synopsis
onteoncli ssl-certificate valid [-h] --group\=
Description
The valid command lists all valid SSL certificates with provided group and purpose with pagination.
Options
--group\=
SSL certificate's group.
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
--page\=
Page number.
--per-page\=
Number of items per page.
--purpose\=
SSL certificate's purpose.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
ssl-key¶
create-from-file¶
Name
onteoncli-ssl-key-create-from-file - The create-from-file command creates new SSL key from file.
Synopsis
onteoncli ssl-key create-from-file [-h] --name\=
Description
The create-from-file command creates new SSL key from file.
Options
-h, --help
Show this help message and exit.
--name\=
SSL key's name.
--output\=
Output format. Supported values: text, json.
--ssl-key-file\=
SSL key's file.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
delete¶
Name
onteoncli-ssl-key-delete - The delete command tries to delete SSL key by id.
Synopsis
onteoncli ssl-key delete [-h] [--output\=] [-v\=
Description
The delete command tries to delete SSL key by id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
SSL key's id.
generate¶
Name
onteoncli-ssl-key-generate - The generate command generates new SSL key.
Synopsis
onteoncli ssl-key generate [-h] [--key-size\=
Description
The generate command generates new SSL key.
Options
-h, --help
Show this help message and exit.
--key-size\=
SSL key's key size.
--name\=
SSL key's name.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
get¶
Name
onteoncli-ssl-key-get - The get command tries to find SSL key by id.
Synopsis
onteoncli ssl-key get [-h] [--output\=] [-v\=
Description
The get command tries to find SSL key by id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
SSL key's id.
get-raw-data¶
Name
onteoncli-ssl-key-get-raw-data - The get-raw-data command tries to find SSL key by id and returns raw data.
Synopsis
onteoncli ssl-key get-raw-data [-h] [--output\=] [-v\=
Description
The get-raw-data command tries to find SSL key by id and returns raw data.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
SSL key's id.
list¶
Name
onteoncli-ssl-key-list - The list command lists all SSL keys with pagination.
Synopsis
onteoncli ssl-key list [-h] [--output\=] [--page\=
Description
The list command lists all SSL keys with pagination.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
--page\=
Page number.
--per-page\=
Number of items per page.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
token¶
Name
onteoncli-token - The token command returns valid JWT access token.
Synopsis
onteoncli token [-h] [--output\=] [-v\=
Description
The token command returns valid JWT access token.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
upgrade¶
delete¶
Name
onteoncli-upgrade-delete - The delete command tries to delete upgrade by id or name with version (in format '
Synopsis
onteoncli upgrade delete [-h] [--output\=] [-v\=
Description
The delete command tries to delete upgrade by id or name with version (in format '
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Upgrade's id or name with version ('
get¶
Name
onteoncli-upgrade-get - The get command tries to find upgrade by id or name with version (in format '
Synopsis
onteoncli upgrade get [-h] [--output\=] [-v\=
Description
The get command tries to find upgrade by id or name with version (in format '
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Upgrade's id or name with version ('
list¶
Name
onteoncli-upgrade-list - The list command lists all upgrades with pagination.
Synopsis
onteoncli upgrade list [-h] [--output\=] [--page\=
Description
The list command lists all upgrades with pagination.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
--page\=
Page number.
--per-page\=
Number of items per page.
--upgrade-name\=
Filter upgrades by upgrade's name.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
perform¶
Name
onteoncli-upgrade-perform - The perform command performs upgrade by id on specified node.
Synopsis
onteoncli upgrade perform [-h] [--output\=] [-v\=
Description
The perform command performs upgrade by id on specified node.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Upgrade's id.
Node's id.
upgrade-registry¶
list¶
Name
onteoncli-upgrade-registry-list - The list command lists all entries in upgrade registry with pagination.
Synopsis
onteoncli upgrade-registry list [-h] [--output\=] [--page\=
Description
The list command lists all entries in upgrade registry with pagination.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
--page\=
Page number.
--per-page\=
Number of items per page.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
upload¶
Name
onteoncli-upgrade-registry-upload - The upload command sends file to upgrade registry.
Synopsis
onteoncli upgrade-registry upload [-h] [--output\=] [-v\=
Description
The upload command sends file to upgrade registry.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
File to upload.
zone¶
create¶
Name
onteoncli-zone-create - The create command creates new zone with specified name.
Synopsis
onteoncli zone create [-h] [--output\=] [-v\=
Description
The create command creates new zone with specified name.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Zone's name.
delete¶
Name
onteoncli-zone-delete - The delete command tries to delete zone by id at first and then by name if not found.
Synopsis
onteoncli zone delete [-h] [--output\=] [-v\=
Description
The delete command tries to delete zone by id at first and then by name if not found.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Zone's name or id.
get¶
Name
onteoncli-zone-get - The get command tries to find zone by id at first and then by name if not found.
Synopsis
onteoncli zone get [-h] [--output\=] [-v\=
Description
The get command tries to find zone by id at first and then by name if not found.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Zone's name or id.
list¶
Name
onteoncli-zone-list - The list command lists all zones with pagination.
Synopsis
onteoncli zone list [-h] [--output\=] [--page\=
Description
The list command lists all zones with pagination.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
--page\=
Page number.
--per-page\=
Number of items per page.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
set-name¶
Name
onteoncli-zone-set-name - The set-name command updates zone with new name.
Synopsis
onteoncli zone set-name [-h] [--output\=] [-v\=
Description
The set-name command updates zone with new name.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Zone's id.
Zone's new name.
set-parent-zone-id¶
Name
onteoncli-zone-set-parent-zone-id - The set-parent-zone-id command updates zone with new parent zone id.
Synopsis
onteoncli zone set-parent-zone-id [-h] [--output\=] [-v\=
Description
The set-parent-zone-id command updates zone with new parent zone id.
Options
-h, --help
Show this help message and exit.
--output\=
Output format. Supported values: text, json.
-v, --verbose\=
Verbose mode. Helpful for troubleshooting. Supports multiple levels (from 1 to 7).
Arguments
Zone's id.
Zone's new parent zone id.