Configuring the console for API

The Console API configuration steps can be performed by using the Customize API Settings task.

To configure the Console for API support:

  1. Log on to the Console in Access Administrator mode.
  2. Select Tasks Index in the left navigation pane.
  3. Select the Customize API Settings task from the tasks list.
  4. Select Enable.
  5. Specify any SNMP agent parameters desired. Note: No special SNMP agent parameters are required for API to work correctly.
  6. Add one or more entries in the Community Names box by selecting Add push button to add a new community name or select the Change push button to change an existing community name. It is recommended that one entry be added for each TCP/IP host (machine) that will be making Management API requests.
    Name
    This field should be filled in with any character string. Each community name in the list must be unique. Note the community name(s) that are to be used by applications using the Console APIs, since it will need to be specified on the HwmcaInitialize calls issued by those applications.
    Address
    If you are following the recommendation of adding an entry for the Console and each requesting application, then this field should be filled in with the TCP/IP address of the machine that will be using the community name.
    Note: This can be specified as an IPV6 address.
    Network Mask/Prefix
    If you are following the recommendation of adding an entry for the Console itself and each requesting application, then this field should be filled in with a character string of 255.255.255.255. When using IPV6 addresses, the prefix for the address should be used, instead of a masked value.
    Access Type
    Use this field to specify the type of access that is allowed for the community name. The access type for the community name(s) that are to be used by applications using the Console APIs MUST be read/write.
  7. Specify any additional locations where enterprise-specific SNMP trap messages created by the Console should be sent in the Event notification information box. Entries can be added, changed, and deleted throughout with the use of the Add, Change, and Delete push buttons respectively. Adding entries to the Event notification information box will cause the Console to send the specified event notifications to TCP/IP port 162 at the locations specified. 8. Select the OK or Apply push buttons to save the changes.
  8. If any of the above data was added or changed, then you need to stop and restart the Console before the changes will be in effect. The Console can be stopped by using the Shutdown or Restart task found in the Console Actions view.