bigiq_device_facts – Сбор фактов с устройств F5 BIG-IQ

Новое в версии 2.8.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Сбор фактов с устройств F5 BIG-IQ.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
gather_subset список / обязательный		Варианты: all applications managed-devices purchased-pool-licenses regkey-pools system-info vlans !all !applications !managed-devices !purchased-pool-licenses !regkey-pools !system-info !vlans	При указании, этот аргумент ограничит возвращаемые факты заданным подмножеством. Можно указать список значений для включения большего подмножества. Значения также могут быть использованы с начальным `!` для указания, что определенное подмножество не должно быть собрано.
password строка / обязательный			Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
provider словарь добавлено в 2.5			Объект dict, содержащий сведения о подключении.
	password строка / обязательный		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, установив переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательный		Хост BIG-IP. Этот параметр можно опустить, установив переменную окружения `F5_SERVER`.
	server_port целое число	По умолчанию: 443	Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную окружения `F5_SERVER_PORT`.
	ssh_keyfile путь		Указывает SSH-ключ, который необходимо использовать для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Этот параметр можно опустить, установив переменную окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число	По умолчанию: 10	Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истечет до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: cli rest ←	Настраивает транспортное подключение для использования при подключении к удаленному устройству.
	user строка / обязательный		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, установив переменную окружения `F5_USER`.
	validate_certs логическое значение	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами. Этот параметр можно опустить, установив переменную окружения `F5_VALIDATE_CERTS`.
server строка / обязательный			Хост BIG-IP. Этот параметр можно опустить, установив переменную окружения `F5_SERVER`.
server_port целое число добавлено в 2.2		По умолчанию: 443	Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную окружения `F5_SERVER_PORT`.
user строка / обязательный			Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, установив переменную окружения `F5_USER`.
validate_certs логическое значение добавлено в 2.0		Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами. Этот параметр можно опустить, установив переменную окружения `F5_VALIDATE_CERTS`.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP ≥ 12.
Модули F5 только манипулируют текущей конфигурацией продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохранится на диске, включите хотя бы одну задачу, использующую модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Collect BIG-IQ facts
  bigiq_device_facts:
    gather_subset:
      - system-info
      - vlans
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Collect all BIG-IQ facts
  bigiq_device_facts:
    gather_subset:
      - all
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Collect all BIG-IP facts except trunks
  bigiq_device_facts:
    gather_subset:
      - all
      - "!trunks"
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

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

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

Ключ		Возвращаемое значение	Описание
applications complex		Когда `managed-devices` указано в `gather_subset`.	Данные, относящиеся к приложениям Пример: хеш/словарь значений
	active_alerts целое число	изменённое	Количество активных сообщений об ошибках для приложения.
	bad_traffic вещественное число	изменённое	Процент трафика для приложения, который определён как 'плохой'. Это значение зависит от того, включена ли функция `protection_mode`. Пример: 1.7498
	bad_traffic_growth булево	изменённое	Установлено ли оповещение о росте плохой нагрузки для запуска или нет.
	connections вещественное число	изменённое	Текущее число подключений к приложению. Пример: 3.06
	enhanced_analytics булево	изменённое	Включены ли расширенные аналитики для приложения. Пример: True
	health строка	изменённое	Состояние приложения. Пример: Хорошо
	id строка	изменённое	Идентификатор приложения, известный BIG-IQ. Пример: 996baae8-5d1d-3662-8a2d-3612fa2aceae
	name строка	изменённое	Имя приложения. Пример: site12http.example.com
	new_connections вещественное число	изменённое	Количество новых подключений, устанавливаемых в секунду. Пример: 0.35
	protection_mode строка	изменённое	Тип защиты F5 Web Application Security Service для приложения. Пример: Не защищено
	response_time вещественное число	изменённое	Измеренное время отклика приложения в миллисекундах. Пример: 0.02
	status строка	изменённое	Текущее состояние приложения. Пример: РАСПРОСТРАНЕНО
	transactions_per_second вещественное число	изменённое	Текущее значение количества транзакций в секунду, обрабатываемых приложением. Пример: 0.87
