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 -		Используется для установки начального и конечного портов назначения в одно значение при 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 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 - / обязательно		Пароль для аутентификации. Этот параметр взаимоисключающий с `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 boolean	Варианты: no yes	Определяет состоятельность записи фильтра.
tenant -		Имя клиента. Псевдонимы: tenant_name
timeout integer	По умолчанию: 30	Таймаут на уровне сокета в секундах.
use_proxy boolean	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определён в переменной окружения на целевых узлах.
use_ssl boolean	Варианты: no yes ←	Если `no`, вместо стандартного HTTPS будет использовано HTTP-соединение.
username -	По умолчанию: "admin"	Имя пользователя для аутентификации. Псевдонимы: user
validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует установить в `no` только при использовании на контролируемых сайтах с самозаверенными сертификатами.

Примечания

Примечание

Необходимо, чтобы tenant и filter существовали перед использованием данного модуля в вашем playbook. Для этого можно использовать модули aci_tenant и aci_filter.
Дополнительную информацию о внутреннем классе APIC vz:Entry можно найти в справочнике по модели управления информацией APIC.

См. также

Руководство по 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.7/modules/aci_filter_entry_module.html