dellemc.os6.os6_facts – Сбор фактов с устройств, работающих под управлением Dell EMC OS6
Примечание
Этот плагин входит в сборку dellemc.os6 (версия 1.0.6).
Для его установки используйте: ansible-galaxy collection install dellemc.os6.
Для использования в книге задач укажите: dellemc.os6.os6_facts.
Обзор
- Сбор базового набора фактов устройства с удаленного устройства, работающего под управлением OS6. Этот модуль добавляет ко всем базовым ключам сетевых фактов
ansible_net_<fact>. Модуль фактов всегда собирает базовый набор фактов с устройства и может включить или выключить сбор дополнительных фактов.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| gather_subset список / элементы=строка | Значение по умолчанию: ["!config"] | При указании данного аргумента факта будут ограничены определенным подмножеством. Возможные значения для этого аргумента включают all, hardware, config и interfaces. Можно указать список значений для включения более крупного подмножества. Значения также могут использоваться с начальным ! для указания того, что определенное подмножество не должно собираться. | |
| provider словарь | Объект словаря, содержащий сведения о подключении. | ||
| 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
- os6_facts:
gather_subset: all
# Collect only the config and default facts
- os6_facts:
gather_subset:
- config
# Do not collect hardware facts
- os6_facts:
gather_subset:
- "!interfaces"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ansible_net_config строка | При конфигурации config. | Текущая активная конфигурация с устройства. |
| ansible_net_gather_subset список / элементы=строка | всегда. | Список подмножеств фактов, собранных с устройства. |
| ansible_net_hostname строка | всегда. | Настроенное имя хоста устройства. |
| ansible_net_image строка | всегда | Файл образа, используемый устройством. |
| ansible_net_interfaces словарь | При конфигурации interfaces. | Хэш всех интерфейсов, работающих в системе. |
| ansible_net_memfree_mb целое число | При конфигурации hardware. | Доступная свободная память на удаленном устройстве в МБ. |
| ansible_net_memtotal_mb целое число | При конфигурации hardware. | Общий объем памяти на удаленном устройстве в МБ. |
| ansible_net_model строка | всегда. | Имя модели, возвращенное устройством. |
| ansible_net_neighbors словарь | При конфигурации interfaces. | Список соседей LLDP с удаленного устройства. |
| ansible_net_serialnum строка | всегда. | Серийный номер удаленного устройства. |
| ansible_net_version строка | всегда. | Версия операционной системы, работающая на удаленном устройстве. |
Авторы
- Abirami N (@abirami-n)
© 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/os6/os6_facts_module.html