HTTP Protocol

Parameter

Description

Username

The name of a user needed to perform BASIC authentication with the remote webserver.

Password

The password of the user needed to perform BASIC authentication with the remote webserver.

Connection Timeout

Time-out in milliseconds after which the Probe stops trying to connect to the remote webserver.

Default: 40,000

Port number

The number of a port to connect to the remote http server.

Default (HTTP): 80

Default (HTTPS): 443

Protocol

The protocol used to connect to the http server: HTTP or HTTPS.

Default: HTTP

Proxy If a proxy is required to access the http site from Data Flow Probe, the proxy's URL needs to be filled here. For example, http://example.com:8080.
Host

The host this credential applies to. It may be empty if the credentials apply to any host.

Realm

The realm this credential applies to. It may be empty if the credentials apply to any host.

Trust Store Password

The password to access the Trust Store file.

Trust Store Path

The full path to the Trust Store file containing the trusted certificates.

Note This protocol supports IPv6.

The Proxy parameter only appears in the Edit Protocol Parameter dialog box. To open this dialog box, right-click the protocol that you created, and then select Edit using previous interface.

For Docker Discovery and Docker Swarm Discovery jobs, you can use certificate-based authentication. To do this, right-click the protocol created, select the Edit using previous interface option, and then configure the following settings:

  • Key Store Path. Specify the full path of the Key Store file.
  • Key Store Password. Specify the password for the Key Store.
  • Key Password. Specify the password for the Key.

For details, see How to Generate the Key Store File for Docker Swarm Discovery Credential.

Note When the CyberArk integration is enabled, two radio buttons (Regular Credential and External Vault) are enabled. The existing Username and Password parameters are grouped under the Regular Credential radio button, and CyberArk integration specific parameters Type and Reference are enabled and grouped under the External Vault radio button, as described in the table below.

CyberArk-related Parameters

Parameter

Description

Regular Credential

Enabled when CyberArk integration is enabled. Select this radio button to use regular credential as before.

  • Username. See description above.
  • Password. See description above.

External Vault

Enabled when CyberArk integration is enabled. Select this radio button to use an external credential vault.

  • Type. The external vault type. Currently only CyberArk is supported.
  • Reference. Click to open the Configure dialog box.

    • Reference. Select this option to configure the Reference ID that will be used by UCMDB/UD to retrieve the passwords from the CyberArk Enterprise Password Vault when they are needed.

      Set the reference ID in the CyberArk Enterprise Password Vault in the following format: <Safe Name>\<Folder Path>\<Reference ID>.

      Where <Safe Name> is the Safe value in CyberArk, <Folder Path> is the folder where the Safe belongs to, and <Reference ID> is the name of the CyberArk account you specified or auto-generated in CyberArk.

      For example, NancySafe\Root\nancy-cyberark-testing-refid.

    • Parameter. Select this option to enable configuring a list of editable CyberArk properties as a query string for UCMDB/UD to retrieve passwords from the CyberArk Enterprise Password Vault.

      To configure a CyberArk property value, click in the Value column for the property, and specify the value in string.

      The CyberArk properties values must not contain any of the following characters: \/:*?"<>|'.;

      The out-of-the-box list of CyberArk properties displayed in the Configure dialog box is editable. You can set selected CyberArk properties as the default list using JMX method setGlobalSettingVaule. For instructions, see "How to Set a Default List of CyberArk Properties Using JMX" in the Data Flow Management section of the UCMDB Help.

      • Regex. Enables configuring CyberArk properties values in regular expressions.

        For examples of how to use regular expression syntax, see "Regular Expression Examples" in the Modeling section of the UCMDB Help.

        The CyberArk properties values in regular expression must not contain any of the following characters: : ;