Share via

az site-recovery network mapping

  • Reference

Note

This reference is part of the site-recovery extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az site-recovery network mapping command. Learn more about extensions.

Manage Network Mapping.

Commands

Name Description Type Status
az site-recovery network mapping create

Create operation to create an ASR network mapping.

 Extension GA
az site-recovery network mapping delete

Delete operation to delete a network mapping.

 Extension GA
az site-recovery network mapping list

List all ASR network mappings for the specified network.

 Extension GA
az site-recovery network mapping show

Get the details of an ASR network mapping.

 Extension GA
az site-recovery network mapping update

Update operation to create an ASR network mapping.

 Extension GA

az site-recovery network mapping create

Create operation to create an ASR network mapping.

az site-recovery network mapping create --fabric-name
                                        --name
                                        --network-name
                                        --recovery-network-id
                                        --resource-group
                                        --vault-name
                                        [--fabric-details]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--recovery-fabric-name]

Examples

network mapping create for A2A fabric

az site-recovery network mapping create -g rg --fabric-name fabric1_name -n network_mapping1_name --network-name azureNetwork --vault-name vault_name --recovery-network-id vnet2_id --fabric-details '{azure-to-azure:{primary-network-id:vnetvm_id}}' --recovery-fabric-name fabric2_name

network mapping create for H2A E2A (VMM)

az site-recovery network mapping create -g "rg" --fabric-name "fabric_name" -n "network_mapping_name" --network-name "vnet_source_name" --vault-name "vault_name" --recovery-network-id "vnet_recovery_id" --fabric-details '{vmm-to-azure:""}'

Required Parameters

--fabric-name

Primary fabric name.

--name --network-mapping-name -n

Network mapping name.

--network-name

Primary network name.

--recovery-network-id

Recovery network Id.

--resource-group -g

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

--vault-name

The name of the recovery services vault.

Optional Parameters

--fabric-details --fabric-specific-details

Fabric specific input properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--recovery-fabric-name

Recovery fabric 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 site-recovery network mapping delete

Delete operation to delete a network mapping.

az site-recovery network mapping delete [--fabric-name]
                                        [--ids]
                                        [--name]
                                        [--network-name]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--resource-group]
                                        [--subscription]
                                        [--vault-name]
                                        [--yes]

Examples

network mapping delete

az site-recovery network mapping delete -g rg --fabric-name fabric_source_name -n network_mapping_src_to_recovery_name --network-name azureNetwork --vault-name vault_name'

Optional Parameters

--fabric-name

Primary fabric name.

--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 --network-mapping-name -n

ARM Resource Name for network mapping.

--network-name

Primary network name.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

--vault-name

The name of the recovery services vault.

--yes -y

Do not prompt for confirmation.

default value: False
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 site-recovery network mapping list

List all ASR network mappings for the specified network.

az site-recovery network mapping list --fabric-name
                                      --network-name
                                      --resource-group
                                      --vault-name
                                      [--max-items]
                                      [--next-token]

Examples

network mapping list

az site-recovery network mapping list -g rg --fabric-name fabric_source_name --network-name azureNetwork --vault-name vault_name

Required Parameters

--fabric-name

Primary fabric name.

--network-name

Primary network name.

--resource-group -g

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

--vault-name

The name of the recovery services vault.

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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 site-recovery network mapping show

Get the details of an ASR network mapping.

az site-recovery network mapping show [--fabric-name]
                                      [--ids]
                                      [--name]
                                      [--network-name]
                                      [--resource-group]
                                      [--subscription]
                                      [--vault-name]

Examples

network mapping show

az site-recovery network mapping show -g rg --fabric-name fabric_source_name -n network_mapping_src_to_recovery_name --network-name azureNetwork --vault-name vault_name

Optional Parameters

--fabric-name

Primary fabric name.

--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 --network-mapping-name -n

Network mapping name.

--network-name

Primary network name.

--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.

--vault-name

The name of the recovery services vault.

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 site-recovery network mapping update

Update operation to create an ASR network mapping.

az site-recovery network mapping update [--add]
                                        [--fabric-details]
                                        [--fabric-name]
                                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--ids]
                                        [--name]
                                        [--network-name]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--recovery-fabric-name]
                                        [--recovery-network-id]
                                        [--remove]
                                        [--resource-group]
                                        [--set]
                                        [--subscription]
                                        [--vault-name]

Examples

network mapping update

az site-recovery network mapping update -g rg --fabric-name fabric_recovery_name -n network_mapping_src_to_recovery_name --network-name azureNetwork --vault-name vault_name --recovery-network-id vnetvm_id --fabric-details '{azure-to-azure:{primary-network-id:vnet_recovery_id}}' --recovery-fabric-name fabric_source_name

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--fabric-details --fabric-specific-details

Fabric specific input properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--fabric-name

Primary fabric name.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

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 --network-mapping-name -n

Network mapping name.

--network-name

Primary network name.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--recovery-fabric-name

Recovery fabric Name.

--recovery-network-id

Recovery network Id.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--subscription

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

--vault-name

The name of the recovery services vault.

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.