CompanySiteResource

Property

Type

Attributes

Description

siteUid

String (uuid)

Required

UID assigned to a site.

cloudTenantType

String

Optional

Tenant type in Veeam Cloud Connect.

Possible values:

  • unknown
  • general
  • vcd

companyUid

String (uuid)

Read-only

UID assigned to a company.

cloudTenantUid

String (uuid)

Read-only

UID assigned to a company tenant.

vCloudOrganizationUid

String (uuid)

Optional, nullable

UID assigned to a VCD organization.

leaseExpirationEnabled

Boolean

Optional

Indicates whether a company account must be disabled automatically.

Default value is false.

leaseExpirationDate

String (date-time)

Optional, nullable

Date and time when a company account must be disabled.

Date and time string is formatted in accordance with RFC 3339.

ownerCredentials

Subschema (OwnerCredentials)

Required

Company owner credentials or user name of a tenant account configured for a vCD Organization.

description

String

Optional, nullable

Company description.

throttlingEnabled

Boolean

Optional

Indicates whether incoming network traffic that will be accepted from a company is limited.

Default value is false.

throttlingValue

Integer (int32)

Optional

Maximum incoming network traffic bandwidth that will be accepted from a company.

Default value is 1.

throttlingUnit

String

Optional

Measurement units for incoming network traffic accepted from a company.

Possible values:

  • mbitPerSec
  • kbytePerSec
  • mbytePerSec

maxConcurrentTask

Integer (int32)

Optional

Maximum number of concurrent tasks available to a company.

Default value is 1.

backupProtectionEnabled

Boolean

Optional

Indicates whether deleted backup file protection is enabled.

Default value is false.

backupProtectionPeriodDays

Integer (int32)

Optional

Number of days during which deleted backup files must be kept in the recycle bin on the Veeam Cloud Connect server.

Default value is 7.

gatewaySelectionType

String

Optional

Type of cloud gateway selection.

Possible values:

  • unknown
  • standaloneGateways
  • gatewayPool

gatewayPoolsUids

Array of strings (uuid)

Optional, nullable

Collection of UIDs assigned to gateway pools that are allocated to a company. If the collection is empty, company will automatically use a standalone gateway.

isGatewayFailoverEnabled

Boolean

Optional

Indicates whether a company is allowed to fail over to a cloud gateway that is not added to a selected cloud gateway pool.

Default value is false.

isFailoverCapabilitiesEnabled

Boolean

Optional

Indicates whether performing failover is available for a company or department

isPublicAllocationEnabled

Boolean

Optional

Indicates whether public IP addresses are allocated to a company or department

numberOfPublicIps

Integer (int32)

Optional

Number of allocated public IP addresses

OwnerCredetials

Property

Type

Attributes

Description

userName

String

Required

User name.

password

String (password)

Optional, nullable

Password.

I want to report a typo

There is a misspelling right here:

 

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