vyos_config – Управление конфигурацией VyOS на удалённом устройстве

Новое в версии 2.2.

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

Описание

Этот модуль предоставляет управление файлами конфигурации устройств VyOS. Он предоставляет аргументы для управления как файлом конфигурации, так и состоянием активной конфигурации. Все команды конфигурации основаны на командах set и delete в конфигурации устройства.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
backup boolean		нет ← да	Аргумент `backup` создаст резервную копию текущей активной конфигурации устройства на хост-системе Ansible перед внесением любых изменений. Файл резервной копии будет расположен в папке backup в корневой директории playbook или в корневой директории роли, если playbook является частью роли ansible. Если директория не существует, она будет создана.
comment -		По умолчанию: "настроено vyos_config"	Позволяет указать описание коммита, которое будет включено при фиксации конфигурации. Если конфигурация не изменялась или не фиксировалась, этот аргумент игнорируется.
config -			Аргумент `config` указывает базу конфигурации для сравнения с желаемой конфигурацией. Если это значение не указано, модуль автоматически получит текущую активную конфигурацию с удалённого устройства.
lines -			Упорядоченный набор строк конфигурации, которые будут управляться и сравниваться с существующей конфигурацией на удалённом устройстве.
match -		строка ← нет	Аргумент `match` контролирует метод сравнения с текущей активной конфигурацией. По умолчанию желаемая конфигурация сравнивается с активной, и разницы загружаются. Если аргумент `match` установлен в `none`, активная конфигурация игнорируется, и конфигурация всегда загружается.
provider -			Устарело Начиная с Ansible 2.5, мы рекомендуем использовать `connection: network_cli`. Для получения дополнительной информации см. Руководство по сети. Объект словаря, содержащий данные подключения.
	host - / обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	password -		Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port -	По умолчанию: 22	Указывает порт для подключения к удалённому устройству.
	ssh_keyfile -		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации SSH-сессии. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout -	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку.
	username -		Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ANSIBLE_NET_USERNAME`.
save boolean		нет ← да	Аргумент `save` определяет, сохраняются ли внесённые изменения в активной конфигурации на диске. Это независимо от фиксации конфигурации. При значении True активная конфигурация сохраняется.
src -			Аргумент `src` указывает путь к исходному файлу конфигурации для загрузки. Исходный файл конфигурации может быть в формате скобок или в другом формате. Исходный файл может содержать переменные шаблона Jinja2.

Примечания

Примечание

Проверено на VYOS 1.1.7
Сокращённые команды НЕ идемпотентны, см. ЧаВО по сети.
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами, см. Руководство по сетям Ansible

Примеры

- name: configure the remote device
  vyos_config:
    lines:
      - set system host-name {{ inventory_hostname }}
      - set service lldp
      - delete service dhcp-server

- name: backup and load from file
  vyos_config:
    src: vyos.cfg
    backup: yes

- name: for idempotency, use full-form commands
  vyos_config:
    lines:
      # - set int eth eth2 description 'OUTSIDE'
      - set interface ethernet eth2 description 'OUTSIDE'

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

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

Ключ	Возвращаемое	Описание
backup_path строка	при backup = да	Полный путь к файлу резервной копии Пример: /playbooks/ansible/backup/vyos_config.2016-07-16@22:28:34
commands список	всегда	Список команд конфигурации, отправленных устройству Пример: ['...', '...']
filtered список	всегда	Список команд конфигурации, удалённых для предотвращения сбоя загрузки Пример: ['...', '...']

Статус

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

Поддержка Red Hat

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

Авторы

Nathaniel Case (@qalthos)

Подсказка

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

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