nxos_facts – Получение фактов о коммутаторах NX-OS
Новая версия 2.1.
Описание
- Сбор фактов с устройств Cisco Nexus, работающих под управлением операционной системы NX-OS. Сбор фактов поддерживается по протоколам Cli и Nxapi. Этот модуль добавляет префикс
ansible_net_<fact>ко всем базовым ключам фактов сети. Модуль фактов всегда собирает базовый набор фактов с устройства и может включать или отключать сбор дополнительных фактов.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| gather_subset - добавлен в 2.2 | По умолчанию: "!config" | При указании этого аргумента, сбор фактов будет ограничен заданным подмножеством. Возможные значения для этого аргумента включают all, hardware, config, legacy и interfaces. Можно указать список значений для включения большего подмножества. Значения также могут быть использованы с начальным ! для указания, что определенное подмножество не должно собираться. | |
| provider словарь | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только если вы используете NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий детали подключения. | ||
| auth_pass строка добавлен в 2.5.3 | Указывает пароль для использования при необходимости входа в привилегированный режим на удаленном устройстве. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение добавлен в 2.5.3 |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host строка / обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному протоколу. Значение хоста используется в качестве адреса назначения для протокола. | ||
| 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 логическое значение добавлен в 2.5 |
| Если no, переменные окружения http_proxy и https_proxy будут игнорироваться. | |
| use_ssl логическое значение |
| Настраивает transport на использование SSL, если значение yes, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi, в зависимости от используемого протокола. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs логическое значение |
| Если no, сертификаты SSL не будут проверяться. Это следует использовать только на контролируемых вами сайтах, использующих самозаверяемые сертификаты. Если аргумент transport не nxapi, это значение игнорируется. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Информация об использовании CLI и NX-API представлена в руководстве NXOS Platform Options
- Дополнительная информация об использовании Ansible для управления сетевыми устройствами представлена в руководстве Ansible Network Guide
- Дополнительная информация об использовании Ansible для управления устройствами Cisco находится на странице интеграции Cisco.
Примеры
- nxos_facts:
gather_subset: all
# Collect only the config and default facts
- nxos_facts:
gather_subset:
- config
# Do not collect hardware facts
- nxos_facts:
gather_subset:
- "!hardware"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращается | Описание |
|---|---|---|
| ansible_net_all_ipv4_addresses список | при конфигурировании интерфейсов | Все настроенные IPv4-адреса устройства |
| ansible_net_all_ipv6_addresses список | при конфигурировании интерфейсов | Все настроенные IPv6-адреса устройства |
| ansible_net_api строка | всегда | Имя транспорта |
| ansible_net_config строка | при конфигурировании конфигурации | Текущая активная конфигурация устройства |
| ansible_net_filesystems список | при конфигурировании оборудования | Все имена файловых систем, доступные на устройстве |
| ansible_net_gather_subset список | всегда | Список подмножеств фактов, собранных с устройства |
| ansible_net_hostname строка | всегда | Настроенное имя хоста устройства |
| ansible_net_image строка | всегда | Файл образа, используемый устройством |
| ansible_net_interfaces словарь | при конфигурировании интерфейсов | Хеш всех работающих на системе интерфейсов |
| ansible_net_license_hostid строка | всегда | Идентификатор хоста лицензии устройства |
| ansible_net_memfree_mb целое число | при конфигурировании оборудования | Доступная свободная память на удаленном устройстве в Мб |
| ansible_net_memtotal_mb целое число | при конфигурировании оборудования | Общий объем памяти на удаленном устройстве в Мб |
| ansible_net_model строка | всегда | Имя модели, возвращённое устройством |
| ansible_net_neighbors словарь | при конфигурировании интерфейсов | Список соседей LLDP и CDP с устройства. Если присутствуют данные о соседях CDP и LLDP на одном порту, предпочтительнее CDP. |
| ansible_net_python_version строка | всегда | Версия Python, используемая контроллером Ansible |
| ansible_net_serialnum строка | всегда | Серийный номер удалённого устройства |
| ansible_net_version строка | всегда | Версия операционной системы, работающей на удалённом устройстве |
| fan_info словарь | при конфигурировании legacy | Хеш фактов о вентиляторах на удалённом устройстве |
| hostname словарь | при конфигурировании legacy | Настроенное имя хоста удалённого устройства |
| interfaces_list словарь | при конфигурировании legacy | Список имён интерфейсов на удалённом устройстве |
| kickstart строка | при конфигурировании legacy | Версия программного обеспечения, используемого для загрузки системы |
| module словарь | при конфигурировании legacy | Хеш фактов о модулях на удалённом устройстве |
| platform строка | при конфигурировании legacy | Аппаратная платформа, сообщённая удалённым устройством |
| power_supply_info строка | при конфигурировании legacy | Хеш фактов о блоках питания на удалённом устройстве |
| vlan_list список | при конфигурировании legacy | Список идентификаторов VLAN, настроенных на удалённом устройстве |
Статус
- Данному модулю не гарантируется обратная совместимость интерфейса. [превью]
- Этот модуль поддерживается командой Ansible Network. [сетевой]
Поддержка Red Hat
Дополнительная информация о поддержке этого модуля Red Hat доступна в этой статье базы знаний Red Hat.
Авторы
- 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.8/modules/nxos_facts_module.html
