models.cluster module

class models.cluster.Cluster(apps_subnet=None, assigned_racks_count=None, available_metadata_space=None, banner_enabled=None, chassis_count=None, cluster_audit_log_config=None, cluster_software_version=None, cluster_type=None, created_time_msecs=None, current_op_scheduled_time_secs=None, current_operation=None, current_time_msecs=None, dns_server_ips=None, domain_names=None, enable_active_monitoring=None, enable_upgrade_pkg_polling=None, encryption_enabled=None, encryption_key_rotation_period_secs=None, eula_config=None, fault_tolerance_level=None, filer_audit_log_config=None, fips_mode_enabled=None, gateway=None, google_analytics_enabled=None, hardware_info=None, id=None, incarnation_id=None, ip_preference=None, is_documentation_local=None, language_locale=None, license_state=None, local_auth_domain_name=None, local_groups_enabled=None, metadata_fault_tolerance_factor=None, minimum_failure_domains_needed=None, multi_tenancy_enabled=None, name=None, node_count=None, node_ips=None, ntp_settings=None, pcie_ssd_tier_rebalance_delay_secs=None, proxy_vm_subnet=None, reverse_tunnel_enabled=None, reverse_tunnel_end_time_msecs=None, schema_info_list=None, smb_ad_disabled=None, smb_multichannel_enabled=None, stats=None, stig_mode=None, supported_config=None, syslog_servers=None, target_software_version=None, tenant_viewbox_sharing_enabled=None, timezone=None, turbo_mode=None, used_metadata_space_pct=None)

Bases: object

Implementation of the ‘Cluster’ model.

Specifies information about the Cohesity Cluster.

Attributes:

apps_subnet (Subnet): The subnet for Athena apps. assigned_racks_count (int): Specifies the number of racks in cluster

with at least one rack assigned.

available_metadata_space (long|int): Information about storage

available for metadata

banner_enabled (bool): Specifies whether UI banner is enabled on the

cluster or not. When banner is enabled, UI will make an additional API call to fetch the banner and show at the login page.

chassis_count (int): Specifies the number of chassis in cluster. cluster_audit_log_config (ClusterAuditLogConfiguration): Specifies the

settings of the Cluster audit log configuration.

cluster_software_version (string): Specifies the current release of

the Cohesity software running on this Cohesity Cluster.

cluster_type (ClusterTypeClusterEnum): Specifies the type of Cluster

such as kPhysical. ‘kPhysical’ indicates the Cohesity Cluster is hosted directly on hardware. ‘kVirtualRobo’ indicates the Cohesity Cluster is hosted in a VM on a ESXi Host of a VMware vCenter Server using Cohesity’s Virtual Edition. ‘kMicrosoftCloud’ indicates the Cohesity Cluster is hosed in a VM on Microsoft Azure using Cohesity’s Cloud Edition. ‘kAmazonCloud’ indicates the Cohesity Cluster is hosed in a VM on Amazon S3 using Cohesity’s Cloud Edition. ‘kGoogleCloud’ indicates the Cohesity Cluster is hosed in a VM on Google Cloud Platform using Cohesity’s Cloud Edition.

created_time_msecs (long|int): Specifies the time when the Cohesity

Cluster was created. This value is specified as a Unix epoch Timestamp (in microseconds).

current_op_scheduled_time_secs (long|int): Specifies the time

scheduled by the Cohesity Cluster to start the current running operation.

current_operation (CurrentOperationEnum): Specifies the current

Cluster-level operation in progress. ‘kUpgrade’ indicates the Cohesity Cluster is upgrading to a new release. ‘kRemoveNode’ indicates the Cohesity Cluster is removing a Node from the Cluster. ‘kNone’ indicates no action is occurring on the Cohesity Cluster. ‘kDestroy’ indicates the Cohesity Cluster is getting destoryed. ‘kClean’ indicates the Cohesity Cluster is getting cleaned. ‘kRestartServices’ indicates the Cohesity Cluster is restarting the services.

current_time_msecs (long|int): Specifies the current system time on

the Cohesity Cluster. This value is specified as a Unix epoch Timestamp (in microseconds).

dns_server_ips (list of string): Array of IP Addresses of DNS Servers.

Specifies the IP addresses of the DNS Servers used by the Cohesity Cluster.

domain_names (list of string): Array of Domain Names. The first

domain name specified in the array is the fully qualified domain name assigned to the Cohesity Cluster. Any additional domain names specified are used for the domain search list for hostname look-up.

enable_active_monitoring (bool): Specifies if Cohesity can receive

monitoring information from the Cohesity Cluster. If ‘true’, remote monitoring of the Cohesity Cluster is allowed.

enable_upgrade_pkg_polling (bool): If ‘true’, Cohesity’s upgrade

server is polled for new releases.

encryption_enabled (bool): If ‘true’, the entire Cohesity Cluster is

encrypted including all View Boxes.

