This is an archive version of the document. To get the most up-to-date information, see the current version.

SingleLicenseReport

Property

Type

Attributes

Description

reportParemeters

Subschema (LicenseReportParemeters)

—

Report parameters

reportSummary

Subschema (LicenseReportSummary)

—

Report summary information.

organizationsUsage

Array of subschemas (OrganizationLicenseUsage)

—

Number of license points used by managed organizations.

notCollectedCloudServers

Array of strings

—

Array of Veeam Cloud Connect servers from which Veeam Service Provider Console could not collect the license usage data.

usageDetails

Array of subschemas (OrganizationUsageOfLicensesWithSameSupportId)

—

Usage of licenses with the same support ID.

appendices

Array of subschemas (LicenseReportAppendix)

—

Usage of licenses issued to organizations other than report owner.

LicenseReportParemeters

Property

Type

Attributes

Description

reportId

Integer (int32)

—

Report ID.

organizationName

String

—

Name of a report owner organization.

organizationUid

String (uuid)

—

UID assigned to a report owner organization.

licenseCompanyName

String

—

Name of a licensee organization.

generationDate

String (date)

—

Date of report generation.

Date string is formatted in accordance with RFC 3339.

reportInterval

Subschema (LicenseReportInterval)

—

Reporting interval.

LicenseReportInterval

Property

Type

Attributes

Description

startOfInterval

String (date)

—

Start date of reporting interval.

Date string is formatted in accordance with RFC 3339.

endOfInterval

String (date)

—

End date of reporting interval.

Date string is formatted in accordance with RFC 3339.

LicenseReportSummary

Property

Type

Attributes

Description

totalPoints

Number (double)

—

Number of report owner license points used by managed organizations.

productsUsage

Array of subschemas (TotalProductLicenseUsage)

—

License usage for each product.

TotalProductLicenseUsage

Property

Type

Attributes

Description

productType

String

—

Product type.

Possible values:

  • unknown
  • enterpriseManager
  • backupAndReplication
  • cloudConnect
  • vspc

totalPoints

Number (double)

—

Number of used license points.

licenseEdition

String

—

License edition.

workloadUsage

Array of subschemas (WorkloadLicenseUsage)

—

License usage for each workload type.

WorkloadLicenseUsage

Property

Type

Attributes

Description

workloadType

String

—

Workload type.

Possible values:

  • unknown
  • vbR_VM
  • vbR_Cloud_VM
  • vaC_Workstation_Agent
  • vaC_Server_Agent
  • vbR_Workstation_Agent
  • vbR_Server_Agent
  • vbR_Application_Plugins
  • vbR_NAS_Backup
  • cC_VM_Backup
  • cC_Workstation_Backup
  • cC_Server_Backup
  • cC_VM_Replica

initialCount

Integer (int32)

—

Number of managed agents.

reportedCount

Integer (int32)

—

Number of managed agents after report finalization.

newCount

Integer (int32)

—

Number of managed agents that were activated within the current calendar month.

weight

Number (double)

—

Number of points a single workload uses.

usedPoints

Number (double)

—

Number of points used by all managed agents of the same type.

OrganizationLicenseUsage

Property

Type

Attributes

Description

organizationType

String

—

Organization type.

Possible values:

  • unknown
  • company
  • reseller

organizationName

String

—

Organization name.

organizationUid

String (uuid)

—

UID assigned to an organization.

tenantUid

String (uuid)

Nullable

UID assigned to a tenant. For resellers the value is null.

usedPoints

Number (double)

—

Number of license points used by an organization.

OrganizationUsageOfLicensesWithSameSupportId

Property

Type

Attributes

Description

organizationName

String

—

Organization name.

organizationUid

String (uuid)

—

UID assigned to an organization.

tenantUid

String (uuid)

Nullable

UID assigned to a tenant. For resellers the value is null.

supportId

String

Nullable

License support ID.

notCollectedClientServers

Array of strings

—

Array of Veeam Backup & Replication servers from which Veeam Service Provider Console could not collect the license usage data.

usageByLicenseAndProduct

Array of subschemas (ProductLicenseUsage)

—

License usage for each license and product.

ProductLicenseUsage

Property

Type

Attributes

Description

licenseId

String

Nullable

License ID.

productType

String

—

Product type.

Possible values:

  • unknown
  • enterpriseManager
  • backupAndReplication
  • cloudConnect
  • vspc

licenseEdition

String

Nullable

License edition.

usedPoints

Number (double)

—

Number of license points used by an organization.

workloadUsage

Array of subschemas (WorkloadLicenseUsage)

—

License usage for each workload type.

LicenseReportAppendix

Property

Type

Attributes

Description

licenseCompanyName

String

—

Licensee company name.

appendixSummary

Subschema (LicenseReportSummary)

—

Appendix summary information.

organizationsUsage

Array of subschemas (OrganizationLicenseUsage)

—

Number of license points used by managed organizations.

notCollectedCloudServers

Array of strings

—

Array of Veeam Cloud Connect servers from which Veeam Service Provider Console could not collect the license usage data.

usageDetails

Array of subschemas (OrganizationUsageOfLicensesWithSameSupportId)

—

Detailed information about license usage.

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.