Public/Get-BlueCatHost.ps1
|
function Get-BlueCatHost { <# .SYNOPSIS Retrieve a Host record (A/AAAA) .DESCRIPTION The Get-BlueCatHost cmdlet allows the retrieval of DNS A and AAAA records. .PARAMETER Name A string value representing the FQDN of the Host record 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-BlueCatHost -Name server1.example.com Returns a PSCustomObject representing the requested host record, or NULL if not found. BlueCatSession will default to the current default session. View will default to the BlueCatSession default view. .EXAMPLE PS> Get-BlueCatHost -Name server9.example.com -ViewID 23456 -BlueCatSession $Session3 Returns a PSCustomObject representing the requested host record, 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 host record, or NULL if not found. [int] id [string] name [string] shortName [string] type = 'HostRecord' [string] properties [PSCustomObject] property [PSCustomObject] config [PSCustomObject] view [PSCustomObject] zone #> [CmdletBinding(DefaultParameterSetName='ViewID')] param( [Parameter(Mandatory)] [ValidateNotNullOrEmpty()] [Alias('HostName')] [string] $Name, [Parameter(ParameterSetName='ViewID')] [ValidateRange(1, [int]::MaxValue)] [int] $ViewID, [Parameter(ParameterSetName='ViewObj',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 ($View) { # A view object has been passed in so test its validity if (-not $View.ID) { # This is not a valid view object! throw "Invalid View object passed to function!" } # Use the view ID from the View object $ViewID = $View.ID } if (-not $ViewID) { # No view ID 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))" $ViewID = $BlueCatSession.View.id } # Trim any trailing dots from the name for consistency/display purposes $FQDN = $Name | Test-ValidFQDN # Standardize lookups and retrieved information $Resolved = Resolve-BlueCatFQDN -FQDN $FQDN -ViewID $ViewID -BlueCatSession $BlueCatSession # Warn that a possibly conflicting external host record was also found if ($Resolved.external) { Write-Warning "$($thisFN): Found External Host '$($Resolved.name)' (ID:$($Resolved.external.id))" } # Validate that a host object was returned $HostObj = $Resolved.host if (!$HostObj.id) { throw "No Host record found for $($FQDN)" } # Reduce redundant API calls by using zone information returned by Resolve-BlueCatFQDN $HostObj | Add-Member -MemberType NoteProperty -Name zone -Value $Resolved.zone Write-Verbose "$($thisFN): Selected #$($HostObj.id) as '$($HostObj.name)' (Zone #$($HostObj.zone.id) as '$($HostObj.zone.name)')" # Return the host object to caller $HostObj } } |