Public/Get-BlueCatMX.ps1
|
Function Get-BlueCatMX { <# .SYNOPSIS Retrieve a set of MX records .DESCRIPTION The Get-BlueCatMX cmdlet allows the retrieval of a set of DNS MX records. .PARAMETER Name A string value representing the FQDN of the MX records to be retrieved. .PARAMETER Zone An optional zone object to be searched. Providing a zone object reduces API calls making the lookup faster. .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-BlueCatMX -Name server1.example.com Returns a PSCustomObject representing one or more MX records, or NULL if none are found. BlueCatSession will default to the current default session. View will default to the BlueCatSession default view. .EXAMPLE PS> Get-BlueCatMX -Name server9.example.com -ViewID 23456 -BlueCatSession $Session3 Returns a PSCustomObject representing the set of MX records, or NULL if none are found. Use the BlueCatSession associated with $Session3 to perform this lookup. The record will be searched for in view 23456. .INPUTS None .OUTPUTS PSCustomObject array representing the requested set of MX records, or NULL if none are found. [int] id [string] name [string] shortName [string] type = 'MXRecord' [string] relay [int] priority [PSCustomObject] config [PSCustomObject] view [PSCustomObject] zone #> [CmdletBinding()] param( [Parameter(Mandatory)] [Alias('HostName')] [string] $Name, [Parameter(ParameterSetName='ZoneObj',Mandatory)] [ValidateNotNullOrEmpty()] [PSCustomObject] $Zone, [Parameter(ParameterSetName='ViewID')] [ValidateRange(1, [int]::MaxValue)] [int] $ViewID, [Parameter(ParameterSetName='ViewObj',Mandatory)] [ValidateNotNullOrEmpty()] [PSCustomObject] $View, [Parameter(ValueFromPipeline)] [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 ($Zone) { $View = $Zone.view } elseif ($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))" } # Trim any trailing dots from the name for consistency/display purposes $FQDN = $Name | Test-ValidFQDN # Resolve zone if not provided if (-not $Zone) { $Zone = Resolve-BlueCatZone -Name $FQDN -View $View -BlueCatSession $BlueCatSession if (-not $Zone) { # Zone could not be resolved Write-Warning "$($thisFN): Zone could not be resolved for $($FQDN)" } } if ($Zone) { # Resolve short name for lookup if ($FQDN -eq $Zone.name) { $ShortName = '' } else { $ShortName = $FQDN -replace "\.$($Zone.name)$", '' } # Warn if a possibly conflicting external host record was also found $xHost = Get-BlueCatExternalHost -Name $FQDN -View $View -BlueCatSession $BlueCatSession if ($xHost) { Write-Warning "$($thisFN): Found External Host '$($xHost.name)' (ID:$($xHost.id))" } # Lookup record $Query = "getEntitiesByName?parentId=$($Zone.id)&type=MXRecord&start=0&count=100&name=$($ShortName)" $BlueCatReply = Invoke-BlueCatApi -Method Get -Request $Query -BlueCatSession $BlueCatSession } if ($BlueCatReply.Count) { # Loop through the results and build an array of objects [PSCustomObject[]] $MXList = @() foreach ($entry in $BlueCatReply) { $PropertyObj = $entry.properties | Convert-BlueCatPropertyString $PropertyObj | Add-Member -MemberType NoteProperty -Name 'address' -Value ($PropertyObj.addresses -split ',') $MXRecord = [PSCustomObject] @{ id = $entry.id name = $PropertyObj.absoluteName type = $entry.type shortName = $entry.name relay = $PropertyObj.linkedRecordName priority = $PropertyObj.priority zone = $Zone property = $PropertyObj properties = $entry.properties view = $View config = $View.config } $MXList += $MXRecord Write-Verbose "$($thisFN): Selected ID:$($MXrecord.id) for $($FQDN) (Priority $($MXrecord.priority): $($MXrecord.relay))" } # Return the array to caller $MXList } else { # No object was returned $Failure = "$($thisFN): No records found for $($FQDN)" throw $Failure Write-Verbose $Failure } } } |