Reset-VPASEPVUserPassword


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

RESET EPV USER PASSWORD


Description:

USE THIS FUNCTION TO RESET THE PASSWORD OF AN EPV USER


Syntax:

Reset-VPASEPVUserPassword -EPVUsername <String> -NewPassword <String> [-token <Hashtable>] [<CommonParameters>]

Reset-VPASEPVUserPassword -EPVUserID <String> -NewPassword <String> [-token <Hashtable>] [<CommonParameters>]

Reset-VPASEPVUserPassword -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]


Parameters:

-EPVUsername <String>
Query for the target EPVUser via Username

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-EPVUserID <String>
Query for the target EPVUser via UserID

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-NewPassword <String>
New temporary password that will be applied to the target EPVUser

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-InputParameters <Hashtable>
HashTable of values containing the parameters required to make the API call

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-token <Hashtable>
HashTable of data containing various pieces of login information (PVWA, LoginToken, HeaderType, etc).
If -token is not passed, function will use last known hashtable generated by New-VPASToken

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug
ErrorAction, ErrorVariable, WarningAction, WarningVariable
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216)


Examples:

$ResetEPVUserPasswordStatus = Reset-VPASEPVUserPassword -EPVUsername {USERNAME VALUE} -NewPassword {NEWPASSWORD VALUE}

$ResetEPVUserPasswordStatus = Reset-VPASEPVUserPassword -EPVUserID {USERID VALUE} -NewPassword {NEWPASSWORD VALUE}

$InputParameters = @{
        EPVUsername = "targetEPVUsername"
         NewPassword = "SuperSecretPassword"
}
$ResetEPVUserPasswordStatus = Reset-VPASEPVUserPassword -InputParameters $InputParameters

$InputParameters = @{
        EPVUserID = "55"
         NewPassword = "SuperSecretPassword"
}
$ResetEPVUserPasswordStatus = Reset-VPASEPVUserPassword -InputParameters $InputParameters


Outputs:

$true if successful

$false if failed