модуль graphiant.naas.graphiant_vrrp — управление конфигурацией Graphiant VRRP (протокола резервирования виртуальных маршрутизаторов)

Примечание

Этот модуль входит в коллекцию graphiant.naas (версия 26.5.0).

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

Для установки используйте: ansible-galaxy collection install graphiant.naas. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: graphiant.naas.graphiant_vrrp.

Добавлено в graphiant.naas 26.1.0

Краткое описание
Требования
Параметры
Атрибуты
Примечания
См. также
Примеры
Возвращаемые значения

Краткое описание

Этот модуль обеспечивает комплексное управление VRRP на устройствах Graphiant Edge.
Поддерживает настройку, отмену настройки и включение VRRP как на основных интерфейсах, так и на подинтерфейсах (VLAN).
Для всех операций используются шаблоны Jinja2, обеспечивающие единообразное развертывание конфигурации.
Файлы конфигурации поддерживают шаблонизацию Jinja2 для динамического формирования.
Все операции идемпотентны — их можно безопасно выполнять несколько раз без ошибок и нежелательных изменений.

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 3.7
graphiant-sdk >= 26.5.0

Параметры

Параметр	Комментарии
access_token string	Токен Bearer для аутентификации API (например, полученный с помощью `graphiant login`, который открывает браузер для входа (SSO или без SSO) и получает токен). Если аргумент модуля не указан, коллекция считывает `GRAPHIANT_ACCESS_TOKEN` (задаётся после `graphiant login` при выполнении `source ~/.graphiant/env.sh`). Если токен Bearer указан (в аргументе модуля или переменной окружения), он имеет приоритет над `username` и `password`. Если действительный токен недоступен, модуль проходит аутентификацию с помощью `username` и `password`, если указаны оба значения.
detailed_logs boolean	Включить подробный вывод журнала для устранения неполадок и мониторинга. При включении выводится подробный журнал всех операций VRRP. Журналы собираются и включаются в result_msg для отображения с помощью модуля ansible.builtin.debug. Варианты: `false` ← (по умолчанию) `true`
host псевдонимы: base_url string / обязательный	URL хоста портала Graphiant для подключения к API. Пример: “https://api.graphiant.com”
operation string	Операция VRRP, которую необходимо выполнить. `configure`: настроить группы VRRP на интерфейсах и подинтерфейсах. `deconfigure`: отменить настройку групп VRRP на интерфейсах и подинтерфейсах. `enable`: включить существующие конфигурации VRRP. Если VRRP не настроен, операция завершается ошибкой. Идемпотентно — пропускает действие, если VRRP уже включён. Варианты: `"configure"` `"deconfigure"` `"enable"`
password string	Пароль портала Graphiant для аутентификации. Требуется для входа по паролю, если действительный токен Bearer недоступен в `access_token` или `GRAPHIANT_ACCESS_TOKEN`.
state string	Требуемое состояние конфигурации VRRP. `present`: соответствует `configure`, если `operation` не указан. `absent`: соответствует `deconfigure`, если `operation` не указан. Варианты: `"present"` ← (по умолчанию) `"absent"`
username string	Имя пользователя портала Graphiant для аутентификации. Требуется для входа по паролю, если действительный токен Bearer недоступен в `access_token` или `GRAPHIANT_ACCESS_TOKEN`.
vrrp_config_file string / обязательный	Путь к YAML-файлу конфигурации VRRP. Обязателен для всех операций. Может быть абсолютным или относительным. Относительные пути разрешаются с использованием заданного config_path. Файлы конфигурации поддерживают синтаксис шаблонов Jinja2 для динамического формирования. Файл должен содержать определения VRRP с именами устройств, именами интерфейсов и конфигурациями групп VRRP.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная При запуске с `--check` модуль записывает точные полезные данные, которые были бы отправлены, с префиксом `[check_mode]`, чтобы можно было увидеть применяемую конфигурацию. Модуль не сравнивает состояния, поэтому `changed` может иметь значение `True`, даже если конфигурация уже применена.	Поддерживается режим проверки. В этом режиме конфигурация не отправляется на устройства, но полезные данные, которые были бы отправлены, записываются с помощью `[check_mode]`.

Примечания

Примечание

Режим проверки (--check): конфигурация не отправляется; полезные данные, которые были бы отправлены, записываются с помощью [check_mode].
Операции VRRP:
- configure: настроить группы VRRP на интерфейсах и подинтерфейсах. Создаёт конфигурации VRRP с указанными идентификаторами виртуальных маршрутизаторов и IP-адресами.
- deconfigure: отключить группы VRRP на интерфейсах и подинтерфейсах. Идемпотентно — пропускает действие, если VRRP уже отключён.
- enable: включить существующие конфигурации VRRP. Если VRRP не настроен, операция завершается ошибкой. Идемпотентно — пропускает действие, если VRRP уже включён.
Файлы конфигурации поддерживают синтаксис шаблонов Jinja2 для динамического формирования конфигурации.
Модуль автоматически преобразует имена устройств в идентификаторы.
Подробности идемпотентности:
Перед внесением изменений модуль запрашивает текущее состояние VRRP. При отмене настройки он проверяет, отключён ли уже VRRP, и пропускает действие, если это так. При включении он проверяет, включён ли уже VRRP, и пропускает действие, если это так. Это обеспечивает безопасное повторное выполнение без ошибок.
Перед применением VRRP необходимо настроить интерфейсы с помощью модуля graphiant.naas.graphiant_interfaces.

См. также

graphiant.naas.graphiant_interfaces: Настройте интерфейсы перед настройкой VRRP

Примеры

- name: Configure VRRP on interfaces
  graphiant.naas.graphiant_vrrp:
    operation: configure
    vrrp_config_file: "sample_vrrp_config.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true
  register: vrrp_result

- name: Deconfigure VRRP from interfaces
  graphiant.naas.graphiant_vrrp:
    operation: deconfigure
    vrrp_config_file: "sample_vrrp_config.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"

- name: Configure VRRP using state parameter
  graphiant.naas.graphiant_vrrp:
    state: present
    vrrp_config_file: "sample_vrrp_config.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"

- name: Deconfigure VRRP using state parameter
  graphiant.naas.graphiant_vrrp:
    state: absent
    vrrp_config_file: "sample_vrrp_config.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"

- name: Enable existing VRRP configuration
  graphiant.naas.graphiant_vrrp:
    operation: enable
    vrrp_config_file: "sample_vrrp_config.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true

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

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

Ключ	Описание
changed boolean	Были ли внесены изменения в систему в результате операции. `true`, если конфигурация VRRP была применена, включена или отключена. `false`, если операция была пропущена благодаря идемпотентности (например, если VRRP уже включён или отключён). Возвращается: всегда Пример: `true`
msg string	Сообщение о результате операции, включая подробные журналы, если включён параметр `detailed_logs`. Возвращается: всегда Пример: `"Successfully configured VRRP interfaces"`
operation string	Выполненная операция. Одно из значений: `configure`, `deconfigure` или `enable`. Возвращается: всегда Пример: `"configure"`
vrrp_config_file string	Файл конфигурации VRRP, использованный для операции. Возвращается: всегда Пример: `"sample_vrrp_config.yaml"`

Авторы

Команда Graphiant (@graphiant)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/graphiant/naas/graphiant_vrrp_module.html