health monitor method icmp

ICMP type

icmp Specification

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

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/health/monitor/{name}/method/icmp

icmp Attributes

Get Object

GET

/axapi/v3/health/monitor/{name}/method/icmp

icmp Attributes

Modify Object

POST

/axapi/v3/health/monitor/{name}/method/icmp

icmp Attributes

Replace Object

PUT

/axapi/v3/health/monitor/{name}/method/icmp

icmp Attributes

Delete Object

DELETE

/axapi/v3/health/monitor/{name}/method/icmp

icmp Attributes

icmp Attributes

icmp

Description: Create an ICMP type health monitor.

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