Модуль cisco.aci.aci_fabric_spine_profile – Управление профилями спины ткани (fabric:SpineP)

Примечание

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

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

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

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

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

Обзор

Управление профилями спины коммутаторов ткани в ткани ACI.

Параметры

Параметр	Комментарии
annotation string	Пользовательская строка для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменной среды `ACI_ANNOTATION`, будет использовано значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
certificate_name aliases: cert_name string	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указано имя файла `private_key`, значение по умолчанию будет равно базовому имени `private_key`, без расширения. Если для `private_key` указано содержимое в формате PEM, значение по умолчанию будет равно `username`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`.
description aliases: descr string	Описание профиля
host aliases: hostname string	IP-адрес или имя хоста APIC, распознаваемое узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_HOST`.
name aliases: spine_profile, spine_switch_profile string	Имя профиля коммутатора fabric spine
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`.
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` для перечисления одного или нескольких объектов. Варианты: `"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`
timeout integer	Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_TIMEOUT`. Значение по умолчанию - 30.
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 Management Information Model reference: Дополнительная информация о внутреннем классе APIC fabricSpineP.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Create a spine switch profile
  cisco.aci.aci_fabric_spine_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_spine_profile
    state: present
  delegate_to: localhost

- name: Remove a spine switch profile
  cisco.aci.aci_fabric_spine_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_spine_profile
    state: absent
  delegate_to: localhost

- name: Query a spine profile
  cisco.aci.aci_fabric_spine_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: my_spine_profile
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all spine profiles
  cisco.aci.aci_fabric_spine_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    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 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"`

Авторы

Tim Cragg (@timcragg)

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

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