Spec-Zone.ru › Ansible

cisco.aci.aci_l3out_hsrp_secondary_vip модуль — Управление вторичным виртуальным IP-адресом HSRP группы (hsrp:SecVip)

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.aci.aci_l3out_hsrp_secondary_vip.

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

Описание

  • Управление вторичным виртуальным IP-адресом HSRP группы на Cisco ACI сетях.

Параметры

Параметр

Комментарии

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.

host

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

строка

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

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

hsrp_interface_group

псевдонимы: name, hsrp_group

строка

Имя существующей группы HSRP.

interface_profile

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

строка

Имя существующего профиля интерфейса.

l3out

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

строка

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

node_profile

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

строка

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

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.

private_key

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

строка

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

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

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

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

secondary_virtual_ip

псевдонимы: vip, secondary_vip

строка

Версия каталога совместимости.

state

string

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

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

Выбираемые значения:

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

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

tenant

псевдонимы: 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

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

string

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

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

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

validate_certs

boolean

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

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

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

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

Выбираемые значения:

  • false
  • true

Примечания

Примечание

  • tenant, l3out, logical_node_profile, logical_interface_profile, hsrp_interface_profile и hsrp_group должны существовать перед использованием данного модуля в вашем плане выполнения. Для этого можно использовать 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_hsrp_interface_profile и cisco.aci.aci_l3out_hsrp_group.

См. также

См. также

aci_tenant

Официальная документация по модулю aci_tenant.

aci_l3out

Официальная документация по модулю aci_l3out.

aci_l3out_logical_node_profile

Официальная документация по модулю aci_l3out_logical_node_profile.

aci_l3out_logical_interface_profile

Официальная документация по модулю aci_l3out_logical_interface_profile.

aci_l3out_hsrp_interface_profile

Официальная документация по модулю aci_l3out_hsrp_interface_profile.

aci_l3out_hsrp_group

Официальная документация по модулю aci_l3out_hsrp_group.

APIC Management Information Model reference

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

Cisco ACI Guide

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

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

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

Примеры

- name: Add a HSRP secondary virtual ip
  cisco.aci.aci_l3out_hsrp_secondary_vip:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    hsrp_group: my_hsrp_group
    secondary_virtual_ip: 191.1.1.1
    state: present
  delegate_to: localhost

- name: Delete a HSRP secondary virtual ip
  cisco.aci.aci_l3out_hsrp_secondary_vip:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    hsrp_group: my_hsrp_interface_group
    secondary_virtual_ip: 191.1.1.1
    state: absent
  delegate_to: localhost

- name: Query a HSRP secondary virtual ip
  cisco.aci.aci_l3out_hsrp_secondary_vip:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    hsrp_group: my_hsrp_group
    secondary_virtual_ip: 191.1.1.1
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all HSRP secondary virtual ips
  cisco.aci.aci_l3out_hsrp_secondary_vip:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    hsrp_group: my_hsrp_group
    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"

Авторы

  • Шреяс Шриш (@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_hsrp_secondary_vip_module.html

Spec-Zone.ru

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