Functions/BloxOneDDI/Get-B1DHCPConfigProfile.ps1
|
function Get-B1DHCPConfigProfile { <# .SYNOPSIS Retrieves a list of DHCP Config Profiles from BloxOneDDI .DESCRIPTION This function is used to query a list of DHCP Config Profiles from BloxOneDDI .PARAMETER Name The name of the DHCP Config Profile .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 IncludeInheritance Include inherited configuration in results .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 id Return results based on DHCP Config Profile id .EXAMPLE Get-B1DHCPConfigProfile -Name "Data Centre" -Strict -IncludeInheritance .FUNCTIONALITY BloxOneDDI #> param( [String]$Name, [switch]$Strict = $false, [switch]$IncludeInheritance = $false, [Int]$Limit = 1000, [Int]$Offset = 0, [String]$tfilter, [String[]]$Fields, [String]$id ) $MatchType = Match-Type $Strict [System.Collections.ArrayList]$Filters = @() [System.Collections.ArrayList]$QueryFilters = @() if ($Name) { $Filters.Add("name$MatchType`"$Name`"") | 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 ($Fields) { $Fields += "id" $QueryFilters.Add("_fields=$($Fields -join ",")") | Out-Null } if ($QueryFilters) { $QueryString = ConvertTo-QueryString $QueryFilters } if ($QueryString) { Query-CSP -Method GET -Uri "dhcp/server$($QueryString)" | Select-Object -ExpandProperty results -ErrorAction SilentlyContinue } else { Query-CSP -Method GET -Uri "dhcp/server" | Select-Object -ExpandProperty results -ErrorAction SilentlyContinue } } |