Remove a server from this server's topology.
This tool will remove the specified server from the topology. In general, the uninstall tool should be used to remove a server from the topology. The remove-defunct-server tool should only be used if a prior attempt to uninstall a server was unsuccessful or the system where the server was installed is no longer available, leaving the server permanently inaccessible from the topology. If the defunct server is online and is able to reach other servers in the topology, running remove-defunct-server from it will cleanly remove it from the topology. If it cannot reach the other servers, then remove-defunct-server must also be run from one of the online servers.
remove-defunct-server
remove-defunct-server --serverInstanceName "Austin Directory Server 1" \
--bindDN "cn=Directory Manager" --bindPassword secret
remove-defunct-server --serverInstanceName "Austin Directory Server 1" \
--bindDN "cn=Directory Manager" --bindPassword secret \
--topologyFilePath topology.json
remove-defunct-server --serverInstanceName "Austin Directory Server 1" \
--bindDN "cn=Directory Manager" --bindPassword secret --ignoreOnline \
--retryTimeoutSeconds 600
-V
--version
| Description | Display Directory Server version information |
-H
--help
| Description | Display general usage information |
--help-debug
| Description | Display help for using debug options |
| Advanced | Yes |
-D {bindDN}
--bindDN {bindDN}
| Description | The DN of an administrator user that is present on every server in the topology |
| Default Value | cn=admin |
| Required | No |
| Multi-Valued | No |
-w {bindPassword}
--bindPassword {bindPassword}
| Description | Password used to bind to the server |
| Required | No |
| Multi-Valued | No |
--topologyFilePath {topologyFilePath}
| Description | The topology hosts file containing the list of hosts that are already in the topology. If specified, remove-defunct-server will be run sequentially on the hosts in the topology file to remove the defunct server from the topology. The servers in the hosts file are tried one by one, and when the defunct server is removed using one of them, then the remaining servers are skipped. This option can make deployment automation more fault-tolerant since it is not necessary for a specific server instance to be available. Instead, the command will succeed as long as a single instance in the topology is online. The LDAP bind options specified on the command-line will be used for each server in the hosts file. The hosts file may be obtained by running the manage-topology export command on an online topology host using the hostname/port options |
| Required | No |
| Multi-Valued | No |
-j {bindPasswordFile}
--bindPasswordFile {bindPasswordFile}
| Description | Bind password file |
| Required | No |
| Multi-Valued | No |
--serverInstanceName {serverInstanceName}
| Description | The instance name of the server to remove |
| Required | No |
| Multi-Valued | No |
-n
--no-prompt
| Description | Use non-interactive mode. If data in the command is missing, you will not be prompted and the tool will fail |
-c
--continueOnError
| Description | Continue processing even if there are errors |
--ignoreOnline
| Description | Ignore that the server being removed is online. Generally, the remove-defunct-server tool should only be used to remove defunct or offline servers that are permanently unavailable. However, in cloud-native environments, where auto-scaling is an inherent feature of the platform, there may be a need to remove a server while it is still online. This flag is also useful in on-premise environments to remove a server from a topology without requiring to force a server as topology master, as long as the servers being removed are still accessible |
--retryTimeoutSeconds {retryTimeoutSeconds}
| Description | If the command fails, then it will continue to be retried up to this timeout specified in seconds. The command will not be aborted if the timeout has expired mid-execution, so it will be executed at least once. A value of zero (which is the default if this argument is not provided) indicates that the command does not have a timeout and so will not be retried upon initial failure. Note that this option is especially helpful in automated deployments where internal retries may significantly improve the chance of the command succeeding |
| Lower Bound | 0 |
| Upper Bound | 86400 |
| Default Value | 0 |
| Required | No |
| Multi-Valued | No |