Percent Memory Used Module Type

Microsoft.Windows.Server.10.0.OperatingSystem.PercentMemoryUsed.ModuleType (DataSourceModuleType)

Data Source module type for collecting amount of used physical memory.

Element properties:

Member Modules:

Overrideable Parameters:

Source Code:

<DataSourceModuleType ID="Microsoft.Windows.Server.10.0.OperatingSystem.PercentMemoryUsed.ModuleType" Accessibility="Public" Batching="false">

  <Configuration>

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

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

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

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

  </Configuration>

  <OverrideableParameters>

    <OverrideableParameter ID="Tolerance" Selector="$Config/Tolerance$" ParameterType="int"/>

    <OverrideableParameter ID="Frequency" Selector="$Config/Frequency$" ParameterType="int"/>

    <OverrideableParameter ID="NumOfSamples" Selector="$Config/MaximumSampleSeparation$" ParameterType="int"/>

  </OverrideableParameters>

  <ModuleImplementation Isolation="Any">

    <Composite>

      <MemberModules>

        <DataSource ID="PerfDS" TypeID="SystemPerf!System.Performance.OptimizedDataProvider">

          <CounterName>Available MBytes</CounterName>

          <ObjectName>Memory</ObjectName>

          <InstanceName/>

          <AllInstances>false</AllInstances>

          <Frequency>$Config/Frequency$</Frequency>

          <Tolerance>$Config/Tolerance$</Tolerance>

          <ToleranceType>Absolute</ToleranceType>

          <MaximumSampleSeparation>$Config/MaximumSampleSeparation$</MaximumSampleSeparation>

        </DataSource>

        <ProbeAction ID="ScriptDS" TypeID="Windows!Microsoft.Windows.PowerShellPropertyBagProbe">

          <ScriptName>Microsoft.Windows.Server.OperatingSystem.PercentMemoryUsed.ps1</ScriptName>

          <ScriptBody><Script>

                                    

                param ($nAvailableMBytes, $nPhysicalMemoryKBytes)

                

$ErrorActionPreference = "Stop"



# Event type constants

$EVENT_TYPE_LOG = 0

$EVENT_TYPE_ERROR = 1

$EVENT_TYPE_WARNING = 2

$EVENT_TYPE_INFORMATION = 4



# Typed property bag constants

$PROPERTY_TYPE_ALERT = 0

$PROPERTY_TYPE_EVENT = 1

$PROPERTY_TYPE_PERFORMANCE = 2

$PROPERTY_TYPE_STATE = 3



# State type constants

$STATE_SUCCESS = "Success"

$STATE_WARNING = "Warning"

$STATE_ERROR = "Error"



$momAPI = new-object -comObject MOM.ScriptAPI

Import-Module CimCmdlets # Workaround to force load CIM cmdlets



# WMI Constant

$wbemCimtypeUseDefault        = 0   #Use Default Type CIM type - Custom

$wbemCimtypeSint16            = 2   #Signed 16-bit integer 

$wbemCimtypeSint32            = 3   #Signed 32-bit integer 

$wbemCimtypeReal32            = 4   #32-bit real number 

$wbemCimtypeReal64            = 5   #64-bit real number 

$wbemCimtypeString            = 8   #String 

$wbemCimtypeBoolean           = 11  #Boolean value 

$wbemCimtypeObject            = 13  #CIM object 

$wbemCimtypeSint8             = 16  #Signed 8-bit integer 

$wbemCimtypeUint8             = 17  #Unsigned 8-bit integer 

$wbemCimtypeUint16            = 18  #Unsigned 16-bit integer 

$wbemCimtypeUint32            = 19  #Unsigned 32-bit integer 

$wbemCimtypeSint64            = 20  #Signed 64-bit integer  

$wbemCimtypeUint64            = 21  #Unsigned 64-bit integer 

$wbemCimtypeDatetime          = 101 #Date/time value 

$wbemCimtypeReference         = 102 #Reference to a CIM object 

$wbemCimtypeChar16            = 103 #16-bit character 



$ErrAction_None               = 0

$ErrAction_Trace              = 1

$ErrAction_ThrowError         = 16

