Spec-Zone.ru › Ansible

cisco.aci.aci_l3out_extepg module – Управление объектами профиля экземпляра внешней сети (ExtEpg) (l3ext:InstP)

Примечание

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

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

Чтобы установить ее, используйте: ansible-galaxy collection install cisco.aci.

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

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

Обзор

  • Управление объектами профиля экземпляра внешней сети (ExtEpg) в структурах Cisco ACI.

Параметры

Параметр

Комментарии

annotation

строка

Пользовательская строка для добавления аннотации к объекту.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_ANNOTATION.

Если значение не указано в задаче и переменная окружения ACI_ANNOTATION, будет использовано значение по умолчанию.

По умолчанию: "orchestrator:ansible"

certificate_name

псевдонимы: cert_name

строка

Имя сертификата X.509, привязанного к пользователю APIC AAA, который используется для аутентификации на основе подписи.

Если указано имя файла private_key, по умолчанию используется его базовое имя private_key без расширения.

Если для private_key указано содержимое в формате PEM, по умолчанию используется значение username.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_CERTIFICATE_NAME.

contract_exception_tag

строка

Тег исключения контракта.

description

псевдонимы: descr

строка

Описание ExtEpg.

dscp

псевдонимы: target

строка

Целевое значение Differentiated Services (DSCP).

Если при создании значение не задано, APIC использует значение unspecified.

Допустимые значения:

  • "AF11"
  • "AF12"
  • "AF13"
  • "AF21"
  • "AF22"
  • "AF23"
  • "AF31"
  • "AF32"
  • "AF33"
  • "AF41"
  • "AF42"
  • "AF43"
  • "CS0"
  • "CS1"
  • "CS2"
  • "CS3"
  • "CS4"
  • "CS5"
  • "CS6"
  • "CS7"
  • "EF"
  • "VA"
  • "unspecified"

extepg

псевдонимы: extepg_name, name

строка

Имя создаваемого ExtEpg.

host

псевдонимы: hostname

строка

IP-адрес или имя узла APIC, доступное для разрешения с управляющего узла Ansible.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_HOST.

intra_ext_epg_isolation

строка

Предпочитаемое управление политиками.

Допустимые значения:

  • "enforced"
  • "unenforced"

l3out

псевдонимы: l3out_name

строка

Имя существующего L3Out.

name_alias

строка

Псевдоним текущего объекта. Соответствует полю nameAlias в ACI.

output_level

строка

Определяет вывод этого модуля ACI.

normal означает стандартный вывод, включая словарь current

info добавляет информационный вывод, включая previous, proposed и словари sent

debug добавляет отладочный вывод, включая информацию filter_string, method, response, status и url

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_OUTPUT_LEVEL.

Допустимые значения:

  • "debug"
  • "info"
  • "normal" ← (по умолчанию)

output_path

строка

Путь к файлу, в который будут записываться созданные модулем объекты конфигурации ACI в формате JSON.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_OUTPUT_PATH.

password

строка

Пароль для аутентификации.

Этот параметр взаимоисключающий с private_key. Если также указано private_key, будет использован этот параметр.

Если значение не указано в задаче, вместо него будут использоваться значения переменных окружения ACI_PASSWORD или ANSIBLE_NET_PASSWORD.

port

целое число

Номер порта для REST-подключения.

Значение по умолчанию зависит от параметра use_ssl.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_PORT.

preferred_group

логическое значение

Определяет, входит ли EPG в Preferred Group и может ли обмениваться данными без контрактов.

Это очень удобно при миграции или если ACI используется для автоматизации сети, но не для управления политиками.

Если при создании значение не задано, APIC использует значение false.

Допустимые значения:

  • false
  • true

private_key

псевдонимы: cert_key

строка

Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи.

Это значение также влияет на используемое значение certificate_name по умолчанию.

Этот параметр взаимоисключающий с password. Если также указано password, оно будет проигнорировано.

Если значение не указано в задаче, вместо него будут использоваться значения переменных окружения ACI_PRIVATE_KEY или ANSIBLE_NET_SSH_KEYFILE.

qos_class

строка

Идентификатор класса приоритета.

Допустимые значения:

  • "level1"
  • "level2"
  • "level3" ← (по умолчанию)
  • "level4"
  • "level5"
  • "level6"
  • "unspecified"

route_control_profiles

словарь

Профили управления маршрутами.