managed_devices complex		Когда `managed-devices` указано в `gather_subset`.	Данные, относящиеся к управляемым устройствам. Пример: хеш/словарь значений
	address строка	изменённое	Адрес обнаружения устройства. Пример: 10.10.10.10
	build строка	изменённое	Версия сборки. Пример: 0.0.4
	device_uri строка	изменённое	URL для доступа к интерфейсу управления устройством. Пример: https://10.10.10.10:443
	edition строка	изменённое	Строка редакции версии продукта. Пример: Финальная
	group_name строка	изменённое	Группа BIG-IQ, к которой принадлежит устройство. Пример: cm-bigip-allBigIpDevices
	hostname строка	изменённое	Обнаруженное имя хоста устройства. Пример: tier2labB1.lab.fp.foo.com
	https_port целое число	изменённое	HTTPS-порт, доступный на интерфейсе управления устройством. Пример: 443
	is_clustered булево	изменённое	Является ли устройство кластеризованным.
	is_license_expired булево	изменённое	Истекло ли лицензия на устройстве. Пример: True
	is_virtual булево	изменённое	Является ли устройство виртуальным. Пример: True
	machine_id строка	изменённое	Уникальный идентификатор машины, назначенный этому устройству BIG-IQ. Пример: c141bc88-f734-4434-be64-a3e9ea98356e
	management_address строка	изменённое	IP-адрес интерфейса управления устройством. Пример: 10.10.10.10
	mcp_device_name строка	изменённое	Имя устройства, известное MCPD на BIG-IP. Пример: /Common/tier2labB1.lab.fp.foo.com
	product строка	изменённое	Продукт, под которым идентифицировано управляемое устройство. Пример: BIG-IP

	rest_framework_version строка	изменено	Версия REST фреймворка, работающая на устройстве Пример: 13.1.1-0.0.4
	self_link строка	изменено	Внутренняя ссылка на управляемое устройство в BIG-IQ. Пример: https://localhost/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices/c141bc88-f734-4434-be64-a3e9ea98356e
	slots сложное	изменено	Тома на устройстве и версии установленного программного обеспечения в этих томах. Пример: {'volume': 'HD1.1', 'product': 'BIG-IP', 'version': '13.1.1', 'build': '0.0.4', 'isActive': 'yes'}
	state строка	изменено	Состояние устройства. Пример: ACTIVE
	tags сложное	изменено	Разные теги, назначенные устройству. Пример: {'BIGIQ_tier_2_device': '2018-08-22T13:30:47.693-07:00', 'BIGIQ_SSG_name': 'tim-ssg'}
	trust_domain_guid строка	изменено	GUID домена доверия, к которому принадлежит устройство. Пример: 40ddf541-e604-4905-bde3005056813e36
	uuid строка	изменено	UUID устройства в BIG-IQ. Пример: c141bc88-f734-4434-be64-a3e9ea98356e
	version строка	изменено	Версия TMOS, установленная на устройстве. Пример: 13.1.1
purchased_pool_licenses сложное		Когда `purchased-pool-licenses` указано в `gather_subset`.	Информация о приобретённых лицензиях пула. Пример: hash/словарь значений
	base_reg_key строка	изменено	Базовый ключ регистрации приобретённого пула. Пример: XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX
	dossier строка	изменено	Досье приобретённой лицензии пула. Пример: d6bd4b8ba5...e9a1a1199b73af9932948a
	evaluation_end_date_time строка	изменено	Дата окончания лицензии оценки. Пример: 2018-10-11T00:00:00-07:00
	evaluation_start_date_time строка	изменено	Дата начала лицензии оценки. Пример: 2018-09-09T00:00:00-07:00
	free_device_licenses целое число	изменено	Количество оставшихся бесплатных лицензий. Пример: 34
	license_end_date_time строка	изменено	Дата истечения срока действия лицензии. Пример: 2018-10-11T00:00:00-07:00
	license_start_date_time строка	изменено	Дата начала действия лицензии. Пример: 2018-09-09T00:00:00-07:00
	licensed_date_time строка	изменено	Отметка времени лицензирования пула. Пример: 2018-09-10T00:00:00-07:00
	licensed_version строка	изменено	Версия BIG-IQ, на которую предоставлена лицензия. Пример: 6.0.1
	name строка	изменено	Название приобретённого пула. Пример: my-pool1
	registration_key строка	изменено	Ключ лицензии приобретённого пула. Пример: XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX
	state строка	изменено	Состояние лицензии приобретённого пула. Пример: LICENSED
	total_device_licenses целое число	изменено	Общее количество лицензий в пуле. Пример: 40
	uuid строка	изменено	UUID приобретённой лицензии пула. Пример: b2112329-cba7-4f1f-9a26-fab9be416d60
	vendor строка	изменено	Производитель, предоставивший лицензию. Пример: F5 Networks, Inc
