cisco.iosxr.iosxr_facts – Получение данных об устройствах iosxr.
Примечание
Этот плагин входит в состав коллекции cisco.iosxr (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install cisco.iosxr.
Для использования в книге задач укажите: cisco.iosxr.iosxr_facts.
Новое в версии 1.0.0: cisco.iosxr
Описание
- Сбор данных об устройствах с операционной системой iosxr. Модуль размещает собранные данные в дереве фактов, индексированных именем соответствующего ресурса. Модуль фактов всегда собирает базовый набор данных с устройства и позволяет включить или отключить сбор дополнительных данных.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
|
gather_network_resources
список / элементы=строка
|
Если указано, этот аргумент ограничит собираемые данные определенным подмножеством. Возможные значения для этого аргумента включают все и ресурсы, такие как интерфейсы, lacp и т. д. Можно указать список значений для включения большего подмножества. Значения также могут использоваться с начальным
! для указания того, что определенное подмножество не должно собираться. Допустимые подмножества: 'all', 'lacp', 'lacp_interfaces', 'lldp_global', 'lldp_interfaces', 'interfaces', 'l2_interfaces', 'l3_interfaces', 'lag_interfaces', 'acls', 'acl_interfaces', 'static_routes', 'ospfv2'. |
||
|
gather_subset
список / элементы=строка
|
Значение по умолчанию: "!config" |
Если указано, этот аргумент ограничит собираемые данные определенным подмножеством. Возможные значения для этого аргумента включают все, оборудование, конфигурацию и интерфейсы. Можно указать список значений для включения большего подмножества. Значения также могут использоваться с начальным
! для указания того, что определенное подмножество не должно собираться. |
|
| provider
словарь
|
Устаревший
Начиная с Ansible 2.5, рекомендуется использовать
connection: network_cli. Дополнительную информацию см. в Руководстве по сети.
Объект словаря, содержащий данные подключения.
|
||
| host
строка
|
Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. |
||
| password
строка
|
Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использоваться значение переменной окружения ANSIBLE_NET_PASSWORD. |
||
| port
целое число
|
Указывает порт для создания подключения к удаленному устройству. |
||
| ssh_keyfile
путь
|
Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, будет использоваться значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. |
||
| timeout
целое число
|
Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истекает до завершения операции, модуль выдаст ошибку. |
||
| transport
строка
|
|
Указывает тип транспорта на основе соединения. |
|
| username
строка
|
Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использоваться значение переменной окружения ANSIBLE_NET_USERNAME. |
||
Примечания
Примечание
- Тестировалось на IOS-XR 6.1.3.
- Этот модуль работает с подключением
network_cli. См. варианты платформы IOS-XR. - Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible.
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
# Gather all facts
- cisco.iosxr.iosxr_facts:
gather_subset: all
gather_network_resources: all
# Collect only the config and default facts
- cisco.iosxr.iosxr_facts:
gather_subset:
- config
# Do not collect hardware facts
- cisco.iosxr.iosxr_facts:
gather_subset:
- '!hardware'
# Collect only the lacp facts
- cisco.iosxr.iosxr_facts:
gather_subset:
- '!all'
- '!min'
gather_network_resources:
- lacp
# Do not collect lacp_interfaces facts
- cisco.iosxr.iosxr_facts:
gather_network_resources:
- '!lacp_interfaces'
# Collect lacp and minimal default facts
- cisco.iosxr.iosxr_facts:
gather_subset: min
gather_network_resources: lacp
# Collect only the interfaces facts
- cisco.iosxr.iosxr_facts:
gather_subset:
- '!all'
- '!min'
gather_network_resources:
- interfaces
- l2_interfaces
Возвращаемые значения
Общие возвращаемые значения описаны в данном разделе. Следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
|
ansible_net_all_ipv4_addresses
список / элементы=строка
|
при настройке интерфейсов |
Все настроенные IPv4-адреса на устройстве
|
|
ansible_net_all_ipv6_addresses
список / элементы=строка
|
при настройке интерфейсов |
Все настроенные IPv6-адреса на устройстве
|
| ansible_net_api
строка
|
всегда |
Имя транспорта
|
| ansible_net_config
строка
|
при настройке конфигурации |
Текущая активная конфигурация с устройства
|
| ansible_net_filesystems
список / элементы=строка
|
при настройке оборудования |
Все имена файловых систем, доступных на устройстве
|
|
ansible_net_gather_network_resources
список / элементы=строка
|
всегда |
Список собранных с устройства подмножеств ресурсов фактов
|
|
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_python_version
строка
|
всегда |
Версия Python, используемая контроллером Ansible
|
| ansible_net_version
строка
|
всегда |
Версия операционной системы, работающей на удаленном устройстве
|
Авторы
- Ricardo Carrillo Cruz (@rcarrillocruz)
- Nilashish Chakraborty (@Nilashishc)
© 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/cisco/iosxr/iosxr_facts_module.html
