SLAMonitor
Description
An object that defines the service level agreement (SLA) monitor for a static route. When you use an SLA monitor on a route, the system periodically checks whether the monitored address is reachable, and installs a backup route if the address becomes unreachable. The system uses ICMP echo request (ping) packets to determine reachability. (Note: The field level constraints listed here might not cover all the constraints on the field. Additional constraints might exist.)
Supported Operations
Model Properties
Property | Required | Type | Description | |||
---|---|---|---|---|---|---|
version | False | string | A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected. | |||
name | True | string | The name of the SLA Monitor. | |||
description | False | string | An optional description of the SLA Monitor object Field level constraints: length must be between 0 and 200 (inclusive). (Note: Additional constraints might exist) |
|||
monitoredAddress | True | object | The IP address to be monitored to determine if the route is functional. The address is typically the gateway address for the route, but it can be another always-on server on that network, such as a syslog or AAA server. Field level constraints: cannot be null. (Note: Additional constraints might exist) Allowed types are: [NetworkObject] |
|||
targetInterface | True | object | The name of the interface through which to send the echo request packets. The interface source address is used as the source address in the echo request packets. Field level constraints: cannot be null. (Note: Additional constraints might exist) Allowed types are: [EtherChannelInterface, PhysicalInterface, SubInterface, VirtualTunnelInterface, VlanInterface] |
|||
slaOperation | True | object | A collection of the attribute-value pairs for an IpIcmpEcho object, which defines the operational properties for this SLA Monitor. Field level constraints: cannot be null. (Note: Additional constraints might exist) |
|||
id | False | string | The ID of the SLA Monitor. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist) |
|||
type | True | string | An required enum that specifies the type of the SLA Monitor object. The only type is slamonitor |