Skip to content

Onteon CLI v2 - Onboarding

Welcome to the Onteon-CLI onboarding manual. Onteon-CLI is a client for the Onteon Control Center v2 API.

Installation

To install Onteon-CLI run the onteon-cli-installer.bash script. The installer takes one argument that is either:

  • user - Onteon-CLI will be installed in single-user mode under the current user, the onteon-cli binary will be placed into ~/.local/bin directory,
  • system - Onteon-CLI will be installed in system-wide mode, it will be accessible to every user on the same system.

If installing on a Linux-based OS under a single-user, remember to add the directory ~/.local/bin to PATH.

This can be done by executing this code snippet:

PATH="${HOME}/.local/bin:${PATH}"
export PATH

The above snippet can be also added to the user's ~/.bashrc file to persist between terminal sessions.

To check the current value of PATH execute:

echo "PATH value is: ${PATH}"

Global options

All of the following options can be used on any subcommand:

--auth-user <username>              Authorize with this user name to the OCC
--auth-token <token>                Authorize with this token to the OCC
--refresh-token <token>             Special token for rotating OCC/ONM tokens,
                                    also called "occApiSecureToken"
--occ-protocol <protocol>           Cluster base protocol to use when
                                    interacting with OCC
--occ-addresses <addresses>         Cluster base addresses to use when
                                    interacting with OCC
--occ-port <port>                   Cluster base port to use  when interacting
                                    with OCC
--occ-tls-ca-bundle-path <path>     Path to a CA cert bundle
                                    (root + intermediate) for communication
                                    with OCC
--occ-tls-insecure                  Allow insecure communication with OCC
                                    (accept all certs)
--onm-port <port>                   Registered ONM port to use when interacting
                                    with ONM(s)
--onm-ip <ip>                       Registered ONM IP address to use when
                                    interacting with ONM(s)
--onm-fqdn <fqdn>                   Registered ONM FQDN to use when interacting
                                    with ONM(s)
--onm-name <name>                   Registered ONM name to use when interacting
                                    with ONM(s)
--onm-tag <tag-pair>                Use nodes that have the given tag pair when
                                    interacting with ONM(s)
--onm-do-on-all                     Use all registered nodes when interacting
                                    with ONM(s)
--skip-onm                          Completely clear out any given ONM(s), no
                                    ONMs will be contacted
--onm-check-timeout <milliseconds>  Connection timeout to check ONM(s)
--onm-wait-time <milliseconds>      Wait time between operations on ONM(s)
--occ-async                         Whether to schedule the operations
                                    asynchronously (OCC context)
--inner-async                       Whether to execute the operations on ONM(s)
                                    asynchronously (inner nodes
                                    communication)
-f, --format <format>               Output format (table, yaml or json)
--table-length <length>             Max table length if the table output format
                                    is selected

For example, we can list applications like this:

onteon-cli --occ-addresses "10.10.10.1" --onm-ip "10.10.10.2" onm get apps

but also like so:

onteon-cli onm get apps --occ-addresses "10.10.10.1" --onm-ip "10.10.10.2"

and after we configure the defaults: Onteon Control Center and Onteon Node Manager addresses we can just do:

onteon-cli onm get apps

Connecting to the cluster

As stated above, we can use the CLI options to specify to which OCC (Onteon Control Center) and ONM (Onteon Node Manager) to connect to. In addition to CLI options in the form of so-called flags we can control Onteon-CLI parameters with a stateful config file and environment variables.

Parameters can be controlled in three ways:

  • config file, stored inside ~/.config/tech.onteon.cli/onteon/onteon-cli/config.yaml on Linux
  • environment variables (use export to set them on Linux):
  • OCLI_OCC_TLS_CA_BUNDLE_PATH
  • OCLI_AUTH_USER
  • OCLI_AUTH_TOKEN
  • OCLI_REFRESH_TOKEN
  • OCLI_OCC_PROTOCOL
  • OCLI_OCC_ADDRESSES
  • OCLI_OCC_PORT
  • OCLI_ONM_IP
  • OCLI_ONM_FQDN
  • OCLI_ONM_NAME
  • OCLI_ONM_PORT
  • OCLI_OUTPUT_FORMAT
  • CLI options

The options are applied exactly in the above order - this means that environment variables will overwrite the config file and CLI options will overwrite both.

Default configuration

Onteon-CLI defaults are stored inside the ~/.config/tech.onteon.cli/onteon/onteon-cli/config.yaml file on Linux.

The config can be retrieved with command: onteon-cli config get

Default config looks like so:

spec:
  occ:
    protocol: null
    port: null
    addresses: null
    tls:
      caBundlePath: null
    auth:
      onteonUserName: null
      occApiToken: null
      occApiSecureToken: null
  onm:
    port: null
    ip: null
    fqdn: null
    name: null
    auth:
      onmApiToken: null
      onmApiSecureToken: null

The above nulls mean that no default variable is set.

