models.cluster_status_result module

class models.cluster_status_result.ClusterStatusResult(cluster_id=None, cluster_incarnation_id=None, current_operation=None, message=None, name=None, node_statuses=None, removal_state=None, services_synced=None, software_version=None, stopped_services=None, system_app_status=None)[source]

Bases: object

Implementation of the ‘ClusterStatusResult’ model.

Specifies the result of getting the status of a Cluster.

Attributes:

cluster_id (long|int): Specifies the ID of the Cluster. cluster_incarnation_id (long|int): Specifies the incarnation ID of the

Cluster.

current_operation (CurrentOperationClusterStatusResultEnum): Specifies

the current operation being run on the Cluster. ‘kNone’ indicates that there is no current operation taking place. ‘kDestroy’ indicates that the Cluster is currently being destroyed. ‘kUpgrade’ indicates that the Cluster is currently being upgraded. ‘kClean’ indicates that the Cluster is being cleaned. ‘kRemoveNode’ indicates that a Node is being removed from the Cluster. ‘kRestartServices’ indicates that the services on the Cluster are currently being restarted.

message (string): Specifies an optional message describing details of

the Cluster status.

name (string): Specifies the name of the Cluster. node_statuses (list of NodeStatusResult): Specifies the status of each

Node on the Cluster.

removal_state (RemovalStateEnum): Specifies the current healing state

of the Cluster. ‘kNoRemoval’ indicates that there are no removal operations currently happening on the Cluster. ‘kNodeRemoval’ indicates that there is a Node being removed from the Cluster. ‘kDiskRemoval’ indicates that there is a Disk being removed from the Cluster. ‘kNodeAndDiskRemoval’ indicates that there is a Node and a Disk being removed from the Cluster.

services_synced (bool): Specifies whether or not the services are

synced with the list of stopped services.

software_version (string): Specifies the software version of the

Cluster.

stopped_services (list of StoppedServiceEnum): Specifies the list of

stopped services on the Cluster. ‘kApollo’ is a service for reclaiming freed disk sectors on Nodes in the SnapFS distributed file system. ‘kBridge’ is a service for managing the SnapFS distributed file system. ‘kGenie’ is a service that is responsible for monitoring hardware health on the Cluster. ‘kGenieGofer’ is a service that links the Genie service to other services on the Cluster. ‘kMagneto’ is the data protection service of the Cohesity Data Platform. ‘kIris’ is the service which serves REST API calls to the UI, CLI, and any scripts written by customers. ‘kIrisProxy’ is a service that links the Iris service to other services on the Cluster. ‘kScribe’ is the service responsible for storing filesystem metadata. ‘kStats’ is the service that is responsible for retrieving and aggregating disk metrics across the Cluster. ‘kYoda’ is an elastic search indexing service. ‘kAlerts’ is a publisher and subscribing service for alerts. ‘kKeychain’ is a service for managing disk encryption keys. ‘kLogWatcher’ is a service that scans the log directory and reduces the number of logs if required. ‘kStatsCollector’ is a service that periodically logs system stats. ‘kGandalf’ is a distributed lock service and coordination manager. ‘kNexus’ indicates the Nexus service. This is the service that is responsible for creation of Clusters and configuration of Nodes and networking. ‘kNexusProxy’ is a service that links the Nexus service to other services on the Cluster. ‘kStorageProxy’ is a service for accessing data on external entities. ‘kTricorder’ is a diagnostic health testing service for Clusters. ‘kRtClient’ is a reverse tunneling client service. ‘kVaultProxy’ is a service for managing external targets that Clusters can be backed up to. ‘kSmbProxy’ is an SMB protocol service. ‘kBridgeProxy’ is the service that links the Bridge service to other services on the Cluster. ‘kLibrarian’ is an elastic search indexing service. ‘kGroot’ is a service for managing replication of SQL databases across multiple nodes in a Cluster. ‘kEagleAgent’ is a service that is responsible for retrieving information on Cluster health. ‘kAthena’ is a service for running distributed containerized applications on the Cohesity Data Platform. ‘kBifrostBroker’ is a service for communicating with the Cohesity proxies for multitenancy. ‘kSmb2Proxy’ is a new SMB protocol service. ‘kOs’ can be specified in order to do a full reboot. ‘kAtom’ is a service for receiving data for the Continuous Data Protection. ‘kPatch’ is a service for downloading and applying patches. ‘kCompass’ is a service for serving dns request for external and internal traffic.

system_app_status (list of SystemAppStatusResult): Specifies the status

of each system app on the Cluster

classmethod from_dictionary(dictionary)[source]

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.