Модуль cisco.aci.aci_access_spine_interface_profile_to_spine_switch_profile – Привязка профилей интерфейсов доступа Spine к профилям коммутаторов Spine Fabric (infra:RsSpAccPortP)

Примечание

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

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

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

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

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

Описание

Привязка профилей селекторов интерфейсов доступа Spine к профилям политики коммутаторов доступа Spine на Cisco ACI fabric.

Параметры

Параметр	Комментарии
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`.
interface_profile aliases: interface_profile_name, spine_interface_profile, spine_interface_profile_name string	Имя профиля интерфейса Fabric Access Spine, который будет добавлен и связан с профилем коммутатора Spine.
output_level string	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` dict `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` dict `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`.
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`.
state string	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления одного объекта или нескольких объектов. Choices: `"absent"` `"present"` ← (default) `"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_profile aliases: switch_profile_name, spine_switch_profile, spine_switch_profile_name string	Имя профиля Fabric Access Spine Switch, к которому добавляется профиль Spine Interface Selector.
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`

Примечания

Примечание

Для этого модуля требуется существующий профиль switch_profile. Для этого можно использовать модуль cisco.aci.aci_access_spine_switch_profile.
Профиль interface_profile принимает имена профилей интерфейсов спины, которые могут не существовать. Они отображаются в интерфейсе APIC с состоянием «missing-target». Для их создания можно использовать модуль cisco.aci.aci_access_spine_interface_profile.

См. также

cisco.aci.aci_access_spine_switch_profile: Управление профилями Fabric Access Spine Switch (infra:SpineP).
cisco.aci.aci_access_spine_interface_profile: Управление профилями политики интерфейсов ткани спины (infra:SpAccPortP).
APIC Management Information Model reference: Дополнительная информация об внутренней APIC-классе infra:RsSpAccPortP.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой Cisco ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Associating an interface selector profile to a switch policy spine profile
  cisco.aci.aci_access_spine_interface_profile_to_spine_switch_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    switch_profile: sw_name
    interface_profile: interface_profile_name
    state: present
  delegate_to: localhost

- name: Query an interface selector profile associated with a switch policy spine profile
  cisco.aci.aci_access_spine_interface_profile_to_spine_switch_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    switch_profile: sw_name
    interface_profile: interface_profile_name
    state: query
  delegate_to: localhost

- name: Query all association of interface selector profiles with a switch policy spine profile
  cisco.aci.aci_access_spine_interface_profile_to_spine_switch_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Remove an interface selector profile associated with a switch policy spine profile
  cisco.aci.aci_access_spine_interface_profile_to_spine_switch_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    switch_profile: sw_name
    interface_profile: interface_profile_name
    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 строка	Необработанный вывод, возвращенный API REST 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-URL, используемый для запроса к 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_interface_profile_to_spine_switch_profile_module.html