In addition to the config, some variables have their default values if not set (neither in the config.yaml, environment variables or CLI options):

  • occ-protocol - http,
  • occ-addresses - 127.0.0.1,
  • occ-port - 7020,
  • onm-ip - 127.0.0.1,
  • onm-port - 8030.

To set a variable to new value use the onteon-cli config set command. Use the variables shown in the "Global options" section to set the defaults.

For example, if we execute onteon-cli config set --onm-ip 10.10.10.5 the config will be set to:

spec:
  occ:
    protocol: http
    port: 7020
    addresses: 127.0.0.1
    tls:
      caBundlePath: null
    auth:
      onteonUserName: null
      occApiToken: null
      occApiSecureToken: null
  onm:
    port: 8030
    ip: 10.10.10.5
    fqdn: null
    name: null
    auth:
      onmApiToken: null
      onmApiSecureToken: null

The value of spec.onm.ip changed to the desired value but also the other variables changed to defaults, this is because they are being transparently passed from the default variables.

Configuring tokens and certificates

This command sets the default tokens to the initial values (as used by the 1st startup of OCC):

onteon-cli config set   \
  --auth-token "a9f3c2e8b47d6a1f09ce5d24b8a7e3f2"   \
  --refresh-token "7e4a9c2f1b8d0e6c5a3f9d2b4e7a1c8c"

To set the certificates use the onteon-bundle.crt or any other file that bundles the root and intermediate certificates. Place that file in a static location (so for example ~/onteon-bundle.crt) and configure the path of certs to be used as follows:

onteon-cli config set --occ-protocol "https"    \
    --occ-tls-ca-bundle-path "${HOME}/onteon-bundle.crt"

Tokens and certificates can be rotated afterwards (see below sections).

WARNING! The default certificate is for localhost only and the host names in the default certificate will likely not match. To circumvent it use the HTTP connection (port 7020) or to accept inaccurate certs use:

onteon-cli --occ-tls-insecure OTHER-COMMANDS

Log files

  • default log file is located at path:
  • on Linux: ~/.local/var/log/tech.onteon.cli/onteon/onteon-cli/onteon-cli.default.log
  • errors-only log file is located at path:
  • on Linux: ~/.local/var/log/tech.onteon.cli/onteon/onteon-cli/onteon-cli.error.log

List all Node Managers

List all Node Managers:

onteon-cli occ get node-managers

See also:

List all applications

List all uploaded files (to Onteon Node Managers) across all nodes:

onteon-cli --onm-do-on-all onm get uploads

List all applications across all nodes:

onteon-cli --onm-do-on-all onm get apps

List all instances across all nodes:

onteon-cli --onm-do-on-all onm get instances

See also:

Application life-cycle

Life-cycle with explicit commands

  • Upload application archive to OCC

  • onteon-cli occ upload app takes:

    • application archive path to upload from
    • application name
    • application version

  • see also:

onteon-cli occ upload app ./my-app-1.0.0.tar.gz my-app 1.0.0

onteon-cli occ get apps

  • Upload application archive to target ONM

  • onteon-cli onm upload app takes:

    • application name
    • application version

  • see also:

onteon-cli --onm-ip "10.10.10.2" onm upload app my-app 1.0.0

onteon-cli --onm-do-on-all onm get uploads

  • Add and create application onto target ONM

  • onteon-cli onm add app takes:

    • application name
    • application version
    • application identifier (a cluster-unique single string)

  • onteon-cli onm create app takes:

    • application identifier

  • see also:

onteon-cli --onm-ip "10.10.10.2" onm add app my-app 1.0.0 my-app-1

onteon-cli --onm-ip "10.10.10.2" onm create app my-app-1

onteon-cli --onm-do-on-all onm get apps

  • Create application instance on target ONM

  • onteon-cli onm create instance takes:

    • application identifier
    • instance identifier

  • see also:

onteon-cli --onm-ip "10.10.10.2" onm create instance my-app-1 my-app-instance-1

onteon-cli --onm-do-on-all onm get apps
onteon-cli --onm-do-on-all onm get instances

onteon-cli --onm-ip "10.10.10.2" onm start instance my-app-1 my-app-instance-1

onteon-cli --onm-do-on-all onm get apps
onteon-cli --onm-do-on-all onm get instances

onteon-cli --onm-ip "10.10.10.2" onm stop instance my-app-1 my-app-instance-1

onteon-cli --onm-do-on-all onm get apps
onteon-cli --onm-do-on-all onm get instances

onteon-cli --onm-ip "10.10.10.2" onm terminate instance my-app-1 my-app-instance-1

onteon-cli --onm-do-on-all onm get apps
onteon-cli --onm-do-on-all onm get instances

  • Delete instance from target ONM

  • onteon-cli onm delete instance takes:

    • application identifier
    • instance identifier

  • see also:

onteon-cli --onm-ip "10.10.10.2" onm delete instance my-app-1 my-app-instance-1

