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'.