Get-B1FederatedRealm¶
SYNOPSIS¶
Queries a list of Federated Realms from the Universal DDI IPAM
SYNTAX¶
Get-B1FederatedRealm [[-Name] <String>] [[-Description] <String>] [-Strict] [[-Limit] <Int32>]
[[-Offset] <Int32>] [[-tfilter] <String>] [[-Fields] <String[]>] [[-OrderBy] <String>]
[[-OrderByTag] <String>] [[-CustomFilters] <Object>] [[-id] <String>] [<CommonParameters>]
DESCRIPTION¶
This function is used to query a list of Federated Realms from the Universal DDI IPAM
EXAMPLES¶
EXAMPLE 1¶
Get-B1FederatedRealm -Name "Corporate" -Strict
allocation_v4 : @{allocated=32; delegated=12; forward_looking_delegation=3; overlapping=1; reserved=7}
comment : Corporate Federated Realm
created_at : 04/03/2026 13:40:50
id : federation/federated_realm/2bff55cf-9bb9-441f-bf06-df53e9358aa3
metadata :
name : Corporate
provider : NIOS_X
region :
tags :
updated_at : 26/06/2026 12:10:05
utilization : 0
utilization_v6 :
PARAMETERS¶
-Name¶
Use this parameter to filter the list of Federated Realms by name
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description¶
Use this parameter to filter the list of Federated Realms by description
.PARAMETER UtilizationLow¶
Use this parameter to filter the list of Federated Realms with a utilization above the low utilization threshold¶
.PARAMETER UtilizationHigh¶
Use this parameter to filter the list of Federated Realms with a utilization below the high utilization threshold¶
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Limit¶
Use this parameter to limit the quantity of results. The default number of results is 1000.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 1000
Accept pipeline input: False
Accept wildcard characters: False
-Offset¶
Use this parameter to offset the results by the value entered for the purpose of pagination
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-tfilter¶
Use this parameter to filter the results returned by tag.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Fields¶
Specify a list of fields to return. The default is to return all fields.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CustomFilters¶
Accepts either an Object, ArrayList or String containing one or more custom filters. See here for usage: https://ibps.readthedocs.io/en/latest/#-customfilters
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-id¶
Use this parameter to query a particular federated realm id
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.