ovownodeutil

Nodes

Nodes are referred to by primary node name and Id:

Primary node name (-node_name parameter)

Represents the PrimaryNodeName property of the OV_ManagedNode object that uniquely identifies a node.

Node Id (-node_id parameter)

Represents the Name property of the OV_ManagedNode object that uniquely identifies a node. It is usually a GUID, but can also be any other unique string.

External nodes

External nodes are referred to by hierarchical path and external node ID:

Hierarchical path (-exnode_path parameter)

Represents a directory-like path of node group names that uniquely identifies a group and an external node name. Captions/Display Names are used as node group names. The Caption property of OV_ExternalNode is used as an external node name. A backslash (\) is used as a separator (for example, \rocco\cad\room108). The path must always start with a single backslash (\), which denotes the Root. If the external node name itself contains a backslash, it must be escaped with an additional backslash (\\).

External node ID (-exnode_id parameter)

Represents the Name property of the OV_ExternalNode object that uniquely identifies a node. It is usually a GUID, but can also be any other unique string.

Node groups

Node groups are referred to by hierarchical path and group Id:

Hierarchical path (-group_path parameter)

Represents a directory-like path of node group names that uniquely identifies a group. Captions/Display Names are used as node group names. A backslash (\) is used as a separator (for example, \rocco\cad\room108). The path must always start with a single backslash (\), which denotes the Root. If the node name itself contains a backslash, it must be escaped with an additional backslash (\\).

Group Id (-group_id parameter)

Represents the Name property of the OV_Nodegroup object that uniquely identifies a node group. It is usually a GUID, but can also be any other unique string.

Command synopsis

ovownodeutil [ -help ] [ -add_node -node_name <primary node name> [ -group_path <hierarchy path> | -group_id <group id> ] [ -agent_comm_type (DCE | HTTPS) ] [ -agent_bin_format <agent binary format> ] [ -caption <caption name> ] [ -comm_path <communication path> ] [ -always_resolve_comm_path (yes | no) ] [ -auto_update_comm_path (yes | no) ] [ -auto_deploy (yes | no) ] ] [ -add_nodewithtype -node_name <primary node name> -ostype <OS type caption> -osversion <OS version caption> -systemtype <system type caption> -osbits (32 | 64) -agent_bin_format <agent binary format> [ -group_path <hierarchy path> | -group_id <group id> ] [ -agent_comm_type (DCE | HTTPS) ] [ -caption <caption name> ] [ -comm_path <communication path> ] [ -always_resolve_comm_path (yes | no) ] [ -auto_update_comm_path (yes | no) ] [ -auto_deploy (yes | no) ] ] [ -delete_node ( -node_name <primary node name> | -node_id <node id> ) ] [ -add_group ( -group_path <hierarchy path> ] [ -delete_group ( -group_path <hierarchy path> | -group_id <group id> ) ] [ -assign_node ( -node_name <primary node name> | -node_id <node id> ) ( -group_path <hierarchy path> | -group_id <group id> ) ] [ -deassign_node (-node_name <primary node name> | -node_id <node id>) ] ( -group_path <hierarchy path> | -group_id <group id> ) ] [ -list_nodes (-group_path <hierarchy path> | -group_id <group id>) [ -recursive ] ] [ -list_groups ] [ -change_comm_opt ( -node_name <primary node name> | -node_id <node id> ) [ -comm_path <communication path> ] [ -always_resolve_comm_path (yes | no) ] [ -auto_update_comm_path (yes | no) ] ] [ -change_comm_opt ( -group_path <hierarchy path> | -group_id <group id> ) [ -always_resolve_comm_path (yes | no) ] [ -auto_update_comm_path (yes | no) ] ] [ -deassign_tool ( ( -node_name <primary node name> | -node_id <node id> ) | ( -group_path <hierarchy path> | -group_id <group id> ) ) ( -tool_path <tool hierarchy path> | -tool_id <tool id> ) ] [ -deassign_autodeploy_pg (-group_path <hierarchy path> | -group_id <group id>) (-pg_path <policy group hierarchy path> | -pg_id <pol. group id>) ] [ -delete_report ( -group_path <hierarchy path> | -group_id <group id> ) -report_name <report name> ] [ -delete_graph ( -group_path <hierarchy path> | -group_id <group id> ) ] [ -outage_node [-scheduled | -unplanned ] [ -node_name {<primary node name>} ] [ -node_id {<node id>} ] [ -group_path {<hierarchy path>} ] [ -group_id {<group id>} ] -get [ -single_line | -detailed | -show_outage_only ] ] [ -outage_node [ -scheduled | -unplanned ] [ -node_name {<primary node name>} ] [ -node_id {<node id>} ] [ -group_path {<hierarchy path>} ] [ -group_id {<group id>} ] ( -on | -off | -toggle ) [ -delete_msgs ] [ -disable_heartbeat ] ] [ -add_exnode -caption <caption name> [ -group_path <hierarchy path> | -group_id <group id> ] ( -ip_address <IP address pattern> | -ip_name <IP name pattern> | -other <other pattern> ) [ -order <order number> ] [ -check_before_managed_nodes ] ] [ -delete_exnode ( -exnode_path <external node hierarchical path> | -exnode_id <unique_node_id> ) ] [ -assign_exnode ( -exnode_path <external node hierarchical pat> | -exnode_id <unique_node_id> ) ( -group_path <hierarchy path> | -group_id <group id> ) ] [ -deassign_exnode ( -exnode_path <external node hierarchical pat> | -exnode_id <unique_node_id> ) ( -group_path <hierarchy path> | -group_id <group id> ) ] [ -list_exnodes [ -group_path <hierarchy path> | -group_id <group id> ] [-recursive] ] [ -outage_exnode [-scheduled | -unplanned ] [ -exnode_path <external node hierarchical path> } ] [ -exnode_id {<unique_node_id>} ] [ -group_path {<hierarchy path>} ] [ -group_id {<group id>} ] -get [ -single_line | -detailed | -show_outage_only ] ] [ -outage_exnode [ -scheduled | -unplanned ] [ -exnode_path <external node hierarchical path> } ] [ -exnode_id {<unique_node_id>} ] [ -group_path {<group_hierarchy_path>} ] [ -group_id {<unique_group_id>} ] ( -on | -off | -toggle ) [ -delete_msgs ] ]

