GET v1/bunits/{bunitId}/consumers/{consumerId}/vm/reports?startDate={startDate}&endDate={endDate}&status={status}&warnings={warnings}

Get reports for a vm

Request Information

URI Parameters

Name	Description	Type	Additional information
`bunitId`	The ID of the business unit the VM is related to	integer	Required
`consumerId`	The ID of the consumption unit the VM is related to	integer	Required
`startDate`	The first date the list of VM reports should include. Omit to get from first date VM had reports	date	None.
`endDate`	The last date the list of VM reports should include. Omit to get reports until present date	date	None.
`status`	Set status = true if the status of the VM reports should be included	boolean	Default value is False
`warnings`	Set warnings = true if the warnings of the VM reports should be included	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of NodeReport

Name	Description	Type	Additional information
`Name`	Backup node name.	string	None.
`Pending`	If a server has not yet reported for the day the node reports are pending Data in pending reports is replicated from the previous day.	boolean	None.
`DataSourceType`	The type of data-source the consumer is related to	DataSourceType	None.
`NodeReportTypeId`	ID of the data-source type	integer	None.
`DataSource`	Name of object on backend server.	string	None.
`DataSourceState`	The state of the data-source when the report was generated	DataSourceState	None.
`DeviceName`	Name of device	string	None.
`TsmName`	Name of object on backend server (obsolete).	string	None.
`Location`	Location name, i.e. backup node name for VM file spaces or hypervisor name for VMs	string	None.
`Status`	The reporting status is based on the applicable report error configuration.	ErrorStatus	None.
`SupportStatus`	Status indicating how the backup node has (or has not) been handled by support	SupportStatus	None.
`TsmClientVersion`	SP client version.	string	None.
`TsmServerName`	IBM Storage Protect server name.	string	None.
`ReportContent`	Serialized data about activity since last report.	NodeReportContent	None.
`ProxyNodeReports`	A list of reports for backup nodes with a proxy target relation to current node	Collection of NodeReport	None.
`ErrorsDeactivated`	Indicates whether errors are deactivated for the backup node.	boolean	None.
`ErrorsDeactivatedReason`	Information about why errors are deactivated	string	None.
`ErrorsDeactivatedNoActivity`	Indicates whether errors regarding no activity are deactivated for the backup node.	boolean	None.
`MegaBytes`	How many megabytes the backup node is storing	decimal number	None.
`BackupMegaBytes`	How many megabytes the backup node backs up	decimal number	None.
`ArchiveMegaBytes`	How many megabytes the backup node archives	decimal number	None.
`MegaBytesDelta`	How many megabytes the backup node is storing	decimal number	None.
`Tags`	List of tags of consumption unit related to report	Collection of Tag	None.
`MegaBytesDeltaPercentage`	How much the delta megabytes are in percentage of megabyte storage	decimal number	None.
`BackupMegaBytesDeltaPercentage`	How much the delta backup megabytes are in percentage of backup megabytes storage	decimal number	None.
`ArchiveMegaBytesDeltaPercentage`	How much the delta megabytes are in percentage of archive megabytes storage	decimal number	None.
`BackupMegaBytesDelta`	How many megabytes the backup node backs up	decimal number	None.
`ArchiveMegaBytesDelta`	How many megabytes the backup node archives	decimal number	None.
`MegaBytesForCurrentBusinessUnit`	How many backup and archive megabytes accumulated the backup node is storing according to current business unit which is viewing the report as opposed to megabytes that reflects what business unit owning the backup node is using. This can differ depending on business unit billing storage type set on the business unit or contract exceptions. Only set for node reports included in status reports	decimal number	None.
`BackupMegaBytesForCurrentBusinessUnit`	How many backup megabytes the backup node is storing according to current business unit which is viewing the report as opposed to megabytes that reflects what enduser is using. This can differ depending on business unit billing storage type set on the business unit or contract exceptions. Only set for backup node reports included in status reports	decimal number	None.
`ArchiveMegaBytesForCurrentBusinessUnit`	How many archive megabytes the backup node is storing according to current business unit which is viewing the report as opposed to megabytes that reflects what enduser is using. This can differ depending on business unit billing storage type set on the business unit or contract exceptions. Only set for backup node reports included in status reports	decimal number	None.
`LastCommentTime`	The latest comment at the time of reporting.	date	None.
`LastCommentTypeId`	The type of the latest comment	integer	None.
`Comments`	A list of all comments created the day of reporting.	Collection of Comment	None.
`TransferredMegaBytes`	How many megabytes the backup node transferred with the last 24 hours	decimal number	None.
`TransferredBackupMegaBytes`	How many megabytes the backup node transferred with the last 24 hours	decimal number	None.
`TransferredRestoreMegaBytes`	How many megabytes the backup node transferred with the last 24 hours	decimal number	None.
`NumberOfFiles`	The number of files	integer	None.
`PercentOfTotalStorageOfBusinessUnit`	How much of the total storage of the business unit this backup node occupies	decimal number	None.
`ConsumerId`	Id of the consumption unit of the report	integer	None.
`Consumer`	The consumption unit of the report	Consumer	None.
`NodeId`	Id of the backup node of the report	integer	None.
`Node`	The backup node of the report	Node	None.
`FilespaceId`	Id of the VirtualMachine of the report	integer	None.
`Filespace`	The VirtualMachine of the report	Filespace	None.
`HypervisorId`	Id of the hypervisor of the report	integer	None.
`Hypervisor`	The hypervisor of the report	Hypervisor	None.
`VmId`	Id of the VM of the report	integer	None.
`Vm`	The VM of the report	Vm	None.
`Microsoft365TenantId`	Id of the Microsoft 365 tenant of the report	integer	None.
`Microsoft365Tenant`	The Microsoft 365 tenant of the report	Microsoft365Tenant	None.
`Microsoft365AccountId`	Id of the Microsoft 365 account of the report	integer	None.
`Microsoft365Account`	The Microsoft 365 account of the report	Microsoft365Account	None.
`RubrikDataSourceId`	Id of the Rubrik data-source of the report	integer	None.
`RubrikDataSource`	The Rubrik data-source of the report	RubrikDataSource	None.
`CohesityDataSourceId`	Id of the Cohesity data-source of the report	integer	None.
`CohesityDataSource`	The Cohesity data-source of the report	CohesityDataSource	None.
`PointBucketId`	Id of the PoINT bucket of the report	integer	None.
`PointBucket`	The PoINT bucket of the report	PointBucket	None.
`BusinessUnitId`	The ID of the business unit that owns the backup node	integer	None.
`BusinessUnitName`	The name of the business unit that owns the backup node	string	None.
`ReportDate`	The date of reporting.	date	None.
`Warnings`	Warnings are collected during reporting. You can specify which warnings are errors and cause alarms for report recipients.	Collection of NodeReportWarning	None.
`Id`	A unique ID for the object.	integer	Read-only.
`CreatedDate`	Time and date the object was created.	date	Read-only.
`ArchivedDate`	Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate	date	Read-only.
`Operations`		Collection of OperationResult	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.