Functions/BloxOneDDI/Get-B1DHCPHost.ps1
|
function Get-B1DHCPHost { <# .SYNOPSIS Retrieves a list of BloxOneDDI DHCP Hosts .DESCRIPTION This function is used to query a list of BloxOneDDI DHCP Hosts .PARAMETER Name The name of the DHCP Host to filter by .PARAMETER IP The IP of the DHCP Host to filter by .PARAMETER Strict Use strict filter matching. By default, filters are searched using wildcards where possible. Using strict matching will only return results matching exactly what is entered in the applicable parameters. .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 id Return results based on DHCP Host id .EXAMPLE Get-B1DHCPHost -Name "bloxoneddihost1.mydomain.corp" -IP "10.10.10.10" .FUNCTIONALITY BloxOneDDI .FUNCTIONALITY DHCP #> param( [String]$Name, [String]$IP, [switch]$Strict, [Int]$Limit = 1000, [Int]$Offset = 0, [String]$tfilter, [String]$id ) $MatchType = Match-Type $Strict [System.Collections.ArrayList]$Filters = @() [System.Collections.ArrayList]$QueryFilters = @() if ($Name) { $Filters.Add("name$MatchType`"$Name`"") | Out-Null } if ($IP) { $Filters.Add("address==`"$IP`"") | Out-Null } if ($id) { $Filters.Add("id==`"$id`"") | Out-Null } if ($Filters) { $Filter = Combine-Filters $Filters $QueryFilters.Add("_filter=$Filter") | Out-Null } $QueryFilters.Add("_limit=$Limit") | Out-Null $QueryFilters.Add("_offset=$Offset") | Out-Null if ($tfilter) { $QueryFilters.Add("_tfilter=$tfilter") | Out-Null } if ($QueryFilters) { $QueryString = ConvertTo-QueryString $QueryFilters } if ($QueryString) { Query-CSP -Method GET -Uri "dhcp/host$QueryString" | Select-Object -ExpandProperty results -ErrorAction SilentlyContinue } else { Query-CSP -Method GET -Uri "dhcp/host" | Select-Object -ExpandProperty results -ErrorAction SilentlyContinue } } |