Set ALM credentials (CLI)

Use the credentials_mng_console command line tool to set the credentials used to connect to ALM.

You must set ALM credentials before synchronizing entities between ALM Octane and ALM, and later on if these credentials change.

Note: Alternatively, set ALM credentials using the Endpoint Credentials Manager. For details, see Manage connection setup.

To open the credentials_mng_console command line tool:

On Windows
As an administrator, or as a user with permissions to run the Integration Bridge:

On Linux
As a root user, or as the user who installed the Integration Bridge:

  1. Open the <Bridge_installation_directory>\product\util\opb directory.
  2. Run the credentials_mng_console.bat file.
  1. Navigate to the <Bridge_installation_directory>/product/util/opb directory.
  2. Run the credentials_mng_console.sh file.

The credentials_mng_console tool supports the commands described below.

list

Lists available credential records for connecting to ALM from the Integration Bridge.

Usage

credentials_mng_console list –endpoint <ENDPOINT TYPE>

Parameters

-endpoint <ENDPOINT TYPE>

Endpoint type name, such as an ALM version (optional).

This type name must be a value available in the listEndpointTypes command.

Sample Results

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

Back to top

listEndpointTypes

Lists available ALM endpoint types accessible to the Integration Bridge, such as ALM versions. You can filter the endpoints by type name.

Usage

credentials_mng_console listEndpointTypes –endpoint <ENDPOINT TYPE>

Parameters

-endpoint <ENDPOINT TYPE>

Endpoint type name (optional)

Sample Results

Endpoint types  :
1. alm

Back to top

listCredentialIds

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

Usage

credentials_mng_console listCredentialIds –endpoint <ENDPOINT TYPE>

Parameters

-endpoint <ENDPOINT TYPE>

Endpoint type name, such as the ALM version (optional).

This type name must be a value available in the listEndpointTypes command.

Sample Results

Endpoint type : alm-11.5
Name | ID :
1. sample credentials record name | 11e7
====================
Endpoint type : sample-endpoint-type-11.5
Name | ID :
1. sample credentials record name | 21e0
2. sample credentials record #2 name | 7e0
Endpoint type : alm-11.5
Name | ID :
1. sample credentials record name | 11e7
====================
Endpoint type : sample-endpoint-type-11.5
Name | ID :
1. sample credentials record name | 21e0
2. sample credentials record #2 name | 7e0

Back to top

listEndpointTypeParams

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

Usage

credentials_mng_console listEndpointTypeParams –endpoint <ENDPOINT TYPE>

Parameters

-endpoint <ENDPOINT TYPE>

Endpoint type name, such as an ALM version (optional).

This type name must be a value available in the listEndpointTypes command.

Sample Results

======================
Endpoint type   : sample-endpoint-type-11.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

Back to top

create

Creates a credentials record for accessing ALM from the Integration Bridge.

Usage

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

Usage example - generic

credentials_mng_console create -user <USER> -pass <PASSWORD> -endpoint sample-endpoint-type-11.5 -name <CREDENTIALS NAME> -param sample.url.property <PARAMETER_VALUE> -param sample.url.property <PARAMETER_VALUE>

Usage example - ALM specific

credentials_mng_console create -user <USER> -pass <PASSWORD> -endpoint alm-11.5 -name <CREDENTIALS NAME>

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

Tip: On Linux:

Use an escape character (' or \) before any non-ASCII characters in the name.

-pass <PASSWORD> Password
-endpoint <ENDPOINT TYPE>

Endpoint type name, such as an ALM version.

This type name must be a value available in the listEndpointTypes command.

-name <CREDENTIALS NAME>

Credentials record name

-param <KEY> <VALUE> Custom parameters (optional)
-replace Replace all existing parameters with input parameters (optional)

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

endpoint=<ENDPOINT TYPE>
name=<NAME>
user=<USER>
pass=<PASSWORD>
customParam1=value1
customParam2=value2

Sample Results

endpoint=<ENDPOINT TYPE>
name=<NAME>
customParam1=value1
customParam2=value2

Back to top

update

Updates an existing credentials record for accessing ALM from the Integration Bridge.

Usage

credentials_mng_console update -user <USER> -pass <PASSWORD> -credentialsId <CREDENTIALS ID> -endpoint <ENDPOINT TYPE> -param <KEY> <VALUE> –param <KEY> <VALUE> -replace

Usage example

credentials_mng_console update -user <USER> -pass <PASSWORD> -credentialsId <CREDENTIALS ID> -endpoint alm-11.5 -replace

Parameters

-file <FILE>

Reads parameters from the property file (optional).

Parameters will be overwritten if they are specified in the console.

-user <USER>

New user name

Tip: On Linux:

Use an escape character (' or \) before any non-ASCII characters in the name.

-pass <PASSWORD> New password
-credentialsId <CREDENTIALS ID> The credentials record ID you want to update
-endpoint <ENDPOINT TYPE>

New endpoint name, such as an ALM version.

This type name must be a value available in the listEndpointTypes command.

-param <KEY> <VALUE>

Custom parameters (optional)

-replace

Replace all existing parameters with input parameters (optional)

Back to top

delete

Deletes an ALM credential record.

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

Usage

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

Parameters

-endpoint <ENDPOINT TYPE>

Endpoint type name, such as the ALM version.

This type name must be a value available in the listEndpointTypes command.

-credentialId <CREDENTIALS ID>

The credentials record ID

Back to top

help

Provides help for the current command when configuring ALM credentials for the Integration Bridge.

Usage

credentials_mng_console help