cnos_conditional_command - Выполнение одной команды на основе условия на устройствах с Lenovo CNOS
Новая в версии 2.3.
Описание
- Этот модуль позволяет изменять текущую конфигурацию коммутатора. Он предоставляет способ выполнения одной команды CNOS на сетевом устройстве, оценивая текущую конфигурацию и выполняя команду только в том случае, если определенные настройки ещё не были сконфигурированы. Команда CNOS передаётся в качестве аргумента метода. Этот модуль работает аналогично модулю cnos_command. Единственное исключение состоит в том, что можно указать следующую переменную инвентаризации [“condition = <строка флага>”]. Когда эта переменная инвентаризации указана как переменная задачи, команда выполняется для сетевого элемента, соответствующего строке флага. Обычно команды выполняются на группе сетевых устройств. Если необходимо пропустить выполнение команды на одном или нескольких устройствах, рекомендуется использовать этот модуль. Этот модуль использует SSH для управления конфигурацией сетевого устройства. Более подробную информацию об этом модуле от Lenovo и его настройке для ваших задач можно найти по адресу http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_conditional_command.html
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
|
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)
|
Эта переменная используется для поиска файла хостов в /etc/ansible/hosts и определения IP-адреса устройства, на котором будет применена шаблон. Обычно в плейбуке используется ключевое слово Ansible {{ inventory_hostname }} как абстракция группы сетевых элементов, которые нужно настроить.
|
|
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Lenovo Network см. в 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:
host: "{{ inventory_hostname }}"
username: "{{ hostvars[inventory_hostname]['ansible_ssh_user'] }}"
password: "{{ hostvars[inventory_hostname]['ansible_ssh_pass'] }}"
deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
enablePassword: "{{ hostvars[inventory_hostname]['enablePassword'] }}"
outputfile: "./results/test_conditional_command_{{ inventory_hostname }}_output.txt"
condition: "{{ hostvars[inventory_hostname]['condition']}}"
flag: leaf_switch2
command: "spanning-tree mode enable"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
|
msg
строка
|
всегда |
Сообщение об успехе или ошибке
Пример:
Команда применена
|
Статус
Этот модуль помечен как превью, что означает, что интерфейс не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Более подробную информацию см. в Поддержка и обслуживание модулей.
Список других модулей, которые также поддерживаются сообществом 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.6/modules/cnos_conditional_command_module.html