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 | По умолчанию: None | Устарел Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации см. Руководство по платформам NXOS. Объект словаря, содержащий сведения о подключении. | |
| username | Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа по CLI или аутентификации nxapi в зависимости от используемого транспортного средства. Если значение не указано в задании, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| authorize (добавлен в 2.5.3) |
| Указывает модулю на вход в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задании, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортного средства cli. Если значение не указано в задании, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| use_proxy (добавлен в 2.5) |
| Если no, переменные окружения http_proxy и https_proxy будут игнорироваться. | |
| auth_pass (добавлен в 2.5.3) | По умолчанию: нет | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это требуется. Если authorize false, этот аргумент ничего не делает. Если значение не указано в задании, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| timeout (добавлен в 2.3) | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т.д.). | |
| use_ssl |
| Настраивает transport для использования SSL, если значение равно true только в случае transport=nxapi, в противном случае это значение игнорируется. | |
| password | По умолчанию: None | Указывает пароль для аутентификации подключения к удалённому устройству. Это распространённый аргумент, используемый для транспортных средств cli или nxapi. Если значение не указано в задании, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | |
| validate_certs |
None | Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах, использующих самоподписанные сертификаты. Если аргумент transport не nxapi, это значение игнорируется. | |
| port | По умолчанию: 0 (использовать общий порт) | Указывает порт для подключения к удалённому устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию соответствует общему порту соответствующего транспортного средства, если в задании не указано другое значение. (cli=22, http=80, https=443). | |
| transport обязательно | По умолчанию: cli | Настраивает транспортное средство для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
Примечания
Примечание
- Сведения об использовании CLI и NX-API см. в Руководстве по платформам NXOS
- Дополнительную информацию об использовании 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 список | при конфигурировании интерфейсов | Все IPv4-адреса, настроенные на устройстве |
| ansible_net_all_ipv6_addresses список | при конфигурировании интерфейсов | Все 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 с удалённого устройства |
| 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, настроенных на удалённом устройстве |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Поддержка
Для получения дополнительной информации о поддержке этого модуля 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.5/modules/nxos_facts_module.html
