agentreg command

Use the agentreg command to register the agent with IBM® Flex System Manager.

Synopsis

On Linux: agentreg.sh [--help][-l server location][-c certificate path][-e endpoint IP address] [-f configuration file] [-p server listener port][-v verbose]

On Windows: agentreg.bat [--help][-l server location][-c certificate path] [-e endpoint IP address] [-f configuration file] [-p server listener port][-v verbose]

Description

The Agent registration command notifies IBM Flex System Manager that the Platform Agent is now installed and must be managed by that server. IBM Flex System Manager discovers and provides access to the Platform Agent through the certificate that is specified on this command.

Agent-initiated discovery allows access to Platform Agent that runs on a managed system without requiring any credentials from IBM Flex System Manager. After you install the Platform Agent on the endpoint, run the Agent registration utility to automatically notify the production IBM Flex System Manager.
Note: The agentreg command requires the Platform Agent to run on a managed system.

Operands

There are no operands.

Options

-c
Specifies the absolute path of the configuration file that contains the certificate to use on IBM Flex System Manager. This certificate file must be in privacy enhanced mail (PEM) format and contain only one certificate.
-e
Specify this option and provide the exact IP address to communicate with IBM Flex System Manager. This option is mandatory and the system displays an error message if the option is not specified.
-f
Specifies the configuration file that contains the configuration information. The format of the configuration file is one line per IBM Flex System Manager. The format starts with the server location and certificate path and an optional port, and the parameters that are delimited by using a space character. The required parameters are either this parameter or the server location and the certificate path.
The following example shows the format of the configuration file.
#Server Location    Endpoint IP     Certificate Path        Port
19.12.33.12         9.122.15.4      /etc/certs/isd1.pem     6989
sys1.mydomain       9.122.15.4      /home/user4/isd2.cert
Any line that starts with hash (#) character before the line is commented out in the configuration file and is therefore ignored by the Agent registration utility.
Note: The configuration file is present in the /opt/ibm/platform/bin directory of IBM Flex System Manager.
--help
Displays detailed information about the command, including the syntax, a description of the command, a description of the options and operands, error codes, and examples.
-p
Specifies the port that IBM Flex System Manager is listening for CIM indications. The port is an optional parameter. If you do not specify the port number, the default value of 6989 is used by IBM Flex System Manager.
-l
Specifies the IP address or host name of IBM Flex System Manager that is used for registering the Platform Agent. The specified host name or IP address is used to send the indication to IBM Flex System Manager from the agent.
-v
Prints verbose output of the data.

Examples

Note: For all the examples that use the Windows agentreg.bat, replace agentreg.bat with cfguserreg.sh to use the example on Linux.
  1. Install and start IBM Flex System Manager.
  2. In IBM Flex System Manager Web interface navigation area, expand Settings, and then click Server Preferences.
  3. In the Inventory pane, select Operating System from the Resource Type list.
  4. Select Automatically Add check box from the Resources That Contact the Server list. This configuration allows the administrator to turn on the ability for the Platform Agents to notify IBM Flex System Manager when they are available.
  5. Generate IBM Flex System Manager certificate by using the keytool command:
     /opt/ibm/director/agent/_jvm/jre/bin/keytool -rfc -export -alias secureclient -file directorcert.pem -keystore /opt/ibm/director/data/cim/keystore/ibmd_cert.jks -storepass iSBi06jA
    Note: Root permission is required to use the keytool command.
  6. Install the Platform Agent on the managed system.
  7. Copy IBM Flex System Manager certificate to any location on the agent system
  8. Log in to the agent system by using the administrator credentials and run the agentreg command to register the agent with IBM Flex System Manager. 
    Usage:
agentreg -l [server location] -e [endpoint IP address] -c [certificate path] -p [server listener port] 
agentreg -f [configuration file]
agentreg --help

C:\Program Files\Common Files\ibm\icc\cimom\bin\agentreg -l 10.32.38.52 -e 9.122.15.4 -c \home\directorcert.pem -p 6989
  9. Verify whether the endpoint is unlocked by IBM Flex System Manager. To verify log in to IBM Flex System Manager console, then Navigate Resource > OS MEPs. Search for the host name or IP address that is trying to be registered. If the endpoint is still locked, run the command again until IBM Flex System Manager unlocks the endpoint.
    Note:
    • The agentreg command not does not generate any error message if there is a failure to notify IBM Flex System Manager. Verify the Agent traces or syslog messages for failed notifications to IBM Flex System Manager.
    • After endpoint is unlocked, the Managed endpoint (MEP) status changes to the "Partial Access" state.
  10. Use the Configure Access page to manually unlock the remote service access point (RSAP) such as Secure Shell (SSH) or Distributed Component Object Model (DCOM) protocol. This step is used to retrieve a full inventory data.
  11. When all parameters are correct and CIM server is running, the agentreg command runs and exits. Any indication of delivery failure is not handled by this utility.
Parent topic: Discovery