Public/Get-SWZone.ps1
|
function Get-SWZone { <# .SYNOPSIS Retrieve Zones from SonicWall appliance. .DESCRIPTION This function gets the Zones from a SonicWall appliance. .PARAMETER Name Name of the object to query. .EXAMPLE Get-SWZone Basic usage. Gets all the Zones from a SonicWall appliance. .EXAMPLE Get-SWZone -Name test Gets the Zone named 'test' #> [CmdletBinding()] param ( # Name of the zone [string]$Name ) begin { # Testing if a connection to SonicWall exists Test-SWConnection # Declaring used rest method $Method = 'get' # Declaring the base resource $BaseResource = 'zones' # Declaring the content type $ContentType = 'application/json' # Getting the base URL of our connection $SWBaseUrl = $env:SWConnection } process { # If a $Name exists limit the search to it if ($Name) { $Resource = "$BaseResource/name/$Name" $Result = (Invoke-RestMethod -Uri "$SWBaseUrl$Resource" -Method $Method -ContentType $ContentType).zone } # If there are no parameters query for all zones else { $Resource = $BaseResource $Result = (Invoke-RestMethod -Uri "$SWBaseUrl$Resource" -Method $Method -ContentType $ContentType).$BaseResource } # Return the result $Result } } |