iosxr_facts – Получение фактов об устройствах iosxr
Описание
- Сбор фактов с сетевых устройств, работающих под управлением операционной системы iosxr. Этот модуль помещает собранные факты в дерево фактов, ключом которого является соответствующее имя ресурса. Модуль фактов всегда собирает базовый набор фактов с устройства и может включать или отключать сбор дополнительных фактов.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| gather_network_resources - добавлено в 2.9 | При указании этого аргумента сбор фактов будет ограничен заданным подмножеством. Возможные значения для этого аргумента включают все и ресурсы, такие как интерфейсы, lacp и т. д. Можно указать список значений для включения более крупного подмножества. Значения также могут использоваться с начальным ! для указания того, что определенное подмножество не должно собираться. Допустимые подмножества: 'all', 'lacp', 'lacp_interfaces', 'lldp_global', 'lldp_interfaces', 'interfaces', 'l2_interfaces', 'l3_interfaces', 'lag_interfaces'. | ||
| gather_subset - | По умолчанию: "!config" | При указании этого аргумента сбор фактов будет ограничен заданным подмножеством. Возможные значения для этого аргумента включают все, аппаратное обеспечение, конфигурацию и интерфейсы. Можно указать список значений для включения более крупного подмножества. Значения также могут использоваться с начальным ! для указания того, что определенное подмножество не должно собираться. | |
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Дополнительную информацию см. в Руководстве по сети. Объект словаря, содержащий данные подключения. | ||
| host строка / обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port целое число | По умолчанию: 22 | Указывает порт для подключения к удаленному устройству. | |
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку. | |
| username строка | Указывает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
Примечания
Примечание
- Проверено на IOS-XR 6.1.3.
- Этот модуль работает с подключением
network_cli. См. Параметры платформы IOS-XR. - Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
# Gather all facts
- iosxr_facts:
gather_subset: all
gather_network_resources: all
# Collect only the config and default facts
- iosxr_facts:
gather_subset:
- config
# Do not collect hardware facts
- iosxr_facts:
gather_subset:
- "!hardware"
# Collect only the lacp facts
- iosxr_facts:
gather_subset:
- "!all"
- "!min"
gather_network_resources:
- lacp
# Do not collect lacp_interfaces facts
- iosxr_facts:
gather_network_resources:
- "!lacp_interfaces"
# Collect lacp and minimal default facts
- iosxr_facts:
gather_subset: min
gather_network_resources: lacp
# Collect only the interfaces facts
- 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 строка | всегда | Версия операционной системы, работающей на удаленном устройстве |
Статус
- Не гарантируется обратная совместимость интерфейса этого модуля. [превью]
- Этот модуль поддерживается командой Ansible Network. [сеть]
Поддержка Red Hat
Дополнительная информация о поддержке этого модуля компанией Red Hat доступна в этой статье базы знаний Red Hat.
Авторы
- Ricardo Carrillo Cruz (@rcarrillocruz)
- Nilashish Chakraborty (@Nilashishc)
Подсказка
Если вы заметите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/iosxr_facts_module.html
