Community
- Command Central
- MVP Program
- Monthly Mission
- Blogs
- Groups
- Events
- Media Vault
Products
- Observability
- Network Management
- Application Management
- IT Security
- IT Service Management
- System Management
- Database Management
Content Exchange
- SolarWinds Platform
- Server & Application Monitor
- Database Performance Analyzer
- Server Configuration Monitor
- Network Performance Monitor
- Network Configuration Manager
- SQL Sentry
- Web Help Desk
Free Tools & Trials

SAM Powershell Template updating Custom Property

I am wanting to populate a Custom Property based off a registry key.

This is my first attempt at making a custom template using powershell and I believe I have the powershell part done but not confident on how to assign it to the custom property.

$regvalue = 'HKLM:\SOFTWARE\Policies\Microsoft\Windows\WindowsUpdate'
$property= (Get-ItemProperty -Path $regvalue).WUServer

But what is best way to assign it to the custom property. Do I need to call an API? My custom property is called WSUSServer.

I have been reading multiple threads but trying to figure out best practice. Do I just assign this to all nodes or best to do it in bulk.

Find more posts tagged with

Accepted answers

All comments

adam.beedell

Two routes that come to mind:

1) in the Component, output the value to Statistic/Message. Then make an alert (perhaps a once-a-day), that when triggered takes the action "Write to a custom property" and write Statistic/message to it

2) In the Component, output to SWIS using the solarwinds api and calling ${caption} or ${IP} to match up the details

Writing either of those is a bit of a pain, if nothing crazy.

yaquaholic

Hello Pogue1000,

All of this was found here: https://github.com/solarwinds/OrionSDK/wiki/PowerShell
You'll need to install the module, instructions included.

Here is an example on getting (previously created) and populating Node Custom Properties:

## Orion SWIS connection
$user = "yaquaholic"
$pwd = "Thwack Rukes!"
$orion = "orion.yourdomian"
$swis = Connect-Swis -UserName $user -Password $pwd -Hostname $orion

# SWQL Query to get the NodeID by searching for an IP
# Or you could use WHERE Caption LIKE '' for a device name 
$ip = "10.0.0.100"
$search_swql = "SELECT NodeID FROM Orion.Nodes WHERE IPAddress = '$($ip)'"


# Populate the variable with the NodeID for that IP Address
$NodeId = Get-SwisData -Query $search_swql -SwisConnection $swis

# And find it's Custom properties (of interest)
$CP_query = @"
SELECT WSUSServer, Uri
  FROM Orion.NodesCustomProperties
 WHERE NodeID ='$($NodeId)' 


$NodeCPs = Get-SwisData -Query $CP_query -SwisConnection $swis

#Show the data (this returns a PSObject)
$NodeCPs


# Update the CP (as a Hashtable, PSObject won't work)
$new_cp = @{ WSUSServer = $property  ; }

# And update the Node's WSUSServer CP using:
Set-SwisObject $swis -Uri $NodeCPs.Uri -Properties $new_cp

This will populate $project into a Node's WSUSServer custom property.

I hope it helps!

Rich (aka Yaquaholic)

adam.beedell

Worth mentioning - Pogue's talking about running this as a SAM component, in which case bear in mind the SWIS powershell module probably wont/shouldnt be on all your servers, so either you have the component in local execution mode to run on your polling engine and just install it there, or you build the API call this module would fire off separately so you dont need loads of installs

yaquaholic

Good point, here's a REST example for you:

# Orion connection variables
$user = 'yaquaholic' 
$pwd = 'Thwack_Rules!' 
$orion =  'orion.yourdomain:17778'  
#Note port 17778 is being replaced by port 17774

# Added to ignore PowerShell TLS/SSL errors
add-type @"
    using System.Net;
    using System.Security.Cryptography.X509Certificates;
    public class TrustAllCertsPolicy : ICertificatePolicy {
        public bool CheckValidationResult(
            ServicePoint srvPoint, X509Certificate certificate,
            WebRequest request, int certificateProblem) {
            return true;
        }
    }

