om node collector cli

Open a Command Line Interface to the collector rest API. The CLI offers autocompletion of paths and arguments, piping JSON data from files. If executed as root and with no –user, the collector is logged in with the node credentials.

–api=<string>

Specify a collector api url different from the one set in node.conf.

–color=<string>

Colorize output. Possible values are:

• auto: guess based on tty presence

• always|yes: always colorize

• never|no: never colorize

–config=<string>

Specify a user-specific collector api connection configuration file. Defaults to “~/.opensvc-cli”.

–debug

Increase stream log verbosity up to the debug level.

–filter=<string>

A JSONPath expression to filter a JSON output.

–format=<string>

Specify a data formatter. Possible values are json, flat_json, csv or table. csv and table formatters are available only for commands returning tabular data.

–insecure

Allow communications with a collector presenting an unverified SSL certificate.

–local

Set to disable cluster-wide operations.

–node=<string>

A node selector expression. Embedded in requests for the daemon to route and multiplex the request to a list of nodes. If not specified the local node is targeted.

–password=<string>

Authenticate with the collector using the specified user credentials instead of the node credentials. Prompted if necessary but not specified.

–refresh-api

Force a reload of the collector’s api digest.

–save

Save the collector cli settings to the file specified by –config or ~/.opensvc-cli by default.

–server=<string>

The server uri to send a request to. If not specified the local node is targeted. Supported schemes are https and raw. The default scheme is https. The default port is 1214 for the raw scheme, and 1215 for https. The uri can be a fullpath to a listener socket. In this case, the scheme is deduced from the socket. Examples: raw://1.2.3.4:1214, https://relay.opensvc.com, /var/lib/opensvc/lsnr/h2.sock.

–user=<string>

Authenticate with the collector using the specified user credentials instead of the node credentials. Required with om node register when the collector is configured to refuse anonymous register.

-h, –help

Show this help message and exit