Модуль cisco.aci.aci_fabric_pod_selector — Управление селекторами Fabric Pod (fabric:PodS)

Примечание

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

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

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

Чтобы использовать в книге задач, укажите: cisco.aci.aci_fabric_pod_selector.

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

Обзор

Управление селекторами Fabric Pod на тканях Cisco ACI.

Параметры

Параметр	Комментарии
annotation string	Пользовательская строка для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменной среды `ACI_ANNOTATION`, будет использовано значение по умолчанию. Default: `"orchestrator:ansible"`
blocks aliases: pod_id, pod_id_range string	Идентификатор(ы) pod, связанный(ые) с селектором Pod. Существующие блоки будут удалены, если они не соответствуют предоставленным блокам. Строка, разделенная запятыми, идентификаторов pod или диапазонов идентификаторов pod. (например, 1,3-4)
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	Описание для селектора Fabric Pod.
host aliases: hostname string	IP-адрес или имя хоста APIC, распознаваемое узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_HOST`.
name aliases: selector, pod_selector string	Имя селектора Pod.
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`. Choices: `"debug"` `"info"` `"normal"` ← (default)
output_path string	Путь к файлу, который будет использоваться для выгрузки объектов конфигурации ACI JSON, созданных модулем. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OUTPUT_PATH`.
owner_key string	Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет ключ для предоставления клиентам права владения своими данными для корреляции сущностей. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OWNER_KEY`.
owner_tag string	Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет тег, позволяющий клиентам добавлять собственные данные. Например, для указания того, кто создал этот объект. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OWNER_TAG`.
password string	Пароль, используемый для аутентификации. Этот параметр является взаимоисключающим с `private_key`. Если также предоставлен `private_key`, он будет использоваться вместо него. Если значение не указано в задаче, вместо него будет использовано значение переменных среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
pod_profile string	Имя профиля Pod, содержащего селектор.
policy_group string	Группа политик Fabric для привязки к этому селектору Pod. Укажите пустую строку `""` для удаления привязки группы политик Fabric.
port integer	Номер порта, который будет использоваться для соединения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PORT`.
private_key aliases: 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`, 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`
timeout целое число	Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию 30.
type строка	Тип селектора подсети. Варианты: `"all"` `"range"`
use_proxy boolean	Если `false`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_USE_PROXY`. Значение по умолчанию true. Варианты: `false` `true`
use_ssl boolean	Если `false`, будет использовано HTTP-соединение вместо стандартного HTTPS-соединения. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_USE_SSL`. Значение по умолчанию true при локальном соединении. Варианты: `false` `true`
username псевдонимы: user строка	Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию admin.
validate_certs boolean	Если `false`, сертификаты SSL не будут проверены. Это следует установить в `false` только при работе с сайтами, контролируемыми лично, использующими самозаверяющие сертификаты. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию true. Варианты: `false` `true`

Примечания

Примечание

Перед использованием данного модуля в вашем плане необходимо, чтобы pod_profile существовал.
Модуль cisco.aci.aci_fabric_pod_profile может быть использован для создания pod_profile.

См. также

APIC Management Information Model reference: Дополнительная информация о внутренней APIC-классе fabric:PodS.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей ACI-инфраструктурой с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Add a new pod selector with type all
  cisco.aci.aci_fabric_pod_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    pod_profile: default
    name: ans_pod_selector
    type: all
    policy_group: ansible_policy_group
    state: present
  delegate_to: localhost

- name: Add a new pod selector with type range and blocks
  cisco.aci.aci_fabric_pod_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    pod_profile: default
    name: ans_pod_selector
    type: range
    blocks: 1,3-4
    policy_group: ansible_policy_group
    state: present
  delegate_to: localhost

- name: Remove a policy_group from an existing pod selector
  cisco.aci.aci_fabric_pod_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    pod_profile: default
    type: all
    name: ans_pod_selector
    policy_group: ""
    state: present
  delegate_to: localhost

- name: Remove a pod selector type all
  cisco.aci.aci_fabric_pod_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    pod_profile: default
    type: all
    name: ans_pod_selector
    state: absent
  delegate_to: localhost

- name: Remove a pod selector type range
  cisco.aci.aci_fabric_pod_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    pod_profile: default
    type: range
    name: ans_pod_selector
    state: absent
  delegate_to: localhost

- name: Query a pod selector
  cisco.aci.aci_fabric_pod_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    pod_profile: default
    name: ans_pod_selector
    type: all
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all pod selectors
  cisco.aci.aci_fabric_pod_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    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"`

Авторы

Tim Cragg (@timcragg)
Akini Ross (@akinross)

Ссылки на сборку

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