Spec-Zone.ru › Ansible

Модуль 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

Пользовательская строка для аннотации объекта.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ACI_ANNOTATION.

Если значение не указано в задаче и переменной окружения ACI_ANNOTATION, будет использовано значение по умолчанию.

Default: "orchestrator:ansible"

arp_flag

string

Флаг arp, используемый, когда ether_type равен arp.

APIC по умолчанию использует unspecified при создании, если значение не задано.

Choices:

  • "arp_reply"
  • "arp_request"
  • "unspecified"

certificate_name

aliases: cert_name

string

Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи.

Если указано имя файла private_key, по умолчанию используется базовое имя private_key, без расширения.

Если для private_key предоставлено содержимое в формате PEM, по умолчанию используется значение username.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ACI_CERTIFICATE_NAME.

description

aliases: descr

string

Описание для записи фильтра.

destination_port

aliases: dst_port

string

Используется для установки начального и конечного портов назначения на одно и то же значение, когда ip_protocol — tcp или udp.

Допустимые значения — любой допустимый диапазон портов TCP/UDP.

APIC по умолчанию использует unspecified при создании, если значение не задано.

destination_port_end

aliases: dst_port_end

string

Используется для установки конечного порта назначения, когда ip_protocol — tcp или udp.

Допустимые значения — любой допустимый диапазон портов TCP/UDP.

APIC по умолчанию использует unspecified при создании, если значение не задано.

destination_port_start

aliases: dst_port_start

string

Используется для установки начального порта назначения, когда ip_protocol — tcp или udp.

Допустимые значения — любой допустимый диапазон портов TCP/UDP.

APIC по умолчанию использует unspecified при создании, если значение не задано.

entry

aliases: entry_name, filter_entry, name

string

Имя записи фильтра.

ether_type

string

Тип Ethernet.

APIC по умолчанию использует unspecified при создании, если значение не задано.

Choices:

  • "arp"
  • "fcoe"
  • "ip"
  • "ipv4"
  • "ipv6"
  • "mac_security"
  • "mpls_ucast"
  • "trill"
  • "unspecified"

filter

aliases: filter_name

string

Имя фильтра, к которому должна принадлежать запись.

host

aliases: hostname

string

IP-адрес или имя хоста APIC, распознаваемое узлом управления Ansible.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ACI_HOST.

icmp6_msg_type

string

Тип сообщения ICMPv6; используется, когда ip_protocol — icmpv6.

APIC по умолчанию использует unspecified при создании, если значение не задано.

Choices:

  • "dst_unreachable"
  • "echo_request"
  • "echo_reply"
  • "neighbor_advertisement"
  • "neighbor_solicitation"
  • "redirect"
  • "time_exceeded"
  • "unspecified"

icmp_msg_type

string

Тип сообщения ICMPv4; используется, когда ip_protocol — icmp.

APIC по умолчанию использует unspecified при создании, если значение не задано.

Choices:

  • "dst_unreachable"
  • "echo"
  • "echo_reply"
  • "src_quench"
  • "time_exceeded"
  • "unspecified"

ip_protocol

string

Тип протокола IP, когда ether_type — ip.

APIC по умолчанию использует unspecified при создании, если значение не задано.

Choices:

  • "eigrp"
  • "egp"
  • "icmp"
  • "icmpv6"
  • "igmp"
  • "igp"
  • "l2tp"
  • "ospfigp"
  • "pim"
  • "tcp"
  • "udp"
  • "unspecified"

match_only_fragments

boolean

Соответствие только фрагментам пакетов записи фильтра.

При включении true правило применяется к любым фрагментам со смещением больше 0 (все фрагменты, кроме первого).

При выключении false оно применяется ко всем пакетам (включая все фрагменты).

APIC по умолчанию использует false при отсутствии значения во время создания.

Варианты:

  • false
  • true

name_alias

string

Псевдоним для текущего объекта. Это относится к полю nameAlias в ACI.

output_level

string

Влияет на вывод этого модуля ACI.

normal означает стандартный вывод, включая current dict

info добавляет информационный вывод, включая previous, proposed и sent dicts

debug добавляет отладочный вывод, включая filter_string, method, response, status и url информацию

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_OUTPUT_LEVEL.

Варианты:

  • "debug"
  • "info"
  • "normal" ← (по умолчанию)

output_path

string

Путь к файлу, который будет использоваться для выгрузки объектов конфигурации ACI JSON, созданных модулем.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_OUTPUT_PATH.

password

string

Пароль для аутентификации.

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

Если значение не указано в задаче, вместо него будут использованы значения переменных среды ACI_PASSWORD или ANSIBLE_NET_PASSWORD.

port

integer

Номер порта, который будет использоваться для REST-подключения.

Значение по умолчанию зависит от параметра use_ssl.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_PORT.

private_key

псевдонимы: cert_key

string

Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемое для аутентификации на основе подписи.

Это значение также влияет на значение certificate_name по умолчанию, которое используется.

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

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_PRIVATE_KEY или ANSIBLE_NET_SSH_KEYFILE.

