HCP System Management Help


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 on a PUT request. It is valid on a POST request and returned by a GET request only when the request is made using a tenant-level user account.

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. Valid 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.

These values are not case sensitive.

If you omit this property on a PUT request, the default is LOCAL and RADIUS.

You can specify any combination of these values except RADIUS alone.

This property is optional on a PUT request. It is valid on a POST request only when the request is made using a system-level user account.

This property is returned by any GET request when the request is made using a system-level user account. It is returned only by a verbose GET request when the request is made using a tenant-level user account.

For an existing tenant, the list of authentication types specified in the request body replaces the list of authentication types currently supported by the tenant. A tenant must always have at least one authentication type enabled.

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.

Valid values are:

true — The tenant can set the retention mode.

false — The tenant cannot set the retention mode.

This property is required on a PUT request. It is valid on a POST request only when the request is made using a system-level user account.

This property is returned by any GET request when the request is made using a system-level user account. It is returned only by a verbose GET request when the request is made using a tenant-level user account.

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.

You can change the value of this property from false to true but not from true to false.

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:

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

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

dataNetwork

String

Specifies the data access network for the tenant. Valid values are any network defined in the HCP system except [hcp_backend]. The default is [hcp_system].

This property is optional on a PUT request. It is valid on a POST request only when the request is made using a system-level user account.

This property is returned by any GET request when the request is made using a system-level user account. It is not returned by any GET request when the request is made using a tenant-level user account.

This property is not valid for the default tenant.

fullyQualifiedName

String

Specifies the fully qualified hostname of the tenant.

This property is not valid on a PUT or 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.

Valid 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 required on a PUT request. It is valid on a POST request only when the request is made using a system-level user account.

This property is returned by any GET request when the request is made using a system-level user account. It is returned only by a verbose GET request when the request is made using a tenant-level user account.

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 PUT or POST request. It is returned only by a verbose GET request.

managementNetwork

String

Specifies the management network for the tenant. Valid values are any network defined in the HCP system except [hcp_backend]. The default is [hcp_system].

This property is optional on a PUT request. It is valid on a POST request only when the request is made using a system-level user account.

This property is returned by any GET request when the request is made using a system-level user account. It is not returned by any GET request when the request is made using a tenant-level user account.

This property is not valid for the default tenant.

maxNamespacesPerUser

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 on a PUT request. It is valid on a POST request and returned by a GET request only when the request is made using a tenant-level user account.

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.

In English, the name you specify for a tenant must be from one through 63 characters long, can contain only alphanumeric characters and hyphens (-), and cannot start or end with a hyphen. In other languages, because the derived English hostname cannot be more than 63 characters long, the name that you specify can be limited to fewer than 63 characters.

Tenant names cannot contain special characters other than hyphens and are not case sensitive. White space is not allowed.

Tenant names cannot start with xn-- (that is, the characters x and n followed by two hyphens).

Tenant names must be unique for the HCP system. Different systems can have tenants with the same name. However, a tenant cannot be replicated to another system that already has a tenant with the same name.

You can reuse tenant names that are not currently in use. So, for example, if you delete a tenant, you can give a new tenant the same name as the one the deleted tenant had.

The name of the default tenant is always Default.

This property is required on a PUT request. It is valid on a POST request for an HCP tenant only when the request is made using a system-level user account.

This property is returned by any GET request for an HCP tenant when the request is made using a system-level user account. It is returned only by a verbose GET request when the request is made using a tenant-level user account.

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.

You can change the name of an HCP tenant any time after you create the tenant, except while the CIFS or NFS protocol is enabled for any namespaces owned by the tenant. However, when you change the name, the URL for the tenant may change as well.

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.

Valid 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.

The default is None.

This property is optional on a PUT request.

This property is returned by any GET request when the request is made using a system-level user account. It is returned only by a verbose GET request when the request is made using a tenant-level user account.

This property is not valid for the default tenant.

replicationConfiguration
Enabled

Boolean

For an HCP tenant, specifies whether the tenant is eligible for replication.

Valid values are:

true — The tenant is eligible for replication.

false — The tenant is not eligible for replication.

The property is required on a PUT request if the HCP system supports replication. If the HCP system does not support replication, this property is optional and, if included, must have a value of false.

