Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_switch_policy_vpc_protection_group – Управление явными группами защиты vPC политики коммутатора (fabric:ExplicitGEp и fabric:NodePEp).

Примечание

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

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

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

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

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

Описание

  • Управление явными группами защиты vPC политики коммутатора на Cisco ACI фабриках.

Параметры

Параметр

Комментарии

annotation

string

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

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

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

Default: "orchestrator:ansible"

certificate_name

aliases: cert_name

string

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

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

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

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

host

aliases: hostname

string

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

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

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

aliases: cert_key

string

Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемое для аутентификации на основе подписи.

Это значение также влияет на используемый certificate_name по умолчанию.

Эта опция взаимоисключающая с password. Если также предоставлен password, он будет проигнорирован.

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

protection_group

aliases: name, protection_group_name

string

Имя явной группы защиты vPC.

protection_group_id

aliases: id

integer

Идентификатор явной группы защиты vPC.

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

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

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

ПРЕДУПРЕЖДЕНИЕ - Это приводит к установке текущего возвращаемого значения в предложенное значение.

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

Варианты:

  • false
  • true

switch_1_id

integer

ID первого коммутатора Leaf для явного vPC Protection Group.

switch_2_id

integer

ID второго коммутатора Leaf для явного vPC Protection Group.

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

aliases: user

string

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

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

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

validate_certs

boolean

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

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

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

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

Варианты:

  • false
  • true

vpc_domain_policy

aliases: vpc_domain_policy_name

string

Политика домена vPC, которая должна быть связана с явным vPC Protection Group.

См. также

См. также

cisco.aci.aci_switch_policy_leaf_profile

Управление профилями коммутаторов Leaf политики (infra:NodeP).

APIC Management Information Model reference

Дополнительная информация о внутренних классах APIC fabric:ExplicitGEp и fabric:NodePEp.

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

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

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

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

Примеры

- name: Add vPC Protection Group
  cisco.aci.aci_switch_policy_vpc_protection_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    protection_group: leafPair101-vpcGrp
    protection_group_id: 6
    switch_1_id: 1011
    switch_2_id: 1012
    state: present
  delegate_to: localhost

- name: Remove Explicit vPC Protection Group
  cisco.aci.aci_switch_policy_vpc_protection_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    protection_group: leafPair101-vpcGrp
    state: absent
  delegate_to: localhost

- name: Query vPC Protection Groups
  cisco.aci.aci_switch_policy_vpc_protection_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query our vPC Protection Group
  cisco.aci.aci_switch_policy_vpc_protection_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    protection_group: leafPair101-vpcGrp
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ

Описание

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"

Авторы

  • Bruno Calogero (@brunocalogero)

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

  • Система отслеживания ошибок
  • Репозиторий (источники)

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

Spec-Zone.ru

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