Update-VPASEPVGroup


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

UPDATE EPV GROUP


Description:

USE THIS FUNCTION TO UPDATE AN EPV GROUP


Syntax:

Update-VPASEPVGroup -GroupName <String> -NewGroupName <String> [-token <Hashtable>] [<CommonParameters>]

Update-VPASEPVGroup -GroupID <String> -NewGroupName <String> [-token <Hashtable>] [<CommonParameters>]

Update-VPASEPVGroup -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]


Parameters:

-GroupName <String>
Target EPV group name that a user will be added to

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

-GroupID <String>
Target EPV group ID that a user will be added to

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

-NewGroupName <String>
New group name that the target EPV group will be updated with

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:

$UpdateEPVGroupJSON = Update-VPASEPVGroup -GroupName {GROUPNAME VALUE} -NewGroupName {NEWGROUPNAME VALUE}

$UpdateEPVGroupJSON = Update-VPASEPVGroup -GroupID {GROUPID VALUE} -NewGroupName {NEWGROUPNAME VALUE}

$InputParameters = @{
        GroupName = "TargetGroupName"
        NewGroupName = "NewGroupName"
}
$UpdateEPVGroupJSON = Update-VPASEPVGroup -InputParameters $InputParameters

$InputParameters = @{
        GroupID = "22"
        NewGroupName = "NewGroupName"
}
$UpdateEPVGroupJSON = Update-VPASEPVGroup -InputParameters $InputParameters


Outputs:

If successful:
{
         "id": 244,
         "groupType": "Vault",
         "members": [
                
         ],
         "groupName": "UpdatedGroupName",
         "description": "New group for documentation",
         "location": "\\"
}

$false if failed