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

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

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

Обзор

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

Параметры

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

Статус

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

Поддержка

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