Spec-Zone.ru › Ansible 2.11

community.network.ironware_facts – Сбор фактов с устройств, работающих на Extreme Ironware

Примечание

Этот плагин входит в коллекцию community.network (версия 2.0.1).

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

Для использования в книге задач укажите: community.network.ironware_facts

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

Описание

  • Сбор базового набора фактов устройства с удалённого устройства, работающего на Ironware. Этот модуль добавляет префикс ansible_net_<fact> ко всем базовым ключам фактов сети. Модуль фактов всегда собирает базовый набор фактов с устройства и может включить или выключить сбор дополнительных фактов.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
authorize
boolean
    Варианты:
  • no ←
  • yes
Устарело
Начиная с Ansible 2.7, рекомендуется использовать connection: network_cli и become: yes
Дополнительную информацию можно найти в руководстве IronWare Platform Options.
Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE
gather_subset
string
Значение по умолчанию:
["!config", "!mpls"]
Если указано, этот аргумент ограничит собираемые факты определённым подмножеством. Возможные значения для этого аргумента включают all, hardware, config, mpls и interfaces. Можно указать список значений для включения более крупного подмножества. Значения также можно использовать с начальным ! для указания того, что определённое подмножество не должно собираться.
provider
dictionary
Устарело
Начиная с Ansible 2.7, рекомендуется использовать connection: network_cli и become: yes
Дополнительную информацию можно найти в руководстве IronWare Platform Options.
Объект словаря, содержащий сведения о подключении.
auth_pass
string
Указывает пароль, который нужно использовать, если требуется войти в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS
authorize
boolean
    Варианты:
  • no ←
  • yes
Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE
host
string
Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
password
string
Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD
port
integer
Значение по умолчанию:
22
Указывает порт, используемый при построении соединения с удалённым устройством.
ssh_keyfile
path
Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE
timeout
integer
Значение по умолчанию:
10
Указывает время ожидания простоя соединения в секундах. Полезно, если консоль зависает перед продолжением. Например, при сохранении конфигураций.
username
string
Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME

Примечания

Примечание

  • Проверено на Ironware 5.8e
  • Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Руководство по сетям Ansible

Примеры

- name: Collect all facts from the device
  community.network.ironware_facts:
    gather_subset: all

- name: Collect only the config and default facts
  community.network.ironware_facts:
    gather_subset:
      - config

- name: Do not collect hardware facts
  community.network.ironware_facts:
    gather_subset:
      - "!hardware"

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

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

Ключ Возвращаемое значение Описание
ansible_net_all_ipv4_addresses
list / elements=string
при настройке интерфейсов
Все настроенные IPv4-адреса устройства

ansible_net_all_ipv6_addresses
list / elements=string
при настройке интерфейсов
Все настроенные IPv6-адреса устройства

ansible_net_config
string
при настройке config
Текущая активная конфигурация устройства

ansible_net_filesystems
list / elements=string
при настройке hardware
Все имена файловых систем, доступные на устройстве

ansible_net_gather_subset
list / elements=string
всегда
Список собранных фактов подмножеств с устройства

ansible_net_interfaces
dictionary
при настройке interfaces
Хэш всех интерфейсов, работающих на системе

ansible_net_memfree_mb
integer
при настройке hardware
Доступная свободная память на удалённом устройстве в Мб

ansible_net_memtotal_mb
integer
при настройке hardware
Общий объём памяти на удалённом устройстве в Мб

ansible_net_model
string
всегда
Имя модели, возвращённое устройством

ansible_net_mpls_lsps
dictionary
при настройке LSP
Все настроенные MPLS LSP на устройстве

ansible_net_mpls_vll
dictionary
при настройке MPLS VLL
Все настроенные экземпляры VLL на устройстве

ansible_net_mpls_vll_local
dictionary
при настройке MPLS VLL-LOCAL
Все настроенные экземпляры VLL-LOCAL на устройстве

ansible_net_mpls_vpls
dictionary
при настройке MPLS VPLS
Все настроенные экземпляры VPLS на устройстве

ansible_net_neighbors
dictionary
при настройке interfaces
Список соседей LLDP с удалённого устройства

ansible_net_serialnum
string
всегда
Серийный номер удалённого устройства

ansible_net_version
string
всегда
Версия операционной системы, работающей на удалённом устройстве



Авторы

  • Paul Baker (@paulquack)

© 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/community/network/ironware_facts_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API