VirtualServer AvailabilityState Powershell Probe

AP.F5.LTM.Probe.VirtualServerAvailabilityState.Powershell (ProbeActionModuleType)

Gets all VirtualServer AvailabilityState as Property Bags

Element properties:

Member Modules:

Overrideable Parameters:

Source Code:

<ProbeActionModuleType ID="AP.F5.LTM.Probe.VirtualServerAvailabilityState.Powershell" Accessibility="Public" Batching="false">

  <Configuration>

    <IncludeSchemaTypes>

      <SchemaType>Windows!Microsoft.Windows.PowerShellSchema</SchemaType>

    </IncludeSchemaTypes>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" minOccurs="1" name="Debug" type="xsd:boolean"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" minOccurs="1" name="DeviceAddresses" type="xsd:string"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" minOccurs="1" name="DevicePorts" type="xsd:string"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" minOccurs="1" name="DeviceCommunities" type="xsd:string"/>

  </Configuration>

  <OverrideableParameters>

    <OverrideableParameter ID="Debug" Selector="$Config/Debug$" ParameterType="bool"/>

  </OverrideableParameters>

  <ModuleImplementation Isolation="Any">

    <Composite>

      <MemberModules>

        <ProbeAction ID="PSScript" TypeID="Windows!Microsoft.Windows.PowerShellPropertyBagTriggerOnlyProbe">

          <ScriptName>Get-VirtualServerAvailabilityState.ps1</ScriptName>

          <ScriptBody><Script>#==================================================================================

# Script: 	Get-VirtualServerAvailabilityState.ps1

# Date:		01/08/18

# Author: 	Andi Patrick

# Purpose:	Gets VirtualServer Availability State via SNMP returns all as Property Bag

#==================================================================================



# Get the named parameters

param($Debug,$DeviceAddresses,$DevicePorts,$DeviceCommunities,$SharpSnmpLocation)



# Get Start Time For Script

$StartTime = (GET-DATE)



#Constants used for event logging

$SCRIPT_NAME			= 'Get-VirtualServerAvailabilityState.ps1'

$EVENT_LEVEL_ERROR 		= 1

$EVENT_LEVEL_WARNING 	= 2

$EVENT_LEVEL_INFO 		= 4



$SCRIPT_STARTED				= 4601

$SCRIPT_PROPERTYBAG_CREATED	= 4602

$SCRIPT_EVENT				= 4603

$SCRIPT_ENDED				= 4604

$SCRIPT_ERROR				= 4605



#==================================================================================

# Sub:		LogDebugEvent

# Purpose:	Logs an informational event to the Operations Manager event log

#			only if Debug argument is true

#==================================================================================

function Log-DebugEvent

{

	param($eventNo,$message)



	$message = "`n" + $message

	if ($Debug -eq $true)

	{

		$api.LogScriptEvent($SCRIPT_NAME,$eventNo,$EVENT_LEVEL_INFO,$message)

	}

}



#Start by setting up API object.

$api = New-Object -comObject 'MOM.ScriptAPI'



# Log Startup Message

Log-DebugEvent $SCRIPT_STARTED "Script Started."



# Get Working All Device Addresses, Ports and Communities

$DeviceAddressList = $DeviceAddresses.Split(",")

$DevicePortList = $DevicePorts.Split(",")

$DeviceCommunityList = $DeviceCommunities.Split(",")



# Load SharpSNMPLib

[reflection.assembly]::LoadFrom( (Resolve-Path $SharpSnmpLocation) )

# Use SNMP v2

$ver = [Lextm.SharpSnmpLib.VersionCode]::V2

# Set Walk Mode to WithinSubtree

$walkMode = [Lextm.SharpSnmpLib.Messaging.WalkMode]::WithinSubtree





# OIDs used

# bigipTrafficMgmt.bigipLocalTM.ltmVirtualServers.ltmVirtualServStatus.ltmVsStatusTable.ltmVsStatusEntry.ltmVsStatusName

[string]$ltmVsStatusName = ".1.3.6.1.4.1.3375.2.2.10.13.2.1.1" 

# bigipTrafficMgmt.bigipLocalTM.ltmVirtualServers.ltmVirtualServStatus.ltmVsStatusTable.ltmVsStatusEntry.ltmVsStatusEnabledState

[string]$ltmVsStatusEnabledState = ".1.3.6.1.4.1.3375.2.2.10.13.2.1.3" 

# bigipTrafficMgmt.bigipLocalTM.ltmVirtualServers.ltmVirtualServStatus.ltmVsStatusTable.ltmVsStatusEntry.ltmVsStatusAvailState

[string]$ltmVsStatusAvailState = ".1.3.6.1.4.1.3375.2.2.10.13.2.1.2" 

# bigipTrafficMgmt.bigipLocalTM.ltmVirtualServers.ltmVirtualServStatus.ltmVsStatusTable.ltmVsStatusEntry.ltmVsStatusDetailReason

[string]$ltmVsStatusDetailedReason = ".1.3.6.1.4.1.3375.2.2.10.13.2.1.5" 

# bigipTrafficMgmt.bigipLocalTM.ltmVirtualServers.ltmVirtualServ.ltmVirtualServTable.ltmVirtualServEntry.ltmVirtualServDefaultPool

[string]$ltmVsDefaultPool = ".1.3.6.1.4.1.3375.2.2.10.1.2.1.19" 



# Loop Through All Devices

