### Install Orion SDK with Chocolatey

Source: https://github.com/solarwinds/orionsdk/blob/master/README.md

Installs the Orion SDK tools using the Chocolatey package manager. This is a convenient way to get started if you have Chocolatey installed.

```bash
choco install orionsdk
```

--------------------------------

### Installing the PowerOrion Module

Source: https://github.com/solarwinds/orionsdk/wiki/PowerOrion---A-Module-for-PowerShell

Provides instructions for installing the PowerOrion module using the `Install-Module` cmdlet in PowerShell. This is the recommended method for users with access to the PowerShell Gallery.

```PowerShell
Install-Module PowerOrion
```

--------------------------------

### SWIS REST Query Request Example

Source: https://github.com/solarwinds/orionsdk/wiki/REST

Demonstrates a GET request to the SWIS REST API for querying data. It specifies the endpoint, query parameters, and authentication headers.

```text
GET https://localhost:17774/SolarWinds/InformationService/v3/Json/Query?query=SELECT+Uri+FROM+Orion.Pollers+ORDER+BY+PollerID+WITH+ROWS+1+TO+3+WITH+TOTALROWS HTTP/1.1
Authorization: Basic YWRtaW46
User-Agent: curl/7.20.0 (i386-pc-win32) libcurl/7.20.0 OpenSSL/0.9.8l zlib/1.2.3
Host: localhost:17774
Accept: */*
```

--------------------------------

### Installing and Importing SwisPowerShell Module

Source: https://github.com/solarwinds/orionsdk/wiki/SwisPowerShell-A-Module-for-PowerShell

Provides instructions on how to install the SwisPowerShell module using PowerShell Gallery and then load it into the current session for use. It also shows how to list all available commands within the module.

```PowerShell
Install-Module SwisPowerShell
```

```PowerShell
Import-Module SwisPowerShell
```

```PowerShell
Get-Command -Module SwisPowerShell
```

```PowerShell
Get-Help About_Modules
```

--------------------------------

### PowerShell Examples for IPAM Operations

Source: https://github.com/solarwinds/orionsdk/wiki/IPAM-4.6-API

Provides practical PowerShell examples for interacting with the SolarWinds Orion SDK to manage IPAM data. Includes samples for creating, updating, and deleting subnets and IP nodes.

```PowerShell
# Delete IPAM Subnet
Remove-SwisObject $swis -Uri 'swis://localhost/Orion/IPAM.Subnet/SubnetId=106,ParentId=101'

# Update IPAM Subnet
Set-SwisObject $swis -Uri 'swis://localhost/Orion/IPAM.Subnet/SubnetId=100,ParentId=2' -Properties @{VLAN='test';CIDR=22}

# Create IPAM Subnet
New-SwisObject $swis -EntityType 'IPAM.Subnet' -Properties @{Address='10.199.252.1'; CIDR=24;}

# Delete IPAM IPNode
Remove-SwisObject $swis -Uri 'swis://localhost/Orion/IPAM.IPNode/IpNodeId=2'

# Update IPAM IPNode
Set-SwisObject $swis -Uri 'swis://localhost/Orion/IPAM.IPNode/IpNodeId=2' -Properties @{ Alias = 'test1' }

# Create IPAM IPNode
New-SwisObject $swis -EntityType 'IPAM.IPNode' -Properties @{ SubnetId=22; IPAddress='10.20.30.40' }

# Create IPAM IPNode Attribute
New-SwisObject $swis -EntityType 'IPAM.IPNodeAttr' -Properties @{ IPNodeId = 1; }

# Update IPAM IPNode Attribute
Set-SwisObject $swis -Uri 'swis://localhost/Orion/IPAM.IPNode/IpNodeId=1/Custom' -Properties @{ Custom_1 = 'test1' }

# Delete IPAM IPNode Attribute
Remove-SwisObject $swis -Uri 'swis://localhost/Orion/IPAM.IPNode/IpNodeId=1/Custom'
```

--------------------------------

### PowerShell Example: Create Custom Property

Source: https://github.com/solarwinds/orionsdk/wiki/Managing-Custom-Properties

Demonstrates how to connect to the Orion server and invoke the `CreateCustomProperty` verb using PowerShell.

```PowerShell
$swis = Connect-Swis -Hostname localhost -Username admin -Password ""
Invoke-SwisVerb $swis Orion.NodesCustomProperties CreateCustomProperty @("Test1", "this is my description", "string", 4000, $null, $null, $null, $null, $null, $null)
```

--------------------------------

### IPAM API Documentation

Source: https://github.com/solarwinds/orionsdk/wiki/IPAM-4.6-API

This section details the IPAM API methods for managing DNS PTR records, IP addresses, and subnets within SolarWinds Orion. It covers adding and removing PTR records, retrieving the first available IP in a subnet, changing the status of an IP node, managing IP address reservations (start, finish, cancel), and creating new subnets. Each method includes its signature, parameter descriptions, return values, and usage examples.

