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

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

Описание

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

Параметры

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

Примеры

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

- name: Ensure removal of the vrrp group config
  # vip is required to ensure the user knows what they are removing
  nxos_vrrp:
    interface: vlan10
    group: 100
    vip: 10.1.100.1
    state: absent

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

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

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

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

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается командой Ansible Network. [сеть]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля компанией Red Hat можно найти в этой статье базы знаний Red Hat.

Авторы

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

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/nxos_vrrp_module.html