Change the state of one or more services on a Cohesity Cluster.

Privileges: CLUSTER_MODIFY

Sends a request to either stop, start, or restart one or more of the services
on a Cohesity Cluster and returns a message describing the result.

WARNING: This is a destructive operation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Specifies the parameters needed to change the state of one or more
services running on the Cluster.

string | null
enum

Specifies the action to take on the specified service.
'kStop' indicates that the specified services will be stopped.
'kStart' indicates that the specified services will be started.
'kRestart' indicates that the specified services will be restarted.

Allowed:
services
array of strings | null

Specifies the list of services to take the specified action on.
If none are specified, all Cluster services will be affected. It should
also be noted that some Cluster services are not stoppable and may
not be affected by the action specified.
'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.
'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.
'kEtlServer' is a service responsible for ETling data for globalsearch.
'kIcebox' is service that links Icebox service to other services on cluster.
kScribe, kStats, kYoda, kAlerts, kKeychain, kLogWatcher, kStatsCollecter,
kGandalf, kNexus, kNexusProxy, kStorageProxy, kRtClient, kVaultProxy,
kSmbProxy, kBridgeProxy, kLibrarian, kGroot, kEagleAgent, kAthena,
kBifrostBroker, kSmb2Proxy, kOs, kAtom, kIcebox

services
Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json