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

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

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

Описание

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

Псевдонимы: bigiq_device_facts

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
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 словарь добавлено в 2.5			Объект словаря с информацией о подключении.
	auth_provider строка		Настраивает поставщика авторизации для получения маркеров авторизации с удалённого устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	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 целое число		Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: cli rest ←	Настраивает транспортное соединение для подключения к удалённому устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Этот параметр можно опустить, установив переменную среды `F5_USER`.
	validate_certs булево	Варианты: 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 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	changed	Производственный продукт, по которому определяется управляемое устройство. Пример: BIG-IP
	rest_framework_version string	changed	Версия REST фреймворка, работающего на устройстве. Пример: 13.1.1-0.0.4
	self_link string	changed	Внутренняя ссылка на управляемое устройство в BIG-IQ. Пример: https://localhost/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices/c141bc88-f734-4434-be64-a3e9ea98356e
	slots complex	changed	Тома на устройстве и версии установленного программного обеспечения в этих томах. Пример: {'volume': 'HD1.1', 'product': 'BIG-IP', 'version': '13.1.1', 'build': '0.0.4', 'isActive': 'yes'}
	state string	changed	Состояние устройства. Пример: ACTIVE
	tags complex	changed	Различные метки, назначенные устройству. Пример: {'BIGIQ_tier_2_device': '2018-08-22T13:30:47.693-07:00', 'BIGIQ_SSG_name': 'tim-ssg'}
	trust_domain_guid string	changed	GUID домена доверия, к которому принадлежит устройство. Пример: 40ddf541-e604-4905-bde3005056813e36
	uuid string	changed	UUID устройства в BIG-IQ. Пример: c141bc88-f734-4434-be64-a3e9ea98356e
	version string	changed	Версия TMOS, установленная на устройстве. Пример: 13.1.1
purchased_pool_licenses complex		Когда `purchased-pool-licenses` указано в `gather_subset`.	Информация, связанная с приобретенными лицензиями пула. Пример: hash/словарь значений
	base_reg_key string	changed	Базовый регистрационный ключ приобретенного пула. Пример: XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX
	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
	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. Пример: hash/словарь значений
	id string	changed	ID пула regkey. Пример: 4f9b565c-0831-4657-b6c2-6dde6182a502

	Имя строка			изменено	Имя пула regkey. Пример: pool1
	Предложения сложный тип				Список предложений в пуле. Пример: хеш/словарь значений
		Досье строка		изменено	Досье лицензии. Пример: 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
	Изменён_корневой_пароль логическое			изменено	Изменён ли корневой пароль с умолчания?
	Система_настроена логическое			изменено	Настроена ли система? Пример: True

	marketing_name string		changed	Маркетинговое имя платформы устройства. Пример: BIG-IQ Virtual Edition
	package_edition string		changed	Отображает версию программного обеспечения. Пример: Point Release 7
	package_version string			Строка, объединяющая `product_build` и `product_build_date`. Пример: Build 0.0.1 - Tue May 15 15:26:30 PDT 2018
	platform string			Идентификатор платформы. Пример: Z100
	product_build string			Версия сборки выпуска. Пример: 0.0.1
	product_build_date string			Дата сборки в читаемом формате. Пример: Tue May 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. Пример: hash/dictionary of values
	auto_lasthop string		changed	Позволяет системе отправлять ответный трафик на MAC-адрес, который передал запрос, даже если таблица маршрутизации указывает на другую сеть или интерфейс. Пример: enabled
	cmp_hash_algorithm string		changed	Указывает, как трафик на VLAN будет разделен. Пример: default
	description string		changed	Описание VLAN. Пример: My vlan
	failsafe_action string		changed	Действие, которое система должна выполнить при срабатывании механизма аварийного режима. Пример: reboot
	failsafe_enabled boolean		changed	Включен ли аварийный режим. Пример: True
	failsafe_timeout integer		changed	Количество секунд, которое может работать активный узел, не обнаруживая сетевого трафика в этой VLAN, прежде чем он начнет переключение. Пример: 90

if_index целое число		changed	Индекс, назначенный этому VLAN. Это уникальный идентификатор, назначенный для всех объектов, отображаемых в SNMP IF-MIB. Пример: 176
interfaces сложное		changed	Список помеченных или непомеченных интерфейсов и каналов, которые вы хотите настроить для VLAN.
	full_path строка	changed	Полное имя ресурса, как известно BIG-IP. Пример: 1.3
	name строка	changed	Относительное имя ресурса в BIG-IP. Пример: 1.3
	tagged булево	changed	Помечен ли интерфейс или нет.
learning_mode строка		changed	Настроены ли порты коммутатора, помещенные во VLAN, для обучения коммутатора, только для пересылки или отбрасывания. Пример: enable-forward
mtu целое число		changed	Конкретный максимальный размер транспортного блока (MTU) для VLAN. Пример: 1500
sflow_poll_interval целое число		changed	Максимальный интервал в секундах между двумя опросами.
sflow_poll_interval_global булево		changed	Устанавливает, переопределяет ли глобальная настройка интервала опроса VLAN интервал опроса на уровне объекта.
sflow_sampling_rate целое число		changed	Соотношение наблюдаемых пакетов к сгенерированным образцам.
sflow_sampling_rate_global булево		changed	Устанавливает, переопределяет ли глобальная настройка частоты выборки VLAN частоту выборки на уровне объекта. Пример: True
source_check_enabled булево		changed	Указывает, что принимаются только подключения, для которых в таблице маршрутизации имеется обратный маршрут. Пример: True
tag целое число		changed	Номер тега для VLAN. Пример: 30
true_mac_address строка		changed	Адрес управления доступом к среде (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.9/modules/bigiq_device_info_module.html