start-failover

Syntax

start-failover common_options --config=config_name --instance-home=instance_home

Description

If the administration node process is running as non-root on the node where the instances are located, then you must run start-failover on those nodes as a root user. This is to manually start or restart a failover in the following cases:

  • While creating a failover group and if the instances for that failover group were running.

  • While deleting a failover group and if the instances for that failover group were running.

  • After toggling the primary and backup nodes in a failover group.

    Note:

    start-failover must be executed on the node as a root user.

Options

For information about common_options, run the help command.

--config|-c

Specify the name of the configuration for which you want to start failover.

--instance-home|-i

Indicates the location where the server instances can be found.

Example

tadm start-failover --user=admin 
--password-file=./admin.passwd --host=admin.example.com --port=8989 
--no-prompt --config=www.example.org --instance-home=/home/otd

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.