PowerShell Software Status

Problem this snippet solves:

This example illustrates how to use the get_all_software_status method in the System SoftwareManagement interface.

Through the iControl interfaces, we've exposed many of the features on the BIG-IP. In this example, I'll illustrate the new System Software Status method in version BIG-IP version 10.1. This information can be found on the "System.Software Management.Image List" menu item on the BIG-IP management GUI. From this information you can determine the installed images on the BIG-IP as well as their active state and status of live software installs.

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-2010 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 (
  $bigip = $null,
  $uid = $null,
  $pwd = $null
)

Set-PSDebug -strict;

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

#-------------------------------------------------------------------------
function Write-Entry()
#-------------------------------------------------------------------------
{
  param([string]$name,
    [string]$value,
    [int]$width = 15);
  if ( $name.Length -gt 0 )
  {
    $fmt = "{0,$width}";
    if ( $value.Length -gt 0 )
    {
      $fmt += " : {1}";
    }
  }
  $fmt -f $name, $value;
}

#-------------------------------------------------------------------------
function Get-SystemSWStatus()
#-------------------------------------------------------------------------
{
  $SoftwareStatusA = (Get-F5.iControl).SystemSoftwareManagement.get_all_software_status();
  
  "==============================================="
  "             SYSTEM SOFTWARE STATUS            ";
  "-----------------------------------------------"
  "{0,10} : {1}" -f "Host", $bigip;
  
  foreach ($SoftwareStatus in $SoftwareStatusA)
  {
    "-----------------------------------------------"
    $installation_id = $SoftwareStatus.installation_id;
    Write-Entry "Chassis Slot Id" $installation_id.chassis_slot_id;
    Write-Entry "Install Volume" $installation_id.install_volume;
    Write-Entry "Product" $SoftwareStatus.product;
    Write-Entry "Version" $SoftwareStatus.version;
    Write-Entry "Build" $SoftwareStatus.build;
    Write-Entry "Base Build" $SoftwareStatus.base_build;
    Write-Entry "Active" $SoftwareStatus.active;
    Write-Entry "Edition" $SoftwareStatus.edition;
    Write-Entry "Status" $SoftwareStatus.status;
    "-----------------------------------------------"
  }
  "==============================================="
}

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

#-------------------------------------------------------------------------
# Main Application Logic
#-------------------------------------------------------------------------
if ( ($bigip -eq $null) -or ($uid -eq $null) -or ($pwd -eq $null) )
{
  Show-Usage;
}

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