Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_l3out_floating_svi_path – Управление атрибутами пути плавающего SVI внешнего уровня 3 (L3Out) (l3ext:RsDynPathAtt)

Примечание

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

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

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

Для использования в книге задач укажите: cisco.aci.aci_l3out_floating_svi_path.

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

Обзор

  • Управляет атрибутами пути плавающего SVI внешнего уровня 3 (L3Out) на фэбрах Cisco ACI.

Параметры

Параметр

Комментарии

access_encap

строка

Вариант инкапсуляции порта.

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.

domain

строка

Этот параметр позволяет виртуальным машинам отправлять кадры с MAC-адресом.

domain_type

строка

Тип домена пути.

Тип физического домена поддерживается только в APIC v5.0 и выше.

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

  • "physical"
  • "vmware"

encap

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

Инкапсуляция на интерфейсе (например, “vlan-500”)

enhanced_lag_policy

строка

Политика расширенной агрегации каналов (LAG) пути.

Передайте “” как значение для удаления существующей политики расширенной агрегации каналов (см. примеры).

floating_ip

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

строка

Плавущий IP-адрес.

forged_transmit

строка

Этот параметр позволяет виртуальным машинам отправлять кадры с MAC-адресом.

Поддерживается только в APIC v5.0 и выше.

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

  • "enabled"
  • "disabled"

host

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

строка

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

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

interface_profile

псевдонимы: interface_profile_name, logical_interface

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

Имя профиля интерфейса.

l3out

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

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

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

mac_change

строка

Статус поддержки изменения MAC-адреса для групп портов во внешнем контроллере VMM.

Поддерживается только в APIC v5.0 и выше.

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

  • "enabled"
  • "disabled"

node_id

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

Узел для создания интерфейса для каналов портов и отдельных портов.

node_profile

псевдонимы: node_profile_name, logical_node

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

Имя профиля узла.

output_level

строка

Влияет на вывод этого модуля ACI.

normal — стандартный вывод, включая current dict.

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

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

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

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

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

output_path

строка

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

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

password

string

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

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

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

pod_id

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

Подразделение (под для построения интерфейса).

port

целое число

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

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

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

private_key

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

строка

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

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

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

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

promiscuous_mode

строка

Статус режима прослушивания для групп портов во внешнем контроллере VMM.

Поддерживается только в APIC v5.0 и выше.

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

  • "enabled"
  • "disabled"

state

строка

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

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

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

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

suppress_previous

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

булево

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

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

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

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

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

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

  • false
  • true

suppress_verification

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

булево

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

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

Если значение не указано в задаче, будет использовано значение переменной окружения 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, l3out, logical_node_profile, logical_interface_profile и floating_svi. Модули cisco.aci.aci_tenant, cisco.aci.aci_l3out, cisco.aci.aci_l3out_logical_node_profile, cisco.aci.aci_l3out_logical_interface_profile и cisco.aci.aci_l3out_floating_svi могут быть использованы для этого.

См. также

См. также

cisco.aci.aci_tenant

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

cisco.aci.aci_l3out

Управление объектами Layer 3 Outside (L3Out) (l3ext:Out).

cisco.aci.aci_l3out_logical_node_profile

Управление профилями логических узлов Layer 3 Outside (L3Out) (l3ext:LNodeP).

cisco.aci.aci_l3out_logical_interface_profile

Управление профилями логических интерфейсов Layer 3 Outside (L3Out) (l3ext:LIfP).

cisco.aci.aci_l3out_floating_svi

Управление интерфейсами Layer 3 Outside (L3Out) (l3ext:VirtualLIfP).

APIC Management Information Model reference

Дополнительная информация о внутреннем классе APIC l3ext:RsDynPathAtt)

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

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

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

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

Примеры

- name: Create a Floating SVI path attribute
  cisco.aci.aci_l3out_floating_svi_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    encap: vlan-1
    floating_ip: 23.45.67.90/24
    domain_type: virtual
    domain: anstest
    enhanced_lag_policy: enhanced
    state: present
  delegate_to: localhost

- name: Remove enhanced lag policy from the path
  cisco.aci.aci_l3out_floating_svi_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    encap: vlan-1
    floating_ip: 23.45.67.90/24
    domain_type: virtual
    domain: anstest
    enhanced_lag_policy: ""
    state: present
  delegate_to: localhost

- name: Remove a Floating SVI path attribute
  cisco.aci.aci_l3out_floating_svi_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    encap: vlan-1
    domain_type: virtual
    domain: anstest
    state: absent
  delegate_to: localhost

- name: Query a Floating SVI path attribute
  cisco.aci.aci_l3out_floating_svi_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    encap: vlan-1
    domain_type: virtual
    domain: anstest
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all the Floating SVI path attributes
  cisco.aci.aci_l3out_floating_svi_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    encap: vlan-1
    state: query
  delegate_to: localhost
  register: query_results

Значения возврата

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

Ключ

Описание

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"

Авторы

  • Shreyas Srish (@shrsr)

Ссылки на сборку

  • Отслеживание ошибок
  • Репозиторий (источники)

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

Spec-Zone.ru

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