cgnv6 one-to-one¶
Set one-to-one NAT parameters
one-to-one Specification¶
Type Intermediate Resource Element Name one-to-one Element URI /axapi/v3/cgnv6/one-to-one Element Attributes one-to-one_attributes Schema one-to-one schema
Operations Allowed:
Operation | Method | URI | Payload | |
---|---|---|---|---|
Get Object | GET | /axapi/v3/cgnv6/one-to-one | one-to-one_attributes |
one-to-one attributes¶
global
Description: global is a JSON Block. Please see below for global
Type: Object
Reference Object: /axapi/v3/cgnv6/one-to-one/global
mapping
Description: mapping is a JSON Block. Please see below for mapping
Type: Object
Reference Object: /axapi/v3/cgnv6/one-to-one/mapping
pool-group-list
Type: List
Reference Object: /axapi/v3/cgnv6/one-to-one/pool-group/{pool-group-name}
pool-list
Type: List
Reference Object: /axapi/v3/cgnv6/one-to-one/pool/{pool-name}
shared-pool
Description: shared-pool is a JSON Block. Please see below for shared-pool
Type: Object
Reference Object: /axapi/v3/cgnv6/one-to-one/shared-pool
shared-pool-group
Description: shared-pool-group is a JSON Block. Please see below for shared-pool-group
Type: Object
Reference Object: /axapi/v3/cgnv6/one-to-one/shared-pool-group
pool-group-list¶
Specification Type list Block object keys member-list
Type: List
Reference Object: /axapi/v3/cgnv6/one-to-one/pool-group/{pool-group-name}/member/{pool-name}
pool-group-name
Description Specify pool group name
Type: string
Format: string-rlx
Maximum Length: 63 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
vrid
Description Specify VRRP-A vrid
Type: number
Range: 1-31
pool-group-list_member-list¶
Specification Type list Block object keys pool-name
Description Specify CGNv6 one-to-one pool name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
global¶
Specification Type object mapping-timeout
Description Configure timeout for the one-to-one NAT mapping (Timeout in minutes (default: 10 minutes))
Type: number
Range: 0-180
Default: 10
sampling-enable
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
global_sampling-enable¶
Specification Type list Block object keys counters1
Description ‘all’: all; ‘total-map-allocated’: Total One-to-One Address Mapping Allocated; ‘total-map-freed’: Total One-to-One Address Mapping Freed; ‘map-alloc-failure’: One-to-One Address Mapping Allocation Failure; ‘map-dbl-free’: Address Mapping Double Free; ‘alloc-map-race’: Mapping Exists When Allocating Address Mapping; ‘map-not-found’: Mapping to be Released Not Found; ‘ha-map-mismatch’: HA Standby Mapping Mismatch; ‘ha-select-addr-failure’: HA Standby Allocate Address Failure; ‘ha-alloc-map-conflicts’: HA Standby Allocate Mapping Conflicts;
Type: string
Supported Values: all, total-map-allocated, total-map-freed, map-alloc-failure, map-dbl-free, alloc-map-race, map-not-found, ha-map-mismatch, ha-select-addr-failure, ha-alloc-map-conflicts
mapping¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
pool-list¶
Specification Type list Block object keys end-address
Description Configure end IP address of NAT pool
Type: string
Format: ipv4-address
group
Description Share with a partition group (Partition Group Name)
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
netmask
Description Configure mask for pool
Type: string
Format: ipv4-netmask-brief
partition
Description Share with a single partition (Partition Name)
Type: string
Maximum Length: 14 characters
Maximum Length: 1 characters
pool-name
Description Specify pool name or pool group
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
shared
Description Share this pool with other partitions (default: not shared)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
start-address
Description Configure start IP address of NAT pool
Type: string
Format: ipv4-address
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
vrid
Description Configure VRRP-A vrid (Specify ha VRRP-A vrid)
Type: number
Range: 1-31