OMS Server Functions

Owned by Stonebranch (Deactivated)
Jul 05, 2023
1 min read

Overview

The command line syntax for each execution of the CLI command, uagcmd, must specify a single CLI function, required / optional Global parameters, and required / optional function-specific parameters. You must use the required Global parameters to connect to OMS Servers and to log on to a Controller (User ID and Password).

Universal Controller supports the following CLI functions for OMS Servers, which are listed alphabetically on this page.

Syntax, parameters, and examples for each function are provided.

List OMS Servers

Description

Lists OMS Servers and their status.

Syntax

uagcmd ops-oms-status global parameters server-address=address:[port] [options=v]

Parameter
  • server-address=
    Required; Server address or partial server address of one or more OMS servers. Wildcards are supported.
  • options=
    Optional; Supports the v (verbose) option, which will toggle the SysId column in the response output.

Example

 
uagcmd ops-oms-status -c config.cfg server-address=lx12-x64:7878

Note

The CLI command response will contain the following information for each matching OMS Server:

  • Name - OMS Server name
  • Status - OMS Server status
  • Session Status - OMS Server sessions status
  • Sysid - OMS Server sys_id