Spec-Zone.ru › Ansible

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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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

строка

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

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

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

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

ap

псевдонимы: app_profile, app_profile_name

строка

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

certificate_name

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

строка

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

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

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

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

deploy_immediacy

строка

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

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

Варианты:

  • "immediate"
  • "lazy"

description

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

строка

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

encap_id

псевдонимы: vlan, vlan_id

целое число

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

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

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

epg

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

строка

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

host

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

строка

IP-адрес или имя хоста, разрешаемые хостом управления Ansible.

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

interface_configs

список / элементы=словарь

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

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

deploy_immediacy

строка

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

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

Варианты:

  • "immediate"
  • "lazy"

description

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

строка

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

encap_id

псевдонимы: vlan, vlan_id

целое число

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

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

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

extpaths

список / элементы=строка

Часть целочисленного значения extpaths в tDn.

extpaths используется только если interface_type — fex, fex_vpc или fex_port_channel.

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

Обычно выглядит как 1011.

interface

строка / обязательно

Часть строкового значения 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 — строка идентификатора лифтовой коммутатора.

Когда interface_type — vpc, тогда leafs — список с идентификаторами обоих лифтовых коммутаторов.

Значение leafs обычно имеет вид ‘101’ или ‘101-102’ в зависимости от connection_type.

pod_id

aliases: pod, pod_number

целое число / обязательно

Номер подсети в части tDn.

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 dict

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

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, GET для проверки предыдущего состояния не будет отправлен перед обновлением POST в APIC.

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

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

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

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

Варианты:

  • false
  • true

suppress_verification

aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

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

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения 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, будет использовано HTTP-соединение вместо стандартного HTTPS-соединения.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения 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 Management Information Model reference

Дополнительная информация о внутренней классе 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

список / элементы=строка

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

Возвращено: успех

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

error

словарь

Информация об ошибке, возвращённая APIC

Возвращено: неудача

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

filter_string

строка

Строка фильтра, используемая для запроса

Возвращено: неудача или отладка

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

method

строка

HTTP-метод, используемый для запроса к APIC

Возвращено: неудача или отладка

Пример: "POST"

previous

список / элементы=строка

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

Возвращено: информация

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

proposed

словарь

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

Возвращено: информация

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

raw

строка

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

строка

HTTP-ответ от APIC

Возвращено: неудача или отладка

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

sent

список / элементы=строка

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

Возвращено: информация

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

status

целое число

HTTP-статус с APIC

Возвращено: неудача или отладка

Пример: 200

url

строка

HTTP-URL, используемый для запроса к APIC

Возвращено: неудача или отладка

Пример: "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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/aci/aci_bulk_static_binding_to_epg_module.html

Spec-Zone.ru

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