cnos_command - Выполнение одной команды на устройствах с Lenovo CNOS
Новое в версии 2.3.
Описание
- Этот модуль позволяет модифицировать конфигурацию коммутатора в рабочем режиме. Он предоставляет способ выполнения одной команды CNOS на коммутаторе, оценивая текущую рабочую конфигурацию и выполняя команду только в том случае, если конкретная настройка еще не настроена. Команда CNOS передается в качестве аргумента метода. Этот модуль использует SSH для управления конфигурацией сетевого устройства. Результаты операции будут помещены в директорию с именем «results», которую пользователь должен создать в локальном каталоге, где выполняется playbook. Дополнительную информацию об этом модуле от Lenovo и настройку его использования для ваших задач см. на сайте http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_command.html
Параметры
| параметр | обязательно | по умолчанию | возможные значения | комментарии |
|---|---|---|---|---|
| clicommand | да | Указывает команду CLI как атрибут этого метода. Команда передается в двойных кавычках. Переменные можно поместить непосредственно в команды CLI или вызвать из каталога vars. | ||
| deviceType (добавлен в 2.3)
| да |
| Указывает тип устройства, на котором выполняется метод. Значения NE1072T, NE1032, NE1032T, NE10032, NE2572 добавлены с версии 2.4 | |
| enablePassword (добавлен в 2.3)
| нет | Настраивает пароль, используемый для входа в режим команд глобальной конфигурации коммутатора. Если коммутатор не запрашивает этот пароль, параметр игнорируется. Хотя значение обычно должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр необязателен. Если он не указан, значение по умолчанию не будет использоваться. | ||
| host (добавлен в 2.3)
| да | Эта переменная используется для поиска файла хостов в /etc/ansible/hosts и определения IP-адреса устройства, на котором будет применена шаблон. Обычно в playbook используется ключевое слово Ansible {{ inventory_hostname }} как абстракция группы сетевых элементов, которые необходимо настроить. | ||
| outputfile (добавлен в 2.3)
| да | Указывает путь к файлу, где сохраняется вывод каждого выполнения команды. Здесь сохраняются каждая команда, указанная в объединенном файле шаблона, и каждый ответ от устройства. Обычно это папка результатов, но вы можете выбрать другое местоположение в зависимости от ваших прав записи. | ||
| password (добавлен в 2.3)
| да | Настраивает пароль, используемый для аутентификации подключения к удаленному устройству. Значение параметра password используется для аутентификации сессии SSH. Хотя значение обычно должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр необязателен. Если он не указан, значение по умолчанию не будет использоваться. | ||
| username (добавлен в 2.3)
| да | Настраивает имя пользователя, используемое для аутентификации подключения к удаленному устройству. Значение параметра username используется для аутентификации сессии SSH. Хотя значение обычно должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр необязателен. Если он не указан, значение по умолчанию не будет использоваться. |
Примеры
Tasks : The following are examples of using the module cnos_command. These are written in the main.yml file of the tasks directory.
---
- name: Test Command
cnos_command:
host: "{{ inventory_hostname }}"
username: "{{ hostvars[inventory_hostname]['username'] }}"
password: "{{ hostvars[inventory_hostname]['password'] }}"
enablePassword: "{{ hostvars[inventory_hostname]['enablePassword'] }}"
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_command_{{ inventory_hostname }}_output.txt"
clicommand: "display users"
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, а следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| msg | Сообщение об успехе или неудаче | всегда | строка | Команда применена |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Для получения помощи в разработке модулей, если у вас есть желание, прочтите Информацию о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/cnos_command_module.html