cisco.nxos.nxos_facts – Получение фактов о коммутаторах NX-OS
Примечание
Этот плагин входит в состав коллекции cisco.nxos (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в плейбуке укажите: cisco.nxos.nxos_facts.
Новое в версии 1.0.0: of 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 по сети
- Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco.
Примеры
- 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_facts_module.html
