domain modify

Changes the description of a domain. You must log in to the management domain as an administrator to perform this command.

Requires authentication (administrator ID and password) to use this command.

This command applies to LDAP registries only.

Syntax

domain modify domain description description

Options

description description
Specifies a new description for the domain.

A valid description is an alphanumeric string that is not case-sensitive. String values are expected to be characters that are part of the local code set. Spaces are allowed. If the description contains a space, ensure that you enclose the description in double quotation marks. You can specify an empty string ("") to clear an existing description.

Example of description: "marketing and advertising areas"

domain
Specifies the name of the domain to modify.

Return codes

0
The command completed successfully.
1
The command failed. When a command fails, the pdadmin command provides a description of the error and an error status code in hexadecimal format (for example, 0x14c012f2). See "Error messages" in the IBM Knowledge Center. This reference provides a list of the Security Access Manager error messages by decimal or hexadecimal codes.

Example

The following example changes the description that is specified for the Marketing domain:
pdadmin sec_master> domain modify Marketing description "marketing and
advertising areas"

See also