grid:cloudapi:tenant : Grid Cloud API Tenant object.

A Tenant object represents an abstract administrative concept in Cloud Management Platforms, which encompasses all network elements such as networks, zones, VMs, IP addresses (fixed and floating), network views, default DNS view, and all related extensive attributes.

Object Reference

References to grid:cloudapi:tenant are object references. The name part of a Grid Cloud API Tenant object reference has the following components:

• ID of the Grid Cloud API Tenant
• Name of the Grid Cloud API Tenant

Example: grid:cloudapi:tenant/ZGldHdvcmtfdmlldyQxMTk:tenant1

Restrictions

The object does not support the following operations:

• Create (insert)
• Delete
• Global search (searches via the search object)
• Scheduling
• CSV export

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): comment, id, name.

cloud_info

cloud_info

Structure containing all cloud API related information for this object.

Type

A/An Cloud Information struct.

Search

The field is not available for search.

Notes

The cloud_info cannot be updated.

cloud_info cannot be written.

comment

comment

Comment for the Grid Cloud API Tenant object; maximum 256 characters.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is undefined.

Search

The field is available for search via

• ‘:=’ (case insensitive search)
• ‘=’ (exact equality)
• ‘~=’ (regular expression)

Notes

The comment is part of the base object.

created_ts

created_ts

The timestamp when the tenant was first created in the system.

Type

Timestamp.

Search

The field is not available for search.

Notes

The created_ts cannot be updated.

created_ts cannot be written.

id

id

Unique ID associated with the tenant. This is set only when the tenant is first created.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is available for search via

• ‘=’ (exact equality)

Notes

The id is part of the base object.

The id cannot be updated.

id cannot be written.

last_event_ts

last_event_ts

The timestamp when the last event associated with the tenant happened.

Type

Timestamp.

Search

The field is not available for search.

Notes

The last_event_ts cannot be updated.

last_event_ts cannot be written.

name

name

Name of the tenant.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The default value is undefined.

Search

The field is available for search via

• ‘:=’ (case insensitive search)
• ‘=’ (exact equality)
• ‘~=’ (regular expression)

Notes

The name is part of the base object.

network_count

network_count

Number of Networks associated with the tenant.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The network_count cannot be updated.

network_count cannot be written.

vm_count

vm_count

Number of VMs associated with the tenant.

Type

Unsigned integer.

Search

The field is not available for search.

Notes

The vm_count cannot be updated.

vm_count cannot be written.

Fields List

Field	Type	Req	R/O	Base	Search
cloud_info	struct	N	Y	N	N/A
comment	String	N	N	Y	: = ~
created_ts	Timestamp	N	Y	N	N/A
id	String	N	Y	Y	=
last_event_ts	Timestamp	N	Y	N	N/A
name	String	N	N	Y	: = ~
network_count	Unsigned int	N	Y	N	N/A
vm_count	Unsigned int	N	Y	N	N/A