Skip to content
CA Unified Infrastructure Management - 8.2
Documentation powered by DocOps

Robot Attribute Reference

Last update May 17, 2015

This article lists all required and optional attributes for a robot. Any of these attributes can be included in an XML or answer file for bulk robot deployment. The most commonly used attributes can be configured in the Admin Console or Infrastructure Manager controller probe GUI.

Required Attributes

The following table lists all robot attributes you are required to specify when you install or deploy a robot.

Attribute Description
profile

Operating system on target system:

  • aix
  • centos
  • debian
  • hp-ux
  • linux (legacy support for previous RPM packages)
  • opensuse
  • rhel (Red Hat Enterprise Linux)
  • solaris
  • suse (SUSE Linux Enterprise Server)
  • ubuntu
  • windows
arch

Architecture of target system:

  • 32 (32-bit)
  • 64 (64-bit)
  • ia64 (HP-UX Itanium)
  • pa-risc (HP-UX PA-RISC)
  • ppc64 (AIX 64-bit)
  • s390x (zLinux)
  • sparcv9 (Solaris)
hostname Target system hostname or IP address. On Windows, you must include the domain name (domain\hostname).
username User name for an account on the target that has administrative permissions or supports sudo for root-level permission.
password Account password.
domain Domain to which the robot will belong. Case-sensitive.
hubip IP address of the hub that will manage this robot (referred to as the robot’s parent hub).
hub Name of the hub that will be the robot’s parent hub.
hubrobotname Robot name of the robot’s parent hub. Case-sensitive.
hubport Port that the parent hub listens on. The default is 48002.

Optional Attributes

You can specify values for these attributes as needed. This table also shows default values when they exist. Click on the column heads to resort the table. For example, click Optional Attribute to sort them alphabetically.

Optional Attribute Category Description Default
installdir Setup

Path to the directory where the robot will be installed on the target system.

C:\Program Files\Nimsoft or
C:\Program Files (x86)\Nimsoft (Windows)

/opt/nimsoft (Unix)

robot_mode

Setup

Mode of communication with the hub:

  • Active (default) – Robot sends messages to its parent hub as soon as it receives them from the probes.
  • Passive – Robot sends data to the hub at the hub's request, and limits are placed on the amount of data the robot can send. 
  • Offline – Robot does not initiate or expect communications from its hub.

Note: Marketplace probes must be deployed to passive robots. For more information, see Configure a Robot for Marketplace Probes.

Active

robotname

Setup

Unique name to be assigned to the deployed robot.

Target system hostname

rsakeyfile

Setup

Path to RSA public key certificate on the system hosting ADE in this format (note that key files with pass phrases are not supported):

<rsakeyfile>

   /path_to_xml_on_local_system

</rsakeyfile>

None

sudo_password

Setup

Password string for sudo. This lets you use sudo over ssh during installation. ssh password is still required. Not applicable to root users.

None

tempdir

Setup

Desired path for a temp directory on the target system. For example, C:\tmp\supertmp (Windows) or /opt/tmp (Unix).

 
ip_version System IP address schema version: IPv4 or IPv6. IPv4
robotip System

IP address of the robot. The robot communicates on this interface only. This value is propagated to its probes.

If no value is specified (default) the robot automatically finds its IP address. If the system has multiple interfaces, it is unpredictable which interface the robot will use.

 
robotip_alias System Robot IP address in a NAT environment.  
tz_offset System Time zone offset override, in seconds, positive or negative. 0
autoremove Hub

Specifies whether the robot should unregister itself from the hub after it terminates. Value: yes or no.

