модуль cisco.aci.aci_ip_sla_monitoring_policy — управление политиками мониторинга IP SLA (fv:IPSLAMonitoringPol)

annotation

string

Пользовательская строка для добавления аннотации к объекту.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_ANNOTATION.

Если значение не указано в задаче и переменная среды ACI_ANNOTATION, будет использовано значение по умолчанию.

По умолчанию: "orchestrator:ansible"

certificate_name

псевдонимы: cert_name

string

Имя сертификата X.509, связанного с пользователем APIC AAA и используемого для аутентификации на основе подписи.

Если указано имя файла private_key, по умолчанию используется имя файла private_key без расширения.

Если для private_key указано содержимое в формате PEM, по умолчанию используется значение username.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_CERTIFICATE_NAME.

description

string

Описание политики SLA.

frequency

integer

Задает интервал между проверочными запросами.

Если значение не задано при создании, APIC использует 60.

Допустимый диапазон значений: [1, 300].

host

псевдонимы: hostname

string

IP-адрес или имя узла APIC, разрешаемое управляющим узлом Ansible.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_HOST.

http_uri

string

URI HTTP, используемый в качестве места назначения SLA.

Если значение не задано при создании, APIC использует /.

Поддерживается только в APIC версии 5.0 и выше.

http_version

string

Используемая версия HTTP.

Если значение не задано при создании, APIC использует 1.0.

Поддерживается только в APIC версии 5.0 и выше.

Варианты:

• "1.0"
• "1.1"

multiplier

псевдонимы: detect_multiplier

integer

Задает количество последовательных сбоев проверочных запросов, необходимое для определения недоступности SLA.

Если значение не задано при создании, APIC использует 3.

Допустимый диапазон значений: [1, 100].

name

псевдонимы: sla_policy

string

Имя политики SLA.

operation_timeout

integer

Время в миллисекундах, в течение которого операция IP SLA ожидает ответ на отправленный пакет запроса.

Если значение не задано при создании, APIC использует 900.

Допустимый диапазон значений: [0, 604800000].

Поддерживается только в APIC версии 5.1 и выше.

output_level

string

Управляет выводом этого модуля ACI.

normal — стандартный вывод, включая словарь current

info добавляет информационный вывод, включая previous, proposed и словари sent

debug добавляет отладочный вывод, включая информацию filter_string, method, response, status и url

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_OUTPUT_LEVEL.

Варианты:

• "debug"
• "info"
• "normal" ← (по умолчанию)

output_path

string

Путь к файлу, в который будут записаны объекты конфигурации ACI в формате JSON, созданные модулем.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_OUTPUT_PATH.

owner_key

string

Пользовательская строка для атрибута ownerKey объекта ACI.

Этот атрибут представляет собой ключ, позволяющий клиентам владеть своими данными для корреляции сущностей.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_OWNER_KEY.

owner_tag

string

Пользовательская строка для атрибута ownerTag объекта ACI.

Этот атрибут представляет собой метку, позволяющую клиентам добавлять собственные данные.

Например, она может указывать, кто создал этот объект.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_OWNER_TAG.

password

string

Пароль для аутентификации.

Этот параметр несовместим с private_key. Если также задан private_key, будет использован он.

Если значение не указано в задаче, вместо него будут использованы переменные среды ACI_PASSWORD или ANSIBLE_NET_PASSWORD.

port

integer

Номер порта для REST-подключения.

Значение по умолчанию зависит от параметра use_ssl.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_PORT.

private_key

псевдонимы: cert_key

string

Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемого для аутентификации на основе подписи.

Это значение также влияет на значение certificate_name, используемое по умолчанию.

Этот параметр несовместим с password. Если также задан password, он будет проигнорирован.

Если значение не указано в задаче, вместо него будут использованы переменные среды ACI_PRIVATE_KEY или ANSIBLE_NET_SSH_KEYFILE.

request_data_size

integer

Количество байтов, отправляемых в запросе.

Используется только при sla_type=http.

Если значение не задано при создании, APIC использует 28.

Допустимый диапазон значений: [0, 17512]

Поддерживается только в APIC версии 5.1 и выше.

sla_port

псевдонимы: destination_port

integer

Порт, отслеживаемый для SLA TCP.

Допустимый диапазон значений: [1, 65535].

sla_type

string

Тип мониторинга.

Если значение не задано при создании, APIC использует icmp.

sla_type=http поддерживается только в APIC версии 5.0 и выше.

Варианты:

• "icmp"
• "tcp"
• "l2ping"
• "http"

state

string

