v7.7 controller IM Configuration

This article describes the Infrastructure Manager controller configuration GUI and provides information on advanced configuration. To open the GUI, double-click the controller probe in the Infrastructure Manager. For an overview of the probe, see .
uimpga-ga
controller_7.7_IM
This article describes the Infrastructure Manager controller configuration GUI and provides information on advanced configuration. To open the GUI, double-click the controller probe in the Infrastructure Manager. For an overview of the probe, see controller.
See the following topics for details:
Setup
The 
Setup
 tab contains the following sections:
  • Nimsoft
  • Misc
  • Advanced
  • Environment
  • Virtual
  • Alarms
  • NAT
  • IP
 
Nimsoft
The 
Nimsoft
 tab allows you to set up the robot and a secondary hub. 
CTRLR--The Setup Tab.png
The tab contains two sections:
  • Robot Name
    • Automatically detect
       uses the system host name as the robot name.
    • Set specific name (override)
       lets you specify the robot name to be used.
  • Secondary HUB 
    defines the method used to determine the secondary hub. The secondary hub will be used if the primary hub is unavailable. Options are:
    • Wait for primary hub to become available
       prevents the robot from attaching to another hub. It will attach to its parent hub when the hub is active.
      This option is replaced by the
      Automatically detect
      option if the
      Search the subnet for a temporary hub
      option is selected.
    • Automatically detect (searches the subnet)
       allows the robot to search the subnet for a responding hub within the domain when the parent and secondary hubs are unavailable. 
      Note
      : This option is displayed if the 
      Search the subnet for a temporary hub
       option is selected.
    • Specify Hub (IP/name)
       allows the robot to attach to the specified hub.
    • Specify Hub (domain name)
       allows the robot to attach to the specified hub.
    • Search the subnet for a temporary hub when primary and secondary hubs are unavailable
       allows the robot to search for a temporary hub if the parent and secondary hubs are unavailable. Selecting this option changes the 
      Wait for the primary hub to become available
       option to 
      Automatically detect (searches the subnet) 
      option.
Misc
The 
Misc
 tab allows you to set logging information, identification properties, quality of service and robot interaction mode.
CTRLR--The Misc Tab.png
  • Identification properties
     lets you specify
      User tag 1
     and 
    User tag 2
    , which are user-defined tags to be used as a grouping/locating mechanism. The tags are displayed in various lists in Infrastructure Manager.
  • Log Level 
    sets the amount of detail to be logged to the log file. Log as little as possible during normal operation to reduce disk consumption, and increase the level of detail when debugging.
  • Log Size
     allows you to change the size of the log file according to your needs. The default size of the log file is 1024 KB.
  • Hub update Interval 
    determines at what interval the hub is contacted with an "alive" message. The range is 1 to 180 minutes. Note that the hub is notified at a shorter interval when changes occur in the probe list.
  • Quality of Service:
    • On Robot uptime, reported as state change
       sends QoS messages on robot uptime. The QoS message 
      status = up
       is sent when the robot starts; 
      status down
       is sent when the robot stops.
    • Set QoS source to robot name instead of computer hostname
       uses the robot name specified on the Setup > Nimsoft tab. 
      This option is disabled unless the
      Set specific name (override)
      option is selected on the Setup > Nimsoft tab.
  • Robot mode 
    is normal or passive. Passive robots cannot initiate communication with a hub. All contact must be initiated by the hub.