onteon-cli --onm-ip "10.10.10.2" onm delete instance --permanently my-app-1 my-app-instance-1

onteon-cli --onm-do-on-all onm get apps
onteon-cli --onm-do-on-all onm get instances

  • Delete application from target ONM

  • onteon-cli onm delete app takes:

    • application identifier

  • see also:

onteon-cli --onm-ip "10.10.10.2" onm delete app my-app-1

onteon-cli --onm-ip "10.10.10.2" onm delete app --permanently my-app-1

onteon-cli --onm-do-on-all onm get apps
onteon-cli --onm-do-on-all onm get apps

  • Delete application from OCC

  • onteon-cli occ delete app takes:

    • application name
    • application version

  • see also:

onteon-cli --onm-ip "10.10.10.2" occ delete app my-app 1.0.0

onteon-cli occ get apps

Life-cycle with workflows

Example workflow:

---
spec:
  defaults:
    appName: "my-app"
    appVersion: "1.0.0"
    appId: "my-app-1"
    instanceId: "my-app-instance-1"
  actions:
    - uploadApp: {}
    - addApp: {}
    - createApp: {}
    - createInstance: {}
    - startInstance: {}

Save the above file into my-app.workflow.yaml.

Then, upload the app tar.gz archive to the Onteon Control Center:

onteon-cli occ upload app ./my-app-1.0.0.tar.gz my-app 1.0.0

And execute the workflow file with:

onteon-cli --onm-ip "10.10.10.2" onm start workflow my-app.workflow.yaml

See also:

Using tags

  • Add new tag
onteon-cli --onm-name 1-node-manager-general onm add tag myTag myTagVal
  • Get all known tags
onteon-cli --onm-do-on-all onm get tags
  • Execute a command on the tagged node
onteon-cli --onm-tag myTag:myTagVal onm exec node "date '+%H:%M:%S.%3N'"

See also:

Rotating tokens

The rotate commands will output YAML with the new token value(s), if rotating OCC (Onteon Control Center) tokens be sure to reconfigure Onteon-CLI afterwards using the newly acquired token.

  • Rotate OCC-API's Token
onteon-cli occ rotate occ-api-token
  • Rotate OCC-API's Secure Token
onteon-cli occ rotate occ-api-secure-token
  • Rotate ONM-API's Token
onteon-cli occ rotate onm-api-token
  • Rotate ONM-API's Secure Token
onteon-cli occ rotate onm-api-secure-token

See also:

Rotating certificates

Remember that if you rotate the OCC (Onteon Control Center) certificates you will have to reconfigure the Onteon-CLI certificates (occ-tls-ca-bundle-path).

For smooth OCC certificate rotation You will need to prepare:

It is possible to rotate either OCC's HTTP-Edge or ONM's CDTP-Server certificates:

  • Rotate OCC's HTTP-Edge certificate
onteon-cli occ rotate occ-http-edge-certificate ./new-server.crt ./new-server.key
  • Rotate ONM's CDTP-Server certificate
onteon-cli occ rotate onm-cdtp-server-certificate ./new-server.crt ./new-server.key

See also:

Full Onteon-CLI command tree

Retrieve the full Onteon-CLI command tree:

onteon-cli commands get

onteon-cli

Command help and usage:

Usage: onteon-cli [options] [command]

Onteon CLI

Options:
  -V, --version                       output the version number
  --auth-user <username>              Authorize with this user name to the OCC
                                      (default: "user")
  --auth-token <token>                Authorize with this token to the OCC
                                      (default: "auth-token")
  --refresh-token <token>             Special token for rotating OCC/ONM
                                      tokens, also called "occApiSecureToken"
                                      (default: "refresh-token")
  --occ-protocol <protocol>           Cluster base protocol to use when
                                      interacting with OCC (default: "https")
  --occ-addresses <addresses>         Cluster base addresses to use when
                                      interacting with OCC (default:
                                      "127.0.0.1")
  --occ-port <port>                   Cluster base port to use  when
                                      interacting with OCC (default: "7019")
  --occ-tls-ca-bundle-path <path>     Path to a CA cert bundle (root +
                                      intermediate) for communication with OCC
                                      (default: "~/onteon-bundle.crt")
  --occ-tls-insecure                  Allow insecure communication with OCC
                                      (accept all certs) (default: false)
  --onm-port <port>                   Registered ONM port to use when
                                      interacting with ONM(s) (default: "8030")
  --onm-ip <ip>                       Registered ONM IP address to use when
                                      interacting with ONM(s) (default:
                                      "127.0.0.1")
  --onm-fqdn <fqdn>                   Registered ONM FQDN to use when
                                      interacting with ONM(s) (default:
                                      "localhost.localdomain")
  --onm-name <name>                   Registered ONM name to use when
                                      interacting with ONM(s) (default:
                                      "localhost")
  --onm-tag <tag-pair>                Use nodes that have the given tag pair
                                      when interacting with ONM(s) (default:
                                      {})
  --onm-do-on-all                     Use all registered nodes when interacting
                                      with ONM(s) (default: false)
  --skip-onm                          Completely clear out any given ONM(s), no
                                      ONMs will be contacted (default: false)
  --onm-check-timeout <milliseconds>  Connection timeout to check ONM(s)
                                      (default: 5000)
  --onm-wait-time <milliseconds>      Wait time between operations on ONM(s)
                                      (default: 0)
  --occ-async                         Whether to schedule the operations
                                      asynchronously (OCC context) (default:
                                      false)
  --inner-async                       Whether to execute the operations on
                                      ONM(s) asynchronously (inner nodes
                                      communication) (default: false)
  -f, --format <format>               Output format (table, yaml or json)
                                      (default: "table")
  --table-length <length>             Max table length if the table output
                                      format is selected (default: 8)
  -h, --help                          display help for command

