nxos_nxapi – Управление конфигурацией NXAPI на устройстве NXOS
Новое в версии 2.1.
Описание
- Настраивает функцию NXAPI на устройствах, работающих под управлением Cisco NXOS. Функция NXAPI по умолчанию отсутствует в конфигурации. Поскольку этот модуль управляет функцией NXAPI, он поддерживает только использование транспорта
Cli.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| http boolean |
| Управляет состоянием протокола HTTP как одного из базовых транспортных протоколов для NXAPI. По умолчанию NXAPI включает HTTP-транспорт при первой настройке функции. Чтобы отключить использование HTTP-транспорта, установите значение этого аргумента в False. Псевдонимы: enable_http | |
| http_port - | Значение по умолчанию: 80 | Настройте порт, на котором HTTP-сервер будет прослушивать запросы. По умолчанию NXAPI привязывает HTTP-сервис к стандартному порту HTTP 80. Этот аргумент принимает допустимые значения портов в диапазоне от 1 до 65535. | |
| https boolean |
| Управляет состоянием протокола HTTPS как одного из базовых транспортных протоколов для NXAPI. По умолчанию NXAPI отключает HTTPS-транспорт при первой настройке функции. Чтобы включить использование HTTPS-транспорта, установите значение этого аргумента в True. Псевдонимы: enable_https | |
| https_port - | Значение по умолчанию: 443 | Настройте порт, на котором HTTPS-сервер будет прослушивать запросы. По умолчанию NXAPI привязывает HTTPS-сервис к стандартному порту HTTPS 443. Этот аргумент принимает допустимые значения портов в диапазоне от 1 до 65535. | |
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации см. руководство по параметрам платформы NXOS NXOS Platform Options guide. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка добавлено в 2.5.3 | Указывает пароль для использования при входе в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean добавлено в 2.5.3 |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host строка / обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | Значение по умолчанию: "0 (использовать общий порт)" | Указывает порт для построения подключения к удаленному устройству. Это значение применяется к транспорту cli или nxapi. Значение порта по умолчанию будет соответствовать общему порту соответствующего транспорта, если в задаче не указано иное (cli=22, http=80, https=443). | |
| ssh_keyfile строка | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число добавлено в 2.3 | Значение по умолчанию: 10 | Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут превышен до завершения операции, модуль выдаст ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т. д.). | |
| transport строка / обязательно |
| Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy boolean добавлено в 2.5 |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl boolean |
| Настраивает транспорт для использования SSL, если установлено значение yes, только при transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в 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 добавлено в 2.7 |
| Управляет использованием настройки сильных или слабых шифров. По умолчанию эта функция отключена, и настроены слабые шифры. Чтобы включить использование сильных шифров, установите значение этого аргумента в True. | |
| state - |
| Аргумент state управляет тем, настроена ли функция NXAPI на удаленном устройстве. Когда значение равно present, конфигурация функции NXAPI присутствует в текущей конфигурации устройства. Когда значение равно absent, конфигурация функции удаляется из текущей конфигурации. | |
| tlsv1_0 boolean добавлено в 2.7 |
| Управляет использованием протокола Transport Layer Security версии 1.0. По умолчанию эта функция включена. Чтобы отключить использование TLSV1.0, установите значение этого аргумента в True. | |
| tlsv1_1 boolean added in 2.7 |
| Управляет использованием версии Transport Layer Security 1.1. По умолчанию эта функция отключена. Чтобы включить использование TLSV1.1, установите значение этого аргумента в True. | |
| tlsv1_2 boolean added in 2.7 |
| Управляет использованием версии Transport Layer Security 1.2. По умолчанию эта функция отключена. Чтобы включить использование TLSV1.2, установите значение этого аргумента в True. | |
Примечания
Примечание
- Сведения об использовании командной строки и NX-API см. в руководстве NXOS Platform Options.
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide.
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco Cisco integration page.
Примеры
- name: Enable NXAPI access with default configuration
nxos_nxapi:
state: present
- name: Enable NXAPI with no HTTP, HTTPS at port 9443 and sandbox disabled
nxos_nxapi:
enable_http: false
https_port: 9443
https: yes
enable_sandbox: no
- name: remove NXAPI configuration
nxos_nxapi:
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| updates список | всегда | Возвращает список команд, которые необходимо передать на удаленное устройство, чтобы удовлетворить аргументы. Пример: ['no feature nxapi'] |
Статус
- Для этого модуля не гарантируется обратная совместимость интерфейса. [превью]
- Этот модуль поддерживается командой Ansible Network Team. [сетевой]
Поддержка Red Hat
Дополнительную информацию о поддержке Red Hat данного модуля можно найти в этой статье базы знаний Red Hat Red Hat Knowledge Base article.
Авторы
- Peter Sprygada (@privateip)
Подсказка
Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/nxos_nxapi_module.html