no
hub_dns_name Hub Fully qualified DNS name of the parent hub. If specified, this value overrides the hubip, which is then used only as a cached value if the DNS lookup fails.  
hub_update_interval Hub Interval, in seconds, at which the controller should send alive or probelist information to the hub. 900
hubdomain Hub Domain of the parent hub.  
secondary_domain Hub Domain of the secondary hub that manages the robot if its assigned parent hub is unavailable.  
secondary_hub Hub Hub that manages the robot if its assigned parent hub is unavailable. None. Robot attaches to the first hub it locates if its own parent is unavailable.
secondary_hub_dns_name Hub Fully qualified DNS name of the secondary hub. If specified, this value overrides the secondary_hubip, which is then used only as a cached value if the DNS lookup fails.  
secondary_hubip Hub IP address of the secondary hub. Overridden if the DNS name is specified.  
secondary_hubport Hub Hub port of the secondary hub. 48002
secondary_hubrobotname Hub Name of the secondary hub’s robot.  
secondary_robotip_alias Hub NAT address the robot should use when connected to the secondary hub. Valid values are:
  • same, which uses the parent hub’s NAT address (default)
  • IP address
same
send_alive Hub Whether or not to send alive messages to the hub. Values:
  • 1 – Send at each hubupdate interval
  • 0 – Do not send alive messages (useful it the robot runs in an offline mode and you want to establish contact between the robot and hub only when needed)
  • -1 – Send the complete probe list; use with very old hubs that do not understand the alive message format
1
do_not_broadcast Broadcast

Prevent the robot from broadcasting to locate any hub. By default, a robot that is not attached to a hub will broadcast to locate a temporary hub. Value: yes or no.

no
temporary_hub_broadcast Broadcast Prevent the robot from broadcasting to locate a temporary hub if its parent hub and secondary hub are not available. This causes the robot spools its messages until its parent or secondary hub is available. By default, a robot that is not attached to a hub will broadcast to locate a temporary hub. Value: yes or no.

no
unmanaged_security Broadcast Specifies which hubs the robot can broadcast to in order to establish contact. Values:
  • not_locked, none, or open – any hub
  • domain_locked or domain – only to hubs in the robot’s domain
  • hub_locked or hub – no broadcast is allowed; controller can only contact its parent hub
domain_locked
controller_port Port Port assigned to the controller probe. 48000
first_probe_port Port First port assigned to a probe by the controller. Ports are assigned to subsequent probes in sequence. Use this option if you want the probes to have port numbers in a specific range for router or firewall purposes. 48000
port_alive_check Port Interval, in seconds, for port alive checking. 330
port_alive_include_local Port Specifies whether to include ports registered from local probes when performing the port check. Value: yes or no. yes
spooler_port Port Port assigned to the spooler probe. 48001
logfile Log Name for the log file. controller.log
loglevel Log Logging level for messages from the robot. Values: 0 through 8. 0
logsize Log Maximum size, in kilobytes, for the controller.log file. 100
proxy_log Log Logging level for proxy functions in the controller.log file. Typically set from 1 to 5.
Values: 0 through 8.
4
origin Message Origin for messages that identifies the source of the message. Typically used to partition data in a multi-tenant environment. Value: any string. Typically a hub or robot name, company name, location, etc. Parent hub name
os_user1 Message Tag added by the controller when sending internal messages directly to the hub and by the spooler when any message is spooled.  
os_user2 Message Tag added by the controller when sending internal messages directly to the hub and by the spooler when any message is spooled.  
capture_output Probes

Creates pipes for each started probe to capture any output they send to stdout or stderr. This output is appended to the probe’s log file. Value: yes or no.

Note that enabling this functionality introduces extra overhead in the probe. On Windows systems, the probes must inherit resources from the controller. In some situations this may prevent the controller from terminating properly.

no
default_fail_window Probes Number of seconds a probe must run before its restart counter is reset. This setting applies to all probes managed by the robot. This value can be overridden for a particular probe by specifying a fail_window in that probe’s configuration. 15
default_priority_level Probes Numeric value that specifies the priority level for all probes that do not have this value set at the probe level. Probes with lower priority levels are started first, with a delay between each priority level.
Note that the start_after probe property gives you more control over the start order of probes.
None
max_restarts Probes Number of starts allowed before a probe is set to the error state. The restart counter is reset for a probe if it runs longer than its fail_window.  
proxy_mode Probes Allows the controller to act as a proxy for all of its probes so that all callback functions to the probes are performed through the controller port. Value: (off) or (on) 0
suspend_on_loopback_only Probes

