Модуль cisco.aci.aci_l3out_extsubnet — управление объектами внешних подсетей (l3ext:Subnet)
Примечание
Этот модуль входит в коллекцию cisco.aci (версия 2.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.aci.
Чтобы использовать коллекцию в плейбуке, укажите: cisco.aci.aci_l3out_extsubnet.
Краткое описание
- Управление объектами внешних подсетей.
Параметры
Параметр | Комментарии |
|---|---|
aggregate list / elements=string | Определяет агрегируемые маршруты для подсети. Параметр Параметр Параметр Параметр Управление импортом агрегированных маршрутов доступно, только если для L3Out включен параметр «Принудительное применение управления импортом маршрутов». По умолчанию он отключен; для его включения можно использовать модуль cisco.aci.aci_l3out с параметром Варианты:
|
annotation string | Пользовательская строка для добавления аннотации к объекту. Если значение не указано в задаче, вместо него будет использовано значение переменной среды Если значение не указано ни в задаче, ни в переменной среды По умолчанию: |
certificate_name псевдонимы: cert_name string | Имя сертификата X.509, привязанного к пользователю APIC AAA и используемого для аутентификации на основе подписи. Если указано имя файла Если для Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
description псевдонимы: descr string | Описание внешней подсети. |
extepg псевдонимы: extepg_name string / обязательный | Имя существующей ExtEpg. |
host псевдонимы: hostname string | IP-адрес или имя узла APIC, разрешаемое управляющим узлом Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
l3out псевдонимы: l3out_name string / обязательный | Имя существующего L3Out. |
name_alias string | Псевдоним текущего объекта. Соответствует полю nameAlias в ACI. |
network псевдонимы: address, ip string | Сетевой адрес подсети. |
output_level string | Управляет выводом этого модуля ACI.
Если значение не указано в задаче, вместо него будет использовано значение переменной среды Варианты:
|
output_path string | Путь к файлу, в который будут записаны созданные модулем объекты конфигурации ACI в формате JSON. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
password string | Пароль для аутентификации. Этот параметр несовместим с Если значение не указано в задаче, вместо него будет использовано значение одной из переменных среды: |
port integer | Номер порта для REST-подключения. Значение по умолчанию зависит от параметра Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
private_key псевдонимы: cert_key string | Файл закрытого ключа в формате PEM либо содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на используемое значение Этот параметр несовместим с Если значение не указано в задаче, вместо него будет использовано значение одной из переменных среды: |
scope list / elements=string | Определяет область действия подсети. Параметр Параметр Параметр Параметр Параметр Если при создании значение не задано, APIC использует Параметр Варианты:
|
state string | Используйте Используйте Варианты:
|
subnet_name псевдонимы: name string | Имя создаваемой внешней подсети. |
suppress_previous псевдонимы: no_previous, ignore_previous boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной среды Значение по умолчанию — ПРЕДУПРЕЖДЕНИЕ — это приведет к тому, что предыдущее возвращаемое значение будет пустым. Предыдущее состояние объекта проверяться не будет, а POST-запрос на обновление будет содержать все свойства. Варианты:
|
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной среды Значение по умолчанию — ПРЕДУПРЕЖДЕНИЕ — это приведет к тому, что в качестве текущего возвращаемого значения будет установлено предложенное значение. Текущее состояние объекта, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи. Варианты:
|
tenant псевдонимы: tenant_name string / обязательный | Имя существующего арендатора. |
timeout integer | Тайм-аут на уровне сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды Значение по умолчанию — 30. |
use_proxy boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной среды Значение по умолчанию — true. Варианты:
|
use_ssl boolean | Если Если значение не указано в задаче, вместо него будет использовано значение переменной среды При локальном подключении значение по умолчанию — true. Варианты:
|
username псевдонимы: user string | Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение одной из переменных среды: Значение по умолчанию — admin. |
validate_certs boolean | Если Значение Если значение не указано в задаче, вместо него будет использовано значение переменной среды Значение по умолчанию — true. Варианты:
|
Примечания
Примечание
- Перед использованием этого модуля в плейбуке должны существовать
tenant,domainиvrf. Для этого можно использовать модули cisco.aci.aci_tenant, cisco.aci.aci_domain и cisco.aci.aci_vrf.
См. также
См. также
- cisco.aci.aci_tenant
-
Управление арендаторами (fv:Tenant).
- cisco.aci.aci_domain
-
Управление профилями физических, виртуальных, коммутируемых, маршрутизируемых доменов и доменов FC (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP и fc:DomP).
- cisco.aci.aci_vrf
-
Управление контекстами или VRF (fv:Ctx).
- Справочник информационной модели управления APIC
-
Дополнительная информация о внутреннем классе APIC l3ext:Subnet.
- Руководство по Cisco ACI
-
Подробная информация об управлении инфраструктурой ACI с помощью Ansible.
- Разработка модулей Cisco ACI
-
Подробное руководство по созданию собственных модулей Cisco ACI для участия в разработке.
Примеры
- name: Add a new External Subnet
cisco.aci.aci_l3out_extsubnet:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
l3out: prod_l3out
extepg: prod_extepg
description: External Subnet for Production ExtEpg
network: 192.0.2.0/24
scope: export-rtctrl
aggregate: export-rtctrl
state: present
delegate_to: localhost
- name: Delete External Subnet
cisco.aci.aci_l3out_extsubnet:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
l3out: prod_l3out
extepg: prod_extepg
network: 192.0.2.0/24
state: absent
delegate_to: localhost
- name: Query ExtEpg Subnet information
cisco.aci.aci_l3out_extsubnet:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
l3out: prod_l3out
extepg: prod_extepg
network: 192.0.2.0/24
state: query
delegate_to: localhost
register: query_result
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
current list / elements=string | Существующая конфигурация из APIC после завершения работы модуля Возвращается: success Пример: |
error dictionary | Информация об ошибке, возвращённая APIC Возвращается: failure Пример: |
filter_string string | Строка фильтра, использованная для запроса Возвращается: failure или debug Пример: |
method string | Метод HTTP, использованный для запроса к APIC Возвращается: failure или debug Пример: |
previous list / elements=string | Исходная конфигурация из APIC до запуска модуля Возвращается: info Пример: |
proposed dictionary | Собранная конфигурация на основе параметров, предоставленных пользователем Возвращается: info Пример: |
raw string | Исходный вывод, возвращённый REST API APIC (xml или json) Возвращается: parse error Пример: |
response string | Ответ HTTP от APIC Возвращается: failure или debug Пример: |
sent list / elements=string | Фактическая/минимальная конфигурация, отправленная в APIC Возвращается: info Пример: |
status integer | Статус HTTP от APIC Возвращается: failure или debug Пример: |
url string | URL HTTP, использованный для запроса к APIC Возвращается: failure или 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_l3out_extsubnet_module.html