5.3 Using the efm Utility

Table of Contents Previous Next


5 Controlling the Failover Manager Service : 5.3 Using the efm Utility

Failover Manager provides the efm utility to assist with cluster management.
efm add-node cluster_name ip_address [priority]
Invoke the efm add-node command to allow the specified node to join the cluster. Provide the name of the cluster, the IP address of the joining node, and (if the new node is a Standby server) the priority in which it will be promoted.
Include a priority value if the node being added is a standby node. The value specifies the order in which the new node will be used in the event of a failover. priority is an integer value of 1 to n, where n is the number of standby nodes in the list. Specify a value of 1 to indicate that the new node is the primary standby, and will be the first node promoted in the event of a failover.
Invoke the efm cluster-status command to display the status of a Failover Manager cluster. For more information about the cluster status report, see Section 4.8.1.
Invoke the efm cluster-status-json command to display the status of a Failover Manager cluster in json format. While the format of the displayed information is different than the display generated by the efm cluster-status command, the information source is the same.
efm encrypt cluster_name
Invoke the efm encrypt command to encrypt the database password before include the password in the cluster properties file.
efm prop-check cluster_name
The efm prop-check command invokes a utility that may help to identify configuration problems caused by mismatched property files.
When invoked on the Witness node with a cluster named employees, the prop-check command might display:
efm promote cluster_name
The promote command instructs Failover Manager to perform a manual failover of master to standby. This command must be invoked by efm or root.
efm remove-node cluster_name ip_address
Invoke the efm remove-node command to remove the specified node from the allowed hosts list, and prevent the node from joining a cluster. This command also removes the cluster from the failover priority list. Provide the name of the cluster and the IP address of the node when calling the efm remove-node command. This command must be invoked by efm or root.
efm resume cluster_name
Invoke the efm resume command to resume monitoring a previously stopped database. This command must be invoked by efm or root.
efm stop-cluster cluster_name
Invoke the efm stop-cluster command to stop Failover Manager on all nodes. This command instructs Failover Manager to connect to each node on the cluster and instruct the existing members to shut down. The command has no effect on running databases, but when the command completes, there is no failover protection in place. This command must be invoked by efm or root.
Invoke the efm --help command to display online help for the Failover Manager utility commands.

5 Controlling the Failover Manager Service : 5.3 Using the efm Utility

Table of Contents Previous Next