Automate Samanage Integration Tasks from PowerShell

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Are you in search of a quick and easy way to access Samanage data from PowerShell? This article demonstrates how to utilize the Samanage Cmdlets for tasks like connecting to Samanage data, automating operations, downloading data, and more.

The CData API Driver for ADO.NET is a standard ADO.NET Provider that make it easy to accomplish data cleansing, normalization, backup, and other integration tasks by enabling real-time access to Samanage.

ADO.NET Provider

The ADO.NET Provider provides a SQL interface for Samanage; this tutorial shows how to use the Provider to retrieve Samanage data.

Once you have acquired the necessary connection properties, accessing Samanage data in PowerShell can be enabled in three steps.

Start by setting the Profile connection property to the location of the Samanage Profile on disk (e.g. C:\profiles\Samanage.apip). Next, set the ProfileSettings connection property to the connection string for Samanage (see below).

Samanage API Profile Settings

Navigate to Setup > Users in Samanage, click your username, and select Generate JSON Web Token from the Action dropdown.

  1. Load the provider's assembly:

    [Reflection.Assembly]::LoadFile("C:\Program Files\CData\CData API Driver for ADO.NET\lib\System.Data.CData.API.dll")
        
  2. Connect to Samanage:

     
    $conn= New-Object System.Data.CData.API.APIConnection("Profile=C:\profiles\Samanage.apip;ProfileSettings='APIKey=your_api_key';")
    $conn.Open()
    
  3. Instantiate the APIDataAdapter, execute an SQL query, and output the results:

    $sql="SELECT Id, Messages from Audits"
    
    $da= New-Object System.Data.CData.API.APIDataAdapter($sql, $conn)
    $dt= New-Object System.Data.DataTable
    $da.Fill($dt)
    
    $dt.Rows | foreach {
    	Write-Host $_.id $_.messages
    }
      

Ready to get started?

Connect to live data from Samanage with the API Driver

Connect to Samanage