Commands:
  commands                            Onteon-CLI subcommands information
  config                              Onteon-CLI configuration commands
  occ                                 Onteon Control Center commands
  onm                                 Onteon Node Manager commands
  endpoints                           Onteon cluster endpoints commands
  help [command]                      display help for command
YAML spec 
onteon-cli:
  description: Onteon CLI
  usage: '[options] [command]'

onteon-cli commands

Command help and usage:

Usage: onteon-cli commands [options] [command]

Onteon-CLI subcommands information

Options:
  -h, --help      display help for command

Commands:
  get             Show available subcommands
  help [command]  display help for command
YAML spec 
onteon-cli commands:
  description: Onteon-CLI subcommands information
  usage: '[options] [command]'

onteon-cli commands get

Command help and usage:

Usage: onteon-cli commands get [options]

Show available subcommands

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli commands get:
  description: Show available subcommands
  usage: '[options]'

onteon-cli config

Command help and usage:

Usage: onteon-cli config [options] [command]

Onteon-CLI configuration commands

Options:
  -h, --help      display help for command

Commands:
  get             Retrieve Onteon-CLI configuration
  set             Modify the Onteon-CLI configuration
  delete          Reset the Onteon-CLI configuration to a clean slate
  help [command]  display help for command
YAML spec 
onteon-cli config:
  description: Onteon-CLI configuration commands
  usage: '[options] [command]'

onteon-cli config get

Command help and usage:

Usage: onteon-cli config get [options]

Retrieve Onteon-CLI configuration

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli config get:
  description: Retrieve Onteon-CLI configuration
  usage: '[options]'

onteon-cli config set

Command help and usage:

Usage: onteon-cli config set [options]

Modify the Onteon-CLI configuration

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli config set:
  description: Modify the Onteon-CLI configuration
  usage: '[options]'

onteon-cli config delete

Command help and usage:

Usage: onteon-cli config delete [options]

Reset the Onteon-CLI configuration to a clean slate

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli config delete:
  description: Reset the Onteon-CLI configuration to a clean slate
  usage: '[options]'

onteon-cli occ

Command help and usage:

Usage: onteon-cli occ [options] [command]

Onteon Control Center commands

Options:
  -h, --help      display help for command

Commands:
  get             Retrieve OCC information
  upload          Upload files to OCC
  delete          Delete OCC objects
  rotate          Rotate OCC resources (certificates, tokens)
  invoke [input]  Directly invoke raw OCC commands
  help [command]  display help for command
YAML spec 
onteon-cli occ:
  description: Onteon Control Center commands
  usage: '[options] [command]'

onteon-cli occ get

Command help and usage:

Usage: onteon-cli occ get [options] [command]

Retrieve OCC information

Options:
  -h, --help                display help for command

Commands:
  node-managers|onms        Retrieve information about all registered Node
                            Managers
  node-managers-occ|onmso   Retrieve information about all OCC registered Node
                            Managers
  store-files|sf            Retrieve all files in the OCC store
  apps                      Retrieve all application files in the OCC store
  graph                     Graph the current estimated layout of OCC and ONMs
  state <reference-number>  Retrieve results of asynchronous operations from
                            OCC
  help [command]            display help for command
YAML spec 
onteon-cli occ get:
  description: Retrieve OCC information
  usage: '[options] [command]'

onteon-cli occ get node-managers

Command help and usage:

Usage: onteon-cli occ get node-managers|onms [options]

Retrieve information about all registered Node Managers

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli occ get node-managers:
  description: Retrieve information about all registered Node Managers
  usage: '[options]'

onteon-cli occ get node-managers-occ

Command help and usage:

Usage: onteon-cli occ get node-managers-occ|onmso [options]

Retrieve information about all OCC registered Node Managers

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli occ get node-managers-occ:
  description: Retrieve information about all OCC registered Node Managers
  usage: '[options]'

onteon-cli occ get store-files

Command help and usage:

Usage: onteon-cli occ get store-files|sf [options]

