health monitor method icmp

ICMP type

icmp Specification

Parameter	Value
Type	Configuration Resource
Element Name	icmp
Element URI	/axapi/v3/health/monitor/{name}/method/icmp
Element Attributes	icmp_attributes
Partition Visibility	shared
Schema	icmp schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/health/monitor/{name}/method/icmp	icmp attributes	example close
POST /axapi/v3/health/monitor/a/method/icmp Payload: { "icmp": { "icmp": 1, "transparent": 1, "ipv6": "2003::1" } }
Get Object	GET	/axapi/v3/health/monitor/{name}/method/icmp	icmp attributes	example close
GET /axapi/v3/health/monitor/a/method/icmp Reponse: { "icmp": { "icmp": 1, "transparent": 1, "ipv6": "2003::1", "uuid": "a4c39002-5eb7-11d9-aa3d-87d6468ef22c", "a10-url": "/axapi/v3/health/monitor/a/method/icmp" } }
Modify Object	POST	/axapi/v3/health/monitor/{name}/method/icmp	icmp attributes
Replace Object	PUT	/axapi/v3/health/monitor/{name}/method/icmp	icmp attributes	example close
PUT /axapi/v3/health/monitor/a/method/icmp Payload: { "icmp": { "icmp": 1, "transparent": 1, "ipv6": "2003::2" } }
Delete Object	DELETE	/axapi/v3/health/monitor/{name}/method/icmp	icmp attributes	example close
DELETE /axapi/v3/health/monitor/a/method/icmp Reponse: { "response": { "status": "OK" } }

icmp attributes

icmp

Description ICMP type

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

ip

Description Specify IPv4 address of destination behind monitored node

Type: string

Format: ipv4-address

Mutual Exclusion: ip and ipv6 are mutually exclusive

ipv6

Description Specify IPv6 address of destination behind monitored node

Type: string

Format: ipv6-address

Mutual Exclusion: ipv6 and ip are mutually exclusive

transparent

Description Apply transparent mode

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