Configure the set of servers to be monitored by this Metrics Engine and prepare external servers for monitoring.
This tool is used to manage the set of servers to be monitored by the Metrics Engine. In addition this tool will prepare a server for monitoring by creating an account on monitored servers to be used by the Metrics Engine for collecting data. See the --help-subcommands option for a list of supported sub-commands.
Configure and prepare monitored servers
Configure the Metrics Engine to monitor one or more servers over LDAP(S). In addition to specification of the Metrics Engine to configure, this command requires specification of a single remote server. By default the Metrics Engine is configured to monitor this remote server as well as any other servers that are registered with the remote server's administrative data (see the dsframework tool). The idempotent nature of this command means it may be re-run any number of times specifying the same same remote server in order to rediscover any newly registered servers or to re-prepare a monitored server if necessary
This command will configure the Metrics Engine by creating LDAP External Server objects in the configuration. The newly created objects can be modified or deleted using the dsconfig tool
Before a server is added to the Metrics Engine configuration it is first prepared for monitoring. Preparation means that an account 'cn=Monitoring User,cn=Root DNs,cn=config' is created on the server to be monitored for exclusive use by the Metrics Engine. This account will have the right privileges for allowing the access to monitoring data of the monitored server. This tool will ensure that the LDAP connection information and credentials stored in the monitored server's LDAP External Server of the Metrics Engine configuration are correct
monitored-servers add-servers --bindDN uid=admin,dc=example,dc=com \
--bindPassword password --monitoringUserBindPassword password \
--remoteServerBindPassword password --remoteServerHostname localhost \
--remoteServerPort 1389
monitored-servers add-servers --bindDN uid=admin,dc=example,dc=com \
--bindPassword password --monitoringUserBindPassword password \
--remoteServerHostname localhost --remoteServerPort 1389 \
--remoteServerBindPassword password --dry-run
--remoteServerHostname {host}
| Description | Hostname or IP address of a remote server either to be monitored or to be used to discover other servers to be monitored |
| Required | Yes |
| Multi-Valued | No |
--remoteServerPort {port}
| Description | Remote server port number |
| Default Value | 389 |
| Required | No |
| Multi-Valued | No |
--remoteServerBindDN {bindDN}
| Description | DN used to bind to the remote server. The DN must represent an account that can be used to manage the remote server(s) |
| Default Value | cn=Directory Manager |
| Required | No |
| Multi-Valued | No |
--remoteServerBindPassword {bindPassword}
| Description | Password used to bind to the server |
| Required | No |
| Multi-Valued | No |
--remoteServerConnectionSecurity {connectionSecurityOption}
| Description | Security option used to connect to the remote server with admin topology data: noSecurity, useSSL, useStartTLS. Connections to remote peer servers will use the preferredSecurity option specified in the admin topology data |
| Default Value | noSecurity |
| Required | No |
| Multi-Valued | No |
--remoteServerBindPasswordFile {bindPasswordFile}
| Description | Bind password file |
| Required | No |
| Multi-Valued | No |
--monitoringUserBindPassword {bindPassword}
| Description | Password that the Metrics Engine will use to access monitoring data using the cn=Monitoring User,cn=Root DNs,cn=config account |
| Required | No |
| Multi-Valued | No |
--monitoringUserBindPasswordFile {bindPasswordFile}
| Description | Password that the Metrics Engine will use to access monitoring data using the cn=Monitoring User,cn=Root DNs,cn=config account |
| Required | No |
| Multi-Valued | No |
--addRemoteServerOnly
| Description | Add only the remote server but not any of its registered peers |
--addRemotePeersOnly
| Description | Add only the remote server's registered peers but not the remote server itself |
-n
--dry-run
| Description | Show what would be done but do not perform any operation |
Stop monitoring monitored server and remove all data collected from the server
Remove monitored server from the servers to be monitored by the Metrics Engine. All data captured from the server is also removed
monitored-servers remove-server --bindDN uid=admin,dc=example,dc=com \
--bindPassword password serverhost:389
Change the display name of a monitored server
Change the display name of a monitored server in the Metrics Engine. The new display name will be used with existing and newly captured data from the monitored server
monitored-servers rename-server --bindDN uid=admin,dc=example,dc=com \
--bindPassword password serverhost:389 directory-5
-V
--version
| Description | Display Metrics Engine version information |
-H
--help
| Description | Display general usage information |
--help-debug
| Description | Display help for using debug options |
| Advanced | Yes |
-Z
--useSSL
| Description | Use SSL for secure communication with the server |
-q
--useStartTLS
| Description | Use StartTLS to secure communication with the server |
--useNoSecurity
| Description | Use no security when communicating with the server |
-h {host}
--hostname {host}
| Description | Fully qualified host name or IP address of the local Metrics Engine |
| Default Value | localhost |
| Required | No |
| Multi-Valued | No |
-p {port}
--port {port}
| Description | Metrics Engine port number |
| Default Value | 389 |
| Required | No |
| Multi-Valued | No |
-D {bindDN}
--bindDN {bindDN}
| Description | DN used to bind to the server |
| Default Value | cn=Directory Manager |
| Required | Yes |
| Multi-Valued | No |
-w {bindPassword}
--bindPassword {bindPassword}
| Description | Password used to bind to the server |
| Required | No |
| Multi-Valued | No |
-j {bindPasswordFile}
--bindPasswordFile {bindPasswordFile}
| Description | Bind password file |
| Required | No |
| Multi-Valued | No |
-o {name=value}
--saslOption {name=value}
| Description | SASL bind options |
| Required | No |
| Multi-Valued | Yes |
-X
--trustAll
| Description | Trust all server SSL certificates |
-P {trustStorePath}
--trustStorePath {trustStorePath}
| Description | Certificate trust store path |
| Required | No |
| Multi-Valued | No |
-T {trustStorePassword}
--trustStorePassword {trustStorePassword}
| Description | Certificate trust store PIN |
| Required | No |
| Multi-Valued | No |
-U {path}
--trustStorePasswordFile {path}
| Description | Certificate trust store PIN file |
| Required | No |
| Multi-Valued | No |
-K {keyStorePath}
--keyStorePath {keyStorePath}
| Description | Certificate key store path |
| Required | No |
| Multi-Valued | No |
-W {keyStorePassword}
--keyStorePassword {keyStorePassword}
| Description | Certificate key store PIN |
| Required | No |
| Multi-Valued | No |
-u {keyStorePasswordFile}
--keyStorePasswordFile {keyStorePasswordFile}
| Description | Certificate key store PIN file |
| Required | No |
| Multi-Valued | No |
-N {nickname}
--certNickname {nickname}
| Description | Nickname of the certificate for SSL client authentication |
| Required | No |
| Multi-Valued | No |
-v
--verbose
| Description | Use verbose mode |
--propertiesFilePath {propertiesFilePath}
| Description | Path to the file that contains default property values used for command-line arguments |
| Required | No |
| Multi-Valued | No |
--noPropertiesFile
| Description | Specify that no properties file will be used to get default command-line argument values |
--script-friendly
| Description | Use script-friendly mode |
--help-subcommands
| Description | Display all subcommands |