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

annotation

string

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

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

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

По умолчанию: "orchestrator:ansible"

arp_flag

string

Флаг ARP, используемый, если ether_type имеет значение arp.

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

Варианты:

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

certificate_name

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

string

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

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

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

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

description

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

string

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

destination_port

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

string

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

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

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

destination_port_end

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

string

Задает конечный порт назначения, если ip_protocol имеет значение tcp или udp.

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

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

destination_port_start

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

string

Задает начальный порт назначения, если ip_protocol имеет значение tcp или udp.

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

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

entry

псевдонимы: entry_name, filter_entry, name

string

Название записи фильтра.

ether_type

string

Тип Ethernet.

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

Варианты:

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

filter

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

string

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

host

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

string

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

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

icmp6_msg_type

string

Тип сообщения ICMPv6; используется, если ip_protocol имеет значение icmpv6.

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

Варианты:

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

icmp_msg_type

string

Тип сообщения ICMPv4; используется, если ip_protocol имеет значение icmp.

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

Варианты:

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

ip_protocol

string

Тип протокола IP, если ether_type имеет значение ip.

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

Варианты:

• "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

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

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, перед отправкой POST-запроса на обновление в APIC не будет отправляться GET-запрос для проверки предыдущего состояния.

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

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

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

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

Варианты:

• false
• true

suppress_verification

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

boolean

Если true, после POST-запроса на обновление в APIC не будет отправляться проверочный GET-запрос.

Если значение не указано в задаче, вместо него будет использоваться значение переменной среды 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

string

Имя арендатора.

timeout

integer

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

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

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

use_proxy

boolean

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

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

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

Варианты:

• false
• true

use_ssl

boolean

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

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

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

Варианты:

• false
• true

username

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

string

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

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

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

validate_certs

boolean

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

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

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

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

Варианты:

• false
• true

current

list / elements=string

Текущая конфигурация APIC после завершения работы модуля

Возвращается: при успехе

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

error

dictionary

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

Возвращается: при сбое

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

filter_string

string

Строка фильтра, использованная для запроса

Возвращается: при сбое или в режиме отладки

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

method

string

Метод HTTP, использованный для запроса к APIC

Возвращается: при сбое или в режиме отладки

Пример: "POST"

previous

list / elements=string

Исходная конфигурация APIC до начала работы модуля

Возвращается: при выводе сведений

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

proposed

dictionary

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

Возвращается: при выводе сведений

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

raw

string

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

Возвращается: при ошибке разбора

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

response

string

Ответ HTTP от APIC

Возвращается: при сбое или в режиме отладки

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

sent

list / elements=string

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

Возвращается: при выводе сведений

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

status

integer

Статус HTTP от APIC

Возвращается: при сбое или в режиме отладки

Пример: 200

url

string

URL HTTP, использованный для запроса к APIC

Возвращается: при сбое или в режиме отладки

Пример: "https://10.11.12.13/api/mo/uni/tn-production.json"