Contact Info

Crumbtrail

ActiveXperts.com » Network Monitor » Scripts » Custom Script

msactivedirectory.ps1 - powershell script by ActiveXperts Software

msactivedirectory.ps1 checks whether MS Active Directory is running; it checks services, processes and performance counters.

Use msactivedirectory.ps1 directly from ActiveXperts Network Monitor; in the Manager's 'Monitor' menu, select 'New Check (Script)' and select msactivedirectory.ps1. Configure the required parameter, or press 'Load a working sample'.

In ActiveXperts Network Monitor, Administrators can use three different scripting languages: Powershell, VBScript and SSH.


msactivedirectory.ps1 script code

#################################################################################
# ActiveXperts Network Monitor PowerShell script, © ActiveXperts Software B.V.
# For more information about ActiveXperts Network Monitor, visit the ActiveXperts 
# Network Monitor web site at http://www.activexperts.com
#################################################################################
# Script:
#     MsActiveDirectory.ps1
# Description: 
#     Checks if Active Directory is running; it checks the AD services and AD processes
# Declare Parameters:
#     1) strHost (string) - Hostname or IP address of the server you want to check
#     2) strAltCredentials (string, optional) - Specify an empty string to use Network Monitor service credentials.
#         To use alternate credentials, enter a server that is defined in Server Credentials table.
#         (To define Server Credentials, choose Tools->Options->Server Credentials)
# Usage:
#     .\MsActiveDirectory.ps1 '<Hostname | IP>' '[alt-credentials]'
# Sample:
#     .\MsActiveDirectory.ps1 'localhost'
#################################################################################

# -- Declare Parameters
param ( [string]$strHost = '', [string]$strAltCredentials = '' )

# -- Use _activexperts.ps1 with common functions 
. 'C:\Program Files\ActiveXperts\Network Monitor\Scripts\Monitor (ps1)\_activexperts.ps1' 


#################################################################################
# // --- Private Functions section ---
#################################################################################

function getSoftwareInfo( $strVersion, [ref]$lstServices, [ref]$lstProcesses, [ref]$lstPerfCounters )
{
  # Retrieve services, processes and counters associated to the specific version of the software. Entries that start 
  # with '!' are optional services/processes/counters and are not checked by default. Remove '!' mark to enable monitoring those items.
  switch( $strVersion )
  {
    ''
    {
      $lstServices.value = @( @( 'NTDS', 'Active Directory Domain Services' ),
                              @( '!CertSvc','Active Directory Certificate Services' ),
                              @( 'DNS','DNS Server' ),
                              @( '' , '', '', '' ) )
      $lstProcesses.value = @( 'lsass.exe', '!certsrv.exe', '!dns.exe', '' )
      $lstPerfCounters.value = @( , @('','', '', '') )
      return $AXSUCCESS
    }
      
    default
    {
      $lstServices.value = @( , @( '', '' ) )
      $lstProcesses.value = @( , '' )
      $lstPerfCounters.value = @( , @( '', '', '', '' ) )
      return $AXERROR
    }
  }
}


#################################################################################
# // --- Main script ---
#################################################################################

# -- Clear screen and clear error
cls
$Error.Clear()

# -- Validate parameters, return on parameter mismatch
if( $strHost -eq '' )
{
  $res = 'UNCERTAIN: Parameter error - Usage: .\MsActiveDirectory.ps1 "<Hostname | IP>" "[alt-credentials]"'
  echo $res
  exit
}

# -- Declare local variables by assigning an initial value to it
$lstServices = $null
$lstProcesses = $null
$lstPerfCounters = $null

$objAltCredentials = $null
$strExplanation = ''


# If alternate credentials are specified, retrieve the alternate login and password from the ActiveXperts global settings
if( $strAltCredentials -ne '' )
{
  # Get the Alternate Credentials object. Function "AxGetCredentials" is implemented in "activexperts.ps1"
  if( ( AxGetCredentials $strHost  $strAltCredentials ([ref]$objAltCredentials) ([ref]$strExplanation) ) -ne $AXSUCCESS )
  {
    echo $strExplanation
    exit
  }
}

# Retrieve product processes/services/performance-counters list
if( ( getSoftwareInfo $strVersion ([ref]$lstServices) ([ref]$lstProcesses) ([ref]$lstPerfCounters) ) -ne $AXSUCCESS )
{ 
  $res = 'ERROR: Version [' + $strVersion + '] is not supported.'
  echo $res
  exit
}

# -- Check services
if( ( AxCheckServices $strHost ([ref]$lstServices) $objAltCredentials ([ref]$strExplanation) ) -ne $AXSUCCESS )
{
  echo $strExplanation
  exit
}

# -- Check processes
if( ( AxCheckProcesses $strHost ([ref]$lstProcesses) $objAltCredentials ([ref]$strExplanation) ) -ne $AXSUCCESS )
{
  echo $strExplanation
  exit
}

# -- Check performance counters
if( ( AxCheckPerfCounters $strHost ([ref]$lstPerfCounters) $objAltCredentials ([ref]$strExplanation) ) -ne $AXSUCCESS )
{
  echo $strExplanation
  exit
}

# -- Print script result
$res = 'SUCCESS: All services, processes and counters successfully checked'
echo $res
exit


#################################################################################
# // --- Catch script exceptions ---
#################################################################################

trap [Exception]
{
  $res = 'UNCERTAIN: ' + $_.Exception.Message
  echo $res
  exit
}