cisco.aci.aci_fabric_node – Управление членами узла Fabric (fabric:NodeIdentP)

Примечание

Этот плагин является частью коллекции cisco.aci (версия 1.1.1).

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

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

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

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

Управление членами узла Fabric в сетях Cisco ACI.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
annotation строка		Определяемая пользователем строка для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_ANNOTATION`.
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указан файл `private_key`, это значение по умолчанию будет базовым именем `private_key`, без расширения. Если для `private_key` предоставлено содержимое в формате PEM, это значение по умолчанию будет `username`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_CERTIFICATE_NAME`. псевдонимы: cert_name
description строка		Описание для нового члена узла Fabric. псевдонимы: descr
host строка / обязательно		IP-адрес или имя узла APIC, распознаваемые узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_HOST`. псевдонимы: hostname
name_alias строка		Псевдоним для текущего объекта. Это относится к полю nameAlias в ACI.
node_id целое число		Номер ID узла для нового члена узла Fabric.
output_level строка	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая словари `previous`, `proposed` и `sent` `debug` добавляет отладочный вывод, включая информацию `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_OUTPUT_LEVEL`.
output_path строка		Путь к файлу, который будет использоваться для выгрузки объектов конфигурации ACI JSON, созданных модулем. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_OUTPUT_PATH`.
owner_key строка		Определяемая пользователем строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ для предоставления клиентам права владения своими данными для корреляции сущностей. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_OWNER_KEY`.
owner_tag строка		Определяемая пользователем строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой тег, позволяющий клиентам добавлять собственные данные. Например, для указания того, кто создал этот объект. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_OWNER_TAG`.
password строка		Пароль, используемый для аутентификации. Этот параметр взаимоисключающий с `private_key`. Если также предоставлен `private_key`, он будет использован вместо этого. Если значение не указано в задаче, вместо него будет использовано значение переменных окружения `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
pod_id целое число		ID подсети для нового члена узла Fabric.
port целое число		Номер порта, используемый для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_PORT`.
private_key строка		Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на используемое значение `certificate_name` по умолчанию. Этот параметр взаимоисключающий с `password`. Если также предоставлен `password`, он будет проигнорирован. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_PRIVATE_KEY`. псевдонимы: cert_key
role строка	Варианты: leaf spine unspecified	Роль для нового члена узла Fabric. псевдонимы: role_name
serial строка		Серийный номер для нового члена узла Fabric. псевдонимы: serial_number
state строка	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов.
switch строка		Имя коммутатора для нового члена узла Fabric. псевдонимы: name, switch_name
timeout целое число	Значение по умолчанию: 30	Тайм-аут на уровне сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_TIMEOUT`.
use_proxy логическое	Варианты: no yes ←	Если `no`, он не будет использовать прокси-сервер, даже если он определен в переменной среды на целевых узлах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_USE_PROXY`.
use_ssl логическое	Варианты: no yes ←	Если `no`, будет использоваться HTTP-соединение вместо соединения HTTPS по умолчанию. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_USE_SSL`.
username строка	Значение по умолчанию: "admin"	Имя пользователя, используемое для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. псевдонимы: user
validate_certs логическое	Варианты: no yes ←	Если `no`, SSL-сертификаты не будут проверяться. Это следует устанавливать в `no` только при использовании на лично контролируемых сайтах с самозаверяющими сертификатами. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_VALIDATE_CERTS`.

См. также

Справочник по модели информации управления APIC: Дополнительная информация о внутреннем классе APIC fabric:NodeIdentP.
Руководство по Cisco ACI: Подробная информация о том, как управлять инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство о том, как писать собственные модули Cisco ACI для внесения вклада.

Примеры

- name: Add fabric node
  cisco.aci.aci_fabric_node:
    host: apic
    username: admin
    password: SomeSecretPassword
    serial: FDO2031124L
    node_id: 1011
    switch: fab4-sw1011
    state: present
  delegate_to: localhost

- name: Remove fabric node
  cisco.aci.aci_fabric_node:
    host: apic
    username: admin
    password: SomeSecretPassword
    serial: FDO2031124L
    node_id: 1011
    state: absent
  delegate_to: localhost

- name: Query fabric nodes
  cisco.aci.aci_fabric_node:
    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 строка	ошибка разбора	Необработанный вывод, возвращаемый APIC REST API (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

Авторы

Bruno Calogero (@brunocalogero)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/aci/aci_fabric_node_module.html