remotecluster

Documentation

Overview

Copyright 2019 Cohesity Inc.

Copyright 2019 Cohesity Inc.

Index

• type REMOTECLUSTER
• type REMOTECLUSTER_IMPL
  • func NewREMOTECLUSTER(config configuration.CONFIGURATION) *REMOTECLUSTER_IMPL
  • func (me *REMOTECLUSTER_IMPL) CreateRemoteCluster(body *models.RegisterRemoteCluster) (*models.RemoteCluster, error)
  • func (me *REMOTECLUSTER_IMPL) DeleteRemoteCluster(id int64) error
  • func (me *REMOTECLUSTER_IMPL) GetRemoteClusterById(id int64) ([]*models.RemoteCluster, error)
  • func (me *REMOTECLUSTER_IMPL) GetRemoteClusters(clusterIds []int64, clusterNames []string, purposeReplication *bool, ...) ([]*models.RemoteCluster, error)
  • func (me *REMOTECLUSTER_IMPL) GetReplicationEncryptionKey() (*models.ReplicationEncryptionKeyReponse, error)
  • func (me *REMOTECLUSTER_IMPL) UpdateRemoteCluster(id int64, body *models.RegisterRemoteCluster) (*models.RemoteCluster, error)

Types

type REMOTECLUSTER

type REMOTECLUSTER interface {
	GetRemoteClusters([]int64, []string, *bool, *bool) ([]*models.RemoteCluster, error)

	CreateRemoteCluster(*models.RegisterRemoteCluster) (*models.RemoteCluster, error)

	DeleteRemoteCluster(int64) error

	GetRemoteClusterById(int64) ([]*models.RemoteCluster, error)

	UpdateRemoteCluster(int64, *models.RegisterRemoteCluster) (*models.RemoteCluster, error)

	GetReplicationEncryptionKey() (*models.ReplicationEncryptionKeyReponse, error)
}

* Interface for the REMOTECLUSTER_IMPL

type REMOTECLUSTER_IMPL

type REMOTECLUSTER_IMPL struct {
	// contains filtered or unexported fields
}

* Client structure as interface implementation

func NewREMOTECLUSTER

func NewREMOTECLUSTER(config configuration.CONFIGURATION) *REMOTECLUSTER_IMPL

* Factory for the REMOTECLUSTER interaface returning REMOTECLUSTER_IMPL

func (*REMOTECLUSTER_IMPL) CreateRemoteCluster

func (me *REMOTECLUSTER_IMPL) CreateRemoteCluster(
	body *models.RegisterRemoteCluster) (*models.RemoteCluster, error)

*

• For a Protection Job to replicate Snapshots from one Cluster
• to another Cluster, the Clusters must be paired together by
• registering each Cluster on the other Cluster.
• For example, Cluster A must be registered on Cluster B
• and Cluster B must be registered on Cluster A.
• @param *models.RegisterRemoteCluster body parameter: Required
• @return Returns the *models.RemoteCluster response from the API call

func (*REMOTECLUSTER_IMPL) DeleteRemoteCluster

func (me *REMOTECLUSTER_IMPL) DeleteRemoteCluster(
	id int64) error

*

• Delete the specified remote Cluster registration connection
• on this Cluster.
• @param int64 id parameter: Required
• @return Returns the response from the API call

func (*REMOTECLUSTER_IMPL) GetRemoteClusterById

func (me *REMOTECLUSTER_IMPL) GetRemoteClusterById(
	id int64) ([]*models.RemoteCluster, error)

*

• Returns the details about the remote Cluster with the specified Cluster id
• that is registered on this local Cluster.
• @param int64 id parameter: Required
• @return Returns the []*models.RemoteCluster response from the API call

func (*REMOTECLUSTER_IMPL) GetRemoteClusters

func (me *REMOTECLUSTER_IMPL) GetRemoteClusters(
	clusterIds []int64,
	clusterNames []string,
	purposeReplication *bool,
	purposeRemoteAccess *bool) ([]*models.RemoteCluster, error)

*

• Cohesity Clusters involved in replication, must be registered to each other.
• For example, if Cluster A is replicating Snapshots to Cluster B, Cluster
• B must be registered on Cluster A and Cluster B must be registered
• on Cluster A.
• @param []int64 clusterIds parameter: Optional
• @param []string clusterNames parameter: Optional
• @param *bool purposeReplication parameter: Optional
• @param *bool purposeRemoteAccess parameter: Optional
• @return Returns the []*models.RemoteCluster response from the API call

func (*REMOTECLUSTER_IMPL) GetReplicationEncryptionKey

func (me *REMOTECLUSTER_IMPL) GetReplicationEncryptionKey() (*models.ReplicationEncryptionKeyReponse, error)

*

• Get the encryption key that is used for encrypting replication data
• between this Cluster and a remote Cluster.
• @return Returns the *models.ReplicationEncryptionKeyReponse response from the API call

func (*REMOTECLUSTER_IMPL) UpdateRemoteCluster

func (me *REMOTECLUSTER_IMPL) UpdateRemoteCluster(
	id int64,
	body *models.RegisterRemoteCluster) (*models.RemoteCluster, error)

*

• Update the connection settings of the specified remote Cluster that is
• registered on this Cluster.
• @param int64 id parameter: Required
• @param *models.RegisterRemoteCluster body parameter: Required
• @return Returns the *models.RemoteCluster response from the API call