Spec-Zone.ru › Ansible

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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

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

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

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

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

  • Управление селектором IP-подсети групп безопасности конечных точек (ESG) в инфраструктурах Cisco ACI.

Параметры

Параметр

Комментарии

annotation

string

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

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

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

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

ap

псевдонимы: app_profile, app_profile_name

string

Имя профиля приложения.

certificate_name

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

string

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

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

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

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

description

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

string

Описание селектора IP-подсети ESG.

esg

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

string

Имя группы безопасности конечных точек.

host

псевдоним: hostname

string

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

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

ip

псевдоним: subnet

string

IP-адрес селектора подсети.

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.

state

string

Для добавления или удаления используйте present или absent.

Для получения списка одного или нескольких объектов используйте query.

Варианты:

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

suppress_previous

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

boolean

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

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

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

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

Предыдущее состояние объекта проверяться не будет, а запрос 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

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

См. также

См. также

cisco.aci.aci_esg

Управление объектами групп безопасности конечных точек (ESG) (fv:ESg).

Управление объектами групп безопасности конечных точек (ESG) (fv:ESg)

Управление группами безопасности конечных точек (ESG) в инфраструктурах Cisco ACI.

Руководство по Cisco ACI

Подробная информация об управлении инфраструктурой ACI с помощью Ansible.

Разработка модулей Cisco ACI

Подробное руководство по созданию собственных модулей Cisco ACI для участия в разработке.

Примеры

- name: Add an IP subnet selector
  cisco.aci.aci_esg_ip_subnet_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 one IP subnet selector
  cisco.aci.aci_esg_ip_subnet_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: production_ap
    esg: web_esg
    ip: "10.0.0.0"
    state: query
  delegate_to: localhost

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

- name: Remove an IP subnet selector
  cisco.aci.aci_esg_ip_subnet_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 после завершения работы модуля

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

Пример: [{"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"

Авторы

  • Sabari Jaganathan (@sajagana)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/aci/aci_esg_ip_subnet_selector_module.html

Spec-Zone.ru

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