Модуль cisco.aci.aci_interface_description — Установка и удаление описания физических интерфейсов (infra:HPathS, infra:RsHPathAtt, infra:SHPathS и infra:RsSHPathAtt)

Примечание

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

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

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

Для использования в книге задач укажите: cisco.aci.aci_interface_description.

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

Обзор

Установка и удаление описания физических интерфейсов на Cisco 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 string	`description` который должен быть прикреплен к `interface`.
fex_id integer	ID FEX, к которому принадлежит `interface`. Значение `fex_id` обычно выглядит как «123».
host aliases: hostname string	IP-адрес или имя хоста APIC, разрешаемые узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_HOST`.
interface string	Имя `interface`, на который нацелен модуль. Обычно имя интерфейса со следующим форматом `1/7`.
node_id aliases: leaf, spine, node integer	ID коммутатора, к которому принадлежит `interface`. Значение `node_id` обычно выглядит как «101».
node_type string	Тип узла, на котором настроен `interface`. Варианты: `"leaf"` `"spine"`
output_level string	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая словари `previous`, `proposed` и `sent` `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`.
pod_id aliases: pod, pod_number integer	Номер pod. `pod_id` обычно является целым числом меньше `12`
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 псевдонимы: no_previous, ignore_previous boolean	Если `true`, запрос GET для проверки предыдущего состояния не будет отправлен перед обновлением POST в APIC. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — Это приводит к тому, что предыдущее возвращаемое значение становится пустым. Предыдущее состояние объекта не будет проверяться, и обновление POST будет содержать все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: 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 псевдонимы: user string	Имя пользователя для аутентификации. Если значение не указано в задаче, будут использованы значения переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию — admin.
validate_certs boolean	Если `false`, сертификаты SSL не будут проверены. Это следует устанавливать в `false` только при работе с сайтами, управляемыми пользователем, с самозаверенными сертификатами. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию — true. Варианты: `false` `true`

См. также

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

Примеры

- name: Set Interface Description
  cisco.aci.aci_interface_description:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: false
    pod_id: 1
    node_id: 105
    node_type: leaf
    interface: 1/49
    description: foobar
    state: present
  delegate_to: localhost

- name: Remove Interface Description
  cisco.aci.aci_interface_description:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: false
    pod_id: 1
    node_id: 105
    node_type: leaf
    interface: 1/49
    description: foobar
    state: absent
  delegate_to: localhost

- name: Set Interface Description on Fex
  cisco.aci.aci_interface_description:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: false
    pod_id: 1
    node_id: 105
    fex_id: 123
    interface: 1/49
    description: foobar
    state: present
  delegate_to: localhost

- name: Remove Interface Description on Fex
  cisco.aci.aci_interface_description:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: false
    pod_id: 1
    node_id: 105
    fex_id: 123
    interface: 1/49
    description: foobar
    state: absent
  delegate_to: localhost

- name: Query Interface
  cisco.aci.aci_interface_description:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    validate_certs: false
    pod_id: 1
    node_id: 105
    node_type: leaf
    interface: 1/49
    state: query
  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 строка	Необработанный вывод, возвращённый 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"`

Авторы

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_interface_description_module.html