regkey_pools сложное		Когда `regkey-pools` указано в `gather_subset`.	Информация о пулах regkey. Пример: hash/словарь значений
	id строка	изменено	ID пула regkey. Пример: 4f9b565c-0831-4657-b6c2-6dde6182a502
	name строка	изменено	Имя пула regkey. Пример: pool1
	offerings сложное		Список предложений в пуле. Пример: hash/словарь значений

		досье строка		изменено	Досье лицензии. Пример: d6bd4b8ba5...e9a1a1199b73af9932948a
		дата_окончания_оценки строка		изменено	Дата окончания лицензии оценки. Пример: 2018-10-11T00:00:00-07:00
		дата_начала_оценки строка		изменено	Дата начала лицензии оценки. Пример: 2018-09-09T00:00:00-07:00
		дата_окончания_лицензии строка		изменено	Дата истечения лицензии. Пример: 2018-10-11T00:00:00-07:00
		дата_начала_лицензии строка		изменено	Дата начала лицензии. Пример: 2018-09-09T00:00:00-07:00
		дата_лицензирования строка		изменено	Отметка времени лицензирования regkey. Пример: 2018-09-10T00:00:00-07:00
		лицензированная_версия строка		изменено	Версия BIG-IQ, которая лицензирована. Пример: 6.0.1
		имя строка		изменено	Имя regkey. Пример: regkey1
		ключ_регистрации строка		изменено	Ключ регистрации лицензии. Пример: XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX
		состояние строка		изменено	Состояние лицензии regkey Пример: LICENSED
	общее_предложение целое число			изменено	Общее количество предложений в пуле Пример: 10
информация_системы сложный				Когда `system-info` указано в `gather_subset`.	Факты, относящиеся к информации о системе. Пример: хэш/словарь значений
	базовый_адрес_mac строка			изменено	Адрес управления доступом к среде (MAC-адрес) устройства. Пример: fa:16:3e:c3:42:6f
	серийный_номер_шасси строка				Серийный номер шасси Пример: 11111111-2222-3333-444444444444
	информация_об_аппаратуре сложный			изменено	Информация, связанная с оборудованием (дисками и процессорами) системы.
		модель строка			Модель оборудования. Пример: Виртуальный диск
		имя строка			Имя оборудования. Пример: HD1
		тип строка			Тип оборудования. Пример: physical-disk
		версии сложный			Свойства, специфичные для оборудования
			имя строка		Имя свойства Пример: Размер
			версия строка		Значение свойства Пример: 154.00Г
	ревизия_части_платы_хоста строка				Ревизия платы хоста.
	серийный_номер_платы_хоста строка				Серийный номер платы хоста.
	пароль_администратора_изменён булево			изменено	Изменен ли пароль администратора с его значения по умолчанию. Пример: True
	пароль_root_изменён булево			изменено	Изменен ли пароль root с его значения по умолчанию.
	настройка_системы_выполнена булево			изменено	Настроена ли система или нет. Пример: True
	маркетинговое_название строка			изменено	Маркетинговое имя платформы устройства. Пример: BIG-IQ Виртуальное издание
	издание_пакета строка			изменено	Отображает издание программного обеспечения. Пример: Точечный выпуск 7
	версия_пакета строка				Строка, объединяющая `product_build` и `product_build_date`. Пример: Сборка 0.0.1 - Вт 15 мая 15:26:30 PDT 2018
	платформа строка				Идентификатор платформы. Пример: Z100

	product_build string			Версия сборки выпуска. Пример: 0.0.1
	product_build_date string			Дата сборки в читаемом формате. Пример: Вторник, 15 мая 15:26:30 PDT 2018
	product_built integer			Маркер времени Unix, когда продукт был собран. Пример: 180515152630
	product_changelist integer			Список изменений, от которого ведётся ветвь продукта. Пример: 2557198
	product_code string			Код, идентифицирующий продукт. Пример: BIG-IQ
	product_jobid integer			Идентификатор задачи, которая сгенерировала версию продукта. Пример: 1012030
	product_version string			Основная версия продукта работающего ПО. Пример: 6.0.0
	switch_board_part_revision string			Ревизия платы коммутатора.
	switch_board_serial string			Серийный номер платы коммутатора.
	time complex		changed	Сопоставление текущей информации о времени со специфическими именованными ключами времени.
		day integer	changed	Текущий день месяца в числовом формате. Пример: 7
		hour integer	changed	Текущий час дня в формате 24-часовых часов. Пример: 18
		minute integer	changed	Текущая минута часа. Пример: 16
		month integer	changed	Текущий месяц в числовом формате. Пример: 6
		second integer	changed	Текущая секунда минуты. Пример: 51
		year integer	changed	Текущий год в формате из четырёх цифр. Пример: 2018
	uptime integer			Время в секундах, прошедшее с момента запуска системы. Пример: 603202
