Public/Get-RabbitMQQueue.ps1
|
<# .Synopsis Gets open RabbitMQ Channels. .DESCRIPTION The Get-RabbitMQQueue cmdlet gets queues registered with RabbitMQ server. The cmdlet allows you to show list of all queues or filter them by name using wildcards. The result may be zero, one or many RabbitMQ.Queue objects. To get Queues from remote server you need to provide -HostName parameter. The cmdlet is using REST Api provided by RabbitMQ Management Plugin. For more information go to: https://www.rabbitmq.com/management.html .EXAMPLE Get-RabbitMQQueue This command gets a list of all queues reigsters with local RabbitMQ server. .EXAMPLE Get-RabbitMQQueue -HostName myrabbitmq.servers.com This command gets a list of all queues registerd with myrabbitmq.servers.com server. .EXAMPLE Get-RabbitMQQueue services* This command gets a list of all queues which name starts with "services". .EXAMPLE Get-RabbitMQQueue -VirtualHost vhost1 This command gets a list of all queues in Virtual Host "vhost1". .EXAMPLE Get-RabbitMQQueue -NotEmpty This command gets a list of all queues having messages. .EXAMPLE Get-RabbitMQQueue -ShowStats This command shows queue statistics. It is equivalent to running Get-RabbitMQQueue | Format-Table -View Stats .EXAMPLE @("services*", "posion*") | Get-RabbitMQQueue This command pipes queue name filters to Get-RabbitMQQueue cmdlet. .INPUTS You can pipe queue Name, VirtualHost and HostName to filter the results. .OUTPUTS By default, the cmdlet returns list of RabbitMQ.Queue objects which describe RabbitMQ queue. .LINK https://www.rabbitmq.com/management.html - information about RabbitMQ management plugin. #> function Get-RabbitMQQueue { [CmdletBinding(SupportsShouldProcess=$true, ConfirmImpact='None')] Param ( # Name of RabbitMQ queue. [parameter(ValueFromPipeline=$true, ValueFromPipelineByPropertyName=$true)] [Alias("queue", "QueueName")] [string[]]$Name = "", # Name of the computer hosting RabbitMQ server. Defalut value is localhost. [parameter(ValueFromPipelineByPropertyName=$true)] [Alias("HostName", "hn", "cn")] [string]$BaseUri = $defaultComputerName, # Name of the virtual host to filter channels by. [parameter(ValueFromPipelineByPropertyName=$true)] [Alias("vh", "vhost")] [string]$VirtualHost, # When set then returns only queues which have messages. [switch]$NotEmpty, # When set then displays queue statistics. [switch]$ShowStats, # Credentials to use when logging to RabbitMQ server. [Parameter(Mandatory=$false)] [PSCredential]$Credentials = $defaultCredentials ) Begin { } Process { if ($pscmdlet.ShouldProcess("server $BaseUri", "Get queues(s): $(NamesToString $Name '(all)')")) { $result = GetItemsFromRabbitMQApi -BaseUri $BaseUri $Credentials "queues" $result = ApplyFilter $result 'name' $Name if ($VirtualHost) { $result = ApplyFilter $result 'vhost' $VirtualHost } foreach ($item in $result) { if ($item.messages -eq $null) { $item | Add-Member -MemberType NoteProperty -Name messages -Value 0 } if ($item.messages_ready -eq $null) { $item | Add-Member -MemberType NoteProperty -Name messages_ready -Value 0 } if ($item.messages_unacknowledged -eq $null) { $item | Add-Member -MemberType NoteProperty -Name messages_unacknowledged -Value 0 } } if ($NotEmpty) { $result = $result | ? messages -ne 0 } $result | Add-Member -NotePropertyName "HostName" -NotePropertyValue $BaseUri if ($ShowStats) { SendItemsToOutput $result "RabbitMQ.Queue" | ft -View Stats } else { SendItemsToOutput $result "RabbitMQ.Queue" } } } End { } } |