f5networks.f5_modules.bigiq_device_info – Сбор информации с устройств F5 BIG-IQ

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).

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

Для использования в книге задач укажите: f5networks.f5_modules.bigiq_device_info.

Новое в версии 1.0.0: модуля f5networks.f5_modules

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

Описание

Сбор информации с устройств F5 BIG-IQ.
Этот модуль назывался bigiq_device_facts до Ansible 2.9. Способ использования не изменился.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
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	При указании, этот аргумент ограничивает возвращаемую информацию заданным подмножеством. Вы можете указать список значений для включения более крупного подмножества. Значения также могут быть использованы с начальным `!`, чтобы указать, что определенное подмножество не должно быть собрано.
provider словарь добавлен в 1.0.0 f5networks.f5_modules			Объект словаря, содержащий детали подключения.
	auth_provider строка		Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	no_f5_teem логическое значение	Варианты: no yes	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную среды `F5_TEEM`.
	password строка / обязательно		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
	server_port целое число	Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
	timeout целое число		Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: rest ←	Настраивает транспортное соединение для использования при подключении к удаленному устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs логическое значение	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах, использующих самозаверяющие сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.

Примечания

Примечание

Этот модуль поддерживается во всех версиях BIG-IQ
В BIGIQ 7.0 и более поздних версиях некоторые поля метаданных не включены/не поддерживаются (например, время работы, product_changelist, product_jobid)
Дополнительную информацию о использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP >= 12.
Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохранится на диске, обязательно включите хотя бы одну задачу, которая использует модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения вашей текущей конфигурации.

Примеры

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

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

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

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

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

Ключ		Возвращаемое значение	Описание
applications complex		Когда `managed-devices` указано в `gather_subset`.	Информация об приложении Пример: хеш/словарь значений
	active_alerts integer	изменённое	Количество активных оповещений об приложении.
	bad_traffic float	изменённое	Процент трафика приложения, определённого как 'плохой'. Это значение зависит от `protection_mode`. Пример: 1.7498
	bad_traffic_growth boolean	изменённое	Включены ли оповещения о росте плохого трафика или нет.
	connections float	изменённое	Текущее количество подключений к приложению. Пример: 3.06
	enhanced_analytics boolean	изменённое	Включен ли расширенный анализ для приложения или нет. Пример: True
	health string	изменённое	Состояние приложения. Пример: Хорошо
	id string	изменённое	Идентификатор приложения, известный BIG-IQ. Пример: 996baae8-5d1d-3662-8a2d-3612fa2aceae
	name string	изменённое	Название приложения. Пример: site12http.example.com
	new_connections float	изменённое	Количество новых подключений в секунду. Пример: 0.35
	protection_mode string	изменённое	Тип защиты F5 Web Application Security Service для приложения. Пример: Не защищено
	response_time float	изменённое	Измеренное время отклика приложения в миллисекундах. Пример: 0.02
	status string	изменённое	Текущее состояние приложения. Пример: РАСПРОСТРАНЁННЫЙ
	transactions_per_second float	изменённое	Текущая скорость обработки транзакций приложением в секунду. Пример: 0.87
managed_devices complex		Когда `managed-devices` указано в `gather_subset`.	Информация о управляемых устройствах. Пример: хеш/словарь значений
	address string	изменённое	Адрес, где было обнаружено устройство. Пример: 10.10.10.10
	build string	изменённое	Версия сборки. Пример: 0.0.4
	device_uri string	изменённое	URI для доступа к интерфейсу управления устройством. Пример: https://10.10.10.10:443
	edition string	изменённое	Строка редакции версии продукта. Пример: Финальная
	group_name string	изменённое	Группа BIG-IQ, членом которой является устройство. Пример: cm-bigip-allBigIpDevices
	hostname string	изменённое	Обнаруженное имя хоста устройства. Пример: tier2labB1.lab.fp.foo.com
	https_port integer	изменённое	Порт HTTPS, доступный на интерфейсе управления устройством. Пример: 443
	is_clustered boolean	изменённое	Является ли устройство кластеризованным.
	is_license_expired boolean	изменённое	Истек ли лицензионный ключ на устройстве. Пример: True
	is_virtual boolean	изменённое	Является ли устройство виртуальной версией или нет. Пример: True
	machine_id string	изменённое	Идентификатор машины, назначенный этому устройству BIG-IQ. Пример: c141bc88-f734-4434-be64-a3e9ea98356e
	management_address string	изменённое	IP-адрес интерфейса управления устройством. Пример: 10.10.10.10
	mcp_device_name string	изменённое	Имя устройства, известное MCPD на BIG-IP. Пример: /Common/tier2labB1.lab.fp.foo.com
	product string	изменённое	Продукт, под которым распознано управляемое устройство. Пример: BIG-IP
	rest_framework_version string	изменённое	Версия REST-фреймворка, работающего на устройстве. Пример: 13.1.1-0.0.4
	self_link string	изменённое	Внутренняя ссылка на управляемое устройство в BIG-IQ. Пример: https://localhost/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices/c141bc88-f734-4434-be64-a3e9ea98356e
	slots dictionary	изменённое	Тома на устройстве и версии установленного программного обеспечения в этих томах. Пример: {'build': '0.0.4', 'isActive': 'yes', 'product': 'BIG-IP', 'version': '13.1.1', 'volume': 'HD1.1'}
	state string	изменённое	Состояние устройства. Пример: АКТИВНЫЙ
	tags dictionary	изменённое	Различные метки, присвоенные устройству. Пример: {'BIGIQ_SSG_name': 'tim-ssg', 'BIGIQ_tier_2_device': '2018-08-22T13:30:47.693-07:00'}
	trust_domain_guid string	изменённое	GUID домена доверия, частью которого является устройство. Пример: 40ddf541-e604-4905-bde3005056813e36
	uuid string	изменённое	UUID устройства в BIG-IQ. Пример: c141bc88-f734-4434-be64-a3e9ea98356e
	version string	изменённое	Версия TMOS, установленная на устройстве. Пример: 13.1.1
