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

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

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Поддержка
- Автор

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
backup bool		Варианты: нет ← да	Аргумент `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 используется как адрес назначения для канала.
	port	Значение по умолчанию: 22	Указывает порт, используемый при подключении к удалённому устройству.
	username		Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	password		Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	timeout	Значение по умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку.
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
save bool		Варианты: нет ← да	Аргумент `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 список	всегда	Список команд конфигурации, удалённых для предотвращения ошибок загрузки Пример: ['...', '...']

Статус

Этот модуль помечен как preview, что означает, что его интерфейс не гарантированно будет совместим со старыми версиями.

Техническое обслуживание

Этот модуль помечен как сетевой, что означает, что его техническое обслуживание выполняет Ansible Network Team. Подробную информацию см. в Документации по поддержке модулей.

Список других модулей, поддерживаемых Ansible Network Team, см. здесь.

Поддержка

Дополнительную информацию о поддержке этого модуля компанией 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.6/modules/vyos_config_module.html