```APIDOC
IPAM.IPAddressManagement:
  AddPtrRecord(recordName: string, recordData: string, dnsIpAddress: string, dnsZoneName: string)
    Adds a PTR record to a DNS zone without creating an A record.
    Parameters:
      recordName: The name of the DNS record.
      recordData: The data for the DNS record (e.g., IP address).
      dnsIpAddress: The IP address of the DNS server.
      dnsZoneName: The name of the DNS zone.
    Returns: A message indicating the status of the operation.

  RemovePtrRecord(recordName: string, dnsIpAddress: string, dnsZoneName: string, isRetryingDnsZoneSearch: bool = false)
    Removes a PTR record from a DNS zone.
    Parameters:
      recordName: The name of the DNS record to remove.
      dnsIpAddress: The IP address of the DNS server.
      dnsZoneName: The name of the DNS zone.
      isRetryingDnsZoneSearch: If true, searches other DNS zones if the record is not found in the specified zone.
    Returns: A message indicating the status of the operation.

IPAM.SubnetManagement:
  GetFirstAvailableIp(subnetAddress: string, subnetCidr: string)
    Retrieves the first available IP address within a specified subnet.
    Parameters:
      subnetAddress: The IP address representing the subnet (e.g., "199.10.1.0").
      subnetCidr: The CIDR notation for the subnet (e.g., "24").
    Returns: The first available IP address from the subnet.
    Note: Does not change the status of the returned IP node.

  ChangeIpStatus(ipAddress: string, status: string)
    Changes the status of a specific IP node.
    Parameters:
      ipAddress: The IP address of the node to update (e.g., "199.10.1.1").
      status: The new status for the IP node. Possible values: "Used", "Available", "Reserved", "Transient", "Blocked".

  StartIpReservation(subnetAddress: string, subnetCidr: string, reservationTimeInMinutes: int = 10)
    Initiates a reservation for an IP address within a subnet.
    Parameters:
      subnetAddress: The IP address representing the subnet.
      subnetCidr: The CIDR notation for the subnet.
      reservationTimeInMinutes: The duration of the reservation in minutes (defaults to 10).
    Returns: The reserved IP address.
    Note: When the reservation time expires, the IP node's status is set to 'Available'.

  FinishIpReservation(ipAddress: string, finalIpStatus: string)
    Completes an IP address reservation with a specified final status.
    Parameters:
      ipAddress: The IP address that was reserved.
      finalIpStatus: The final status for the IP address. Possible values: "Used", "Available", "Reserved", "Transient", "Blocked".

  CancelIpReservation(reservedIpAddress: string)
    Cancels an ongoing IP address reservation.
    Parameters:
      reservedIpAddress: The IP address that is currently reserved.

  CreateSubnet(subnetAddress: string, rawCidr: string)
    Creates a new subnet within the IPAM group tree, placed under the root folder.
    Parameters:
      subnetAddress: The IP address for the new subnet.
      rawCidr: The CIDR notation for the new subnet.
    Possible Errors: Overlapping with existing subnets.
```

--------------------------------

### Create WMI Credentials (PowerShell Example)

Source: https://github.com/solarwinds/orionsdk/wiki/Credential-Management

Example of how to create WMI (UserPassword) credentials using the Orion SDK with PowerShell. This snippet demonstrates invoking the `CreateUsernamePasswordCredentials` verb with a specified name, username, and password.

```powershell
# create WHMI credentials guest/guest with name=custom
# credentialId can be used in discovery plugin configuration
$credentialId = Invoke-SwisVerb $swis Orion.Credential CreateUsernamePasswordCredentials @( "custom",  "guest", "guest" )
```

--------------------------------

### Install SwisPowerShell Module

Source: https://github.com/solarwinds/orionsdk/wiki/PowerShell

Installs the SwisPowerShell module from the PowerShell Gallery. Requires administrator privileges.

```PowerShell
Install-Module -Name SwisPowerShell
```

--------------------------------

### Create SNMP Credentials (PowerShell Example)

Source: https://github.com/solarwinds/orionsdk/wiki/Credential-Management

Example of how to create SNMP credentials using the Orion SDK with PowerShell. This snippet demonstrates invoking the `CreateSNMPCredentials` verb with a specified name and community string.

```powershell
# create SNMP credentials with name=custom, community=RO_permanent
# credentialId can be used in discovery plugin configuration
$credentialId = Invoke-SwisVerb $swis Orion.Credential CreateSNMPCredentials @( "custom",  "RO_permanent" )
```

--------------------------------

### SWIS Uri Format and Examples

Source: https://github.com/solarwinds/orionsdk/wiki/Uris

Details the structure of a SWIS Uri, including the system identifier, endpoint, entity type, and key filter. Provides examples of common Uri patterns.

```APIDOC
URI Format:
swis://<system-identifier>/<endpoint>/<entity type>/<key filter>[/<nav property>[/<key filter>][…]]

System Identifier:
The FQDN of the server where the Orion database was initially created. This identifier is permanently associated with the database and does not change even if the server is renamed.

Examples:
swis://abcdef/Orion/Orion.Nodes/NodeID=1
swis://abcdef/Orion/Orion.Nodes/NodeID=1/Interfaces/InterfaceID=2
swis://abcdef/Orion/Orion.Nodes/NodeID=1/CustomProperties
```

--------------------------------

### PowerShell Example: Create Custom Property with Values

Source: https://github.com/solarwinds/orionsdk/wiki/Managing-Custom-Properties

Shows how to create a custom property with a predefined list of values using PowerShell and the `CreateCustomPropertyWithValues` verb.

```PowerShell
$swis = Connect-Swis -Hostname localhost -Username admin -Password ""
$values = New-Object string[] 3
$values[0] = "value1"
$values[1] = "value2"
$values[2] = "value3"
Invoke-SwisVerb $swis Orion.NodesCustomProperties CreateCustomPropertyWithValues @("Test2", "this one has a value list", "string", 4000, $null, $null, $null, $null, $null, $null, $values)
```

--------------------------------

