Spec-Zone.ru › Ansible 2.4

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

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

  • Описание
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Примечания
    • Статус
    • Информация о техническом обслуживании

Описание

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

Параметры

параметр обязательный по умолчанию значения комментарии
domain_name
нет
Новое доменное имя для применения к устройству.
domain_search
нет
Список доменных имен для поиска. Взаимоисключающее с параметром name_server
hostname
нет
Настройка параметра имени хоста устройства. Этот параметр принимает значение ASCII-строки.
name_server
нет
Список имен серверов, которые следует использовать с устройством. Взаимоисключающее с параметром domain_search
provider
нет
Объект словаря, содержащий сведения о подключении.
Объект словаря provider
параметр обязательный по умолчанию значения комментарии
username
нет
Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME.
host
да
Указывает имя DNS-хоста или адрес для подключения к удаленному устройству по указанному протоколу. Значение параметра host используется в качестве адреса назначения для протокола.
ssh_keyfile
нет
Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
timeout
нет 10
Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль сообщит об ошибке.
password
нет
Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD.
port
нет 22
Указывает порт для подключения к удаленному устройству.
state
нет present
  • present
  • absent
Необходимо ли применять (present) или удалять (absent) настройки.

Примеры

- name: configure hostname and domain-name
  vyos_system:
    hostname: vyos01
    domain_name: test.example.com

- name: remove all configuration
  vyos_system:
    state: absent

- name: configure name servers
  vyos_system:
    name_server:
      - 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']

Примечания

Примечание

  • Проверено на 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_system_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API