<a id="domains-config"></a>

# domains-config

## domains-config create-domain-config

**Usage**

```none
  usage: symp domains-config create-domain-config
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--fit-width] [--print-empty]
                                                  [--noindent] [--prefix PREFIX]
                                                  [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                  [--driver DRIVER]
                                                  domain_id config
```

**Description**

Configures a domain with the relevant configuration parameters.

**Mandatory**

```none
positional arguments:
  domain_id             The ID of the domain (account) to be configured
  config                A JSON string of configuration parameters to pass to the driver
                        If --driver = 'ldap' or 'openotp' The following parameters must be included: user, password, url, suffix, user_tree_dn
                        For example:
                        -{
                        -    "user": "cn=Administrator,cn=Users,dc=example,dc=com",
                        -    "password": "123PASSword",
                        -    "url": "ldap://10.11.12.13:333",
                        -    "suffix": "dc=example,dc=com",
                        -    "user_tree_dn": "cn=Users,dc=example,dc=com"
                        -}
                        For information about additional LDAP configuration parameters see:
                        https://github.com/Stratoscale/openstack-keystone/blob/master/etc/keystone.conf.sample under [ldap]
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --driver DRIVER       The driver to use for the domain's authentication; either ldap or openotp. Default: ldap
```

## domains-config delete-domain-config

**Usage**

```none
  usage: symp domains-config delete-domain-config
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--fit-width] [--print-empty]
                                                  [--noindent] [--prefix PREFIX]
                                                  [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                  domain_id
```

**Description**

Deletes the configuration of a domain (account), reverting it to the default configuration.

**Mandatory**

```none
positional arguments:
  domain_id             The ID of the domain (account) whose configuration is being deleted
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## domains-config get-domain-config

**Usage**

```none
  usage: symp domains-config get-domain-config
[-f {adaptive_table,json,shell,table,value,yaml}]
                                               [-c COLUMN]
                                               [--max-width <integer>]
                                               [--fit-width] [--print-empty]
                                               [--noindent] [--prefix PREFIX]
                                               [-m [NAME=VALUE [NAME=VALUE ...]]]
                                               domain_id
```

**Description**

Displays the details of the current configuration of a given domain (account).

**Returns**

Returns dict: The configuration of the given domain (account)

**Mandatory**

```none
positional arguments:
  domain_id             The ID of the domain (account) whose configuration is to be displayed
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## domains-config test-ldap-config

**Usage**

```none
  usage: symp domains-config test-ldap-config
[-f {adaptive_table,json,shell,table,value,yaml}]
                                              [-c COLUMN]
                                              [--max-width <integer>]
                                              [--fit-width] [--print-empty]
                                              [--noindent] [--prefix PREFIX]
                                              [-m [NAME=VALUE [NAME=VALUE ...]]]
                                              domain_id config
```

**Description**

Validate LDAP configuration of a given domain.

**Returns**

Returns dict: LDAP stats for the given domain

**Mandatory**

```none
positional arguments:
  domain_id             The ID of the domain (account) whose LDAP configuration will be set
  config                A JSON string of configuration parameters to pass to the driver.
                        For details - see "domains-config create-domain-config"
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## domains-config test-openotp-config

**Usage**

```none
  usage: symp domains-config test-openotp-config
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                 [-c COLUMN]
                                                 [--max-width <integer>]
                                                 [--fit-width] [--print-empty]
                                                 [--noindent] [--prefix PREFIX]
                                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                 domain_id config
```

**Description**

Validate OpenOTP configuration of a given domain.

**Returns**

Returns dict: OpenOTP & LDAP stats for the given domain

**Mandatory**

```none
positional arguments:
  domain_id             The ID of the domain (account) whose LDAP configuration will be set
  config                A JSON string of configuration parameters to pass to the driver.
                        For details - see "domains-config create-domain-config"
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## domains-config update-domain-config

**Usage**

```none
  usage: symp domains-config update-domain-config
[-f {adaptive_table,json,shell,table,value,yaml}]
                                                  [-c COLUMN]
                                                  [--max-width <integer>]
                                                  [--fit-width] [--print-empty]
                                                  [--noindent] [--prefix PREFIX]
                                                  [-m [NAME=VALUE [NAME=VALUE ...]]]
                                                  [--driver DRIVER]
                                                  domain_id config
```

**Description**

Update a domain.
For more information on parameters and valid configurations:
[https://developer.openstack.org/api-ref/identity/v3/?expanded=create-domain-configuration-detail#create-domain-configuration](https://developer.openstack.org/api-ref/identity/v3/?expanded=create-domain-configuration-detail#create-domain-configuration).

**Mandatory**

```none
positional arguments:
  domain_id             The ID of the domain to configure
  config                Parameters to pass to the driver
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --driver DRIVER       The driver to use for the domain's authentication. Either ldap or openotp
```