### IP Address Reservation (PowerShell)

Source: https://github.com/solarwinds/orionsdk/wiki/IPAM-4.6-API

PowerShell samples demonstrating the IP address reservation workflow: starting, finishing, and canceling a reservation using Invoke-SwisVerb.

```powershell
Invoke-SwisVerb $swis IPAM.SubnetManagement StartIpReservation @("199.10.1.0", "24", "15")
  
Invoke-SwisVerb $swis IPAM.SubnetManagement FinishIpReservation @("199.10.1.1", "Reserved")
 
Invoke-SwisVerb $swis IPAM.SubnetManagement CancelIpReservation @("199.10.1.1")
```

--------------------------------

### Connect-Swis Cmdlet Usage

Source: https://github.com/solarwinds/orionsdk/wiki/PowerShell

Examples of using the Connect-Swis cmdlet with different authentication methods and hostnames.

```APIDOC
Connect-Swis

Arguments:
* Hostname (optional, defaults to `localhost`)
* V2 (optional, opens a connection to SWISv2 instead of default SWISv3)
* An authentication option. One of:
	* Credential (a PSCredential object, see [Get-Credential](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/get-credential?view=powershell-6) for details)
	* Username and Password (strings)
	* Trusted (uses the current Windows token for authentication)
	* Certificate (uses the local Orion server certificate. This will only work when running `SwisPowerShell` on an Orion server)

Returns a SWIS connection object.

Example:
```powershell
$creds = Get-Credential  # display a window asking for credentials
$swis = Connect-Swis -Credential $creds -Hostname localhost  # create a SWIS connection object
```
```

--------------------------------

### IP Address Reservation (PowerShell)

Source: https://github.com/solarwinds/orionsdk/wiki/IPAM-4.7-API

Demonstrates PowerShell commands to interact with IPAM.SubnetManagement for IP address reservation operations, including starting, finishing, and canceling.

```powershell
Invoke-SwisVerb $swis IPAM.SubnetManagement StartIpReservation @("199.10.1.0", "24", "15")
  
Invoke-SwisVerb $swis IPAM.SubnetManagement FinishIpReservation @("199.10.1.1", "Reserved")
 
Invoke-SwisVerb $swis IPAM.SubnetManagement CancelIpReservation @("199.10.1.1")
```

--------------------------------

### ApiKeyCredential Configuration

Source: https://github.com/solarwinds/orionsdk/wiki/Credential-Management

Configuration example for ApiKeyCredential, used in the 'Send GET/POST Request' Alerting action for Token Authentication. It requires an API key name and its value.

```SWQL
<ArrayOfKeyValueOfstringstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays" ><KeyValueOfstringstring><Key>Name</Key><Value>APIKey_credset</Value></KeyValueOfstringstring><KeyValueOfstringstring><Key>Description</Key><Value>APIKey_desc</Value></KeyValueOfstringstring><KeyValueOfstringstring><Key>ApiKeyName</Key><Value>APIKey_tokenname</Value></KeyValueOfstringstring><KeyValueOfstringstring><Key>ApiKey</Key><Value>APIKey_tokenvalue</Value></KeyValueOfstringstring></ArrayOfKeyValueOfstringstring>
```

--------------------------------

### PowerShell Samples for AppInsight Automation

Source: https://github.com/solarwinds/orionsdk/wiki/SAM-AppInsight-applications

Provides links to PowerShell scripts and examples for automating Server & Application Monitor (SAM) AppInsight configurations. These samples demonstrate practical usage of the Orion SDK for managing AppInsight applications.

```PowerShell
https://github.com/solarwinds/OrionSDK/tree/master/Samples/PowerShell/SAM.AppInsightAutomation
```

--------------------------------

### Get all Supernets by name (PowerShell)

Source: https://github.com/solarwinds/orionsdk/wiki/IPAM-vNext-API

Shows how to fetch supernets by their name using PowerShell and the Orion SDK. This example executes the `GetSupernetsByName` verb.

```powershell
Invoke-SwisVerb $swis IPAM.SupernetManagement GetSupernetsByName @("Example Supernet")
```

--------------------------------

### Get all Group Nodes by Name (PowerShell)

Source: https://github.com/solarwinds/orionsdk/wiki/IPAM-vNext-API

Illustrates how to retrieve group nodes by name using PowerShell and the Orion SDK. This example invokes the `GetAllGroupNodesByName` verb.

```powershell
Invoke-SwisVerb $swis IPAM.GroupManagement GetAllGroupNodesByName @("Group Node Name")
```

--------------------------------

### PowerShell Sample for Groups

Source: https://github.com/solarwinds/orionsdk/wiki/Groups

Reference to a PowerShell script that demonstrates group-related API calls, including creation.

```PowerShell
See Samples/PowerShell/Groups.ps1
```

--------------------------------

### Get First Available IP Address (PowerShell IPv4)

Source: https://github.com/solarwinds/orionsdk/wiki/IPAM-4.6-API

PowerShell example for retrieving the first available IPv4 address in a subnet using Invoke-SwisVerb.

```powershell
Invoke-SwisVerb $swis IPAM.SubnetManagement GetFirstAvailableIp @("199.10.1.0", "24")
```

--------------------------------

### Get First Available IP Address (PowerShell IPv6)

Source: https://github.com/solarwinds/orionsdk/wiki/IPAM-4.6-API

PowerShell example for retrieving the first available IPv6 address in a subnet using Invoke-SwisVerb.

