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. Объект словаря, содержащий детали подключения. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | По умолчанию: "0 (использовать стандартный порт)" | Указывает порт для использования при построении подключения к удаленному устройству. Это значение относится как к cli, так и к nxapi. Значение порта будет установлено по умолчанию до соответствующего порта транспорта, если он не указан в задаче (cli=22, http=80, https=443). | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использоваться значение переменной среды ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, будет использоваться значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| authorize bool (добавлен в 2.5.3) |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| auth_pass (добавлен в 2.5.3) | По умолчанию: "none" | Указывает пароль для использования, если требуется войти в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| timeout (добавлен в 2.3) | По умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать значения при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно | По умолчанию: "cli" | Настраивает транспортное подключение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl bool |
| Настраивает transport для использования SSL, если установлено в true только когда transport=nxapi, в противном случае это значение игнорируется. | |
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверяющие сертификаты. Если аргумент transport не является nxapi, это значение игнорируется. | |
| use_proxy bool (добавлен в 2.5) |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Для получения информации об использовании CLI и NX-API см. руководство NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве по сетям Ansible
- Дополнительную информацию об использовании 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 список | при конфигурировании интерфейсов | Все IP-адреса IPv4, настроенные на устройстве |
| ansible_net_all_ipv6_addresses список | при конфигурировании интерфейсов | Все IP-адреса IPv6, настроенные на устройстве |
| ansible_net_config строка | при конфигурировании конфигурации | Текущая активная конфигурация с устройства |
| ansible_net_filesystems список | при конфигурировании оборудования | Все имена файловых систем, доступные на устройстве |
| ansible_net_gather_subset список | всегда | Список подмножеств фактов, собранных с устройства |
| ansible_net_hostname строка | всегда | Настроенное имя хоста устройства |
| ansible_net_image строка | всегда | Файл образа, используемый устройством |
| ansible_net_interfaces словарь | при конфигурировании интерфейсов | Хэш всех интерфейсов, работающих в системе |
| ansible_net_memfree_mb целое число | при конфигурировании оборудования | Доступная свободная память на удаленном устройстве в Мб |
| ansible_net_memtotal_mb целое число | при конфигурировании оборудования | Общий объем памяти на удаленном устройстве в Мб |
| ansible_net_model строка | всегда | Имя модели, возвращенное устройством |
| ansible_net_neighbors словарь | при конфигурировании интерфейсов | Список соседей LLDP и CDP с устройства. Если присутствуют данные соседей CDP и LLDP на одном порту, то CDP имеет приоритет. |
| ansible_net_serialnum строка | всегда | Серийный номер удалённого устройства |
| ansible_net_version строка | всегда | Версия операционной системы, работающей на удалённом устройстве |
| fan_info словарь | при конфигурировании устаревшего режима | Хэш фактов о кулерах на удалённом устройстве |
| hostname словарь | при конфигурировании устаревшего режима | Настроенное имя хоста удалённого устройства |
| interfaces_list словарь | при конфигурировании устаревшего режима | Список имён интерфейсов на удалённом устройстве |
| kickstart строка | при конфигурировании устаревшего режима | Версия программного обеспечения, используемая для загрузки системы |
| module словарь | при конфигурировании устаревшего режима | Хэш фактов о модулях на удалённом устройстве |
| platform строка | при конфигурировании устаревшего режима | Аппаратная платформа, сообщенная удалённым устройством |
| power_supply_info строка | при конфигурировании устаревшего режима | Хэш фактов о блоках питания на удалённом устройстве |
| vlan_list список | при конфигурировании устаревшего режима | Список идентификаторов VLAN, настроенных на удалённом устройстве |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимый.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible Network Team. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых Ansible Network Team, см. в разделе здесь.
Поддержка
Дополнительную информацию о поддержке этого модуля 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.6/modules/nxos_facts_module.html
