Appendix A. Utilities
A.1. Domain Management Tool
Red Hat Storage Console uses directory services to authenticate users. During installation, the manager sets up a domain named
internal that is only used to store the admin user. To add and remove other users from the system, you must first add the directory services 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 this service. In this way, you can 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 on 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:
# rhsc-manage-domains -action=ACTION [options]
The 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 user name and password.
-
list - List the current directory services configuration of the console.
The options that can be combined with the actions on the command line are:
- -
domain=DOMAIN - Specifies the domain on which the action must be performed. The
-domainparameter is mandatory foradd,edit, anddelete. - -
user=USER - Specifies the domain user to use. The
-userparameter is mandatory foradd, and optional foredit. - -
interactive - Specifies that the domain user's password is to be provided interactively. This option or the -
passwordFile -
-passwordFile=FILE - Specifies that the domain user's password is on the first line of the provided file. This option or the
-interactiveoption must be used to provide the password for use with theaddaction. -
-configFile=FILE - Specifies an alternative configuration file that the command must load. The
-configFileparameter is always optional. -
-report - Specifies that all validation errors encountered while performing the validate action will be reported in full.
Common examples of usage are discussed further within this guide. For full information on usage, see the
rhsc-manage-domains command help output:
# rhsc-manage-domains --help
A.1.2. Examples
The following examples demonstrate the use of
rhsc-manage-domains to perform basic manipulation of the Red Hat Storage Console domain configuration.