$ErrAction_Abort              = 32

$ErrAction_ThrowErrorAndAbort = 48



$DISKSIZE_BYTES_IN_MB = 1048576



$g_ErrorEventNumber = 4001

$g_TraceEventNumber = 4002

$g_DebugFlag = $false



#---------------------------------------------------------------------------

# Returns WMI Instance requested. Tries to execute WMI query a N times.

#---------------------------------------------------------------------------

Function WMIGetInstanceExTryN

{

    param ([string]$sTargetComputer,

           [string]$sNamespace,

           [string]$sInstanceQuery, 

           [int]$N)



    for ($i = 0; $i -lt $N; $i++)

    {

        $error.Clear();

        $oInstance = Get-CimInstance -ComputerName $sTargetComputer -Namespace $sNamespace -Query ("Select * from "+$sInstanceQuery) -ErrorAction SilentlyContinue

        if ($error.Count -gt 0)

        {

            if ($i -eq ($N-1))

            {

                ThrowScriptError ("The class name '" + $sInstanceQuery + "' returned no instances.  Please check to see if this is a valid WMI class name.") $error[0]

            }

        }

        else

        {

            break;

        }

        sleep -m 1000

    }



    return $oInstance

}



#---------------------------------------------------------------------------

# Returns WMI Instance requested.

#---------------------------------------------------------------------------

Function WMIGetInstanceEx

{

    param ([string]$sTargetComputer,

           [string]$sNamespace,

           [string]$sInstanceQuery)



    $error.Clear();

    $oInstance = Get-CimInstance -ComputerName $sTargetComputer -Namespace $sNamespace -Query ("Select * from "+$sInstanceQuery) -ErrorAction SilentlyContinue

    if ($error.Count -gt 0)

    {

        ThrowScriptError ("The class name '" + $sInstanceQuery + "' returned no instances.  Please check to see if this is a valid WMI class name.") $error[0]

    }



    return $oInstance

}



#---------------------------------------------------------------------------

# Connect to WMI.

#---------------------------------------------------------------------------

Function WMIConnect

{

    param ([string]$sTargetComputer,

           [string]$sNamespace)



    $error.Clear()



    # !!! Refactoring comment: 

    # Original VBScript only tries to connect to the namespace. Piping to get only the first one saves time. 

    $oWMI = Get-CimClass -ComputerName $sTargetComputer -Namespace $sNamespace -ErrorAction SilentlyContinue | select -First 1

    if ($error.Count -gt 0)

    {

        $msg = "Unable to open WMI Namespace 'winmgmts:\\" + $sTargetComputer + "\" + $sNamespace + "'. Check to see if the WMI service is enabled and running, and ensure this WMI namespace exists."

        ThrowScriptError $msg $error[0]

    }

}



#---------------------------------------------------------------------------

# Returns WMI Instance requested.

#---------------------------------------------------------------------------

Function WMIGetInstance

{

    param ([string]$sTargetComputer,

           [string]$sNamespace,

           [string]$sInstanceQuery)



    WMIConnect $sTargetComputer $sNamespace

    $oInstance = WMIGetInstanceEx $sTargetComputer $sNamespace $sInstanceQuery

    return $oInstance

}



#---------------------------------------------------------------------------

# Returns WMI Instance requested.

#---------------------------------------------------------------------------

Function WMIGetInstanceNoAbort

{

    param ([string]$sTargetComputer,

           [string]$sNamespace,

           [string]$sInstanceQuery)



    $oInstance = Get-CimInstance -ComputerName $sTargetComputer -Namespace $sNamespace -Query ("Select * from "+$sInstanceQuery) -ErrorAction SilentlyContinue



    return $oInstance

}



#---------------------------------------------------------------------------

# Executes the WMI query and returns the result set.

#---------------------------------------------------------------------------

Function WMIExecQuery

