Модуль cisco.aci.aci_interface_config — Управление конфигурацией интерфейсов доступа (infra:PortConfig) и интерфейсов Fabric (fabric:PortConfig) поддерживается только для ACI 5.2(7)+

Примечание

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

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

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

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

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

Описание

Управление конфигурацией интерфейсов доступа (infra:PortConfig) и интерфейсов Fabric (fabric:PortConfig) поддерживается только для ACI 5.2(7)+

Параметры

Параметр	Комментарии
admin_state string	Административное состояние интерфейса. APIC по умолчанию устанавливает значение «включено», если оно не задано при создании. Варианты: `"up"` `"down"`
annotation string	Строка, определяемая пользователем, для аннотирования объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменной среды `ACI_ANNOTATION`, будет использовано значение по умолчанию. Значение по умолчанию: `"orchestrator:ansible"`
breakout string	Схема Breakout для интерфейса. Параметры policy_group и breakout не могут быть настроены одновременно. Варианты: `"100g-2x"` `"100g-4x"` `"10g-4x"` `"25g-4x"` `"50g-8x"`
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`.
interface string	Адрес интерфейса. Формат значения интерфейса должен быть 1/1/1 (плата/номер_порта/подпорт) или 1/1 (плата/номер_порта). Номер платы должен быть в диапазоне от 1 до 64. Номер порта должен быть в диапазоне от 1 до 128. Номер подпорта должен быть в диапазоне от 0 до 16
interface_type string	Тип интерфейса. Варианты: `"switch_port"` ← (по умолчанию) `"pc_or_vpc"` `"fc"` `"fc_port_channel"` `"leaf_fabric"` `"spine_access"` `"spine_fabric"`
node aliases: node_id integer	Идентификатор узла. Значение должно быть в диапазоне от 101 до 4000.
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`.
pc_member aliases: port_channel_member string	Имя участника канала портов.

policy_group aliases: policy_group_name строка	Название группы политик, которая связывается с портом. Параметры policy_group и breakout не могут быть сконфигурированы одновременно.
port целое число	Номер порта, используемый для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_PORT`.
port_type строка	Тип интерфейса может быть либо access, либо fabric. Выборы: `"access"` ← (по умолчанию) `"fabric"`
private_key aliases: cert_key строка	Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимоисключающий с `password`. Если `password` также предоставлен, он будет проигнорирован. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
role aliases: node_type строка	Роль коммутатора (узла) может быть либо leaf, либо spine. APIC по умолчанию устанавливает роль leaf, если она не задана при создании. Выборы: `"leaf"` `"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`

См. также

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

Примеры

- name: Add an interface with port channel(PC) policy group
  cisco.aci.aci_interface_config:
    host: apic
    username: admin
    password: SomeSecretPassword
    role: leaf
    port_type: access
    interface_type: port_channel
    policy_group: ans_test_port_channel
    node: 502
    interface: "2/2/2"
    state: present
  delegate_to: localhost

- name: Breakout the existing interface with "100g-4x"
  cisco.aci.aci_interface_config:
    host: apic
    username: admin
    password: SomeSecretPassword
    role: leaf
    port_type: access
    node: 502
    interface: "2/2/2"
    breakout: "100g-4x"
    state: present
  delegate_to: localhost

- name: Query an access interface with node id
  cisco.aci.aci_interface_config:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_type: access
    node: 201
    state: query
  delegate_to: localhost

- name: Query a fabric interface with node id
  cisco.aci.aci_interface_config:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_type: fabric
    node: 202
    state: query
  delegate_to: localhost

- name: Query all access interfaces
  cisco.aci.aci_interface_config:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_type: access
    state: query
  delegate_to: localhost

- name: Query all fabric interfaces
  cisco.aci.aci_interface_config:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_type: fabric
    state: query
  delegate_to: localhost

- name: Remove a interface
  cisco.aci.aci_interface_config:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_type: access
    node: 201
    interface: "1/1/1"
    state: absent
  delegate_to: localhost

Возвращаемые значения

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

Ключ	Описание
current list / elements=string	Существующая конфигурация из APIC после завершения работы модуля Возвращается: успех Пример: `[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
error dictionary	Информация об ошибке, возвращаемая APIC Возвращается: ошибка Пример: `{"code": "122", "text": "unknown managed object class foo"}`
filter_string string	Строка фильтра, используемая для запроса Возвращается: ошибка или отладка Пример: `"?rsp-prop-include=config-only"`
method string	Метод HTTP, используемый для запроса к APIC Возвращается: ошибка или отладка Пример: `"POST"`
previous list / elements=string	Оригинальная конфигурация из APIC до начала работы модуля Возвращается: информация Пример: `[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
proposed dictionary	Собранная конфигурация из параметров, предоставленных пользователем Возвращается: информация Пример: `{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}`
raw string	Необработанный вывод, возвращаемый 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 string	HTTP-ответ от APIC Возвращается: ошибка или отладка Пример: `"OK (30 bytes)"`
sent list / elements=string	Фактическая/минимальная конфигурация, отправленная в APIC Возвращается: информация Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status integer	HTTP-статус от APIC Возвращается: ошибка или отладка Пример: `200`
url string	HTTP-url, используемый для запроса к APIC Возвращается: ошибка или отладка Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Sabari Jaganathan (@sajagana)

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

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