How to specify credentials using a command line tool

This command line tool enables you to create and manage client-side endpoint credentials. With this tool, you can:

  • List credentials, filtered by endpoint type name
  • Create new credentials for a specified endpoint type
  • Update existing credentials
  • Delete existing credentials

To run the tool:

Run the credentials_mng_console.bat file (Windows only) in the <Agent_installation_directory>\product\util\opb folder.

list

Lists available credentials, filtered by endpoint type name.

Usage:

credentials_mng_console list –endpoint <ENDPOINT TYPE>

Parameters:

-endpoint <ENDPOINT TYPE> Endpoint type name (optional)

Result:

======================
Endpoint type  : sample-endpoint-type-12.5
ID             : 9460b7
Name           : sample credentials record
User           : sample username
Password       : ******
Parameters     :
Key | Value
-----------
sample.secret.property | ******
sample.url.property | 123

listEndpointTypes

Lists available endpoint types, filtered by endpoint type name.

Usage:

credentials_mng_console listEndpointTypes –endpoint <ENDPOINT TYPE>

Parameters:

-endpoint <ENDPOINT TYPE> Endpoint type name (optional)

Result:

Endpoint types : 1. indexing-domain 2. ucmdb-10.20

listCredentialIds

Lists all credential IDs and the endpoint type related to each credential ID.

Usage:

credentials_mng_console listCredentialIds –endpoint <ENDPOINT TYPE>

Parameters:

-endpoint <ENDPOINT TYPE> Endpoint type name (optional)

Result:

====================
Endpoint type : indexing-domain
Name | ID :
1. sample credentials record name | 11e7

====================
Endpoint type : ucmdb-10.20
Name | ID :
1. sample credentials record name | 21e0
2. sample credentials record #2 name | 7e0

listEndpointTypeParams

Lists the specific parameters required for saving credentials for each endpoint type.

Usage:

credentials_mng_console listEndpointTypeParams –endpoint <ENDPOINT TYPE>

Parameters:

-endpoint <ENDPOINT TYPE> Endpoint type name (optional)

Result:

====================== Endpoint type : indexing-domain-12.5 Output format: Parameter: Label: Description: Mandatory: -------------------------------------------- Endpoint type specific parameters: Parameter: sample.url.property Label: Server URL Description: URL address for sample server Mandatory: true Parameter: sample.secret.property Label: Secret key Description: Secret key for sample server Mandatory: false Usage example: credentials_mng_console create -endpointType indexing-domain-12.5 -name <NAME_VALUE> -user <USER_VALUE> -pass <PASSWORD_VALUE> -param sample.url.property <PARAMETER_VALUE> -param sample.secret.property <PARAMETER_VALUE>

create

Creates a credentials record.

Usage:

credentials_mng_console create –file <path to data file> –user <USER> –pass <PASSWORD> -endpoint <ENDPOINT TYPE> -name <CREDENTIALS NAME> -param <KEY> <VALUE> –param <KEY> <VALUE>

Usage example

credentials_mng_console create -user <USER_VALUE> -pass <PASSWORD> -endpoint indexing-domain-12.5 -name <NAME_VALUE> -param sample.url.property <PARAMETER_VALUE> -param sample.secret.property <PARAMETER_VALUE>

Parameters:

-file <FILE> Read parameters from the property file (optional). Parameters will be overwritten if they are specified in the console.
-user <USER> User name
-pass <PASSWORD> Password
-endpoint <ENDPOINT TYPE> Endpoint type name (optional)
-name <CREDENTIALS NAME> Credentials name
-param <KEY> <VALUE> Custom parameters (optional)

The property file is a text file that describes the credential's properties. The file format is:

endpoint=
name=
user=
pass=
customParam1=value1
customParam2=value2

Result:

endpoint=ALM_12.5
name=Build-Jenkins-Master
customParam1=value1
customParam2=value2

update

Updates an existing credentials record.

Usage:

credentials_mng_console update –file <path to data file> –user <USER> –pass <PASSWORD> -endpoint <ENDPOINT TYPE> -name <CREDENTIALS NAME> -param <KEY> <VALUE> –param <KEY> <VALUE> -replace

Parameters:

-file <FILE> Read parameters from the property file (optional). Parameters will be overwritten if they are specified in the console.
-user <USER> User name
-pass <PASSWORD> Password
-endpoint <ENDPOINT TYPE> Endpoint type name
-param <KEY> <VALUE> Custom parameters (optional)
-replace Replace all existing parameters with input parameters (optional).

delete

Deletes a credential.

Note You cannot delete a single parameter from a credential. You can delete an entire credential.

Usage:

credentials_mng_console delete –endpoint <ENDPOINT TYPE> -credentialsId <CREDENTIALS ID>

Parameters:

-endpoint <ENDPOINT TYPE> Endpoint type name
-credentialId <CREDENTIALS ID> The credentials ID

help

Provides help for the current topic.

Usage:

credentials_mng_console help

Related Topics Link IconRelated Information