Retrieve all files in the OCC store

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli occ get store-files:
  description: Retrieve all files in the OCC store
  usage: '[options]'

onteon-cli occ get apps

Command help and usage:

Usage: onteon-cli occ get apps [options]

Retrieve all application files in the OCC store

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli occ get apps:
  description: Retrieve all application files in the OCC store
  usage: '[options]'

onteon-cli occ get graph

Command help and usage:

Usage: onteon-cli occ get graph [options]

Graph the current estimated layout of OCC and ONMs

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli occ get graph:
  description: Graph the current estimated layout of OCC and ONMs
  usage: '[options]'

onteon-cli occ get state

Command help and usage:

Usage: onteon-cli occ get state [options] <reference-number>

Retrieve results of asynchronous operations from OCC

Arguments:
  reference-number  Asynchronous operation reference number

Options:
  -h, --help        display help for command
YAML spec 
onteon-cli occ get state:
  description: Retrieve results of asynchronous operations from OCC
  usage: '[options] <reference-number>'

onteon-cli occ upload

Command help and usage:

Usage: onteon-cli occ upload [options] [command]

Upload files to OCC

Options:
  -h, --help                                  display help for command

Commands:
  app <file-path> [file-name] [file-version]  Upload app file to the OCC store
  help [command]                              display help for command
YAML spec 
onteon-cli occ upload:
  description: Upload files to OCC
  usage: '[options] [command]'

onteon-cli occ upload app

Command help and usage:

Usage: onteon-cli occ upload app [options] <file-path> [file-name] [file-version]

Upload app file to the OCC store

Arguments:
  file-path     File path to upload
  file-name     File name (default: "app")
  file-version  File version (default: "1.0.0")

Options:
  -h, --help    display help for command
YAML spec 
onteon-cli occ upload app:
  description: Upload app file to the OCC store
  usage: '[options] <file-path> [file-name] [file-version]'

onteon-cli occ delete

Command help and usage:

Usage: onteon-cli occ delete [options] [command]

Delete OCC objects

Options:
  -h, --help                      display help for command

Commands:
  app <file-name> [file-version]  Delete app file from the OCC store
  help [command]                  display help for command
YAML spec 
onteon-cli occ delete:
  description: Delete OCC objects
  usage: '[options] [command]'

onteon-cli occ delete app

Command help and usage:

Usage: onteon-cli occ delete app [options] <file-name> [file-version]

Delete app file from the OCC store

Arguments:
  file-name     File name
  file-version  File version (default: "1.0.0")

Options:
  -h, --help    display help for command
YAML spec 
onteon-cli occ delete app:
  description: Delete app file from the OCC store
  usage: '[options] <file-name> [file-version]'

onteon-cli occ rotate

Command help and usage:

Usage: onteon-cli occ rotate [options] [command]

Rotate OCC resources (certificates, tokens)

Options:
  -h, --help                                                                 display help for command

Commands:
  occ-api-token                                                              Rotate the OCC API Token
  occ-api-secure-token                                                       Rotate the OCC API Secure Token
  onm-api-token                                                              Rotate the ONM API Token
  onm-api-secure-token                                                       Rotate the ONM API Secure Token
  occ-http-edge-certificate|occ-cert <certificate-path> <privatekey-path>    Rotate OCC HTTP edge certificates
  onm-cdtp-server-certificate|onm-cert <certificate-path> <privatekey-path>  Rotate ONM CDTP server certificates
  help [command]                                                             display help for command
YAML spec 
onteon-cli occ rotate:
  description: Rotate OCC resources (certificates, tokens)
  usage: '[options] [command]'

onteon-cli occ rotate occ-api-token

Command help and usage:

Usage: onteon-cli occ rotate occ-api-token [options]

Rotate the OCC API Token

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli occ rotate occ-api-token:
  description: Rotate the OCC API Token
  usage: '[options]'

onteon-cli occ rotate occ-api-secure-token

Command help and usage:

Usage: onteon-cli occ rotate occ-api-secure-token [options]

Rotate the OCC API Secure Token

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli occ rotate occ-api-secure-token:
  description: Rotate the OCC API Secure Token
  usage: '[options]'

onteon-cli occ rotate onm-api-token

Command help and usage:

Usage: onteon-cli occ rotate onm-api-token [options]

Rotate the ONM API Token

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli occ rotate onm-api-token:
  description: Rotate the ONM API Token
  usage: '[options]'

onteon-cli occ rotate onm-api-secure-token

Command help and usage:

Usage: onteon-cli occ rotate onm-api-secure-token [options]

Rotate the ONM API Secure Token

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli occ rotate onm-api-secure-token:
  description: Rotate the ONM API Secure Token
  usage: '[options]'

onteon-cli occ rotate occ-http-edge-certificate

Command help and usage:

Usage: onteon-cli occ rotate occ-http-edge-certificate|occ-cert [options] <certificate-path> <privatekey-path>

