Start-AzRecoveryServicesAsrSwitchAppliance
Starts the switch appliance action for a Site Recovery object.
Syntax
Default (Default)
Start-AzRecoveryServicesAsrSwitchAppliance
-Fabric <ASRFabric>
-ReplicationProtectedItem <ASRReplicationProtectedItem>
-TargetApplianceName <String>
[-CredentialsToAccessVm <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Start-AzRecoveryServicesAsrSwitchAppliance cmdlet starts the switch appliance process for an Azure Site Recovery object.
Examples
Example 1
$currentJob = Start-AzRecoveryServicesAsrSwitchAppliance -Fabric $Fabric `
-ReplicationProtectedItem $RPI -TargetApplianceName $TargetApplianceName
Starts the switch appliance for the specified replicated protected item and returns the ASR job used to track the operation.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Aliases: cf
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-CredentialsToAccessVm
Specifies the name of credentials to be used to push install the Mobility service on source machine if needed.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None
Supports wildcards: False
DontShow: False
Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-Fabric
Specifies the ASR Fabric object.
Parameter properties
Type: ASRFabric
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-ReplicationProtectedItem
Specifies an ASR replication protected item object to be switched to new appliance.
Parameter properties
Parameter sets
(All)
Position: Named
Mandatory: True
Value from pipeline: True
Value from pipeline by property name: False
Value from remaining arguments: False
-TargetApplianceName
Specifies the name of appliance to be used to replicate this machine.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Aliases: wi
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
None
Outputs