httpapi – Использование httpapi для выполнения команд на сетевых устройствах

логический тип

"нет"

записи ini:

[]
= нет

[]
= нет

переменная среды:ANSIBLE_BECOME

переменная: ansible_become

Параметр become укажет сессии CLI на попытку повышения привилегий на платформах, которые ее поддерживают. Обычно это означает переход от пользовательского режима к enable режиму в сессии CLI. Если become установлено в True, а удаленное устройство не поддерживает повышение привилегий или привилегии уже повышены, этот параметр будет проигнорирован.

Может быть сконфигурирован через CLI с помощью параметров --become или -b

-

"sudo"

записи ini:

[]
= sudo

[]
= sudo

переменная среды:ANSIBLE_BECOME_METHOD

переменная: ansible_become_method

Этот параметр позволяет указать метод повышения привилегий для обработки повышения привилегий. Обычно значение become_method устанавливается в enable, но может быть определено и другими значениями.

-

"inventory_hostname"

переменная: ansible_host

Указывает FQDN или IP-адрес удаленного устройства для установления HTTP(S)-соединения.

-

переменная: ansible_network_os

Конфигурирует сетевую операционную систему платформы устройства. Это значение используется для загрузки правильных плагинов httpapi и cliconf для связи с удаленным устройством.

-

переменная: ansible_password

переменная: ansible_httpapi_pass

Секрет, используемый для аутентификации

целое число

10

записи ini:

[persistent_connection]
command_timeout = 10

переменная среды:ANSIBLE_PERSISTENT_COMMAND_TIMEOUT

Устанавливает, в секундах, время ожидания возврата команды с удалённого устройства. Если этот таймер истечёт до возврата команды, плагин подключения генерирует исключение и закрывает соединение

целое число

30

записи ini:

[persistent_connection]
connect_timeout = 30

переменная среды:ANSIBLE_PERSISTENT_CONNECT_TIMEOUT

переменная: ansible_connect_timeout

Устанавливает, в секундах, время ожидания при попытке первоначального установления постоянного подключения. Если это значение истечёт до завершения подключения к удалённому устройству, подключение завершится с ошибкой

целое число

записи ini:

[defaults]
remote_port = ЗНАЧЕНИЕ

переменная среды:ANSIBLE_REMOTE_PORT

переменная: ansible_httpapi_port

Указывает порт на удаленном устройстве, слушающий подключения при установлении HTTP(S)-соединения. Если не указан, будет выбран 80 или 443 в зависимости от значения use_ssl

-

записи ini:

[defaults]
remote_user = ЗНАЧЕНИЕ

переменная среды:ANSIBLE_REMOTE_USER

переменная: ansible_user

Имя пользователя, используемое для аутентификации на удалённом устройстве при первом установлении соединения API. Если remote_user не указан, для подключения будет использован логин текущего пользователя.

Может быть сконфигурирован через CLI с помощью параметров --user или -u

целое число

120

Устанавливает время подключения, в секундах, для связи с удалённым устройством. Этот таймаут используется как значение таймаута по умолчанию для команд при выполнении команды в сетевой CLI. Если команда не вернётся в течение timeout секунд, генерируется ошибка.

логический тип

"нет"

переменная: ansible_httpapi_use_ssl

Использовать ли SSL (HTTPS) или нет (HTTP)

логический тип

добавлен в 2.7

"да"

переменная: ansible_httpapi_validate_certs

Требовать ли проверку SSL-сертификатов