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"] | При указании этого аргумента, сбор фактов будет ограничен заданным подмножеством. Возможные значения этого аргумента включают все, оборудование, конфигурацию и интерфейсы. Можно указать список значений для включения большего подмножества. Значения также могут использоваться с начальным префиксом ! для указания того, что конкретное подмножество не должно собираться. | |
| provider словарь | Объект словаря, содержащий данные соединения. | ||
| auth_pass строка | Указывает пароль для использования при необходимости входа в привилегированный режим на удалённом устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения 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 string | При конфигурировании настроек. | Текущая активная конфигурация устройства. |
| 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 строка | всегда. | Версия операционной системы, работающей на удаленном устройстве. |
Авторы
- Abirami N (@abirami-n)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/dellemc/os6/os6_facts_module.html