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

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

Обзор
Параметры
Примечания
Примеры
Значения возврата
Статус
- Автор

Обзор

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

Параметры

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

Примечания

Примечание

Файлы tenant и filter должны существовать до использования этого модуля в вашем плейбуке. Для этого можно использовать модули aci_tenant и aci_filter.
Дополнительная информация о внутреннем классе APIC vz:Entry из справочника по модели управления информацией APIC.
По умолчанию, если на целевом узле установлена переменная окружения <protocol>_proxy, запросы будут отправляться через этот прокси. Это поведение можно переопределить, установив переменную для этой задачи (см. установку среды) или используя опцию use_proxy.
HTTP-редиректы могут перенаправлять с HTTP на HTTPS, поэтому вы должны убедиться, что ваша среда прокси для обоих протоколов корректна.

Примеры

- 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 }}"

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

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

Ключ	Возврат	Описание
current список	успех	Текущая конфигурация с APIC после завершения модуля Пример: [{'fvTenant': {'attributes': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Производственная среда', 'nameAlias': '', 'ownerTag': ''}}}]
error словарь	ошибка	Информация об ошибке, возвращённая APIC Пример: {'text': 'неизвестный класс управляемого объекта foo', 'code': '122'}
filter_string строка	ошибка или отладка	Строка фильтра, используемая для запроса Пример: ?rsp-prop-include=config-only
method строка	ошибка или отладка	Метод HTTP, используемый для запроса к APIC Пример: POST
previous список	информация	Исходная конфигурация с APIC до запуска модуля Пример: [{'fvTenant': {'attributes': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Производство', 'nameAlias': '', 'ownerTag': ''}}}]
proposed словарь	информация	Собранная конфигурация из параметров, предоставленных пользователем Пример: {'fvTenant': {'attributes': {'name': 'production', 'descr': 'Производственная среда'}}}
raw строка	ошибка разбора	Необработанный результат, возвращённый REST API 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

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.

Автор

Яков Макгилл (@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.5/modules/aci_filter_entry_module.html