Socket-based command port

By default, a socket-based command port module starts when the probe starts. For details of using an HTTP/HTTPS command port instead, see HTTP/HTTPS command port.

Configuring the socket-based command port

To use the socket-based command port feature, you must enable it by using the CommandPort property to specify a port through which commands will be sent. The default is 6970. You can use the CommandPortLimit property to specify the maximum number of connections to allow at one time. The default is 10 connections.

If you are using a second instance of the probe in a failover configuration, you must use the PeerCommandPort property to specify a port through which commands can be sent to the slave probe.

When you want to issue CLI commands, use Telnet to connect through the specified port.

Note: Depending on the version of Windows you are using, you might have to download Telnet from http://technet.microsoft.com/ and install it manually.

CLI commands

The following table describes the CLI commands that you can use with the socket-based command port.

Table 1. CLI commands
Command	Description
acknowledge_alarm	Use this command to acknowledge one or more alarms. The command takes a list of alarm identifiers separated by semicolons as parameters in the following format: `acknowledge_alarm alarm_id_01;alarm_id_02; ... ;alarm_id_nn` Where `alarm_id_01;alarm_id_02; ... alarm_id_nn` represents a list or `nn` alarm IDs. The system returns the identifiers of any alarms that cannot be acknowledged. Note: You can use the AckedResolutionState property to specify a value for the `ResolutionState` field of an alarm acknowledged using the CLI. The default value is 85, which is the standard value understood by Microsoft SCOM 2016 to identify an alarm as acknowledged.
resolve_alarm	Use this command to resolve alarms in the Microsoft SCOM 2016 server. The command takes a list of alarm identifiers separated by semicolons as parameters, in the following format: `resolve_alarm alarm_id_01;alarm_id_02; ... ;alarm_id_nn` Where `alarm_id_01;alarm_id_02; ... alarm_id_nn` represents a list or `nn` alarm IDs. The system returns the identifiers of any alarms that cannot be resolved. Note: You can use the ClearedResolutionState property to specify a value for the `ResolutionState` field of an alarm resolved using the CLI command. The default value assigned is 255, which is the standard value understood by Microsoft SCOM 2016 to identify an alarm as resolved.
set_ticket_id	Use this command to assign a value to the ticket identifier of an alarm on the Microsoft SCOM 2016 server. The command takes the alarm identifier and the value to be assigned to the ticket identifier as parameters, in the following format: `set_ticket_id alarm_id ticket_id`
set_field	Use this command to assign values to individual alarm fields on the Microsoft SCOM 2016 server. The command takes a list of alarm identifiers, field names, and field values as parameters, in the following format: `set_field alarm_id_01(field_name=field_value) alarm_id_02(field_name=field_value) ... alarm_id_nn(field_name=field_value)` Where `field_name` in each case can be one of the following fields: `CustomFieldn` (where `n` is an integer from 1 to 10) `Owner` `ResolutionState` `TicketId` The system returns the identifiers of any alarms for which field values cannot be assigned.
exit/quit	Use this command to close the connection.
help	Use this command to display online help about the CLI.
version	Use this command to display the version of the probe and the CLI.