Tool options

-help

Show tool usage and description.

-add_node

Adds a node to this management server.

-node_name <primary node name>: Sets the PrimaryNodeName property of the new node.
-group_path <hierarchy path>: Sets a parent node group of the new node by hierarchical path. The node group must exist.
-group_id <group id>: Sets a parent node group of the new node by its ID. The node group must exist.
-agent_comm_type (DCE | HTTPS): Sets the communication type of the nodes agent.
-agent_bin_format <agent binary format>: Sets the agent binary format (x86, x64, IA64, and so on).
-caption <caption name>: Sets the Caption property of the new node.
-comm_path <communication path>: Sets the CommunicationPath property of the new node. It can contain the DNS name, WINS name, or IP.
-always_resolve_comm_path (yes | no): If set to yes, the communication to the new node is always resolved before contacting the agent (DHCP).
-auto_update_comm_path (yes | no): If set to yes, the CommunicationPath property is updated by the agent automatically.
-auto_deploy (yes | no): If set to yes, the management server attempts to deploy auto-deployment policies or packages of the parent node groups to the node. Otherwise, no automatic deployment occurs (primarily intended for nodes imported from another management server).

-add_nodewithtype

Adds a node to this management server with system information. Use this when the discovery service cannot find the node's system information automatically. Valid values for node system information are visible in the System tab of the Node Properties dialog box.

