Spec-Zone.ru › Ansible

модуль cisco.aci.aci_bulk_static_binding_to_epg — Привязка статических путей к EPG (fv:RsPathAtt)

Примечание

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

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

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

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

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

Краткое описание

  • Привязывает статические пути к EPG в фабриках Cisco ACI.

Параметры

Параметр

Комментарии

annotation

string

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

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

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

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

ap

aliases: app_profile, app_profile_name

string

Имя профиля приложения.

certificate_name

aliases: cert_name

string

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

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

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

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

deploy_immediacy

string

Немедленность развертывания статической EPG на PC, VPC или интерфейсе.

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

Варианты:

  • "immediate"
  • "lazy"

description

aliases: descr

string

Описание привязки статического пути к EPG.

encap_id

aliases: vlan, vlan_id

integer

Идентификатор инкапсуляции, связывающий epg с путем интерфейса.

При использовании микросегментации он выступает в качестве вторичного encap_id.

Допустимы любые допустимые идентификаторы инкапсуляции для указанной инкапсуляции; в настоящее время диапазон — от 1 до 4096.

epg

aliases: epg_name

string

Имя группы конечных точек.

host

aliases: hostname

string

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

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

interface_configs

list / elements=dictionary

Список конфигураций интерфейсов; элементы представлены в виде словарей.

Атрибуты уровня модуля переопределяются атрибутами уровня пути.

deploy_immediacy

string

Немедленность развертывания статической EPG на PC, VPC или интерфейсе.

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

Варианты:

  • "immediate"
  • "lazy"

description

aliases: descr

string

Описание привязки статического пути к EPG.

encap_id

aliases: vlan, vlan_id

integer

Идентификатор инкапсуляции, связывающий epg с путем интерфейса.

При использовании микросегментации он выступает в качестве вторичного encap_id.

Допустимы любые допустимые идентификаторы инкапсуляции для указанной инкапсуляции; в настоящее время диапазон — от 1 до 4096.

extpaths

list / elements=string

Целочисленная часть extpaths значения tDn.

extpaths используется только в том случае, если interface_type имеет значение fex, fex_vpc или fex_port_channel.

Если interface_type имеет значение fex_vpc, то extpaths — это список с обоими идентификаторами FEX.

Обычно это значение выглядит примерно так: 1011.

interface

string / обязательный

Строковая часть interface значения tDn.

Обычно это группа политик, например test-IntPolGrp, или интерфейс в следующем формате: 1/7, в зависимости от interface_type.

interface_mode

aliases: interface_mode_name, mode

string

Определяет, как теги уровня 2 считываются из кадров и добавляются в них.

Значения 802.1p и native идентичны.

Значения access и untagged идентичны.

Значения regular, tagged и trunk идентичны.

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

Варианты:

  • "802.1p"
  • "access"
  • "native"
  • "regular"
  • "tagged"
  • "trunk"
  • "untagged"

interface_type

string

Тип интерфейса для развертывания статической EPG.

Варианты:

  • "fex"
  • "port_channel"
  • "switch_port"
  • "vpc"
  • "fex_port_channel"
  • "fex_vpc"

leafs

aliases: leaves, nodes, paths, switches

list / elements=string / обязательный

Идентификатор(ы) коммутатора, которому принадлежит interface.

Если interface_type имеет значение switch_port, port_channel или fex, то leafs — это строка с идентификатором leaf-коммутатора.

Если interface_type имеет значение vpc, то leafs — это список с обоими идентификаторами leaf-коммутаторов.

Значение leafs обычно выглядит примерно так: «101» или «101-102», в зависимости от connection_type.

pod_id

aliases: pod, pod_number

integer / обязательный

Часть tDn, содержащая номер pod.

pod_id обычно представляет собой целое число меньше 10.

primary_encap_id

aliases: primary_vlan, primary_vlan_id

string

Определяет основной идентификатор инкапсуляции, связывающий epg с путем интерфейса при использовании микросегментации.

Допустимы любые допустимые идентификаторы инкапсуляции для указанной инкапсуляции; в настоящее время диапазон — от 1 до 4096 и unknown.

unknown — значение по умолчанию; использование unknown отключает микросегментацию.

interface_mode

aliases: interface_mode_name, mode

string

Определяет, как теги уровня 2 считываются из кадров и добавляются в них.

Значения 802.1p и native идентичны.

Значения access и untagged идентичны.

Значения regular, tagged и trunk идентичны.

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

Варианты:

  • "802.1p"
  • "access"
  • "native"
  • "regular"
  • "tagged"
  • "trunk"
  • "untagged"

interface_type

string

Тип интерфейса для развертывания статической EPG.

Варианты:

  • "fex"
  • "port_channel"
  • "switch_port" ← (по умолчанию)
  • "vpc"
  • "fex_port_channel"
  • "fex_vpc"

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.

password

string

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

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

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

port

integer

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

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

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

primary_encap_id

aliases: primary_vlan, primary_vlan_id

string

Определяет основной идентификатор инкапсуляции, связывающий epg с путем интерфейса при использовании микросегментации.

Допустимы любые допустимые идентификаторы инкапсуляции для указанной инкапсуляции; в настоящее время диапазон — от 1 до 4096 и unknown.

