ios_facts – Сбор фактов с удалённых устройств на базе Cisco IOS
Новое в версии 2.2.
Описание
- Сбор базового набора фактов устройства с удаленного устройства, работающего на IOS. Этот модуль добавляет ко всем базовым ключам сетевых фактов префикс
ansible_net_<fact>. Модуль фактов всегда собирает базовый набор фактов с устройства и может включать или отключать сбор дополнительных фактов.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_pass строка | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass. Дополнительную информацию см. в руководстве IOS Platform Options. Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize равно false, этот аргумент не имеет значения. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize булево |
| Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes. Дополнительную информацию см. в руководстве IOS Platform Options. Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| gather_subset - | Значение по умолчанию: "!config" | При указании данного аргумента ограничиваются факты, собираемые из подмножества. Возможные значения для этого аргумента включают all, hardware, config, и interfaces. Укажите список значений для включения большего подмножества. Используйте значение с начальным ! для сбора всех фактов, кроме этого подмножества. | |
| provider словарь | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Дополнительную информацию см. в руководстве IOS Platform Options. Объект словаря, содержащий данные соединения. | ||
| auth_pass строка | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize равно false, этот аргумент не имеет значения. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize булево |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| 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 15.6
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
# Collect all facts from the device
- ios_facts:
gather_subset: all
# Collect only the config and default facts
- ios_facts:
gather_subset:
- config
# Do not collect hardware facts
- ios_facts:
gather_subset:
- "!hardware"
Возвращаемые значения
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ansible_net_all_ipv4_addresses список | при конфигурации интерфейсов | Все IPv4-адреса, настроенные на устройстве |
| ansible_net_all_ipv6_addresses список | при конфигурации интерфейсов | Все IPv6-адреса, настроенные на устройстве |
| ansible_net_api строка | всегда | Название транспортного протокола |
| ansible_net_config строка | при конфигурации конфигурации | Текущая активная конфигурация устройства |
| ansible_net_filesystems список | при конфигурации оборудования | Все имена файловых систем, доступные на устройстве |
| ansible_net_filesystems_info словарь | при конфигурации оборудования | Хэш всех файловых систем с информацией о каждой файловой системе (например, свободный и общий объём) |
| ansible_net_gather_subset список | всегда | Список подмножеств фактов, собранных с устройства |
| ansible_net_hostname строка | всегда | Настроенное имя хоста устройства |
| ansible_net_image строка | всегда | Файл образа, используемый устройством |
| ansible_net_interfaces словарь | при конфигурации интерфейсов | Хэш всех интерфейсов, работающих в системе |
| ansible_net_iostype строка | всегда | Тип операционной системы (IOS или IOS-XE), работающей на удалённом устройстве |
| ansible_net_memfree_mb целое число | при конфигурации оборудования | Доступная свободная память на удалённом устройстве в Мб |
| ansible_net_memtotal_mb целое число | при конфигурации оборудования | Общий объём памяти на удалённом устройстве в Мб |
| ansible_net_model строка | всегда | Имя модели, возвращённое устройством |
| ansible_net_neighbors словарь | при конфигурации интерфейсов | Список соседей CDP и LLDP с удалённого устройства. Если присутствуют данные и о соседях CDP, и о соседях LLDP на одном порту, то отдаётся предпочтение CDP. |
| ansible_net_python_version строка | всегда | Версия Python, используемая контроллером Ansible |
| ansible_net_serialnum строка | всегда | Серийный номер удалённого устройства |
| ansible_net_stacked_models список | при конфигурации нескольких устройств в стеке | Имена моделей каждого устройства в стеке |
| ansible_net_stacked_serialnums список | при конфигурации нескольких устройств в стеке | Серийные номера каждого устройства в стеке |
| ansible_net_version строка | всегда | Версия операционной системы, работающей на удалённом устройстве |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Данный модуль поддерживается командой Ansible по работе с сетями. [сеть]
Поддержка Red Hat
Более подробную информацию о поддержке данного модуля компанией Red Hat можно найти в этой статье базы знаний Red Hat.
Авторы
- Peter Sprygada (@privateip)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/ios_facts_module.html
