Share via

az netappfiles volume replication

  • Reference

Manage Azure NetApp Files (ANF) Volume replication.

Commands

Name Description Type Status
az netappfiles volume replication approve

Authorize source volume replication.

 Core GA
az netappfiles volume replication authorize-external-replication

Starts SVM peering and returns a command to be run on the external ONTAP to accept it. Once the SVM have been peered a SnapMirror will be created.

 Core GA
az netappfiles volume replication finalize-external-replication

Finalizes the migration of an external volume by releasing the replication and breaking the external cluster peering if no other migration is active.

 Core GA
az netappfiles volume replication list

List all replications for a specified volume.

 Core GA
az netappfiles volume replication peer-external-cluster

Starts peering the external cluster for this migration volume.

 Core GA
az netappfiles volume replication perform-replication-transfer

Performs an adhoc replication transfer on a volume with volumeType Migration.

 Core GA
az netappfiles volume replication populate-availability-zone

This operation will populate availability zone information for a volume.

 Core GA
az netappfiles volume replication re-initialize

Re-Initializes the replication connection on the destination volume.

 Core GA
az netappfiles volume replication reestablish

Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots.

 Core GA
az netappfiles volume replication remove

Delete the replication connection on the destination volume, and send release to the source replication.

 Core GA
az netappfiles volume replication resume

Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source.

 Core GA
az netappfiles volume replication status

Get the status of the replication.

 Core GA
az netappfiles volume replication suspend

Suspend/Break the replication connection on the destination volume.

 Core GA

az netappfiles volume replication approve

Edit

Authorize source volume replication.

Authorize the replication connection on the source volume.

az netappfiles volume replication approve [--account-name]
                                          [--ids]
                                          [--name]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--pool-name]
                                          [--remote-volume-resource-id]
                                          [--resource-group]
                                          [--subscription]

Examples

Authorize the volume as the replication destination for the source

az netappfiles volume replication approve -g mygroup --account-name myaccname --pool-name mypoolname --name mysourcevolname --remote-volume-resource-id /subscriptions/69a75bda-882e-44d5-8431-63421204131c/resourceGroups/mygroup1/providers/Microsoft.NetApp/netAppAccounts/myaccount1/capacityPools/mypool1/volumes/mydestinationvolume

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --volume-name -n -v

The name of the volume.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--pool-name -p

The name of the capacity pool.

--remote-volume-resource-id -d

Resource id of the remote volume.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume replication authorize-external-replication

Edit

Starts SVM peering and returns a command to be run on the external ONTAP to accept it. Once the SVM have been peered a SnapMirror will be created.

az netappfiles volume replication authorize-external-replication [--account-name]
                                                                 [--ids]
                                                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                                 [--pool-name]
                                                                 [--resource-group]
                                                                 [--subscription]
                                                                 [--volume-name]

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--volume-name -n -v

The name of the volume.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume replication finalize-external-replication

Edit

Finalizes the migration of an external volume by releasing the replication and breaking the external cluster peering if no other migration is active.

az netappfiles volume replication finalize-external-replication [--account-name]
                                                                [--ids]
                                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                                [--pool-name]
                                                                [--resource-group]
                                                                [--subscription]
                                                                [--volume-name]

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--volume-name -n -v

The name of the volume.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume replication list

Edit

List all replications for a specified volume.

az netappfiles volume replication list --account-name
                                       --name
                                       --pool-name
                                       --resource-group

Examples

List all replications for a specified volume

az netappfiles volume replication list -g mygroup --account-name myaccname --pool-name mypoolname --name mydestinationvolname

Required Parameters

--account-name -a

The name of the NetApp account.

--name --volume-name -n -v

The name of the volume.

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume replication peer-external-cluster

Edit

Starts peering the external cluster for this migration volume.

az netappfiles volume replication peer-external-cluster --peer-ip-addresses
                                                        [--account-name]
                                                        [--ids]
                                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--pool-name]
                                                        [--resource-group]
                                                        [--subscription]
                                                        [--volume-name]

Required Parameters

--peer-ip-addresses

A list of IC-LIF IPs that can be used to connect to the On-prem cluster Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--volume-name -n -v

The name of the volume.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume replication perform-replication-transfer

