aci_filter_entry – Управление записями фильтров (vz:Entry)

Новое в версии 2.4.

Краткое описание
Параметры
Примечания
См. также
Примеры
Возвращаемые значения
Статус

Краткое описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
arp_flag строка	Варианты: arp_reply arp_request неуказано	Флаг arp для использования, когда ether_type равен arp. APIC по умолчанию использует `unspecified`, если не указано при создании.
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе сертификатов. Если был предоставлен файл с именем `private_key`, по умолчанию используется имя файла `private_key` без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username`. псевдонимы: cert_name
description строка		Описание записи фильтра. псевдонимы: descr
dst_port строка		Используется для установки начального и конечного портов назначения на одно и то же значение, когда ip_protocol равен tcp или udp. Допустимые значения — любой допустимый диапазон портов TCP/UDP. APIC по умолчанию использует `unspecified`, если не указано при создании.
dst_port_end строка		Используется для установки конечного порта назначения, когда ip_protocol равен tcp или udp. Допустимые значения — любой допустимый диапазон портов TCP/UDP. APIC по умолчанию использует `unspecified`, если не указано при создании.
dst_port_start строка		Используется для установки начального порта назначения, когда ip_protocol равен tcp или udp. Допустимые значения — любой допустимый диапазон портов TCP/UDP. APIC по умолчанию использует `unspecified`, если не указано при создании.
entry строка		Имя записи фильтра. псевдонимы: entry_name, filter_entry, name
ether_type строка	Варианты: arp fcoe ip mac_security mpls_ucast trill неуказано	Тип Ethernet. APIC по умолчанию использует `unspecified`, если не указано при создании.
filter строка		Имя фильтра, к которому должна принадлежать запись. псевдонимы: filter_name
host строка / обязательно		IP-адрес или имя хоста APIC, разрешаемые хостом управления Ansible. псевдонимы: hostname
icmp6_msg_type строка	Варианты: dst_unreachable echo_request echo_reply neighbor_advertisement neighbor_solicitation redirect time_exceeded неуказано	Тип сообщения ICMPv6; используется, когда ip_protocol равен icmpv6. APIC по умолчанию использует `unspecified`, если не указано при создании.
icmp_msg_type строка	Варианты: dst_unreachable echo echo_reply src_quench time_exceeded неуказано	Тип сообщения ICMPv4; используется, когда ip_protocol равен icmp. APIC по умолчанию использует `unspecified`, если не указано при создании.
ip_protocol строка	Варианты: eigrp egp icmp icmpv6 igmp igp l2tp ospfigp pim tcp udp неуказано	Тип IP-протокола, когда ether_type равен ip. APIC по умолчанию использует `unspecified`, если не указано при создании.
output_level строка	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь. `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию.
password строка / обязательно		Пароль для аутентификации. Этот параметр исключает `private_key`. Если `private_key` также предоставлен, он будет использован.
port целое число		Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`.
private_key строка / обязательно		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемые для аутентификации на основе сертификатов. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр исключает `password`. Если `password` также предоставлен, он будет проигнорирован. псевдонимы: cert_key
state строка	Варианты: absent present ← query	present, absent, query
stateful логическое значение	Варианты: no yes	Определяет состояние записи фильтра.
tenant строка		Имя клиента. псевдонимы: tenant_name
timeout целое число	По умолчанию: 30	Таймаут сокета в секундах.
use_proxy логическое значение	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах.
use_ssl логическое значение	Варианты: no yes ←	Если `no`, будет использовано HTTP-соединение вместо стандартного HTTPS-соединения.
username строка	По умолчанию: "admin"	Имя пользователя для аутентификации. псевдонимы: user
validate_certs логическое значение	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это нужно устанавливать в `no` только при работе с сайтами, которыми вы управляете и используете самоподписанные сертификаты.

Примечания

Примечание

Модуль tenant и filter должны существовать перед использованием этого модуля в вашем плане действий. Для этого можно использовать модули aci_tenant и aci_filter.

См. также

aci_tenant – Управление арендаторами (fv:Tenant): Официальная документация по модулю aci_tenant.
aci_filter – Управление фильтрами верхнего уровня (vz:Filter): Официальная документация по модулю aci_filter.
APIC Management Information Model reference: Дополнительная информация о внутреннем классе APIC vz:Entry.
Руководство Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для участия.

Примеры

- aci_filter_entry:
    host: "{{ inventory_hostname }}"
    username: "{{ user }}"
    password: "{{ pass }}"
    state: "{{ state }}"
    entry: "{{ entry }}"
    tenant: "{{ tenant }}"
    ether_name: "{{  ether_name }}"
    icmp_msg_type: "{{ icmp_msg_type }}"
    filter: "{{ filter }}"
    descr: "{{ descr }}"
  delegate_to: localhost

Значения возврата

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

Ключ	Возвращаемое значение	Описание
current список	успех	Настройка, существующая в APIC после завершения модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
error словарь	ошибка	Информация об ошибке, возвращаемая APIC Пример: {'code': '122', 'text': 'неизвестный класс управляемого объекта foo'}
filter_string строка	ошибка или отладка	Строка фильтра, используемая для запроса Пример: ?rsp-prop-include=config-only
method строка	ошибка или отладка	HTTP-метод, используемый для запроса к APIC Пример: POST
previous список	информация	Исходная конфигурация из APIC до запуска модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производственная', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed словарь	информация	Собранная конфигурация из параметров, предоставленных пользователем Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда', 'name': 'production'}}}
raw строка	ошибка разбора	Необработанный вывод, возвращённый API REST APIC (xml или json) Пример: <?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="неизвестный класс управляемого объекта foo"/></imdata>
response строка	ошибка или отладка	HTTP-ответ от APIC Пример: OK (30 байт)
sent список	информация	Фактическая/минимальная конфигурация, отправленная в APIC Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда'}}}
status целое число	ошибка или отладка	HTTP-статус от APIC Пример: 200
url строка	ошибка или отладка	Используемый HTTP-url для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Состояние

Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается партнёром Ansible. [сертифицированно]

Авторы

Jacob McGill (@jmcgill298)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/aci_filter_entry_module.html