PowerShell Support

Use web services and PowerShell to programmatically execute many of the processes within XIA Configuration including search, viewing information, making changes and exporting data to PDF or XML.

Example - Basic Search

This example demonstrates how to perform a basic search in XIA Configuration using PowerShell.

Connect to the web service

# Connect to the configuration web service.
$url = "http://localhost/xiaconfiguration/webservice/xiaconfiguration.asmx";
Write-Host "Connecting to configuration web service at" $url;
$xia = New-WebServiceProxy -UseDefaultCredential -Uri $url;
Write-Host "Connected as" $xia.GET_AuthenticatedUserName();

Perform a basic search

$searchResults = $xia.DO_PerformBasicSearch("DEMO-DHCP*")
foreach ($searchResult in $searchResults.SearchResult)
{
Write-Host $searchResult.Name "-" $searchResult.ItemID;
}

Output

The search results which match the specified criteria are returned:

Screenshot of XIA Configuration search results in PowerShell — Execute a search in XIA Configuration using PowerShell

Please view the administrator's guide for more information on performing a basic search.

Example - Generate a PDF

This example demonstrates how to generate a PDF in XIA Configuration using PowerShell.

Connect to the web service

# Connect to the configuration web service.
$url = "http://localhost/xiaconfiguration/webservice/xiaconfiguration.asmx";
Write-Host "Connecting to configuration web service at" $url;
$xia = New-WebServiceProxy -UseDefaultCredential -Uri $url;
Write-Host "Connected as" $xia.GET_AuthenticatedUserName();

Generate a PDF

# Generate the PDF as a byte array.
$data = $xia.GET_PDFOutputBasic(1000);

# Write the PDF to a file.
Write-Host "Saving PDF file...";
$filename = "c:\temp\sample.pdf";
[IO.File]::WriteAllBytes($filename,$data);

# Display the file.
[System.Diagnostics.Process]::Start($filename);

Output

The PDF is generated for the specified item:

Please view the administrator's guide for more information on documentation output.

Try XIA Configuration for free

No commitments. No costs. Try XIA Configuration today.

Download Free 30-Day Trial

Back to all features