cisco.nxos.nxos_feature – Управление функциями на коммутаторах NX-OS.
Примечание
Этот плагин входит в коллекцию cisco.nxos (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в книге задач укажите: cisco.nxos.nxos_feature.
Новое в версии 1.0.0: cisco.nxos
Обзор
- Предоставляет возможность включения и выключения функций в NX-OS.
Примечание
Данный модуль имеет соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| feature строка / обязательно | Имя функции. | ||
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.Начиная с Ansible 2.6, рекомендуется использовать connection: httpapi для NX-API.Этот параметр будет удален в выпуске после 2022-06-01. Дополнительная информация в руководстве NXOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize булево |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удаленному устройству. Этот аргумент часто используется для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт для подключения к удаленному устройству. Это значение применяется к cli или nxapi. Значение порта по умолчанию соответствует общепринятому порту для транспорта, если в задаче не указано иное. (cli=22, http=80, https=443). | ||
| ssh_keyfile строка | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль возвращает ошибку. NX-API может медленно реагировать на длительные команды (sh mac, sh bgp и т.д.). | ||
| transport строка |
| Настраивает транспортное подключение для соединения с удаленным устройством. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy булево |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl булево |
| Настраивает transport для использования SSL, если установлено yes только при transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs булево |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах, использующих самозаверенные сертификаты. Если аргумент transport не равен nxapi, это значение игнорируется. | |
| state строка |
| Желаемое состояние функции. | |
Примечания
Примечание
- Информация об использовании CLI и NX-API в руководстве NXOS Platform Options
- Дополнительная информация об использовании Ansible для управления сетевыми устройствами в руководстве Ansible Network Guide
- Дополнительная информация об использовании Ansible для управления устройствами Cisco на странице интеграции Cisco.
Примеры
- name: Ensure lacp is enabled
cisco.nxos.nxos_feature:
feature: lacp
state: enabled
- name: Ensure ospf is disabled
cisco.nxos.nxos_feature:
feature: ospf
state: disabled
- name: Ensure vpc is enabled
cisco.nxos.nxos_feature:
feature: vpc
state: enabled
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда | Набор команд, которые необходимо отправить на удаленное устройство Пример: ['nv overlay evpn'] |
Авторы
- Jason Edelman (@jedelman8)
- Gabriele Gerbino (@GGabriele)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/nxos/nxos_feature_module.html
