tenant data type properties

The table below describes the properties included in the tenant data type that describes the tenants resource.

Property name

Data type

Description

Notes

administrationAllowed

Boolean

For an HCP tenant, specifies whether system-level users have administrative access to the tenant. Valid values are:

true — System-level users have administrative access to the tenant.

false — System-level users do not have administrative access to the tenant.

The default is false.

This property is not valid for the default tenant.

authenticationTypes

String

For an HCP tenant, lists the types of user authentication supported by the tenant. Possible authentication types are:

LOCAL — The tenant supports local authentication by HCP.

RADIUS — The tenant supports remote authentication by RADIUS servers.

EXTERNAL — The tenant supports remote authentication by AD.

This property is not valid on a POST request. It is returned only by a verbose GET request.

In XML, each listed authentication type is the value of an element named authenticationType. In JSON, the name in the name/value pair that lists the authentication types is authenticationType.

This property is not valid for the default tenant.

complianceConfiguration
  Enabled

Boolean

For an HCP tenant, specifies whether the tenant can set the retention mode of the namespaces it owns. Possible values are:

true — The tenant can set the retention mode.

false — The tenant cannot set the retention mode.

This property is not valid on a POST request. It is returned only by a verbose GET request.

This property is not valid for the default tenant.

In enterprise mode, privileged deletes are allowed, retention class durations can be shortened, and retention classes can be deleted. In compliance mode, these activities are not allowed.

creationTime

String

Specifies the date and time at which the tenant was created, in this ISO 8601 format:

yyyy-MM-ddThh:mm:ssZ

Z represents the offset from UTC, in this format:

(+|-)hhmm

For example:

2017-02-09T19:26:32-0500

This property is not valid on a POST request. It is returned only by a verbose GET request.

fullyQualifiedName

String

Specifies the fully qualified hostname of the tenant.

This property is not valid on a POST request. It is returned only by a verbose GET request.

hardQuota

String

For an HCP tenant, specifies the total amount of space available to the tenant for allocation to its namespaces.

Possible values are decimal numbers with up to two places after the period, followed by a space, followed by MB, GB, or TB (for example, 10.25 TB). The minimum value is 1 (one) for GB and .01 for TB.

This property is not valid on a POST request. It is returned only by a verbose GET request.

This property is not valid for the default tenant.

id

String

Specifies the system-supplied unique ID for the tenant. HCP generates this ID automatically when you create a tenant.

This property is not valid on a POST request. It is returned only by a verbose GET request.

maxNamespacesPer
  User

integer

For an HCP tenant, specifies the maximum number of namespaces that can be owned at one time by any given user.

Valid values are zero through 10,000. The default is 100.

This property is not valid for the default tenant.

name

String

Specifies the name of the tenant. HCP derives the hostname for the tenant from this name. The hostname is used in URLs for access to the tenant and its namespaces.

The name of the default tenant is always Default.

This property is not valid on a POST request. It is returned only by a verbose GET request for an HCP tenant.

This property is not returned by any GET request for the default tenant.

The tenant name is used in the URL for access to the tenant.

namespaceQuota

String

For an HCP tenant, specifies the number of namespaces HCP reserves for the tenant out of the total number of namespaces the system can have. This is also maximum number of namespaces the tenant can own at any given time.

Possible values are:

Integers in the range 1 (one) through the current number of namespaces available for allocation. The number of available namespaces is equal to 10,000 minus the number of namespaces currently allocated to HCP tenants, minus the number of namespaces currently owned by HCP tenants without a quota, minus one for the default namespace, if it exists. If any tenants are above quota, the number of excess namespaces is also subtracted from the number of available namespaces.

None.

This property is not valid on a POST request. It is returned only by a verbose GET request.

This property is not valid for the default tenant.

replicationConfiguration
  Enabled

Boolean

For an HCP tenant, specifies whether the tenant is eligible for replication. Possible values are:

true — The tenant is eligible for replication.

false — The tenant is not eligible for replication.

This property is not valid on a POST request. It is returned only by a verbose GET request.

This property is not valid for the default tenant. If the HCP system supports replication, directories in the default namespace are automatically eligible for replication.

searchConfiguration
  Enabled

Boolean

For an HCP tenant, specifies whether the tenant can enable and disable search for the namespaces it owns. Possible values are:

true — The tenant can enable and disable search for its namespaces.

false — The tenant cannot enable or disable search for its namespaces.

This property is not valid on a POST request. It is returned only by a verbose GET request.

This property is not valid for the default tenant.

snmpLoggingEnabled

Boolean

Specifies whether tenant log messages are sent to the SNMP managers specified at the HCP system level. Valid values are:

true — Tenant log messages are sent to SNMP managers.

false — Tenant log messages are not sent to SNMP managers.

The default is false.

softQuota

Integer

For an HCP tenant, specifies the percentage point at which HCP notifies the tenant that free storage space is running low.

Possible values are integers in the range zero through 100.

This property is not valid on a POST request. It is returned only by a verbose GET request.

This property is not valid for the default tenant.

syslogLoggingEnabled

Boolean

Specifies whether tenant log messages are sent to the syslog servers specified at the HCP system level. Valid values are:

true — Tenant log messages are sent to syslog servers.

false — Tenant log messages are not sent to syslog servers.

The default is false.

tenantVisibleDescription

String

Specifies the tenant-level description of the tenant. This description is optional. The default is no description.

To remove a tenant-level description from an existing tenant, specify the tenantVisibleDescription property with no value.

For the rules for descriptions, see Descriptions.

versioningConfiguration
  Enabled

Boolean

For an HCP tenant, specifies whether the tenant's namespaces can have versioning enabled. Possible values are:

true —The tenant's namespaces can have versioning enabled.

false — The tenant's namespaces cannot have versioning enabled.

This property is not valid on a POST request. It is returned only by a verbose GET request.

This property is not valid for the default tenant.

© 2015, 2020 Hitachi Vantara LLC. All rights reserved.