replications

Creates, updates, deletes, gets or lists a replications resource.

Overview

Name	replications
Type	Resource
Id	google.netapp.replications

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the Replication. Format: projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.
clusterLocation	string	Optional. Location of the user cluster.
createTime	string (google-datetime)	Output only. Replication create time.
description	string	A description about this replication relationship.
destinationVolume	string	Output only. Full name of destination volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
destinationVolumeParameters	object	Required. Input only. Destination volume parameters (id: DestinationVolumeParameters)
healthy	boolean	Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.
hybridPeeringDetails	object	Output only. Hybrid peering details. (id: HybridPeeringDetails)
hybridReplicationType	string	Output only. Type of the hybrid replication.
hybridReplicationUserCommands	object	Output only. Copy pastable snapmirror commands to be executed on onprem cluster by the customer. (id: UserCommands)
labels	object	Resource labels to represent user provided metadata.
mirrorState	string	Output only. Indicates the state of mirroring.
replicationSchedule	string	Required. Indicates the schedule for replication.
role	string	Output only. Indicates whether this points to source or destination.
sourceVolume	string	Output only. Full name of source volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
state	string	Output only. State of the replication.
stateDetails	string	Output only. State details of the replication.
transferStats	object	Output only. Replication transfer statistics. (id: TransferStats)

list

Successful response

Name	Datatype	Description
name	string	Identifier. The resource name of the Replication. Format: projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}.
clusterLocation	string	Optional. Location of the user cluster.
createTime	string (google-datetime)	Output only. Replication create time.
description	string	A description about this replication relationship.
destinationVolume	string	Output only. Full name of destination volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
destinationVolumeParameters	object	Required. Input only. Destination volume parameters (id: DestinationVolumeParameters)
healthy	boolean	Output only. Condition of the relationship. Can be one of the following: - true: The replication relationship is healthy. It has not missed the most recent scheduled transfer. - false: The replication relationship is not healthy. It has missed the most recent scheduled transfer.
hybridPeeringDetails	object	Output only. Hybrid peering details. (id: HybridPeeringDetails)
hybridReplicationType	string	Output only. Type of the hybrid replication.
hybridReplicationUserCommands	object	Output only. Copy pastable snapmirror commands to be executed on onprem cluster by the customer. (id: UserCommands)
labels	object	Resource labels to represent user provided metadata.
mirrorState	string	Output only. Indicates the state of mirroring.
replicationSchedule	string	Required. Indicates the schedule for replication.
role	string	Output only. Indicates whether this points to source or destination.
sourceVolume	string	Output only. Full name of source volume resource. Example : "projects/{project}/locations/{location}/volumes/{volume_id}"
state	string	Output only. State of the replication.
stateDetails	string	Output only. State details of the replication.
transferStats	object	Output only. Replication transfer statistics. (id: TransferStats)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, volumesId, replicationsId		Describe a replication for a volume.
list	select	projectsId, locationsId, volumesId	pageSize, pageToken, orderBy, filter	Returns descriptions of all replications for a volume.
create	insert	projectsId, locationsId, volumesId	replicationId	Create a new replication for a volume.
patch	update	projectsId, locationsId, volumesId, replicationsId	updateMask	Updates the settings of a specific replication.
delete	delete	projectsId, locationsId, volumesId, replicationsId		Deletes a replication.
stop	exec	projectsId, locationsId, volumesId, replicationsId		Stop Cross Region Replication.
resume	exec	projectsId, locationsId, volumesId, replicationsId		Resume Cross Region Replication.
reverse_direction	exec	projectsId, locationsId, volumesId, replicationsId		Reverses direction of replication. Source becomes destination and destination becomes source.
establish_peering	exec	projectsId, locationsId, volumesId, replicationsId		Establish replication peering.
sync	exec	projectsId, locationsId, volumesId, replicationsId		Syncs the replication. This will invoke one time volume data transfer from source to destination.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
replicationsId	string
volumesId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
replicationId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Describe a replication for a volume.

SELECT
name,
clusterLocation,
createTime,
description,
destinationVolume,
destinationVolumeParameters,
healthy,
hybridPeeringDetails,
hybridReplicationType,
hybridReplicationUserCommands,
labels,
mirrorState,
replicationSchedule,
role,
sourceVolume,
state,
stateDetails,
transferStats
FROM google.netapp.replications
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND volumesId = '{{ volumesId }}' -- required
AND replicationsId = '{{ replicationsId }}' -- required;

