models.tenant module

class models.tenant.Tenant(active_directories=None, bifrost_enabled=None, cluster_hostname=None, cluster_ips=None, created_time_msecs=None, deleted=None, deleted_time_msecs=None, deletion_finished=None, deletion_info_vec=None, description=None, entity_ids=None, last_updated_time_msecs=None, ldap_providers=None, name=None, org_suffix=None, parent_tenant_id=None, policy_ids=None, protection_jobs=None, subscribe_to_alert_emails=None, swift_config=None, tenant_id=None, view_box_ids=None, views=None, vlan_iface_names=None)

Bases: object

Implementation of the ‘Tenant’ model.

Specifies details about a tenant.

Attributes:

active_directories (list of ActiveDirectoryEntry): Specifies the

active directories this tenant is associated to.

bifrost_enabled (bool): Specifies whether bifrost (Ambassador proxy)

is enabled for tenant.

cluster_hostname (string): The hostname for Cohesity cluster as seen by

tenants and as is routable from the tenant’s network. Tenant’s VLAN’s hostname, if available can be used instead but it is mandatory to provide this value if there’s no VLAN hostname to use. Also, when set, this field would take precedence over VLAN hostname.

cluster_ips (list of string): Set of IPs as seen from the tenant’s

network for the Cohesity cluster. Only one from ‘ClusterHostname’ and ‘ClusterIps’ is needed.

created_time_msecs (long|int): Specifies the epoch time in

milliseconds when the tenant account was created on the Cohesity Cluster.

deleted (bool): Specifies if the Tenant is deleted. deleted_time_msecs (long|int): Specifies the timestamp at which the

tenant was deleted.

deletion_finished (bool): Specifies if the object collection is

complete for the tenant.

deletion_info_vec (list of TenantDeletionInfo): Specifies the current

deletion state of object categories.

description (string): Specifies the description of this tenant. entity_ids (list of long|int): Specifies the EntityIds this tenant is

associated to.

last_updated_time_msecs (long|int): Specifies the epoch time in

milliseconds when the tenant account was last modified on the Cohesity Cluster.

ldap_providers (list of LdapProviderResponse): Specifies the ldap

providers this tenant is associated to.

name (string): Specifies the name of the tenant. org_suffix (string): Specifies the organization suffix needed to

construct tenant id. Tenant id is not completely auto generated rather chosen by tenant/SP admin as we needed same tenant id on multiple clusters to support replication across clusters, etc.

parent_tenant_id (string): Specifies the parent tenant of this tenant

if available.

policy_ids (list of string): Specifies the PolicyIds this tenant is

associated to.

protection_jobs (list of BackupJobProto): Specifies the ProtectionJobs

this tenant is associated to.

subscribe_to_alert_emails (bool): Service provider can optionally

unsubscribe from the Tenant Alert Emails.

swift_config (SwiftParams): Specifies the Swift configuration of this

tenant.

tenant_id (string): Specifies the unique id of the tenant. view_box_ids (list of long|int): Specifies the ViewBoxIds this tenant

is associated to.

views (list of View): Specifies the Views this tenant is associated

to.

vlan_iface_names (list of string): Specifies the VlanIfaceNames this

tenant is associated to, in the format of bond1.200.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.

Returns:

object: An instance of this structure class.