Public/Get-BlueCatZone.ps1
|
function Get-BlueCatZone { <# .SYNOPSIS Retrieve a DNS Zone definition .DESCRIPTION The Get-BlueCatZone cmdlet allows the retrieval of DNS Zone definitions. .PARAMETER Name A string value representing the FQDN of the Zone definition to be retrieved. .PARAMETER ViewID An integer value representing the entity ID of the desired view. .PARAMETER View A PSCustomObject representing the desired view. .PARAMETER BlueCatSession A BlueCat object representing the session to be used for this object lookup. .EXAMPLE PS> Get-BlueCatZone -Name example.com Returns a PSCustomObject representing the requested zone definition, or NULL if not found. BlueCatSession will default to the current default session. View will default to the BlueCatSession default view. .EXAMPLE PS> Get-BlueCatZone -Name anotherzone.com -ViewID 23456 -BlueCatSession $Session3 Returns a PSCustomObject representing the requested zone definition, or NULL if not found. Use the BlueCatSession associated with $Session3 to perform this lookup. The record will be searched for in view 23456. .INPUTS None .OUTPUTS PSCustomObject representing the requested zone definition, or NULL if not found. [int] id [string] name [string] shortName [string] type = 'Zone' [string] properties [PSCustomObject] property [PSCustomObject] config [PSCustomObject] view #> [CmdletBinding(DefaultParameterSetName='byID')] param( [parameter(Mandatory)] [Alias('Zone')] [string] $Name, [Parameter(ParameterSetName='byID')] [ValidateRange(1, [int]::MaxValue)] [int]$ViewID, [Parameter(ParameterSetName='byObj',Mandatory)] [ValidateNotNullOrEmpty()] [PSCustomObject] $View, [Parameter()] [Alias('Connection','Session')] [BlueCat]$BlueCatSession = $Script:BlueCatSession ) begin { Get-CallerPreference -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState if (-not $BlueCatSession) { throw 'No active BlueCatSession found' } } process { $thisFN = (Get-PSCallStack)[0].Command if ($ViewID) { $View = Get-BlueCatView -ViewID $ViewID -BlueCatSession $BlueCatSession } elseif (-not $View) { # No View or ViewID has been passed in so attempt to use the default view $BlueCatSession | Confirm-Settings -View Write-Verbose "$($thisFN): Using default view '$($BlueCatSession.View.name)' (ID:$($BlueCatSession.View.id))" $View = $BlueCatSession.View } if (-not $View) { throw "$($thisFN): View could not be resolved" } if (-not $View.ID) { # This is not a valid object! throw "$($thisFN): Invalid View object passed to function!" } if ($View.type -ne 'View') { throw "$($thisFN): Object is not a View (ID:$($View.ID) $($View.name) is a $($View.type))" } $Zone = $Name | Test-ValidFQDN $zPath = $Zone.Split('\.') [array]::Reverse($zPath) $zId = $View.id foreach ($bit in $zPath) { $Query = "getEntityByName?parentId=$($zId)&type=Zone&name=$($bit)" $BlueCatReply = Invoke-BlueCatApi -Method Get -Request $Query -BlueCatSession $BlueCatSession if (-not $BlueCatReply.id) { break } $zId = $BlueCatReply.id } if ($BlueCatReply.id) { # Build the full object $PropertyObj = $BlueCatReply.properties | Convert-BlueCatPropertyString $ZoneObj = [PSCustomObject] @{ id = $BlueCatReply.id name = $PropertyObj.absoluteName type = $BlueCatReply.type shortName = $BlueCatReply.name deployable = $PropertyObj.deployable property = $PropertyObj properties = $BlueCatReply.properties view = $View config = $View.config } Write-Verbose "$($thisFN): Selected #$($ZoneObj.id) as '$($ZoneObj.name)'" # Return the Zone object to caller $ZoneObj } else { # No object was returned $Failure = "$($thisFN): Zone $($Zone) not found!" throw $Failure Write-Verbose $Failure } } } |