Develop > Command-Line Interfaces > opr-node Command-Line Interface

opr-node Command-Line Interface

You can use the opr-node command-line interface (CLI) to manually add, modify, list, or delete nodes in the RTSM. You can also add a node to a node group, and add, modify, and delete node groups. This tool can act on CIs of the type node, computer, nt, unix and IpAddress.

You can use this tool instead of synchronizing nodes from another OM server or running OMi discovery tools. In automation cases when no real user is online, you can also use this tool to manage nodes.

For more information, see Monitored Nodes.

Location

<OMi_HOME>/opr/bin/opr-node[.bat|.sh]

You can run opr-node on a gateway or a data processing server. The server processes must be running.

Synopsis

opr-node -help | -version | -example |<CONNECTION_INFO> <operation>

Options

ClosedSyntax for <CONNECTION_INFO>

-rc_file <file> &| -username <login name> [ -password <password> | -smartcard | -winCrypto | -jks <keystore path> -jksPassword <keystore password> ] [[-port <port>] [-server <gatewayserver>] [-ssl] | [-u <URL>]]

Note If <CONNECTION_INFO> is omitted, the command is executed on the server to which you are logged on.

Option Description
{-rc_file | -rcf }<file> Location of your credential store. Values for your username, password, java keystore location, and java keystore password can be defined here, enabling you to run commands without having to specify the values individually each time. Use the options -list_rc, -set_rc, and -delete_rc to work with the file. The default file is <OMi_HOME>/.opr-cli-rc. If this option is not specified, then commands automatically check the default file location for credentials. You must specify this option if your credential store file is in a non-default location. If this file does not exist or does not contain the correct settings, you must manually specify the credentials using the other command options.
{-list_rc| -lrc} [-rc_file <file>] Display the content of the file from which credentials are read. The file contains fields for java keystore, keystore password, username and password, and is encrypted by a hardcoded key.
{-set_rc | -src} <key>=<value> [-rc_file <file>] Configure one setting in the file from which credentials are read. Specify the setting and the new value by using a key=value pair. For example, -set_rc password=<password string>.
{-delete_rc | -drc} <setting> [-rc_file <file> } Delete setting from file from which credentials are read. Possible settings are username, password, jks, and jksPassword.
{-username|-user} <login name>

Sets the login name of the user required to execute CLI operations on the target gateway server.
{-password|-pw} <password>

Sets the password for the specified user. If using SSH on Cygwin, either enter the password in free text or use other communication methods, for example Java keystore, Windows keystore, or smart card authentication.

Default value: empty string
{-smartcard|-sc}

Use certificate stored on smart card or security token for authentication. When OMi is configured to use CAC authentication, the CLI tools under <OMi_HOME>/opr/bin/ do not directly prompt users to enter the password for the smartcard connected to the system. Instead, users must specify that a smartcard authentication is to be run, using the option -sc or -smartcard. Users attempting to run a tool without the -smartcard option automatically receive an error message.

For more information, see Using command-line tools when client certificate enforcement is used.
{-winCrypto|-wc}

If OMi is configured for TLS mutual authentication, this option specifies to use the Windows certificate store for authentication. The certificate store must hold exactly one client certificate, which OMi will use to authenticate the user. This option is only available on Windows systems.

For details, see Configure Client Certificate or Smart Card Authentication.
{-jks|-j} <keystore path>

If OMi is configured for TLS mutual authentication, this option can be used to specify the Java keystore to be used for authentication. The keystore must hold exactly one client certificate, which OMi will use to authenticate the user.

Note It is not necessary that the client certificate contains the flag "Smart Card Logon (1.3.6.1.4.1.311.20.2.2)" in the "Enhanced Key Usage" field.

For details, see Configure Client Certificate or Smart Card Authentication.
{-jksPassword|-jp} <keystore password>

Password for accessing the Java keystore.
{-port|-p} <port>

Uses port <port> to connect to the target gateway server.

Default:
80 (HTTP)
443 (HTTPS)
-server <GatewayServer>

Sets the target gateway server, using <GatewayServer> as the hostname or IP address to locate it.

Default: FQDN of the OMi gateway server
-ssl

When this option is specified, the HTTPS protocol is used to connect to the target gateway server. If omitted, the HTTP protocol is used.

Cannot be used in conjunction with the -url option.
{-url|-u} <url>

Sets the target gateway server, using <url> as the URL to locate it.

Default:
https://<OMi gateway FQDN>:80/opr‑config‑server
ClosedSyntax for <operation> 
-list_nodes <targets> | -add_node <identifier_options> [<add_options>] 
| -modify_node <identifier_options> [<modify_options>]
| -del_node <identifier_options> | -list_os_types 
| -list_node_groups [-show_details] 
| -list_containing_node_groups <node_identifier>
| -add_node_group <node_group_identifier> [<add_node_group_options>] 
| -modify_node_group <node_group_identifier> [<modify_node_group_options>]
| -del_node_group <node_group_identifier>
<targets> = -query_name <query_name> | -view_name <view_name> 
            | -node_list <node_list> | -node_group <node_group> 
            | -filter_name <filter_name> | -all
