vyos_system – Запуск набора системных команд на устройствах VyOS

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

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

Описание

Выполняет одну или несколько команд на удаленных устройствах с VyOS. Этот модуль также можно использовать для проверки ключевых параметров перед успешным возвратом.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
domain_name -			Новое доменное имя для применения к устройству.
domain_search -			Список доменных имен для поиска. Взаимоисключающее с параметром name_server
host_name -			Настройка параметра имени хоста устройства. Этот параметр принимает значение ASCII-строки.
name_servers -			Список имен серверов имен для использования с устройством. Взаимоисключающее с параметром domain_search псевдонимы: name_server
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`.
state -		Варианты: present ← absent	Применить (`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']

Статус

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

Поддержка Red Hat

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