Advanced
The Advanced tab allows you to set robot options and the data origin.
CTRLR--The Advanced Tab.png
  • Robot options
     allows you to set options for the robot:
    • Automatically unregister from HUB at shutdown
      When the robot is stopped, an unregister message is sent to the hub on which it is registered. This will make the robot disappear from Infrastructure Manager. If this is not selected, the stopped robot will appear with a red icon, enabling the operator to detect the situation.
    • Suspend all probes when no network connection is available
      When running the robot on a computer with no network connection, you can determine whether the robot should be active or enter a sleep mode where all probes are suspended until a network connection is again available. If this option is not selected the alarm messages will be spooled and flushed when a network connection is again available.
      This function is available only on Windows platforms.
    • First probe port number
      Daemon type probes will normally register a command port, which is allocated run-time on probe start-up. Setting the probe port number will make the robot allocate specific port numbers for the probes as they are started. Use this option if you want the probes to have port numbers in a specific range for router / firewall purposes.
    • Time offset from UTC
      This option lets you override the local time zone setting. The time specification must be entered as time offset from UTC (in seconds).
  • When no contact with hub 
    sets limitations for attempts to connect an unmanaged robot (a robot that has lost the contact with it’s hub) to a hub, using the 
    Tools > Connect Robot 
    option in Infrastructure Manager. The options are:
    • Do not allow robot to be moved
    • Allow move only within domain
  • Data Origin (override origin set by the Hub)
     lets you specify the 
    Origin
    , which is a string attached to
     
    QoS data from probes to identify the origin of the data. The default origin is the name of the parent hub.
Environment
The robot controller will read the variable/value pair in the list and insert it into the robot environment.  This environment is inherited by the probes managed by the robot.
You can add, edit or delete these environment variables by right-clicking in the screen and selecting the appropriate menu option. Only add environment variables that you want all probes on this robot to use.
Virtual
This tab lists 
virtual robots
 served by the robot controller. The netware probe is the only probe that can be set up on a virtual robot.
Virtual robots will, via the 
proxy
 probe, be created for ‘remote’ probes (probes installed and running on computers without a robot). The ‘remote’ probe is configured to know which robot to be served by.
In Infrastructure Manager, the ‘remote’ probe will appear as a probe on a virtual robot.
CTRLR--The Virtual Tab.png
To add user tags for a virtual robot:
  1. Select the hub in Infrastructure Manager, and the robots will be listed in the Main Window.
    The 
    Version 
    column will notify if it is a virtual robot or not.
    In the example below, lab 5 is 
    virtual 
    on xpkost, which means that the robot xpkost serves the virtual robot lab 5.
  2. Right-click the xpkost robot in the Navigation Pane and select Properties to bring up the controller configuration tool.
    Now you may select the 
    Setup > Virtual
     tab, right-click and define user tags for the virtual robot.
    CTRLR--The Virtual Tab 2.png
Alarm
This tab contains the internal alarm messages issued by the controller on the different error situations that may occur. You are allowed to select the severity level for each alarm message. For the condition ‘Probe restart when the probe does not respond’, you can also select that no alarm message is issued.
CTRLR--The Alarm Tab.png
The option ‘Time interval at which alarms will be resent’ defines the time interval in minutes between alarms being sent on an error condition.
If this field is left blank, the controller will never attempt to resend the alarms.
NAT
The feature allows you to allocate an external IP address to a robot that resides on another IP network with incompatible addressing.
This tab contains the setup for NAT (Network Address Translation).
CTRLR--The NAT Tab.png
If the robot is separated from the hub by a NAT (Network Address Translation) device, the robot will be able to send alarms and QoS messages, but the hub will be unable to communicate back. One solution is to setup static NAT mappings for each robot behind the NAT device.  Using Raw Configure, you can then add the key 
robotip_alias
 to the controller section of the 
robot.cfg
 file on the robot computer.  This key changes the IP address that gets registered when the robot initially connects to the hub.
The key 
robotip_alias
 should specify the static NAT mapping IP address that the hub and the clients on the other side of the NAT device should use to access the robot. For example:
<controller>
robotip_alias = 193.71.55.153
...
<\controller>
IP
The IP tab allows you to configure the IP information for this robot.
CTRLR--The IP Tab.png
  • Robot IP-address:
    • Automatically detect
      The host IP address will be used.
    • Set specific address(es) (override)
      Specify an IP-address or set of IP-addresses for the robot. This is typically used when a host has more than one network interface. 
      For more than one IP-address, the addresses must be separated by a comma. IP addresses can also contain wildcards (*). 
      Valid entries:
      • 198.2.3.5, 138.3.4.10
      • 198.2.*.*, 138.3.4.10
      The controller and all probes it starts only listen for connections ON their NIC attached to addresses that start 198.2. If there are not any addresses then they would listen ON 138.3.4.10.
  • IP version support
     – Select the appropriate IP version you are running.
  • Local IP validation 
    – With this option enabled, if the robot IP address is not set to localhost, it is checked against a list of IP addresses that are known valid for that server before it is used.
  • IP-binding:
    • Listen only on the first valid address from configured IP addresses
      You can only select this option if you set a specific address in the Robot IP-address section of this screen. The controller will only list ON a specific IP address on servers with multiple NICs.
Status
This section describes the properties for the Status tab.
CTRLR--The Status Tab.png
  • Robot name
    The actual/current name of the robot.
  • Robot IP-addr.
    The actual/current ip-address of the robot.
  • Robot version
    The version of the robot.
  • Op. Sys.
    Operating system name.
  • Op. Sys. type
    The type of the operating system (UNIX/Windows etc.).
  • Op. Sys descr
    Operating system description.
  • Indicator and status information
    The status indicator will, together with a status message, give information about the current controller status (Green icon means OK, Red icon means an error situation).
    Right-clicking on the indicator lets you set the robot into maintenance mode for the period specified. See the section for more information.
  • Installed packages
    Lists all packages installed on the robot in a separate window.
  • Robot environment
    Opens the Robot Environment window. This window displays the variables and values for the computer running the robot.
    The values are inherited by any probe started by this robot.
  • Hub connectivity
    Displays the current, primary and secondary hubs.
Advanced Configuration
Using DNS Names for the Hub Computer in robot.cfg
Version 2.80 or higher of the probe allows the DNS name of the hub machine to be used in the 
robot.cfg
 file in two ways: using the full DNS name instead of the IP address in the hubip parameter or using the full DNS name in the hub_dns_name parameter.
Using the full DNS name of the computer instead of the IP address (as the 
hubip
 parameter) allows the robot to recognize its main hub and return to it after a failover situation.
The hubip parameter will be replaced by an IP address on a robot move operation. The robot can fail over to a different hub if the DNS is down.
Using the full DNS name in the parameter hub_dns_name allows the robot to attempt to use the hub_dns_name to look up the hub IP address. If this fails, the hubip parameter is used. When the DNS name lookup is successful and the ip address found is different from the hubip parameter, this parameter is replaced.
The same functionality is available for the secondary hub, using the secondary_hub_dns_name parameter.
Note that the hub_dns_name is lost on robot move and secondary_hub_dns_name is lost on change of secondary hub initiated by the controller configuration tool.
 
<controller>
 hubip =
 hub_dns_name =
 secondary_hub_dns_name =
</controller>
Limiting the Number of Open Ports
You can limit the number of open ports in your environment (for example, in a network with a firewall) by setting the 
proxy_mode
 key in the 
robot.cfg
.
In the robot.cfg, set the 
proxy_mode = 1
 to send all the traffic through a specific port, for example, port 48000.
Robot Maintenance Mode
Controller version 2.80 or higher supports 
maintenance mode
. Right-clicking one or more robots in the Infrastructure Manager main window pane and selecting 
Maintenance,
 lets you set the selected robot (s) into maintenance mode for the period specified.
The robot will stop all probes and stop sending messages. The robot does a full restart and only starts the core components (
controller
spooler
hdb
hub
distsrv
nas
 and 
proxy
 ). In Infrastructure Manager the probe icon of other probes will indicate that these probes are suspended while the robot is in maintenance mode.
On entering maintenance mode, the end time of the maintenance mode period must be given.  When this time is reached the robot will go back to normal operation and start up any suspended probes.
Probe distribution and activation can be performed while the robot is in maintenance mode, however the affected probes will be suspended and not actually started.