dcConfigUtility script

You can use the dcConfigUtility.sh script to configure the data center.

Usage

The utility is a shell script that calls a Java™ program, which in turn calls the Mailbox Datacenter Service API. You must run the script from the installation directory of your Global Mailbox node. The utility prompts you for a Global Mailbox administrator ID and password. Authenticate with the ID and password, and specify the required action. For example, to add a data center, do the following:
dcConfigUtility add
  --dcname=<datacenter name>
  --P<propertyname>=<propertyvalue>
  --output=<path to file>

File location

install_dir/MailboxUtilities/admin/bin

Environments

Linux® or UNIX (dcConfigUtility.sh)

Authorization

You must be a Global Mailbox administrator to view and modify the configuration with the dcConfigUtility script.

To use this script, you must provide your Global Mailbox administrator user ID and password.

Syntax

dcConfigUtility action --parameter=value

Options description

The following are the actions and options supported by the dcConfigUtility script:

adminUser=<user name>
Global Mailbox administrator user ID
adminPassword=<password>
Global Mailbox administrator password
add
Adds a data center to the Cassandra table. To establish a connection with another data center, you must first add the data center to the Cassandra table. Specify the following parameters to add a data center:
  • dcName - Name of the data center to be added.
  • P - Properties for the data center.
  • output - If an output file is specified, it contains the ID of the data center in the form, com.ibm.mailbox.datacenter.id = <guuid>
Following is an example for add:
dcConfigUtility add
  --dcname=<datacenter name>
  --P<propertyname>=<propertyvalue>
  --output=<path to file>
remove
Removes a data center from the Cassandra table. The data center is not available for any transactions. To update a data center configuration, you must remove the data center and then add it again. Specify the following parameter to remove a data center:
  • dcName - Name of the data center to be removed.
The following code is an example for remove:
dcConfigUtility remove
  --dcname=<datacenter name>
resume
Resumes a data center in the system and sets it to operational status. It also resumes all associated servers and sets the servers to online status. Specify the following parameter to resume a data center:
  • dcName - Name of the data center to be resumed.
Following is an example for resume:
dcConfigUtility resume
  --dcname=<datacenter name>
suspend
Suspends a data center in the system and sets it to non-operational status. It also suspends all associated servers and sets the servers to offline status. Specify the following parameter to suspend a data center:
  • dcName - Name of the data center to be suspended.
Following is an example for suspend:
dcConfigUtility suspend
  --dcname=<datacenter name>
showAllStatus
Lists the names and status of all the data centers in the system. Following is an example for showAllStatus:
dcConfigUtility showAllStatus
showConfig
Displays the configuration of a data center. The configuration includes the data center name, status (operational or non-operational), and details of the servers associated with the data center. The server details include the host name, TCP port, UDP port, encryption (enabled or disabled), and status (online or offline). Specify the following parameter to display the configuration of a data center:
  • dcName - Name of the data center to display the configuration for.
Following is an example for showConfig:
dcConfigUtility showConfig
  --dcname=<datacenter name>
addServer (V5.2.6.2 or later)
Adds a replication server in the data center. Specify the following parameters to add a replication server:
  • dcName - Name of the data center where the replication server is to be added.
  • hostNmae - The host name of the replication server.
  • tcpPort - The TCP port number of the replication server.
  • udpPort - The UDP port number of the replication server.
Following is an example for addServer:
dcConfigUtility addServer
 --dcName=<datacenter name>
 --hostName=<host name of the replication server>
 --tcpPort=<TCP port number of the replication server>
 --udpPort=<UDP port number of the replication server>
Note: A replication server must be added before upgrading Global Mailbox.
updateServer (V5.2.6.2 or later)
Updates the replication server configuration. Specify the following parameters to update a replication server:
  • dcName - Name of the data center where the replication server is to be updated.
  • hostName - The host name of the replication server.
The following is an example for updateServer:
dcConfigUtility updateServer
  --dcname=<datacenter name>
  --hostname=<the host name of the replication server>
removeServer (V5.2.6.2 or later)
Removes the replication server from the data center. Specify the following parameters to remove a replication server:
  • dcName - Name of the data center where the replication server is to be removed from.
  • hostName - The host name of the replication server.
The following is an example for removeServer:
dcConfigUtility removeServer
  --dcname=<datacenter name>
  --hostname=<the host name of the replication server>
resumeServer (V5.2.6.2 or later)
Resumes a replication server in the data center and sets it to online status. If a data center is non-operational, and if this the first and only replication server in the data center to be brought online, then the corresponding data center is also set to operational. Specify the following parameters to resume a replication server:
  • dcName - Name of the data center where the replication server is to be resumed.
  • hostName - The host name of the replication server.
Following is an example for resumeServer:
dcConfigUtility resumeServer
  --dcname=<datacenter name>
  --hostname=<the host name of the replication server>
suspendServer (V5.2.6.2 or later)
Suspends a replication server in the data center and sets it to offline status. If this is the last or the only replication server in the data center to be taken offline, the corresponding data center is also set to non-operational status. Specify the following parameters to suspend a replication server:
  • dcName - Name of the data center where the replication server is to be suspended.
  • hostName - The host name of the replication server.
Following is an example for suspendServer:
dcConfigUtility suspendServer
  --dcname=<datacenter name>
  --hostname=<the host name of the replication server>
Tip: Suspended replication servers are not used for replication, until they are made active again. You can suspend replication servers when bringing a data center down for maintenance. The following table provides the parameter for each intended result:
For the following result Use the following parameter
Pause a data center from the Cassandra table suspend
Suspend a replication server suspendServer
testConnection (V5.2.6.2 or later)
Tests the connection status of a replication server in the data center. Specify the following parameters to test the connection of a replication server:
  • dcName - Name of the data center where the replication server is added.
  • hostName - The host name of the replication server.
Following is an example for testConnection:
dcConfigUtility testConnection
  --dcname=<datacenter name>
  --hostname=<the host name of the replication server>