nxos_facts - Получение фактов о коммутаторах NX-OS
Новая версия 2.1.
Описание
- Сбор фактов с устройств Cisco Nexus, работающих под управлением операционной системы NX-OS. Сбор фактов поддерживается через транспортные средства Cli и Nxapi. Этот модуль добавляет все базовые ключи сетевых фактов с
ansible_net_<fact>. Модуль фактов всегда собирает базовый набор фактов с устройства и может включать или отключать сбор дополнительных фактов.
Параметры
| параметр | обязательно | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| auth_pass (добавлено в 2.4.4)
| нет | нет | Указывает пароль, используемый для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлено в 2.4.4)
| нет |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| gather_subset (добавлено в 2.2)
| нет | !config | При указании этого аргумента, сбор фактов будет ограничен заданным подмножеством. Возможные значения для этого аргумента включают все, оборудование, конфигурацию, legacy и интерфейсы. Можно указать список значений для включения большего подмножества. Значения также могут использоваться с начальным ! для указания того, что конкретное подмножество не должно собираться. | |
| host | да | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password | нет | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспорта cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port | нет | 0 (использовать стандартный порт) | Указывает порт для подключения к удалённому устройству. Это значение относится к cli или nxapi. Значение порта будет по умолчанию соответствовать стандартному порту транспорта, если не указано в задаче. (cli=22, http=80, https=443). | |
| provider | нет | Удобный метод, позволяющий передавать все аргументы nxos как объект словаря. Все ограничения (обязательность, варианты и т. д.) должны быть выполнены либо отдельными аргументами, либо значениями в этом словаре. | ||
| ssh_keyfile | нет | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout (добавлено в 2.3)
| нет | 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| transport | да | cli | Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl | нет |
| Настраивает транспорт transport для использования SSL, если значение true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверенные сертификаты. Если аргумент transport не nxapi, это значение игнорируется. |
Примеры
- 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 с удалённого устройства | при настроенных интерфейсах | словарь | |
| 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 | Список идентификаторов VLAN, настроенных на удалённом устройстве | при настроенном legacy | список |
Статус
Этот модуль помечен как предварительная версия, что означает, что он не гарантирует обратную совместимость интерфейса.
Информация о техническом обслуживании
Дополнительную информацию о поддержке этого модуля компанией Red Hat можно найти по адресу knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Для получения помощи в разработке модулей ознакомьтесь с Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_facts_module.html
