If set to No, the traffic IP group will be disabled and none of the traffic IP addresses will be raised.

Value type: Yes / No

Default value: "Yes"

Whether or not the source port should be taken into account when deciding which traffic manager should handle a request.

Requires: mode is set to "multihosted"

Value type: Yes / No

Default value: "No"

Configure how traffic IPs are assigned to traffic managers in Single-Hosted mode

Value type: enumeration

Default value: "balanced"

Permitted values:

alphabetic: Alphabetical order of traffic manager hostnames

balanced: Approximately balanced between traffic managers

Assigns a traffic IP address to a specific traffic manager, while the traffic manager is operating correctly it will host the address. The IP address must be one from the ipaddresses list and takes the place of the * in the key name, the key value is the name of the traffic manager that should host the IP address. If this is not specified for an IP address the address is automatically assigned to a machine.

Value type: string

Default value: <none>

The IP addresses that belong to the Traffic IP group.

Value type: list

Default value: <none>

If set to Yes then all the traffic IPs will be raised on a single traffic manager. By default they're distributed across all active traffic managers in the traffic IP group.

Value type: Yes / No

Default value: "No"

The location in which the Traffic IP group is based.

Value type: int

Default value: "0"

The traffic managers that can host the traffic IP group's IP addresses.

Value type: list

Default value: <none>

The method used to distribute traffic IPs across machines in the cluster. If "multihosted" is used then multicast must be set to an appropriate multicast IP address.

Value type: enumeration

Default value: "singlehosted"

Permitted values:

singlehosted: Raise each address on a single machine (Single-Hosted mode)

multihosted: Raise each address on every machine in the group (Multi-Hosted mode) - IPv4 only

rhi: Use route health injection to route traffic to the active machine - IPv4 only

ec2elastic: Use an EC2-Classic Elastic IP address.

ec2vpcelastic: Use an EC2-VPC Elastic IP address.

ec2vpcprivate: Use an EC2-VPC Private IP address.

gceexternal: Use GCE External IP addresses.

The multicast IP address used to duplicate traffic to all traffic managers in the group.

Requires: mode is set to "multihosted"

Value type: string

Default value: <none>

A note, used to describe this Traffic IP Group

Value type: string

Default value: <none>

The base BGP routing metric for this Traffic IP group. This is the advertised routing cost for the active traffic manager in the cluster. It can be used to set up inter-cluster failover.

Requires: mode is set to "rhi"

Value type: unsigned integer

Default value: "10"

The BGP routing metric offset for this Traffic IP group. This is the difference between the advertised routing cost for the active and passive traffic manager in the cluster.

Requires: mode is set to "rhi"

Value type: unsigned integer

Default value: "10"

The base OSPFv2 routing metric for this Traffic IP group. This is the advertised routing cost for the active traffic manager in the cluster. It can be used to set up inter-cluster failover.

Requires: mode is set to "rhi"

Value type: unsigned integer

Default value: "10"

The OSPFv2 routing metric offset for this Traffic IP group. This is the difference between the advertised routing cost for the active and passive traffic manager in the cluster.

Requires: mode is set to "rhi"

Value type: unsigned integer

Default value: "10"

A list of protocols to be used for RHI. Currently must be 'ospf' or 'bgp' or both. The default, if empty, is 'ospf', which means that it is not possible to specify no protocol.

Requires: mode is set to "rhi"

Value type: string

Default value: "ospf"