Properties

In this article

    The /tenants/licensing/reports resource has a number of properties that reflect license characteristics. Properties can be used in POST requests and as query parameter values in GET requests.

    Property

    Type

    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

    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

    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

    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

    Description

    productName

    String

    Name of a product.

    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

    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

    Description

    organizationType

    String

    Organization type.

    Possible values:

    • Unknown
    • Company
    • Reseller

    organizationName

    String

    Organization name.

    organizationUid

    String (uuid)

    UID assigned to an organization.

    tenantId

    String (uuid)

    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

    Description

    organizationName

    String

    Organization name.

    organizationUid

    String (uuid)

    UID assigned to an organization.

    tenantId

    String (uuid)

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

    supportId

    String

    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

    Description

    licenseId

    String

    License ID.

    productName

    String

    Name of a product.

    Possible values:

    • Unknown
    • EnterpriseManager
    • BackupAndReplication
    • CloudConnect
    • VSPC

    licenseEdition

    String

    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

    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.