network_cli - Использование network_cli для выполнения команд на сетевых устройствах
Новая версия 2.3.
Обзор
- Этот плагин подключения обеспечивает соединение с удаленными устройствами по SSH и реализует оболочку CLI. Этот плагин подключения обычно используется сетевыми устройствами для отправки и получения команд CLI сетевым устройствам.
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии |
|---|---|---|---|
|
become
boolean
|
Значение по умолчанию: "нет"
|
строки ini:
[privilege_escalation ] переменная окружения:ANSIBLE_BECOME
переменная: ansible_become
|
Опция become укажет сессии CLI попытку повышения привилегий на платформах, которые ее поддерживают. Обычно это означает переход от пользовательского режима к
enable режиму в сессии CLI. Если become установлено в True, а удаленное устройство не поддерживает повышение привилегий или привилегии уже повышены, эта опция будет проигнорирована.Можно настроить из командной строки с помощью опций
--become или -b |
| become_method |
Значение по умолчанию: "sudo"
|
строки ini:
[privilege_escalation ] переменная окружения:ANSIBLE_BECOME_METHOD
переменная: ansible_become_method
|
Эта опция позволяет указать метод become для обработки повышения привилегий. Обычно значение become_method устанавливается в
enable, но может быть определено и другими значениями. |
| host |
Значение по умолчанию: "inventory_hostname"
|
переменная: ansible_host
|
Указывает FQDN или IP-адрес удаленного устройства для создания SSH-соединения.
|
|
host_key_auto_add
boolean
|
Значение по умолчанию: "нет"
|
строки ini:
[paramiko_connection ] переменная окружения:ANSIBLE_HOST_KEY_AUTO_ADD
|
По умолчанию Ansible запросит пользователя перед добавлением SSH-ключа в файл известных хостов. Так как постоянные соединения, такие как network_cli, работают в фоновых процессах, пользователя никогда не будут спрашивать. Включив эту опцию, неизвестные ключи хостов будут автоматически добавлены в файл известных хостов.
Убедитесь, что вы полностью понимаете последствия включения этой опции в производственной системе, так как она может создать уязвимость в системе безопасности.
|
| network_os |
переменная: ansible_network_os
|
Конфигурирует сетевую операционную систему платформы устройства. Это значение используется для загрузки правильных плагинов терминала и cliconf для взаимодействия с удаленным устройством
|
|
| password |
переменная: ansible_password
переменная: ansible_ssh_pass
|
Настраивает пароль пользователя, используемый для аутентификации на удаленном устройстве при первом подключении по SSH.
|
|
|
persistent_command_timeout
int
|
Значение по умолчанию: 10
|
строки ini:
[persistent_connection ] переменная окружения:ANSIBLE_PERSISTENT_COMMAND_TIMEOUT
|
Конфигурирует время ожидания возврата команды с удаленного устройства в секундах. Если этот таймер истечет до возвращения команды, плагин подключения сгенерирует исключение и закроет соединение.
|
|
persistent_connect_timeout
int
|
Значение по умолчанию: 30
|
строки ini:
[persistent_connection ] переменная окружения:ANSIBLE_PERSISTENT_CONNECT_TIMEOUT
|
Конфигурирует время ожидания при попытке первоначального подключения к постоянно действующему соединению в секундах. Если это значение истечет до завершения подключения к удаленному устройству, подключение будет неудачным
|
|
port
int
|
Значение по умолчанию: 22
|
строки ini:
[defaults ] переменная окружения:ANSIBLE_REMOTE_PORT
переменная: ansible_port
|
Указывает порт на удаленном устройстве, который слушает подключения при создании SSH-соединения.
|
| private_key_file |
строки ini:
[defaults ] переменная окружения:ANSIBLE_PRIVATE_KEY_FILE
переменная: ansible_private_key_file
|
Приватный SSH-ключ или сертификат, используемый для аутентификации на удаленном устройстве при первом подключении по SSH.
|
|
| remote_user |
строки ini:
[defaults ] переменная окружения:ANSIBLE_REMOTE_USER
переменная: ansible_user
|
Имя пользователя, используемое для аутентификации на удаленном устройстве при первом подключении по SSH. Если remote_user не указан, подключение будет использовать имя пользователя вошедшего пользователя.
Можно настроить из командной строки с помощью опций
--user или -u |
|
|
timeout
int
|
Значение по умолчанию: 120
|
Устанавливает время соединения в секундах для взаимодействия с удаленным устройством. Этот таймаут используется в качестве значения таймаута по умолчанию для команд при выполнении команды в сетевой CLI. Если команда не вернет результат в течение времени таймаута, генерируется ошибка.
|
Статус
Автор
- Команда Ansible Networking
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ для его улучшения.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/plugins/connection/network_cli.html
