Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_access_spine_switch_selector — Управление политикой доступа к ткани для портов коммутаторов Spine (infra:SpineS)

Примечание

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

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

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

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

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

Обзор

  • Управление политикой доступа к ткани для портов коммутаторов Spine на 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.

description

string

Описание селектора порта коммутатора spine.

host

aliases: hostname

string

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

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

output_level

string

Влияет на вывод этого модуля ACI.

normal означает стандартный вывод, включая словарь current

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

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.

policy_group

aliases: policy_group_name

string

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

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.

selector_type

aliases: type

string

Тип селектора порта хоста.

При использовании блока портов для указания диапазона коммутаторов тип должен быть установлен в range.

Choices:

  • "all"
  • "range"

spine_switch_profile

aliases: spine_switch_profile_name, switch_profile, switch_profile_name

string

Имя профиля коммутатора spine политики доступа к структуре.

spine_switch_selector

aliases: name, spine_switch_selector_name, switch_selector, switch_selector_name, access_port_selector, access_port_selector_name

строка

Имя селектора портов коммутатора Fabric Access Spine.

state

строка

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

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

Варианты:

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

suppress_previous

aliases: no_previous, ignore_previous

булево

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

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

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

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

Предыдущее состояние объекта не будет проверяться, и обновление POST будет содержать все свойства.

Варианты:

  • false
  • true

suppress_verification

aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

булево

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

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

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

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

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

Варианты:

  • false
  • true

timeout

целое число

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

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

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

use_proxy

булево

Если false, прокси не будет использоваться, даже если он определён в переменной окружения на целевых узлах.

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

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

Варианты:

  • false
  • true

use_ssl

булево

Если false, будет использоваться HTTP-соединение вместо стандартного HTTPS-соединения.

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

Значение по умолчанию true, когда соединение локальное.

Варианты:

  • false
  • true

username

aliases: user

строка

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

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

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

validate_certs

булево

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

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

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

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

Варианты:

  • false
  • true

Примечания

Примечание

  • spine_switch_profile должен существовать перед использованием данного модуля в вашем плейбуке. Для этого можно использовать модуль cisco.aci.aci_access_spine_switch_profile.
  • Если используется policy_group, он должен существовать перед использованием данного модуля в вашем плейбуке. Для этого можно использовать модуль cisco.aci.aci_switch_policy_group.

См. также

См. также

cisco.aci.aci_access_spine_switch_profile

Управление профилями коммутаторов Fabric Access Spine (infra:SpineP).

APIC Management Information Model reference

Дополнительная информация о внутренних классах APIC infra:SpineS и infra:RsAccNodePGrp.

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

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

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

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

Примеры

- name: Add a switch policy spine profile selector (with policy group)
  cisco.aci.aci_access_spine_switch_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    spine_switch_profile: sw_name
    spine_switch_selector: spine_selector_name
    selector_type: range
    policy_group: somepolicygroupname
    state: present
  delegate_to: localhost

- name: Query a switch policy spine profile selector
  cisco.aci.aci_access_spine_switch_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    spine_switch_profile: sw_name
    spine_switch_selector: spine_selector_name
    selector_type: range
    state: query
  delegate_to: localhost

- name: Query all switch policy spine profile selectors
  cisco.aci.aci_access_spine_switch_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Remove a switch policy spine profile selector
  cisco.aci.aci_access_spine_switch_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    spine_switch_profile: sw_name
    spine_switch_selector: spine_selector_name
    selector_type: range
    state: absent
  delegate_to: localhost

Значения возврата

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

Ключ

Описание

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

строка

Необработанный вывод, возвращённый REST API APIC (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-адрес, используемый для запроса к APIC

Возвращено: неудача или отладка

Пример: "https://10.11.12.13/api/mo/uni/tn-production.json"

Авторы

  • Эрик Жирар (@netgirard)
  • Гаспар Миколь (@gmicol)

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

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

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

Spec-Zone.ru

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