The topic describes data fields that are collected by Call Home for IBM
Storage Protect server monitoring.
Root level fields
| Field |
Data Type |
Description |
customer |
String |
Organization identifier for the customer. |
component |
String |
Component identifier. |
code |
String |
Report code identifier. |
fault |
String |
Fault status indicator. Value is none when no faults are detected. |
contact_email |
String |
Email address of the primary contact person. |
contact_phone |
String |
Phone number of the primary contact person. |
contact_name |
String |
Name of the primary contact person. |
contact_address |
String |
Mailing address of the primary contact person. |
description |
String |
Description of the payload contents. |
Context object fields
| Field |
Data Type |
Description |
origin |
Integer |
Origin identifier for the data source. |
timestamp |
Long |
Unix timestamp in milliseconds indicating when the data was collected. |
transid |
Long |
Transaction identifier for tracking the data submission. |
Overview object fields
| Field |
Data Type |
Description |
data_collected_date |
String (Date) |
Date when the data was collected, in YYYY-MM-DD format. |
report_generated_date |
String (Date) |
Date when the report was generated, in YYYY-MM-DD format. |
server_count |
Integer |
Total number of servers in the fleet. |
client_count |
Integer |
Total number of clients across all servers. |
Inventory - servers_from_html array fields
| Field |
Data Type |
Description |
vendor |
String |
Vendor name of the server hardware. |
name |
String |
Server name or hostname. |
platform |
String |
Operating system and architecture of the server. |
version_str |
String |
IBM Spectrum Protect server version number. |
clients |
Integer |
Number of clients registered to this server. |
serial |
String |
Hardware serial number of the server. |
type |
String |
Hardware type or model number of the server. |
Inventory - dashboard_per_server array fields
| Field |
Data Type |
Description |
name |
String |
Server name or hostname. |
daily_ingest_max_tb |
Float |
Maximum daily data ingest in terabytes. |
daily_ingest_avg_tb |
Float |
Average daily data ingest in terabytes. |
db_alloc_gb |
Float |
Allocated database space in gigabytes. |
db_used_gb |
Float |
Used database space in gigabytes. |
devclass_est_capacity_tb |
Float |
Estimated device class capacity in terabytes. |
devclass_pct_utilized |
Float |
Percentage of device class capacity utilized. |
directory_est_capacity_tb |
Float |
Estimated directory container capacity in terabytes. |
directory_pct_utilized |
Float |
Percentage of directory container capacity utilized. |
primary_total_used_tb |
Float |
Total primary storage used in terabytes. |
blueprint_ingest |
String |
Blueprint sizing category for data ingest. Valid values are Small, Medium, or Large. |
blueprint_db |
String |
Blueprint sizing category for database. Valid values are Small, Medium, or Large. |
blueprint_data |
String |
Blueprint sizing category for data storage. Valid values are Small, Medium, or Large. |
Licensing - backend per_server array fields
| Field |
Data Type |
Description |
server |
String |
Server name or hostname. |
licenses_tb |
Float |
Licensed backend capacity in terabytes. |
archive_tb |
Float |
Archive data capacity in terabytes. |
occupancy_tb |
Float |
Total backend occupancy in terabytes. |
reporting_date |
String (Date) |
Date of the licensing report, in YYYY-MM-DD format. |
Licensing - backend totals object fields
| Field |
Data Type |
Description |
licenses_tb |
Float |
Total licensed backend capacity across all servers in terabytes. |
archive_tb |
Float |
Total archive data capacity across all servers in terabytes. |
occupancy_tb |
Float |
Total backend occupancy across all servers in terabytes. |
Licensing - frontend by_workload array fields
| Field |
Data Type |
Description |
workload |
String |
Workload type or application name. Examples include B/A Client, Oracle, MSSQL, DB2, Domino, SP4VE, or Unknown. |
frontend_tb |
Float |
Frontend capacity for this workload in terabytes. |
clients_detected |
Integer |
Number of clients detected for this workload. |
active_clients_quarter |
Integer |
Number of active clients for this workload in the current quarter. |
Licensing - frontend totals object fields
| Field |
Data Type |
Description |
frontend_tb |
Float |
Total frontend capacity across all workloads in terabytes. |
clients |
Integer |
Total number of clients across all workloads. |
active_quarter |
Integer |
Total number of active clients in the current quarter. |
Security - password_settings object fields
| Field |
Data Type |
Description |
authentication |
String |
Authentication status. Valid values are ON or OFF. |
password_expiration_days |
Integer |
Number of days until passwords expire. |
min_password_length |
Integer |
Minimum required password length in characters. |
invalid_password_limit |
Integer |
Maximum number of invalid password attempts allowed before account lockout. |
Security - log_retention object fields
| Field |
Data Type |
Description |
server_name |
String |
Server name or retention period identifier. |
summary_retention_days |
Float |
Number of days to retain summary logs. |
activity_log_retention_days |
Float |
Number of days to retain activity logs. |
Security - db_backup_details object fields
| Field |
Data Type |
Description |
server_name |
String |
Server name or collection date identifier. |
collection_date |
String (DateTime) |
Date and time when the backup information was collected, in YYYY-MM-DD HH:MM:SS format. |
most_recent_backup |
String |
Identifier or count of the most recent backup. |
age_days |
Float |
Age of the most recent backup in days. |
backup_count |
Integer |
Total number of database backups. |
protect_master_key |
Boolean |
Indicates whether the master encryption key is protected. Valid values are true or false. |
Version currency - client_server_buckets object fields
| Field |
Data Type |
Description |
cvrls |
Array of Integers |
Client version release level distribution across version buckets. |
cvrls_m |
Array of Integers |
Client version release level distribution for the current month across version buckets. |
cvrls_q |
Array of Integers |
Client version release level distribution for the current quarter across version buckets. |
cvrls_y |
Array of Integers |
Client version release level distribution for the current year across version buckets. |
Version currency - client_versions_by_platform object fields
| Field |
Data Type |
Description |
labels |
Array of Strings |
Platform labels for client version distribution. |
datasets |
Array of Objects |
Dataset objects containing client version distribution data by platform. |