dellemc.os9.os9_facts – Сбор фактов с удалённых устройств, работающих под управлением Dell EMC Networking OS9

Примечание

Этот плагин входит в состав коллекции dellemc.os9 (версия 1.0.3).

Для его установки используйте: ansible-galaxy collection install dellemc.os9.

Для использования в книге задач укажите: dellemc.os9.os9_facts.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Сбор базового набора фактов устройства с удаленного устройства, работающего под управлением OS9. Этот модуль добавляет к всем ключам базовых сетевых фактов префикс 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`.

Примечания

Примечание

Этот модуль требует версии OS9 9.10.0.1P13 или выше.
Этот модуль требует увеличения предела скорости подключения SSH. Используйте следующую команду ip ssh connection-rate-limit 60 для настройки того же. Это также можно сделать с помощью модуля os9_config.
Дополнительную информацию об использовании Ansible для управления устройствами Dell EMC Network см. на странице https://www.ansible.com/ansible-dell-networking.

Примеры

# Collect all facts from the device
- os9_facts:
    gather_subset: all
# Collect only the config and default facts
- os9_facts:
    gather_subset:
      - config
# Do not collect hardware facts
- os9_facts:
    gather_subset:
      - "!hardware"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
ansible_net_all_ipv4_addresses список / элементы=строка	при конфигурировании интерфейсов	Все настроенные IPv4-адреса на устройстве
ansible_net_all_ipv6_addresses список / элементы=строка	при конфигурировании интерфейсов	Все настроенные IPv6-адреса на устройстве
ansible_net_config строка	при конфигурировании config	Текущая активная конфигурация с устройства
ansible_net_filesystems список / элементы=строка	при конфигурировании hardware	Все имена файловых систем, доступные на устройстве
ansible_net_gather_subset список / элементы=строка	всегда	Список подмножеств фактов, собранных с устройства
ansible_net_hostname строка	всегда	Настроенное имя хоста устройства
ansible_net_image строка	всегда	Файл образа, под управлением которого работает устройство
ansible_net_interfaces словарь	при конфигурировании интерфейсов	Хэш всех интерфейсов, работающих на системе
ansible_net_memfree_mb целое число	при конфигурировании hardware	Доступная свободная память на удалённом устройстве в Мб
ansible_net_memtotal_mb целое число	при конфигурировании hardware	Общий объём памяти на удалённом устройстве в Мб
ansible_net_model строка	всегда	Имя модели, возвращённое с устройства
ansible_net_neighbors словарь	при конфигурировании интерфейсов	Список соседей LLDP с удаленного устройства
ansible_net_serialnum строка	всегда	Серийный номер удалённого устройства
ansible_net_version строка	всегда	Версия операционной системы, работающей на удалённом устройстве

Авторы

Dhivya P (@dhivyap)

© 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/os9/os9_facts_module.html