Public/Get-VirtualServer.ps1

Function Get-VirtualServer{
    <#
        .SYNOPSIS
            Retrieve specified virtual server(s)
 
        .EXAMPLE
            #Retrieve all virtual servers with a list of assigned iRules for each
            $VS_iRules = Get-VirtualServer |
                ForEach {
                    New-Object psobject -Property @{
                        Name = $_.name;
                        Partition = $_.partition;
                        Rules = @{}
                    }
                }
 
            $VS_iRules | ForEach { $_.Rules = (Get-VirtualServer -Name $_.Name -Partition $_.Partition | Select-Object -ExpandProperty rules -ErrorAction SilentlyContinue ) }
 
    #>

    [cmdletBinding()]
    param (
        $F5Session=$Script:F5Session,

        [Alias("VirtualServerName")]
        [Parameter(Mandatory=$false,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true)]
        [string[]]$Name='',

        [Alias('iApp')]
        [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true)]
        [string]$Application='',

        [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true)]
        [string]$Partition,

        [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true)]
        [PoshLTM.F5Address[]]$Address

    )
    begin {
        #Test that the F5 session is in a valid format
        Test-F5Session($F5Session)

        Write-Verbose "NB: Virtual server names are case-specific."
    }
    process {

        foreach ($vsname in $Name) {

            $URI = $F5Session.BaseURL + 'virtual/{0}?expandSubcollections=true' -f (Get-ItemPath -Name $vsname -Application $Application -Partition $Partition)
            $JSON = Invoke-F5RestMethod -Method Get -Uri $URI -F5Session $F5Session
            if ($JSON.items -or $JSON.name) {
                $items = Invoke-NullCoalescing {$JSON.items} {$JSON}
                if(![string]::IsNullOrWhiteSpace($Application)) {
                    $items = $items | Where-Object {$_.fullPath -eq "/$($_.partition)/$Application.app/$($_.name)"}
                }

                #If an IP address was specified, filter the results by that
                If ($Address){
                    $items = $items | Where-Object {$_.Destination -match $Address}
                }

<#
    JN: the expandSubcollections=true param should be a better way to expand subcollections and so this subcollection expansion logic wouldn't be needed.
 
                #Unless requested subcollections will be included
                #Excluding subcollections has a significant performance increase
                If (!$ExcludeSubcollections) {
 
                    #Retrieve all subcollections' contents
                    $subcollections = [Array] $items | Get-Member -MemberType NoteProperty | % Name | % { $items.$_ } | Where { $_.isSubcollection -eq 'True' }
 
                    #Add properties for policies and profiles
                    $items | Add-Member -NotePropertyName 'policies' -NotePropertyValue @()
                    $items | Add-Member -NotePropertyName 'profiles' -NotePropertyValue @()
 
                    ForEach ($sub in $subcollections)
                    {
 
                        #Retrieve the virtual server name from the link
                        $tmpArray = [string]($sub.link) -split "/"
                        $tmpArray = ($tmpArray[$tmpArray.Length-2]).Split("~")
                        $virtualServerName = $tmpArray[$tmpArray.Length-1]
 
                        #Expand each subcollection
                        $JSON = Invoke-F5RestMethod -Method Get -Uri ($sub.link -replace 'localhost',$F5Session.Name) -F5Session $F5Session
 
                        #If the subcollection contains items, then add them to the JSON to return
                        #Make sure to add them to the corresponding virtual server
                        If ($JSON.items){
 
                            #Retrieve the name for the collection from the segment of the 'kind' value preceding the collection.
                            #JN: There may be a better way to determine this
                            $tmpArray = [string]($JSON.kind) -split ":"
                            $collName = [string]$tmpArray[$tmpArray.length-2]
 
                            #Add the contents of the subcollection
                            ($items | Where-Object Name -CContains $virtualServerName).$collName = $JSON.items
                        }
                    }
                } #End of subcollection gathering
#>

                $items | Add-ObjectDetail -TypeName 'PoshLTM.VirtualServer'
            }
        }
    }
}