Onteon CLI v2 - General Options

Version

You can check version of your OnteonCLI by executing onteon-cli --version or onteon-cli -V.

root@de8f7a95da2e:/opt/onteon# onteon-cli --version
2.0.0

Help

To check available commands or options you can use --help or -h flag.

Check list of commands

root@de8f7a95da2e:/opt/onteon# onteon-cli --help
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

root@de8f7a95da2e:/opt/onteon# onteoncli onm --help
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

Check command arguments

root@de8f7a95da2e:/opt/onteon# onteon-cli onm add app --help
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