-node_name <primary node name>: Sets the PrimaryNodeName property of the new node.
-ostype <OS type caption>: Sets the operating system type.
-osversion <OS version caption>: Sets the operating system version.
-systemtype <system type caption>: Sets the system type.
-osbits (32 | 64): Sets the operating system bit length.
-agent_bin_format <agent binary format>: Sets the agent binary format.
-group_path <hierarchy path>: Sets a parent node group of the new node by hierarchical path. The node group must exist.
-group_id <group id>: Sets a parent node group of the new node by its ID. The node group must exist.
-agent_comm_type (DCE | HTTPS): Sets the communication type of the nodes agent.
-agent_bin_format <agent binary format>: Sets the agent binary format (x86, x64, IA64, and so on).
-caption <caption name>: Sets the Caption property of the new node.
-comm_path <communication path>: Sets the CommunicationPath property of the new node. It can contain the DNS name, WINS name, or IP.
-always_resolve_comm_path (yes | no): If set to yes, the communication to the new node is always resolved before contacting the agent (DHCP).
-auto_update_comm_path (yes | no): If set to yes, the CommunicationPath property is updated by the agent automatically.
-auto_deploy (yes | no): If set to yes, the management server attempts to deploy auto-deployment policies or packages of the parent node groups to the node. Otherwise, no automatic deployment occurs (primarily intended for nodes imported from another management server).

-delete_node

Deletes a node from this management server. All the node associations are deleted as well.

-node_name <primary node name>: Specifies a node by its PrimaryNodeName property.
-node_id <node id>): Specifies a node by its ID.

-add_group

Adds a node group to this management server.

-group_path <hierarchy path>: Specifies the hierarchical path of the new node group. All non-existing groups from the path are created automatically.

-delete_group

Deletes a node group from this management server. All the group associations are deleted as well.

-group_path <hierarchy path>: Specifies a node group to be deleted by hierarchical path.
-group_id <group id>: Specifies a node group to be deleted by its ID.

-assign_node

Assigns a node to a node group. Both the node and the node group must already exist.

-node_name <primary node name>: Specifies a node by its PrimaryNodeName property.
-node_id <node id>): Specifies a node by its ID.
-group_path <hierarchy path>: Specifies a parent node group by hierarchical path.
-group_id <group id>: Specifies a parent node group by its ID.

-deassign_node

De-assigns a node from a node group. The node is not deleted. Only its association to the node group is removed.

-node_name <primary node name>: Specifies a node by its PrimaryNodeName property.
-node_id <node id>): Specifies a node by its ID.
-group_path <hierarchy path>: Specifies a parent node group by its hierarchical path.
-group_id <group id>: Specifies a parent node group by its ID.

-list_nodes

Lists nodes belonging to a specific node group. If no node group is specified, the Root is used as default. Some nodes may be listed more than once because they may belong to more than one node group, including the HPOM for Windows predefined node groups. This is especially the case when the -recursive option is used on a higher-level node group or Root, and a larger number of node groups is affected.

-group_path <hierarchy path>: Specifies a node group by hierarchical path.
-group_id <group id>: Specifies a node group by its ID.
-recursive: Specifies that the child node group is searched recursively for containing nodes.

-list_groups

Lists all node groups on this management server.

-change_comm_opt

Changes the communication options of a single node or of nodes belonging to specific node group.

-node_name <primary node name>: Specifies a node by its PrimaryNodeName property.
-node_id <node id>): Specifies a node by its ID.
-group_path <hierarchy path>: Specifies a node group by hierarchical path.
-group_id <group id>: Specifies a node group by its ID.
-comm_path <communication path>: Sets the CommunicationPath property of the node. It can contain a DNS name, a WINS name, or an IP. If a node group is selected, this option is not allowed.
-always_resolve_comm_path (yes | no): If set to yes, the communication to the node is always resolved before contacting the agent (DHCP).
-auto_update_comm_path (yes | no): If set to yes, the CommunicationPath property is updated automatically by the agent.

-deassign_tool

De-assigns a tool (OV_Action object) from a node or node group (but only one entity at a time).

