Adding credentials
Login credentials are usernames and passwords, SSH keys, and other authentication methods used to access a host. For BMC Helix Discovery to access and scan the hosts in the IT environment, BMC Helix Discovery needs to add and store their login credentials.You add credentials from the Manage > Credentials page in the UI on the Discovery Outpost.
On the Add Credential page, you can enter general details for the credential, and depending on the specific credential type, any additional parameters. For example, for a Linux host, you can specify an SSH key to be used for authentication or a username/password combination for escalated privileges. If you add an exception for matching IP addresses, the label of the credentials is updated with the exception.
You can add credentials for Linux and Windows hosts, management controllers, network devices, storage devices, and so on. The preferred method of accessing remote devices through BMC Helix Discovery is by using remote login.
You can set up different login credentials to use on different computers, by an individual IP address or a range of addresses. You can set up several access methods and define the order in which they must be attempted. Each access method is attempted until a working credential is found or the list is exhausted. When BMC Helix Discovery successfully logs in to a host for the first time, the access method used to log in is recorded. On subsequent scans, the access method used during the previous successful login to the host is attempted first. However, you must configure appropriate options on the BMC Helix Discovery configuration pages in the service UI for successful attempts.
If BMC Helix Discovery records an access login method (for example, telnet) as the last successful login method but this method is later disabled for any reason, then BMC Helix Discovery tries the same method again on a subsequent scan. If the scan fails, then that method is not tried again until it is re-enabled. BMC Helix Discovery attempts an access method only if it is seen to be available. For example, SSH access is attempted only if the SSH port is open. Information about the success or failure of credentials is displayed on the Discovery Status page.
Before you begin
If you have integrated BMC Helix Discovery with a supported credential broker, then see the following topics for additional information about adding credentials:
User accounts on UNIX and Linux target systems
When creating a user account (the account that BMC Helix Discovery logs into to discover a host) on a UNIX or Linux target host, make sure that you specify the full path to the shell in the user profile. For example, SHELL=/bin/sh. Otherwise, the credentials would be considered invalid.
Important
Regarding Shell support, BMC Helix Discovery is tested to work with Bourne and Bourne-compatible shells (/bin/sh). In general, the best shell to use for BMC Helix Discovery is /bin/sh as it is widely available on Linux, Unix, AIX, and so on. Support for other shells such as the Korn shell is the best effort only. The product has been sporadically tested and might work but with known issues, and BMC might not fix bugs that affect these shells.
To add login credentials
From the menu bar, select Manage > Credentials.
The Credentials page is displayed.On the top-right corner of the page, click the Add list to view the type of target for which you want to add a credential.
The available credential types are:
Network Device
Database
Host
Cloud
Storage Device
Management Controller
Custom Credential
Web API
- API Provider
Each type contains options under it. You can click an option to view the Add Credential page and enter details for the option.
The Add Credential page displays pre-populated fields relevant to your selection. For example, under Host, click SSH to configure the Add Credential page with the SSH and UNIX Settings access methods.
In the Label field, specify an appropriate name for the credential.
This label is used later for searching credentials. This field is mandatory.
(Optional) If you have configured integration with a credential broker, select the Vault source from the list menu. It can be one of the following:
local—The local credential vault on the BMC Helix Discovery Outpost. This option is always available.
BeyondTrust Password Safe—Select this option if you have configured integration with BeyondTrust Password Safe
Centrify Identity Platform—Select this option if you have configured integration with Centrify Identity Platform
CyberArk Credential Provider—Select this option if you have configured integration with CyberArk Enterprise Password Vault
Thycotic Secret Server—Select this option if you have configured integration with Thycotic Secret Server
HashiCorp Vault—Select this option if you have configured integration with HashiCorp Vault
Safeguard Vault—Select this option if you have configured integration with Safeguard for Privileged Passwords
If you need to add more access methods to the selected credential type, click the + icon
in the Credential Types field or proceed to the next step.Select the Matching criteria. Either select Match All for the credential to be valid for any endpoint (this is the default), or clear Match All to enter specific endpoints or ranges.
To add Matching exceptions, that is, endpoints that the credential must never match, click the + icon
in the Matching exceptions field and enter the endpoints that you do not want this credential to match. You can use the same endpoint types for matching exceptions as you can for matching criteria. Select the Enabled check box to enable the credentials.
You can edit the credentials at any time or disable a given credential.
In the Description field, specify a description for the credential.
In the User – Name field, specify a username for the credential.
In the User – Password field, specify a password for the credential.
Tip
On the Edit Login Credential page, the User – Password field is displayed as Set Password. The existing password is displayed as a series of asterisks that cannot be edited. To enter a new password, select the check box. The password field is cleared, enabling you to enter the new password.
Specify additional fields for the selected credential type. For more information about these fields, see the relevant credential type:
Click Apply to save the credential details.
Network device credentials
Credential type | Parameter | Description |
|---|---|---|
| SNMP | Retries | The number of attempts made if no response is received. The default is five. |
| Timeout | The time (in seconds) in which a response is expected from the host. The default is one second. | |
| SNMP Port | Select the check box and then select an SNMP port from the list. The list is populated with SNMP ports that you have configured in the Discovery Configuration window. | |
| SNMP Version | The SNMP version to use. From the SNMP version list, select one of the following: 1, 2c, or 3. The default is Version 2c. If you are setting up credentials for discovering Netware, you must select Version 1 from the SNMP version list. | |
| Use GETBULK | Use GETBULK requests instead of GETNEXT requests. GETBULK improves discovery performance. However, some devices do not support it correctly, which occasionally may lead to scanning issues. If you experience scanning issues, clear this option to revert to GETNEXT. GETBULK is supported only by SNMP v2c and v3. | |
| SNMP v1/v2c | Community: Name | The community used for SNMP read access to the defined host or hosts; for SNMP V1 and V2c credentials only. |
| SNMP v3 | Security Level | For SNMP V3 credentials only. This field shows the security level selected by using the following authentication and privacy protocols:
No setting exists for privacy without authentication. |
| Authentication Protocol | Protocol used to encrypt the authentication with the client. This is applicable for SNMP V3 credentials only. Select one of the following options from the list:
The hashed passphrase is used to access the target system. Tip The SHA-2 authentication protocols (SHA-224, SHA-256, SHA-384, and SHA-512) are specified in the proposed standard
RFC 7860
| |
| Security Name | For SNMP V3 credentials only. | |
| Security— Authentication Key | The key (passphrase) that is used to encrypt the credentials. This is applicable for SNMP V3 credentials only, and only if you have selected an authentication protocol. The key must be at least 8 characters. | |
| Privacy Protocol | The protocol that is used to encrypt data retrieved from the target. Encrypting the data retrieved from a discovery target causes performance degradation as compared to not encrypting the data. This is applicable for SNMP V3 credentials only, and only if you have selected an authentication protocol. That is, you cannot have privacy without authentication. Select one of the following options from the list:
| |
| Private key—Value | The key (passphrase) that is used to encrypt the data. This is applicable for SNMP V3 credentials only, and only if you have selected a privacy protocol. The key must be at least 8 characters. | |
| Context | The SNMP v3 context. This field is optional and only required for some devices. | |
AVI Vantage Web API | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. |
| Access Protocol | Select Allow HTTP to enable REST API requests to be made over HTTP. Warning HTTP is not a secure protocol as the communication is not encrypted. This is a security risk that allows access credentials to be stolen. | |
| Cisco APIC REST API | AAA Domain | The AAA domain to which the user belongs. This field is empty by default. |
| Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. | |
| Access Protocol | Select Allow HTTP to enable REST API requests to be made over HTTP. Warning HTTP is not a secure protocol as the communication is not encrypted. This is a security risk that allows access credentials to be stolen. | |
| Citrix NetScaler NITRO REST API | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. |
| Access Protocol | Select Allow HTTP to enable REST API requests to be made over HTTP. Warning HTTP is not a secure protocol as the communication is not encrypted. This is a security risk that allows access credentials to be stolen. | |
| BeyondTrust Remote Support Web API | Client details (optional) | You can specify an optional Client ID and a secret to access the web API.
|
| Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. | |
| Access Protocol | Select Allow HTTP to enable API requests to be made over HTTP. Warning HTTP is not a secure protocol as the communication is not encrypted. This is a security risk that allows access credentials to be stolen. | |
| Port | The port number on which to connect. The default port is 443. | |
| Fortinet FortiADC REST API | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. |
| Access Protocol | Select Allow HTTP to enable API requests to be made over HTTP. Warning HTTP is not a secure protocol as the communication is not encrypted. This is a security risk that allows access credentials to be stolen. | |
| Port | The port number on which to connect. The default port is 443. | |
| F5 REST API with token based authentication | Login Provider name | The name of the authentication provider. The default value is "tmos". |
| Timeout | The time (in seconds) in which a response is expected. The default is 180 seconds. | |
| Port | The port number on which to connect. The default port is 443. | |
| ArubaOS REST API with token based authentication | Timeout | The time (in seconds) in which a response is expected. The default is 180 seconds. |
| Port | The port number on which to connect. The default port is 443. |
Database credentials
Each credential type has the following parameters.
Credential type | Parameter | Description |
|---|---|---|
One of:
| Driver | Select a driver from the list of configured drivers. To add a new driver or to update an existing driver, see Managing database drivers. |
| Database Name | Specify the name of the database. By default, the check box Treat as regular expression is selected. Clear the check box if the database name is not to be treated as a regular expression. | |
| Port | Specify the port number applicable for the database. By default, the check box Treat as regular expression is selected. Clear the check box if the port number is not to be treated as a regular expression. | |
| Timeout | The time (in seconds) in which a response is expected from the host. The default is 60 seconds. | |
| Credential Group | If a credential can be used for multiple database types, it can be added to a credential group in TPL. Enter the name of that credential group. | |
Additional Properties | Specify the other database properties by using the format, In earlier releases, the Encrypt Password check box was available to encrypt the password. This checkbox was removed in August TKU (TKU 2020-Aug-1). Tip Microsoft SQL Server with a domain account If you are connecting to Microsoft SQL Server with a domain account, you must add the following lines for the credential: |
Host credentials
The following video explains, in brief, the process for adding an SSH credential and configuring a discovery scan to discover endpoints using the SSH credential.
| Credential type | Parameter | Description |
|---|---|---|
SSH | Kerberos Realm | Where one or more Kerberos realms are configured, select the realm for which the credential will be valid. See Adding Kerberos realms for discovery authentication for information on adding realms and testing authorization for those realms. |
| SSH Port | If the host for which this credential is created is configured to listen for SSH connections on a nonstandard port, pick a port from the list. You can specify only those SSH ports that are defined in Discovery Configuration on the Administration page. For more information, see TCP and UDP ports to use for initial scan. | |
| Timeout (in seconds) | Enter a timeout period (in seconds) for a session. This timeout includes the period for a credential handshake (see also the Session Login Timeout). This timeout is used to control sessions. The default is 180 seconds. In general, timeout is not used to limit the time to scan devices. More than one session can be used to scan one device. For this reason, a scan can take more time than the specified timeout. A typical consequence of this timeout (for example, when the execution of the platform script for | |
| SSH Key—Private Key File | Specify an existing SSH key that you already have deployed in your organization. Click Browse to locate the private key and click Open to select it. For more information about setting up a private key, see Using SSH keys. | |
| SSH Key—Passphrase | Specify the passphrase for the UNIX host. When you click Apply on the Add Credentials page to save the credential, the key and passphrase are validated. BMC Software recommends that when you upload the private key to the BMC Discovery machine, you protect the vault with a passphrase. | |
| SSH Authentication | To use an SSH key or password, select Key or Password. If you have not configured an SSH key, the Key option is disabled. To use the realm you have chosen, select Kerberos. If no realms are configured, or you have not chosen a realm, Kerberos is disabled. When using Kerberos authentication and you have selected a realm, the username and password specified are not used. However, if the BMC Helix Discovery appliance has not yet obtained a Ticket Granting Ticket (TGT) from the Key Distribution Center (KDC) then the username and password are used as the Principal Name and password for obtaining the TGT. | |
HPE OneView REST API | Timeout | The time (in seconds) in which a response is expected from the host. The default is 60 seconds. |
| Port | The port number on which to connect. The default port is 443. | |
PowerShell | PowerShell Timeout | Enter a timeout period (in seconds) for a session. This timeout includes the credential handshaking (see also the Session Login Timeout). This timeout is used to control sessions. The default is 180 seconds. In general, timeout is not used to limit the time to scan devices. More than one session can be used to scan one device. For this reason, a scan can take more time than the specified timeout. A typical consequence of this timeout (for example, when the execution of the platform script for getInterfaceList takes longer than this timeout) is that the scan will fail with a script failure (error message Connection timed out). |
| PowerShell Authentication | The type of authentication used. This can be one of the following:
| |
| Just Enough Administration (JEA) |
| |
| Access Protocol |
| |
| PowerShell HTTPS Port | If the host for which this credential is created is configured to listen for PowerShell connections on a nonstandard port, pick a port from the list. You can specify only those ports here that are defined in the Discovery Configuration window on the Administration tab. For more information, see PowerShell ports. | |
| PowerShell HTTP Port | If the host for which this credential is created is configured to listen for PowerShell connections on a nonstandard port, pick a port from the list. You can specify only those ports here that are defined in the Discovery Configuration window on the Administration tab. For more information, see PowerShell ports. | |
| Proxy | If you need to connect through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
| Proxy Credentials | If you need to connect through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
| Telnet | Telnet port | If the host for which this credential is created is configured to listen for Telnet connections on a nonstandard port, pick a port from the list. You can specify only those telnet ports that are defined in Discovery Configuration on the Administration page. For more information, see TCP and UDP ports to use for initial scan. |
| Timeout (in seconds) | Enter a timeout period (in seconds) for a session. This timeout includes the period for a credential handshake (see also the Session Login Timeout). This timeout is used to control sessions. The default is 180 seconds. In general, timeout is not used to limit the time to scan devices. More than one session can be used to scan one device. For this reason, a scan can take more time than the specified timeout. A typical consequence of this timeout (for example, when the execution of the platform script for | |
UNIX Settings | Switch User? | To use the su command to change to the root or any other user, select Switch User. In the following two fields, enter the user to be changed to, and the corresponding password. The password text is not displayed on the screen. |
| SU User—Name | The username used to log in to hosts identified by the key. | |
| SU User—Password | The password for the SU User. The password text is not displayed on the screen. Tip On the Edit Login Credential page, this field is displayed as Set Password. The existing password is displayed as a series of asterisks that cannot be edited. To enter a new password, select the check box. The password field is cleared, enabling you to enter the new password. | |
| Prompt | Specify a regular expression to define the valid and expected prompt characters. | |
| Force Subshell | To force the session to open a Bourne (/bin/sh) subshell, if the default login shell is a C shell (/bin/csh /bin/tcsh), select Yes. This selection enables you to cater to machines by using nonstandard shells. | |
| Use password for privilege escalation | Select the check box to permit the password to be sent when a command requests a privilege escalation, for example, sudo. | |
| Active Directory | Use Group Managed Service Account | A Windows Active Directory credential. Cannot be specified with a local Windows user credential. You cannot change an Active Directory credential on the BMC Discovery Outpost. Rather, you should delete and recreate the credential. No additional Active Directory parameters are required unless the BMC Discovery Outpost is running on a Windows host with a Group Managed Service Account (gMSA) configured. |
| Just Enough Administration (JEA) |
| |
| Windows | Not applicable | A local Windows user credential. Cannot be specified with an Active Directory credential. No additional Windows parameters are required. |
| vCenter | Timeout | The time (in seconds) in which a response is expected from the host. The default is 60 seconds. |
| HTTPS Port | Select a custom HTTPS port from the list. The list is populated with custom HTTPS ports that you have configured in Administration > Discovery Configuration. | |
| vSphere | Timeout | Enter a timeout period (in seconds) for a session. This timeout includes the period for a credential handshake (see also the Session Login Timeout). This timeout is used to control sessions. The default is 180 seconds. In general, timeout is not used to limit the time to scan devices. More than one session can be used to scan one device. For this reason, a scan can take more time than the specified timeout. A typical consequence of this timeout (for example, when the execution of the platform script for |
| HTTPS Port | Select a custom HTTPS port from the list. The list is populated with custom HTTPS ports that you have configured in Administration > Discovery Configuration. | |
| vSphere Web API | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. |
| VMware Guest | Timeout | The time (in seconds) in which a response is expected. The default is 180 seconds. |
| Mainframe z/OS Agent | Mainframe z/OS Agent Port | Port to use to connect to the Mainframe z/OS Agent. The default value is 3940. To use a different port, select a port number from the list. The list is populated with port numbers that you have configured in Administration > Discovery Configuration. |
| Timeout | Enter a timeout period (in seconds) for a session. This timeout includes the period for a credential handshake (see also the Session Login Timeout) and is used to control sessions. The default is 180 seconds. In general, timeout is not used to limit the time to scan devices. More than one session can be used to scan one device. For this reason, a scan can take more time than the specified timeout. A typical consequence of this timeout (for example, when the execution of the platform script for |
Web API credentials
Credential type | Parameter | Description |
|---|---|---|
| Ceph API | Timeout | The time (in seconds) in which a response is expected. The default is 180 seconds. |
| Port | The port number on which to connect. The default port is 443. | |
| SANnav REST API | Timeout | The time (in seconds) in which a response is expected. The default is 180 seconds. |
| Port | The port number on which to connect. The default port is 443. | |
| Dell EMC ScaleIO / VxFlex / PowerFlex REST API | Timeout | The time (in seconds) in which a response is expected. The default is 180 seconds. |
| Port | The port number on which to connect. The default port is 443. | |
| REST API with API key authentication | API Key | The API key name. |
| Header Name | The header that is used in API requests to authenticate and authorize access. Examples: X-PAN-KEY, Authorization, Y-Cisco-Meraki-API-Key. | |
| Header Prefix (optional) | Optional header prefix. For example: Bearer <API Key>. | |
| Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. | |
| Port | The port number on which to connect. The default port is 443. | |
| REST API with basic authentication | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. |
| Access Protocol | Select Allow HTTP to enable REST API requests to be made over HTTP. Warning HTTP is not a secure protocol as the communication is not encrypted. This is a security risk that allows access credentials to be stolen. | |
| REST API with digest authentication | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. |
| Access Protocol | Select Allow HTTP to enable REST API requests to be made over HTTP. Warning HTTP is not a secure protocol as the communication is not encrypted. This is a security risk that allows access credentials to be stolen. | |
REST API with OAuth2 authentication | Client details (optional) | You can specify an optional Client ID and the secret to access REST APIs with OAuth2 authentication.
|
| Token endpoint | Enter the URL of the target where the token endpoint can be obtained. | |
| Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. | |
| Access Protocol | Select Allow HTTP to enable REST API requests to be made over HTTP. Warning HTTP is not a secure protocol as the communication is not encrypted. This is a security risk that allows access credentials to be stolen. | |
| Control-M Web API | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. |
| Access Protocol | Select Allow HTTP to enable Web API requests to be made over HTTP. Warning HTTP is not a secure protocol as the communication is not encrypted. This is a security risk that allows access credentials to be stolen. | |
| BMC Remedy ITSM Authentication with token | Timeout | Add the time (in seconds) in which a response is expected. The default value is 180 seconds. |
| Access Protocol | Select Allow HTTP to enable Web API requests to be made over HTTP. Warning HTTP is not a secure protocol as the communication is not encrypted. This is a security risk that allows access credentials to be stolen. | |
| Port | Specify the port to use to connect to the API. The default port is 443. |
Storage device credentials
Credential type | Parameter | Description |
|---|---|---|
| SNMP | Retries | The number of attempts made if no response is received from the host. The default is five. |
| Timeout | The time (in seconds) in which a response is expected from the host. The default is one second. | |
| SNMP Port | Select the check box and then select an SNMP port from the list. The list is populated with SNMP ports that you have configured in the Discovery Configuration window. | |
| SNMP Version | The SNMP version to use. From the SNMP version list, select one of the following: 1, 2c, or 3. The default is Version 2c. If you are setting up credentials for discovering Netware, you must select Version 1 from the SNMP version list. | |
| Use GETBULK | Use GETBULK requests instead of GETNEXT requests. GETBULK improves discovery performance. However, some devices do not support it correctly, which occasionally may lead to scanning issues. If you experience scanning issues, clear this option to revert to GETNEXT. | |
| SNMP v1/v2c | Community Name | The community used for SNMP read access to the defined host or hosts. This is applicable for SNMP V1 and V2c credentials only. |
| SNMP v3 | Security Level | For SNMP V3 credentials only. This field shows the security level selected by using the following authentication and privacy protocols:
No setting exists for privacy without authentication. |
| Authentication Protocol | Protocol used to encrypt the authentication with the client. This is applicable for SNMP V3 credentials only. Select one of the following options from the list:
The hashed passphrase is used to access the target system. Tip The SHA-2 authentication protocols (SHA-224, SHA-256, SHA-384, and SHA-512) are specified in the proposed standard
RFC 7860
| |
| Security Name | For SNMP V3 credentials only. | |
| Security-Authentication Key | The key (passphrase) used to encrypt the credentials. This is applicable for SNMP V3 credentials only, and only if you have selected an authentication protocol. This field must be at least 8 characters. | |
| Privacy Protocol | The protocol used to encrypt data retrieved from the target. Encrypting the data retrieved from a discovery target causes performance degradation as compared to not encrypting the data. This is for SNMP V3 credentials only, and only if you have selected an authentication protocol. That is, you cannot have privacy without authentication. Select one of the following options from the list:
| |
| Private key | The key (passphrase) used to encrypt the data. This is applicable for SNMP V3 credentials only, and only if you have selected a privacy protocol. This field must be at least 8 characters. | |
| Context | The SNMP v3 context. This field is optional and only required for some devices. | |
| WBEM | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. WBEM queries may take some time, so you might need to increase this timeout. |
| Access Protocol | The protocol to communicate with the WBEM server. Select HTTP, HTTPS, or both. | |
| WBEM HTTPS Port | Select a custom HTTPS port from the list. The list is populated with custom WBEM HTTPS ports that you have configured in Administration > Discovery Configuration. | |
| WBEM HTTP Port | Select a custom HTTP port from the list. The list is populated with custom WBEM HTTP ports that you have configured in Administration > Discovery Configuration. | |
| EMC VPLEX REST API | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. |
| HTTPS Port | Select an HTTPS port from the list. The list is populated with HTTPS ports that you have configured in Administration > Discovery Configuration. | |
| Dell EMC ECS Web API | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. |
| Port | The port number on which to connect. The default port is 443. | |
| Dell EMC Powervault Web API | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. |
| Access Protocol | Select Allow HTTP to enable REST API requests to be made over HTTP. Warning HTTP is not a secure protocol as the communication is not encrypted. This is a security risk that allows access credentials to be stolen. | |
| Port | The port number on which to connect. The default port is 443. | |
| HDI REST API | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. |
| Port | The port number on which to connect. The default port is 443. | |
| IBM DS8000 REST API | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. |
| Port | The port number on which to connect. The default port is 443. | |
| Nimble Storage Web API | Login path | The login path is the path to a token resource (to obtain a token for Rest API Authentication) on the Nimble storage API. The path is configurable on some versions of Nimble storage. You must use the default path for your Nimble storage device version. Contact your Nimble Storage vendor if the default path does not work and update the credential to match. The default value in the UI is |
| Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. | |
| Access Protocol | Select Allow HTTP to enable REST API requests to be made over HTTP. Warning HTTP is not a secure protocol as the communication is not encrypted. This is a security risk that allows access credentials to be stolen. | |
| Nutanix HCI REST API | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. |
| Port | The port number on which to connect. The default port is 443. | |
| Pure Storage Web API | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. |
| Access Protocol | Select Allow HTTP to enable REST API requests to be made over HTTP. Warning HTTP is not a secure protocol as the communication is not encrypted. This is a security risk that allows access credentials to be stolen. | |
| Port | The port number on which to connect. The default port is 443. | |
| Tintri REST API | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. |
| Port | The port number on which to connect. The default port is 443. |
Management Controller credentials
Credential type | Parameter | Description |
|---|---|---|
| SNMP | Retries | The number of attempts made if no response is received from the host. The default is five. |
| Timeout | The time (in seconds) in which a response is expected from the host. The default is one second. | |
| SNMP Port | Select the check box and then select an SNMP port from the list. The list is populated with SNMP ports that you have configured in the Discovery Configuration window. | |
| SNMP Version | The SNMP version to use. From the SNMP version list, select one of the following: 1, 2c, or 3. The default is Version 2c. If you are setting up credentials for discovering Netware, you must select Version 1 from the SNMP version list. | |
| Use GETBULK | Use GETBULK requests instead of GETNEXT requests. GETBULK improves discovery performance. However, some devices do not support it correctly, which occasionally may lead to scanning issues. If you experience scanning issues, clear this option to revert to GETNEXT. | |
| SNMP v1/v2c | Community: Name | The community used for SNMP read access to the defined host or hosts. This is applicable for SNMP V1 and V2c credentials only. |
| SNMP v3 | Security Level | For SNMP V3 credentials only. This field shows the security level selected by using the following authentication and privacy protocols:
No setting exists for privacy without authentication. |
| Authentication Protocol | Protocol used to encrypt the authentication with the client. This is applicable for SNMP V3 credentials only. Select one of the following options from the list:
The hashed passphrase is used to access the target system. Tip The SHA-2 authentication protocols (SHA-224, SHA-256, SHA-384, and SHA-512) are specified in the proposed standard
RFC 7860
| |
| Security Name | For SNMP V3 credentials only. | |
| Security-Authentication Key | The key (passphrase) used to encrypt the credentials. This is applicable for SNMP V3 credentials only, and only if you have selected an authentication protocol. This field must be at least 8 characters. | |
| Privacy Protocol | The protocol used to encrypt data retrieved from the target. Encrypting the data retrieved from a discovery target causes performance degradation as compared to not encrypting the data. This is for SNMP V3 credentials only, and only if you have selected an authentication protocol. That is, you cannot have privacy without authentication. Select one of the following options from the drop-down list:
| |
| Private key | The key (passphrase) used to encrypt the data. This is applicable for SNMP V3 credentials only, and only if you have selected a privacy protocol. This field must be at least 8 characters. | |
| Context | The SNMP v3 context. This field is optional and only required for some devices. | |
| Cisco IMC Web API | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. |
| HTTPS Port | Select an HTTPS port for the Web API from the list. The list is populated with HTTPS ports that you have configured in Administration > Discovery Configuration. Tip Cisco CIMC can be discovered by using XML API or SNMP. | |
| Cohesity REST API | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. |
| Port | The port number on which to connect. The default port is 443. | |
| HP iLO Web API | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. |
| HTTPS Port | Select a custom HTTPS port from the list. The list is populated with custom HTTPS ports that you have configured in Administration > Discovery Configuration. Tip To fully discover HP iLO Management Controller, valid HP iLO Web API credentials should be set up. However, it is possible to discover HP iLO without valid credentials by using the unauthenticated XMLDATA request (GET request to /xmldata?item=all). | |
| HP Moonshot Web API | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. |
| Access Protocol | Select Allow HTTP to enable REST API requests to be made over HTTP. Warning HTTP is not a secure protocol as the communication is not encrypted. This is a security risk that allows access credentials to be stolen. | |
| Port | The port number on which to connect. The default port is 443. | |
| Ubiquiti REST API | Timeout | The time (in seconds) in which a response is expected from the host. The default is 180 seconds. |
| Port | The port number on which to connect. The default port is 443. |
The Custom Credential group provides an option of adding a blank credential. If you have a specific requirement of adding a set of credentials that are listed under different groups in the UI then you do not need to add several separate credentials. You can configure a blank or custom credential by adding multiple credential types to it. For example, you may want to configure SSH, which is listed under the Host category, and WBEM, which is listed under the Storage Device category.
Click Blank Credential and follow the steps listed earlier in To add login credentials and enter field information relevant to the credential type that you add.
API provider credentials
The API provider credential optionally accepts an IP addresses or addresses in Matching criteria, and in Matching exceptions.In an IP scan, when, for example container management software is discovered, this might trigger additional discovery using an API provider credential. The IP addresses specified in Matching criteria are those for which an API scan can be triggered using this API provider credential. Similarly, the IP addresses specified in Matching exceptions are those for which an API scan cannot be triggered using this API provider credential.
Credential type | Parameter | Description |
|---|---|---|
| Kubernetes/ OpenShift | Authentication | The authentication to use with Kubernetes/OpenShift.
|
| Bearer Token | The token enabling access to the API. For information on getting a Kubernetes bearer token,
see this article
| |
| Cluster URLs | An optional newline-separated list of cluster URLs (including ports) to be scanned when performing an API scan using this credential. If you leave this field empty, the credential is not available when you create an API scan. | |
| Port | The port to use when dynamically building a cluster URL for requests performed during an IP scan. The default is 6443. Extend Cluster URLs with Port: If you specify Cluster URL without a prescription port, you can select this check box to set a default port for this URL. Warning If you enable port extension, the cluster URLs with no port will be extended with the credential port. | |
| Timeout | The time (in seconds) in which a response is expected. The default is 60 seconds. | |
| TLS Certificate Check | By default, BMC Helix Discovery checks the TLS certificate against the Kubernetes/OpenShift credentials. Warning If you clear (deselect) the TLS certificate check box, an attacker could perform a man-in-the-middle attack and intercept the Kubernetes/OpenShift credentials. Clear the check box only in a test environment where your server cannot be given a valid certificate. | |
| Proxy | If you need to connect through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
| Proxy Credentials | If you need to connect through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
| MongoDB | Port | The port number on which to connect. The default port is 27017. |
| Timeout | The time (in seconds) in which a response is expected. The default is 60 seconds. | |
| MongoDB Atlas | Public Key | A key formed by MongoDB Atlas together with a private key to set permissions with which to access the MongoDB Atlas user account. |
| Private Key | A key formed by MongoDB Atlas in a pair with a public key to set permissions with which to access the MongoDB Atlas user account. A private key is generated just once and cannot be restored. | |
| Use Proxy | If you need to connect through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
| Proxy Credentials | If you need to connect through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
| Timeout | The time (in seconds) in which a response is expected. The default is 60 seconds. | |
| Rancher | Rancher Token | The token enabling access to the API. For information on getting a Rancher token,
see this article
|
| Rancher URL | A URL to the Rancher management tool. | |
| Timeout | The time (in seconds) in which a response is expected. The default is 30 seconds. | |
| TLS Certificate Check | By default, BMC Helix Discovery checks the TLS certificate against the Rancher credentials. Warning If you clear (deselect) the TLS certificate check box, an attacker could perform a man-in-the-middle attack and intercept the Rancher credentials. Clear the check box only in a test environment where your server cannot be given a valid certificate. | |
| Proxy | If you need to connect through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
| Proxy Credentials | If you need to connect through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
|
When testing a Kubernetes/OpenShift credential that uses OpenShift OAuth authentication, you only add one URL, as the username and password combination in the credential is the same for each cluster.
Cloud credentials
The following video explains, in brief, the process for adding an AWS cloud credential and configuring a discovery scan to discover endpoints using the AWS cloud credential.
Credential type | Parameter | Description |
|---|---|---|
Alibaba Cloud | Access Key ID | The access key ID. The equivalent to a username. To upload a csv file containing the Key ID and Secret, click Upload CSV, select the file, and click Open. |
| Access Key Password | The access secret key or password. | |
| Timeout | The connection timeout and the read timeout (in seconds). The default is 60 seconds. The value specified here is a value for two separate timeouts. Consequently, the time before receiving data back on an initial connection could be up to almost twice the timeout value. That is, if the connection time was almost the maximum and the time to read the content was almost the maximum. | |
| Assume Roles (ARNs) | (Optional) Use the Alibaba Resource Name (ARN) only if you want to apply role-based authentication for a user, application, or service. You must have defined the role earlier in the Alibaba Cloud console. For information about defining roles, see Discovering Alibaba Cloud Platform. Example for a single role: To enable role-switching (multiple roles), enter each role as a new-line separated list. For more information about AWS roles and role-switching, see Discovering Alibaba Cloud Platform. Note: If you do not specify the ARN, you will discover Alibaba resources associated with the Access Key ID credentials. | |
| TLS Certificate Check | By default, BMC Helix Discovery checks the TLS certificate against the Alibaba Cloud credentials. Warning If you clear (deselect) the TLS certificate check box, an attacker could perform a man-in-the-middle attack and intercept the Alibaba Cloud credentials. Clear the check box only in a test environment where your server cannot be given a valid certificate. | |
| Proxy | If you need to connect to Alibaba Cloud through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
| Proxy Credentials | If you need to connect to Alibaba Cloud through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
Amazon Web Services | Access Key ID | The access key ID. The equivalent to a username, and refers to the initial account. The AWS IAM console enables you to download the Access Key ID and Access Secret Key as a csv file. You can import the csv files downloaded from the IAM console, reducing scope for cut and paste errors when creating AWS credentials in BMC Helix Discovery. To upload a csv file containing the Key ID and Secret, click Upload CSV, select the file, and click Open. |
| Access Key Secret | The access secret key or password. | |
Tip If the BMC Helix Discovery Outpost is running in an EC2 instance and that instance is associated with an instance profile, you can use that profile rather than an Access Key ID and Access Secret Key. If you leave these fields blank, AWS discovery uses the EC2 instance profile to perform the discovery. In the credential list, the AWS credential is labeled, | ||
| Timeout | The connection timeout and the read timeout (in seconds). The default is 60 seconds. The value specified here is a value for two separate timeouts. Consequently, the time before receiving data back on an initial connection could be up to almost twice the timeout value. That is, if the connection time was almost the maximum and the time to read the content was almost the maximum. | |
| TLS Certificate Check | By default, BMC Helix Discovery checks the TLS certificate against the AWS credentials. Warning If you clear (deselect) the TLS certificate check box, an attacker could perform a man-in-the-middle attack and intercept the AWS credentials. Clear the check box only in a test environment where your server cannot be given a valid certificate. | |
| Assume Roles (ARNs) | (Optional) Use the Amazon Resource Name (ARN) only if you want to apply role-based authentication for a user, application, or service. You must have defined the role earlier in AWS Identify and Access Management (IAM). For information on defining roles, see
Creating IAM roles
Example for a single role: To enable role-switching (multiple roles), enter each role as a new-line separated list. For more information about AWS roles and role-switching, see Discovering Amazon Web Services From the December 2021 TKU, the ARN field supports expansions using
Note: If you do not specify the ARN, you will discover AWS resources associated with the Access Key ID credentials. | |
| External ID | By default, BMC Helix Discovery uses an external ID with the "BMCDiscovery" value, which does not impact accounts without an AWS external ID. If a user account does have an AWS external ID, update this field with a valid value. AWS recommends to use one external ID for each AWS account. For more information, see
How to use an external ID when granting access to your AWS resources to a third party
| |
| System Manager Session Timeout | The time (in seconds) in which a response is expected from the System Manager session. The default is 180 seconds. | |
| Proxy | If you need to connect to AWS through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
| Proxy Credentials | If you need to connect to AWS through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
| Google Cloud Platform | Service Account | The key used to access the Google Cloud Platform services. Download the key from the Google Cloud Console as a JSON formatted file. Upload the JSON file to BMC Discovery. Select Choose File, select the JSON file in the file browser and click Open. When viewing the credential, this information populates the Project ID and Service Account Email fields. |
| Timeout | The connection timeout and the read timeout (in seconds). The default is 60 seconds. The value specified here is a value for two separate timeouts. Consequently, the time before receiving data back on an initial connection could be up to almost twice the timeout value. That is, if the connection time was almost the maximum and the time to read the content was almost the maximum. | |
| TLS Certificate Check | By default, BMC Helix Discovery checks the TLS certificate against the GCP credentials. Warning If you clear (deselect) the TLS certificate check box, an attacker could perform a man-in-the-middle attack and intercept the GCP credentials. Clear the check box only in a test environment where your server cannot be given a valid certificate. | |
| Identity-Aware Proxy Sessions | Automatically manage ssh keys for Linux compute instances accessed via IAP If automatic management is disabled or the managed key does not work, standard ssh credential matching will be used, based on the private IP address of the VM. Automatically manage passwords for Windows compute instances accessed via IAP Requires that the service account has the If automatic management is disabled or the generated password does not work, standard PowerShell credential matching will be used, based on the private IP address of the VM. | |
| Proxy | If you need to connect to GCP through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
| Proxy Credential | If you need to connect to GCP through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
| IBM Cloud | API Key: | The API key name. You can download the key as a JSON file from the the IBM Cloud API keys console when you create it. You can upload this to BMC Helix Discovery using the Upload JSON button. |
API Key: | The API key name. | |
| Timeout | The connection timeout and the read timeout (in seconds). The default is 60 seconds. The value specified here is a value for two separate timeouts. Consequently, the time before receiving data back on an initial connection could be up to almost twice the timeout value. That is, if the connection time was almost the maximum and the time to read the content was almost the maximum. | |
| TLS Certificate Check | By default, BMC Helix Discovery checks the TLS certificate against the IBM Cloud credentials. Warning If you clear (deselect) the TLS certificate check box, an attacker could perform a man-in-the-middle attack and intercept the IBM Cloud credentials. Clear the check box only in a test environment where your server cannot be given a valid certificate. | |
| Proxy | If you need to connect to IBM Cloud through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
| Proxy Credentials | If you need to connect to IBM Cloud through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
| Microsoft Azure | Directory ID | The Directory ID also known as the Tenant ID. The Directory ID is a GUID. The Directory ID can be found in the Azure Active Directory properties in the Azure Portal. |
| Application ID | The Application ID key. The Application ID is a GUID. | |
| Application Key | The application password. | |
| Timeout | The connection timeout and the read timeout (in seconds). The default is 60 seconds. The value specified here is a value for two separate timeouts. Consequently, the time before receiving data back on an initial connection could be up to almost twice the timeout value. That is, if the connection time was almost the maximum and the time to read the content was almost the maximum. | |
| TLS Certificate Check | By default, BMC Helix Discovery checks the TLS certificate against the Microsoft Azure credentials. Warning If you clear (deselect) the TLS certificate check box, an attacker could perform a man-in-the-middle attack and intercept the Microsoft Azure credentials. Clear the check box only in a test environment where your server cannot be given a valid certificate. | |
| Proxy | If you need to connect to Microsoft Azure through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
| Proxy Credentials | If you need to connect to Microsoft Azure through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
| OpenStack | User Domain | The overall container for your OpenStack projects, users, and groups. See the OpenStack documentation for more information on user domains. |
| Timeout | The connection timeout and the read timeout (in seconds). The default is 60 seconds. The value specified here is a value for two separate timeouts. Consequently, the time before receiving data back on an initial connection could be up to almost twice the timeout value. That is, if the connection time was almost the maximum and the time to read the content was almost the maximum. | |
| TLS Certificate Check | By default, BMC Helix Discovery checks the TLS certificate against the OpenStack credentials. Warning If you clear (deselect) the TLS certificate check box, an attacker could perform a man-in-the-middle attack and intercept the OpenStack credentials. Clear the check box only in a test environment where your server cannot be given a valid certificate. | |
| Proxy | If you need to connect to OpenStack through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
| Proxy Credentials | If you need to connect to OpenStack through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
| Oracle Cloud Infrastructure | User ID | The User ID provided in the Oracle Cloud Infrastructure API key configuration file. For more information about generating the API key and the configuration file in Oracle Cloud Infrastructure, see Discovering Oracle Cloud Infrastructure. |
| Tenancy ID | The Tenancy ID provided in the Oracle Cloud Infrastructure API key configuration file. | |
| API Key Fingerprint | The API Key Fingerprint provided in the Oracle Cloud Infrastructure API key configuration file. | |
| Api Key |
| |
| Timeout | The connection timeout and the read timeout (in seconds). The default is 60 seconds. The value specified here is a value for two separate timeouts. Consequently, the time before receiving data back on an initial connection could be up to almost twice the timeout value. That is, if the connection time was almost the maximum and the time to read the content was almost the maximum. | |
| TLS Certificate Check | By default, BMC Helix Discovery checks the TLS certificate against the Oracle Cloud Infrastructure credentials. Warning If you clear (deselect) the TLS certificate check box, an attacker could perform a man-in-the-middle attack and intercept the Oracle Cloud Infrastructure credentials. Clear the check box only in a test environment where your server cannot be given a valid certificate. | |
| Proxy | If you need to connect to Oracle Cloud Infrastructure through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
| Proxy Credentials | If you need to connect to Oracle Cloud Infrastructure through an HTTP proxy, enter the details here. This is an authenticating HTTP proxy rather than a BMC Discovery Windows proxy.
| |
Comments
Log in or register to comment.