Create a new Physical Edition Cohesity Cluster.

post

https://cluster.ip.address/irisservices/api/v1/public/clusters/physicalEdition

Privileges: CLUSTER_CREATE

Sends a request to create a new Physical Edition Cohesity Cluster and returns
the IDs, name, and software version of the new cluster. Also returns the
status of each node.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Specifies the parameters needed for creation of a new Cluster.

allowApiBasedFetch

boolean | null

Specifies if API based GET should be enabled for cluster destroy
params.

clusterDestroyHmacKey

string | null

Specifies HMAC secret key that will be used to validate OTP used
for destroy request. This is b32 format of the HMAC key.
This should only be set/modified during cluster creation.

clusterName

string | null

required

Specifies the name of the new Cluster.

clusterSwType

string | null

enum

Specifies cluster software type for a unified node.
'kOneHelios' indicates that the specified services will be stopped.
'kNetBackup' indicates that the specified services will be started.
'kRegular' indicates that the specified services will be restarted.

Allowed:

enableClusterDestroy

boolean | null

Specifies if cluster destroy op is enabled on this cluster.
This should only be set/modified during cluster creation.

encryptionConfig

object | null

Specifies the encryption configuration parameters.

ipPreference

int32 | null

Specifies IP preference.

ipmiConfig

object | null

required

Specifies the IPMI configuration parameters.

metadataFaultTolerance

int32 | null

Specifies the metadata fault tolerance.

netbackConfig

object | null

Specifies the NetBackup configuration parameters.

networkConfig

object | null

required

Specifies the network configuration parameters.

nodeConfigs

array of objects | null

required

Specifies the configuration for the nodes in the new cluster.

nodeConfigs*

trustDomain

string | null

Specifies Trust Domain used for Service Identity.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Success

defaultError