-node_name <primary node name>: Specifies a node by its PrimaryNodeName property.
-node_id <node id>): Specifies a node by its ID.
-group_path <hierarchy path>: Specifies a node group by hierarchical path.
-group_id <group id>: Specifies a node group by its ID.
-tool_path <tool hierarchy path>: Specifies a tool to be de-assigned by hierarchical path, which is a directory-like path of tool group names (Captions/Display Name properties) that uniquely identifies a group. A backslash (\) is used as a separator. The tool name must appear at the end of the path.
-tool_id <tool id>): Specifies a tool to be de-assigned by its ID.

-deassign_autodeploy_pg

De-assigns an auto-deployment policy group from a node group.

-group_path <hierarchy path>: Specifies a node group by hierarchical path.
-group_id <group id>: Specifies a node group by its ID.
-pg_path <policy hierarchy path>: Specifies a policy group to be de-assigned by hierarchical path, which is a directory-like path of policy group names (Captions/Display Name properties) that uniquely identifies a group. A backslash (\) is used as a separator.
-pg_id <policy group id>: Specifies a policy group to be de-assigned by its ID.

-delete_report

Deletes a report from a node group.

-group_path <hierarchy path>: Specifies a node group by hierarchical path.
-group_id <group id>: Specifies a node group by its ID.
-report_name <report name>: Specifies a report to be deleted.

-delete_graph

Deletes graphing information from a node group.

-group_path <hierarchy path>: Specifies a node group by hierarchical path.
-group_id <group id>: Specifies a node group by its ID.

-outage_node

Sets or gets the outage state of nodes, node groups, or both.

-scheduled: Sets the scheduled outage mode. (Used in case of scheduled outages.)
-unplanned: Sets the unplanned outage mode. (Used in case of maintenance.)
-node_name <primary node name>: Specifies a node by its PrimaryNodeName property.
-node_id <node id>: Specifies a node by its ID.
-group_path <hierarchy path>: Specifies a node group by hierarchical path.
-group_id <group id>: Specifies a node group by its ID.
-on: Enables the outage mode for a specified node or node group.
-off: Disables the outage mode for a specified node or node group.
-toggle: Switches the node or node group outage state to the opposite state (from -on to -off, then from -off to -on, and so on).
-get: Returns the outage state (on or off) for a specified node or node group. If neither switch (-scheduled or -unplanned) is defined, the outage states of both modes are returned.
NOTE:
If one of the "set outage state" switches (-on, -off, or -toggle) is specified, at least one of the "external node or node group specification" switches (-node_name, -node_id, -group_path, or -group_id) must be specified. If the -get switch is specified, and none of the "node or node group specification" switches is specified, the tool returns the outage state for all nodes.
-delete_msgs: Specifies a messages to be deleted during an outage. Otherwise, messages are acknowledged automatically.
-disable_heartbeat: Specifies heartbeat polling to be disabled during an outage.
-node_name, -node_id, -group_path, -group_id: Specifies at least one node or node group. To specify more than one node or node group, you can use multiple switches. Each switch can have one or more parameters.
-detailed: Specifies the detailed format of output.
-single_line: Specifies the compressed format of output that is printed in one line.
-show_outage_only: Specifies the detailed format of output. It is the same as detailed format, except it shows only nodes that are in at least one of the outage modes.

-add_exnode

Adds external node to this management server.

-caption <caption name>: Sets the Caption property of the new node.
-group_path <hierarchy path>: Sets a parent node group of the new node by hierarchical path. The node group must exist.
-group_id <group id>: Sets a parent node group of the new node by its ID. The node group must exist.
-ip_address <IP address pattern>: Specifies the pattern data type as IP address and sets <IP address pattern> as object pattern.
-ip_name <IP name pattern>: Specifies pattern data type as IP name and sets <IP a name pattern> as an object pattern.
-other <other pattern>: Specifies the pattern data type as other and sets <other pattern> as an object pattern.
-order <order number>: Specifies the order in which the external nodes are evaluated. This is an optional parameter. Default is 0.
-check_before_managed_nodes: Specifies that the external node is checked before the managed nodes. If this parameter is not specified, the external node is not checked before managed nodes.

-delete_exnode

Deletes an external node from this management server.