{

    param ([string]$sTargetComputer,

           [string]$sNamespace,

           [string]$sQuery)



    $error.Clear()



    # !!! Refactoring comment: 

    # Original VBScript only tries to connect to the namespace. Piping to get only the first one saves time. 

    $oWMI = Get-CimClass -ComputerName $sTargetComputer -Namespace $sNamespace -ErrorAction SilentlyContinue | select -First 1

    if ($error.Count -gt 0)

    {

        $msg = "Unable to open WMI Namespace 'winmgmts:\\" + $sTargetComputer + "\" + $sNamespace + "'. Check to see if the WMI service is enabled and running, and ensure this WMI namespace exists."

        ThrowScriptError $msg, $error[0]

    }



    $oQuery = Get-CimInstance -ComputerName $sTargetComputer -Namespace $sNamespace -Query $sQuery -ErrorAction SilentlyContinue

    if ($error.Count -gt 0)

    {

        ThrowScriptError ("The Query '" + $sQuery + "' returned an invalid result set.  Please check to see if this is a valid WMI Query.") $error[0]

    }



    return $oQuery

}



#---------------------------------------------------------------------------

# Executes the WMI query and returns the result set, no abort version.

#---------------------------------------------------------------------------

Function WMIExecQueryNoAbort

{

    param ([string]$sTargetComputer,

           [string]$sNamespace,

           [string]$sQuery)    

    

    $oQuery = Get-CimInstance -ComputerName $sTargetComputer -Namespace $sNamespace -Query $sQuery -ErrorAction SilentlyContinue



    return $oQuery

}



#---------------------------------------------------------------------------

# Creates an event and sends it back to the mom server.

#---------------------------------------------------------------------------

Function ThrowScriptErrorNoAbort

{

    param ([string]$sMessage, 

           [System.Management.Automation.ErrorRecord]$oErr)

    # Retrieve the name of this (running) script

    $ScriptFileName = $MyInvocation.ScriptName

    

    if ($oErr -ne $null)

    {

        $sMessage = $sMessage + ". " + $oErr.ErrorDetails

    }

    

    $momAPI.LogScriptEvent($ScriptFileName, $g_ErrorEventNumber, $EVENT_TYPE_ERROR, $sMessage)

    

    Write-Host $sMessage

}



#---------------------------------------------------------------------------

# Creates an event and sends it back to the mom server.

#---------------------------------------------------------------------------

Function ThrowScriptError

{

    param ([string]$sMessage, 

           [System.Management.Automation.ErrorRecord]$oErr)

    ThrowScriptErrorNoAbort $sMessage $oErr

    exit

}



#---------------------------------------------------------------------------

# Verifies that number of arguments is correct

#---------------------------------------------------------------------------

Function VerifyNumberOfArguments

{

    param ($NumberOfArguments)



    if ($args.Length -ne $NumberOfArguments)

    {

       $sArgs = ""

       foreach ($argument in $args)

       {

           $sArgs += " {" + $argument + "}"

       }

       ThrowScriptError ("Invalid number of arguments (" + $args.Length + " instead of " + $NumberOfArguments + "). Arguments:" + $sArgs) $null

    }

}



#---------------------------------------------------------------------------

# Outputs to file and echo for debugging purposes

#---------------------------------------------------------------------------

Function TraceLogMessage

{

    param ([string]$sMessage)



    Write-Host $sMessage

    

    If ($g_DebugFlag -eq $true)

    {

        # Retrieve the name of this (running) script

        $ScriptFileName = $MyInvocation.ScriptName

        

        $momAPI.LogScriptEvent($ScriptFileName, $g_TraceEventNumber, $EVENT_TYPE_INFORMATION, $sMessage)

    }

}



#---------------------------------------------------------------------------

# Verifies the expression. If equals to False then generates an error and quits the script

#   Usage:

#     Verify Not WMISet Is Nothing, "WMISet is invalid!"

#     Verify WMISet.Count = 1, "Invalid quantity of services with name 'Server' (qty = " &amp; WMISet.Count &amp; ")."

#---------------------------------------------------------------------------

Function Verify

{

    param ([bool]$bBool, 

           [string]$sMessage)



    If ($bBool -eq $false)

    {

        ThrowScriptError $sMessage $null

    }

}



Function GetRegistryKeyValue

