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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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, прикреплённого к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указано имя файла `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-адрес или имя хоста, разрешаемые хостом Ansible. Если значение не указано в задаче, используется значение переменной среды `ACI_HOST`.
lldp_policy строка	Имя политики LLDP доступа к фабрике.
mtu_policy строка	Только VMWare. Имя политики MTU доступа к фабрике.
netflow_exporter словарь	Параметры политики экспортера netflow.
active_flow_timeout целое число	Указывает задержку в секундах, которую NetFlow ожидает после инициирования активного потока, после чего NetFlow отправляет собранные данные. Диапазон от 60 до 3600. Значение по умолчанию 60.
idle_flow_timeout целое число	Указывает задержку в секундах, которую NetFlow ожидает после инициирования потока простоя, после чего NetFlow отправляет собранные данные. Диапазон от 10 до 600. Значение по умолчанию 15.
name строка / обязательно	Имя политики экспортера netflow.
sampling_rate целое число	(Только VDS) Указывает, сколько пакетов NetFlow будет отбрасывать после каждого собранного пакета. Если указано значение 0, то NetFlow не отбрасывает пакеты. Диапазон от 0 до 1000. Значение по умолчанию 0.

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`.
owner_key string	Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет ключ, позволяющий клиентам владеть своими данными для корреляции сущностей. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OWNER_KEY`.
owner_tag string	Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет тег, позволяющий клиентам добавлять свои собственные данные. Например, для указания того, кто создал этот объект. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OWNER_TAG`.
password string	Пароль для аутентификации. Этот параметр является взаимоисключающим с `private_key`. Если `private_key` также предоставлен, он будет использован вместо него. Если значение не указано в задаче, вместо него будет использовано значение переменных среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port integer	Номер порта, который будет использоваться для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PORT`.
port_channel_policy string	Имя политики каналов портов доступа к сети.
private_key псевдонимы: cert_key string	Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение `certificate_name` по умолчанию, которое используется. Этот параметр является взаимоисключающим с `password`. Если `password` также предоставлен, он будет игнорироваться. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
state string	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления одного или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
stp_policy string	Только SCVMM. Имя политики STP.
suppress_previous псевдонимы: no_previous, ignore_previous boolean	Если `true`, запрос GET для проверки предыдущего состояния не будет отправлен перед обновлением POST в APIC. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию: `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение будет пустым. Предыдущее состояние объекта не будет проверено, и обновление POST будет содержать все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, подтверждающий запрос GET не будет отправлен после обновления POST в APIC. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию: `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение. Текущий объект, включая значения по умолчанию, не может быть проверен в одной задаче. Варианты: `false` `true`
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`
vm_provider string	Платформа виртуальных машин для 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 Management Information Model reference: Дополнительная информация о внутренних классах 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 список / элементы=строка	Текущая конфигурация из 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"`

Авторы

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

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

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