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

boolean

записи ini:

[privilege_escalation]
become = нет

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

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

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

Может быть настроен из CLI с помощью опций --become или -b.

строка

"sudo"

записи ini:

[privilege_escalation]
become_method = sudo

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

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

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

строка

"inventory_hostname"

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

Указывает FQDN или IP-адрес удалённого устройства для установления SSH-соединения.

boolean

записи ini:

[paramiko_connection]
host_key_auto_add = нет

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

По умолчанию Ansible запросит пользователя перед добавлением SSH-ключей в файл известных хостов. Так как постоянные подключения, такие как network_cli, выполняются в фоновых процессах, пользователь никогда не будет спрошен. Включив этот параметр, неизвестные ключи хостов будут автоматически добавлены в файл известных хостов.

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

целое число

3

записи ini:

[persistent_connection]
network_cli_retries = 3

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

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

Количество попыток подключения к удалённому хосту. Время ожидания между попытками увеличивается после каждой попытки в степени 2 в секундах до тех пор, пока не будут исчерпаны все попытки или не будут сработаны таймеры persistent_command_timeout или persistent_connect_timeout.

строка

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

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

строка

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

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

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

Настраивает пароль пользователя, используемый для аутентификации на удалённом устройстве при первом установлении SSH-соединения.

вещественное число

0.1

записи ini:

[persistent_connection]
buffer_read_timeout = 0.1

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

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

Настраивает время ожидания (в секундах) для чтения данных из канала Paramiko после совпадения командного приглашения. Это значение таймаута гарантирует, что командное приглашение совпадает и больше нет данных, которые необходимо получить от удалённого хоста.

целое число

30

записи ini:

[persistent_connection]
command_timeout = 30

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

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

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

целое число

30

записи ini:

[persistent_connection]
connect_timeout = 30

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

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

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

boolean

записи ini:

[persistent_connection]
log_messages = нет

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

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

Этот флаг включит протоколирование команды, выполненной и полученного ответа от целевого устройства в файл журнала Ansible. Для работы этого параметра требуется параметр конфигурации Ansible «log_path», установленный в путь к файлу с правами записи.

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

целое число

22

записи ini:

[defaults]
remote_port = 22

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

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

Указывает порт на удалённом устройстве, который прослушивает подключения при установлении SSH-соединения.

строка

записи ini:

[defaults]
private_key_file = None

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

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

Приватный SSH-ключ или сертификат, используемый для аутентификации на удалённом устройстве при первом установлении SSH-соединения.

строка

записи ini:

[defaults]
remote_user = None

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

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

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

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

строка

"paramiko"

записи ini:

[persistent_connection]
ssh_type = paramiko

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

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

Тип транспорта, используемый плагином подключения network_cli для подключения к удалённому хосту. Допустимые значения — paramiko или libssh

boolean

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

Этот булевый флаг, который, когда установлен в True, отправит новую строку в ответе, если какой-либо из значений в terminal_initial_prompt совпадает.

список / элементы=строка

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

Ответ, который нужно отправить, если совпадёт terminal_initial_prompt. Значение может быть одним ответом или списком ответов для нескольких terminal_initial_prompt. В случае, если меню входа имеет несколько приглашений, последовательность приглашения и ожидаемого ответа должна быть в том же порядке, и значение terminal_prompt_checkall должно быть установлено в True, если ожидается соответствие всем значениям в terminal_initial_prompt, и в False, если ожидается соответствие только одному приглашению для входа.

список / элементы=строка

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

Один регулярный шаблон или последовательность шаблонов для оценки ожидаемого приглашения во время первоначального входа на удалённый хост.

boolean

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

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

список / элементы=словарь

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

Этот параметр предоставляет регулярный шаблон и необязательные флаги для сопоставления строки ошибки из полученного фрагмента ответа. Этот параметр принимает ключи pattern и flags. Значение pattern — это регулярный шаблон Python для сопоставления ответа, а значение flags — это значение, принимаемое аргументом flags метода re.compile языка Python для управления способом сопоставления регулярного выражения с ответом, например 're.I'.

список / элементы=словарь

var: ansible_terminal_stdout_re

Единый шаблон регулярного выражения или последовательность шаблонов вместе с необязательными флагами для сопоставления командной строки из полученного фрагмента ответа. Этот параметр принимает ключи pattern и flags. Значение pattern — шаблон регулярного выражения Python для сопоставления ответа, а значение flags — значение, принимаемое аргументом flags метода re.compile языка Python для управления способом сопоставления регулярного выражения с ответом, например, 're.I'.