Configuring XML API credentials

You can discover the Cisco IMC and HP iLO for ProLiant management controllers by using an XML API. The XML API credentials are checked in sequence, and the first matching entry is used. After a working XML API credential is found, no further credentials are checked. To reorder XML API credentials, drag the credential to the required position in the list.

Info

Multiple login failures cause HP iLOs to impose a login delay. To avoid this issue, ensure that the credential is specific to the device so that it is checked first.

To view XML API credentials

  1. From the secondary navigation bar on the Discovery tab, click Credentials.
  2. Click Devices, and then click XML API.
    The XML API Credentials page displays the following information for each credential:

Field Name

Details

Credential link

A heading link that describes the credential, which consists of the following parts:

  • IP range—The IP address or addresses of the XML API credential is intended to be used.
  • Username—The username for this credential.

If you click this heading link, the Edit XML API Credential page is displayed. For more information about this page, see To set up XML API credentials.

Description

A free-text description of the XML API credential supplied by the user who created the credential.

Actions

A drop-down menu with the following options:

  • Edit—Select to edit the credential. The Edit XML API Credential page is displayed. For information about the fields and settings available from this page, see To set up XML API credentials.
  • Disable—To disable a credential, select Disable. The credential is a marked as disabled in the credential list. When a credential is disabled, this option is replaced with an Enable option. To enable the credential, click Enable.
  • Delete—Select to delete the credential.
  • Test—Select to test the credential. For more information, see Testing XML API credentials.
  • Move to top—Moves the credential to the top of the list.
  • Move to bottom—Moves the credential to the bottom of the list.

To set up XML API credentials

To add or edit an XML API credential:

  1. From the XML API credentials page, perform one of the following actions:
    1. To add a new credential, click Add.
    2. To amend an existing credential, click ActionsEdit.
  2. Enter the XML API credential details as follows, and then click Apply:

Field Name

Details

Matching Criteria

To match all endpoints, select Match All, or deselect it to enter values that will be used to determine if this credential is suitable for a particular endpoint. They can be one or more of the following, separated by commas:
• IPv4 address—For example 192.168.1.100.
• IPv4 range—For example 192.168.1.100-105, 192.168.1.100/24, or 192.168.1.*.
• IPv6 address—For example 2001:500:100:1187:203:baff:fe44:91a0.
• IPv6 network prefix—For example fda8:7554:2721:a8b3::/64.

The following address types cannot be specified
• IPv6 link local addresses (prefix fe80::/64)
• IPv6 multicast addresses (prefix ff00::/8)
• IPv4 multicast addresses (224.0.0.0 to 239.255.255.255)

As you enter text, the UI divides it into pills (discrete editable units) when you enter a space or a comma. According to the text entered, the pill is formatted to represent one of the previous types or is presented as invalid.

 Click here for more information on using the pill UI.

Invalid pills are labeled with a question mark. You can also paste a list of IP addresses or ranges into this field. If any pills are invalid, a message stating the number of invalid pills is displayed above the range field. Clicking the link applies a filter that shows only invalid pills, which you can then edit or delete. You can remove the filter by clicking clear the Showing n of n label below the Range field. There is no paste option on the context-sensitive (right-click) menu.
Warning: Do not paste a comma-separated list of IP address information into the Range field in Mozilla Firefox. Doing so can crash the browser. You can use a space-separated list with no problems.
• To edit a pill, click the pill body and edit the text.
• To delete a pill, click the X icon to the right of the pill, or click to edit and delete all of the text.
• To view the unformatted source text, click the source toggle switch. The source view is useful for copying to a text editor or spreadsheet. Click the source toggle switch again to see the formatted pill view.
Underneath the entry field is a filter box. Enter text in the filter box to show only matching pills.

Pills are not supported in Opera.

Enabled

A check box enabling you to enable or disable the credential.

Username

Username used to access the target.

Password

The corresponding password.
In the Edit XML API Credential page, this field is displayed as Set Password. When editing a credential, the password is shown as a series of asterisks in this field, and it cannot be edited. To enter a new password, select the check box. The password entry field is cleared. Enter the password into the password entry field; the password text is not echoed to the screen.

TimeoutThe time (in seconds) after which a response is expected. The default is 180 seconds.

Description

A free-text description of this credential.

ProtocolThe protocol to use to communicate with the target. Select Cisco CIMC or HP iLO RIBCL.

When selecting HP iLO RIBCL, be aware that after too many login failures, HP iLOs to impose a login delay. To avoid this issue, ensure that the credential is specific to the device so that it is checked first.

Custom HTTPS Port

To use a custom HTTPS port, select from the ports in the list. You must already have configured a custom HTTPS port in the Discovery Configuration window.

The XML API credential page is refreshed to show details of the new credentials.

Testing XML API credentials

After you add the credentials, test them using the following steps to ensure that they work

  1. Click ActionsTest for the XML API credential.
    A dialog box is displayed, with valid IP address range, description, username, and options pre-populated.
  2. Enter the target IP address to test. 
  3. Click Test.
    The page is refreshed to show that the test is in progress. When the test is complete, the results are shown on the Device Credentials page (this might take a few minutes).
  4. Repeat for all credentials that you want to test.
Was this page helpful? Yes No Submitting... Thank you

Comments