Start-AzRecoveryServicesAsrSwitchAppliance

  • Reference
Module:
Az.RecoveryServices

Starts the switch appliance action for a Site Recovery object.

Syntax

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.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CredentialsToAccessVm

Specifies the name of credentials to be used to push install the Mobility service on source machine if needed.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Fabric

Specifies the ASR Fabric object.

Type:ASRFabric
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ReplicationProtectedItem

Specifies an ASR replication protected item object to be switched to new appliance.

Type:ASRReplicationProtectedItem
Aliases:ReplicatedItem
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-TargetApplianceName

Specifies the name of appliance to be used to replicate this machine.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

ASRJob