gslb policy¶
Policy for GSLB zone, service or geo-location
policy Specification¶
Parameter Value Type Collection Object Key(s) name Collection Name policy-list Collection URI /axapi/v3/gslb/policy Element Name policy Element URI /axapi/v3/gslb/policy/{name} Element Attributes policy_attributes Partition Visibility shared Operational Data URI /axapi/v3/gslb/policy/{name}/oper Schema policy schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/gslb/policy | ||
Create List | POST | /axapi/v3/gslb/policy | ||
Get Object | GET | /axapi/v3/gslb/policy/{name} | ||
Get List | GET | /axapi/v3/gslb/policy | ||
Modify Object | POST | /axapi/v3/gslb/policy/{name} | ||
Replace Object | PUT | /axapi/v3/gslb/policy/{name} | ||
Replace List | PUT | /axapi/v3/gslb/policy | ||
Delete Object | DELETE | /axapi/v3/gslb/policy/{name} | ||
policy-list¶
policy-list is JSON List of policy attributes
policy-list : [
]
policy attributes¶
active-rdt
Description: active-rdt is a JSON Block. Please see below for active-rdt
Type: Object
Reference Object: /axapi/v3/gslb/policy/{name}/active-rdt
active-servers-enable
Description Enable Select Service-IP with the highest number of active servers
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
active-servers-fail-break
Description Break when no active server
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
admin-ip-enable
Description Enable admin ip
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
admin-ip-top-only
Description Return highest priority server only
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: admin-ip-top-only and ordered-ip-top-only are mutually exclusive
admin-preference
Description Select Service-IP for the device having maximum admin preference
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
alias-admin-preference
Description Select alias name having maximum admin preference
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
amount-first
Description Select record based on the amount of available service-ip
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
auto-map
Description: auto-map is a JSON Block. Please see below for auto-map
Type: Object
Reference Object: /axapi/v3/gslb/policy/{name}/auto-map
bw-cost-enable
Description Enable bw cost
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
bw-cost-fail-break
Description Break when exceed limit
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
capacity
Description: capacity is a JSON Block. Please see below for capacity
Type: Object
Reference Object: /axapi/v3/gslb/policy/{name}/capacity
connection-load
Description: connection-load is a JSON Block. Please see below for connection-load
Type: Object
Reference Object: /axapi/v3/gslb/policy/{name}/connection-load
dns
Description: dns is a JSON Block. Please see below for dns
Type: Object
Reference Object: /axapi/v3/gslb/policy/{name}/dns
edns
Description: edns is a JSON Block. Please see below for edns
Type: Object
Reference Object: /axapi/v3/gslb/policy/{name}/edns
geo-location-list
Type: List
Reference Object: /axapi/v3/gslb/policy/{name}/geo-location/{name}
geo-location-match
Description: geo-location-match is a JSON Block. Please see below for geo-location-match
Type: Object
Reference Object: /axapi/v3/gslb/policy/{name}/geo-location-match
geographic
Description Select Service-IP by geographic
Type: boolean
Supported Values: true, false, 1, 0
Default: 1
health-check
Description Select Service-IP by health status
Type: boolean
Supported Values: true, false, 1, 0
Default: 1
health-check-preference-enable
Description Check health preference
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
health-preference-top
Description Only keep top n
Type: number
Range: 1-128
ip-list
Description Specify IP List (IP List Name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/gslb/ip-list
least-response
Description Least response selection
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
metric-fail-break
Description Break if no valid Service-IP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
metric-force-check
Description Always check Service-IP for all enabled metrics
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
metric-order
Description Specify order of metric
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
metric-type
Description
Type: string
Format: enum-list
name
Description Specify policy name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Default: default
num-session-enable
Description Enable Select Service-IP for device having maximum number of available sessions
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
num-session-tolerance
Description The difference between the available sessions, default is 10 (Tolerance)
Type: number
Range: 0-100
Default: 10
ordered-ip-top-only
Description Return highest priority server only
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: ordered-ip-top-only and admin-ip-top-only are mutually exclusive
round-robin
Description Round robin selection, enabled by default
Type: boolean
Supported Values: true, false, 1, 0
Default: 1
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
weighted-alias
Description Select alias name by weighted preference
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
weighted-ip-enable
Description Enable Select Service-IP by weighted preference
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
weighted-ip-total-hits
Description Weighted by total hits
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
weighted-site-enable
Description Enable Select Service-IP by weighted site preference
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
weighted-site-total-hits
Description Weighted by total hits
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
auto-map¶
Specification Value Type object all
Description All modules
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: all and module-type are mutually exclusive
module-disable
Description Specify Disable Auto Map Module
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
module-type
Description
Type: string
Format: enum-list
Mutual Exclusion: module-type and all are mutually exclusive
ttl
Description Specify Auto Map TTL (TTL, default is 300)
Type: number
Range: 1-65535
Default: 300
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
edns¶
Specification Value Type object client-subnet-geographic
Description Use client subnet for geo-location
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
active-rdt¶
Specification Value Type object controller
Description Active round-delay-time by controller
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
difference
Description The difference between the round-delay-time, default is 0
Type: number
Range: 0-16383
Default: 0
enable
Description Enable the active rdt
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
fail-break
Description Break when no valid RDT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ignore-id
Description Ignore IP Address specified in IP List by ID
Type: number
Range: 0-31
keep-tracking
Description Keep tracking client even round-delay-time samples are ready
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
limit
Description Limit of allowed RDT, default is 16383 (Limit, unit: millisecond)
Type: number
Range: 1-16383
Default: 16383
proto-rdt-enable
Description Enable the round-delay-time to the controller
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
samples
Description Specify samples number for round-delay-time (Number of samples,default is 5)
Type: number
Range: 1-8
Default: 5
single-shot
Description Single Shot RDT
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
skip
Description Skip query if round-delay-time samples are not ready (Specify maximum skip count,default is 3)
Type: number
Range: 1-31
Default: 3
timeout
Description Specify timeout if round-delay-time samples are not ready (Specify timeout, unit:sec,default is 3)
Type: number
Range: 1-255
Default: 3
tolerance
Description The difference percentage between the round-delay-time, default is 10 (Tolerance)
Type: number
Range: 0-100
Default: 10
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
capacity¶
Specification Value Type object capacity-enable
Description Enable capacity
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
capacity-fail-break
Description Break when exceed threshold
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
threshold
Description Specify capacity threshold, default is 90
Type: number
Range: 0-100
Default: 90
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
geo-location-match¶
Specification Value Type object geo-type-overlap
Description ‘global’: Global Geo-location; ‘policy’: Policy Geo-location;
Type: string
Supported Values: global, policy
match-first
Description ‘global’: Global Geo-location; ‘policy’: Policy Geo-location;
Type: string
Supported Values: global, policy
Default: global
overlap
Description Enable overlap mode to do longest match
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
dns¶
Specification Value Type object action
Description Apply DNS action for service
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
action-type
Description ‘drop’: Drop query; ‘reject’: Send refuse response; ‘ignore’: Send empty response;
Type: string
Supported Values: drop, reject, ignore
active-only
Description Only keep active servers
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
active-only-fail-safe
Description Continue if no candidate
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
aging-time
Description Specify aging-time, default is TTL in DNS record, unit: second (Aging time, default 0 means using TTL in DNS record as aging time)
Type: number
Range: 0-1000000000
Default: 0
backup-alias
Description Return alias name when fail
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
backup-server
Description Return fallback server when fail
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
block-action
Description Specify Action
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
block-type
Description
Type: string
Format: enum-list
block-value
Type: Listcache
Description Cache DNS Server response
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
cname-detect
Description Apply GSLB for DNS Server response when service is Canonical Name (CNAME)
Type: boolean
Supported Values: true, false, 1, 0
Default: 1
delegation
Description Zone Delegation
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dns-addition-mx
Description Append MX Records in Addition Section
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dns-auto-map
Description Automatically build DNS Infrastructure
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dynamic-preference
Description Make dynamically change the preference
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dynamic-weight
Description dynamically change the weight
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
external-ip
Description Return DNS response with external IP address
Type: boolean
Supported Values: true, false, 1, 0
Default: 1
external-soa
Description Return DNS response with external SOA Record
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
geoloc-action
Description Apply DNS action by geo-location
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
geoloc-alias
Description Return alias name by geo-location
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
geoloc-policy
Description Apply different policy by geo-location
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
hint
Description ‘none’: None; ‘answer’: Append Hint Records in DNS Answer Section; ‘addition’: Append Hint Records in DNS Addition Section;
Type: string
Supported Values: none, answer, addition
Default: addition
ip-replace
Description Replace DNS Server Response with GSLB Service-IPs
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
ipv6
Type: Listlogging
Description ‘none’: None; ‘query’: DNS Query; ‘response’: DNS Response; ‘both’: Both DNS Query and Response;
Type: string
Supported Values: none, query, response, both
proxy-block-port-range-list
Type: Listselected-only
Description Only keep selected servers
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
selected-only-value
Description Answer Number
Type: number
Range: 1-128
server
Description Run GSLB as DNS server mode
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
server-addition-mx
Description Append MX Records in Addition Section
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
server-any
Description Provide All Records
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: server-any and server-any-with-metric are mutually exclusive
server-any-with-metric
Description Provide All Records with GSLB Metrics applied to A/AAAA Records
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: server-any-with-metric and server-any are mutually exclusive
server-authoritative
Description As authoritative server
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
server-auto-ns
Description Provide A-Records for NS-Records automatically
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
server-auto-ptr
Description Provide PTR Records automatically
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
server-cname
Description Provide CNAME Records
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
server-custom
Description Provide Custom Records
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
server-full-list
Description Append All A Records in Authoritative Section
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
server-mode-only
Description Only run GSLB as DNS server mode
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
server-mx
Description Provide MX Records
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
server-naptr
Description Provide NAPTR Records
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
server-ns
Description Provide NS Records
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
server-ns-list
Description Append All NS Records in Authoritative Section
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
server-ptr
Description Provide PTR Records
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
server-sec
Description Provide DNSSEC support
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
server-srv
Description Provide SRV Records
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
server-txt
Description Provide TXT Records
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
sticky
Description Make DNS Record sticky for certain time
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
sticky-aging-time
Description Specify aging-time, unit: min, default is 5 (Aging time)
Type: number
Range: 1-65535
Default: 5
sticky-ipv6-mask
Description Specify IPv6 mask length, default is 128
Type: number
Range: 1-128
Default: 128
sticky-mask
Description Specify IP mask, default is /32
Type: string
Format: ipv4-netmask-brief
Default: /32
template
Description Logging template (Logging Template Name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/logging
ttl
Description Specify the TTL value contained in DNS record (TTL value, unit: second, default is 10)
Type: number
Range: 0-1000000000
Default: 10
Mutual Exclusion: ttl and use-server-ttl are mutually exclusive
use-server-ttl
Description Use DNS Server Response TTL value in GSLB Proxy mode
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: use-server-ttl and ttl are mutually exclusive
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
dns_ipv6¶
Specification Value Type list Block object keys dns-ipv6-mapping-type
Description ‘addition’: Append Mapped Record in DNS Addition Section; ‘answer’: Append Mapped Record in DNS Answer Section; ‘exclusive’: Only return AAAA Record; ‘replace’: Replace Record with Mapped Record;
Type: string
Supported Values: addition, answer, exclusive, replace
dns-ipv6-option
Description ‘mix’: Return both AAAA Record and A Record; ‘smart’: Return AAAA Record by DNS Query Type; ‘mapping’: Map A Record to AAAA Record;
Type: string
Supported Values: mix, smart, mapping
dns_block-value¶
Specification Value Type list Block object keys block-value
Description Specify Type Number
Type: number
Range: 1-255
dns_proxy-block-port-range-list¶
Specification Value Type list Block object keys proxy-block-range-from
Description Specify Type Range (From)
Type: number
proxy-block-range-to
Description To
Type: number
geo-location-list¶
Specification Value Type list Block object keys ip-multiple-fields
Type: Listipv6-multiple-fields
Type: Listname
Description Specify geo-location name, section range is (1-15)
Type: string
Maximum Length: 127 characters
Maximum Length: 1 characters
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
geo-location-list_ip-multiple-fields¶
Specification Value Type list Block object keys ip-addr2-sub
Description Specify IP address range
Type: string
Format: ipv4-address
ip-mask-sub
Description Specify IP/mask format (Specify IP address mask)
Type: string
Format: ipv4-netmask-brief
ip-sub
Description Specify IP information
Type: string
Format: ipv4-address
geo-location-list_ipv6-multiple-fields¶
Specification Value Type list Block object keys ipv6-addr2-sub
Description Specify IPv6 address range
Type: string
Format: ipv6-address
ipv6-mask-sub
Description Specify IPv6/mask format (Specify IP address mask)
Type: number
Range: 0-128
ipv6-sub
Description Specify IPv6 information
Type: string
Format: ipv6-address
connection-load¶
Specification Value Type object connection-load-enable
Description Enable connection-load
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
connection-load-fail-break
Description Break when exceed limit
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
connection-load-interval
Description Interval between two samples, Unit: second (Interval value,default is 5)
Type: number
Range: 1-60
Default: 5
connection-load-limit
Description The value of the connection-load limit, default is unlimited
Type: number
Range: 1-999999999
connection-load-samples
Description Specify samples for connection-load (Number of samples used to calculate the connection load, default is 5)
Type: number
Range: 1-8
Default: 5
limit
Description Limit of maxinum connection load, default is unlimited
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters