Ps TMM Statistics

Problem this snippet solves:

This application will look into the insides of the TMOS processes on the system and dump out the available statistics exposed in the System.Statistics.get_tmm_statistics() method.

Continuing on with my series of applications on system level statistics, this application will look into the insides of the TMOS processes on the system and dump out the available statistics exposed in the System.Statistics.get_tmm_statistics() method.

Code :

#----------------------------------------------------------------------------
# The contents of this file are subject to the "END USER LICENSE AGREEMENT FOR F5
# Software Development Kit for iControl"; you may not use this file except in
# compliance with the License. The License is included in the iControl
# Software Development Kit.
#
# Software distributed under the License is distributed on an "AS IS"
# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
# the License for the specific language governing rights and limitations
# under the License.
#
# The Original Code is iControl Code and related documentation
# distributed by F5.
#
# The Initial Developer of the Original Code is F5 Networks,
# Inc. Seattle, WA, USA. Portions created by F5 are Copyright (C) 1996-2007 F5 Networks,
# Inc. All Rights Reserved.  iControl (TM) is a registered trademark of F5 Networks, Inc.
#
# Alternatively, the contents of this file may be used under the terms
# of the GNU General Public License (the "GPL"), in which case the
# provisions of GPL are applicable instead of those above.  If you wish
# to allow use of your version of this file only under the terms of the
# GPL and not to allow others to use your version of this file under the
# License, indicate your decision by deleting the provisions above and
# replace them with the notice and other provisions required by the GPL.
# If you do not delete the provisions above, a recipient may use your
# version of this file under either the License or the GPL.
#----------------------------------------------------------------------------
param (
  $g_bigip = $null,
  $g_uid = $null,
  $g_pwd = $null
);

Set-PSDebug -strict;

#-------------------------------------------------------------------------
# function Write-Usage
#-------------------------------------------------------------------------
function Write-Usage()
{
  Write-Host "Usage: GlobalIPStats.ps1 host uid pwd";
  exit;
}

#-------------------------------------------------------------------------
# function Get-TimeFromTimeStamp
#-------------------------------------------------------------------------
function Get-TimeFromTimeStamp()
{
  param ($TimeStamp);
  $dt = new-object -typename System.DateTime
  $dt = $dt.AddYears($TimeStamp.year-1).AddMonths($TimeStamp.month-1).AddDays($TimeStamp.day-1);
  $dt = $dt.AddHours($TimeStamp.hour).AddMinutes($TimeStamp.minute).AddSeconds($TimeStamp.second);
  return $dt;
}

#-------------------------------------------------------------------------
# function Convert-To64Bit
#-------------------------------------------------------------------------
function Convert-To64Bit()
{
  param($high, $low);
  return ($high*[Math]::Pow(2,32))+$low;
}