<identifier_options> = -node_name <primary_node_name> &| -ci_id <node_ci_id> 
<add_options> = [-ip_addrs <comma_separated_ip_addresses>][-ci_name <ci_name>]
                [-os_type <os_type>][-processor_family <processor_family>]
                [-ci_type <ci_type>][-node_group <node_group_name>]
<modify_options> = [-ip_addrs <comma_separated_ip_addresses>
                   [-add_ip_addrs | -del_ip_addrs]]
                   [-ci_name <ci_name>][-os_type <os_type>]
                   [-processor_family <processor_family>]
                   [-node_group <node_group_name>]
                   [-remove_from_node_group]   
		    [-new_node_name <new_primary_node_name>]
<node_group_identifier> = -node_group <node_group_name>
                          [-parent_node_group <node_group_name>]
<add_node_group_options> = [-node_group_description <node_group_description>]
                           [-parent_node_group <node_group_name>]
<modify_node_group_options> = [-new_name <new_node_group_name>]
                              [-new_description <node_group_description>] 
                              [-new_parent_node_group <node_group_name>]
Option Description
{-add_ip_addrs|-add_ip} Adds the IP address(es) specified in parameter ip_addrs to the node.
{-all} Returns all OM nodes in the RTSM.
{-add_node|-an}

Adds a new OM node to the RTSM.
{-add_node_group |-ang}

Add a new node group.
{-ci_id <HPE Universal CMDB id, 32 characters long>|-ci}

HPE Universal CMDB node CI ID; node_name is used to identify a node if not set.
{-ci_name <ci_name>|-cn}

CI name; identifies a node CI in the HPE Universal CMDB (together with its IP address(es)). If ci_name is not given, node_name is used (if node_name contains quotation marks, the left-most portion is used, typically the short hostname). Stored in the HPE Universal CMDB attribute name and also in attribute display_label.
{-ci_type <HPE Universal CMDB CI type>|-ct}

HPE Universal CMDB type for nodes; can be node, host_node (default), unix, or nt.
{-del_ip_addrs|-del_ip}

Deletes the IP address(es) specified in the parameter ip_addrs from the node.
{-del_node|-dn}

Deletes an OM node from the RTSM.
{-del_node_group |-dng}

Delete a node group.

{‑filter_name <filter_name>|‑fn}

Performs the operation on a list of monitored nodes with the HPE Operations Agent installed that was obtained by applying the node filter.

{-ip_addrs <comma-separated list of IP addresses>|-ip }

IP address(es) of the node; the name service is called, if not set; format either in IPv4 notation or in IPv6 notation. When used with the option -modify_node and without the options -add_ip or -del_ip, the IP address(es) of the node are replaced by the value of option -ip_addrs.
{-list_containing_node_groups|-lcng}

Lists OMi node groups that contain the specified node.

{-list_nodes|-ln}

Lists OM nodes in the RTSM.
{-list_node_groups|-lng}

Lists OMi nodes from the HPE Universal CMDB.
{-list_os_types|-lot}

Lists supported OS types and processor families.
{-modify_node|-mn}

Updates an existing node in the RTSM.
{-modify_node_group |-mng}

Modify a node group.

{-new_description <new node group description>|-nd}

Specify a new description for a node group.

{-new_name <new node group name>|-newn}

Specify a new name for a node group.

{-new_node_name <new_primary_node_name>|-nnn}

Specify a new primary node name, ideally an FQDN. Stored in the HPE Universal CMDB attribute primary_dns_name.
{‑node_group <node_group>|‑ng}

Performs the operation on a group of monitored nodes. A node group is a CI collection containing hosts. Node groups can be maintained in the Monitoring Automation Node Editor or they can be imported through topology synchronization from OM to OMi.

The nodes must exist in the RTSM and be associated with a CI of the type hp_operations_agent.

Specify node groups by their names or their paths (the latter applies to hierarchical node groups imported from OM for Windows).

{-node_group_description| -ngd}

Specify a description of the node group.

{‑node_list <comma or blank separated list of hostnames>| ‑nl}

Returns the node list; checked against RTSM.
{-node_name <primary nodename>|-nn}

Primary node name, ideally an FQDN; stored in the HPE Universal CMDB attribute primary_dns_name.
{-new_parent_node_group <new parent node group name>|-npng}

Specify new parent node group name of the node group.

{-os_type <OS type string>|-os}

OS type / version string. Relevant to select platform dependent configuration for deployment. If not set, it is left empty. Stored in HPE Universal CMDB attribute discovered_os_name; to list supported values use option -list_os_types.
{-processor_family <processor family string>|-pf}

Processor family. Relevant to select platform-dependent configuration for deployment. If not set, it is left empty. Stored in HPE Universal CMDB attribute processor_family; to list supported values use option -list_os_types.
{-parent_node_group <parent_node_group_name>|-png}

Specify the parent node group.
{‑query_name <query name>|‑qn}

Performs the operation on monitored nodes selected by the specified TQL query.
{‑remove_from_node_group|‑rem_ng}

Remove the node from the group specified in the -node_group parameter.

{‑show_details|‑sd}

Show details of the node groups.

