gtm data-center-remote

The gtm data-center-remote command defines the remote data centers GTM takes into account while distributing traffic: the access addresses, how frequently they will be queried and the number of consecutive results needed for them to count as healthy or unhealthy. Its panel equivalent is the Remote Devices screen.

The own data center of this device is managed with a separate command: gtm data-center-local.

Command Summary

TR7 WEB-CLI · gtm data-center-remote

admin@TR7LBWAF01> gtm data-center-remote list # list them all

admin@TR7LBWAF01> gtm data-center-remote show <id> # show one

admin@TR7LBWAF01> gtm data-center-remote add name <name> … # a new record

admin@TR7LBWAF01> gtm data-center-remote update id <id> … # change

admin@TR7LBWAF01> gtm data-center-remote delete <id> # delete

admin@TR7LBWAF01>  

Required Fields

Order	Field	Status	Value
1	name	Required	The name of the data center. It starts with a letter, contains letters, digits, an underscore and a hyphen, and is between 3 and 20 characters

There is no other required field; the access addresses and the thresholds are optional. However, a data center that is not given an address cannot be queried.

The Access Addresses

There are two separate lists: the access over the wide area network (wanAccess) and the access over the local network (lanAccess). The fields of the two are the same and every address is written with its own index.

Field	Default	Value
--wanAccess.0.ip · --lanAccess.0.ip	—	The access address of the remote device
--wanAccess.0.port · --lanAccess.0.port	—	The access port
--wanAccess.0.v-device · --lanAccess.0.v-device	Host device	From which virtual device the query will be made
--wanAccess.0.namespace · --lanAccess.0.namespace	The default route table of the device	From which route table the query will be made

• When more than one address is defined in a list, the addresses are tried in order; the first address that answers is enough for that access.
• The address and the port are written together; a line in which only one of them is given returns an error.
• The WAN and LAN lists are tried separately in every cycle.
• --wanAccess.delete and --lanAccess.delete empty the whole of the related list.

The Query Frequency and the Thresholds

Field	Default	Value
--accessPeriod.val · --accessPeriod.unit	5 minutes	How frequently the remote data center will be queried; the unit is s, m or h
--requiredSuccess	2	The number of consecutive successful queries needed to pass to healthy; between 1 and 100
--requiredFailure	3	The number of consecutive failed queries needed to pass to unhealthy; between 1 and 100

The thresholds affect only the state of the automatic health checks; the status indicator in the list reflects the result of every query instantly.

Examples

TR7 WEB-CLI · A) A remote center with WAN access

admin@TR7LBWAF01> gtm data-center-remote add name ankara-dc \

--wanAccess.0.ip 203.0.113.10 --wanAccess.0.port 8443

admin@TR7LBWAF01>  

TR7 WEB-CLI · B) Two WAN addresses, one LAN address and tight thresholds

admin@TR7LBWAF01> gtm data-center-remote add name izmir-dc \

--wanAccess.0.ip 203.0.113.20 --wanAccess.0.port 8443 \

--wanAccess.1.ip 198.51.100.20 --wanAccess.1.port 8443 \

--lanAccess.0.ip 10.20.0.20 --lanAccess.0.port 8443 \

--accessPeriod.val 30 --accessPeriod.unit s --requiredFailure 2

admin@TR7LBWAF01>  

TR7 WEB-CLI · C) Changing and deleting an address

admin@TR7LBWAF01> gtm data-center-remote update id <id> --wanAccess.0.ip 203.0.113.30

admin@TR7LBWAF01> gtm data-center-remote update id <id> --lanAccess.delete # empty the LAN list

admin@TR7LBWAF01> gtm data-center-remote delete <id>

admin@TR7LBWAF01>  

Things to Know

• The automatic checks are created together with the adding. The health checks for the new data center are produced by themselves and appear in the automatic checks list on the Health Checks screen.
• The first query starts right away. Until the result comes, the state of the data center is seen as unknown.
• In a cluster setup the definition is reflected on the peer device too. Every device queries the data center itself.
• A center that is not given an address cannot be queried. At least one WAN or LAN address has to be defined.
• The duration field is in two parts. The query frequency is written with --accessPeriod.val and --accessPeriod.unit.