Properties

The /licensing/backupserverLicenses resource has a number of properties that reflect license characteristics. Properties can be used for POST, PUT, and DELETE requests and as query parameter values in GET requests.

Property

Type

Description

id

String

System ID assigned to a Veeam Backup & Replication server.

contactPerson

String

Name of a contact person in an organization to which the license is issued.

licenseIds

Array of strings

License IDs.

licenseAdministratorEmail

String

Email address of the license administrator in a company.

licenseeEmail

String

Email address of a contact person in a company.

edition

String

Type of Veeam Backup & Replication product edition.

Possible values:

  • Community
  • Standard
  • Enterprise
  • EnterprisePlus

monitoring

String

Monitoring status.

licensedTo

String

Name of a person or organization to which the license is issued.

licenseType

String

Type of the license.

Possible values:

  • NotInstalled
  • Community
  • Trial
  • Full
  • NFR
  • Perpetual
  • Rental
  • Subscription

status

String

Current status of the license.

Possible values:

  • Unknown
  • Valid
  • Warning
  • Error

supportID

String

Support ID required for contacting Veeam Customer Support.

licenseExpirationDate

String

License expiration date and time.

Date and time string is formatted in accordance with ISO 8601.

supportExpirationDate

String

Support expiration date and time.

Date and time string is formatted in accordance with ISO 8601.

licensedSockets

integer

Number of licensed sockets.

usedSockets

integer

Number of used sockets.

licensedVMs

integer

Number of licensed VMs.

usedVMs

integer

Number of used VMs.

backupServerName

String

Name of a Veeam Backup & Replication server to which license is uploaded.

companyName

String

Name of a company in Veeam Service Provider Console to which the licensed server belongs.

locationName

String

Name of a company location at which the licensed server is located.

newVMs

integer

Number of VMs treated as New (for rental licenses).

totalInstances

integer

Total number of available instances.

usedInstances

integer

Number of instances consumed by managed objects.

packages

String

License package type.

sectionTypes

String

Type of license units.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property). Contains a link to the backup server, on which license was installed.

This property can be excluded from the response. For more information, see the SetLinks Custom Query Option (setLinks) section.

I want to report a typo

There is a misspelling right here:

 

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