```powershell
Invoke-SwisVerb $swis IPAM.SubnetManagement GetFirstAvailableIp @("1212::3", "24")
```

--------------------------------

### Connect-Swis PowerShell Cmdlet

Source: https://github.com/solarwinds/orionsdk/wiki/Connecting-to-SWIS

Demonstrates how to connect to SWIS using the `Connect-Swis` cmdlet in PowerShell with username and password authentication. This method is equivalent to the 'Orion (v3)' server type in SWQL Studio.

```PowerShell
$host = '12.153.24.2'
$user = 'admin'
$password = 'swordfish'
$swis = Connect-Swis -Hostname $host -Username $user -Password $password
```

--------------------------------

### Get Global Setting Value

Source: https://github.com/solarwinds/orionsdk/wiki/How-to-set-polling-parameters-on-a-Node

Retrieves the current and default values for a global setting from the Orion.Settings entity. This example shows how to check the 'WLP_Settings_PollRogues' setting.

```APIDOC
GET /SolarWinds/InformationService/v3/Json/Query?query=SELECT+CurrentValue,+DefaultValue+FROM+Orion.Settings+WHERE+SettingID='WLP_Settings_PollRogues'

Headers:
Authorization: _{{basicAuthorization}}_ 

Example Response:
{
    "results": [
        {
          "CurrentValue": 0.0,
          "DefaultValue": 1.0
        }
    ]
}
```

--------------------------------

### SWIS REST Read Request Example

Source: https://github.com/solarwinds/orionsdk/wiki/REST

Shows a GET request to read a specific entity from the SWIS REST API. The request includes the unique URI of the entity to be retrieved.

```text
GET https://localhost:17774/SolarWinds/InformationService/v3/Json/swis://tdanner-dev.swdev.local/Orion/Orion.Pollers/PollerID=6 HTTP/1.1
Authorization: Basic YWRtaW46
User-Agent: curl/7.20.0 (i386-pc-win32) libcurl/7.20.0 OpenSSL/0.9.8l zlib/1.2.3
Host: localhost:17774
Accept: */*
```

--------------------------------

### Getting Help on PowerShell Modules

Source: https://github.com/solarwinds/orionsdk/wiki/PowerOrion---A-Module-for-PowerShell

A general PowerShell command to access help documentation for modules, specifically referencing `About_Modules`. This is useful for understanding module management within PowerShell.

```PowerShell
Get-Help About_Modules
```

--------------------------------

### IPAM API Documentation

Source: https://github.com/solarwinds/orionsdk/wiki/IPAM-4.5.x-API

This section details the IPAM API methods for managing DNS PTR records, IP addresses, and subnets. It includes method signatures, parameter descriptions, return values, and usage examples.

```APIDOC
IPAM.IPAddressManagement:
  AddPtrRecord(recordName: str, recordData: str, dnsIpAddress: str, dnsZoneName: str) -> str
    Adds a PTR record to a DNS zone without creating an A record.
    Parameters:
      recordName: The name of the DNS record.
      recordData: The data for the DNS record (e.g., IP address).
      dnsIpAddress: The IP address of the DNS server.
      dnsZoneName: The name of the DNS zone.
    Returns: A message indicating the status of the operation.

  RemovePtrRecord(recordName: str, dnsIpAddress: str, dnsZoneName: str, isRetryingDnsZoneSearch: bool = False) -> str
    Removes a PTR record from a DNS zone.
    Parameters:
      recordName: The name of the DNS record to remove.
      dnsIpAddress: The IP address of the DNS server.
      dnsZoneName: The name of the DNS zone.
      isRetryingDnsZoneSearch: If true, enables searching in other DNS zones if the record is not found in the specified zone.
    Returns: A message indicating the status of the operation.

IPAM.SubnetManagement:
  GetFirstAvailableIp(subnetAddress: str, subnetCidr: str) -> str
    Retrieves the first available IP address within a specified subnet. Does not change the IP node's status.
    Parameters:
      subnetAddress: The IP address representing the subnet (e.g., "199.10.1.1").
      subnetCidr: The CIDR notation for the subnet (e.g., "24").
    Returns: The first available IP address from the subnet.

  ChangeIpStatus(ipAddress: str, status: str) -> void
    Changes the status of an IP node.
    Parameters:
      ipAddress: The IP address of the IP node (e.g., "199.10.1.1").
      status: The new status for the IP node. Possible values: "Used", "Available", "Reserved", "Transient", "Blocked".

  StartIpReservation(subnetAddress: str, subnetCidr: str, reservationTimeInMinutes: int = 10) -> str
    Initiates an IP address reservation for a given subnet.
    Parameters:
      subnetAddress: The IP address representing the subnet (e.g., "199.10.1.1").
      subnetCidr: The CIDR notation for the subnet.
      reservationTimeInMinutes: The duration of the reservation in minutes (defaults to 10).
    Returns: The reserved IP address.

  FinishIpReservation(ipAddress: str, finalIpStatus: str) -> void
    Completes an IP address reservation, setting the IP node to a specified final status.
    Parameters:
      ipAddress: The IP address that was reserved.
      finalIpStatus: The final status for the reserved IP address. Possible values: "Used", "Available", "Reserved", "Transient", "Blocked".

  CancelIpReservation(reservedIpAddress: str) -> void
    Cancels an ongoing IP address reservation.
    Parameters:
      reservedIpAddress: The IP address that is reserved and needs to be cancelled.

  CreateSubnet(subnetAddress: str, rawCidr: str) -> void
    Creates a new subnet. The new subnet will be placed under the root folder in the IPAM group tree. Potential errors include overlapping with existing subnets.
    Parameters:
      subnetAddress: The IP address for the new subnet.
      rawCidr: The CIDR notation for the new subnet.
```