For ($i=0;$i -lt $DeviceAddressList.Count;$i++) {

	Try {

		# Create endpoint for SNMP server

		$ip = [System.Net.IPAddress]::Parse($DeviceAddressList[$i])

		$svr = New-Object System.Net.IpEndPoint ($ip, $DevicePortList[$i])



		# Get VirtualServer Names from SNMP

		$VirtualServerNameList = New-Object 'System.Collections.Generic.List[Lextm.SharpSnmpLib.Variable]'

		[Lextm.SharpSnmpLib.Messaging.Messenger]::Walk($ver, $svr, $DeviceCommunityList[$i], $ltmVsStatusName, $VirtualServerNameList, 3000, $walkMode)



		# Get VirtualServer Default Pool Names

		$VirtualServerDefaultPoolList = New-Object 'System.Collections.Generic.List[Lextm.SharpSnmpLib.Variable]'

		[Lextm.SharpSnmpLib.Messaging.Messenger]::Walk($ver, $svr, $DeviceCommunityList[$i], $ltmVsDefaultPool, $VirtualServerDefaultPoolList, 3000, $walkMode)

		Write-Host "Pools" : $VirtualServerDefaultPoolList.Count



		# Get VirtualServer Enabled State from SNMP

		$VirtualServerEnabledStateList = New-Object 'System.Collections.Generic.List[Lextm.SharpSnmpLib.Variable]'

		[Lextm.SharpSnmpLib.Messaging.Messenger]::Walk($ver, $svr, $DeviceCommunityList[$i], $ltmVsStatusEnabledState, $VirtualServerEnabledStateList, 3000, $walkMode)



		# Get VirtualServer Availability State from SNMP

		$VirtualServerAvailabilityStateList = New-Object 'System.Collections.Generic.List[Lextm.SharpSnmpLib.Variable]'

		[Lextm.SharpSnmpLib.Messaging.Messenger]::Walk($ver, $svr, $DeviceCommunityList[$i], $ltmVsStatusAvailState, $VirtualServerAvailabilityStateList, 3000, $walkMode)



		# Get VirtualServer DetailedReason from SNMP

		$VirtualServerDetailedReasonList = New-Object 'System.Collections.Generic.List[Lextm.SharpSnmpLib.Variable]'

		[Lextm.SharpSnmpLib.Messaging.Messenger]::Walk($ver, $svr, $DeviceCommunityList[$i], $ltmVsStatusDetailedReason, $VirtualServerDetailedReasonList, 3000, $walkMode)



		# Loop Through Results

		For($i=0; $i -lt $VirtualServerNameList.Count; $i++) {

			[int]$VirtualServerEnabledState = $VirtualServerEnabledStateList[$i].Data.ToString()



			# Only Get Enabled Virtual Servers

			If ($VirtualServerEnabledState -eq 1){

				[string]$VirtualServerName = $VirtualServerNameList[$i].Data.ToString()

				[string]$DefaultPoolName = $VirtualServerDefaultPoolList[$i].Data.ToString()

				[int]$VirtualServerAvailabilityState = $VirtualServerAvailabilityStateList[$i].Data.ToString()

				[string]$VirtualServerDetailedReason = $VirtualServerDetailedReasonList[$i].Data.ToString()



				#Create a property bag.

				[string] $message = "Creating Property bag for : " + $VirtualServerName + "`r`nAvailability State : " + $VirtualServerAvailabilityState + "`r`nDetailed Reason : " + $VirtualServerDetailedReason

				Log-DebugEvent $SCRIPT_PROPERTYBAG_CREATED $message

				$bag = $api.CreatePropertyBag()

				$bag.AddValue("VirtualServerName", $VirtualServerName)

				$bag.AddValue("DefaultPoolName", $DefaultPoolName)

				$bag.AddValue("AvailabilityState", $VirtualServerAvailabilityState)

				$bag.AddValue("DetailedReason", $VirtualServerDetailedReason)

				#$api.Return($bag)

				$bag		

			}



		}

		# All Done So Don't try any more devices

		break	



	}

	Catch {

		$message = "SNMP Server : $DeviceAddress" + "`r`nSNMP Port : " + $DevicePort + "`r`nSNMP Community : " + $DeviceCommunity + "`r`nSharpSnmp Location : " + $SharpSnmpLocation + "`r`nError : $_"

		Log-DebugEvent $SCRIPT_ERROR $message

	}

}

# Get End Time For Script

$EndTime = (GET-DATE)

$TimeTaken = NEW-TIMESPAN -Start $StartTime -End $EndTime

$Seconds = [math]::Round($TimeTaken.TotalSeconds, 2)

# Log Finished Message

Log-DebugEvent $SCRIPT_ENDED "Script Finished. Took $Seconds Seconds to Complete!"</Script></ScriptBody>

          <SnapIns/>

          <Parameters>

            <Parameter>

              <Name>DeviceAddresses</Name>

              <Value>$Config/DeviceAddresses$</Value>

            </Parameter>

            <Parameter>

              <Name>DevicePorts</Name>

              <Value>$Config/DevicePorts$</Value>

            </Parameter>

            <Parameter>

              <Name>DeviceCommunities</Name>

              <Value>$Config/DeviceCommunities$</Value>

            </Parameter>

            <Parameter>

              <Name>debug</Name>

              <Value>$Config/Debug$</Value>

            </Parameter>

            <Parameter>

              <Name>SharpSnmpLocation</Name>

              <Value>$FileResource[Name="AP.F5.LTM.SharpSnmpLib"]/Path$</Value>

            </Parameter>

          </Parameters>

          <TimeoutSeconds>60</TimeoutSeconds>

        </ProbeAction>

      </MemberModules>

      <Composition>

        <Node ID="PSScript"/>

      </Composition>

    </Composite>

  </ModuleImplementation>

  <OutputType>System!System.PropertyBagData</OutputType>

  <TriggerOnly>true</TriggerOnly>

</ProbeActionModuleType>