list

Returns descriptions of all replications for a volume.

SELECT
name,
clusterLocation,
createTime,
description,
destinationVolume,
destinationVolumeParameters,
healthy,
hybridPeeringDetails,
hybridReplicationType,
hybridReplicationUserCommands,
labels,
mirrorState,
replicationSchedule,
role,
sourceVolume,
state,
stateDetails,
transferStats
FROM google.netapp.replications
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND volumesId = '{{ volumesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}';

INSERT examples

create

Create a new replication for a volume.

INSERT INTO google.netapp.replications (
data__name,
data__replicationSchedule,
data__labels,
data__description,
data__destinationVolumeParameters,
data__clusterLocation,
projectsId,
locationsId,
volumesId,
replicationId
)
SELECT 
'{{ name }}',
'{{ replicationSchedule }}',
'{{ labels }}',
'{{ description }}',
'{{ destinationVolumeParameters }}',
'{{ clusterLocation }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ volumesId }}',
'{{ replicationId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: replications
  props:
    - name: projectsId
      value: string
      description: Required parameter for the replications resource.
    - name: locationsId
      value: string
      description: Required parameter for the replications resource.
    - name: volumesId
      value: string
      description: Required parameter for the replications resource.
    - name: name
      value: string
      description: >
        Identifier. The resource name of the Replication. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/replications/{replication_id}`.
        
    - name: replicationSchedule
      value: string
      description: >
        Required. Indicates the schedule for replication.
        
      valid_values: ['REPLICATION_SCHEDULE_UNSPECIFIED', 'EVERY_10_MINUTES', 'HOURLY', 'DAILY']
    - name: labels
      value: object
      description: >
        Resource labels to represent user provided metadata.
        
    - name: description
      value: string
      description: >
        A description about this replication relationship.
        
    - name: destinationVolumeParameters
      value: object
      description: >
        Required. Input only. Destination volume parameters
        
    - name: clusterLocation
      value: string
      description: >
        Optional. Location of the user cluster.
        
    - name: replicationId
      value: string

UPDATE examples

patch

Updates the settings of a specific replication.

UPDATE google.netapp.replications
SET 
data__name = '{{ name }}',
data__replicationSchedule = '{{ replicationSchedule }}',
data__labels = '{{ labels }}',
data__description = '{{ description }}',
data__destinationVolumeParameters = '{{ destinationVolumeParameters }}',
data__clusterLocation = '{{ clusterLocation }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND volumesId = '{{ volumesId }}' --required
AND replicationsId = '{{ replicationsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a replication.

DELETE FROM google.netapp.replications
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND volumesId = '{{ volumesId }}' --required
AND replicationsId = '{{ replicationsId }}' --required;

Lifecycle Methods

stop

Stop Cross Region Replication.

EXEC google.netapp.replications.stop 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@volumesId='{{ volumesId }}' --required, 
@replicationsId='{{ replicationsId }}' --required 
@@json=
'{
"force": {{ force }}
}';

resume

Resume Cross Region Replication.

EXEC google.netapp.replications.resume 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@volumesId='{{ volumesId }}' --required, 
@replicationsId='{{ replicationsId }}' --required;

reverse_direction

Reverses direction of replication. Source becomes destination and destination becomes source.

EXEC google.netapp.replications.reverse_direction 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@volumesId='{{ volumesId }}' --required, 
@replicationsId='{{ replicationsId }}' --required;

establish_peering

Establish replication peering.

EXEC google.netapp.replications.establish_peering 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@volumesId='{{ volumesId }}' --required, 
@replicationsId='{{ replicationsId }}' --required 
@@json=
'{
"peerClusterName": "{{ peerClusterName }}", 
"peerSvmName": "{{ peerSvmName }}", 
"peerIpAddresses": "{{ peerIpAddresses }}", 
"peerVolumeName": "{{ peerVolumeName }}"
}';

sync

Syncs the replication. This will invoke one time volume data transfer from source to destination.

EXEC google.netapp.replications.sync 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@volumesId='{{ volumesId }}' --required, 
@replicationsId='{{ replicationsId }}' --required;