nxos_nxapi — Управление конфигурацией NXAPI на устройстве NXOS.
Новое в версии 2.1.
Описание
- Настраивает функцию NXAPI на устройствах, работающих под управлением Cisco NXOS. Функция NXAPI по умолчанию отсутствует в конфигурации. Поскольку этот модуль управляет функцией NXAPI, он поддерживает только использование транспорта
Cli.
Параметры
| Параметр | Обязателен | Значение по умолчанию | Допустимые значения | Комментарии |
|---|---|---|---|---|
| auth_pass (Добавлен в 2.4.4)
| Нет | нет | Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это необходимо. Если authorize ложно, этот аргумент не имеет эффекта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| authorize (Добавлен в 2.4.4)
| Нет |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host | Да | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение параметра host используется в качестве адреса назначения для транспорта. | ||
| http | Нет | True |
| Управляет рабочим состоянием протокола HTTP как одного из базовых транспортов для NXAPI. По умолчанию NXAPI включит транспорт HTTP при первой настройке функции. Чтобы отключить использование транспорта HTTP, установите значение этого аргумента в False. Псевдонимы: enable_http |
| http_port | Нет | 80 | Настройка порта, на котором HTTP-сервер будет слушать запросы. По умолчанию NXAPI привязывает HTTP-сервис к стандартному порту HTTP 80. Этот аргумент принимает допустимые значения портов в диапазоне от 1 до 65535. | |
| https | Нет |
| Управляет рабочим состоянием протокола HTTPS как одного из базовых транспортов для NXAPI. По умолчанию NXAPI отключит транспорт HTTPS при первой настройке функции. Чтобы включить использование транспорта HTTPS, установите значение этого аргумента в True. Псевдонимы: enable_https | |
| https_port | Нет | 443 | Настройка порта, на котором HTTPS-сервер будет слушать запросы. По умолчанию NXAPI привязывает HTTPS-сервис к стандартному порту HTTPS 443. Этот аргумент принимает допустимые значения портов в диапазоне от 1 до 65535. | |
| password | Нет | Указывает пароль для аутентификации соединения с удалённым устройством. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port | Нет | 0 (использовать стандартный порт) | Указывает порт для подключения к удалённому устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию соответствует стандартному порту соответствующего транспорта, если он не указан в задаче (cli=22, http=80, https=443). | |
| provider | Нет | Удобный метод, позволяющий передавать все аргументы nxos как объект словаря. Все ограничения (обязательность, допустимые значения и т. д.) должны быть выполнены либо отдельными аргументами, либо значениями в этом словаре. | ||
| sandbox | Нет |
| Функция NXAPI предоставляет веб-UI для разработчиков для ввода команд. Эта функция изначально отключена при первой настройке функции NXAPI. Когда аргумент sandbox установлен в True, URL песочницы разработчика будет принимать запросы, а при установке в False URL песочницы недоступен.Псевдонимы: enable_sandbox | |
| ssh_keyfile | Нет | Указывает SSH-ключ для аутентификации соединения с удалённым устройством. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| state | Нет | present |
| Аргумент state управляет тем, включена ли функция NXAPI на удалённом устройстве. При значении present конфигурация функции NXAPI присутствует в running-config устройства. При значении absent конфигурация функции удаляется из running-config. |
| timeout (Добавлен в 2.3)
| Нет | 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| transport | Да | cli | Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl | Нет |
| Настраивает транспорт transport на использование SSL, если значение равно true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username | Нет | Настраивает имя пользователя для аутентификации соединения с удалённым устройством. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs | Нет |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с самозаверенными сертификатами. Если аргумент transport не равен nxapi, это значение игнорируется. |
Примеры
- 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'] |
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантированно будет обратно совместимым.
Информация о техническом обслуживании
Для получения дополнительной информации о поддержке этого модуля Red Hat, обратитесь к knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Для получения помощи в разработке модулей, если вы заинтересованы, прочитайте Информация о сообществе и участие, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_nxapi_module.html
