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

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

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
arp_flag	Варианты: arp_reply arp_request unspecified	Флаг arp для использования при ether_type arp. APIC по умолчанию использует `unspecified` при отсутствии значения при создании.
certificate_name		Имя сертификата X.509, привязанного к пользователю APIC AAA, используемому для аутентификации на основе сертификатов. По умолчанию используется `private_key` без расширения. псевдонимы: cert_name
description		Описание записи фильтра. псевдонимы: descr
dst_port	Варианты: Допустимые диапазоны портов TCP/UDP	Используется для установки начального и конечного портов назначения на одинаковое значение при ip_protocol tcp или udp. APIC по умолчанию использует `unspecified` при отсутствии значения при создании.
dst_port_end	Варианты: Допустимые диапазоны портов TCP/UDP	Используется для установки конечного порта назначения при ip_protocol tcp или udp. APIC по умолчанию использует `unspecified` при отсутствии значения при создании.
dst_port_start	Варианты: Допустимые диапазоны портов TCP/UDP	Используется для установки начального порта назначения при 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` словарь. `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию.
password обязательно		Пароль для аутентификации. Этот параметр взаимоисключает `private_key`. Если задано также `private_key`, будет использовано оно.
port		Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`.
private_key обязательно		Файл в формате PEM с вашим закрытым ключом для аутентификации на основе сертификатов. Имя ключа (без расширения) используется в ACI как имя сертификата, если не указано `certificate_name`. Этот параметр взаимоисключает `password`. Если указано также `password`, оно будет проигнорировано. псевдонимы: cert_key
state	Варианты: absent present ← query	present, absent, query
stateful bool	Варианты: no yes	Определяет состояние записи фильтра.
tenant		Имя арендатора. псевдонимы: tenant_name
timeout int	Значение по умолчанию: 30	Таймаут сокета в секундах.
use_proxy bool	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах.
use_ssl bool	Варианты: no yes ←	Если `no`, вместо стандартного HTTPS-соединения будет использоваться HTTP-соединение.
username	Значение по умолчанию: "admin"	Имя пользователя для аутентификации. псевдонимы: user
validate_certs bool	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует устанавливать в `no` только при работе с сайтами, управляемыми лично, использующими самозаверяющие сертификаты.

Примечания

Примечание

Должны существовать tenant и filter, прежде чем использовать этот модуль в вашем плейбуке. Для этого можно использовать модули aci_tenant и aci_filter.
Дополнительная информация о внутреннем классе APIC vz:Entry содержится в справочнике по модели информации управления APIC.
Для получения более подробной информации о управлении инфраструктурой ACI с помощью Ansible, обратитесь к Руководству по 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 }}"

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

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

Ключ	Возвращённое значение	Описание
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 строка	ошибка разбора	Необработанный вывод, возвращённый APIC REST API (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. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, также поддерживаемых сообществом 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.6/modules/aci_filter_entry_module.html