--------------------------------

### SWIS REST Invoke Request Example

Source: https://github.com/solarwinds/orionsdk/wiki/REST

Shows a POST request to invoke a method on the SWIS REST API. This example invokes the 'GetAliases' method on the 'Metadata.Entity' resource.

```json
POST https://localhost:17774/SolarWinds/InformationService/v3/Json/Invoke/Metadata.Entity/GetAliases HTTP/1.1
Authorization: Basic YWRtaW46
User-Agent: curl/7.20.0 (i386-pc-win32) libcurl/7.20.0 OpenSSL/0.9.8l zlib/1.2.3
Host: localhost:17774
Accept: */*
Content-Type: application/json
Content-Length: 39

["SELECT B.Caption FROM Orion.Nodes B"]
```

--------------------------------

### Loading and Listing PowerOrion Cmdlets

Source: https://github.com/solarwinds/orionsdk/wiki/PowerOrion---A-Module-for-PowerShell

Shows how to load the PowerOrion module into the current PowerShell session using `Import-Module` and how to view all available cmdlets within the module using `Get-Command -Module PowerOrion`.

```PowerShell
Import-Module PowerOrion
Get-Command -Module PowerOrion
```

--------------------------------

### IP Address Reservation (C#)

Source: https://github.com/solarwinds/orionsdk/wiki/IPAM-2019.4-and-higher-versions-API

Manages IP address reservations by starting, finishing with a specific status, or canceling them. Requires subnet details for starting and IP address for finishing/canceling.

```csharp
/// <summary>
/// Start IpAddress Reservation
/// </summary>
/// <param name="subnetAddress">Subnet IpAddress. Like "199.10.1.1"</param>
/// <param name="subnetCidr">Subnet CIDR</param>
/// <param name="reservationTimeInMinutes">Reservation Time In Minutes. Default value is "10"</param>
/// <returns>Reserved IpAddress</returns>
string StartIpReservation(string subnetAddress, string subnetCidr, int reservationTimeInMinutes = 10)
  
/// <summary>
/// Finish IpAddress Reservation with specific status.
/// Call after 'StartIpReservation'
/// </summary>
/// <param name="ipAddress">IpAddress for Reservation. Like "199.10.1.1"</param>
/// <param name="finalIpStatus">IpAddress Status. Possible status values: "Used", "Available", "Reserved", "Transient", "Blocked"</param>
void FinishIpReservation(string ipAddress, string finalIpStatus)
  
/// <summary>
/// Cancel IpAddress Reservation.
/// Call after 'StartIpReservation'
/// </summary>
/// <param name="reservedIpAddress">IpAddress for Reservation. Like "199.10.1.1"</param>
void CancelIpReservation(string reservedIpAddress)
```

--------------------------------

### Read Response Example

Source: https://github.com/solarwinds/orionsdk/wiki/REST

Demonstrates a successful HTTP 200 OK response when reading data from the Orion SDK. It includes typical response headers and a JSON body containing resource details.

```APIDOC
HTTP/1.1 200 OK
Content-Length: 245
Content-Type: application/json
Server: Microsoft-HTTPAPI/2.0
Date: Fri, 27 Jul 2012 19:30:02 GMT

{"PollerID":6,"PollerType":"V.Details.SNMP.Generic","NetObject":"V:1","NetObjectType":"V","NetObjectID":1,"DisplayName":null,"Description":null,"InstanceType":"Orion.Pollers","Uri":"swis://tdanner-dev.swdev.local/Orion/Orion.Pollers/PollerID=6"}
```

--------------------------------

### SWQL Query Example

Source: https://github.com/solarwinds/orionsdk/wiki/About SWIS

Demonstrates querying all managed entities to retrieve their display names. This leverages SWIS's ability to query across entity types due to inheritance.

```SWQL
SELECT TOP 10 DisplayName FROM System.ManagedEntity ORDER BY DisplayName
```

--------------------------------

### SWIS REST Create Request Example

Source: https://github.com/solarwinds/orionsdk/wiki/REST

Demonstrates a POST request to create a new entity using the SWIS REST API. This example shows the creation of an 'Orion.Pollers' entity with specific properties.

```json
POST https://localhost:17774/SolarWinds/InformationService/v3/Json/Create/Orion.Pollers HTTP/1.1
Authorization: Basic YWRtaW46
User-Agent: curl/7.20.0 (i386-pc-win32) libcurl/7.20.0 OpenSSL/0.9.8l zlib/1.2.3
Host: localhost:17774
Accept: */*
Content-Type: application/json
Content-Length: 92

{"PollerType":"hi from curl 2", "NetObject":"N:123", "NetObjectType":"N", "NetObjectID":123}
```

--------------------------------

### Basic SwisPowerShell Workflow

Source: https://github.com/solarwinds/orionsdk/wiki/PowerShell

Demonstrates the basic steps to connect to SWIS and retrieve data using SwisPowerShell.

```PowerShell
Import-Module SwisPowerShell
$swis = Connect-Swis
Get-SwisData $swis 'SELECT NodeID, Caption FROM Orion.Nodes'
```

--------------------------------

### SWIS REST Invoke Response Example

Source: https://github.com/solarwinds/orionsdk/wiki/REST

