dellemc.os9.os9_facts – Сбор фактов с удалённых устройств, работающих под управлением Dell EMC Networking OS9
Примечание
Этот плагин входит в коллекцию dellemc.os9 (версия 1.0.3).
Для его установки используйте: ansible-galaxy collection install dellemc.os9.
Для использования в playbook, укажите: dellemc.os9.os9_facts.
Обзор
- Сбор базового набора фактов устройства с удалённого устройства, работающего под управлением ОС9. Этот модуль добавляет к ключам всех базовых сетевых фактов префикс
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/dellemc/os9/os9_facts_module.html