Rotate OCC HTTP edge certificates

Arguments:
  certificate-path  Path to a server certificate file
  privatekey-path   Path to a private key file

Options:
  -h, --help        display help for command
YAML spec 
onteon-cli occ rotate occ-http-edge-certificate:
  description: Rotate OCC HTTP edge certificates
  usage: '[options] <certificate-path> <privatekey-path>'

onteon-cli occ rotate onm-cdtp-server-certificate

Command help and usage:

Usage: onteon-cli occ rotate onm-cdtp-server-certificate|onm-cert [options] <certificate-path> <privatekey-path>

Rotate ONM CDTP server certificates

Arguments:
  certificate-path  Path to a server certificate file
  privatekey-path   Path to a private key file

Options:
  -h, --help        display help for command
YAML spec 
onteon-cli occ rotate onm-cdtp-server-certificate:
  description: Rotate ONM CDTP server certificates
  usage: '[options] <certificate-path> <privatekey-path>'

onteon-cli occ invoke

Command help and usage:

Usage: onteon-cli occ invoke [options] [input]

Directly invoke raw OCC commands

Arguments:
  input       OCC command input in JSON (if none, stdin is used) (default:
              null)

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli occ invoke:
  description: Directly invoke raw OCC commands
  usage: '[options] [input]'

onteon-cli onm

Command help and usage:

Usage: onteon-cli onm [options] [command]

Onteon Node Manager commands

Options:
  -h, --help      display help for command

Commands:
  upload          Upload files to ONM
  get             Retrieve ONM information
  add             Add resources to ONM
  create          Create resources on ONM
  start           Start ONM resources
  exec            Execute commands on ONM resources
  stop            Stop ONM resources
  terminate       Terminate ONM resources
  delete          Delete resources from ONM
  help [command]  display help for command
YAML spec 
onteon-cli onm:
  description: Onteon Node Manager commands
  usage: '[options] [command]'

onteon-cli onm upload

Command help and usage:

Usage: onteon-cli onm upload [options] [command]

Upload files to ONM

Options:
  -h, --help            display help for command

Commands:
  app <name> <version>  Upload app to ONM
  help [command]        display help for command
YAML spec 
onteon-cli onm upload:
  description: Upload files to ONM
  usage: '[options] [command]'

onteon-cli onm upload app

Command help and usage:

Usage: onteon-cli onm upload app [options] <name> <version>

Upload app to ONM

Arguments:
  name        Application name to use
  version     Application version to use

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli onm upload app:
  description: Upload app to ONM
  usage: '[options] <name> <version>'

onteon-cli onm get

Command help and usage:

Usage: onteon-cli onm get [options] [command]

Retrieve ONM information

Options:
  -h, --help                  display help for command

Commands:
  uploads|up                  Retrieve all files uploaded onto a given ONM
  apps [options]              Retrieve all apps on a given ONM
  instances [options]         Retrieve all app instances on a given ONM
  summary <reference-number>  Retrieve summaries of asynchronous operations
                              from ONM(s)
  tag <tag-key>               Retrieve tag values from a given ONM
  tags                        Retrieve all tags of a given ONM
  help [command]              display help for command
YAML spec 
onteon-cli onm get:
  description: Retrieve ONM information
  usage: '[options] [command]'

onteon-cli onm get uploads

Command help and usage:

Usage: onteon-cli onm get uploads|up [options]

Retrieve all files uploaded onto a given ONM

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli onm get uploads:
  description: Retrieve all files uploaded onto a given ONM
  usage: '[options]'

onteon-cli onm get apps

Command help and usage:

Usage: onteon-cli onm get apps [options]

Retrieve all apps on a given ONM

Options:
  --force     Force node information collection immediately (default: false)
  -h, --help  display help for command
YAML spec 
onteon-cli onm get apps:
  description: Retrieve all apps on a given ONM
  usage: '[options]'

onteon-cli onm get instances

Command help and usage:

Usage: onteon-cli onm get instances [options]

Retrieve all app instances on a given ONM

Options:
  --force     Force node information collection immediately (default: false)
  -h, --help  display help for command
YAML spec 
onteon-cli onm get instances:
  description: Retrieve all app instances on a given ONM
  usage: '[options]'

onteon-cli onm get summary

Command help and usage:

Usage: onteon-cli onm get summary [options] <reference-number>

Retrieve summaries of asynchronous operations from ONM(s)

Arguments:
  reference-number  Asynchronous operation reference number

Options:
  -h, --help        display help for command
YAML spec 
onteon-cli onm get summary:
  description: Retrieve summaries of asynchronous operations from ONM(s)
  usage: '[options] <reference-number>'

onteon-cli onm get tag

Command help and usage:

Usage: onteon-cli onm get tag [options] <tag-key>

Retrieve tag values from a given ONM

Arguments:
  tag-key     Tag key to retrieve

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli onm get tag:
  description: Retrieve tag values from a given ONM
  usage: '[options] <tag-key>'