{‑view_name <view_name>|‑vn} Performs the operation on monitored nodes selected by the specified view.

Exit Status

Exit Status

Description

Output
0

Successful completion of the requested operation

 No output.
1

Failure of the requested operation

 An error message stating why the operation failed, followed by the tool's help text.
300‑399

HTTP Redirection (300-399)

An error message stating the HTTP error number and description.

For more information about HTTP error status values, see publicly available HTTP documentation.
400‑499

HTTP Client Error (400-499)
500‑599

HTTP Internal Server Error (500-599)

Restrictions

  • Permissions. The user running the opr-node command-line interface must be an OMi user with Monitored Nodes access rights. For more information, see Monitored Nodes and Users, Groups, and Roles.

    Non-admin users also need the following file permissions to operate this command-line tool:

    File Windows Permissions Linux Permissions
    <OMi_HOME>/conf/TopazInfra.ini read r
    <OMi_HOME>/log/opr-clis.log full control rw

    <OMi_HOME>/log/opr-pgctl.log

    Note: This file is not available on gateway server systems.
    		full control rw
    <OMi_HOME>/conf/encryption.properties read r
    <OMi_HOME>/conf/seed.properties read r

    • Examples

    This section shows a number of examples you can use as a starting point for developing your own opr-node commands.

    • List all OM nodes from RTSM:

      opr-node.sh -username user -password passwd -list_nodes -all

    • Add node mynode to RTSM as part of node group mygroup (IP address taken from name service):

      opr-node.sh -username user -password passwd -add_node -node_name
      mynode.example.com -ci_name mynode -os_type "Windows Server 2012 (6.2)"
      -processor_family x86_64 -ci_type nt -node_group mygroup

    • Add node mynode to RTSM as part of node group mysubgroup that is located under myparentgroup in the node group hierarchy (IP address taken from name service):

      opr-node.sh -username user -password passwd -add_node -node_name
      mynode.example.com -ci_name mynode -os_type "Windows Server 2012 (6.2)"
      -processor_family x86_64 -ci_type nt -node_group "/myparentgroup/mysubgroup"

    • Modify CI name node (display_label) of mynode in RTSM and add it to node group mygroup (all other attributes stay the same):

      opr-node.sh -username user -password passwd -modify_node -node_name
      mynode.example.com -ci_name MYNODE -node_group mygroup

    • Modify mynode in RTSM and remove it from node group mygroup:

      opr-node.sh -username user -password passwd -modify_node -node_name
      mynode.example.com -node_group mygroup -remove_from_node_group

    • Modify CI name (display_label) of mynode in RTSM (all other attributes stay the same):

      opr-node.sh -username user -password passwd -modify_node -node_name mynode.example.com -ci_name MYNODE

    • Modify mynode in RTSM and add IP address 192.168.1.123:

      opr-node.bat -username user -password passwd -modify_node -node_name mynode.example.com -ip_addrs 192.168.1.123 -add_ip

    • Modify mynode in RTSM and remove IP address 192.168.1.123:

      opopr-node.sh -username user -password passwd -modify_node -node_name mynode.example.com -ip_addrs 192.168.1.123 -del_ip

    • Modify mynode in RTSM and replace current IP address with 1.2.3.4:

      opr-node.bat -username user -password passwd -modify_node -node_name mynode.example.com -ip_addrs 1.2.3.4

    • Modify mynode in RTSM and replace current primary DNS name to mynewnode:

      opr-node.bat -username user -password passwd -modify_node -node_name mynode.example.com -new_node_name mynewnode.example.com

    • Add or override existing mynode and set its IP address to 1.2.3.4:

      opr-node.bat -username user -password passwd -add_node -node_name mynode.example.com -ip_addrs 1.2.3.4

    • Delete node with CI ID 11112222333344445555666677778888 from RTSM:

      opr-node.sh -username user -password passwd -del_node -ci 11112222333344445555666677778888

    • List all node groups including ID and description:

      opr-node.bat -username user -password passwd -list_node_groups -show_details

    • Add a new top-level node group called newTopLevelNG1:

      opr-node.bat -username user -password passwd -add_node_group -node_group newTopLevelNG1 -v

    • Add a new node group called newNG3 to the existing node group testNG2:

      opr-node.bat -username user -password passwd -add_node_group -node_group newNG3 -parent_node_group testNG2 -v

    • Modify the name of the node group newNG3 (with parent node group testNG2) to changed_newNG3:

      opr-node.bat -username user -password passwd -mod_node_group -node_group newNG3 -parent_node_group testNG2 -new_name changed_newNG3 -v

    • Delete the node group newNG3 (with parent node group testNG2):

      opr-node.bat -username user -password passwd -del_node_group -node_group newNG3 -parent_node_group testNG2 -v

    • List all node groups containing the node with the primary DNS name test.example.com:

      opr-node.bat -username user -password passwd -list_containing_node_groups -node_name test.example.com -v

    • List all node groups containing the node with the ID 11112222333344445555666677778888:

      opr-node.bat -username user -password passwd -list_containing_node_groups -ci_id 11112222333344445555666677778888 -v

    Send Help Center feedback