om vol print status

Display the service status, with a detailed view of the local instance.

Resources Flags:

  1. R Running, . Not Running
  2. M Monitored, . Not Monitored
  3. D Disabled, . Enabled
  4. O Optional, . Not Optional
  5. E Encap, . Not Encap
  6. P Not Provisioned, . Provisioned
  7. S Standby, . Not Standby
  8. <n> Remaining Restart, + if more than 10, . No Restart

--color=<string>

Colorize output. Possible values are:

  • auto: guess based on tty presence
  • always|yes: always colorize
  • never|no: never colorize

--daemon

A flag inhibiting the command daemonization. Set by the daemonization routine.

--debug

Increase stream and file log verbosity up to the debug level.

--env

Export the uppercased variable in the os environment.

With the create action only, set a env section parameter in the service configuration file. Multiple --env <key>=<val> can be specified. For all other actions.

--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.

--hide-disabled

Do not include the disabled resources. This option supersedes the show_disabled value in the service configuration.

--local

Execute the service action on the local service instances only, ignoring cluster-wide considerations.

--namespace=<string>

The namespace to switch to for the action. Namespaces are cluster partitions. A default namespace can be set for the session setting the OSVC_NAMESPACE environment variable.

--node=<string>

The node to send a request to. If not specified the local node is targeted.

--show-disabled

Include the disabled resources. This option supersedes the show_disabled value in the service configuration.

--status=<string>

Operate only on service with a local instance in the specified availability status (up, down, warn, ...).

--waitlock=<string>

A duration expression like 5s. The maximum wait time when acquiring the service action lock.

-h, --help

Show this help message and exit.

-p, --parallel

Start actions on specified services in parallel. max_parallel in node.conf limits the number of parallel running subprocesses.

-r, --refresh

Drop status caches and re-evaluate before printing.

-s, VAL, --service=<string>

A service selector expression [!]<expr>[<sep>[!]<expr>] where:

  • ! is the expression negation operator
  • <sep> can be:
    • , OR expressions
    • + AND expressions
  • <expr> can be:
    • a shell glob on service names
    • <param><op><value> where:
      • <param> can be:
        • <rid>:
        • <group>:
        • <rid>.<key>
        • <group>.<key>
        • <single value jsonpath expression on the $.monitor.services.<path> dictionary extended under the 'nodes' key by each instance 'status' and 'config' data>
      • <op> can be:
        • < > <= >= =
        • ~ with regexp value

Examples:

  • *dns,ha*+app.timeout>1
  • ip:+task:
  • !*excluded
  • $.avail=warn
  • $.nodes.*.status.avail=warn

Note:

  • ! usage requires single quoting the expression to prevent shell history expansion