onteon-cli onm get tags

Command help and usage:

Usage: onteon-cli onm get tags [options]

Retrieve all tags of a given ONM

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli onm get tags:
  description: Retrieve all tags of a given ONM
  usage: '[options]'

onteon-cli onm add

Command help and usage:

Usage: onteon-cli onm add [options] [command]

Add resources to ONM

Options:
  -h, --help                     display help for command

Commands:
  app <name> <version> <app-id>  Add new app to ONM
  tag <tag-key> <tag-value>      Add tags to a given ONM
  help [command]                 display help for command
YAML spec 
onteon-cli onm add:
  description: Add resources to ONM
  usage: '[options] [command]'

onteon-cli onm add app

Command help and usage:

Usage: onteon-cli onm add app [options] <name> <version> <app-id>

Add new app to ONM

Arguments:
  name        Application name to use
  version     Application version to use
  app-id      Application ID

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli onm add app:
  description: Add new app to ONM
  usage: '[options] <name> <version> <app-id>'

onteon-cli onm add tag

Command help and usage:

Usage: onteon-cli onm add tag [options] <tag-key> <tag-value>

Add tags to a given ONM

Arguments:
  tag-key     Tag key
  tag-value   Tag value

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli onm add tag:
  description: Add tags to a given ONM
  usage: '[options] <tag-key> <tag-value>'

onteon-cli onm create

Command help and usage:

Usage: onteon-cli onm create [options] [command]

Create resources on ONM

Options:
  -h, --help                       display help for command

Commands:
  app <app-id>                     Create app on ONM
  instance <app-id> <instance-id>  Create add on ONM
  help [command]                   display help for command
YAML spec 
onteon-cli onm create:
  description: Create resources on ONM
  usage: '[options] [command]'

onteon-cli onm create app

Command help and usage:

Usage: onteon-cli onm create app [options] <app-id>

Create app on ONM

Arguments:
  app-id      Application ID

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli onm create app:
  description: Create app on ONM
  usage: '[options] <app-id>'

onteon-cli onm create instance

Command help and usage:

Usage: onteon-cli onm create instance [options] <app-id> <instance-id>

Create add on ONM

Arguments:
  app-id       Application ID
  instance-id  Instance ID

Options:
  -h, --help   display help for command
YAML spec 
onteon-cli onm create instance:
  description: Create add on ONM
  usage: '[options] <app-id> <instance-id>'

onteon-cli onm start

Command help and usage:

Usage: onteon-cli onm start [options] [command]

Start ONM resources

Options:
  -h, --help                       display help for command

Commands:
  instance <app-id> <instance-id>  Start instance from ONM
  workflow <workflow-file>         Start a workflow on ONM
  help [command]                   display help for command
YAML spec 
onteon-cli onm start:
  description: Start ONM resources
  usage: '[options] [command]'

onteon-cli onm start instance

Command help and usage:

Usage: onteon-cli onm start instance [options] <app-id> <instance-id>

Start instance from ONM

Arguments:
  app-id       Application ID
  instance-id  Instance ID

Options:
  -h, --help   display help for command
YAML spec 
onteon-cli onm start instance:
  description: Start instance from ONM
  usage: '[options] <app-id> <instance-id>'

onteon-cli onm start workflow

Command help and usage:

Usage: onteon-cli onm start workflow [options] <workflow-file>

Start a workflow on ONM

Arguments:
  workflow-file  Workflow file to start

Options:
  -h, --help     display help for command
YAML spec 
onteon-cli onm start workflow:
  description: Start a workflow on ONM
  usage: '[options] <workflow-file>'

onteon-cli onm exec

Command help and usage:

Usage: onteon-cli onm exec [options] [command]

Execute commands on ONM resources

Options:
  -h, --help                                               display help for command

Commands:
  instance <app-id> <instance-id> <command> [commandArgs]  Execute command on app instance
  node [options] <command>                                 Execute command on ONM node
  help [command]                                           display help for command
YAML spec 
onteon-cli onm exec:
  description: Execute commands on ONM resources
  usage: '[options] [command]'

onteon-cli onm exec instance

Command help and usage:

Usage: onteon-cli onm exec instance [options] <app-id> <instance-id> <command> [commandArgs]

Execute command on app instance

Arguments:
  app-id       Application ID
  instance-id  Instance ID
  command      Command to execute
  commandArgs  Command arguments (default: "")

Options:
  -h, --help   display help for command
YAML spec 
onteon-cli onm exec instance:
  description: Execute command on app instance
  usage: '[options] <app-id> <instance-id> <command> [commandArgs]'

onteon-cli onm exec node

Command help and usage:

Usage: onteon-cli onm exec node [options] <command>

Execute command on ONM node

Arguments:
  command                   Command to execute