Illustrates a successful JSON response from an SWIS REST API 'Invoke' operation. The response format depends on the invoked method; this example shows a PropertyBag.

```json
HTTP/1.1 200 OK
Content-Length: 19
Content-Type: application/json
Server: Microsoft-HTTPAPI/2.0
Date: Fri, 27 Jul 2012 19:23:27 GMT

{"B":"Orion.Nodes"}
```

--------------------------------

### Connecting to Orion and Adding a Node

Source: https://github.com/solarwinds/orionsdk/wiki/SwisPowerShell-A-Module-for-PowerShell

Demonstrates how to establish a connection to the Orion server using `Connect-Swis` and then add a new node to Orion using the `New-OrionNode` cmdlet. This showcases the module's ability to simplify common administrative tasks.

```PowerShell
$swis = Connect-Swis -UserName admin -Password "" -Hostname 10.160.5.75 
New-OrionNode -SwisConnection $swis -IPAddress 10.160.5.10
```

--------------------------------

### IP Address Reservation (PowerShell)

Source: https://github.com/solarwinds/orionsdk/wiki/IPAM-4.5.x-API

PowerShell samples demonstrating IP address reservation management using Invoke-SwisVerb. Includes starting, finishing, and cancelling reservations with the IPAM.SubnetManagement verb.

```powershell
Invoke-SwisVerb $swis IPAM.SubnetManagement StartIpReservation @("199.10.1.0", "24", "15")
  
Invoke-SwisVerb $swis IPAM.SubnetManagement FinishIpReservation @("199.10.1.1", "Reserved")
 
Invoke-SwisVerb $swis IPAM.SubnetManagement CancelIpReservation @("199.10.1.1")
```

--------------------------------

### Importing Alerts with PowerShell

Source: https://github.com/solarwinds/orionsdk/wiki/Alerts

Shows how to import an alert configuration from an XML file using Get-Content with the -Raw switch and Invoke-SwisVerb. It emphasizes using -Raw to read the entire file as a single string.

```powershell
$AlertXml = Get-Content MeaningOfLifeAlert.xml -Raw
Invoke-SwisVerb $swis Orion.AlertConfigurations Import @($AlertXml)
```

--------------------------------

### Unmanage Node

Source: https://github.com/solarwinds/orionsdk/wiki/Unmanaging-Entities

Stops monitoring a specific node for a defined period. Requires the node's identity, start time, end time, and a flag to indicate if the end time is relative to the start time.

```csharp
void Unmanage(string netObjectId, DateTime unmanageFrom, DateTime unmanageUntil, bool isRelative)
```

--------------------------------

### Connect to Orion SDK using AD (Explicit Credentials)

Source: https://github.com/solarwinds/orionsdk/wiki/Connecting-to-SWIS

Establishes a connection to the SolarWinds Orion SDK by explicitly providing Active Directory credentials. This allows connecting as a different user than the one currently running the script.

```pwsh
$host = 'myorion.mydomain.local'
$creds = Get-Credential  # display a window asking for credentials
$swis = Connect-Swis -Hostname $host -Credential $creds
```

--------------------------------

### Get First Available IP Address (PowerShell)

Source: https://github.com/solarwinds/orionsdk/wiki/IPAM-4.5.x-API

PowerShell sample using Invoke-SwisVerb to get the first available IP address in a subnet. It calls the IPAM.SubnetManagement verb with the subnet address and CIDR.

```powershell
Invoke-SwisVerb $swis IPAM.SubnetManagement GetFirstAvailableIp @("199.10.1.0", "24")
```

--------------------------------

### SWQL Studio

Source: https://github.com/solarwinds/orionsdk/wiki/Home

SWQL Studio is a graphical query tool included with the Orion SDK for executing SWQL queries against the SolarWinds Information Service.

```SWQL
SWQL Studio:
  Purpose: Graphical query tool for SWQL.
  Functionality: Allows running SWQL queries against SWIS.
  Included in: Orion SDK.
```

--------------------------------

### IP Address Reservation Management

Source: https://github.com/solarwinds/orionsdk/wiki/IPAM-vNext-API

Provides methods for managing IP address reservations, including starting, finishing, and canceling reservations. Supports specifying reservation time and starting address. When reservation time expires, the IP node status is set to available.

```APIDOC
IPAM.SubnetManagement:
  StartIpReservation(subnetAddress: string, subnetCidr: string, reservationTimeInMinutes: int = 10, addressToStart: string = '')
    Description: Starts an IP address reservation. If reservation time expires, the IP node status is set to available.
    Parameters:
      subnetAddress: Subnet IpAddress. Like "199.10.1.1"
      subnetCidr: Subnet CIDR
      reservationTimeInMinutes: Reservation Time In Minutes. Default value is "10"
      addressToStart: Address from which available addresses will be reserved. By default addresses will be reserved from first available address in subnet.
    Returns: Reserved IpAddress

  FinishIpReservation(ipAddress: string, finalIpStatus: string)
    Description: Finishes an IP address reservation with a specific status. Should be called after 'StartIpReservation'.
    Parameters:
      ipAddress: IpAddress for Reservation. Like "199.10.1.1"
      finalIpStatus: IpAddress Status. Possible status values: "Used", "Available", "Reserved", "Transient", "Blocked"

  CancelIpReservation(reservedIpAddress: string)
    Description: Cancels an IP address reservation. Should be called after 'StartIpReservation'.
    Parameters:
      reservedIpAddress: IpAddress for Reservation. Like "199.10.1.1"
```

