cisco.nxos.nxos_nxapi – Управление конфигурацией NXAPI на устройстве NXOS.
Примечание
Этот плагин входит в коллекцию cisco.nxos (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Чтобы использовать его в книге задач, укажите: cisco.nxos.nxos_nxapi.
Новое в версии 1.0.0: для cisco.nxos
Описание
- Настраивает функцию NXAPI на устройствах, работающих под управлением Cisco NXOS. Функция NXAPI по умолчанию отсутствует в конфигурации. Поскольку этот модуль управляет функцией NXAPI, он поддерживает только использование
Cliтранспорта.
Примечание
У данного модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| http boolean |
| Управляет состоянием протокола HTTP как одним из базовых транспортов для NXAPI. По умолчанию NXAPI включает транспорт HTTP при первой настройке функции. Для отключения использования транспорта HTTP установите значение этого аргумента в False. псевдонимы: enable_http | |
| http_port integer | Значение по умолчанию: 80 | Настройка порта, на котором HTTP-сервер будет прослушивать запросы. По умолчанию NXAPI привязывает HTTP-сервис к стандартному порту HTTP 80. Этот аргумент принимает допустимые значения портов в диапазоне от 1 до 65535. | |
| https boolean |
| Управляет состоянием протокола HTTPS как одним из базовых транспортов для NXAPI. По умолчанию NXAPI отключает транспорт HTTPS при первой настройке функции. Для включения использования транспорта HTTPS установите значение этого аргумента в True. псевдонимы: enable_https | |
| https_port integer | Значение по умолчанию: 443 | Настройка порта, на котором HTTPS-сервер будет прослушивать запросы. По умолчанию NXAPI привязывает HTTPS-сервис к стандартному порту HTTPS 443. Этот аргумент принимает допустимые значения портов в диапазоне от 1 до 65535. | |
| provider dictionary | Устаревший Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli. Начиная с Ansible 2.6 рекомендуется использовать connection: httpapi для NX-API.Этот параметр будет удален в релизе после 2022-06-01. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий данные соединения. | ||
| auth_pass string | Указывает пароль для использования при входе в привилегированный режим на удаленном устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host string | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| password string | Указывает пароль для проверки подлинности подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port integer | Указывает порт для построения подключения к удаленному устройству. Это значение применяется к транспорту cli или nxapi. Значение порта по умолчанию соответствует соответствующему общему порту транспорта, если он не задан в задаче (cli=22, http=80, https=443). | ||
| ssh_keyfile string | Указывает SSH-ключ для проверки подлинности подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout integer | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.). | ||
| transport string |
| Настройка транспорта для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy boolean |
| Если no, переменные окружения http_proxy и https_proxy будут игнорироваться. | |
| use_ssl boolean |
| Настраивает транспорт transport для использования SSL, если установлено значение yes, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username string | Настройка имени пользователя для проверки подлинности подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверяться. Это следует использовать только на контролируемых вами сайтах с самозаверяющими сертификатами. Если аргумент transport не равен nxapi, это значение игнорируется. | |
| sandbox boolean |
| Функция NXAPI предоставляет веб-интерфейс для разработчиков для ввода команд. Эта функция изначально отключена при первой настройке функции NXAPI. Когда аргумент sandbox установлен в True, URL разработчика-песочницы будет принимать запросы, а при установке в False URL песочницы недоступен. Поддерживается на серии устройств NX-OS 7K.псевдонимы: enable_sandbox | |
| ssl_strong_ciphers boolean |
| Управляет использованием того, настроены ли сильные или слабые шифры. По умолчанию эта функция отключена и настроены слабые шифры. Для включения использования сильных шифров установите значение этого аргумента в True. | |
| state string |
| Аргумент state управляет тем, настраивается ли функция NXAPI на удаленном устройстве или нет. Когда значение равно present, конфигурация функции NXAPI присутствует в конфигурации устройства running-config. Когда значение равно absent, конфигурация функции удаляется из running-config. | |
| tlsv1_0 boolean |
| Управляет использованием протокола Transport Layer Security версии 1.0. По умолчанию эта функция включена. Для отключения TLSV1.0 установите значение этого аргумента в True. | |
| tlsv1_1 boolean |
| Управляет использованием протокола Transport Layer Security версии 1.1. По умолчанию эта функция отключена. Для включения TLSV1.1 установите значение этого аргумента в True. | |
| tlsv1_2 boolean |
| Управляет использованием протокола Transport Layer Security версии 1.2. По умолчанию эта функция отключена. Для включения TLSV1.2 установите значение этого аргумента в True. | |
Примечания
Примечание
- Дополнительная информация по использованию CLI и NX-API находится в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- name: Enable NXAPI access with default configuration
cisco.nxos.nxos_nxapi:
state: present
- name: Enable NXAPI with no HTTP, HTTPS at port 9443 and sandbox disabled
cisco.nxos.nxos_nxapi:
enable_http: false
https_port: 9443
https: yes
enable_sandbox: no
- name: remove NXAPI configuration
cisco.nxos.nxos_nxapi:
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| updates список / элементы=строка | всегда | Возвращает список команд, которые необходимо передать на удалённое устройство, чтобы выполнить заданные аргументы Пример: ['no feature nxapi'] |
Авторы
- Peter Sprygada (@privateip)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_nxapi_module.html
