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

Примечание

Этот плагин входит в коллекцию cisco.aci (версия 1.1.1).

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

Чтобы использовать его в книге задач, укажите: cisco.aci.aci_filter_entry.

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

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

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
annotation строка		Определенная пользователем строка для аннотирования объекта. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_ANNOTATION`.
arp_flag строка	Варианты: arp_reply arp_request unspecified	Флаг arp для использования, когда ether_type равен arp. APIC по умолчанию использует `unspecified`, если не задано при создании.
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл с именем `private_key`, по умолчанию используется имя файла `private_key`, без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_CERTIFICATE_NAME`. Псевдонимы: 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-адрес или имя хоста APIC, разрешаемое хостом управления Ansible. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_HOST`. Псевдонимы: 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`, если не задано при создании.
name_alias строка		Псевдоним для текущего объекта. Он относится к полю nameAlias в ACI.
output_level строка	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` dict `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` dicts `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_OUTPUT_LEVEL`.
output_path строка		Путь к файлу, который будет использоваться для вывода сгенерированных модулем ACI JSON-объектов конфигурации. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_OUTPUT_PATH`.
owner_key строка		Определенная пользователем строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ для предоставления клиентам права собственности на данные для корреляции сущностей. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_OWNER_KEY`.
owner_tag строка		Определенная пользователем строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой метку для предоставления клиентам возможности добавлять свои собственные данные. Например, для указания того, кто создал этот объект. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_OWNER_TAG`.
password строка		Пароль для аутентификации. Этот параметр взаимоисключающий с `private_key`. Если также указан `private_key`, будет использовано его значение. Если значение не указано в задаче, будет использовано значение переменных окружения `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число		Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_PORT`.
private_key строка		Файл с закрытым ключом в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимоисключающий с `password`. Если также указан `password`, он будет проигнорирован. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_PRIVATE_KEY`. Псевдонимы: cert_key
state строка	Варианты: absent present ← query	present, absent, query
stateful логическое	Варианты: no yes	Определяет состояние записи фильтра.
tenant строка		Имя арендатора. Псевдонимы: tenant_name
timeout целое число	По умолчанию: 30	Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_TIMEOUT`.
use_proxy логическое	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_PROXY`.
use_ssl логическое	Варианты: no yes ←	Если `no`, вместо стандартного подключения HTTPS будет использоваться HTTP. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_SSL`.
username строка	По умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не указано в задаче, будут использованы значения переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Псевдонимы: user
validate_certs логическое	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это значение должно быть установлено в `no` только при работе с сайтами, контролируемыми лично, которые используют самозаверяющие сертификаты. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_VALIDATE_CERTS`.

Примечания

Примечание

Перед использованием этого модуля в вашем плане необходимо наличие tenant и filter. Для этого можно использовать модули cisco.aci.aci_tenant и cisco.aci.aci_filter.

См. также

cisco.aci.aci_tenant: Официальная документация по модулю cisco.aci.aci_tenant.
cisco.aci.aci_filter: Официальная документация по модулю cisco.aci.aci_filter.
APIC Management Information Model reference: Дополнительная информация об внутренней классе APIC vz:Entry.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей 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 строка	ошибка разбора	Необработанный вывод, возвращенный 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

Авторы

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.10/collections/cisco/aci/aci_filter_entry_module.html