export_profile

псевдонимы: export

строка

Профиль управления маршрутами для направления экспорта.

Чтобы удалить политику экспорта маршрутов, передайте пустую строку (см. примеры).

import_profile

псевдонимы: import

строка

Профиль управления маршрутами для направления импорта.

Чтобы удалить политику импорта маршрутов, передайте пустую строку (см. примеры).

state

строка

Используйте present или absent для добавления или удаления.

Используйте query для просмотра одного или нескольких объектов.

Допустимые значения:

  • "absent"
  • "present" ← (по умолчанию)
  • "query"

suppress_previous

псевдонимы: no_previous, ignore_previous

логическое значение

Если true, перед отправкой POST-запроса на обновление в APIC не будет отправлен GET-запрос для проверки предыдущего состояния.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_SUPPRESS_PREVIOUS.

Значение по умолчанию: false.

ПРЕДУПРЕЖДЕНИЕ — это приведет к тому, что возвращаемое предыдущее значение будет пустым.

Предыдущее состояние объекта не будет проверено, а POST-запрос на обновление будет содержать все свойства.

Допустимые значения:

  • false
  • true

suppress_verification

псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

логическое значение

Если true, после отправки POST-запроса на обновление в APIC проверочный GET-запрос отправлен не будет.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_SUPPRESS_VERIFICATION.

Значение по умолчанию: false.

ПРЕДУПРЕЖДЕНИЕ — текущее возвращаемое значение будет установлено в предложенное значение.

Проверить текущий объект, включая значения по умолчанию, в рамках одной задачи будет невозможно.

Допустимые значения:

  • false
  • true

tenant

псевдонимы: tenant_name

строка

Имя существующего арендатора.

timeout

целое число

Тайм-аут на уровне сокета в секундах.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_TIMEOUT.

Значение по умолчанию: 30.

use_proxy

логическое значение

Если false, прокси использоваться не будет, даже если он задан в переменной окружения на целевых узлах.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_USE_PROXY.

Значение по умолчанию: true.

Допустимые значения:

  • false
  • true

use_ssl

логическое значение

Если false, вместо HTTPS-подключения, используемого по умолчанию, будет установлено HTTP-подключение.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_USE_SSL.

При локальном подключении значение по умолчанию — true.

Допустимые значения:

  • false
  • true

username

псевдонимы: user

строка

Имя пользователя для аутентификации.

Если значение не указано в задаче, вместо него будут использоваться значения переменных окружения ACI_USERNAME или ANSIBLE_NET_USERNAME.

Значение по умолчанию: admin.

validate_certs

логическое значение

Если false, SSL-сертификаты проверяться не будут.

Устанавливайте значение false только на контролируемых вами сайтах, использующих самоподписанные сертификаты.

Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения ACI_VALIDATE_CERTS.

Значение по умолчанию: true.

Допустимые значения:

  • false
  • 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 l3extInstP:instP.

Руководство по Cisco ACI

Подробная информация об управлении инфраструктурой ACI с помощью Ansible.

Разработка модулей Cisco ACI

Подробное руководство по созданию собственных модулей Cisco ACI для участия в разработке.

Примеры

- name: Add a new ExtEpg
  cisco.aci.aci_l3out_extepg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    l3out: prod_l3out
    name: prod_extepg
    description: ExtEpg for Production L3Out
    contract_exception_tag: test
    qos_class: level6
    route_control_profiles:
      import_profile: test1
      export_profile: test2
    state: present
  delegate_to: localhost

- name: Delete ExtEpg
  cisco.aci.aci_l3out_extepg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    l3out: prod_l3out
    name: prod_extepg
    state: absent
  delegate_to: localhost

- name: Delete the export route control profile in an ExtEpg
  cisco.aci.aci_l3out_extepg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    l3out: prod_l3out
    name: prod_extepg
    route_control_profiles:
      import_profile: test1
      export_profile: ""
    state: present
  delegate_to: localhost

- name: Query ExtEpg information
  cisco.aci.aci_l3out_extepg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    l3out: prod_l3out
    name: prod_extepg
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ

Описание

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

Необработанный вывод, возвращенный REST API 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

URL HTTP, использованный для запроса к APIC

Возвращается: при сбое или отладке

Пример: "https://10.11.12.13/api/mo/uni/tn-production.json"

Авторы

  • Rostyslav Davydenko (@rost-d)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API