vyos_system - Выполнение набора системных команд на устройствах VyOS
Новая версия 2.3.
Описание
- Выполняет одну или несколько команд на удаленных устройствах, работающих под управлением VyOS. Этот модуль также можно использовать для проверки параметров ключей перед успешным возвращением.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| domain_name | Новое имя домена для применения к устройству. | ||
| domain_search | Список имен доменов для поиска. Взаимоисключающие с параметром name_server
| ||
| host_name | Настройка параметра имени хоста устройства. Этот параметр принимает значение ASCII-строки. | ||
| name_servers | По умолчанию: None | Список имен серверов DNS для использования с устройством. Взаимоисключающие с параметром domain_search
псевдонимы: name_server | |
| provider | По умолчанию: None | Устаревший Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli. Для получения дополнительной информации, пожалуйста, обратитесь к Руководству по сети. Объект dict, содержащий сведения о подключении. | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение параметра host используется в качестве адреса назначения для транспорта. | ||
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout | По умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечет до завершения операции, модуль вернет ошибку. | |
| password | По умолчанию: None | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | |
| port | По умолчанию: 22 | Указывает порт для подключения к удаленному устройству. | |
| state |
| Необходимо применить ( present) или удалить (absent) настройки. | |
Примечания
Примечание
- Проверено на VYOS 1.1.7
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сети Ansible
Примеры
- name: configure hostname and domain-name
vyos_system:
host_name: vyos01
domain_name: test.example.com
- name: remove all configuration
vyos_system:
state: absent
- name: configure name servers
vyos_system:
name_servers
- 8.8.8.8
- 8.8.4.4
- name: configure domain search suffixes
vyos_system:
domain_search:
- sub1.example.com
- sub2.example.com
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда | Список команд режима конфигурации для отправки на устройство Пример: ['set system hostname vyos01', 'set system domain-name foo.example.com'] |
Статус
Этот модуль помечен как превью, что означает, что интерфейс не гарантируется совместимым со старыми версиями.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией 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_system_module.html