{

    param ([string]$keyPath, 

           [string]$key)



    $error.Clear()



    $strKeyValue = Get-ItemProperty -Path $keyPath -Name $key -ErrorAction SilentlyContinue

    if ($error.Count -gt 0)

    {

        ThrowScriptError ("An error occurred while reading the registry: '" + $keyPath + $key + "'") $error[0]

    }

    return $strKeyValue.$key

}





#---------------------------------------------------------------------------

# Function: ExpressedInMB

#   Usage:

#     Parameter (SizeInBytes) 

#     Returns the Size Expressed in MBytes

#---------------------------------------------------------------------------

Function ExpressedInMB

{

    param ($SizeInBytes)



    $NumberSizeExpInMB = [math]::Round($SizeInBytes / $DISKSIZE_BYTES_IN_MB, 0)

    return $NumberSizeExpInMB

}





#Copyright (c) Microsoft Corporation. All rights reserved.



#*************************************************************************

# $ScriptName: "Microsoft.Windows.Server.OperatingSystem.PercentMemoryUsed"$

#

#

# $File: Microsoft.Windows.Server.OperatingSystem.PercentMemoryUsed.ps1$

#*************************************************************************



# Parameters that should be passed to this script

# 0 Available Physical memory MBytes.

# 1 Total amount of Physical Memory in KBytes.



$sCounterName = "PercentMemoryUsed"

$sObjectName  = "Memory"



Function Main()

{

    $sErrorDescription = "Invalid arguments are detected: " + $nAvailableMBytes + " " + $nPhysicalMemoryKBytes

    $dblAvailableMBytes = $nAvailableMBytes -as [double]

    $dblPhysicalMemoryKBytes = $nPhysicalMemoryKBytes -as [double]



    if (($dblAvailableMBytes -eq $null) -or ($dblPhysicalMemoryKBytes -eq $null))

    {

        ThrowScriptError $sErrorDescription $null

    }



    $dblPhysicalMemoryMBytes = $dblPhysicalMemoryKBytes / 1024



    if ($dblAvailableMBytes -gt 0)

    {

        if ($dblAvailableMBytes -ge $dblPhysicalMemoryMBytes)

        {

            ThrowScriptError $sErrorDescription $null

        }



        $oBag = $momAPI.CreateTypedPropertyBag(2)



        $nResult = [double](100 - ($dblAvailableMBytes/$dblPhysicalMemoryMBytes)*100)



        $oBag.AddValue("PerfCounter", $sCounterName)

        $oBag.AddValue("PerfValue", $nResult)



        $oBag

    }

}



Main

</Script></ScriptBody>

          <Parameters>

            <Parameter>

              <Name>nAvailableMBytes</Name>

              <Value>$Data/Value$</Value>

            </Parameter>

            <Parameter>

              <Name>nPhysicalMemoryKBytes</Name>

              <Value>$Config/PhysicalMemory$</Value>

            </Parameter>

          </Parameters>

          <TimeoutSeconds>300</TimeoutSeconds>

        </ProbeAction>

        <ConditionDetection ID="PerfMapper" TypeID="SystemPerf!System.Performance.DataGenericMapper">

          <ObjectName>Memory</ObjectName>

          <CounterName>$Data/Property[@Name='PerfCounter']$</CounterName>

          <InstanceName/>

          <Value>$Data/Property[@Name='PerfValue']$</Value>

        </ConditionDetection>

        <ConditionDetection ID="IsNullCD" TypeID="System!System.ExpressionFilter">

          <Expression>

            <SimpleExpression>

              <ValueExpression>

                <XPathQuery Type="String">/DataItem/IsNull</XPathQuery>

              </ValueExpression>

              <Operator>Equal</Operator>

              <ValueExpression>

                <Value Type="String">false</Value>

              </ValueExpression>

            </SimpleExpression>

          </Expression>

        </ConditionDetection>

      </MemberModules>

      <Composition>

        <Node ID="PerfMapper">

          <Node ID="ScriptDS">

            <Node ID="IsNullCD">

              <Node ID="PerfDS"/>

            </Node>

          </Node>

        </Node>

      </Composition>

    </Composite>

  </ModuleImplementation>

  <OutputType>SystemPerf!System.Performance.Data</OutputType>

</DataSourceModuleType>