PoshCode Archive  Artifact Content

Artifact 35363649aeaa473c6f5769a7fdde384a52af0afaa11489e9d1b82b040992ff37:

  • File SMS-psm1.ps1 — part of check-in [10965baae7] at 2018-06-10 14:05:05 on branch trunk — Module with functions to make it easy to query the SMS provider directly through WMI (user: unknown size: 5263)

# encoding: ascii
# api: powershell
# title: SMS.psm1
# description: Module with functions to make it easy to query the SMS provider directly through WMI
# version: 0.1
# type: function
# license: CC0
# function: Get-SmsWmi
# x-poshcode-id: 597
# x-archived: 2008-09-26T19:09:58
#
#
# SystemsManagementServer.psm1
# written by Tojo2000 <tojo2000@tojo2000.com>
# Last updated on 20080921
#
# Functions for getting data from MS Systems Management Server.


# Set default server and site name here.  It should be the server with the SMS 
# Provider, not necessarily the site server.

[string]$default_wmi_provider_server = 'servername'
[string]$default_site = 'S00'


# Get-SmsWmi
# A wrapper for Get-WmiObject that makes it easy to get objects from SMS.
#
# Args:
#   $class: the WMI class or nickname to retrieve
#   $filter: the where clause of the query
#   $computer_name: the SMS server hosting the SMS Provider
#   $site: the SMS Site Code of the target site
# Returns:
#   An array of WMI objects

function Get-SmsWmi {
  param([string]$class = $(Throw @"
`t
ERROR: You must enter a class name or nickname.
`t
Valid nicknames are:
`t
  AddRemovePrograms
  AdStatus
  Advertisement
  Collection
  ComputerSystem
  DistributionPoint
  LogicalDisk
  MembershipRule
  NetworkAdapter
  NetworkAdapterConfiguration
  OperatingSystem
  Package
  PackageStatus
  Program
  Query
  Server
  Service
  Site
  StatusMessage
  System
  WorkstationStatus
  User
`t
Note: You only need to type as many characters as necessary to be unambiguous.
`t
"@),
        [string]$filter = $null,
        [string]$computer_name = $default_wmi_provider_server,
        [string]$site = $default_site)

  $classes = @{'collection' = 'SMS_Collection';
               'package' = 'SMS_Package';
               'program' = 'SMS_Program';
               'system' = 'SMS_R_System';
               'server' = 'SMS_SystemResourceList';
               'advertisement' = 'SMS_Advertisement';
               'query' = 'SMS_Query';
               'membershiprule' = 'SMS_CollectionMembershipRule';
               'statusmessage' = 'SMS_StatusMessage';
               'site' = 'SMS_Site';
               'user' = 'SMS_R_User';
               'pkgstatus' = 'SMS_PackageStatus';
               'addremoveprograms' = 'SMS_G_System_ADD_REMOVE_PROGRAMS';
               'computersystem' = 'SMS_G_System_COMPUTER_SYSTEM';
               'operatingsystem' = 'SMS_G_System_OPERATING_SYSTEM';
               'service' = 'SMS_G_System_SERVICE';
               'workstationstatus' = 'SMS_G_System_WORKSTATION_STATUS';
               'networkadapter' = 'SMS_G_System_NETWORK_ADAPTER';
               'networkadapterconfiguration' = ('SMS_G_System_NETWORK_' +
                                                'ADAPTER_CONFIGURATION');
               'logicaldisk' = 'SMS_G_System_LOGICAL_DISK';
               'distributionpoint' = 'SMS_DistributionPoint';
               'adstatus' = 'SMS_ClientAdvertisementStatus'}

  $matches = @();

  foreach ($class_name in @($classes.Keys | sort)) {
    if ($class_name.StartsWith($class.ToLower())) {
      $matches += $classes.($class_name)
    }
  }

  if ($matches.Count -gt 1) {
    Write-Error @"
`t
Warning: Class provided matches more than one nickname.
`t
Type 'Get-SMSWmi' with no parameters to see a list of nicknames.
`t
"@
    $class = $matches[0]
  } elseif ($matches.Count -eq 1) {
    $class = $matches[0]
  }

  $query = "Select * From $class"

  if ($filter) {
    $query += " Where $filter"
  }

  # Now that we have our parameters, let's execute the command.
  $namespace = 'root\sms\site_' + $site
  gwmi -ComputerName $computer_name -Namespace $namespace -Query $query
}


# Find-SmsId
# Look up an SMS ID.
#
# Args:
#   $advertisement_id,
#   $collection_id,
#   $package_id,
#   $resource_id: The id type to look up.  Pick only one type.
#   $id: The ID to look up
#
# Returns:
#   An sms object if one was found

function Find-SmsID {
  param([switch]$advertisement_id,
        [switch]$collection_id,
        [switch]$resource_id,
        [switch]$package_id,
        [string]$id)
  $Class = ''
  $Type = ''

    if ($advertisement_id) {
      $type = 'AdvertisementID'
      $class = 'Advertisement'
    } elseif ($collection_id) {
      $type = 'CollectionID'
      $class = 'Collection'
    } elseif ($package_id) {
      $type = 'PackageID'
      $class = 'Package'
    } elseif ($resource_id) {
      $type = 'ResourceID'
      $class = 'System'
    } else {
      Throw @"
`t
You must specify an ID type.  Valid switches are:
`t
`t-advertisement_id
`t-collection_id
`t-package_id
`t-resource_id
`t
USAGE: Find-SmsID <Type> <ID>
`t
"@
    }

  if ($resource_id) {
    trap [System.Exception] {
      Write-Output "`nERROR: Invalid Input for ResourceID!`n"
      break
    }
	
    $type = 'ResourceID'
    $class = 'System'
    [int]$id = $id  # Throws an exception if it's not a number
  } else{
    if ($id -notmatch '^[a-zA-Z0-9]{8}$') {
      Throw "`n`t`nERROR: Invalid ID format.`n`t`n"
    }
  }

  Get-SmsWmi $class "$type = `"$ID`""
}