Модуль cisco.aci.aci_fabric_pod_policy_group – Управление группами политики подсетей Fabric (fabric:PodPGrp)

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.aci.aci_fabric_pod_policy_group.

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

Обзор

Настройка группы политики подсети Fabric (fabric:PodPGrp) на тканях Cisco ACI.

Параметры

Параметр	Комментарии
annotation строка	Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, используется значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменной среды `ACI_ANNOTATION`, используется значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
bgp_rr_policy строка	Политика BGP маршрутизатора-отражателя для привязки к группе политик
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если предоставлено имя файла `private_key`, по умолчанию используется имя файла `private_key`, без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, используется значение переменной среды `ACI_CERTIFICATE_NAME`.
coop_group_policy псевдонимы: coop_policy строка	Политика группы COOP для привязки к группе политик
date_time_policy псевдонимы: ntp_policy строка	Политика NTP для привязки к группе политик
host псевдонимы: hostname строка	IP-адрес или имя хоста, разрешимые хостом Ansible. Если значение не указано в задаче, используется значение переменной среды `ACI_HOST`.
isis_policy строка	Политика IS-IS для привязки к группе политик
macsec_policy строка	Политика MACSec для привязки к группе политик
management_access_policy псевдонимы: management_policy, mgmt_policy строка	Политика управления доступом для привязки к группе политик
name псевдонимы: policy_group, policy_group_name, pod_policy_group строка	Имя группы политик
name_alias строка	Псевдоним для текущего объекта. Связан с полем nameAlias в ACI.
output_level строка	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` словари `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию. Если значение не указано в задаче, используется значение переменной среды `ACI_OUTPUT_LEVEL`. Доступные значения: `"debug"` `"info"` `"normal"` ← (по умолчанию)
output_path строка	Путь к файлу, который будет использоваться для выгрузки объектов конфигурации ACI JSON, сгенерированных модулем. Если значение не указано в задаче, используется значение переменной среды `ACI_OUTPUT_PATH`.
owner_key строка	Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ для предоставления клиентам возможности владения своими данными для корреляции сущностей. Если значение не указано в задаче, используется значение переменной среды `ACI_OWNER_KEY`.
owner_tag строка	Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой тег, позволяющий клиентам добавлять свои собственные данные. Например, для указания того, кто создал этот объект. Если значение не указано в задаче, используется значение переменной среды `ACI_OWNER_TAG`.
password строка	Пароль для аутентификации. Этот параметр взаимоисключающий с `private_key`. Если также предоставлен `private_key`, он будет использован вместо этого. Если значение не указано в задаче, используется значение переменных среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число	Номер порта, используемый для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, используется значение переменной среды `ACI_PORT`.

private_key aliases: cert_key string	Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на значение `certificate_name` по умолчанию, которое используется. Эта опция является взаимоисключающей с `password`. Если `password` также предоставлено, оно будет проигнорировано. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
snmp_policy string	Политика SNMP для привязки к группе политик
state string	Используйте `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`
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`

См. также

Справочник по модели информации управления APIC: Дополнительная информация о внутреннем классе APIC fabricPodPGrp.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство о том, как написать собственные модули Cisco ACI для внесения вклада.

Примеры

- name: Add a new fabric pod policy group
  cisco.aci.aci_fabric_pod_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_pod_pol_grp
    snmp_policy: my_snmp_pol
    bgp_rr_policy: my_bgp_rr_pol
    state: present
  delegate_to: localhost

- name: Remove a fabric pod policy group
  cisco.aci.aci_fabric_pod_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_pod_pol_grp
    state: absent
  delegate_to: localhost

- name: Query a fabric pod policy group
  cisco.aci.aci_fabric_pod_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_pod_pol_grp
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all fabric pod policy groups
  cisco.aci.aci_fabric_pod_policy_group:
    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 строка	Необработанный вывод, возвращенный API REST APIC (xml или json) Возвращено: ошибка парсинга Пример: `"<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class \"/></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)

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

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