Используйте present или absent для добавления или удаления.

Используйте query для вывода одного или нескольких объектов.

Варианты:

• "absent"
• "present" ← (по умолчанию)
• "query"

suppress_previous

псевдонимы: no_previous, ignore_previous

boolean

Если true, перед отправкой POST-запроса на обновление APIC не будет отправлен GET-запрос для проверки предыдущего состояния.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_SUPPRESS_PREVIOUS.

Значение по умолчанию: false.

ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое предыдущее значение будет пустым.

Предыдущее состояние объекта проверяться не будет, а POST-запрос на обновление будет содержать все свойства.

Варианты:

• false
• true

suppress_verification

псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

Если true, после отправки POST-запроса на обновление APIC не будет отправлен проверочный GET-запрос.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_SUPPRESS_VERIFICATION.

Значение по умолчанию: false.

ПРЕДУПРЕЖДЕНИЕ — в результате текущее возвращаемое значение будет установлено равным предлагаемому значению.

Текущее состояние объекта, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи.

Варианты:

• false
• true

tenant

псевдонимы: tenant_name

string

Имя существующего арендатора.

threshold

integer

Верхнее пороговое значение в миллисекундах для расчета статистики мониторинга сети, собираемой операцией IP SLA.

Значение, заданное для этого свойства, не должно превышать значение, заданное для operation_timeout.

Если значение не задано при создании, APIC использует 900.

Допустимый диапазон значений: [0, 604800000].

Поддерживается только в APIC версии 5.1 и выше.

timeout

integer

Тайм-аут на уровне сокета в секундах.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_TIMEOUT.

Значение по умолчанию: 30.

traffic_class

псевдонимы: traffic_class_value

integer

Задает значение класса трафика в заголовке IPv6.

Если значение не задано при создании, APIC использует 0.

Допустимый диапазон значений: [0, 255].

Поддерживается только в APIC версии 5.1 и выше.

type_of_service

псевдонимы: tos

integer

Значение типа обслуживания (ToS), задаваемое в заголовке IPv4.

Если значение не задано при создании, APIC использует 0.

Допустимый диапазон значений: [0, 255].

Поддерживается только в APIC версии 5.1 и выше.

use_proxy

boolean

Если false, прокси использоваться не будет, даже если он задан в переменной среды на целевых узлах.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_USE_PROXY.

Значение по умолчанию: true.

Варианты:

• false
• true

use_ssl

boolean

Если false, вместо используемого по умолчанию HTTPS-подключения будет установлено HTTP-подключение.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_USE_SSL.

При локальном подключении значение по умолчанию — true.

Варианты:

• false
• true

username

псевдонимы: user

string

Имя пользователя для аутентификации.

Если значение не указано в задаче, вместо него будут использованы переменные среды ACI_USERNAME или ANSIBLE_NET_USERNAME.

Значение по умолчанию: admin.

validate_certs

boolean

Если false, SSL-сертификаты проверяться не будут.

Устанавливайте значение false только при использовании на контролируемых вами ресурсах с самоподписанными сертификатами.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_VALIDATE_CERTS.

Значение по умолчанию: true.

Варианты:

• false
• true

current

list / elements=string

Текущая конфигурация из APIC после завершения работы модуля

Возвращается: success

Пример: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

error

dictionary

Сведения об ошибке, возвращённые APIC

Возвращается: failure

Пример: {"code": "122", "text": "unknown managed object class foo"}

filter_string

string

Строка фильтра, использованная для запроса

Возвращается: failure or debug

Пример: "?rsp-prop-include=config-only"

method

string

Метод HTTP, использованный для запроса к APIC

Возвращается: failure or debug

Пример: "POST"

previous

list / elements=string

Исходная конфигурация из APIC до начала работы модуля

Возвращается: info

Пример: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

dictionary

Сформированная конфигурация на основе параметров, указанных пользователем

Возвращается: info

Пример: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}

raw

string

Необработанный вывод, возвращённый REST API APIC (xml или json)

Возвращается: parse error

Пример: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"

response

string

Ответ HTTP от APIC

Возвращается: failure or debug

Пример: "OK (30 bytes)"

sent

list / elements=string

Фактическая/минимальная конфигурация, отправленная в APIC

Возвращается: info

Пример: {"fvTenant": {"attributes": {"descr": "Production environment"}}}

status

integer

Статус HTTP от APIC

Возвращается: failure or debug

Пример: 200

url

string

URL HTTP, использованный для запроса к APIC

Возвращается: failure or debug

Пример: "https://10.11.12.13/api/mo/uni/tn-production.json"