Модуль cisco.aci.aci_filter_entry — Управление записями фильтров (vz:Entry)
Примечание
Этот модуль входит в коллекцию cisco.aci (версия 2.10.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.aci.
Чтобы использовать её в плейбуке, укажите: cisco.aci.aci_filter_entry.
Краткое описание
- Управление записями фильтров для фильтра на тканях Cisco ACI.
Параметры
Параметр | Комментарии |
|---|---|
annotation string | Пользовательская строка для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения Если значение не указано в задаче и переменной окружения Default: |
arp_flag string | Флаг arp, используемый, когда ether_type равен arp. APIC по умолчанию использует Choices:
|
certificate_name aliases: cert_name string | Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указано имя файла Если для Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
description aliases: descr string | Описание для записи фильтра. |
destination_port aliases: dst_port string | Используется для установки начального и конечного портов назначения на одно и то же значение, когда ip_protocol — tcp или udp. Допустимые значения — любой допустимый диапазон портов TCP/UDP. APIC по умолчанию использует |
destination_port_end aliases: dst_port_end string | Используется для установки конечного порта назначения, когда ip_protocol — tcp или udp. Допустимые значения — любой допустимый диапазон портов TCP/UDP. APIC по умолчанию использует |
destination_port_start aliases: dst_port_start string | Используется для установки начального порта назначения, когда ip_protocol — tcp или udp. Допустимые значения — любой допустимый диапазон портов TCP/UDP. APIC по умолчанию использует |
entry aliases: entry_name, filter_entry, name string | Имя записи фильтра. |
ether_type string | Тип Ethernet. APIC по умолчанию использует Choices:
|
filter aliases: filter_name string | Имя фильтра, к которому должна принадлежать запись. |
host aliases: hostname string | IP-адрес или имя хоста APIC, распознаваемое узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
icmp6_msg_type string | Тип сообщения ICMPv6; используется, когда ip_protocol — icmpv6. APIC по умолчанию использует Choices:
|
icmp_msg_type string | Тип сообщения ICMPv4; используется, когда ip_protocol — icmp. APIC по умолчанию использует Choices:
|
ip_protocol string | Тип протокола IP, когда ether_type — ip. APIC по умолчанию использует Choices:
|
match_only_fragments boolean | Соответствие только фрагментам пакетов записи фильтра. При включении При выключении APIC по умолчанию использует Варианты:
|
name_alias string | Псевдоним для текущего объекта. Это относится к полю nameAlias в ACI. |
output_level string | Влияет на вывод этого модуля ACI.
Если значение не указано в задаче, вместо него будет использовано значение переменной среды Варианты:
|
output_path string | Путь к файлу, который будет использоваться для выгрузки объектов конфигурации ACI JSON, созданных модулем. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
password string | Пароль для аутентификации. Этот параметр взаимоисключает Если значение не указано в задаче, вместо него будут использованы значения переменных среды |
port integer | Номер порта, который будет использоваться для REST-подключения. Значение по умолчанию зависит от параметра Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
private_key псевдонимы: cert_key string | Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на значение Этот параметр взаимоисключает Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
source_port псевдонимы: src_port string | Используется для установки начального и конечного портов источника на одно и то же значение, когда ip_protocol имеет значение tcp или udp. Допустимые значения — любой допустимый диапазон портов TCP/UDP. APIC по умолчанию использует |
source_port_end псевдонимы: src_port_end string | Используется для установки конечного порта источника, когда ip_protocol имеет значение tcp или udp. Допустимые значения — любой допустимый диапазон портов TCP/UDP. APIC по умолчанию использует |
source_port_start псевдонимы: src_port_start string | Используется для установки начального порта источника, когда ip_protocol имеет значение tcp или udp. Допустимые значения — любой допустимый диапазон портов TCP/UDP. APIC по умолчанию использует |
state string | present, absent, query Варианты:
|
stateful boolean | Определяет состояние записи фильтра. Варианты:
|
suppress_previous псевдонимы: no_previous, ignore_previous boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной среды Значение по умолчанию — ПРЕДУПРЕЖДЕНИЕ — Это приводит к тому, что предыдущее возвращаемое значение будет пустым. Предыдущее состояние объекта не будет проверено, и обновление POST будет содержать все свойства. Варианты:
|
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной среды Значение по умолчанию — ПРЕДУПРЕЖДЕНИЕ — Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение. Текущий объект, включая значения по умолчанию, будет непроверяемым в одной задаче. Варианты:
|
tcp_flags list / elements=string | Флаги TCP для записи фильтра. Флаги TCP APIC по умолчанию использует значение Возможные значения:
|
tenant псевдонимы: tenant_name строка | Имя клиента. |
timeout целое число | Таймаут сокета в секундах. Если значение не указано в задании, будет использовано значение переменной среды Значение по умолчанию — 30. |
use_proxy булево | Если Если значение не указано в задании, будет использовано значение переменной среды Значение по умолчанию — true. Возможные значения:
|
use_ssl булево | Если Если значение не указано в задании, будет использовано значение переменной среды Значение по умолчанию — true, если соединение локальное. Возможные значения:
|
username псевдонимы: user строка | Имя пользователя для аутентификации. Если значение не указано в задании, будет использовано значение переменных окружения Значение по умолчанию — admin. |
validate_certs булево | Если Это следует использовать только для сайтов под собственным контролем, использующих самозаверенные сертификаты. Если значение не указано в задании, будет использовано значение переменной среды Значение по умолчанию — true. Возможные значения:
|
Примечания
Примечание
- Для использования этого модуля в вашей книге задач должны существовать
tenantиfilter. Для этого можно использовать модули cisco.aci.aci_tenant и cisco.aci.aci_filter.
См. также
См. также
- cisco.aci.aci_tenant
-
Управление клиентами (fv:Tenant).
- cisco.aci.aci_filter
-
Управление фильтрами верхнего уровня (vz:Filter).
- APIC Management Information Model reference
-
Дополнительная информация о внутреннем классе APIC vz:Entry.
- Руководство по Cisco ACI
-
Подробная информация о том, как управлять инфраструктурой Cisco ACI с помощью Ansible.
- Разработка модулей Cisco ACI
-
Подробное руководство по написанию собственных модулей Cisco ACI для участия в разработке.
Примеры
- name: Create a filter entry
cisco.aci.aci_filter_entry:
host: apic
username: admin
password: SomeSecretPassword
entry: https_allow
filter: web_filter
tenant: prod
ether_type: ip
ip_protocol: tcp
dst_port_start: 443
dst_port_end: 443
source_port_start: 20
source_port_end: 22
tcp_flags:
- acknowledgment
- finish
state: present
delegate_to: localhost
- name: Create a filter entry with the match only packet fragments enabled
cisco.aci.aci_filter_entry:
host: apic
username: admin
password: SomeSecretPassword
entry: https_allow
filter: web_filter
tenant: prod
ether_type: ip
ip_protocol: tcp
match_only_fragments: true
state: present
delegate_to: localhost
- name: Delete a filter entry
cisco.aci.aci_filter_entry:
host: apic
username: admin
password: SomeSecretPassword
entry: https_allow
filter: web_filter
tenant: prod
state: absent
delegate_to: localhost
- name: Query all filter entries
cisco.aci.aci_filter_entry:
host: apic
username: admin
password: SomeSecretPassword
state: query
delegate_to: localhost
register: query_result
- name: Query a specific filter entry
cisco.aci.aci_filter_entry:
host: apic
username: admin
password: SomeSecretPassword
entry: https_allow
filter: web_filter
tenant: prod
state: query
delegate_to: localhost
register: query_result
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
current список / элементы=строка | Существующая конфигурация с APIC после завершения работы модуля Возвращаемое значение: успех Пример: |
error словарь | Информация об ошибке, возвращаемая с APIC Возвращаемое значение: неудача Пример: |
filter_string строка | Строка фильтра, используемая для запроса Возвращаемое значение: неудача или отладка Пример: |
method строка | HTTP-метод, используемый для запроса к APIC Возвращаемое значение: неудача или отладка Пример: |
previous список / элементы=строка | Исходная конфигурация с APIC до запуска модуля Возвращаемое значение: информация Пример: |
proposed словарь | Собранная конфигурация из предоставленных пользователем параметров Возвращаемое значение: информация Пример: |
raw строка | Необработанный вывод, возвращаемый APIC REST API (xml или json) Возвращаемое значение: ошибка разбора Пример: |
response строка | HTTP-ответ с APIC Возвращаемое значение: неудача или отладка Пример: |
sent список / элементы=строка | Фактическая/минимальная конфигурация, отправленная в APIC Возвращаемое значение: информация Пример: |
status целое число | HTTP-статус с APIC Возвращаемое значение: неудача или отладка Пример: |
url строка | HTTP-URL, используемый для запроса к APIC Возвращаемое значение: неудача или отладка Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/aci/aci_filter_entry_module.html