BLCLI command options

Option

Description

-f <SSO credential cache file>

Specifies an alternate location for the single sign-on (SSO) credential cache file name.
This option takes precedence over the environment variable setting BL_SSO_CRED_CACHE_FILE. For information about this environment variable, see Environment variables

-h

Displays information about command options, then exits.

-n true|false

Specifies whether to run the BLCLI in interactive mode (true) or non-interactive mode (false).
By default, the BLCLI runs in interactive mode. One effect of this is that if you have not provided authentication information (see Authenticating against the Application Server), the BLCLI prompts you to do so when you try to run a command.
If you are running a command within a script and do not provide authentication information, this interactive prompting behavior can cause the script to hang.
To avoid this situation, you can use the -n false option with each command within a script. When you do this, if the BLCLI discovers that you have not provided authentication information, it displays an error message to that effect, and exits the script.
When operating BLCLI over SSO, if this option is set to -n true (the default value) and you are authorized for multiple roles, BLCLI will prompt you to select a role. If, however, this option is set to -n false, you are required to specify the role (either through the -r option or an environment variable). If you do not specify a role, the following error is reported: Failed to connect to server. Must specify a role.

-r <role name>

Specifies your role. Required if -n false .
This option takes precedence over the BL_RBAC_ROLE environment variable. For information about this environment variable, see Environment variables.

-rr <REST response type>

Used with RESTful web services. Use this option to set the REST response type to XML or Java Script Object Notation (JSON). Set this option to one of the following strings:

• XML
  
• JSON

-v <authentication profile name>

Specifies the name of the authentication profile to which the cached session credential should conform.
This option takes precedence over the BL_AUTH_PROFILE_NAME environment variable. For information about this environment variable, see Environment variables.

-w <authentication profiles file>

All authentication profiles are stored within a single XML file. By default, this file resides at installDirectory/br/authenticationProfiles.xml.
You can use the -w option to specify an alternate location for this file.
Note that this option takes precedence over the BL_AUTH_PROFILES_FILE environment variable. For information about this environment variable, see Environment variables.

-x <TLS certificate store>

Specifies file name of the TLS certificate store.
This option takes precedence over the BL_SSO_TRUSTED_CERT_KEYSTORE_FILE environment variable. For information about this environment variable, see the Environment variables.