-exnode_path <external node hierarchical path>: Specifies an external node by hierarchical path.
-exnode_id <unique_node_id>: Specifies an external node by its ID.

-assign_exnode

Assigns an external node to a node group.

-exnode_path <external node hierarchical path>: Specifies an external node by hierarchical path.
-exnode_id <unique_node_id>: Specifies an external node by its ID.
-group_path <hierarchy path>: Sets a parent node group of the new node by hierarchical path. The node group must exist.
-group_id <group id>: Sets a parent node group of the new node by its ID. The node group must exist.

-deassign_exnode

De-assigns an external node from a node group.

-exnode_path <external node hierarchical path>: Specifies an external node by hierarchical path.
-exnode_id <unique_node_id>: Specifies an external node by its ID.
-group_path <hierarchy path>: Sets a parent node group of the new node by hierarchical path. The node group must exist.
-group_id <group id>: Sets a parent node group of the new node by its ID. The node group must exist.

-list_exnodes

Lists external nodes belonging to a specific node group. If no node group is specified, Root is used as default. Some external nodes may be listed more than once because they may belong to more than one node group, including the HPOM for Windows predefined node groups. This is especially the case when the -recursive option is used on a higher-level node group or Root, and a larger number of node groups is affected.

-group_path <hierarchy path>: Specifies a node group by hierarchical path.
-group_id <group id>: Specifies a node group by its ID.
-recursive: Specifies that the child node group is searched recursively for containing external nodes.

-outage_exnode

Sets or gets the outage state of nodes, node groups, or both.

-scheduled: Sets the scheduled outage mode. (Used in case of scheduled outages.)
-unplanned: Sets the unplanned outage mode. (Used in case of maintenance.)
-exnode_path <external node hierarchical path>: Specifies an external node by hierarchical path.
-exnode_id <unique_node_id>: Specifies an external node by its ID.
-group_path <hierarchy path>: Specifies a node group by hierarchical path.
-group_id <group id>: Specifies a node group by its ID.
-on: Enables the outage mode for a specified external node or node group.
-off: Disables the outage mode for a specified external node or node group.
-toggle: Switches the external node or node group outage state to the opposite state (from -on to -off, then from -off to -on, and so on).
-get: Returns the outage state (on or off) for a specified external node or node group. If neither switch (-scheduled or -unplanned) is defined, the outage states of both modes are returned.
NOTE:
If one of the "set outage state" switches (-on, -off, or -toggle) is specified, at least one of the "external node or node group specification" switches (-node_name, -node_id, -group_path, or -group_id) must be specified. If the -get switch is specified, and none of the "node or node group specification" switches is specified, the tool returns the outage state for all external nodes.
-delete_msgs: Specifies a messages to be deleted during an outage. Otherwise, messages are acknowledged automatically.
-detailed: Specifies the detailed format of output.
-single_line: Specifies the compressed format of output that is printed in one line.
-show_outage_only: Specifies the detailed format of output. It is the same as detailed format, except it shows only nodes that are in at least one of the outage modes.

Examples

ovownodeutil -help

Gets help and usage for the tool.

ovownodeutil -add_node -node_name kermit -group_path
\cad\ulm

Adds a new node with the Primary Node Name kermit and assigns it to the existing node group \cad\ulm.

ovownodeutil -assign_node -node_name kermit -group_path
\cad\koeln

Assigns an existing node with the Primary Node Name kermit to the existing node group \cad\koeln.

ovownodeutil -change_comm_opt -node_name kermit
-always_resolve_comm_path yes

Changes the communication option for an existing node with the Primary Node Name kermit. Communication to the node is resolved before the agent is contacted.

ovownodeutil -outage_node -node_name Node1 Node2 -node_id
Node1_ID -group_path \Group1\SubBroup1 -group_id SubGroup1_ID
-scheduled -on -delete_msgs –disable_heart_beat

Enables or disables outage of nodes or node groups.

ovownodeutil -outage_node -node_name Node2 -unplanned
-get

Gets the state of the node outage.