#-------------------------------------------------------------------------
# function Process-TMMStatisticEntry
#-------------------------------------------------------------------------
function Process-TMMStatisticEntry()
{
  param($TMMStatisticEntry);
  
  $stat_obj = New-Object -TypeName System.Object;
  
  $stat_obj | Add-Member -Type noteProperty -Name "Time Stamp" $t;
  $stat_obj | Add-Member -Type noteProperty -Name "--------------------------------" "";
  
  $Statistics = $TMMStatisticEntry.statistics;

  foreach($Statistic in $Statistics)
  {
    $val = Convert-To64Bit $Statistic.value.high $Statistic.value.low;
    switch ($Statistic.type)
    {
      "STATISTIC_TM_PID" {
        $label = "TMOS Processing Agent Process ID";
      }
      "STATISTIC_TM_CPU" {
        $label = "TMOS Processing Agent CPU #";
      }
      "STATISTIC_TM_TMID" {
        $label = "TMOS Processing Agent Instance";
      }
      "STATISTIC_TM_NPUS" {
        $label = "TMOS Processing Agent count";
      }
      "STATISTIC_CLIENT_SIDE_BYTES_IN" {
        $label = "Bytes - Client Side In";
      }
      "STATISTIC_CLIENT_SIDE_BYTES_OUT" {
        $label = "Bytes - Client Side Out";
      }
      "STATISTIC_CLIENT_SIDE_PACKETS_IN" {
        $label = "Packets - Client Side In";
      }
      "STATISTIC_CLIENT_SIDE_PACKETS_OUT" {
        $label = "Packets - Client Side Out";
      }
      "STATISTIC_CLIENT_SIDE_CURRENT_CONNECTIONS" {
        $label = "Connections - Client Side Current";
      }
      "STATISTIC_CLIENT_SIDE_MAXIMUM_CONNECTIONS" {
        $label = "Connections - Client Side Max";
      }
      "STATISTIC_CLIENT_SIDE_TOTAL_CONNECTIONS" {
        $label = "Connections - Client Side Total";
      }
      "STATISTIC_SERVER_SIDE_BYTES_IN" {
        $label = "Bytes - Server Side In";
      }
      "STATISTIC_SERVER_SIDE_BYTES_OUT" {
        $label = "Bytes - Server Side Out";
      }
      "STATISTIC_SERVER_SIDE_PACKETS_IN" {
        $label = "Packets - Server Side In";
      }
      "STATISTIC_SERVER_SIDE_PACKETS_OUT" {
        $label = "Packets - Server Side Out";
      }
      "STATISTIC_SERVER_SIDE_CURRENT_CONNECTIONS" {
        $label = "Connections - Server Side Current";
      }
      "STATISTIC_SERVER_SIDE_MAXIMUM_CONNECTIONS" {
        $label = "Packets - Server Side Max";
      }
      "STATISTIC_SERVER_SIDE_TOTAL_CONNECTIONS" {
        $label = "Packets - Server Side Total";
      }
      "STATISTIC_TM_TOTAL_CYCLES" {
        $label = "TMOS Total CPU Cycles";
      }
      "STATISTIC_TM_IDLE_CYCLES" {
        $label = "TMOS Idle CPU Cycles";
      }
      "STATISTIC_TM_SLEEP_CYCLES" {
        $label = "TMOS Yielded CPU Cycles";
      }
      "STATISTIC_MAINTENANCE_MODE_DENIALS" {
        $label = "Connections - Denials due To Maintenance";
      }
      "STATISTIC_VIRTUAL_ADDRESS_MAXIMUM_CONNECTION_DENIALS" {
        $label = "Connections - Denials Due To Address Limits";
      }
      "STATISTIC_VIRTUAL_SERVER_MAXIMUM_CONNECTION_DENIALS" {
        $label = "Connections - Denials Due To VS Limits";
      }
      "STATISTIC_VIRTUAL_SERVER_NON_SYN_DENIALS" {
        $label = "Packets - Denials Due To SYN Attacks";
      }
      "STATISTIC_NO_HANDLER_DENIALS" {
        $label = "Packets - Denials Due To No Handlers";
      }
      "STATISTIC_LICENSE_DENIALS" {
        $label = "Packets - Denials Due to License Restrictions";
      }
      "STATISTIC_TM_CMP_CONN_REDIRECTED" {
        $label = "Connections - Redirected To Other CMP Processing Agent";
      }
      "STATISTIC_CONNECTION_FAILED_MEMORY_ERRORS" {
        $label = "Connection - Dropped Due To Memory Contstraints";
      }
      "STATISTIC_MEMORY_TOTAL_BYTES" {
        $label = "Memory - TMM Total";
      }
      "STATISTIC_MEMORY_USED_BYTES" {
        $label = "Memory - TMM Used";
      }
      "STATISTIC_DROPPED_PACKETS_TOTAL" {
        $label = "Packets - Total Dropped";
      }
      "STATISTIC_ERRORS_IN" {
        $label = "Errors on Ingress";
      }
      "STATISTIC_ERRORS_OUT" {
        $label = "Errors on Egress";
      }
      "STATISTIC_HTTP_TOTAL_REQUESTS" {
        $label = "Requests - Total HTTP Requests";
      }
      default {
$type = $Statistic.type;
Write-Error "Label '$type' not found"
      }
    }
    #Write-Host "$label : $val"
    $stat_obj | Add-Member -Type noteProperty -Name $label $val;
  }
  $stat_obj | format-list
}

#-------------------------------------------------------------------------
# Get-TMMStatistics
#-------------------------------------------------------------------------
function Get-TMMStatistics()
{
  param($subset = $null);
  if ( $subset -eq $null ) { $subset = "all"; }
  
  Write-Host "TMM Statistics"
  
  $TMMStatistics = (Get-F5.iControl).SystemStatistics.get_all_tmm_statistics();
  $t = Get-TimeFromTimeStamp $TMMStatistics.time_stamp;
  $Statistics = $TMMStatistics.statistics;
  
  foreach($TMMStatisticEntry in $Statistics)
  {
Process-TMMStatisticEntry $TMMStatisticEntry
  }
}

#-------------------------------------------------------------------------
# Do-Initialize
#-------------------------------------------------------------------------
function Do-Initialize()
{
  if ( (Get-PSSnapin | Where-Object { $_.Name -eq "iControlSnapIn"}) -eq $null )
  {
    Add-PSSnapIn iControlSnapIn
  }
  $success = Initialize-F5.iControl -HostName $g_bigip -Username $g_uid -Password $g_pwd;
  
  return $success;
}

#-------------------------------------------------------------------------
# Main Application Logic
#-------------------------------------------------------------------------
if ( ($g_bigip -eq $null) -or ($g_uid -eq $null) -or ($g_pwd -eq $null) )
{
  Write-Usage;
}

if ( Do-Initialize )
{
  Get-TMMStatistics;
}
else
{
  Write-Error "ERROR: iControl subsystem not initialized"
}