Модуль f5networks.f5_modules.bigiq_device_info — Сбор информации с устройств F5 BIG-IQ

Примечание

Этот модуль является частью коллекции f5networks.f5_modules (версия 1.31.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

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

Новый в f5networks.f5_modules 1.0.0

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

Описание

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

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

Примечания

Примечание

Этот модуль поддерживается всеми версиями 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: cm.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: cm.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Значения возврата

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

Ключ	Описание
applications сложный	Информация, связанная с приложением Возвращаемое значение: Когда `managed-devices` указано в `gather_subset`. Пример: `"hash/dictionary of values"`
active_alerts целое число	Количество активных предупреждений для приложения. Возвращаемое значение: изменённое Пример: `0`
bad_traffic вещественное число	Процент трафика для приложения, который определяется как «плохой». Это значение зависит от того, включена ли функция `protection_mode`. Возвращаемое значение: изменённое Пример: `1.7498`
bad_traffic_growth логическое	Указывается, настраиваются ли предупреждения о росте плохого трафика. Возвращаемое значение: изменённое Пример: `false`
connections вещественное число	Текущее количество подключений к приложению. Возвращаемое значение: изменённое Пример: `3.06`
enhanced_analytics логическое	Указано, включен ли расширенный анализ для приложения. Возвращаемое значение: изменённое Пример: `true`
health строка	Состояние приложения. Возвращаемое значение: изменённое Пример: `"Good"`
id строка	Идентификатор приложения в BIG-IQ. Возвращаемое значение: изменённое Пример: `"996baae8-5d1d-3662-8a2d-3612fa2aceae"`
name строка	Имя приложения. Возвращаемое значение: изменённое Пример: `"site12http.example.com"`
new_connections вещественное число	Количество новых подключений в секунду. Возвращаемое значение: изменённое Пример: `0.35`
protection_mode строка	Тип защиты F5 Web Application Security Service для приложения. Возвращаемое значение: изменённое Пример: `"Not Protected"`
response_time вещественное число	Измеренное время отклика приложения в миллисекундах. Возвращаемое значение: изменённое Пример: `0.02`
status строка	Текущее состояние приложения. Возвращаемое значение: изменённое Пример: `"DEPLOYED"`
transactions_per_second вещественное число	Текущая величина транзакций в секунду, обрабатываемых приложением. Возвращаемое значение: изменённое Пример: `0.87`
managed_devices сложный	Информация, связанная с управляемыми устройствами. Возвращаемое значение: Когда `managed-devices` указано в `gather_subset`. Пример: `"hash/dictionary of values"`
address строка	Адрес, по которому было обнаружено устройство. Возвращаемое значение: изменённое Пример: `"10.10.10.10"`

build string	Номер сборки версии. Возвращено: changed Пример: `"0.0.4"`
device_uri string	URI для доступа к интерфейсу управления устройством. Возвращено: changed Пример: `"https://10.10.10.10:443"`
edition string	Строка выпуска версии продукта. Возвращено: changed Пример: `"Final"`
group_name string	Группа BIG-IQ, членом которой является устройство. Возвращено: changed Пример: `"cm-bigip-allBigIpDevices"`
hostname string	Обнаруженное имя хоста устройства. Возвращено: changed Пример: `"tier2labB1.lab.fp.foo.com"`
https_port integer	HTTPS-порт, доступный на интерфейсе управления устройством. Возвращено: changed Пример: `443`
is_clustered boolean	Является ли устройство кластером или нет. Возвращено: changed Пример: `false`
is_license_expired boolean	Истекла ли лицензия на устройстве или нет. Возвращено: changed Пример: `true`
is_virtual boolean	Является ли устройство виртуальной версией или нет. Возвращено: changed Пример: `true`
machine_id string	Уникальный идентификатор устройства, назначенный BIG-IQ. Возвращено: changed Пример: `"c141bc88-f734-4434-be64-a3e9ea98356e"`
management_address string	IP-адрес интерфейса управления на устройстве. Возвращено: changed Пример: `"10.10.10.10"`
mcp_device_name string	Имя устройства, известное MCPD на BIG-IP. Возвращено: changed Пример: `"/Common/tier2labB1.lab.fp.foo.com"`
product string	Продукт, как идентифицируется управляемое устройство. Возвращено: changed Пример: `"BIG-IP"`
rest_framework_version string	Версия фреймворка REST, работающая на устройстве Возвращено: changed Пример: `"13.1.1-0.0.4"`
self_link string	Внутренняя ссылка на управляемое устройство в BIG-IQ. Возвращено: changed Пример: `"https://localhost/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices/c141bc88-f734-4434-be64-a3e9ea98356e"`
slots dictionary	Тома на устройстве и версии установленного в них программного обеспечения. Возвращено: changed Пример: `{"build": "0.0.4", "isActive": "yes", "product": "BIG-IP", "version": "13.1.1", "volume": "HD1.1"}`
state string	Состояние устройства. Возвращено: changed Пример: `"ACTIVE"`

теги словарь	Разные теги, назначенные устройству. Возвращено: изменено Пример: `{"BIGIQ_SSG_name": "tim-ssg", "BIGIQ_tier_2_device": "2018-08-22T13:30:47.693-07:00"}`
guid_домена_доверия строка	GUID домена доверия, к которому принадлежит устройство. Возвращено: изменено Пример: `"40ddf541-e604-4905-bde3005056813e36"`
uuid строка	UUID устройства в BIG-IQ. Возвращено: изменено Пример: `"c141bc88-f734-4434-be64-a3e9ea98356e"`
версия строка	Версия TMOS, установленная на устройстве. Возвращено: изменено Пример: `"13.1.1"`
купленные_лицензии_пула сложный	Информация, связанная с лицензией купленного пула. Возвращено: Когда `purchased-pool-licenses` указано в `gather_subset`. Пример: `"hash/dictionary of values"`
базовый_ключ_регистрации строка	Базовый ключ регистрации купленного пула. Возвращено: изменено Пример: `"XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX"`
досье строка	Досье купленной лицензии пула. Возвращено: изменено Пример: `"d6bd4b8ba5...e9a1a1199b73af9932948a"`
дата_окончания_оценочной_лицензии строка	Дата окончания оценочной лицензии. Возвращено: изменено Пример: `"2018-10-11T00:00:00-07:00"`
дата_начала_оценочной_лицензии строка	Дата начала оценочной лицензии. Возвращено: изменено Пример: `"2018-09-09T00:00:00-07:00"`
бесплатные_лицензии_на_устройства целое_число	Количество оставшихся бесплатных лицензий. Возвращено: изменено Пример: `34`
дата_окончания_лицензии строка	Дата истечения срока действия лицензии. Возвращено: изменено Пример: `"2018-10-11T00:00:00-07:00"`
дата_начала_лицензии строка	Дата начала действия лицензии. Возвращено: изменено Пример: `"2018-09-09T00:00:00-07:00"`
дата_лицензирования строка	Отметка времени лицензирования пула. Возвращено: изменено Пример: `"2018-09-10T00:00:00-07:00"`
лицензированная_версия строка	Версия BIG-IQ, на которую распространяется лицензия. Возвращено: изменено Пример: `"6.0.1"`
имя строка	Название купленного пула. Возвращено: изменено Пример: `"my-pool1"`
ключ_регистрации строка	Ключ лицензии купленного пула. Возвращено: изменено Пример: `"XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX"`
состояние строка	Состояние купленной лицензии пула. Возвращено: изменено Пример: `"LICENSED"`

total_device_licenses integer	Общее количество лицензий в пуле. Returned: changed Sample: `40`
uuid string	UUID приобретенной лицензии пула Returned: changed Sample: `"b2112329-cba7-4f1f-9a26-fab9be416d60"`
vendor string	Поставщик, предоставивший лицензию Returned: changed Sample: `"F5 Networks, Inc"`
regkey_pools complex	Информация, связанная с пулом ключей реестра. Returned: When `regkey-pools` is specified in `gather_subset`. Sample: `"hash/dictionary of values"`
id string	ID пула ключей реестра. Returned: changed Sample: `"4f9b565c-0831-4657-b6c2-6dde6182a502"`
name string	Имя пула ключей реестра. Returned: changed Sample: `"pool1"`
offerings complex	Список предложений в пуле. Returned: success Sample: `"hash/dictionary of values"`
dossier string	Досье лицензии. Returned: changed Sample: `"d6bd4b8ba5...e9a1a1199b73af9932948a"`
evaluation_end_date_time string	Дата окончания действия оценочной лицензии. Returned: changed Sample: `"2018-10-11T00:00:00-07:00"`
evaluation_start_date_time string	Дата начала действия оценочной лицензии. Returned: changed Sample: `"2018-09-09T00:00:00-07:00"`
license_end_date_time string	Дата истечения срока действия лицензии. Returned: changed Sample: `"2018-10-11T00:00:00-07:00"`
license_start_date_time string	Дата начала действия лицензии. Returned: changed Sample: `"2018-09-09T00:00:00-07:00"`
licensed_date_time string	Метка времени лицензирования ключа реестра. Returned: changed Sample: `"2018-09-10T00:00:00-07:00"`
licensed_version string	Версия BIG-IQ, которая лицензируется. Returned: changed Sample: `"6.0.1"`
name string	Имя ключа реестра. Returned: changed Sample: `"regkey1"`
registration_key string	Регистрационный ключ лицензии. Returned: changed Sample: `"XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX"`
state string	Состояние лицензии ключа реестра Returned: changed Sample: `"LICENSED"`

total_offerings integer	Общее количество предложений в пуле Возвращено: changed Пример: `10`
system_info complex	Информация о системной информации. Возвращено: Когда `system-info` указан в `gather_subset`. Пример: `"hash/dictionary of values"`
base_mac_address string	Адрес медиа-доступа (MAC-адрес) устройства. Возвращено: changed Пример: `"fa:16:3e:c3:42:6f"`
chassis_serial string	Серийный номер шасси Возвращено: success Пример: `"11111111-2222-3333-444444444444"`
hardware_information complex	Информация об оборудовании (дисках и процессорах) системы. Возвращено: changed
model string	Модель оборудования. Возвращено: success Пример: `"Virtual Disk"`
name string	Название оборудования. Возвращено: success Пример: `"HD1"`
type string	Тип оборудования. Возвращено: success Пример: `"physical-disk"`
versions complex	Специфические свойства оборудования Возвращено: success
name string	Название свойства Возвращено: success Пример: `"Size"`
version string	Значение свойства Возвращено: success Пример: `"154.00G"`
host_board_part_revision string	Ревизия материнской платы. Возвращено: success
host_board_serial string	Серийный номер материнской платы. Возвращено: success
is_admin_password_changed boolean	Изменен ли пароль администратора по умолчанию или нет. Возвращено: changed Пример: `true`
is_root_password_changed boolean	Изменен ли пароль root по умолчанию или нет. Возвращено: changed Пример: `false`
is_system_setup boolean	Настроена ли система или нет. Возвращено: changed Пример: `true`
marketing_name string	Маркетинговое название платформы устройства. Возвращено: changed Пример: `"BIG-IQ Virtual Edition"`
package_edition string	Отображает версию программного обеспечения. Возвращено: changed Пример: `"Point Release 7"`

package_version string	Строка, объединяющая `product_build` и `product_build_date`. Возвращено: success Пример: `"Build 0.0.1 - Tue May 15 15:26:30 PDT 2018"`
platform string	Идентификатор платформы. Возвращено: success Пример: `"Z100"`
product_build string	Версия сборки версии релиза. Возвращено: success Пример: `"0.0.1"`
product_build_date string	Дата сборки, понятная человеку. Возвращено: success Пример: `"Tue May 15 15:26:30 PDT 2018"`
product_built integer	Unix-метка времени сборки продукта. Возвращено: success Пример: `180515152630`
product_changelist integer	Изменение списка, от которого разветвляется продукт. Не поддерживается в BIGIQ 7.0 и более поздних версиях Возвращено: success Пример: `2557198`
product_code string	Код, идентифицирующий продукт. Возвращено: success Пример: `"BIG-IQ"`
product_jobid integer	ID задания, которое создало версию продукта. Не поддерживается в BIGIQ 7.0 и более поздних версиях Возвращено: success Пример: `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	Текущий час дня в 24-часовом формате. Возвращено: changed Пример: `18`
minute integer	Текущая минута часа. Возвращено: changed Пример: `16`
month integer	Текущий месяц в числовом формате. Возвращено: changed Пример: `6`
second integer	Текущая секунда минуты. Возвращено: changed Пример: `51`

year integer	Текущий год в 4-значном формате. Возвращено: changed Пример: `2018`
uptime integer	Время в секундах с момента загрузки системы. Не поддерживается в BIGIQ 7.0 и более поздних версиях Возвращено: success Пример: `603202`
vlans complex	Список информации о VLAN. Возвращено: Когда `vlans` указан в `gather_subset`. Пример: `"hash/dictionary of values"`
auto_lasthop string	Позволяет системе отправлять возвратный трафик на MAC-адрес, который передал запрос, даже если таблица маршрутизации указывает на другую сеть или интерфейс. Возвращено: changed Пример: `"enabled"`
cmp_hash_algorithm string	Указывает, как будет разделен трафик в VLAN. Возвращено: changed Пример: `"default"`
description string	Описание VLAN. Возвращено: changed Пример: `"My vlan"`
failsafe_action string	Действие, которое система должна предпринять, когда срабатывает механизм аварийного переключения. Возвращено: changed Пример: `"reboot"`
failsafe_enabled boolean	Включено ли аварийное переключение или нет. Возвращено: changed Пример: `true`
failsafe_timeout integer	Количество секунд, в течение которых активный модуль может работать без обнаружения сетевого трафика в этом VLAN, прежде чем он начнет переключение. Возвращено: changed Пример: `90`
if_index integer	Индекс, назначенный этому VLAN. Это уникальный идентификатор, назначенный для всех объектов, отображаемых в SNMP IF-MIB. Возвращено: changed Пример: `176`
interfaces complex	Список помеченных или непомеченных интерфейсов и транков, которые вы хотите настроить для VLAN. Возвращено: changed
full_path string	Полное имя ресурса, известное BIG-IP. Возвращено: changed Пример: `"1.3"`
name string	Относительное имя ресурса в BIG-IP. Возвращено: changed Пример: `"1.3"`
tagged boolean	Является ли интерфейс помеченным или нет. Возвращено: changed Пример: `false`
learning_mode string	Настроены ли порты коммутатора, размещенные в VLAN, для обучения коммутатора, только для пересылки или отбрасывания. Возвращено: changed Пример: `"enable-forward"`
mtu integer	Уникальный максимальный блок передачи (MTU) для VLAN. Возвращено: changed Пример: `1500`
sflow_poll_interval integer	Максимальный интервал в секундах между двумя опросами. Возвращено: changed Пример: `0`

sflow_poll_interval_global boolean	Определяет, переопределяет ли глобальное значение интервала опроса VLAN значение интервала опроса на уровне объекта. Возвращаемое значение: changed Пример: `false`
sflow_sampling_rate integer	Соотношение наблюдаемых пакетов к сгенерированным образцам. Возвращаемое значение: changed Пример: `0`
sflow_sampling_rate_global boolean	Определяет, переопределяет ли глобальное значение параметра выборки VLAN значение параметра выборки на уровне объекта. Возвращаемое значение: changed Пример: `true`
source_check_enabled boolean	Указывает, что принимаются только подключения, у которых есть обратный маршрут в таблице маршрутизации. Возвращаемое значение: changed Пример: `true`
tag integer	Номер тега для VLAN. Возвращаемое значение: changed Пример: `30`
true_mac_address string	MAC-адрес интерфейса с наименьшим номером, назначенным этому VLAN. Возвращаемое значение: changed Пример: `"fa:16:3e:10:da:ff"`

Авторы

Tim Rupp (@caphrim007)

Ссылки на сборки

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigiq_device_info_module.html