Files
ZertoApiWrapper/docs/Set-ZertoUserCredential.md
2020-04-07 10:30:42 -04:00

2.6 KiB

external help file, Module Name, online version, schema
external help file Module Name online version schema
ZertoApiWrapper-help.xml ZertoApiWrapper https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Set-ZertoUserCredential.md 2.0.0

Set-ZertoUserCredential

SYNOPSIS

Allows the change or update of the credentials used to allow the Zerto Virtual Manager to connect and communicate with the paired Hypervisor.

SYNTAX

Set-ZertoUserCredential [-UserCredential] <PSCredential> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Allows the change or update of the credentials used to allow the Zerto Virtual Manager to connect and communicate with the paired Hypervisor. A PSCredential object is required and will be used to pass the updated credentials.

EXAMPLES

Example 1

PS C:\> Set-ZertoUserCredential -UserCredential $UserCredential

Will update the user account used to connect the Zerto Virtual Manager to the the paired Hypervisor.

Example 2

PS C:\> Set-ZertoUserCredential -UserCredential $UserCredential -Confirm:$False

Will update the user account used to connect the Zerto Virtual Manager to the the paired Hypervisor. CAUTION: By adding the -Confirm:$False parameter, this will suppress the confirmation dialog and you will not be prompted if you wish to complete this action.

PARAMETERS

-UserCredential

PSCredential Object that contains the username and password for the updated credentials.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
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

-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

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 (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

PSCredential Object Information