gtm data-center-local
The gtm data-center-local command manages the settings of the local data center this TR7 device represents: the name of the data center, the addresses at which the other devices will reach this device, the scenario that determines the internet access state and the maintenance mode. Its panel equivalent is the The Local Data Center Settings section of the Remote Devices screen.
The definition of the remote sites is done with a separate command: gtm data-center-remote.
This record is single-object
The local data center is the device itself; it is not added and not deleted. For this reason there are only two actions in the command: show and update. The identifier is not asked for either.
Command Summary
Fields
There is no required field in the update command: only the fields to be changed are written, the others stay as they are.
| Field | Default | Value |
|---|---|---|
--name | — | The name of the local data center. It starts with a letter, contains letters, digits, an underscore and a hyphen, and is between 3 and 20 characters. It is seen in the checks and in the lists of the other devices in the <name>(local) form |
--access.0.namespace | The default route table of the device | The route table the access address belongs to |
--access.0.ip | — | One of the addresses defined in the selected route table; a free address cannot be written |
--access.0.port | — | The port to be opened to access |
--internetScenario | — | The scenario that determines the internet access state |
--maintenanceMode | false | It takes the device into the maintenance mode |
The Access Addresses
The access addresses are a list; every address is written with its own index and consists of three fields.
| Writing | Its meaning |
|---|---|
--access.0.namespace · --access.0.ip · --access.0.port | The first access address |
--access.1.namespace · --access.1.ip · --access.1.port | The second access address |
--access.delete | It empties the whole of the address list |
For every address, an automatic firewall rule that routes the incoming connections to the GTM access service is created; this rule appears among the automatic rules on the Firewall screen.
The Internet Health Scenario
The --internetScenario field determines whether the internet access of this device will be counted as present or not.
| Selection | Result |
|---|---|
Always | The internet access is always accepted as present |
Never | The internet access is accepted as absent |
| A health scenario | While the scenario is active the access is counted as present, and while it is passive as absent |
If a scenario is not selected the internet is counted as absent
When the field is left empty, the local data center falls into the No internet state and is announced to the other devices in this way. The scenarios are created with gtm scenario.
Examples
Things to Know
- It is selected from the list, it is not written freely. The
--access.N.ipfield lists the addresses defined in the selected route table; it is selected with Tab. - The maintenance mode does not change the routing on its own. For the records to be moved away from the data center that is in maintenance, the maintenance check has to be added as a condition to the health scenario the related records use.
- The settings are written as a whole. When the update runs, the automatic firewall rules are produced again.
- There is no delete command. Since the record represents the device itself, it cannot be removed; if it will not be used, its fields are emptied.