This property is valid on a POST request only when the request is made using a system-level user account.

This property is returned by any GET request when the request is made using a system-level user account. It is returned only by a verbose GET request when the request is made using a tenant-level user account.

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.

You can change the value of this property from false to true but not from true to false.

searchConfiguration
Enabled

Boolean

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

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

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

The default is false.

This property is optional on a PUT request. It is valid on a POST request only when the request is made using a system-level user account.

This property is returned by any GET request when the request is made using a system-level user account. It is returned only by a verbose GET request when the request is made using a tenant-level user account.

This property is not valid for the default tenant.

You can change the value of this property from false to true but not from true to false.

servicePlan

String

For an HCP tenant, specifies the service plan associated with the tenant.

Valid values are names of existing service plans. The default is Default.

This property is valid on a PUT or POST request only when the value of the servicePlanSelectionEnabled property is false.

This property is valid on a POST request only when the request is made using a system-level user account.

This property is returned by a GET request only when the request is made using a system-level user account and only when the value of the servicePlanSelection-Enabled property is false.

This property is not valid for the default tenant. To specify a service plan for the default tenant, use the servicePlan query parameter when creating the tenant. For information on this parameter, see Default tenant query parameters.

servicePlanSelection
Enabled

Boolean

For an HCP tenant, specifies whether the tenant can select service plans for the namespaces it owns. Valid values are:

true — The tenant can select service plans for its namespaces.

false — The tenant cannot select service plans for its namespaces.

The default is false.

This property is optional on a PUT request. It is valid on a POST request only when the request is made using a system-level user account.

This property is returned by any GET request when the request is made using a system-level user account. It is returned only by a verbose GET request when the request is made using a tenant-level user account.

This property is not valid for the default tenant.

You can change the value of this property from false to true but not from true to false.

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.

This property is not valid on a PUT request.

For HCP tenants, this property is valid on a POST request and returned by a GET request only when the request is made using a tenant-level user account.

softQuota

Integer

For an HCP tenant, specifies the percentage point at which HCP notifies the tenant that free storage space is running low. Valid values are integers in the range zero through 100.

This property is required on a PUT request. It is valid on a POST request only when the request is made using a system-level user account.

This property is returned by any GET request when the request is made using a system-level user account. It is returned only by a verbose GET request when the request is made using a tenant-level user account.

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.

This property is not valid on a PUT request.

For HCP tenants, this property is valid on a POST request and returned by a GET request only when the request is made using a tenant-level user account.

systemVisibleDescription

String

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

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

For the rules for descriptions, see Common property values.

This property is optional on a PUT request. It is valid on a POST request only when the request is made using a system-level user account.

This property is returned by any GET request when the request is made using a system-level user account. It is not returned by any GET request when the request is made using a tenant-level user account.

tags

List

Associates zero, one, or more tags with the tenant. Each tag can be from one through 64 characters long and can contain any valid UTF-8 characters except commas (,). White space is allowed.

Tags are not case sensitive.

This property is optional on a PUT request. It is valid on a POST request only when the request is made using a system-level user account.

This property is returned by any GET request when the request is made using a system-level user account. It is not returned by any GET request when the request is made using a tenant-level user account.

For an existing tenant, the set of tags specified in the request body replaces the set of tags currently associated with the namespace. To remove all tags, specify an empty set.

In XML, each listed tag is the value of an element named tag. In JSON, the name in the name/value pair that lists the tags is tag.

This property is not valid for the default namespace.

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 Common property values.

To retrieve or set the value of this property, you need a tenant-level user account.

versioningConfiguration
Enabled

Boolean

For an HCP tenant, specifies whether the namespaces owned by the tenant can have versioning enabled. Valid values are:

true — Namespaces owned by the tenant can have versioning enabled.

false — Namespaces owned by the tenant cannot have versioning enabled.

This property is required on a PUT request. It is valid on a POST request only when the request is made using a system-level user account.

This property is returned by any GET request when the request is made using a system-level user account. It is returned only by a verbose GET request when the request is made using a tenant-level user account.

This property is not valid for the default tenant.

You can change the value of this property from false to true but not from true to false.

© 2017 Hitachi Vantara Corporation. All rights reserved.