Update-VPASEPVGroup


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

UPDATE EPV GROUP


Description:

USE THIS FUNCTION TO UPDATE AN EPV GROUP


Syntax:

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


Parameters:

-GroupLookupBy <String>
Define the method by which the EPV groups will be queried by
Possible values: GroupName, GroupID

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

-GroupLookupVal <String>
Search value that will be used to query for target EPV group

Required: true
Position: 2
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: 3
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: 4
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 -GroupLookupBy GroupName -GroupLookupVal {GROUPNAME VALUE} -NewGroupName {NEWGROUPNAME VALUE}

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


Outputs:

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

$false if failed