vlans complex			Когда `vlans` указано в `gather_subset`.	Список фактов VLAN. Пример: хеш/словарь значений
	auto_lasthop string		changed	Позволяет системе отправлять трафик ответа на MAC-адрес, который передал запрос, даже если таблица маршрутизации указывает на другую сеть или интерфейс. Пример: включено
	cmp_hash_algorithm string		changed	Указывает, как трафик по VLAN будет разделен. Пример: по умолчанию
	description string		changed	Описание VLAN. Пример: Моя vlan
	failsafe_action string		changed	Действие, которое система должна выполнить при срабатывании механизма защиты. Пример: перезапуск
	failsafe_enabled boolean		changed	Включена ли функция защиты или нет. Пример: True
	failsafe_timeout integer		changed	Количество секунд, в течение которых активный узел может работать без обнаружения сетевого трафика в этой VLAN, прежде чем он начнёт резервное копирование. Пример: 90
	if_index integer		changed	Индекс, назначенный этой VLAN. Это уникальный идентификатор, назначенный для всех объектов, отображаемых в SNMP IF-MIB. Пример: 176
	interfaces complex		changed	Список помеченных или непомеченных интерфейсов и каналов, которые вы хотите настроить для VLAN.
		full_path string	changed	Полное имя ресурса, как известно BIG-IP. Пример: 1.3
		name string	changed	Относительное имя ресурса в BIG-IP. Пример: 1.3
		tagged boolean	changed	Помечен ли интерфейс или нет.
	learning_mode string		changed	Настроены ли порты коммутатора, помещенные в VLAN, для обучения коммутатора, только для пересылки или отклонены. Пример: включить-пересылку

mtu целое число	изменено	Максимальный размер транспортного блока (MTU) для VLAN. Пример: 1500
sflow_poll_interval целое число	изменено	Максимальный интервал в секундах между двумя опросами.
sflow_poll_interval_global логическое значение	изменено	Указывает, переопределяет ли глобальное значение интервала опроса VLAN значение интервала опроса на уровне объекта.
sflow_sampling_rate целое число	изменено	Соотношение наблюдаемых пакетов к сгенерированным образцам.
sflow_sampling_rate_global логическое значение	изменено	Указывает, переопределяет ли глобальное значение скорости выборки VLAN значение скорости выборки на уровне объекта. Пример: True
source_check_enabled логическое значение	изменено	Указывает, что принимаются только соединения, имеющие обратный маршрут в таблице маршрутизации. Пример: True
tag целое число	изменено	Номер тега для VLAN. Пример: 30
true_mac_address строка	изменено	Адрес управления доступом к среде (MAC) для интерфейса с наименьшим номером, назначенного этой VLAN. Пример: fa:16:3e:10:da:ff

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается партнером Ansible. [сертифицирован]

Авторы

Tim Rupp (@caphrim007)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 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/bigiq_device_facts_module.html