Skip Headers
Oracle® Traffic Director Command-Line Reference
11g Release 1 (

Part Number E21037-03
Go to Documentation Home
Go to Book List
Book List
Go to Table of Contents
Go to Index
Go to Feedback page
Contact Us

Go to previous page
Go to next page
PDF · Mobi · ePub



create-failover-group common_options --config=config_name --virtual-ip=VIP
 [--network-prefix-length=number_of_bits] --primary-node=node [--force]
 --backup-node=node [--primary-nic=network_interface]
 [--backup-nic=network_interface] [--router-id=router_id]


Use this command to create a failover group consisting of two Oracle® Traffic Director instances grouped by a unique virtual IP address (VIP), to provide high availability in active-passive mode. Requests are received at the specified VIP address and routed to the Oracle® Traffic Director instance that is designated as the primary instance. If the primary instance is not reachable, requests are routed to the backup instance.

For active-active failover, you should create two failover groups, both consisting of the same two nodes, but with the primary and backup roles reversed. Each instance is the primary instance for one VIP address and the backup for the other VIP.

There can be a maximum of 255 failover groups, across configurations.

When creating a failover group, 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 the failover. If this command is not executed, failover will not start and there will be no high availability.

For more information about how failover works in Oracle Traffic Director, see the Oracle Traffic Director Administrator's Guide on OTN.


For information about common_options, run the help command.


The name of the configuration for which you want to create a failover group.


A unique virtual IP address (VIP) to identify the failover group.

The VIP can be a host name or an IPv4/IPv6 address. The VIP should belong to the same subnet as that of the nodes in the failover group, and must be accessible to clients.


The network prefix of the interface on which the VIP should be managed.

The network prefix is the subnet mask represented in the Classless Inter-Domain Routing (CIDR) format. For example, for an IPv4 VIP address in a subnet that contains 256 addresses (8 bits), the CIDR notation of the subnet mask would be 24, which is derived by deducting the number of addresses in the given subnet (8 bits) from the maximum number of IPv4 addresses possible (32 bits).

To calculate the CIDR notation of the subnet mask for an IPv6 subnet, deduct the bit-size of the subnet's address space from 128 bits, which is the maximum number of IPv6 addresses possible.

If you do not specify the network prefix, the default of 24 is assumed for an IPv4 VIP, and 64 for an IPv6 VIP.

--primary-node|-n, --backup-node|-b

The administration nodes that you want to specify as the primary and backup nodes in the failover group. Both the nodes should be in the same subnet and should be running as the root user. The nodes should not have an instance that is already part of another failover group. Note that the administration nodes that you select need not have Oracle® Traffic Director instances running on them.


Specify this option to force creation of the failover group even if a failover group already exists with the specified VIP. The existing failover group will be replaced.

--primary-nic|-m, --backup-nic|-k

The network interfaces, on the primary and back up node, on which the VIP must be managed. If you do not specify the network interfaces, Oracle® Traffic Director discovers them automatically.


The router ID for the failover group. The value should be unique across failover groups. If you do not specify the router ID, it is set to 255 for the first failover group. For every subsequent failover group that you create, the default router ID is decremented by one: 254, 253, and so on.


tadm create-failover-group --config=soa --virtual-ip=
tadm start-failover --user=admin 
--password-file=./admin.passwd --port=8989 
--no-prompt --config=soa --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.

See Also

help, delete-failover-group, get-failover-group-prop, set-failover-group-primary, list-failover-groups, start-failover, stop-failover