purchased_pool_licenses complex		Когда `purchased-pool-licenses` указано в `gather_subset`.	Информация о приобретённых лицензиях пула. Пример: хеш/словарь значений
	base_reg_key string	изменённое	Базовый ключ регистрации приобретённого пула. Пример: XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX
	dossier string	изменённое	Досье приобретённой лицензии пула. Пример: d6bd4b8ba5...e9a1a1199b73af9932948a
	evaluation_end_date_time string	изменённое	Дата окончания оценочной лицензии. Пример: 2018-10-11T00:00:00-07:00
	evaluation_start_date_time string	изменённое	Дата начала оценочной лицензии. Пример: 2018-09-09T00:00:00-07:00

	free_device_licenses integer			changed	Количество оставшихся бесплатных лицензий. Пример: 34
	license_end_date_time string			changed	Дата истечения лицензии. Пример: 2018-10-11T00:00:00-07:00
	license_start_date_time string			changed	Дата начала действия лицензии. Пример: 2018-09-09T00:00:00-07:00
	licensed_date_time string			changed	Отметка времени лицензирования пула. Пример: 2018-09-10T00:00:00-07:00
	licensed_version string			changed	Версия BIG-IQ, на которую распространяется лицензия. Пример: 6.0.1
	name string			changed	Имя приобретённого пула. Пример: my-pool1
	registration_key string			changed	Ключ лицензии приобретённого пула. Пример: XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX
	state string			changed	Состояние лицензии приобретённого пула. Пример: LICENSED
	total_device_licenses integer			changed	Общее количество лицензий в пуле. Пример: 40
	uuid string			changed	UUID приобретённой лицензии пула. Пример: b2112329-cba7-4f1f-9a26-fab9be416d60
	vendor string			changed	Поставщик лицензии. Пример: F5 Networks, Inc
regkey_pools complex				Когда `regkey-pools` указано в `gather_subset`.	Информация, связанная с пулом regkey. Пример: хеш/словарь значений
	id string			changed	Идентификатор пула regkey. Пример: 4f9b565c-0831-4657-b6c2-6dde6182a502
	name string			changed	Имя пула regkey. Пример: pool1
	offerings complex			success	Список предложений в пуле. Пример: хеш/словарь значений
		dossier string		changed	Досье лицензии. Пример: d6bd4b8ba5...e9a1a1199b73af9932948a
		evaluation_end_date_time string		changed	Дата окончания оценочной лицензии. Пример: 2018-10-11T00:00:00-07:00
		evaluation_start_date_time string		changed	Дата начала оценочной лицензии. Пример: 2018-09-09T00:00:00-07:00
		license_end_date_time string		changed	Дата истечения лицензии. Пример: 2018-10-11T00:00:00-07:00
		license_start_date_time string		changed	Дата начала действия лицензии. Пример: 2018-09-09T00:00:00-07:00
		licensed_date_time string		changed	Отметка времени лицензирования regkey. Пример: 2018-09-10T00:00:00-07:00
		licensed_version string		changed	Версия BIG-IQ, на которую распространяется лицензия. Пример: 6.0.1
		name string		changed	Имя regkey. Пример: regkey1
		registration_key string		changed	Ключ лицензии регистрации. Пример: XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX
		state string		changed	Состояние лицензии regkey. Пример: LICENSED
	total_offerings integer			changed	Общее количество предложений в пуле. Пример: 10
