Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_access_switch_policy_group — управление группами политик коммутаторов доступа (infra:AccNodePGrp и infra:SpineAccNodePGrp).

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.aci.

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

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

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

  • Управление группами политик коммутаторов доступа в фабриках Cisco ACI.

Параметры

Параметр

Комментарии

annotation

string

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

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

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

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

bfd_ipv4_policy

string

Политика BFD IPv4, привязанная к группе политик коммутатора доступа.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

bfd_ipv6_policy

string

Политика BFD IPv6, привязанная к группе политик коммутатора доступа.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

bfd_multihop_ipv4_policy

string

Политика BFD IPv4 для нескольких переходов, привязанная к группе политик коммутатора доступа.

Доступно только в APIC версии 5.x или более поздней.

Доступно только при switch_type=leaf.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

bfd_multihop_ipv6_policy

string

Политика BFD IPv6 для нескольких переходов, привязанная к группе политик коммутатора доступа.

Доступно только в APIC версии 5.x или более поздней.

Доступно только при switch_type=leaf.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

cdp_policy

string

Политика CDP, привязанная к группе политик коммутатора доступа.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

certificate_name

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

string

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

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

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

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

copp_policy

string

Политика CoPP, привязанная к группе политик коммутатора доступа.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

copp_pre_filter_policy

string

Политика предварительной фильтрации CoPP, привязанная к группе политик коммутатора доступа.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

description

string

Описание группы политик коммутатора доступа.

equipment_flash_policy

string

Политика флеш-памяти оборудования, привязанная к группе политик коммутатора доступа.

Доступно только при switch_type=leaf.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

fast_link_failover_policy

string

Политика быстрого переключения при отказе канала, привязанная к группе политик коммутатора доступа.

Доступно только при switch_type=leaf.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

fibre_channel_node_policy

string

Политика узла Fibre Channel, привязанная к группе политик коммутатора доступа.

Доступно только при switch_type=leaf.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

fibre_channel_san_policy

string

Политика SAN Fibre Channel, привязанная к группе политик коммутатора доступа.

Доступно только при switch_type=leaf.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

forward_scale_profile_policy

string

Политика профиля масштабирования пересылки, привязанная к группе политик коммутатора доступа.

Доступно только при switch_type=leaf.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

host

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

string

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

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

lldp_policy

string

Политика LLDP, привязанная к группе политик коммутатора доступа.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

monitoring_policy

string

Политика мониторинга, привязанная к группе политик коммутатора доступа.

Доступно только при switch_type=leaf.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

name

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

string

Имя группы политик коммутатора доступа.

netflow_node_policy

string

Политика узла NetFlow, привязанная к группе политик коммутатора доступа.

Доступно только при switch_type=leaf.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

node_802_1x_authentication_policy

string

Политика аутентификации узла 802.1x, привязанная к группе политик коммутатора доступа.

Доступно только при switch_type=leaf.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

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.

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.

poe_node_policy

string

Политика узла PoE, привязанная к группе политик коммутатора доступа.

Доступно только при switch_type=leaf.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

port

integer

Номер порта для REST-подключения.

Значение по умолчанию зависит от параметра use_ssl.

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

private_key

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

string

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

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

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

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

ptp_node_policy

string

Политика узла PTP, привязанная к группе политик коммутатора доступа.

Доступно только в APIC версии 5.2 или более поздней.

Доступно только при switch_type=leaf.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

spanning_tree_policy

string

Политика связующего дерева, привязанная к группе политик коммутатора доступа.

Доступно только в APIC версии 5.2 или более поздней.

Доступно только при switch_type=leaf.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

state

string

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

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

Варианты:

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

suppress_previous

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

boolean

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

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

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

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

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

switch_type

string / обязательный

Определяет, является ли эта группа политик группой политик для leaf- или spine-коммутатора.

Варианты:

  • "leaf"
  • "spine"

sync_e_node_policy

string

Политика узла SyncE, привязанная к группе политик коммутатора доступа.

Доступно только в APIC версии 5.x или более поздней.

Доступно только при switch_type=leaf.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

timeout

integer

Тайм-аут на уровне сокета в секундах.

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

Значение по умолчанию: 30.

usb_configuration_policy

string

Политика конфигурации USB, привязанная к группе политик коммутатора доступа.

Доступно только в APIC версии 5.2 или более поздней.

По умолчанию APIC использует "", в результате чего при создании, если значение не задано, целевой DN устанавливается в соответствии с политикой по умолчанию.

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

См. также

См. также

Справочник по информационной модели управления APIC

Дополнительные сведения о внутренних классах APIC infra:AccNodePGrp и infra:SpineAccNodePGrp.

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

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

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

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

Примеры

- name: Create Leaf Access Switch Policy Group
  cisco.aci.aci_access_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ansible_pol_grp_spine
    switch_type: leaf
    spanning_tree_policy: example_spanning_tree_policy
    bfd_ipv4_policy: example_bfd_ipv4_policy
    bfd_ipv6_policy: example_bfd_ipv6_policy
    fibre_channel_node_policy: example_fibre_channel_node_policy
    poe_node_policy: example_poe_node_policy
    fibre_channel_san_policy: example_fibre_channel_san_policy
    monitoring_policy: example_monitoring_policy
    copp_policy: example_copp_policy
    forward_scale_profile_policy: example_forward_scale_profile_policy
    fast_link_failover_policy: example_fast_link_failover_policy
    node_802_1x_authentication_policy: example_node_802_1x_authentication_policy
    copp_pre_filter_policy: example_copp_pre_filter_policy
    equipment_flash_policy: example_equipment_flash_policy
    cdp_policy: example_cdp_policy
    lldp_policy: example_lldp_policy
    state: present
  delegate_to: localhost

- name: Create Spine Access Switch Policy Group
  cisco.aci.aci_access_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ansible_pol_grp_leaf
    switch_type: spine
    bfd_ipv4_policy: example_bfd_ipv4_policy
    bfd_ipv6_policy: example_bfd_ipv6_policy
    copp_policy: example_copp_policy
    copp_pre_filter_policy: example_copp_pre_filter_policy
    cdp_policy: example_cdp_policy
    lldp_policy: example_lldp_policy
    state: present
  delegate_to: localhost

- name: Delete Leaf Access Switch Policy Group
  cisco.aci.aci_access_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ansible_pol_grp_leaf
    switch_type: leaf
    state: absent
  delegate_to: localhost

- name: Query Leaf Access Switch Policy Group
  cisco.aci.aci_access_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ansible_pol_grp_leaf
    switch_type: leaf
    state: query
  delegate_to: localhost
  register: query_result

- name: Query All Leaf Access Switch Policy Groups
  cisco.aci.aci_access_switch_policy_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    switch_type: leaf
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ

Описание

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 \"/></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"

Авторы

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

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

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

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

Spec-Zone.ru

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