cisco.nxos.nxos_vrrp – Управляет конфигурацией VRRP на коммутаторах NX-OS.
Примечание
Этот плагин входит в коллекцию cisco.nxos (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в книге задач, укажите: cisco.nxos.nxos_vrrp.
Добавлена в версии 1.0.0: of cisco.nxos
Обзор
- Управляет конфигурацией VRRP на коммутаторах NX-OS.
Примечание
Данный модуль имеет соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| admin_state строка |
| Используется для включения или выключения процесса VRRP. | |
| authentication строка | Строка аутентификации в открытом виде или ключевое слово 'default' | ||
| group строка / обязательно | Номер группы VRRP. | ||
| interface строка / обязательно | Полное имя интерфейса, который управляется для VRRP. | ||
| interval строка | Интервал времени между объявлениями или ключевое слово 'default' | ||
| preempt логическое значение |
| Включить/выключить преемственность. | |
| 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 ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, вместо этого будет использовано значение переменной среды 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 строка |
| Настраивает транспортное соединение для использования при подключении к удаленному устройству. Аргумент 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 строка |
| Указывает желаемое состояние ресурса. | |
| vip строка | Виртуальный IP-адрес VRRP или ключевое слово 'default' | ||
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Функция VRRP должна быть сначала включена в системе.
- SVIs должны существовать перед использованием этого модуля.
- Интерфейс должен быть портом L3 перед использованием этого модуля.
-
state=absentудаляет группу VRRP, если она существует на устройстве. - VRRP не может быть настроен на интерфейсах loopback.
- Для получения информации об использовании CLI и NX-API см. руководство по параметрам платформы NXOS
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. руководство по Ansible для сети
- Для получения дополнительной информации об использовании 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/nxos/nxos_vrrp_module.html