Модуль cisco.aci.aci_esg_ip_subnet_selector — Управление выбором подсети ESG IP (fv:EPSelector)

Примечание

Этот модуль является частью коллекции cisco.aci (версия 2.10.1).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

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

Чтобы использовать её в playbook, укажите: cisco.aci.aci_esg_ip_subnet_selector.

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

Обзор

Управление выбором подсети IP для Групп защиты конечных точек (ESG) на Cisco ACI fabric.

Параметры

Параметр	Комментарии
annotation строка	Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, используется значение переменной окружения `ACI_ANNOTATION`. Если значение не указано в задаче и переменной окружения `ACI_ANNOTATION`, используется значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
ap псевдонимы: app_profile, app_profile_name строка	Название профиля приложения.
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл `private_key`, значение по умолчанию — имя файла `private_key`, без расширения. Если для `private_key` был предоставлен контент в формате PEM, значение по умолчанию — значение `username`. Если значение не указано в задаче, используется значение переменной окружения `ACI_CERTIFICATE_NAME`.
description псевдонимы: ip_subnet_selector_description строка	Описание селектора подсети ESG IP.
esg псевдонимы: esg_name строка	Имя группы безопасности конечных точек.
host псевдонимы: hostname строка	IP-адрес или имя хоста, разрешаемого хостом управления Ansible. Если значение не указано в задаче, используется значение переменной окружения `ACI_HOST`.
ip псевдонимы: subnet строка	IP-адрес селектора подсети.
name_alias строка	Псевдоним текущего объекта. Связан с полем nameAlias в ACI.
output_level строка	Влияет на вывод модуля ACI. `normal` означает стандартный вывод, включая `current` dict `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` dicts `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию Если значение не указано в задаче, используется значение переменной окружения `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
output_path строка	Путь к файлу, который будет использоваться для вывода объектов конфигурации ACI JSON, сгенерированных модулем. Если значение не указано в задаче, используется значение переменной окружения `ACI_OUTPUT_PATH`.
password строка	Пароль для аутентификации. Этот параметр взаимно исключает `private_key`. Если также указан `private_key`, он будет использован вместо него. Если значение не указано в задаче, используются значения переменных окружения `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число	Номер порта, используемый для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, используется значение переменной окружения `ACI_PORT`.
private_key псевдонимы: cert_key строка	Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемые для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимно исключает `password`. Если `password` также указан, он будет проигнорирован. Если значение не указано в задаче, используются значения переменных окружения `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
state строка	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`

suppress_previous aliases: no_previous, ignore_previous boolean	Если `true`, GET-запрос для проверки предыдущего значения не будет отправлен перед POST-обновлением в APIC. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию `false`. ПРЕДУПРЕЖДЕНИЕ - Это приведет к пустому возвращаемому значению предыдущего состояния. Предыдущее состояние объекта не будет проверено, и POST-обновление будет содержать все свойства. Варианты: `false` `true`
suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, проверяющий GET-запрос не будет отправлен после POST-обновления в APIC. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию `false`. ПРЕДУПРЕЖДЕНИЕ - Это приведет к тому, что текущее возвращаемое значение будет установлено в предложенное значение. Текущий объект, включая значения по умолчанию, не будет проверяем в одной задаче. Варианты: `false` `true`
tenant aliases: tenant_name string	Имя арендатора.
timeout integer	Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию 30.
use_proxy boolean	Если `false`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_USE_PROXY`. Значение по умолчанию true. Варианты: `false` `true`
use_ssl boolean	Если `false`, будет использоваться HTTP-соединение вместо стандартного HTTPS-соединения. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_USE_SSL`. Значение по умолчанию true, когда соединение локальное. Варианты: `false` `true`
username aliases: user string	Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию admin.
validate_certs boolean	Если `false`, сертификаты SSL не будут проверены. Это следует устанавливать только в `false` при использовании на контролируемых вами сайтах с самозаверяющимися сертификатами. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию true. Варианты: `false` `true`

См. также

cisco.aci.aci_esg: Управление объектами Групп безопасности конечных точек (ESG) (fv:ESg).
Manage Endpoint Security Groups (ESGs) objects (fv:ESg): Управление группами безопасности конечных точек (ESG) на Cisco ACI-матрицах.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей ACI-инфраструктурой с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для вклада.

Примеры

- name: Add an IP subnet selector
  cisco.aci.aci_esg_tag_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: production_ap
    esg: web_esg
    ip: "10.0.0.0"
    description: "IP Subnet Selector Description"
    state: present
  delegate_to: localhost

- name: Query all IP subnet selector
  cisco.aci.aci_esg_tag_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Remove an IP subnet selector
  cisco.aci.aci_esg_tag_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: production_ap
    esg: web_esg
    ip: "10.0.0.0"
    state: absent
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
current list / elements=string	Существующая конфигурация из APIC после завершения работы модуля Возвращается: success Пример: `[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
error dictionary	Информация об ошибке, возвращаемая APIC Возвращается: failure Пример: `{"code": "122", "text": "unknown managed object class foo"}`
filter_string string	Строка фильтра, используемая для запроса Возвращается: failure или debug Пример: `"?rsp-prop-include=config-only"`
method string	HTTP-метод, используемый для запроса к APIC Возвращается: failure или debug Пример: `"POST"`
previous list / elements=string	Оригинальная конфигурация из APIC до начала работы модуля Возвращается: info Пример: `[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
proposed dictionary	Собранная конфигурация из параметров, предоставленных пользователем Возвращается: info Пример: `{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}`
raw string	Необработанный вывод, возвращаемый API REST APIC (xml или json) Возвращается: parse error Пример: `"<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"`
response string	HTTP-ответ от APIC Возвращается: failure или debug Пример: `"OK (30 bytes)"`
sent list / elements=string	Фактическая/минимальная конфигурация, отправленная в APIC Возвращается: info Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status integer	HTTP-статус от APIC Возвращается: failure или debug Пример: `200`
url string	HTTP-url, используемый для запроса к APIC Возвращается: failure или debug Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Sabari Jaganathan (@sajagana)

Ссылки на коллекцию

© 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_esg_ip_subnet_selector_module.html