addSLAMonitor
The addSLAMonitor operation handles configuration related to SLAMonitor model.
Description
This API call is not allowed on the standby unit in an HA pair.
Data Parameters
Parameter | Required | Type | Description | |||
---|---|---|---|---|---|---|
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) |
|||
type | True | string | An required enum that specifies the type of the SLA Monitor object. The only type is slamonitor |
Example
- name: Execute 'addSLAMonitor' operation
ftd_configuration:
operation: "addSLAMonitor"
data:
name: "{{ name }}"
description: "{{ description }}"
monitoredAddress: "{{ monitored_address }}"
targetInterface: "{{ target_interface }}"
slaOperation: "{{ sla_operation }}"
type: "{{ type }}"