UpdateAgentConfiguration

Modified on Tue, 12 Mar, 2024 at 3:06 PM

Updates the assignment of the EBA Agent Config for the given device. Can also be used to force the agent/client to fetch its newly assigned configuration when the device is currently online.

For ease of use, you need to import the Console-API-Module.

All documentation can also be seen in the API Module.

This method is available since Console version 4.9.17+.

Parameter:	Description:
uri	string, optional web Service URL e.g.: http://coreservername/five9sWS/five9sWS.asmx
pat	string, mandatory the Personal Access Token
deviceName	string, mandatory the name/displayName of the target device
clientConfigIdn	int, mandatory the ID of the Agent Config to assign to the client
forceAgentCheckin	string array, optional force the agent/client to fetch its newly assigned configuration when its currently online

Get started with the following PowerShell:

Import-Module $PSScriptRoot\Console-API-Module.psm1 -Verbose #you need to execute this line once, so that powershell can offer intelliSense support

# Arrange the parameters
$wsdlUrl = "http://coreserver/five9sWS.asmx?wsdl" # web service URL, you need to replace the 'coreserver' with your actual value
$pat = "879067F0F16_YourPatHere_024214A4"

# Action
$result = Invoke-UpdateAgentConfiguration -uri $wsdlUrl -pat $pat -deviceName "Win10-Test2" -clientConfigIdn 88 -forceAgentCheckin $true
Write-Host "Success: $($result.Success), Message: $($result.Message)" # Output "Success" and "Message"

The result from the request will look like this:

Returns { [bool]$Success, [string]$Message, [int]$ExitCode }