Traffic target

NameTypeDescription
TrafficTargetObjectThis specifies where to direct data center traffic. For geographic mapped properties, it's always a cname. For mirror failover properties, it can be any set of servers. For load balanced properties, this is a set of servers that are all within the same data center. You can assign multiple traffic targets to the same data center.
datacenterIdIntegerA unique identifier for an existing data center in the domain.
enabledBooleanIndicates whether the traffic target is used. You can also omit the traffic target, which has the same result as the false value. However, when the value is false, GTM continues to store the other traffic target fields in the database. There's no need to store them locally should you want to use the traffic target at a later time.
handoutCNameStringSpecifies an optional data center for the property. Uses the handoutCName when there are no servers configured for the property. Maximum 63 characters for the labels, 255 characters overall. May contain alphanumeric, hyphens, and underscores, but not literal IP addresses. Leading or trailing hyphens aren't allowed.
nameStringAn alternative label for the traffic target.
precedenceNumberFrom v1.6. For use by ranked-failover type properties, the lower the number, the higher the precedence.
serversArrayIdentifies the IP address or the hostnames of the servers. For hostnames that return IP addresses, tests all IP addresses for liveness.
weightNumberSpecifies the traffic weight for the target. This is required when the enclosing property is failover, weighted, weighted-with-load-feedback, or performance. The sum of this value, for all enabled targets, can be any number, percentage, or ratio. For example, you can express a traffic split as 60/40, 120/80, or 3/2, all equivalent values. For failover properties, set this value to 1 for the traffic target you want to mark as primary.