LINK AN ACCOUNT

USE THIS FUNCTION TO LINK AN ACCOUNT (RECONCILE/LOGON/JUMP ACCOUNT)

Set-VPASLinkedAccount -AccountType <String> [-safe <String>] [-platform <String>] [-username <String>] [-address <String>] -extraAcctSafe <String> -extraAcctFolder <String> -extraAcctName <String> [-token <Hashtable>] [<CommonParameters>]

Set-VPASLinkedAccount -AccountType <String> -AcctID <String> -extraAcctSafe <String> -extraAcctFolder <String> -extraAcctName <String> [-token <Hashtable>] [<CommonParameters>]

Set-VPASLinkedAccount -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]

-AccountType <String>
Type of account that is being linked
Possible values: LogonAcct, JumpAcct, ReconAcct

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

-safe <String>
Safe name that will be used to query for the target account if no AcctID is passed

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

-platform <String>
PlatformID that will be used to query for the target account if no AcctID is passed

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

-username <String>
Username that will be used to query for the target account if no AcctID is passed

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

-address <String>
Address that will be used to query for the target account if no AcctID is passed

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

-AcctID <String>
Unique ID that maps to a single account, passing this variable will skip any query functions

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

-extraAcctSafe <String>
Safe value of the extra account being linked

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

-extraAcctFolder <String>
Folder value of the extra account being linked

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

-extraAcctName <String>
ObjectName value of the extra account being linked

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)

$LinkAcctActionStatus = Set-VPASLinkedAccount -AccountType {ACCOUNTTYPE VALUE} -extraAcctSafe {EXTRAACCTSAFE VALUE} -extraAcctFolder {EXTRAACCTFOLDER VALUE} -extraAcctName {EXTRAACCTNAME VALUE} -AcctID {ACCTID VALUE}

$InputParameters = @{
        AccountType = "LogonAcct"|"JumpAcct"|"ReconAcct"
        safe = "TargetSafeName"
        platform = "TargetPlatformID"
         username = "TargetUsername"
         address = "TargetAddress"
         extraAcctSafe = "SafeOfLinkedAccount"
         extraAcctFolder = "Root"
         extraAcctName = "NameOfLinkedAccount"
}
$LinkAcctActionStatus = Set-VPASLinkedAccount -InputParameters $InputParameters

$InputParameters = @{
        AccountType = "LogonAcct"|"JumpAcct"|"ReconAcct"
         AcctID = "22_123"
         extraAcctSafe = "SafeOfLinkedAccount"
         extraAcctFolder = "Root"
         extraAcctName = "NameOfLinkedAccount"
}
$LinkAcctActionStatus = Set-VPASLinkedAccount -InputParameters $InputParameters

$true if successful

$false if failed