dellemc.os10.os10_facts – Сбор фактов с устройств, работающих под управлением Dell EMC SmartFabric OS10
Примечание
Этот плагин входит в коллекцию dellemc.os10 (версия 1.0.2).
Для его установки используйте: ansible-galaxy collection install dellemc.os10.
Для использования в playbook, укажите: dellemc.os10.os10_facts.
Обзор
- Сбор базового набора фактов устройства с удаленного устройства, работающего под управлением OS10. Этот модуль добавляет все базовые ключи фактов сети с
ansible_net_<fact>. Модуль facts всегда собирает базовый набор фактов с устройства и может включить или отключить сбор дополнительных фактов.
Примечание
Этот модуль имеет соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| gather_subset список / элементы=строка | По умолчанию: ["!config"] | При указании этого аргумента, сбор фактов будет ограничен заданным подмножеством. Возможные значения для этого аргумента включают все, оборудование, конфигурацию и интерфейсы. Можно указать список значений для включения большего подмножества. Значения также могут использоваться с начальным ! для указания, что определённое подмножество не должно быть собрано. | |
| provider словарь | Объект типа dict, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль для использования, если требуется вход в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, то этот аргумент ничего не делает. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize булево |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Пароль для аутентификации SSH-сессии с удалённым устройством. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт, используемый при построении соединения с удалённым устройством. | ||
| ssh_keyfile путь | Путь к SSH-ключу, используемому для аутентификации SSH-сессии с удалённым устройством. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает время ожидания бездействия (в секундах) для соединения. Полезно, если консоль зависает перед продолжением. Например, при сохранении конфигураций. | ||
| username строка | Пользователь для аутентификации SSH-сессии с удалённым устройством. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Dell EMC Network см. на странице https://www.ansible.com/ansible-dell-networking.
Примеры
# Collect all facts from the device
- os10_facts:
gather_subset: all
# Collect only the config and default facts
- os10_facts:
gather_subset:
- config
# Do not collect hardware facts
- os10_facts:
gather_subset:
- "!hardware"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ansible_net_all_ipv4_addresses список / элементы=строка | при конфигурации интерфейсов | Все IPv4-адреса, настроенные на устройстве |
| ansible_net_all_ipv6_addresses список / элементы=строка | при конфигурации интерфейсов | Все IPv6-адреса, настроенные на устройстве |
| ansible_net_config строка | при конфигурации config | Текущая активная конфигурация с устройства |
| ansible_net_cpu_arch строка | при конфигурации оборудования | Архитектура процессора удалённого устройства. |
| ansible_net_gather_subset список / элементы=строка | всегда | Список подмножеств фактов, собранных с устройства |
| ansible_net_hostname строка | всегда | Настроенное имя хоста устройства |
| ansible_net_interfaces словарь | при конфигурации интерфейсов | Хэш всех интерфейсов, работающих в системе |
| ansible_net_memfree_mb целое число | при конфигурации оборудования | Доступная свободная память на удалённом устройстве в Мб |
| ansible_net_memtotal_mb целое число | при конфигурации оборудования | Общий объём памяти на удалённом устройстве в Мб |
| ansible_net_model строка | всегда | Название модели, возвращённое устройством. |
| ansible_net_name строка | Всегда. | Имя ОС, работающей на устройстве. |
| ansible_net_neighbors словарь | при конфигурации интерфейсов | Список соседей LLDP с удалённого устройства |
| ansible_net_servicetag строка | всегда | Номер тега обслуживания удалённого устройства. |
| ansible_net_version строка | всегда | Версия операционной системы, работающей на удалённом устройстве |
Авторы
- Senthil Kumar Ganesan (@skg-net)
© 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/dellemc/os10/os10_facts_module.html
