cisco.nxos.nxos_facts – Получение сведений о коммутаторах NX-OS
Примечание
Этот плагин входит в коллекцию cisco.nxos (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в плейбуке укажите: cisco.nxos.nxos_facts.
Новое в версии 1.0.0: модуля cisco.nxos
Обзор
- Собирает сведения о устройствах Cisco Nexus, работающих под управлением операционной системы NX-OS. Сбор данных поддерживается через транспортные средства Cli и Nxapi. Этот модуль добавляет ко всем базовым ключам сетевых данных префикс
ansible_net_<fact>. Модуль facts всегда собирает базовый набор данных с устройства и позволяет включать или отключать сбор дополнительных данных.
Примечание
Для этого модуля существует соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| gather_network_resources список / элементы=строка | При указании этот аргумент ограничит собранные сведения подмножеством. Возможные значения для этого аргумента — все и такие ресурсы, как интерфейсы, VLAN и т. д. Можно указать список значений для включения большего подмножества. Значения также можно использовать с начальным ! для указания, что определенное подмножество не должно собираться. Допустимые подмножества — 'all', 'bfd_interfaces', 'lag_interfaces', 'telemetry', 'vlans', 'lacp', 'lacp_interfaces', 'interfaces', 'l3_interfaces', 'l2_interfaces', 'lldp_global', 'acls', 'acl_interfaces', 'ospfv2'. | ||
| gather_subset список / элементы=строка | По умолчанию: "!config" | При указании этот аргумент ограничит собранные сведения подмножеством. Возможные значения для этого аргумента — все, оборудование, конфигурация, legacy и интерфейсы. Можно указать список значений для включения большего подмножества. Значения также можно использовать с начальным ! для указания, что определенное подмножество не должно собираться. | |
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.Начиная с Ansible 2.6, для NX-API рекомендуется использовать connection: httpapi.Этот параметр будет удален в релизе после 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, это значение игнорируется. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Дополнительную информацию об использовании CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco Cisco integration page.
Примеры
- name: Gather all legacy facts
cisco.nxos.nxos_facts:
gather_subset: all
- name: Gather only the config and default facts
cisco.nxos.nxos_facts:
gather_subset:
- config
- name: Do not gather hardware facts
cisco.nxos.nxos_facts:
gather_subset:
- '!hardware'
- name: Gather legacy and resource facts
cisco.nxos.nxos_facts:
gather_subset: all
gather_network_resources: all
- name: Gather only the interfaces resource facts and no legacy facts
cisco.nxos.nxos_facts:
gather_subset:
- '!all'
- '!min'
gather_network_resources:
- interfaces
- name: Gather interfaces resource and minimal legacy facts
cisco.nxos.nxos_facts:
gather_subset: min
gather_network_resources: interfaces
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращается | Описание |
|---|---|---|
| ansible_net_all_ipv4_addresses список / элементы=строка | при конфигурации интерфейсов | Все настроенные IPv4-адреса устройства |
| ansible_net_all_ipv6_addresses список / элементы=строка | при конфигурации интерфейсов | Все настроенные IPv6-адреса устройства |
| ansible_net_api строка | всегда | Имя транспорта |
| ansible_net_config строка | при конфигурации конфигурации | Текущая активная конфигурация устройства |
| ansible_net_filesystems список / элементы=строка | при конфигурации оборудования | Все имена файловых систем, доступные на устройстве |
| ansible_net_gather_network_resources список / элементы=строка | при конфигурации ресурса | Список фактов для подмножеств сетевых ресурсов, собранных с устройства |
| 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, настроенных на удалённом устройстве |
Авторы
- 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_facts_module.html
