Functions/BloxOne/BloxOneDDI/Get-B1FixedAddress.ps1
|
function Get-B1FixedAddress { <# .SYNOPSIS Retrieves a list of Fixed Addresses in BloxOneDDI IPAM .DESCRIPTION This function is used to query a list of Fixed Addresses in BloxOneDDI IPAM .PARAMETER IP The IP of the fixed address .PARAMETER Space Use this parameter to filter the list of fixed addresses by Space .PARAMETER Limit Use this parameter to limit the quantity of results. The default number of results is 1000. .PARAMETER Offset Use this parameter to offset the results by the value entered for the purpose of pagination .PARAMETER tfilter Use this parameter to filter the results returned by tag. .PARAMETER Fields Specify a list of fields to return. The default is to return all fields. .PARAMETER OrderBy Optionally return the list ordered by a particular value. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. Using 'asc' or 'desc' as a suffix will change the ordering, with ascending as default. .PARAMETER OrderByTag Optionally return the list ordered by a particular tag value. Using 'asc' or 'desc' as a suffix will change the ordering, with ascending as default. .PARAMETER id Use the id parameter to filter the results by ID .EXAMPLE PS> Get-B1FixedAddress -IP 10.10.100.12 .FUNCTIONALITY BloxOneDDI .FUNCTIONALITY DHCP #> param( [String]$IP = $null, [String]$Space, [Int]$Limit = 1000, [Int]$Offset = 0, [String]$tfilter, [String[]]$Fields, [String]$OrderBy, [String]$OrderByTag, [String]$id ) if ($Space) {$SpaceUUID = (Get-B1Space -Name $Space -Strict).id} [System.Collections.ArrayList]$Filters = @() [System.Collections.ArrayList]$QueryFilters = @() if ($IP) { $Filters.Add("address==`"$IP`"") | Out-Null } if ($id) { $Filters.Add("id==`"$id`"") | Out-Null } if ($SpaceUUID) { $Filters.Add("ip_space==`"$SpaceUUID`"") | Out-Null } if ($Filters) { $Filter = Combine-Filters $Filters $QueryFilters.Add("_filter=$Filter") | Out-Null } if ($Limit) { $QueryFilters.Add("_limit=$Limit") | Out-Null } if ($Offset) { $QueryFilters.Add("_offset=$Offset") | Out-Null } if ($Fields) { $Fields += "id" $QueryFilters.Add("_fields=$($Fields -join ",")") | Out-Null } if ($OrderBy) { $QueryFilters.Add("_order_by=$OrderBy") | Out-Null } if ($OrderByTag) { $QueryFilters.Add("_torder_by=$OrderByTag") | Out-Null } if ($tfilter) { $QueryFilters.Add("_tfilter=$tfilter") | Out-Null } if ($QueryFilters) { $QueryString = ConvertTo-QueryString $QueryFilters } Write-DebugMsg -Filters $QueryFilters if ($QueryString) { Invoke-CSP -Method GET -Uri "$(Get-B1CSPUrl)/api/ddi/v1/dhcp/fixed_address$($QueryString)" | Select-Object -ExpandProperty results -ErrorAction SilentlyContinue } else { Invoke-CSP -Method GET -Uri "$(Get-B1CSPUrl)/api/ddi/v1/dhcp/fixed_address" | Select-Object -ExpandProperty results -ErrorAction SilentlyContinue } } |