source_port

псевдонимы: src_port

string

Используется для установки начального и конечного портов источника на одно и то же значение, когда ip_protocol имеет значение tcp или udp.

Допустимые значения — любой допустимый диапазон портов TCP/UDP.

APIC по умолчанию использует unspecified при отсутствии значения во время создания.

source_port_end

псевдонимы: src_port_end

string

Используется для установки конечного порта источника, когда ip_protocol имеет значение tcp или udp.

Допустимые значения — любой допустимый диапазон портов TCP/UDP.

APIC по умолчанию использует unspecified при отсутствии значения во время создания.

source_port_start

псевдонимы: src_port_start

string

Используется для установки начального порта источника, когда ip_protocol имеет значение tcp или udp.

Допустимые значения — любой допустимый диапазон портов TCP/UDP.

APIC по умолчанию использует unspecified при отсутствии значения во время создания.

state

string

present, absent, query

Варианты:

  • "absent"
  • "present" ← (по умолчанию)
  • "query"

stateful

boolean

Определяет состояние записи фильтра.

Варианты:

  • false
  • true

suppress_previous

псевдонимы: no_previous, ignore_previous

boolean

Если true, запрос GET для проверки предыдущего состояния не будет отправлен перед обновлением POST в APIC.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_SUPPRESS_PREVIOUS.

Значение по умолчанию — false.

ПРЕДУПРЕЖДЕНИЕ — Это приводит к тому, что предыдущее возвращаемое значение будет пустым.

Предыдущее состояние объекта не будет проверено, и обновление POST будет содержать все свойства.

Варианты:

  • false
  • true

suppress_verification

псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

Если true, подтверждающий запрос GET не будет отправлен после обновления POST в APIC.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_SUPPRESS_VERIFICATION.

Значение по умолчанию — false.

ПРЕДУПРЕЖДЕНИЕ — Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение.

Текущий объект, включая значения по умолчанию, будет непроверяемым в одной задаче.

Варианты:

  • false
  • true

tcp_flags

list / elements=string

Флаги TCP для записи фильтра.

Флаги TCP established не могут быть объединены с другими правилами TCP.

APIC по умолчанию использует значение unspecified при отсутствии явного указания.

Возможные значения:

  • "acknowledgment"
  • "established"
  • "finish"
  • "reset"
  • "synchronize"
  • "unspecified"

tenant

псевдонимы: tenant_name

строка

Имя клиента.

timeout

целое число

Таймаут сокета в секундах.

Если значение не указано в задании, будет использовано значение переменной среды ACI_TIMEOUT.

Значение по умолчанию — 30.

use_proxy

булево

Если false, прокси не будет использоваться, даже если оно определено в переменной окружения на целевых хостах.

Если значение не указано в задании, будет использовано значение переменной среды ACI_USE_PROXY.

Значение по умолчанию — true.

Возможные значения:

  • false
  • true

use_ssl

булево

Если false, будет использоваться HTTP-соединение вместо стандартного HTTPS-соединения.

Если значение не указано в задании, будет использовано значение переменной среды ACI_USE_SSL.

Значение по умолчанию — true, если соединение локальное.

Возможные значения:

  • false
  • true

username

псевдонимы: user

строка

Имя пользователя для аутентификации.

Если значение не указано в задании, будет использовано значение переменных окружения ACI_USERNAME или ANSIBLE_NET_USERNAME.

Значение по умолчанию — admin.

validate_certs

булево

Если false, сертификаты SSL не будут проверены.

Это следует использовать только для сайтов под собственным контролем, использующих самозаверенные сертификаты.

Если значение не указано в задании, будет использовано значение переменной среды ACI_VALIDATE_CERTS.

Значение по умолчанию — true.

Возможные значения:

  • false
  • 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 после завершения работы модуля

Возвращаемое значение: успех

Пример: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

error

словарь

Информация об ошибке, возвращаемая с APIC

Возвращаемое значение: неудача

Пример: {"code": "122", "text": "unknown managed object class foo"}

filter_string

строка

Строка фильтра, используемая для запроса

Возвращаемое значение: неудача или отладка

Пример: "?rsp-prop-include=config-only"

method

строка

HTTP-метод, используемый для запроса к APIC

Возвращаемое значение: неудача или отладка

Пример: "POST"

previous

список / элементы=строка

Исходная конфигурация с APIC до запуска модуля

Возвращаемое значение: информация

Пример: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

словарь

Собранная конфигурация из предоставленных пользователем параметров

Возвращаемое значение: информация

Пример: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}

raw

строка

Необработанный вывод, возвращаемый APIC REST API (xml или json)

Возвращаемое значение: ошибка разбора

Пример: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"

response

строка

HTTP-ответ с APIC

Возвращаемое значение: неудача или отладка

Пример: "OK (30 bytes)"

sent

список / элементы=строка

Фактическая/минимальная конфигурация, отправленная в APIC

Возвращаемое значение: информация

Пример: {"fvTenant": {"attributes": {"descr": "Production environment"}}}

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–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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API