Smarter by Design.Simpler for Business
gtm express-profile
The gtm express-profile command manages the profiles that provide that the DNS records are pulled from an external master DNS server with a zone transfer instead of being written by hand on TR7. Its panel equivalent is the Express Profiles screen.
A profile does not run on its own: it is assigned to the data center group of a domain name, and the records of that group now come from the master.
Command Summary
admin@TR7LBWAF01> gtm express-profile list # list them all
admin@TR7LBWAF01> gtm express-profile show <id> # show one
admin@TR7LBWAF01> gtm express-profile add name <name> … # a new profile
admin@TR7LBWAF01> gtm express-profile update id <id> … # change
admin@TR7LBWAF01> gtm express-profile delete <id> # delete
admin@TR7LBWAF01>
Required Fields
| Order | Field | Status | Value |
|---|---|---|---|
| 1 | name | Required | The name of the profile; it is seen in the domain name form in the <name> (EXPRESS) form |
The master address is seen as optional in the completion list, but a profile that is not given an address cannot do a transfer.
Fields
| Field | Default | Value |
|---|---|---|
--masterAddresses.0.ip | — | The address of the master DNS server from which the zone transfer will be done; not a domain name, an IP address is written |
--masterAddresses.0.port | — | The port of the master server; in the panel a new row opens with 53 |
--identifier | Empty | The token pattern that selects the pulled records and converts their names |
--recordMgmtType | express | The record management type; it has a single value |
The addresses are tried in the order in the list and it is stopped at the first successful transfer; the addresses in the queue are used only when the previous ones have failed.
The Token Pattern
The --identifier field does not limit the transfer itself: the zone is always pulled in its entirety, the pattern is applied to the incoming records. One or more tokens separated with a comma are written; the tokens are applied in order and the evaluation ends at the first token that drops a record.
| Token | Effect |
|---|---|
dc1 | Only the records whose name is dc1 or that end with .dc1 are taken and the .dc1 suffix is removed from the name (www.dc1 → www). None of the records that do not match are taken |
!dc2 | The records whose name is dc2 or that end with .dc2 are not taken; the others pass with their names unchanged |
In a pattern that consists only of tokens starting with !, the records that are not excluded are taken with their names unchanged. When the field is left empty, all the records are taken as they are.
Feeding two data centers from the same zone
If there are www.dc1 and www.dc2 records in the master zone, dc1 is written to the profile of the first data center and dc2 to that of the second. Every center takes only its own record with the name www, and TR7 produces an answer for the same name on a data center basis.
Assigning the Profile to a Domain Name
The profile comes into play by being bound to the data center group of the domain name:
admin@TR7LBWAF01> gtm express-profile list # find the identifier of the profile
admin@TR7LBWAF01> gtm dns-domain update dnsId <service> id <domain> --defaultRecordConfig.0.recordMgmt <profile>
admin@TR7LBWAF01>
Examples
admin@TR7LBWAF01> gtm express-profile add name center-express \
--masterAddresses.0.ip 10.0.0.53 --masterAddresses.0.port 53
admin@TR7LBWAF01>
admin@TR7LBWAF01> gtm express-profile add name dc1-express \
--masterAddresses.0.ip 10.0.0.53 --masterAddresses.0.port 53 \
--masterAddresses.1.ip 10.0.1.53 --masterAddresses.1.port 53 \
--identifier dc1
admin@TR7LBWAF01>
# the records that end with dc2 are not taken, the others come with their names unchanged
admin@TR7LBWAF01> gtm express-profile update id <id> --identifier !dc2
admin@TR7LBWAF01>
Updating and Deleting
admin@TR7LBWAF01> gtm express-profile update id <id> --masterAddresses.0.ip 10.0.0.54
admin@TR7LBWAF01> gtm express-profile update id <id> --masterAddresses.delete # empty the address list
admin@TR7LBWAF01> gtm express-profile delete <id>
admin@TR7LBWAF01>
Things to Know
- It does not run without being assigned. As long as it is not bound to the data center group of a domain name, a transfer is not done.
- The records are managed from the master. In a group bound with express, the records are not added and edited by hand over TR7; the source is the master server.
- A domain name cannot be written as an address. The master server is defined only with an IP address.
- The pattern is separated with a comma. More than one token is written as a single value, without a space being put between them:
--identifier dc1,!dc2.