encryption_key_rotation_period_secs (long|int): Specifies the period

of time (in seconds) when encryption keys are rotated. By default, the encryption keys are rotated every 77760000 seconds (30 days).

eula_config (EulaConfig): Specifies the End User License Agreement

(EULA) acceptance information.

fault_tolerance_level (FaultToleranceLevelEnum): Specifies the level

which ‘MetadataFaultToleranceFactor’ applies to. ‘kNode’ indicates ‘MetadataFaultToleranceFactor’ applies to Node level. ‘kChassis’ indicates ‘MetadataFaultToleranceFactor’ applies to Chassis level. ‘kRack’ indicates ‘MetadataFaultToleranceFactor’ applies to Rack level.

filer_audit_log_config (FilerAuditLogConfiguration): Specifies the

settings of the filer audit log configuration.

fips_mode_enabled (bool): Specifies if the Cohesity Cluster should

operate in the FIPS mode, which is compliant with the Federal Information Processing Standard 140-2 certification.

gateway (string): Specifies the gateway IP address. google_analytics_enabled (bool): Specifies whether Google Analytics is

enabled.

hardware_info (ClusterHardwareInfo): Specifies a hardware type for

motherboard of the Nodes that make up this Cohesity Cluster such as S2600WB for Ivy Bridge or S2600TP for Haswell.

id (long|int): Specifies the unique id of Cohesity Cluster. incarnation_id (long|int): Specifies the unique incarnation id of the

Cohesity Cluster.

ip_preference (int): IP preference is_documentation_local (bool): Specifies what version of the

documentation is used. If ‘true’, the version of documentation stored locally on the Cohesity Cluster is used. If ‘false’, the documentation stored on a Cohesity Web Server is used. The default is ‘false’. Cohesity recommends accessing the Help from the Cohesity Web site which provides the newest and most complete version of Help.

language_locale (string): Specifies the language and locale for this

Cohesity Cluster.

license_state (LicenseState): Specifies the Licensing State

information.

local_auth_domain_name (string): Domain name for SMB local

authentication.

local_groups_enabled (bool): Specifies whether to enable local groups

on cluster. Once it is enabled, it cannot be disabled.

metadata_fault_tolerance_factor (int): Specifies metadata fault

tolerance setting for the cluster. This denotes the number of simultaneous failures[node] supported by metadata services like gandalf and scribe.

minimum_failure_domains_needed (int): Specifies minimum failure domains

needed in the cluster.

multi_tenancy_enabled (bool): Specifies if multi tenancy is enabled in

the cluster. Authentication & Authorization will always use tenant_id, however, some UI elements may be disabled when multi tenancy is disabled.

name (string): Specifies the name of the Cohesity Cluster. node_count (long|int): Specifies the number of Nodes in the Cohesity

Cluster.

node_ips (string): IP addresses of nodes in the cluster ntp_settings (NtpSettingsConfig): TODO: type description here. pcie_ssd_tier_rebalance_delay_secs (int): Specifies the rebalance

delay in seconds for cluster PcieSSD storage tier.

proxy_vm_subnet (string): The subnet reserved for ProxyVM reverse_tunnel_enabled (bool): If ‘true’, Cohesity’s Remote Tunnel is

enabled. Cohesity can access the Cluster and provide remote assistance via a Remote Tunnel.

reverse_tunnel_end_time_msecs (long|int): ReverseTunnelEndTimeMsecs

specifies the end time in milliseconds since epoch until when the reverse tunnel will stay enabled.

schema_info_list (list of SchemaInfo): Specifies the time series

schema info of the cluster.

smb_ad_disabled (bool): Specifies if Active Directory should be

disabled for authentication of SMB shares. If ‘true’, Active Directory is disabled.

smb_multichannel_enabled (bool): Specifies whether SMB multichannel is

enabled on the cluster. When this is set to true, then any SMB3 multichannel enabled client can establish multiple TCP connection per session to the Server.

stats (ClusterStats): Specifies statistics about this Cohesity

Cluster.

stig_mode (bool): Specifies if STIG mode is enabled or not. supported_config (SupportedConfig): Lists the supported Erasure Coding

options for the number of Nodes in the Cohesity Cluster. In addition, the minimum number of Nodes supported for this Cluster type is defined.

syslog_servers (list of OldSyslogServer): Syslog servers. target_software_version (string): Specifies the Cohesity release that

this Cluster is being upgraded to if an upgrade operation is in progress.

tenant_viewbox_sharing_enabled (bool): In case multi tenancy is

enabled, this flag controls whether multiple tenants can be placed on the same viewbox. Once set to true, this flag should never become false.

timezone (string): Specifies the timezone to use for showing time in

emails, reports, filer audit logs, etc.

turbo_mode (bool): Specifies if the cluster is in Turbo mode. used_metadata_space_pct (float): UsedMetadataSpacePct measures the

percentage about storage used for metadata over the total storage available for metadata

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.