dsccmon

Monitor servers registered with Directory Service Control Center

Synopsis

install-path/bin/dsccmon subcommand [options]

Description

The dsccmon command is used to monitor servers registered with Directory Service Control Center. Use the dsccmon command with the subcommands described in this man page.

Subcommands

The following subcommands are supported:

dsccmon view-repl-agmts

Show monitoring information about the replication agreements between Directory Server instances.

The format of this subcommand is:

dsccmon view-repl-agmts [-d seconds] [-b] [-s suffix-dn]…

dsccmon view-servers

Show monitoring information about registered servers.

The format of this subcommand is:

dsccmon view-servers [-d seconds] [-t] [-E]

dsccmon view-suffixes

Show monitoring information about suffixes supported by registered servers.

The usage of this subcommand is:

dsccmon view-suffixes [-d seconds] [-b] [-G] [-s suffix-dn]…

Global Options

The following options apply to all commands and subcommands:

-?

--help

Display usage for the command or for the specified subcommand.

-D user-dn

--user-dn user-dn

Bind using the specified user-dn.

By default, the value of the environment variable LDAP_ADMIN_USER is used. If LDAP_ADMIN_USER is not defined, cn=admin,cn=Administrators,cn=dcc is used.

-a

--all

Display hidden suffixes or servers, such as the server and suffixes used by Directory Service Control Center to manage metainformation about the directory service.

-h hostname

--hostname hostname

Connect to the Directory Service Control Center registry on the specified host or IP address.

By default, the value of the environment variable DSCC_HOST is used. If DSCC_HOST is not defined, localhost is used.

For example, when mapping the IPv4 address 192.168.0.99 to IPv6, pass the -h option with its argument as -h ::ffff:192.168.0.99.

-p port-number

--port port-number

Connect to the Directory Service Control Center registry on the specified port.

By default, the value of the environment variable DSCC_PORT is used. If DSCC_PORT is not defined, 3998 is used.

-u uid

--username uid

Bind using cn=uid,cn=Administrators,cn=dcc.

By default, the value of the environment variable LDAP_ADMIN_USER is used. If LDAP_ADMIN_USER is not defined, cn=admin,cn=Administrators,cn=dcc is used.

-V

--version

Displays the current version of dsccmon. The version is provided in the format year.monthday.time. So version number 2007.1204.0035 was built on December 4th, 2007 at 00h35. If the components used by dsccmon are not aligned, the version of each individual component is displayed.

-v

--verbose

Display extra information for debugging purposes.

-w file

--pwd-file file

Bind using the password specified in file.

By default, the value of the environment variable LDAP_ADMIN_PWF is used. If LDAP_ADMIN_PWF is not defined, dsccmon prompts for a password.

Subcommands Options

The following options apply to the subcommands where they are specified:

-E
--error: Display detailed server error information.
-G
--genid: Display generation IDs.
-b
--brief: Do not display nonessential data, such as headers and notes.
-d seconds
--period seconds: Update monitoring information each specified number of seconds.
-s suffix-dn
--suffix suffix-dn: Display information for the specified suffix only.
-t
--ipath: Display the server instance path.

Environment Variables

The following environment variables are supported:

DSCC_HOST: Bind to the registry on this host.
DSCC_PORT: Bind to the registry on this port number.
LDAP_ADMIN_PWF: Read the bind password from this file.
LDAP_ADMIN_USER: Bind with this user DN or uid.

Exit Status

The following exit status values are returned:

0: Successful completion
non-zero: An error occurred.

Attributes

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	SUNWdsee7
Stability Level	Evolving