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

boolean

"нет"

Записи в 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 для обработки повышения привилегий. Обычно значение become_method устанавливается в enable, но может быть определено и другими значениями.

"inventory_hostname"

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

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

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

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

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

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

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

int

10

Записи в ini:

[persistent_connection ]
command_timeout = 10

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

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

int

30

Записи в ini:

[persistent_connection ]
connect_timeout = 30

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

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

int

Записи в ini:

[defaults ]
remote_port = VALUE

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

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

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

Записи в ini:

[defaults ]
remote_user = VALUE

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

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

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

Можно настроить из CLI с помощью опций --user или -u

int

120

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

boolean

"нет"

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

Подключаться ли по SSL (HTTPS) или нет (HTTP)