system mon-template monitor¶
Monitor template
monitor Specification¶
Parameter Value Type Collection Object Key(s) id Collection Name monitor-list Collection URI /axapi/v3/system/mon-template/monitor Element Name monitor Element URI /axapi/v3/system/mon-template/monitor/{id} Element Attributes monitor_attributes Partition Visibility shared Schema monitor schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/system/mon-template/monitor | ||
Create List | POST | /axapi/v3/system/mon-template/monitor | ||
Get Object | GET | /axapi/v3/system/mon-template/monitor/{id} | ||
Get List | GET | /axapi/v3/system/mon-template/monitor | ||
Modify Object | POST | /axapi/v3/system/mon-template/monitor/{id} | ||
Replace Object | PUT | /axapi/v3/system/mon-template/monitor/{id} | ||
Replace List | PUT | /axapi/v3/system/mon-template/monitor | ||
Delete Object | DELETE | /axapi/v3/system/mon-template/monitor/{id} | ||
monitor-list¶
monitor-list is JSON List of monitor attributes
monitor-list : [
]
monitor attributes¶
clear-cfg
Type: Listid
Description Monitor template ID Number
Type: number
Range: 1-16
link-disable-cfg
Type: Listlink-down-cfg
Type: Listlink-enable-cfg
Type: Listlink-up-cfg
Type: Listmonitor-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
clear-cfg¶
Specification Value Type list Block object keys clear-all-sequence
Description Sequence number (Specify the port physical port number)
Type: number
Range: 1-16
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
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
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
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-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