server

Description

Manages authentication parameters required by rl-protect for connecting to Spectra Assure Community or Portal user accounts.

Users can create, modify, and remove settings for one or more connections in the configuration file (config.info). Every connection is assigned a unique name (connection ID). This allows connection settings to persist across scans, and eliminates the need to explicitly specify user tokens and Portal server details every time the user wants to run a scan.

The connection ID "default" is reserved and automatically used if no other connection is specified.

Supported sub-commands

The server command supports several sub-commands for managing configured connections.

• server connect - for creating new connections to Spectra Assure Community and Spectra Assure Portal accounts in the rl-protect configuration.

• server list - for displaying all currently created and active connections in the rl-protect configuration.

• server remove - for deleting previously created connections from the rl-protect configuration.

• server update - for modifying existing connections in the rl-protect configuration, including the default connection.

Usage

rl-protect server <sub-command> [<options>]

rl-protect server connect [<connection-id>] [<options>]

rl-protect server list [<connection-id>] [<options>]

rl-protect server remove [<connection-id>] [<options>]

rl-protect server update [<connection-id>] [<options>]

Options

connect

Option	Description
--rl-token	Required. Provide the token for your Spectra Assure Community or Portal account.
--save-token	Specify whether to save the token into the rl-protect config.info configuration file. Tokens are saved by default; set this parameter to --save-token=false to override the default behavior.
--connection-id, --connect-id	Specify the connection name. If not specified, the default connection is used.
--config-path	Specify the path to a custom config.info file where you want to store the connection settings.
--rl-portal-server, --rl-server	Required only when connecting to the Portal. Name of the Spectra Assure Portal instance associated with your account (example: my.secure.software/company).
--rl-portal-org, --rl-org	Required only when connecting to the Portal. Name of the Spectra Assure Portal organization. The organization must exist on the Portal instance specified with --rl-portal-server. The user account authenticated with the token must be a member of the specified organization and have the appropriate permissions. Organization names are case-sensitive.
--rl-portal-group, --rl-group	Applies only when connecting to the Portal. Name of the Spectra Assure Portal group. The group must exist in the Portal organization specified with --rl-portal-org. Group names are case-sensitive.
--ca-path	Path to the directory where CA certificates are stored.
--proxy-server	Use this parameter to provide the server URL for optional local proxy configuration.
--proxy-port	Use this parameter to provide the network port for optional local proxy configuration.
--proxy-user	Use this parameter to provide the user name for optional local proxy authentication. Must be used together with --proxy-password.
--proxy-password	Use this parameter to provide the password for optional local proxy authentication. Must be used together with --proxy-user.

list

Option	Description
--connection-id, --connect-id	Specify the connection name for which you want to view the current configuration. If not specified, all connections are displayed.
--config-path	Specify the path to a custom config.info file from which you want to read and display the configuration.

remove

Option	Description
--connection-id, --connect-id	Specify the connection name. If not specified, the default connection is removed.
--config-path	Specify the path to a custom config.info file where you want to remove the connection settings.

update

Option	Description
--rl-token	Provide the token for your Spectra Assure Community or Portal account.
--save-token	Specify whether to save the token into the rl-protect config.info configuration file. Tokens are saved by default; set this parameter to --save-token=false to override the default behavior.
--connection-id, --connect-id	Specify the connection name. If not specified, the default connection is updated.
--remove-token	Remove an existing token for the specified connection from the configuration file.
--config-path	Specify the path to a custom config.info file where you want to update the connection settings.
--rl-portal-server, --rl-server	Applies only for Portal connections. Name of the Spectra Assure Portal instance associated with your account (example: my.secure.software/company).
--rl-portal-org, --rl-org	Applies only for Portal connections. Name of the Spectra Assure Portal organization. The organization must exist on the Portal instance specified with --rl-portal-server. The user account authenticated with the token must be a member of the specified organization and have the appropriate permissions. Organization names are case-sensitive.
--rl-portal-group, --rl-group	Applies only for Portal connections. Name of the Spectra Assure Portal group. The group must exist in the Portal organization specified with --rl-portal-org. Group names are case-sensitive.
--ca-path	Path to the directory where CA certificates are stored.
--proxy-server	Use this parameter to provide the server URL for optional local proxy configuration.
--proxy-port	Use this parameter to provide the network port for optional local proxy configuration.
--proxy-user	Use this parameter to provide the user name for optional local proxy authentication. Must be used together with --proxy-password.
--proxy-password	Use this parameter to provide the password for optional local proxy authentication. Must be used together with --proxy-user.