Options:
  --use-shell <bool>        Interpret the command as a shell commands (default:
                            true)
  --execute-time <seconds>  Max time to wait for command completion (default:
                            "100")
  --output-only             Only show the output received from a command
                            execution (default: false)
  -h, --help                display help for command
YAML spec 
onteon-cli onm exec node:
  description: Execute command on ONM node
  usage: '[options] <command>'

onteon-cli onm stop

Command help and usage:

Usage: onteon-cli onm stop [options] [command]

Stop ONM resources

Options:
  -h, --help                       display help for command

Commands:
  instance <app-id> <instance-id>  Stop instance from ONM
  help [command]                   display help for command
YAML spec 
onteon-cli onm stop:
  description: Stop ONM resources
  usage: '[options] [command]'

onteon-cli onm stop instance

Command help and usage:

Usage: onteon-cli onm stop instance [options] <app-id> <instance-id>

Stop instance from ONM

Arguments:
  app-id       Application ID
  instance-id  Instance ID

Options:
  -h, --help   display help for command
YAML spec 
onteon-cli onm stop instance:
  description: Stop instance from ONM
  usage: '[options] <app-id> <instance-id>'

onteon-cli onm terminate

Command help and usage:

Usage: onteon-cli onm terminate [options] [command]

Terminate ONM resources

Options:
  -h, --help                       display help for command

Commands:
  instance <app-id> <instance-id>  Terminate instance from ONM
  help [command]                   display help for command
YAML spec 
onteon-cli onm terminate:
  description: Terminate ONM resources
  usage: '[options] [command]'

onteon-cli onm terminate instance

Command help and usage:

Usage: onteon-cli onm terminate instance [options] <app-id> <instance-id>

Terminate instance from ONM

Arguments:
  app-id       Application ID
  instance-id  Instance ID

Options:
  -h, --help   display help for command
YAML spec 
onteon-cli onm terminate instance:
  description: Terminate instance from ONM
  usage: '[options] <app-id> <instance-id>'

onteon-cli onm delete

Command help and usage:

Usage: onteon-cli onm delete [options] [command]

Delete resources from ONM

Options:
  -h, --help                                 display help for command

Commands:
  upload|up <name> <version>                 Delete files uploaded onto a given ONM
  instance [options] <app-id> <instance-id>  Delete app instance from ONM
  app [options] <app-id>                     Delete app from ONM
  tag <tag-key>                              Delete specified tag from a given ONM
  tags                                       Delete specified tag from a given ONM
  help [command]                             display help for command
YAML spec 
onteon-cli onm delete:
  description: Delete resources from ONM
  usage: '[options] [command]'

onteon-cli onm delete upload

Command help and usage:

Usage: onteon-cli onm delete upload|up [options] <name> <version>

Delete files uploaded onto a given ONM

Arguments:
  name        Application name to use
  version     Application version to use

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli onm delete upload:
  description: Delete files uploaded onto a given ONM
  usage: '[options] <name> <version>'

onteon-cli onm delete instance

Command help and usage:

Usage: onteon-cli onm delete instance [options] <app-id> <instance-id>

Delete app instance from ONM

Arguments:
  app-id             Application ID
  instance-id        Instance ID

Options:
  -r, --permanently  Permanently delete given app instance (default: false)
  -h, --help         display help for command
YAML spec 
onteon-cli onm delete instance:
  description: Delete app instance from ONM
  usage: '[options] <app-id> <instance-id>'

onteon-cli onm delete app

Command help and usage:

Usage: onteon-cli onm delete app [options] <app-id>

Delete app from ONM

Arguments:
  app-id             Application ID

Options:
  -r, --permanently  Permanently delete given app (default: false)
  -h, --help         display help for command
YAML spec 
onteon-cli onm delete app:
  description: Delete app from ONM
  usage: '[options] <app-id>'

onteon-cli onm delete tag

Command help and usage:

Usage: onteon-cli onm delete tag [options] <tag-key>

Delete specified tag from a given ONM

Arguments:
  tag-key     Tag key

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli onm delete tag:
  description: Delete specified tag from a given ONM
  usage: '[options] <tag-key>'

onteon-cli onm delete tags

Command help and usage:

Usage: onteon-cli onm delete tags [options]

Delete specified tag from a given ONM

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli onm delete tags:
  description: Delete specified tag from a given ONM
  usage: '[options]'

onteon-cli endpoints

Command help and usage:

Usage: onteon-cli endpoints [options] [command]

Onteon cluster endpoints commands

Options:
  -h, --help      display help for command

Commands:
  get             Show available OCC endpoints
  help [command]  display help for command
YAML spec 
onteon-cli endpoints:
  description: Onteon cluster endpoints commands
  usage: '[options] [command]'

onteon-cli endpoints get

Command help and usage:

Usage: onteon-cli endpoints get [options]

Show available OCC endpoints

Options:
  -h, --help  display help for command
YAML spec 
onteon-cli endpoints get:
  description: Show available OCC endpoints
  usage: '[options]'