Модуль community.network.cnos_conditional_command – Выполнение одной команды на основе условия на устройствах под управлением Lenovo CNOS
Примечание
Этот модуль является частью коллекции community.network (версия 5.0.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.network.
Для использования в playbook, укажите: community.network.cnos_conditional_command.
Краткое описание
- Этот модуль позволяет изменять работающую конфигурацию коммутатора. Он предоставляет способ выполнить одну команду CNOS на сетевом устройстве, оценив текущую работающую конфигурацию и выполнив команду только в том случае, если определенные параметры еще не настроены. Команда CNOS передается как аргумент метода. Этот модуль работает так же, как модуль cnos_command. Единственное исключение состоит в том, что может быть указана следующая переменная инвентаризации [“condition = <flag string>”] Когда эта переменная инвентаризации указана как переменная задачи, команда выполняется для сетевого элемента, который соответствует строке флага. Обычно команды выполняются в группе сетевых устройств. Если необходимо пропустить выполнение команды на одном или нескольких устройствах, рекомендуется использовать этот модуль. Этот модуль использует SSH для управления конфигурацией сетевого устройства.
Псевдонимы: network.cnos.cnos_conditional_command
Параметры
Параметр | Комментарии |
|---|---|
clicommand строка / обязательно | Это указывает команду CLI как атрибут этого метода. Команда передается в двойных кавычках. Переменные могут быть размещены непосредственно в командах CLI или вызываться из каталога vars. |
condition строка / обязательно | Если вы укажете condition=false в файле инвентаризации для любого устройства, выполнение команды будет пропущено для этого устройства. |
deviceType строка / обязательно | Это указывает тип устройства, на котором выполняется метод. Варианты NE1072T, NE1032, NE1032T, NE10032, NE2572 добавлены начиная с Ansible 2.4. Вариант NE0152T добавлен начиная с 2.8 Варианты:
|
enablePassword строка | Настраивает пароль, используемый для входа в режим команд глобальной конфигурации на коммутаторе. Если коммутатор не запрашивает этот пароль, параметр игнорируется. Хотя, как правило, значение должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр необязателен. Если он не указан, значение по умолчанию не будет использоваться. |
flag строка / обязательно | Если необходимо выполнить задачу, необходимо установить флаг таким же, как он указан в инвентаризации для этого устройства. |
host строка / обязательно | Это переменная, используемая для поиска файла hosts в /etc/ansible/hosts и определения IP-адреса устройства, на которое будет применен шаблон. Обычно ключевое слово Ansible {{ inventory_hostname }} указывается в playbook как абстракция группы сетевых элементов, которые необходимо настроить. |
outputfile строка / обязательно | Это указывает путь к файлу, в котором сохраняется результат каждого выполнения команды. Каждая команда, указанная в объединенном файле шаблона, и каждый ответ от устройства сохраняются здесь. Обычно это папка результатов, но вы можете выбрать другое местоположение в зависимости от ваших прав на запись. |
password строка / обязательно | Настраивает пароль, используемый для аутентификации соединения с удаленным устройством. Значение параметра password используется для аутентификации сеанса SSH. Хотя, как правило, значение должно поступать из файла инвентаризации, вы также можете указать его как переменную. Этот параметр необязателен. Если он не указан, значение по умолчанию не будет использоваться. |
username строка / обязательно | Настраивает имя пользователя, используемое для аутентификации соединения с удаленным устройством. Значение параметра 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
community.network.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 строка | Сообщение об успехе или ошибке Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/cnos_conditional_command_module.html
