Модуль cisco.aci.aci_interface_config – управление конфигурацией интерфейсов портов доступа (infra:PortConfig) и портов фабрики (fabric:PortConfig); поддерживается только для ACI 5.2(7)+
Примечание
Этот модуль входит в коллекцию cisco.aci (версия 2.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install cisco.aci.
Чтобы использовать её в плейбуке, укажите: cisco.aci.aci_interface_config.
Краткое описание
- Управление конфигурацией интерфейсов портов доступа (infra:PortConfig) и портов фабрики (fabric:PortConfig); поддерживается только для ACI 5.2(7)+
Параметры
Параметр | Комментарии |
|---|---|
admin_state string | Состояние интерфейса, заданное администратором. При создании, если значение не задано, APIC устанавливает состояние up. Варианты:
|
annotation string | Определяемая пользователем строка для добавления аннотации к объекту. Если значение не указано в задаче, вместо него используется значение переменной окружения Если значение не указано в задаче и переменная окружения По умолчанию: |
breakout string | Карта разделения интерфейса. Параметры policy_group и breakout нельзя настроить одновременно. Варианты:
|
certificate_name псевдонимы: cert_name string | Имя сертификата X.509, связанного с пользователем APIC AAA, используемого для аутентификации на основе подписи. Если указано имя файла Если для Если значение не указано в задаче, вместо него используется значение переменной окружения |
description псевдонимы: descr string | Описание объекта конфигурации интерфейса. |
host псевдонимы: hostname string | IP-адрес или имя узла APIC, доступное для разрешения с управляющего узла Ansible. Если значение не указано в задаче, вместо него используется значение переменной окружения |
interface string | Адрес интерфейса. Формат значения интерфейса: 1/1/1 (карта/идентификатор порта/подпорт) или 1/1 (карта/идентификатор порта). Идентификатор карты должен находиться в диапазоне от 1 до 255. Идентификатор порта должен находиться в диапазоне от 1 до 128. Идентификатор под порта должен находиться в диапазоне от 0 до 64. |
interface_type string | Тип интерфейса. Варианты:
|
node псевдонимы: node_id integer | Идентификатор узла. Значение должно находиться в диапазоне от 101 до 4000. |
output_level string | Управляет выводом этого модуля ACI.
Если значение не указано в задаче, вместо него используется значение переменной окружения Варианты:
|
output_path string | Путь к файлу, в который будут записаны объекты конфигурации ACI в формате JSON, созданные модулем. Если значение не указано в задаче, вместо него используется значение переменной окружения |
owner_key string | Определяемая пользователем строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ, позволяющий клиентам владеть своими данными для сопоставления сущностей. Если значение не указано в задаче, вместо него используется значение переменной окружения |
owner_tag string | Определяемая пользователем строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой метку, позволяющую клиентам добавлять собственные данные. Например, чтобы указать, кто создал этот объект. Если значение не указано в задаче, вместо него используется значение переменной окружения |
password string | Пароль для аутентификации. Этот параметр несовместим с Если значение не указано в задаче, вместо него будут использоваться значения переменных окружения |
pc_member псевдонимы: port_channel_member string | Имя политики участника Port Channel (lacp:IfPol). Политика участника Port Channel используется для переопределения приоритета порта LACP и скорости передачи пакетов LACP. |
policy_group псевдонимы: policy_group_name string | Имя группы политик, связываемой с портом. Параметры policy_group и breakout нельзя настроить одновременно. |
port integer | Номер порта для REST-подключения. Значение по умолчанию зависит от параметра Если значение не указано в задаче, вместо него используется значение переменной окружения |
port_type string | Тип интерфейса: порт доступа или порт фабрики. Варианты:
|
private_key псевдонимы: cert_key string | Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на значение Этот параметр несовместим с Если значение не указано в задаче, вместо него будут использоваться значения переменных окружения |
role псевдонимы: node_type string | Роль коммутатора (узла): leaf или spine. При создании, если значение не задано, APIC устанавливает роль leaf. Варианты:
|
state string | Для добавления или удаления используйте Для просмотра одного или нескольких объектов используйте Варианты:
|
suppress_previous псевдонимы: no_previous, ignore_previous boolean | Если Если значение не указано в задаче, вместо него используется значение переменной окружения Значение по умолчанию: ПРЕДУПРЕЖДЕНИЕ — возвращаемое значение previous будет пустым. Предыдущее состояние объекта не будет проверяться, а POST-запрос на обновление будет содержать все свойства. Варианты:
|
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean | Если Если значение не указано в задаче, вместо него используется значение переменной окружения Значение по умолчанию: ПРЕДУПРЕЖДЕНИЕ — текущим возвращаемым значением будет заданное предлагаемое значение. Текущий объект, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи. Варианты:
|
timeout integer | Тайм-аут на уровне сокета в секундах. Если значение не указано в задаче, вместо него используется значение переменной окружения Значение по умолчанию: 30. |
use_proxy boolean | Если Если значение не указано в задаче, вместо него используется значение переменной окружения Значение по умолчанию: true. Варианты:
|
use_ssl boolean | Если Если значение не указано в задаче, вместо него используется значение переменной окружения При локальном подключении значение по умолчанию: true. Варианты:
|
username псевдонимы: user string | Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будут использоваться значения переменных окружения Значение по умолчанию: admin. |
validate_certs boolean | Если Устанавливайте значение Если значение не указано в задаче, вместо него используется значение переменной окружения Значение по умолчанию: 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: pc_or_vpc
policy_group: ans_test_port_channel
node: 502
interface: "2/2/2"
state: present
delegate_to: localhost
- name: Add an interface with port channel(PC) policy group with a PC member policy override
cisco.aci.aci_interface_config:
host: apic
username: admin
password: SomeSecretPassword
role: leaf
port_type: access
interface_type: pc_or_vpc
policy_group: ans_test_port_channel
pc_member: ans_test_pc_member_policy
node: 502
interface: "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 после завершения работы модуля Возвращается: success Пример: |
error dictionary | Информация об ошибке, возвращённая APIC Возвращается: failure Пример: |
filter_string string | Строка фильтра, использованная для запроса Возвращается: failure or debug Пример: |
method string | Метод HTTP, использованный для запроса к APIC Возвращается: failure or debug Пример: |
previous list / elements=string | Исходная конфигурация APIC до запуска модуля Возвращается: info Пример: |
proposed dictionary | Сформированная конфигурация на основе параметров, предоставленных пользователем Возвращается: info Пример: |
raw string | Исходные данные, возвращённые REST API APIC (xml или json) Возвращается: parse error Пример: |
response string | Ответ HTTP от APIC Возвращается: failure or debug Пример: |
sent list / elements=string | Фактическая/минимальная конфигурация, отправленная в APIC Возвращается: info Пример: |
status integer | Статус HTTP от APIC Возвращается: failure or debug Пример: |
url string | URL HTTP, использованный для запроса к APIC Возвращается: failure or debug Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/aci/aci_interface_config_module.html