Модуль f5networks.f5_modules.bigiq_device_info — сбор сведений с устройств 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"

provider

словарь

добавлено в f5networks.f5_modules 1.0.0

Объект dict, содержащий сведения о подключении.

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 ← (по умолчанию)

applications

complex

Информация, связанная с приложением

Возвращается: если managed-devices указан в gather_subset.

Пример: "hash/dictionary of values"

active_alerts

integer

Количество активных оповещений для приложения.

Возвращается: изменено

Пример: 0

bad_traffic

float

Процент трафика приложения, который считается «плохим».

Это значение зависит от включения protection_mode.

Возвращается: изменено

Пример: 1.7498

bad_traffic_growth

boolean

Указывает, настроены ли оповещения о росте плохого трафика.

Возвращается: изменено

Пример: false

connections

float

Текущее количество соединений с приложением.

Возвращается: изменено

Пример: 3.06

enhanced_analytics

boolean

Указывает, включена ли для приложения расширенная аналитика.

Возвращается: изменено

Пример: true

health

string

Состояние приложения.

Возвращается: изменено

Пример: "Good"

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 для приложения.

Возвращается: изменено

Пример: "Not Protected"

response_time

float

Измеренное время отклика приложения в миллисекундах.

Возвращается: изменено

Пример: 0.02

status

string

Текущее состояние приложения.

Возвращается: изменено

Пример: "DEPLOYED"

transactions_per_second

float

Текущее измеренное количество транзакций в секунду, обрабатываемых приложением.

Возвращается: изменено

Пример: 0.87

managed_devices

complex

Информация, связанная с управляемым устройством.

Возвращается: если managed-devices указан в gather_subset.

Пример: "hash/dictionary of values"

address

string

Адрес, по которому было обнаружено устройство.

Возвращается: изменено

Пример: "10.10.10.10"

build

string

Сборка версии.

Возвращается: изменено

Пример: "0.0.4"

device_uri

string

URI для доступа к интерфейсу управления устройством.

Возвращается: изменено

Пример: "https://10.10.10.10:443"

edition

string

Строка редакции версии продукта.

Возвращается: изменено

Пример: "Final"

group_name

string

Группа BIG-IQ, в которую входит устройство.

Возвращается: изменено

Пример: "cm-bigip-allBigIpDevices"

hostname

string

Обнаруженное имя хоста устройства.

Возвращается: изменено

Пример: "tier2labB1.lab.fp.foo.com"

https_port

integer

Порт HTTPS, доступный на интерфейсе управления устройством.

Возвращается: изменено

Пример: 443

is_clustered

boolean

Указывает, входит ли устройство в кластер.

Возвращается: изменено

Пример: false

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 framework, работающая на устройстве

Возвращается: изменено

Пример: "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

Состояние устройства.

Возвращается: изменено

Пример: "ACTIVE"

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.

Пример: "hash/dictionary of values"

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

Количество оставшихся свободных лицензий.

Возвращается: изменено

Пример: 34

license_end_date_time

string

Дата истечения срока действия лицензии.

Возвращается: изменено

Пример: "2018-10-11T00:00:00-07:00"

license_start_date_time

string

Дата начала действия лицензии.

Возвращается: изменено

Пример: "2018-09-09T00:00:00-07:00"

licensed_date_time

string

Время выдачи лицензии для пула.

Возвращается: изменено

Пример: "2018-09-10T00:00:00-07:00"

licensed_version

string

Версия BIG-IQ, для которой предоставлена лицензия.

Возвращается: изменено

Пример: "6.0.1"

name

string

Название приобретенного пула

Возвращается: изменено

Пример: "my-pool1"

registration_key

string

Ключ лицензии приобретенного пула.

Возвращается: изменено

Пример: "XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX"

state

string

Состояние лицензии приобретенного пула

Возвращается: изменено

Пример: "LICENSED"

total_device_licenses

integer

Общее количество лицензий в пуле.

Возвращается: изменено

Пример: 40

uuid

string

UUID лицензии приобретенного пула

Возвращается: изменено

Пример: "b2112329-cba7-4f1f-9a26-fab9be416d60"