unknown — значение по умолчанию; использование unknown отключает микросегментацию.

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

aliases: no_previous, ignore_previous

boolean

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

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

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

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

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

Варианты:

  • false
  • true

suppress_verification

aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

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

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

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

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

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

Варианты:

  • false
  • true

tenant

aliases: tenant_name

string

Имя арендатора.

timeout

integer

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

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

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

use_proxy

boolean

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

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

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

Варианты:

  • false
  • true

use_ssl

boolean

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

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

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

Варианты:

  • false
  • true

username

aliases: user

string

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

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

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

validate_certs

boolean

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

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

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

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

Варианты:

  • false
  • true

Примечания

Примечание

  • Объекты tenant, ap, epg должны существовать до использования этого модуля в вашем плейбуке. Для этого можно использовать модули cisco.aci.aci_tenant, cisco.aci.aci_ap, cisco.aci.aci_epg.

См. также

См. также

cisco.aci.aci_tenant

Управление арендаторами (fv:Tenant).

cisco.aci.aci_ap

Управление объектами профилей приложений верхнего уровня (AP) (fv:Ap).

cisco.aci.aci_epg

Управление объектами групп конечных точек (EPG) (fv:AEPg).

Справочник модели управления информацией APIC

Дополнительная информация о внутреннем классе APIC fv:RsPathAtt.

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

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

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

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

Примеры

- name: Create list of interfaces using module level attributes
  cisco.aci.aci_bulk_static_binding_to_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: accessport-code-cert
    ap: accessport_code_app
    epg: accessport_epg1
    encap_id: 221
    interface_mode: trunk
    deploy_immediacy: lazy
    description: "Module level attributes used to create interfaces"
    interface_configs:
      - interface: 1/7
        leafs: 101
        pod: 1
      - interface: 1/7
        leafs: 107
        pod: 7
      - interface: 1/8
        leafs: 108
        pod: 8
        encap_id: 108
    state: present
  delegate_to: localhost

- name: Create/Update list of interfaces using path level attributes
  cisco.aci.aci_bulk_static_binding_to_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: accessport-code-cert
    ap: accessport_code_app
    epg: accessport_epg1
    interface_configs:
      - interface: 1/7
        leafs: 101
        pod: 1
        encap_id: 221
        interface_mode: trunk
        deploy_immediacy: lazy
        description: "Path level attributes used to create/update interfaces"
      - interface: 1/7
        leafs: 107
        pod: 7
        encap_id: 221
        interface_mode: trunk
        deploy_immediacy: lazy
        description: "Path level attributes used to create/update interfaces"
      - interface: 1/8
        leafs: 108
        pod: 8
        encap_id: 108
        interface_mode: trunk
        deploy_immediacy: lazy
        description: "Path level attributes used to create/update interfaces"
    state: present
  delegate_to: localhost

- name: Query all interfaces of an EPG
  cisco.aci.aci_bulk_static_binding_to_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: accessport-code-cert
    ap: accessport_code_app
    epg: accessport_epg1
    state: query
  delegate_to: localhost

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

- name: Remove list of interfaces
  cisco.aci.aci_bulk_static_binding_to_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: accessport-code-cert
    ap: accessport_code_app
    epg: accessport_epg1
    encap_id: 221
    interface_mode: trunk
    deploy_immediacy: lazy
    interface_configs:
      - interface: 1/7
        leafs: 101
        pod: 1
      - interface: 1/7
        leafs: 107
        pod: 7
      - interface: 1/8
        leafs: 108
        pod: 8
        encap_id: 108
    state: absent
  delegate_to: localhost

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

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

Ключ

Описание

current

list / elements=string

Текущая конфигурация из APIC после завершения работы модуля

Возвращается: success

Пример: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

error

dictionary

Сведения об ошибке, возвращённые APIC

Возвращается: failure

Пример: {"code": "122", "text": "unknown managed object class foo"}

filter_string

string

Строка фильтра, использованная для запроса

Возвращается: failure or debug

Пример: "?rsp-prop-include=config-only"

method

string

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

Возвращается: failure or debug

Пример: "POST"

previous

list / elements=string

Исходная конфигурация из APIC до запуска модуля

Возвращается: info

Пример: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

dictionary

Сформированная конфигурация на основе параметров, предоставленных пользователем

Возвращается: info

Пример: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}

raw

string

Необработанный вывод, возвращённый REST API APIC (xml или json)

Возвращается: parse error

Пример: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"

response

string

Ответ HTTP от APIC

Возвращается: failure or debug

Пример: "OK (30 bytes)"

sent

list / elements=string

Фактическая/минимальная конфигурация, отправленная в APIC

Возвращается: info

Пример: {"fvTenant": {"attributes": {"descr": "Production environment"}}}

status

integer

Статус HTTP от APIC

Возвращается: failure or debug

Пример: 200

url

string

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

Возвращается: failure or debug

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

Авторы

  • Bruno Calogero (@brunocalogero)
  • Marcel Zehnder (@maercu)
  • Sabari Jaganathan (@sajagana)

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

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

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

Spec-Zone.ru

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