system_info complex				Когда `system-info` указано в `gather_subset`.	Связанная информация о системе. Пример: хеш/словарь значений
	base_mac_address string			changed	Адрес управления доступом к среде (MAC-адрес) устройства. Пример: fa:16:3e:c3:42:6f
	chassis_serial string			success	Серийный номер шасси. Пример: 11111111-2222-3333-444444444444
	hardware_information complex			changed	Информация, связанная с аппаратным обеспечением (дисками и ЦП) системы.
		model string		success	Модель аппаратного обеспечения. Пример: Виртуальный диск
		name string		success	Имя аппаратного обеспечения. Пример: HD1
		type string		success	Тип аппаратного обеспечения. Пример: physical-disk
		versions complex		success	Свойства, специфичные для аппаратного обеспечения.
			name string	success	Имя свойства. Пример: Размер
			version string	success	Значение свойства. Пример: 154.00 ГБ
	host_board_part_revision string			success	Ревизия материнской платы.
	host_board_serial string			success	Серийный номер материнской платы.
	is_admin_password_changed boolean			changed	Изменялся ли пароль администратора от значения по умолчанию. Пример: True
	is_root_password_changed boolean			changed	Изменялся ли пароль root от значения по умолчанию.
	is_system_setup boolean			changed	Была ли выполнена настройка системы. Пример: True
	marketing_name string			changed	Маркетинговое название платформы устройства. Пример: BIG-IQ виртуальная версия
	package_edition string			changed	Отображает выпуск программного обеспечения. Пример: Точечный выпуск 7
	package_version string			success	Строка, объединяющая `product_build` и `product_build_date`. Пример: Сборка 0.0.1 - Вт, 15 мая 15:26:30 PDT 2018

	platform string		success	Идентификатор платформы. Пример: Z100
	product_build string		success	Версия сборки выпускаемой версии. Пример: 0.0.1
	product_build_date string		success	Читаемый человеком день сборки. Пример: Втор, 15 мая 15:26:30 PDT 2018
	product_built integer		success	Маркер Unix времени, когда был создан продукт. Пример: 180515152630
	product_changelist integer		success	Изменение списка, от которого ведут ветки продукта. Не поддерживается в BIGIQ 7.0 и более поздних версиях Пример: 2557198
	product_code string		success	Код, идентифицирующий продукт. Пример: BIG-IQ
	product_jobid integer		success	Идентификатор задачи, которая создала версию продукта. Не поддерживается в BIGIQ 7.0 и более поздних версиях Пример: 1012030
	product_version string		success	Основная версия продукта работающего программного обеспечения. Пример: 6.0.0
	switch_board_part_revision string		success	Ревизия платы коммутатора.
	switch_board_serial string		success	Серийный номер платы коммутатора.
	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		success	Время в секундах с момента запуска системы. Не поддерживается в BIGIQ 7.0 и более поздних версиях Пример: 603202
vlans complex			Когда `vlans` указан в `gather_subset`.	Список информации о VLAN. Пример: хеш/словарь значений
	auto_lasthop string		changed	Разрешает системе отправлять трафик возврата в MAC-адрес, который передал запрос, даже если таблица маршрутизации указывает на другую сеть или интерфейс. Пример: enabled
	cmp_hash_algorithm string		changed	Указывает, как трафик в VLAN будет дезагрегирован. Пример: default
	description string		changed	Описание VLAN. Пример: Мой vlan
	failsafe_action string		changed	Действие, которое система должна выполнить, когда срабатывает механизм fail-safe. Пример: reboot
	failsafe_enabled boolean		changed	Включен или нет fail-safe. Пример: True
	failsafe_timeout integer		changed	Количество секунд, в течение которых активный узел может работать без обнаружения сетевого трафика в этой VLAN, прежде чем он запустит failover. Пример: 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, для обучения коммутатора, только пересылки или удалены. Пример: enable-forward
	mtu integer		changed	Конкретный максимальный размер транспортного блока (MTU) для VLAN. Пример: 1500
	sflow_poll_interval integer		changed	Максимальный интервал в секундах между двумя опросами.
	sflow_poll_interval_global boolean		changed	Настройка глобального интервала опроса VLAN перекрывает настройку интервала опроса на уровне объекта.
	sflow_sampling_rate integer		changed	Соотношение наблюдаемых пакетов к сгенерированным образцам.
	sflow_sampling_rate_global boolean		changed	Настройка глобальной частоты выборки VLAN перекрывает настройку частоты выборки на уровне объекта. Пример: True
	source_check_enabled boolean		changed	Указывает, что принимаются только соединения, имеющие обратный маршрут в таблице маршрутизации. Пример: True
	tag integer		changed	Номер тега VLAN. Пример: 30
	true_mac_address string		changed	MAC-адрес интерфейса с наименьшим номером, назначенным этой VLAN. Пример: fa:16:3e:10:da:ff

Авторы

Tim Rupp (@caphrim007)

© 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/f5networks/f5_modules/bigiq_device_info_module.html