GetCentralSearchDevices

Modified on Fri, 17 Nov 2023 at 04:12 PM

Allows you to search for individual or multiple devices in CentralSearch/multi-core databases and confirm their existence. Additionally, this method provides information regarding the core servers on which the devices were located.

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

All documentation can also be seen in the API Module.

Included since version 4.8.13

Parameter:	Description:
uri	string, optional web Service URL e.g.: http://coreservername/five9sWS/five9sWS.asmx
pat	string, mandatory the Personal Access Token
deviceNames	string arrray, mandatory a list of devices to search

The search request will be initiated promptly using the CentralSearch data that has been recently synchronized, but it's important to note that the data may not be the most current.

Get started with the following PowerShell:

Import-Module $PSScriptRoot\Console-API-Module.psm1 -Verbose -Force #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"
$deviceNames = @("DeviceName1", "DeviceName2")

# Action
Invoke-GetCentralSearchDevices -uri $wsdlUrl -pat $pat -deviceNames $deviceNames

The result from the request will look like this:

DisplayName DeviceExists FoundOnCores
----------- ------------ ------------
DeviceName1         True {59epm1}    
DeviceName2         True {59epm1}