slb template monitor

Configure a link monitoring template.

Link Monitor Template Sequence Numbers

Each monitor template can contain the following types of entries:

  • Monitoring entries - A monitoring entry monitors for a specific event type (link up or link down) on a specific Ethernet data interface.
  • Action entries - An action entry specifies the action to take when monitored events are detected.

When you configure an entry of either type, you must specify a sequence number, 1-16. The sequence numbers assigned to

monitoring entries specify the order in which to check the monitored ports for the specified event type.

Likewise, the sequence number assigned to action entries specify the order in which to apply the actions.

The sequence number can be important in cases such as the following:

  • The order in which link state changes take place can affect whether traffic loops occur.
  • The template contains action entries that clear sessions and that disable or enable links. In this case, the sequence number controls whether the sessions are cleared before or after the link states are changed. Normally, it is recommended to clear the sessions first, before changing the link states.

The monitor with the lowest sequence number is performed first, then the monitor with the next lowest sequence number is performed, and so on. For example, monitor 1 is performed first, monitor 2 is performed second, and so on. Likewise, if the monitored events are detected, action 1 is performed first, then action 2, and so on.

Link Monitor Template Logical Operators

Each monitor template uses one of the following logical operators:

  • AND - The actions are performed only if all the monitored events are detected. (This is the default).
  • OR - The actions are preformed if any of the monitored events is detected.

The logical operator applies only to monitor entries, not to action entries. For example, if the logical operator is OR, and at least one of the monitored events occurs, all the actions configured in the template are applied.

You can configure the entries in any order. In the configuration, the entries of each type are ordered based on sequence number.

You can configure and activate up to 16 monitor templates. A monitor template does not take effect until you activate it.

monitor Specification

Type Collection
Object Key(s) id
Collection Name monitor-list
Collection URI /axapi/v3/slb/template/monitor/
Element Name monitor
Element URI /axapi/v3/slb/template/monitor/{id}
Element Attributes monitor_attributes
Schema monitor schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/slb/template/monitor/

monitor Attributes

Create List

POST

/axapi/v3/slb/template/monitor/

monitor Attributes

Get Object

GET

/axapi/v3/slb/template/monitor/{id}

monitor Attributes

Get List

GET

/axapi/v3/slb/template/monitor/

monitor-list

Modify Object

POST

/axapi/v3/slb/template/monitor/{id}

monitor Attributes

Replace Object

PUT

/axapi/v3/slb/template/monitor/{id}

monitor Attributes

Replace List

PUT

/axapi/v3/slb/template/monitor/

monitor-list

Delete Object

DELETE

/axapi/v3/slb/template/monitor/{id}

monitor Attributes

monitor-list

monitor-list is JSON List of monitor Attributes

monitor-list : [

monitor Attributes

clear-cfg

Description: clear-cfg is a JSON List . Please see below for clear-cfg

Type: List

id

Description: Identification number of the template. This can be a number between 1 and 16.

Type: number

Range: 1-16

Required: Yes

link-disable-cfg

Description: link-disable-cfg is a JSON List . Please see below for link-disable-cfg

Type: List

link-down-cfg

Description: link-down-cfg is a JSON List . Please see below for link-down-cfg

Type: List

link-enable-cfg

Description: link-enable-cfg is a JSON List . Please see below for link-enable-cfg

Type: List

link-up-cfg

Description: link-up-cfg is a JSON List . Please see below for link-up-cfg

Type: List

monitor-relation

Description: Specifies the comparison operator for the monitoring entries. You can configure the entries in any order. In the configuration, the entries of each type are ordered based on sequence number and are specific to monitor entries only. The following operators are used:

  • AND - The actions are performed only if all the monitored events are detected.
  • OR - The actions are performed if any of the monitored events is detected.

Type: string

Supported Values: monitor-and, monitor-or

Default: monitor-and

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

clear-cfg

Specification
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