```powershell
Invoke-SwisVerb $swis IPAM.SubnetManagement StartIpReservation @("199.10.1.0", "24", "15", "199.10.1.24")

Invoke-SwisVerb $swis IPAM.SubnetManagement FinishIpReservation @("199.10.1.1", "Reserved")

Invoke-SwisVerb $swis IPAM.SubnetManagement CancelIpReservation @("199.10.1.1")
```

--------------------------------

### Import Application Monitoring Template

Source: https://github.com/solarwinds/orionsdk/wiki/SAM-Application-Monitoring-Templates

Automates the import of an application monitoring template into SolarWinds SAM from a specified .apm-template file. It uses the `ImportTemplate` verb on the `Orion.APM.ApplicationTemplate` entity.

```PowerShell
# Load the template to a variable
$applicationTemplate = (Get-Content -Path ".\MyTemplate.apm-template" | Out-String)
# Import template
$result = Invoke-SwisVerb -Swis $swis Orion.APM.ApplicationTemplate ImportTemplate @($applicationTemplate)
$applicationTemplateId = $result.InnerText
Write-Host "Imported template Id: $applicationTemplateId"
```

--------------------------------

### IP Address Reservation Management

Source: https://github.com/solarwinds/orionsdk/wiki/IPAM-Observability-2022.2

Provides methods for managing IP address reservations, including starting, finishing, and canceling reservations. Supports specifying reservation time and starting address. When reservation time expires, the IP node status is set to available.

```APIDOC
IPAM.SubnetManagement:
  StartIpReservation(subnetAddress: string, subnetCidr: string, reservationTimeInMinutes: int = 10, addressToStart: string = '')
    Description: Starts an IP address reservation. If reservation time expires, the IP node status is set to available.
    Parameters:
      subnetAddress: Subnet IpAddress. Like "199.10.1.1"
      subnetCidr: Subnet CIDR
      reservationTimeInMinutes: Reservation Time In Minutes. Default value is "10"
      addressToStart: Address from which available addresses will be reserved. By default addresses will be reserved from first available address in subnet.
    Returns: Reserved IpAddress

  FinishIpReservation(ipAddress: string, finalIpStatus: string)
    Description: Finishes an IP address reservation with a specific status. Should be called after 'StartIpReservation'.
    Parameters:
      ipAddress: IpAddress for Reservation. Like "199.10.1.1"
      finalIpStatus: IpAddress Status. Possible status values: "Used", "Available", "Reserved", "Transient", "Blocked"

  CancelIpReservation(reservedIpAddress: string)
    Description: Cancels an IP address reservation. Should be called after 'StartIpReservation'.
    Parameters:
      reservedIpAddress: IpAddress for Reservation. Like "199.10.1.1"
```

```powershell
Invoke-SwisVerb $swis IPAM.SubnetManagement StartIpReservation @("199.10.1.0", "24", "15", "199.10.1.24")

Invoke-SwisVerb $swis IPAM.SubnetManagement FinishIpReservation @("199.10.1.1", "Reserved")

Invoke-SwisVerb $swis IPAM.SubnetManagement CancelIpReservation @("199.10.1.1")
```

--------------------------------

### Connect to Orion SDK using AD (Trusted)

Source: https://github.com/solarwinds/orionsdk/wiki/Connecting-to-SWIS

Establishes a connection to the SolarWinds Orion SDK using the current user's Active Directory credentials. This method is suitable when running the script under the intended AD user context.

```pwsh
$host = 'myorion.mydomain.local'
$swis = Connect-Swis -Hostname $host -Trusted
```

--------------------------------

### IPAM API Reference

Source: https://github.com/solarwinds/orionsdk/wiki/_Sidebar

Documentation for the IPAM API, detailing its endpoints, methods, and parameters for managing IP addresses within the SolarWinds environment.

```APIDOC
IPAM API:
  Endpoints:
    /SolarWinds/InformationService/Orion/Orion.IPAM.IIpAddress
    /SolarWinds/InformationService/Orion/Orion.IPAM.ISubnet

  Methods for Orion.IPAM.IIpAddress:
    GetIpAddress(ipAddressId: int) -> IpAddress
      Retrieves a specific IP address record by its ID.
      Parameters:
        ipAddressId: The unique identifier of the IP address.
      Returns:
        An IpAddress object containing details of the IP address.

    GetAllIpAddresses() -> Array[IpAddress]
      Retrieves all IP address records.
      Returns:
        An array of IpAddress objects.

    CreateIpAddress(ipAddress: IpAddress) -> IpAddress
      Creates a new IP address record.
      Parameters:
        ipAddress: An IpAddress object with the details of the new IP address.
      Returns:
        The created IpAddress object.

    UpdateIpAddress(ipAddress: IpAddress) -> IpAddress
      Updates an existing IP address record.
      Parameters:
        ipAddress: An IpAddress object with the updated details.
      Returns:
        The updated IpAddress object.

    DeleteIpAddress(ipAddressId: int)
      Deletes an IP address record by its ID.
      Parameters:
        ipAddressId: The unique identifier of the IP address to delete.

  Methods for Orion.IPAM.ISubnet:
    GetSubnet(subnetId: int) -> Subnet
      Retrieves a specific subnet record by its ID.
      Parameters:
        subnetId: The unique identifier of the subnet.
      Returns:
        A Subnet object containing details of the subnet.

    GetAllSubnets() -> Array[Subnet]
      Retrieves all subnet records.
      Returns:
        An array of Subnet objects.

    CreateSubnet(subnet: Subnet) -> Subnet
      Creates a new subnet record.
      Parameters:
        subnet: A Subnet object with the details of the new subnet.
      Returns:
        The created Subnet object.

    UpdateSubnet(subnet: Subnet) -> Subnet
      Updates an existing subnet record.
      Parameters:
        subnet: A Subnet object with the updated details.
      Returns:
        The updated Subnet object.

    DeleteSubnet(subnetId: int)
      Deletes a subnet record by its ID.
      Parameters:
        subnetId: The unique identifier of the subnet to delete.

  Data Types:
    IpAddress:
      IpAddressId: int
      IpAddress: string
      Description: string
      Status: int
      SubnetId: int

    Subnet:
      SubnetId: int
      CidrNotation: string
      Description: string
      Vlan: int
```