vendor

string

Поставщик лицензии

Возвращается: изменено

Пример: "F5 Networks, Inc"

regkey_pools

complex

Информация о пулах Regkey.

Возвращается: если regkey-pools указано в gather_subset.

Пример: "hash/dictionary of values"

id

string

ID пула regkey.

Возвращается: изменено

Пример: "4f9b565c-0831-4657-b6c2-6dde6182a502"

name

string

Название пула regkey.

Возвращается: изменено

Пример: "pool1"

offerings

complex

Список предложений в пуле.

Возвращается: при успешном выполнении

Пример: "hash/dictionary of values"

dossier

string

Dossier лицензии.

Возвращается: изменено

Пример: "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"

license_end_date_time

string

Дата окончания срока действия лицензии.

Возвращается: изменено

Пример: "2018-10-11T00:00:00-07:00"

license_start_date_time

string

Дата начала действия лицензии.

Возвращается: изменено

Пример: "2018-09-09T00:00:00-07:00"

licensed_date_time

string

Временная метка выдачи лицензии для regkey.

Возвращается: изменено

Пример: "2018-09-10T00:00:00-07:00"

licensed_version

string

Версия BIG-IQ, для которой предоставлена лицензия.

Возвращается: изменено

Пример: "6.0.1"

name

string

Название regkey.

Возвращается: изменено

Пример: "regkey1"

registration_key

string

Регистрационный ключ лицензии.

Возвращается: изменено

Пример: "XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX"

state

string

Состояние лицензии regkey

Возвращается: изменено

Пример: "LICENSED"

total_offerings

integer

Общее количество предложений в пуле

Возвращается: изменено

Пример: 10

system_info

complex

Информация о системе.

Возвращается: если system-info указано в gather_subset.

Пример: "hash/dictionary of values"

base_mac_address

string

Адрес управления доступом к среде передачи данных (MAC-адрес) устройства.

Возвращается: изменено

Пример: "fa:16:3e:c3:42:6f"

chassis_serial

string

Серийный номер корпуса

Возвращается: при успешном выполнении

Пример: "11111111-2222-3333-444444444444"

hardware_information

complex

Информация об аппаратном обеспечении системы (дисках и ЦП).

Возвращается: изменено

model

string

Модель оборудования.

Возвращается: при успешном выполнении

Пример: "Virtual Disk"

name

string

Название оборудования.

Возвращается: при успешном выполнении

Пример: "HD1"

type

string

Тип оборудования.

Возвращается: при успешном выполнении

Пример: "physical-disk"

versions

complex

Свойства, относящиеся к оборудованию

Возвращается: при успешном выполнении

name

string

Название свойства

Возвращается: при успешном выполнении

Пример: "Size"

version

string

Значение свойства

Возвращается: при успешном выполнении

Пример: "154.00G"

host_board_part_revision

string

Ревизия системной платы.

Возвращается: при успешном выполнении

host_board_serial

string

Серийный номер системной платы.

Возвращается: при успешном выполнении

is_admin_password_changed

boolean

Был ли пароль администратора изменен с установленного по умолчанию.

Возвращается: изменено

Пример: true

is_root_password_changed

boolean

Был ли пароль root изменен с установленного по умолчанию.

Возвращается: изменено

Пример: false

is_system_setup

boolean

Выполнена ли настройка системы.

Возвращается: изменено

Пример: true

marketing_name

string

Маркетинговое название платформы устройства.

Возвращается: изменено

Пример: "BIG-IQ Virtual Edition"

package_edition

string

Отображает редакцию программного обеспечения.

Возвращается: изменено

Пример: "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

Номер списка изменений, от которого ответвляется продукт.

Не поддерживается в BIGIQ 7.0 и более поздних версиях

Возвращается: при успешном выполнении

Пример: 2557198

product_code

string

Код, идентифицирующий продукт.

Возвращается: при успешном выполнении

Пример: "BIG-IQ"

product_jobid

integer

ID задания, в ходе которого была собрана версия продукта.

Не поддерживается в 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

Текущий час дня в 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.

Возвращается: если в gather_subset указано vlans.

Пример: "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"