Spec-Zone.ru › Ansible

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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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, то будет использовано значение по умолчанию.

Default: "orchestrator:ansible"

bfd_ipv4_policy

string

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

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

bfd_ipv6_policy

string

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

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

bfd_multihop_ipv4_policy

string

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

Доступно только в версии APIC 5.x и выше.

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

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

bfd_multihop_ipv6_policy

string

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

Доступно только в версии APIC 5.x и выше.

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

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

cdp_policy

string

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

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

certificate_name

aliases: cert_name

string

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

Если указано имя файла 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

aliases: hostname

string

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

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

lldp_policy

string

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

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

monitoring_policy

string

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

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

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

name

aliases: 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 dict

info добавляет информационный вывод, включая previous, proposed и sent dicts

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

aliases: 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

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

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

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

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

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

switch_type

string / required

Является ли это группой политик уровня доступа или уровня магистрали

Варианты:

  • "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, будет использоваться 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 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

список / элементы=строка

Существующая конфигурация из 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-адрес, используемый для запроса к 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_access_switch_policy_group_module.html

Spec-Zone.ru

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