health source-nat

Define Source NAT for health monitor

source-nat Specification

Parameter	Value
Type	Configuration Resource
Element Name	source-nat
Element URI	/axapi/v3/health/source-nat
Element Attributes	source-nat_attributes
Partition Visibility	shared
Statistics Data URI	/axapi/v3/health/source-nat/stats
Schema	source-nat schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/health/source-nat	source-nat attributes	example close
POST /axapi/v3/health/source-nat Payload: { "source-nat": { "source-nat-pool": "a" } }
Get Object	GET	/axapi/v3/health/source-nat	source-nat attributes	example close
GET /axapi/v3/health/source-nat Reponse: { "source-nat": { "source-nat-pool": "a", "smart-nat-precedence": 0, "enable-vrrp-a-mode": 0, "uuid": "9f2ff5ee-091a-11f0-b37c-7dd5c2404b7e", "a10-url": "/axapi/v3/health/source-nat" } }
Modify Object	POST	/axapi/v3/health/source-nat	source-nat attributes
Replace Object	PUT	/axapi/v3/health/source-nat	source-nat attributes	example close
PUT /axapi/v3/health/source-nat Payload: { "source-nat": { "source-nat-pool": "abcd" } }
Delete Object	DELETE	/axapi/v3/health/source-nat	source-nat attributes	example close
DELETE /axapi/v3/health/source-nat Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

source-nat attributes

enable-vrrp-a-mode

Description Forward health check by active device only

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ethernet

Description Ethernet interface number

Type: number

Format: interface

interface

Description ‘ethernet’: ethernet; ‘trunk’: trunk; ‘ve’: ve;

Type: string

Supported Values: ethernet, trunk, ve

sampling-enable

Type: List

smart-nat-precedence

Description Use smart nat when resourece is presented in virtual port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

smart-nat-vrid

Description Smart nat VRID

Type: number

Range: 1-31

source-nat-pool

Description Use source nat for all health check (nat pool)

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/ip/nat/pool

source-nat-pool-v6

Description Use ipv6 source nat for all health check (nat pool)

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/ipv6/nat/pool

trunk

Description Trunk interface number

Type: number

Range: 1-4096

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ve

Description Virtual ethernet interface number

Type: number

Range: 2-4094

sampling-enable

Specification	Value
Type	list
Block object keys

counters1

Description ‘all’: all; ‘act_recv_from_sby’: Packets received from standby; ‘act_send_to_sby’: Packets sent to standby; ‘sby_recv_from_act’: Packets received from active; ‘sby_send_to_act’: Packets sent to active; ‘sby_recv_from_act_err’: Packets received from active error; ‘recv_from_kernel’: Packets received from kernel; ‘send_to_kernel’: Packets sent to kernel; ‘send_to_kernel_err’: Packets sent to kernel error; ‘sby_no_peer’: Peer not found on standby; ‘dcmsg_err’: DCMSG error; ‘no_slb_object’: SLB object not found; ‘smart_nat_init_port_err’: Smart NAT port initialization error; ‘smart_nat_init_inst_err’: Smart NAT instance initialization error; ‘smart_nat_rserver_route_err’: Smart NAT rserver route update error; ‘smart_nat_rserver_ip_err’: Smart NAT rserver ip update error; ‘nat_resource_err’: NAT resource error;

Type: string

Supported Values: all, act_recv_from_sby, act_send_to_sby, sby_recv_from_act, sby_send_to_act, sby_recv_from_act_err, recv_from_kernel, send_to_kernel, send_to_kernel_err, sby_no_peer, dcmsg_err, no_slb_object, smart_nat_init_port_err, smart_nat_init_inst_err, smart_nat_rserver_route_err, smart_nat_rserver_ip_err, nat_resource_err, frag_err