cnos_conditional_command – Выполнение единственной команды на основе условия на устройствах с Lenovo CNOS
Новое в версии 2.3.
Описание
- Этот модуль позволяет изменять текущую конфигурацию коммутатора. Он предоставляет способ выполнения одной команды CNOS на сетевом устройстве, оценивая текущую конфигурацию и выполняя команду только в том случае, если соответствующие настройки ещё не были сконфигурированы. Команда CNOS передаётся в качестве аргумента метода. Этот модуль работает так же, как модуль cnos_command. Единственное исключение состоит в том, что можно указать переменную инвентаризации [“condition = <строка флага>”]. Когда эта переменная инвентаризации указана в качестве переменной задачи, команда выполняется для сетевого элемента, соответствующего строке флага. Обычно команды выполняются для группы сетевых устройств. Если необходимо пропустить выполнение команды на одном или нескольких устройствах, рекомендуется использовать этот модуль. Этот модуль использует SSH для управления конфигурацией сетевых устройств.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| clicommand - / обязательно | Значение по умолчанию: null | Это указывает команду CLI как атрибут этого метода. Команда передаётся в двойных кавычках. Переменные могут быть размещены непосредственно в командах CLI или вызваны из каталога vars. |
| condition - / обязательно | Значение по умолчанию: null | Если в файле инвентаризации для любого устройства вы укажете condition=false, выполнение команды для этого устройства будет пропущено. |
| deviceType - / обязательно добавлен в 2.3 |
| Это указывает тип устройства, на котором выполняется метод. Варианты NE1072T, NE1032, NE1032T, NE10032, NE2572 добавлены с версии 2.4. |
| enablePassword - добавлен в 2.3 | Настраивает пароль, используемый для входа в режим глобальной конфигурации на коммутаторе. Если коммутатор не запрашивает этот пароль, параметр игнорируется. Хотя, как правило, значение должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр необязателен. Если он не указан, значение по умолчанию не будет использоваться. | |
| flag - / обязательно | Значение по умолчанию: null | Если задача должна быть выполнена, необходимо установить флаг, точно так же, как он указан в инвентаризации для этого устройства. |
| host - / обязательно добавлен в 2.3 | Эта переменная используется для поиска файла hosts по пути /etc/ansible/hosts и определения IP-адреса устройства, на котором будет применена шаблон. Обычно в плейбуке используется ключевое слово Ansible {{ inventory_hostname }} в качестве абстракции группы сетевых элементов, которые необходимо сконфигурировать. | |
| outputfile - / обязательно добавлен в 2.3 | Это указывает путь к файлу, в который сохраняется вывод каждого выполнения команды. Здесь сохраняются каждая команда, указанная в объединённом файле шаблона, и каждый ответ от устройства. Обычно расположением является папка результатов, но вы можете выбрать другое расположение в зависимости от ваших прав записи. | |
| password - / обязательно добавлен в 2.3 | Настраивает пароль, используемый для аутентификации подключения к удалённому устройству. Значение параметра password используется для аутентификации сессии SSH. Хотя, как правило, значение должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр необязателен. Если он не указан, значение по умолчанию не будет использоваться. | |
| username - / обязательно добавлен в 2.3 | Настраивает имя пользователя, используемое для аутентификации подключения к удалённому устройству. Значение параметра username используется для аутентификации сессии SSH. Хотя, как правило, значение должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр необязателен. Если он не указан, значение по умолчанию не будет использоваться. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами Lenovo см. на странице https://www.ansible.com/ansible-lenovo.
Примеры
Tasks : The following are examples of using the module
cnos_conditional_command. These are written in the main.yml file of the tasks
directory.
---
- name: Applying CLI template on VLAG Tier1 Leaf Switch1
cnos_conditional_command:
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
outputfile: "./results/test_conditional_command_
{{ inventory_hostname }}_output.txt"
condition: "{{ hostvars[inventory_hostname]['condition']}}"
flag: leaf_switch2
command: "spanning-tree mode enable"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| msg строка | всегда | Сообщение об успехе или ошибке Пример: Команда применена |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Anil Kumar Muraleedharan (@amuraleedhar)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/cnos_conditional_command_module.html
