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

Примечание

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

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

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

Добавлена в версии 1.0.0: of cisco.nxos

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

Обзор

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

Примечание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_string строка			Строка аутентификации. Если её нужно скрыть (для типа md5), строка должна начинаться с 7, за которым следует ключ. В противном случае, она может начинаться с 0, за которым следует ключ (для обратной совместимости). Для типа text, это просто ключ. Если это 'default', аутентификация удаляется.
auth_type строка		Варианты: text md5	Тип аутентификации.
group строка / обязательный			Номер группы HSRP.
interface строка / обязательный			Полное имя интерфейса, управляемого HSRP.
preempt строка		Варианты: enabled disabled	Включить/выключить preempt.
priority строка			Приоритет HSRP или ключевое слово 'default'.
provider словарь			Устарело Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli`. Начиная с Ansible 2.6 рекомендуется использовать `connection: httpapi` для NX-API. Этот параметр будет удалён в релизе после 2022-06-01. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий детали подключения.
	auth_pass строка		Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	authorize булево	Варианты: нет ← да	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `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`, переменные среды `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl булево	Варианты: нет ← да	Настраивает transport для использования SSL, если установлено `yes`, только если `transport=nxapi`, в противном случае это значение игнорируется.
	username строка		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого протокола. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.
	validate_certs булево	Варианты: нет ← да	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на управляемых сайтах с самозаверяющими сертификатами. Если аргумент transport не nxapi, это значение игнорируется.
state строка		Варианты: present ← absent	Укажите желаемое состояние ресурса.
version строка		Варианты: 1 2 По умолчанию: 1	Версия HSRP.
vip строка			Виртуальный IP-адрес HSRP или ключевое слово 'default'.

Примечания

Примечание

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

Примеры

- name: Ensure HSRP is configured with following params on a SVI
  cisco.nxos.nxos_hsrp:
    group: 10
    vip: 10.1.1.1
    priority: 150
    interface: vlan10
    preempt: enabled

- name: Ensure HSRP is configured with following params on a SVI with clear text authentication
  cisco.nxos.nxos_hsrp:
    group: 10
    vip: 10.1.1.1
    priority: 150
    interface: vlan10
    preempt: enabled
    auth_type: text
    auth_string: CISCO

- name: Ensure HSRP is configured with md5 authentication and clear authentication
    string
  cisco.nxos.nxos_hsrp:
    group: 10
    vip: 10.1.1.1
    priority: 150
    interface: vlan10
    preempt: enabled
    auth_type: md5
    auth_string: 0 1234

- name: Ensure HSRP is configured with md5 authentication and hidden authentication
    string
  cisco.nxos.nxos_hsrp:
    group: 10
    vip: 10.1.1.1
    priority: 150
    interface: vlan10
    preempt: enabled
    auth_type: md5
    auth_string: 7 1234

- name: Remove HSRP config for given interface, group, and VIP
  cisco.nxos.nxos_hsrp:
    group: 10
    interface: vlan10
    vip: 10.1.1.1
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
commands список / элементы=строка	всегда	Команды, отправленные устройству Пример: ['interface vlan10', 'hsrp version 2', 'hsrp 30', 'ip 10.30.1.1']

Авторы

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.10/collections/cisco/nxos/nxos_hsrp_module.html