Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_vmm_vswitch_policy – Управление политикой vSwitch для профилей виртуальных доменов VMware (vmm:VSwitchPolicyCont)

Примечание

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

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

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

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

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

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

  • Управление политикой vSwitch для доменов VMware VMM в фабриках Cisco ACI.

Параметры

Параметр

Комментарии

annotation

строка

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

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

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

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

cdp_policy

строка

Имя политики CDP для доступа к фабрике.

certificate_name

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

строка

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

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

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

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

domain

псевдонимы: domain_name, domain_profile

строка

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

enhanced_lag

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

Список политик расширенного LAG, если vSwitch необходимо подключить через VPC.

lacp_mode

строка

Режим канала портов LACP.

Варианты:

  • "active"
  • "passive"

load_balancing_mode

строка

Режим балансировки нагрузки канала портов.

См. также https://pubhub.devnetcloud.com/media/apic-mim-ref-421/docs/MO-lacpEnhancedLagPol.html.

Варианты:

  • "dst-ip"
  • "dst-ip-l4port"
  • "dst-ip-vlan"
  • "dst-ip-l4port-vlan"
  • "dst-mac"
  • "dst-l4port"
  • "src-ip"
  • "src-ip-l4port"
  • "src-ip-vlan"
  • "src-ip-l4port-vlan"
  • "src-mac"
  • "src-l4port"
  • "src-dst-ip"
  • "src-dst-ip-l4port"
  • "src-dst-ip-vlan"
  • "src-dst-ip-l4port-vlan"
  • "src-dst-mac"
  • "src-dst-l4port"
  • "src-port-id"
  • "vlan"

name

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

Имя политики расширенного LAG.

number_uplinks

целое число

Количество восходящих каналов; должно быть от 2 до 8.

host

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

строка

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

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

lldp_policy

строка

Имя политики LLDP для доступа к фабрике.

mtu_policy

строка

Только для VMWare.

Имя политики MTU для доступа к фабрике.

netflow_exporter

словарь

Параметры политики экспортера NetFlow

active_flow_timeout

целое число

Задает задержку в секундах, которую NetFlow ожидает после начала активного потока, прежде чем отправить собранные данные.

Диапазон: от 60 до 3600. Значение по умолчанию — 60.

idle_flow_timeout

целое число

Задает задержку в секундах, которую NetFlow ожидает после начала простаивающего потока, прежде чем отправить собранные данные.

Диапазон: от 10 до 600. Значение по умолчанию — 15.

name

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

Имя политики экспортера NetFlow

sampling_rate

целое число

(Только для VDS) Задает количество пакетов, которые NetFlow будет отбрасывать после каждого собранного пакета. Если указать значение 0, NetFlow не будет отбрасывать пакеты.

Диапазон: от 0 до 1000. Значение по умолчанию — 0.

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.

owner_key

строка

Заданная пользователем строка для атрибута ownerKey объекта ACI.

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

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

owner_tag

строка

Заданная пользователем строка для атрибута ownerTag объекта ACI.

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

Например, чтобы указать, кто создал этот объект.

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

password

строка

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

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

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

port

целое число

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

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

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

port_channel_policy

строка

Имя политики канала портов для доступа к фабрике.

private_key

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

строка

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

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

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

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

state

строка

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

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

Варианты:

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

stp_policy

строка

Только для SCVMM.

Имя политики STP.

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

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

vm_provider

строка

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

Поддержка Kubernetes добавлена в ACI v3.0.

Поддержка CloudFoundry, OpenShift и Red Hat добавлена в ACI v3.1.

Варианты:

  • "cloudfoundry"
  • "kubernetes"
  • "microsoft"
  • "openshift"
  • "openstack"
  • "redhat"
  • "vmware"

См. также

См. также

cisco.aci.aci_domain

Управление профилями физических, виртуальных, мостовых, маршрутизируемых доменов или доменов FC (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP и fc:DomP).

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

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

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

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

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

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

Примеры

- name: Add a vSwitch policy with LLDP
  cisco.aci.aci_vmm_vswitch_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    lldp_policy: LLDP_ENABLED
    domain: vmware_dom
    vm_provider: vmware
    state: present

- name: Add a vSwitch policy with link aggregation
  cisco.aci.aci_vmm_vswitch_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_channel_policy: LACP_ACTIVE
    lldp_policy: LLDP_ENABLED
    domain: vmware_dom
    vm_provider: vmware
    enhanced_lag:
      - name: my_lacp_uplink
        lacp_mode: active
        load_balancing_mode: src-dst-ip
        number_uplinks: 2
    state: present

- name: Remove vSwitch Policy from VMware VMM domain
  cisco.aci.aci_vmm_vswitch_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: vmware_dom
    vm_provider: vmware
    state: absent

- name: Query the vSwitch policy of the VMWare domain
  cisco.aci.aci_vmm_vswitch_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: vmware_dom
    vm_provider: vmware
    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"

Авторы

  • Manuel Widmer (@lumean)
  • Anvitha Jain (@anvitha-jain)

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

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

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

Spec-Zone.ru

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