cisco.nxos.nxos_vrrp – Управляет конфигурацией VRRP на коммутаторах NX-OS.

Примечание

Этот плагин входит в состав коллекции cisco.nxos (версия 1.4.0).

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

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

Новое в версии 1.0.0: of cisco.nxos

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Управляет конфигурацией VRRP на коммутаторах NX-OS.

Примечание

У данного модуля есть соответствующий плагин действий.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
admin_state строка		Варианты: shutdown ← no shutdown default	Используется для включения или выключения процесса VRRP.
authentication строка			Строка аутентификации в открытом виде или ключевое слово 'default'
group строка / обязательно			Номер группы VRRP.
interface строка / обязательно			Полное имя интерфейса, управляемого для VRRP.
interval строка			Интервал времени между объявлениями или ключевое слово 'default'
preempt булево		Варианты: no yes	Включить/выключить преемственность.
priority строка			Приоритет VRRP или ключевое слово 'default'
provider словарь			Устарело Начиная с Ansible 2.5, рекомендуем использовать `connection: network_cli`. Начиная с Ansible 2.6, рекомендуем использовать `connection: httpapi` для NX-API. Этот параметр будет удален в выпуске после 2022-06-01. Для получения дополнительной информации, пожалуйста, обратитесь к руководству NXOS Platform Options. Объект словаря, содержащий сведения о подключении.
	auth_pass строка		Указывает пароль для использования при входе в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	authorize булево	Варианты: no ← yes	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
	host строка		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	password строка		Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port целое число		Указывает порт для построения соединения с удалённым устройством. Это значение применяется к cli или nxapi. Значение порта по умолчанию соответствует стандартному порту для выбранного транспорта, если не указано другое значение в задаче (cli=22, http=80, https=443).
	ssh_keyfile строка		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число		Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истечёт до завершения операции, модуль вернёт ошибку. NX-API может медленно возвращать результаты при длительных командах (sh mac, sh bgp и т.д.).
	transport строка	Варианты: cli ← nxapi	Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi.
	use_proxy булево	Варианты: no yes ←	Если `no`, переменные среды `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl булево	Варианты: no ← yes	Настраивает transport для использования SSL, если значение равно `yes` только в случае `transport=nxapi`, в противном случае это значение игнорируется.
	username строка		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.
	validate_certs булево	Варианты: no ← yes	Если `no`, сертификаты SSL не будут проверены. Это должно использоваться только на контролируемых сайтах с самозаверяющимися сертификатами. Если аргумент transport не nxapi, это значение игнорируется.
state строка		Варианты: present ← absent	Указывает желаемое состояние ресурса.
vip строка			Виртуальный IP-адрес VRRP или ключевое слово 'default'

Примечания

Примечание

Проверено на NXOSv 7.3.(0)D1(1) на VIRL
Сначала необходимо включить функцию VRRP в системе.
SVIs должны существовать перед использованием этого модуля.
Интерфейс должен быть L3-портом перед использованием этого модуля.
state=absent удаляет группу VRRP, если она существует на устройстве.
VRRP не может быть настроен на интерфейсах loopback.
Дополнительную информацию об использовании CLI и NX-API можно найти в руководстве NXOS Platform Options
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами можно найти в руководстве Ansible Network Guide
Дополнительную информацию об использовании Ansible для управления устройствами Cisco можно найти на странице интеграции Cisco.

Примеры

- name: Ensure vrrp group 100 and vip 10.1.100.1 is on vlan10
  cisco.nxos.nxos_vrrp:
    interface: vlan10
    group: 100
    vip: 10.1.100.1

- name: Ensure removal of the vrrp group config
  cisco.nxos.nxos_vrrp:
    interface: vlan10
    group: 100
    vip: 10.1.100.1
    state: absent

- name: Re-config with more params
  cisco.nxos.nxos_vrrp:
    interface: vlan10
    group: 100
    vip: 10.1.100.1
    preempt: false
    priority: 130
    authentication: AUTHKEY

Возвращаемые значения

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

Ключ	Возвращённое значение	Описание
commands список / элементы=строка	всегда	Команды, отправленные устройству Пример: ['interface vlan10', 'vrrp 150', 'address 10.1.15.1', 'authentication text testing', 'no shutdown']

Авторы

Jason Edelman (@jedelman8)
Gabriele Gerbino (@GGabriele)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_vrrp_module.html