Suspend all probes if loopback is the only network. Windows only. Values: 

  •  yes – robot enters a "sleep" mode where all probes are suspended until a network connection is available
  • no – alarm messages are spooled, then flushed when a network connection is again available
yes
set_qos_source QoS Specifies whether probes use the robot name as the QoS source instead of the host name. Not supported for all probes. Value: yes or no. no
system_uptime_qos Qos Specifies whether to send asynchronous QoS when the robot is up or down. Value: yes or no. no
alarm_level_comfail_restart Alarm Alarm sent after the controller’s fourth unsuccessful attempt to communicate with a probe that has a registered port. Controller restarts the probe after alarm is sent. Values:
  • no alarm
  • clear
  • informational
  • warning
  • minor
  • major
  • critical
no alarm
alarm_level_dispatch_error Alarm Severity level for an internal alarm indicating a socket system failure. Alarm is sent only if the loglevel is greater than 0. Values:
  • clear
  • informational
  • warning
  • minor
  • major
  • critical
major
alarm_level_max_restarts Alarm Severity level for alarm sent when a probe is restarted 10 times and quickly terminates each time. Values:
  • clear
  • informational
  • warning
  • minor
  • major
  • critical
major
alarm_level_postinstall Alarm

Severity level for an alarm sent when there is an error during probe distribution. Error occurs when the controller is unable to start a post-install script after distributing a package distribution, or if the post-install script does not return an "okay" (0) status. Values:

  • no alarm
  • clear
  • informational
  • warning
  • minor
  • major
  • critical
no alarm
alarm_level_request_error Alarm Severity level for an alarm sent when unable to issue a request to distsrv. Values:
  • no alarm
  • clear
  • informational
  • warning
  • minor
  • major
  • critical
major
alarm_level_start_error Alarm  Severity level for an alarm sent when unable to start a probe. Values:
  • no alarm
  • clear
  • informational
  • warning
  • minor
  • major
  • critical
major
alarm_level_suspended Alarm Severity level for an alarm sent when a probe start is aborted because the robot state is suspended. Values:
  • no alarm
  • clear
  • informational
  • warning
  • minor
  • major
  • critical
no alarm
alarm_level_timed_error_return Alarm Severity level for an alarm sent when a probe start is aborted because the robot state is suspended. Values:
  • no alarm
  • clear
  • informational
  • warning
  • minor
  • major
  • critical
warning
alarm_level_timed_not_finished Alarm Severity level for an alarm sent when a timed probe is not completed at the next scheduled start time. The timed probe is restarted when this occurs. Values:
  • clear
  • informational
  • warning
  • minor
  • major
  • critical
warning
alarm_level_unregister Alarm Severity level for an alarm sent when a probe unregisters its port but does not terminate. Values:
  • clear
  • informational
  • warning
  • minor
  • major
  • critical
major
alarm_timeout Alarm Interval, in minutes, at which alarms for probes in the error state are repeated.  
wait_after_unregister Alarm Wait time, in seconds, after a probe unregisters a port. If the process is still running, the unregister alarm is issued and the probe is set to the error state.  
audit Audit  When and where to send audit messages. Values:
  • post – Send audit message on controller events
  • yes – Log controller events to local file
  • post_detail – Send audit event on controller events and configuration file changes
  • file_detail – Log controller events and file change events to local file
 
audit_checkpoint_count Audit Number of versions of configuration files to retain.  
audit_max_config_size Audit Maximum size, in bytes, of the configuration file for content comparison.  
config_locking Lock Signals the configuration tools that they should acquire a lock at startup and relinquish it on termination. Value: yes or no. no
config_lock_timeout Timeout Timeout, in seconds, for the configuration file lock. 360
startup_timeout Timeout If the robot is a hub robot, specifies how long (in seconds) the controller waits for the hub probe to start before starting other probes. If the timeout is reached, the robot does a failover.  
Was this helpful?

Please log in to post comments.