--------------------------------

### MemberDefinitionInfo Array in JSON

Source: https://github.com/solarwinds/orionsdk/wiki/Groups

Example of how to structure an array of `MemberDefinitionInfo` objects in JSON format for use with the `CreateContainer` API call.

```JSON
[
    {"Name": "Node 42", "Definition": "swis://my-orion-instance/Orion/Orion.Nodes/NodeID=42"},
    {"Name": "Cisco gear", "Definition": "filter:/Orion.Nodes[Vendor='Cisco']"},
    {"Name": "ATX", "Definition": "filter:/Orion.Nodes[CustomProperties.City='Austin']"}
]
```

--------------------------------

### ApmUsernamePasswordCredential Configuration

Source: https://github.com/solarwinds/orionsdk/wiki/Credential-Management

Configuration example for ApmUsernamePasswordCredential, the SAM module's version of UsernamePasswordCredentials. It is used in SAM-specific features such as application discovery.

```SWQL
<ArrayOfKeyValueOfstringstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays" ><KeyValueOfstringstring><Key>Name</Key><Value>SAMUserPass_credset</Value></KeyValueOfstringstring><KeyValueOfstringstring><Key>Description</Key><Value>SAMUserPass_desc</Value></KeyValueOfstringstring><KeyValueOfstringstring><Key>Username</Key><Value>UserPass_username</Value></KeyValueOfstringstring><KeyValueOfstringstring><Key>Password</Key><Value>UserPass_password</Value></KeyValueOfstringstring></ArrayOfKeyValueOfstringstring>
```

--------------------------------

### Connecting to SolarWinds Orion and Adding a Node

Source: https://github.com/solarwinds/orionsdk/wiki/PowerOrion---A-Module-for-PowerShell

Demonstrates how to establish a connection to the SolarWinds Orion server using `Connect-Swis` and then add a new node to the Orion Platform using the `New-OrionNode` cmdlet. This showcases the module's ability to simplify common administrative tasks.

```PowerShell
$swis = Connect-Swis -UserName admin -Password "" -Hostname 10.160.5.75 
New-OrionNode -SwisConnection $swis -IPAddress 10.160.5.10
```

--------------------------------

### MemberDefinitionInfo Array in XML (PowerShell)

Source: https://github.com/solarwinds/orionsdk/wiki/Groups

Example of how to structure an array of `MemberDefinitionInfo` objects in XML format, typically used when working with PowerShell.

```XML
<ArrayOfMemberDefinitionInfo xmlns='http://schemas.solarwinds.com/2008/Orion'>
    <MemberDefinitionInfo>
        <Name>Node 42</Name>
        <Definition>swis://my-orion-instance/Orion/Orion.Nodes/NodeID=42</Definition>
    </MemberDefinitionInfo>
    <MemberDefinitionInfo>
        <Name>Cisco gear</Name>
        <Definition>filter:/Orion.Nodes[Vendor='Cisco']</Definition>
    </MemberDefinitionInfo>
    <MemberDefinitionInfo>
        <Name>ATX</Name>
        <Definition>filter:/Orion.Nodes[CustomProperties.City='Austin']</Definition>
    </MemberDefinitionInfo>
</ArrayOfMemberDefinitionInfo>
```

--------------------------------

### Create Subnet (PowerShell)

Source: https://github.com/solarwinds/orionsdk/wiki/IPAM-4.9-API

Demonstrates the PowerShell command to create a new subnet using the Invoke-SwisVerb cmdlet, specifying the subnet address and CIDR.

```powershell
Invoke-SwisVerb $swis IPAM.SubnetManagement CreateSubnet @("10.10.1.0", "21")
```

--------------------------------

### IP Address Reservation (PowerShell)

Source: https://github.com/solarwinds/orionsdk/wiki/IPAM-4.9-API

Demonstrates how to invoke IPAM subnet management verbs in PowerShell for starting, finishing, and canceling IP address reservations.

```powershell
Invoke-SwisVerb $swis IPAM.SubnetManagement StartIpReservation @("199.10.1.0", "24", "15")
  
Invoke-SwisVerb $swis IPAM.SubnetManagement FinishIpReservation @("199.10.1.1", "Reserved")
 
Invoke-SwisVerb $swis IPAM.SubnetManagement CancelIpReservation @("199.10.1.1")
```

--------------------------------

### Delete UDT Port

Source: https://github.com/solarwinds/orionsdk/wiki/UDT-vNext-API

Provides a PowerShell example for deleting a UDT port from the SolarWinds Orion platform using its unique URI.

```powershell
Remove-SwisObject $swis -Uri 'swis://localhost/Orion/Orion.Nodes/NodeID={node_id_here}/Ports/PortID={port_id_here}'
```