Модуль cisco.aci.aci_interface_policy_storm_control – Управление политиками контроля всплесков на интерфейсах (stormctrl:IfPol)

Примечание

Этот модуль входит в коллекцию cisco.aci (версия 2.10.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.aci.

Чтобы использовать его в плейбуке, укажите: cisco.aci.aci_interface_policy_storm_control.

Обзор
Параметры
См. также
Примеры
Возвращаемые значения

Обзор

Управление политиками контроля всплесков на интерфейсах Cisco ACI.

Параметры

Параметр	Комментарии
all_types_configuration псевдонимы: all_types словарь	Настройка скоростей для всех типов пакетов.
burst_rate строка	Скорость импульса для всех типов пакетов.
rate строка	Скорость для всех типов пакетов.
rate_type строка / обязательно	Тип скорости для всех типов пакетов. Выбор между процентом пропускной способности `percentage` или пакетами в секунду `pps` Варианты: `"percentage"` `"pps"`
annotation строка	Определяемая пользователем строка для аннотирования объекта. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменной среды `ACI_ANNOTATION`, будет использовано значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
broadcast_configuration псевдонимы: broadcast словарь	Настройка скоростей для пакетов широковещательной рассылки.
burst_rate строка	Скорость импульса для пакетов широковещательной рассылки.
rate строка	Скорость для пакетов широковещательной рассылки.
rate_type строка / обязательно	Тип скорости для всех типов пакетов. Выбор между процентом пропускной способности `percentage` или пакетами в секунду `pps` Варианты: `"percentage"` `"pps"`
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл с расширением `private_key`, по умолчанию используется `private_key` имя файла без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`.
description псевдонимы: descr строка	Описание имени политики интерфейса шторма.
host псевдонимы: hostname строка	IP-адрес или имя хоста, разрешаемый хостом управления Ansible. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_HOST`.
multicast_configuration псевдонимы: multicast словарь	Настройка скоростей для пакетов мультикаста.
burst_rate строка	Скорость импульса для пакетов мультикаста.
rate строка	Скорость для пакетов мультикаста.
rate_type строка / обязательно	Тип скорости для всех типов пакетов. Выбор между процентом пропускной способности `percentage` или пакетами в секунду `pps` Варианты: `"percentage"` `"pps"`
name_alias строка	Псевдоним для текущего объекта. Это относится к полю nameAlias в ACI.

output_level string	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` dict `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` dicts `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`.
state string	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления одного объекта или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
storm_control_action string	Действие контроля шторма, которое необходимо выполнить при срабатывании. Варианты: `"drop"` `"shutdown"`
storm_control_policy псевдонимы: storm_control, storm_control_name, name string	Имя политики интерфейса контроля шторма.
storm_control_soak_action integer	Количество экземпляров перед срабатыванием отключения.
suppress_previous псевдонимы: no_previous, ignore_previous boolean	Если `true`, запрос GET для проверки предыдущего значения не будет отправлен перед обновлением POST в APIC. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию - `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение будет пустым. Предыдущее состояние объекта не будет проверено, и обновление POST будет содержать все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, проверочный запрос GET не будет отправлен после обновления POST в APIC. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию - `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение. Текущий объект, включая значения по умолчанию, будет непроверяемым в одной задаче. Варианты: `false` `true`
timeout integer	Таймаут на уровне сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию - 30.

unicast_configuration aliases: unicast словарь	Конфигурация скоростей пакетов unicast.
burst_rate строка	Скорость пакетов unicast в импульсе.
rate строка	Скорость пакетов unicast.
rate_type строка / обязательно	Тип скорости всех типов пакетов. Выбор между процентом от пропускной способности `percentage` или пакетами в секунду `pps` Варианты: `"percentage"` `"pps"`
use_proxy булево	Если `false`, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах. Если значение не указано в задании, вместо него будет использовано значение переменной среды `ACI_USE_PROXY` Значение по умолчанию — true. Варианты: `false` `true`
use_ssl булево	Если `false`, вместо стандартного HTTPS-соединения будет использовано HTTP-соединение. Если значение не указано в задании, вместо него будет использовано значение переменной среды `ACI_USE_SSL` Значение по умолчанию — true, когда соединение локальное. Варианты: `false` `true`
username aliases: user строка	Имя пользователя для аутентификации. Если значение не указано в задании, вместо него будет использовано значение переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME` Значение по умолчанию — admin.
validate_certs булево	Если `false`, сертификаты SSL не будут проверены. Это следует установить в `false` только при работе с сайтами, контролируемыми вами, которые используют самозаверяемые сертификаты. Если значение не указано в задании, вместо него будет использовано значение переменной среды `ACI_VALIDATE_CERTS` Значение по умолчанию — true. Варианты: `false` `true`

См. также

Справочник по модели информации управления APIC: Дополнительная информация о внутреннем классе APIC stormctrl:IfPol.
Руководство Cisco ACI: Подробная информация о том, как управлять инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Add a new Storm Control Interface Policy
  cisco.aci.aci_interface_policy_storm_control:
    host: apic
    username: admin
    password: SomeSecretPassword
    storm_control_policy: my_storm_control_policy
    description: My Storm Control Policy
    all_types_configuration:
      rate: 80
      burst_rate: 100
      rate_type: percentage
    storm_control_action: shutdown
    storm_control_soak_action: 5
    state: present
  delegate_to: localhost

- name: Query a Storm Control Interface Policy
  cisco.aci.aci_interface_policy_storm_control:
    host: apic
    username: admin
    password: SomeSecretPassword
    storm_control_policy: my_storm_control_policy
    state: query
  delegate_to: localhost

- name: Query all Storm Control Interface Policies
  cisco.aci.aci_interface_policy_storm_control:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Delete a Storm Control Interface Policy
  cisco.aci.aci_interface_policy_storm_control:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    storm_control_policy: my_storm_control_policy
    state: absent
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
current list / elements=string	Существующая конфигурация из APIC после завершения работы модуля Возвращается: success Пример: `[{"cdpIfPol": {"attributes": {"adminSt": "disabled", "annotation": "", "descr": "Ansible Created CDP Test Policy", "dn": "uni/infra/cdpIfP-Ansible_CDP_Test_Policy", "name": "Ansible_CDP_Test_Policy", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
error dictionary	Информация об ошибке, возвращаемая APIC Возвращается: failure Пример: `{"code": "122", "text": "unknown managed object class foo"}`
filter_string string	Строка фильтра, используемая для запроса Возвращается: failure или debug Пример: `"?rsp-prop-include=config-only"`
method string	HTTP-метод, используемый для запроса к APIC Возвращается: failure или 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	Необработанный вывод, возвращаемый API REST APIC (xml или json) Возвращается: ошибка парсинга Пример: `"<?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 или debug Пример: `"OK (30 bytes)"`
sent list / elements=string	Фактическая/минимальная конфигурация, отправленная в APIC Возвращается: info Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status integer	HTTP-статус от APIC Возвращается: failure или debug Пример: `200`
url string	HTTP-url, используемый для запроса к APIC Возвращается: failure или debug Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Eric Girard (@netgirard)
Gaspard Micol (@gmicol)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/aci/aci_interface_policy_storm_control_module.html