Invoke-PASVRMFailover

Invoke-PASVRMFailover

SYNOPSIS

Initiates DR failover to the DR site

SYNTAX

Invoke-PASVRMFailover [[-BaseURI] <String>] [-DRAddress] <String> [[-serviceUserName] <String>]
 [-servicePassword] <SecureString> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Initiates a disaster recovery failover operation to switch operations to the DR site. This is a critical operation that should only be performed during an actual disaster recovery scenario or planned failover test. Requires authentication with the PARAgent service credentials and supports WhatIf for testing.

EXAMPLES

Example 1

$password = ConvertTo-SecureString -String 'P@ssw0rd' -AsPlainText -Force
Invoke-PASVRMFailover -DRAddress dr-vault.company.com -servicePassword $password -Confirm:$false

Initiates a failover to the DR Vault at the specified address

Example 2

$password = ConvertTo-SecureString -String 'P@ssw0rd' -AsPlainText -Force
Invoke-PASVRMFailover -DRAddress dr-vault.company.com -servicePassword $password -WhatIf

Shows what would happen if a failover to the DR Vault was initiated, without actually performing the failover

Example 3

$password = ConvertTo-SecureString -String 'P@ssw0rd' -AsPlainText -Force
[PSCustomObject]@{DRAddress = 'dr-vault.company.com'; servicePassword = $password} | Invoke-PASVRMFailover -Confirm:$false

Initiates a failover using pipeline input for the DR address and credentials

PARAMETERS

-BaseURI

The URL of the PVWA server. If not specified, uses the BaseURI from New-PASSession

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-DRAddress

The IP address or hostname of the DR Vault server

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-serviceUserName

The PARAgent user name. Defaults to Administrator

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: Administrator
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-servicePassword

The PARAgent password as a SecureString

Type: SecureString
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

https://pspas.pspete.dev/commands/Invoke-PASVRMFailover

https://docs.cyberark.com/pam-self-hosted/latest/en/content/sdk/server-api-vrm-initiate-dr-failover.htm