[System.Net.ServicePointManager]::CertificatePolicy = New-Object TrustAllCertsPolicy


# Quick and dirty way to create the credentials
# You will need something better than this
$creds = Get-Credential -UserName $user -Message "Enter password"

# Create JSON, for populating the Custom Property WSUSServer
$wsusserver = @{ WSUSServer = $property } | ConvertTo-Json

# Search for a NodeID by IPAddress
$ip = "10.10.10.10"
$query = "SELECT NodeId FROM Orion.Nodes WHERE IPAddress LIKE '$($ip)'"
$results = Invoke-WebRequest -Credential $creds https://$orion/SolarWinds/InformationService/v3/Json/Query?query=$query

# Convert the results in a Hahtable
$data =  $results.Content | ConvertFrom-Json

# The should only be one NodeId
ForEach ($result in $data.results)
        { 
          $nodeid = $result.NodeID
          Write-Host "NodeID: $($nodeid)"
          # Collect the custom property values and the Uri for that NodeID
          $cp_query = "SELECT WSUSServer, Uri FROM Orion.NodesCustomProperties WHERE NodeID=$($nodeid)"
          $cp_results = Invoke-WebRequest -Credential $creds https://$orion/SolarWinds/InformationService/v3/Json/Query?query=$cp_query

          $cp_data = $cp_results.Content | ConvertFrom-Json

          #Echo the results to the terminal
          Write-Host $cp_data.results.WSUSServer
          # We need this URI, as it is used in the URI to POST the data back
          Write-Host $cp_data.results.Uri

          # Using the $cp_data.results.Uri, create the POST URI
          $update_uri = "https://sol01mon01.cloudsoftcat.net:17778/SolarWinds/InformationService/v3/Json/$($cp_json.results.Uri)"
          # And upload the JSON 
          $update_results = Invoke-WebRequest -Credential $creds -Uri $update_uri -Method POST -Body $wsusserver  -ContentType "application/json"

          # And finally check for HTTP 200 response
          $update_results.StatusCode
        }

Again taken from: https://github.com/solarwinds/OrionSDK/wiki/REST

pogue1000

I might just create a powershell script as a scheduled task that runs daily on the server using the SDK. All I am trying to achieve is confirmation that all servers are getting set up in WSUS so they get patched on proper patch cycle.

What exactly do you mean by

in the Component, output the value to Statistic/Message

adam.beedell

If you run it as a scheduled task you can ignore that bit. In your original post you were referring to a template, which I took to mean "a SAM Component", in which case those require some specific formatting in order to be valid.

This kinda exists in the scheduled task world too, where you'd want to figure out some exit/return codes to represent error states you might need to deal with later

Eden60

To assign the value retrieved from the registry key to a custom property called "WSUSServer," you can use PowerShell scripting. Here's an example of how you can achieve this:

$regvalue = 'HKLM:\SOFTWARE\Policies\Microsoft\Windows\WindowsUpdate'
$property = (Get-ItemProperty -Path $regvalue).WUServer

# Set the custom property value for the current node
Set-ItemProperty -Path "HKLM:\SOFTWARE\CustomProperties" -Name "WSUSServer" -Value $property

In the example above, the value of the registry key HKLM:\SOFTWARE\Policies\Microsoft\Windows\WindowsUpdate\WUServer is retrieved and stored in the $property variable. Then, the Set-ItemProperty cmdlet is used to assign this value to the custom property "WSUSServer" under the registry path HKLM:\SOFTWARE\CustomProperties.

To apply this script to multiple nodes, you would need to execute it on each node individually or incorporate it into a deployment or configuration management tool that can execute PowerShell scripts across multiple nodes.

Note: The registry path and custom property name in the script are just examples. You should replace them with the actual registry path and custom property name you intend to use in your scenario.