Edit

Performs an adhoc replication transfer on a volume with volumeType Migration.

az netappfiles volume replication perform-replication-transfer [--account-name]
                                                               [--ids]
                                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                               [--pool-name]
                                                               [--resource-group]
                                                               [--subscription]
                                                               [--volume-name]

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--volume-name -n -v

The name of the volume.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume replication populate-availability-zone

Edit

This operation will populate availability zone information for a volume.

az netappfiles volume replication populate-availability-zone [--account-name]
                                                             [--ids]
                                                             [--name]
                                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                             [--pool-name]
                                                             [--resource-group]
                                                             [--subscription]

Examples

This operation will populate availability zone information for volume myvolname

az netappfiles volume populate-availability-zone -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --volume-name -n -v

The name of the volume.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume replication re-initialize

Edit

Re-Initializes the replication connection on the destination volume.

Re-initialise a volume replication for the specified destination volume. The replication process is resumed from source to destination.

az netappfiles volume replication re-initialize [--account-name]
                                                [--ids]
                                                [--name]
                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--pool-name]
                                                [--resource-group]
                                                [--subscription]

Examples

Re-initialises the replication process

az netappfiles volume replication re-initialize -g mygroup --account-name myaccname --pool-name mypoolname --name mydestinationvolname

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --volume-name -n -v

The name of the volume.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume replication reestablish

Edit

Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots.

az netappfiles volume replication reestablish [--account-name]
                                              [--ids]
                                              [--name]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--pool-name]
                                              [--resource-group]
                                              [--source-volume-id]
                                              [--subscription]

Examples

Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots

az netappfiles volume replication reestablish -g mygroup --account-name myaccname --pool-name mypoolname --name mydestinationvolname --source-volume-id mysourcevolumeid

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --volume-name -n -v

The name of the volume.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--source-volume-id

Resource id of the source volume for the replication.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume replication remove

Edit

Delete the replication connection on the destination volume, and send release to the source replication.

az netappfiles volume replication remove [--account-name]
                                         [--ids]
                                         [--name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--pool-name]
                                         [--resource-group]
                                         [--subscription]

Examples

Delete the replication objects of the paired volumes

az netappfiles volume replication remove -g mygroup --account-name myaccname --pool-name mypoolname --name mydestinationvolname

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --volume-name -n -v

The name of the volume.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume replication resume

Edit

Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source.

Resync a volume replication for the specified destination volume. The replication process is resumed from source to destination. If any quota rules exists on destination volume they will be overwritten with source volume's quota rules.

az netappfiles volume replication resume [--account-name]
                                         [--ids]
                                         [--name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--pool-name]
                                         [--resource-group]
                                         [--subscription]

Examples

Resume the replication process

az netappfiles volume replication resume -g mygroup --account-name myaccname --pool-name mypoolname --name mydestinationvolname

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --volume-name -n -v

The name of the volume.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume replication status

Edit

Get the status of the replication.

Get the replication status for the specified replication volume.

az netappfiles volume replication status [--account-name]
                                         [--ids]
                                         [--name]
                                         [--pool-name]
                                         [--resource-group]
                                         [--subscription]

Examples

Get the replication status for the volume. Returns whether the replication is healthy, the replication schedule and the mirror state (whether replication is suspened/broken or synced/mirrored)

az netappfiles volume replication status -g mygroup --account-name myaccname --pool-name mypoolname --name mydestinationvolname

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --volume-name -n -v

The name of the volume.

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume replication suspend

Edit

Suspend/Break the replication connection on the destination volume.

Suspend/break a volume replication for the specified destination volume. The replication process is suspended until resumed or deleted.

az netappfiles volume replication suspend [--account-name]
                                          [--force {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--ids]
                                          [--name]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--pool-name]
                                          [--resource-group]
                                          [--subscription]

Examples

Suspend the replication process

az netappfiles volume replication suspend -g mygroup --account-name myaccname --pool-name mypoolname --name mydestinationvolname

Optional Parameters

--account-name -a

The name of the NetApp account.

--force --force-break-replication -f

If replication is in status transferring and you want to force break the replication, set to true.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --volume-name -n -v

The name of the volume.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.