aci_ip_sla_monitoring_policy
Manage IP SLA Monitoring Policies (fv:IPSLAMonitoringPol)
Collection: cisco.aci
Full Name: cisco.aci.aci_ip_sla_monitoring_policy
Synopsis
Manage IP SLA Monitoring Policies (fv:IPSLAMonitoringPol)
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| annotation | string | orchestrator:ansible | User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable C(ACI_ANNOTATION) will be used instead. If the value is not specified in the task and environment variable C(ACI_ANNOTATION) then the default value will be used. | |
| certificate_name | string | The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a C(private_key) filename was provided, this defaults to the C(private_key) basename, without extension. If PEM-formatted content was provided for C(private_key), this defaults to the C(username) value. If the value is not specified in the task, the value of environment variable C(ACI_CERTIFICATE_NAME) will be used instead. | ||
| description | string | The SLA Policy description. | ||
| frequency | int | Defines the interval at which probes are conducted. The APIC defaults to C(60) when unset during creation. Permitted values are in the range of [1, 300]. | ||
| host | string | IP Address or hostname of APIC resolvable by Ansible control host. If the value is not specified in the task, the value of environment variable C(ACI_HOST) will be used instead. | ||
| http_uri | string | The HTTP URI to use as the SLA destination. The APIC defaults to C(/) when unset during creation. This is only supported in APIC v5.0 and above. | ||
| http_version | string | The HTTP version to use. The APIC defaults to C(1.0) when unset during creation. This is only supported in APIC v5.0 and above. | ||
| multiplier | int | Specifies the number of consecutive probe failures required to determine the SLA as down. The APIC defaults to C(3) when unset during creation. Permitted values are in the range of [1, 100]. | ||
| name | string | The SLA Policy name. | ||
| operation_timeout | int | The amount of time in milliseconds that the IP SLA operation waits for a response from its request packet. The APIC defaults to C(900) when unset during creation. Permitted values are in the range of [0, 604800000]. This is only supported in APIC v5.1 and above. | ||
| output_level | string | normal | Influence the output of this ACI module. C(normal) means the standard output, incl. C(current) dict C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts C(debug) adds debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information If the value is not specified in the task, the value of environment variable C(ACI_OUTPUT_LEVEL) will be used instead. | |
| output_path | string | Path to a file that will be used to dump the ACI JSON configuration objects generated by the module. If the value is not specified in the task, the value of environment variable C(ACI_OUTPUT_PATH) will be used instead. | ||
| owner_key | string | User-defined string for the ownerKey attribute of an ACI object. This attribute represents a key for enabling clients to own their data for entity correlation. If the value is not specified in the task, the value of environment variable C(ACI_OWNER_KEY) will be used instead. | ||
| owner_tag | string | User-defined string for the ownerTag attribute of an ACI object. This attribute represents a tag for enabling clients to add their own data. For example, to indicate who created this object. If the value is not specified in the task, the value of environment variable C(ACI_OWNER_TAG) will be used instead. | ||
| password | string | The password to use for authentication. This option is mutual exclusive with C(private_key). If C(private_key) is provided too, it will be used instead. If the value is not specified in the task, the value of environment variables C(ACI_PASSWORD) or C(ANSIBLE_NET_PASSWORD) will be used instead. | ||
| port | int | Port number to be used for REST connection. The default value depends on parameter C(use_ssl). If the value is not specified in the task, the value of environment variable C(ACI_PORT) will be used instead. | ||
| private_key | string | Either a PEM-formatted private key file or the private key content used for signature-based authentication. This value also influences the default C(certificate_name) that is used. This option is mutual exclusive with C(password). If C(password) is provided too, it will be ignored. If the value is not specified in the task, the value of environment variable C(ACI_PRIVATE_KEY) or C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. | ||
| request_data_size | int | The number of bytes to send in the request. Only used if I(sla_type=http). The APIC defaults to C(28) when unset during creation. Permitted values are in the range of [0, 17512] This is only supported in APIC v5.1 and above. | ||
| sla_port | int | The Port to monitor for TCP SLAs. Permitted values are in the range of [1, 65535]. | ||
| sla_type | string | The type of monitoring. The APIC defaults to C(icmp) when unset during creation. I(sla_type=http) is only supported in APIC v5.0 and above. | ||
| state | string | present | Use C(present) or C(absent) for adding or removing. Use C(query) for listing an object or multiple objects. | |
| suppress_previous | bool | If C(true), a GET to check previous will not be sent before a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_PREVIOUS) will be used instead. The default value is C(false). WARNING - This causes the previous return value to be empty. The previous state of the object will not be checked and the POST update will contain all properties. | ||
| suppress_verification | bool | If C(true), a verifying GET will not be sent after a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_VERIFICATION) will be used instead. The default value is C(false). WARNING - This causes the current return value to be set to the proposed value. The current object including default values will be unverifiable in a single task. | ||
| tenant | string | The name of an existing tenant. | ||
| threshold | int | The upper threshold value in milliseconds for calculating network monitoring statistics created by the IP SLA operation. The value specified for this property must not exceed the value specified for I(operation_timeout). The APIC defaults to C(900) when unset during creation. Permitted values are in the range of [0, 604800000]. This is only supported in APIC v5.1 and above. | ||
| timeout | int | The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable C(ACI_TIMEOUT) will be used instead. The default value is 30. | ||
| traffic_class | int | Sets the Traffic Class value in the IPv6 header. The APIC defaults to C(0) when unset during creation. Permitted values are in the range of [0, 255]. This is only supported in APIC v5.1 and above. | ||
| type_of_service | int | The Type of Service (ToS) value to set in the IPv4 header. The APIC defaults to C(0) when unset during creation. Permitted values are in the range of [0, 255]. This is only supported in APIC v5.1 and above. | ||
| use_proxy | bool | If C(false), it will not use a proxy, even if one is defined in an environment variable on the target hosts. If the value is not specified in the task, the value of environment variable C(ACI_USE_PROXY) will be used instead. The default value is true. | ||
| use_ssl | bool | If C(false), an HTTP connection will be used instead of the default HTTPS connection. If the value is not specified in the task, the value of environment variable C(ACI_USE_SSL) will be used instead. The default value is true when the connection is local. | ||
| username | string | The username to use for authentication. If the value is not specified in the task, the value of environment variables C(ACI_USERNAME) or C(ANSIBLE_NET_USERNAME) will be used instead. The default value is admin. | ||
| validate_certs | bool | If C(false), SSL certificates will not be validated. This should only set to C(false) when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable C(ACI_VALIDATE_CERTS) will be used instead. The default value is true. |
Example
yaml
- {"cisco.aci.aci_ip_sla_monitoring_policy": {"frequency": 40, "host": "apic", "multiplier": 6, "name": "my_policy", "password": "SomeSecretPassword", "sla_type": "icmp", "state": "present", "tenant": "my_tenant", "username": "admin"}, "delegate_to": "localhost", "name": "Add a new ICMP SLA monitoring policy"}
- {"cisco.aci.aci_ip_sla_monitoring_policy": {"frequency": 45, "host": "apic", "multiplier": 5, "name": "my_policy", "password": "SomeSecretPassword", "sla_port": 2345, "sla_type": "tcp", "state": "present", "tenant": "my_tenant", "username": "admin"}, "delegate_to": "localhost", "name": "Update to TCP SLA monitoring policy"}
- {"cisco.aci.aci_ip_sla_monitoring_policy": {"host": "apic", "name": "my_policy", "password": "SomeSecretPassword", "state": "query", "tenant": "my_tenant", "username": "admin"}, "delegate_to": "localhost", "name": "Query an SLA monitoring policy", "register": "query_result"}
- {"cisco.aci.aci_ip_sla_monitoring_policy": {"host": "apic", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query all SLA monitoring policies", "register": "query_result"}
- {"cisco.aci.aci_ip_sla_monitoring_policy": {"host": "apic", "name": "my_policy", "password": "SomeSecretPassword", "state": "absent", "tenant": "my_tenant", "username": "admin"}, "delegate_to": "localhost", "name": "Delete an SLA monitoring policy"}