Appendix A. Utilities

A.1. Domain Management Tool

Red Hat Storage Console uses directory services to authenticate users. While during installation the manager sets up a domain named internal this is only used for the admin user. To add and remove other users from the system it is first necessary to add the directory service(s) in which they are found.

The supported directory service is IPA. Red Hat Storage Console includes a domain management tool, rhsc-manage-domains, to add and remove domains provided by these services. In this way it is possible to grant access to the Red Hat Storage environment to users stored across multiple domains.

You will find the rhsc-manage-domains command on the machine to which Red Hat Storage Console was installed. The rhsc-manage-domains command must be run as the root user.

A.1.1. Syntax

The usage syntax is:

Usage:rhsc-manage-domains -action=ACTION [options]

Available actions are:

add: Add a domain to the console directory services configuration.
edit: Edit a domain in the console directory services configuration.
delete: Delete a domain from the console directory services configuration.
validate: Validate the console directory services configuration. The command attempts to authenticate to each domain in the configuration using the configured username and password.
list: List the console's current directory services configuration.

The options available to be combined with the actions on the command line are:

-domain=DOMAIN: Specifies the domain the action must be performed on. The -domain parameter is mandatory for add, edit, and delete.
-user=USER: Specifies the domain user to use. The -user parameter is mandatory for add, and optional for edit.
-interactive: Specifies that the domain user's password is to be provided interactively. This option, or the - passwordFile option, must be used to provide the password for use with the add action.
-passwordFile=FILE: Specifies that the domain user's password is on the first line of the provided file. This option, or the -interactive option, must be used to provide the password for use with the add action.
-configFile=FILE: Specifies an alternative configuration file that the command must load. The -configFile parameter is always optional.
-report: Specifies that when performing the validate action all validation errors encountered will be reported in full.

Common usage examples are discussed further within this guide. For full usage information consult the rhsc-manage-domains command's help output:

# rhsc-manage-domains --help

A.1.2. Examples

The following examples demonstrate the use of the rhsc-manage-domains to perform basic manipulation of the Red Hat Storage Console domain configuration.