vyos_config - Управление конфигурацией VyOS на удалённом устройстве
Новое в версии 2.2.
Описание
- Этот модуль предоставляет управление файлами конфигурации устройств VyOS. Он предоставляет аргументы для управления как файлом конфигурации, так и состоянием активной конфигурации. Все инструкции конфигурации основаны на командах
setиdeleteв конфигурации устройства.
Параметры
| параметр | обязательно | значение по умолчанию | варианты | комментарии | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| backup | нет |
| Аргумент backup создаст резервную копию текущей активной конфигурации устройства на хост Ansible перед внесением каких-либо изменений. Файл резервной копии будет расположен в папке backup в корне playbook | ||||||||||||||||||||||||||||||||||||
| comment | нет | настраивается vyos_config | Разрешает указать описание коммита, которое будет включено при сохранении конфигурации. Если конфигурация не изменена или не сохранена, этот аргумент игнорируется. | ||||||||||||||||||||||||||||||||||||
| config | нет | Аргумент config указывает базовую конфигурацию для сравнения с желаемой конфигурацией. Если это значение не указано, модуль автоматически получит текущую активную конфигурацию с удалённого устройства. | |||||||||||||||||||||||||||||||||||||
| lines | нет | Упорядоченный набор строк конфигурации, которые будут обрабатываться и сравниваться с существующей конфигурацией на удалённом устройстве. | |||||||||||||||||||||||||||||||||||||
| match | нет | строка |
| Аргумент match управляет методом сопоставления с текущей активной конфигурацией. По умолчанию, желаемая конфигурация сопоставляется с активной конфигурацией, и разницы загружаются. Если аргумент match установлен в none, активная конфигурация игнорируется, и конфигурация всегда загружается. | |||||||||||||||||||||||||||||||||||
| provider | нет | Объект dict, содержащий данные подключения. |
|||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
| save | нет |
| Аргумент save управляет сохранением изменений, внесённых в активную конфигурацию, на диске. Это независимо от сохранения конфигурации. При установке в True, активная конфигурация сохраняется. | ||||||||||||||||||||||||||||||||||||
| src | нет | Аргумент src указывает путь к исходному файлу конфигурации для загрузки. Исходный файл конфигурации может быть в формате в скобках или в формате установки. Исходный файл может содержать переменные шаблонов Jinja2. | |||||||||||||||||||||||||||||||||||||
Примеры
- 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| backup_path | Полный путь к файлу резервной копии | при backup=да | строка | /playbooks/ansible/backup/vyos_config.2016-07-16@22:28:34 |
| commands | Список команд конфигурации, отправленных устройству | всегда | список | ['...', '...'] |
| filtered | Список команд конфигурации, удалённых для предотвращения ошибки загрузки | всегда | список | ['...', '...'] |
Примечания
Примечание
- Тестировалось на VYOS 1.1.7
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Информация о техническом обслуживании
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Для получения помощи в разработке модулей, если вы заинтересованы, ознакомьтесь с Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/vyos_config_module.html
