system mon-template¶
Define an template monitor
mon-template Specification¶
Parameter
Value
Type
Intermediate Resource
Element Name
mon-template
Element URI
/axapi/v3/system/mon-template
Element Attributes
mon-template_attributes
Partition Visibility
shared
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Get Object | GET | /axapi/v3/system/mon-template | mon-template_attributes |
mon-template attributes¶
link-block-as-down
Description: link-block-as-down is a JSON Block. Please see below for link-block-as-down
Type: Object
Reference Object: /axapi/v3/system/mon-template/link-block-as-down
link-down-on-restart
Description: link-down-on-restart is a JSON Block. Please see below for link-down-on-restart
Type: Object
Reference Object: /axapi/v3/system/mon-template/link-down-on-restart
monitor-list
Type: List
Reference Object: /axapi/v3/system/mon-template/monitor/{id}
monitoring-mode
Description: monitoring-mode is a JSON Block. Please see below for monitoring-mode
Type: Object
Reference Object: /axapi/v3/system/mon-template/monitoring-mode
monitor-list¶
Specification
Value
Type
list
Block object keys
clear-cfg
Type: List
id
Description Monitor template ID Number
Type: number
Range: 1-16
link-disable-cfg
Type: List
link-down-cfg
Type: List
link-enable-cfg
Type: List
link-up-cfg
Type: List
monitor-relation
Description ‘monitor-and’: Configures the monitors in current template to work with AND logic; ‘monitor-or’: Configures the monitors in current template to work with OR logic;
Type: string
Supported Values: monitor-and, monitor-or
Default: monitor-and
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
monitor-list_clear-cfg¶
Specification
Value
Type
list
Block object keys
clear-all-partition
Description Partition name to clear
Type: string
Maximum Length: 14 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/partition
clear-all-partition-all
Description Clear all partitions
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
clear-all-sequence
Description Sequence number (Specify the port physical port number)
Type: number
Range: 1-16
clear-partition
Description Partition name to clear
Type: string
Maximum Length: 14 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/partition
clear-partition-all
Description Clear all partitions
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
clear-sequence
Description Specify the port physical port number
Type: number
Range: 1-16
sessions
Description ‘all’: Clear all sessions; ‘sequence’: Sequence number;
Type: string
Supported Values: all, sequence
monitor-list_link-disable-cfg¶
Specification
Value
Type
list
Block object keys
dis-sequence
Description Sequence number (Specify the sequence number)
Type: number
Range: 1-16
diseth
Description Specify the physical port number (Ethernet interface number)
Type: number
Format: interface
monitor-list_link-enable-cfg¶
Specification
Value
Type
list
Block object keys
ena-sequence
Description Sequence number (Specify the sequence number)
Type: number
Range: 1-16
enaeth
Description Specify the physical port number (Ethernet interface number)
Type: number
Format: interface
monitor-list_link-up-cfg¶
Specification
Value
Type
list
Block object keys
link-up-sequence1
Description Sequence number (Specify the sequence number)
Type: number
Range: 1-16
link-up-sequence2
Description Sequence number (Specify the sequence number)
Type: number
Range: 1-16
link-up-sequence3
Description Sequence number (Specify the sequece number)
Type: number
Range: 1-16
linkup-ethernet1
Description Specify the port physical port number (Ethernet interface number)
Type: number
Format: interface
linkup-ethernet2
Description Specify the port physical port number (Ethernet interface number)
Type: number
Format: interface
linkup-ethernet3
Description Specify the port physical port number (Ethernet interface number)
Type: number
Format: interface
monitor-list_link-down-cfg¶
Specification
Value
Type
list
Block object keys
link-down-sequence1
Description Sequence number (Specify the sequence number)
Type: number
Range: 1-16
link-down-sequence2
Description Sequence number (Specify the seqeuence number)
Type: number
Range: 1-16
link-down-sequence3
Description Sequence number (Specify the sequence number)
Type: number
Range: 1-16
linkdown-ethernet1
Description Specify the port physical port number (Ethernet interface number)
Type: number
Format: interface
linkdown-ethernet2
Description Specify the port physical port number (Ethernet interface number)
Type: number
Format: interface
linkdown-ethernet3
Description Specify the port physical port number (Ethernet interface number)
Type: number
Format: interface
link-block-as-down¶
Specification
Value
Type
object
enable
Description
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
link-down-on-restart¶
Specification
Value
Type
object
enable
Description
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
monitoring-mode¶
Specification
Value
Type
object
mmode
Description ‘interdependent’: INTERDEPENDENT monitoring behaviour, Default; ‘and’: AND monitoring behaviour;
Type: string
Supported Values: interdependent, and
Default: interdependent
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters