pw sso config

The pw sso config command sets configuration parameters for the BMC Atrium SSO integration with BMC ProactiveNet. The command also modifies properties in BMC ProactiveNet configuration files. The modifications are verified by the BMC Atrium SSO server, but no changes occur in the server.

Long form

pw sso config --admin <user group name> --am-pwd <password> --bppm-host <host> --enable --list --sso-host <host> --port <ssl port> --searcher-id <user name> --searcher-password <password>

Short form

pw sso config -a <user group name> -w <password> -s <bppm-host> -e -l -o <ssl-host> -p <ssl port> -i <user name> -q <password>

Parameter descriptions

Parameter - Long form

Parameter - Short form

Description

--admin

-a

Name of user group to be given Full Access to BMC ProactiveNet

--am-pwd

-w

Password for the BMC Atrium SSO server AmAdmin account

--bppm-host

-s

BMC ProactiveNet Server host name and domain that users will use to access BMC ProactiveNet
The --bppm-host parameter is used to create the URL for the Pronto web application. Because the authentication filter will forward the URL to the user's browser, it must be exactly as the user sees it. This URL is stored in the BMC Atrium SSO server as an agent. When a user unregisters, the same URL must be provided. If the URL differs, the user will have to manage the BMC ProactiveNet Agent tables on the BMC Atrium SSO server console. See pw-sso-unregister.

--disable

-d

Disables the BMC Atrium SSO integration

--enable

-e

Enables the BMC Atrium SSO integration

--list

-l

Optional parameter; lists the properties after modification

--help

-h

Optional parameter; displays online help

--sso-host

-o

BMC Atrium SSO host name and domain

--port

-p

BMC Atrium SSL port

--searcher-id

-i

The searcher-id user name that exists in BMC Atrium SSO server for the user who can search for all user names and all groups

Note

The searcher-id parameter must be associated with the BmcSearchAdmins group in BMC Atrium SSO.

--searcher-password

-q

Password for the user who can search for all user names and all groups

Note

  • The values set by the pw sso config command are used by the other pw sso commands. 
  • The pw sso config command is also used to update properties postinstallation.
Example

Long form:

pw sso config --admin admin --am-pwd AdminSSO --bppm-host bppmHost.bmc.com --enable --sso-host proactivenet.sso.com --port 8443 --searcher-id AdminAdmin --searcher-password Admin1234

Short form:

pw sso config -a admin -w AdminSSO -s bppmHost.bmc.com -e -sso-host proactivenet.sso.com -p 8443 -i AdminAdmin -q Admin1234

Enabling Atrium SSO integration

To switch BMC Atrium SSO integration on (enable), run the following commands:
Long form:

pw sso config --enable
pw sso load

Short form:

pw sso config -e
pw sso load

Disabling Atrium SSO integration

To switch BMC Atrium SSO integration off (disable), run the following commands:
Long form:

pw sso config --disable
pw sso load

Short form:

pw sso config -d
pw sso load

pw sso config return codes

Codes

Description

0

Success

1

General error

2

Usage

3

Missing value

4

Port number must be a number greater than or equal to 0, and less than or equal to 65535.

5

<hostname> is not a fully qualified host name. Provide a host name including the domain name, for example example.bmc.com.

6

<hostname> is not an active host name.

7

Failed to connect to BMC Atrium SSO server for HTTPS certificate download (connection refused: connect)

8

Failed to connect to BMC Atrium SSO server, return code: 404

9

Failed while fetching authentication info from BMC ProactiveNet Server

10

<user> user not found, authentication failed

11

<user> user authentication failed, check the user name and password

12

Authentication failed for user <user>

13

This BMC Atrium SSO server does not support GROUP identity search (version of server is too old). Upgrade BMC Atrium SSO server.

14

<user> user does not have search permissions, failed call to BMC Atrium SSO server

15

SSO Group Search failed. See logs for more information.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*