Get-B1IPAMHost¶
SYNOPSIS¶
Retrieves a list of host objects from IPAM
SYNTAX¶
Get-B1IPAMHost [[-Name] <String>] [[-Description] <String>] [[-Limit] <Int32>] [[-Offset] <Int32>] [-Strict]
[[-Fields] <String[]>] [[-OrderBy] <String>] [[-OrderByTag] <String>] [[-tfilter] <String>] [-CaseSensitive]
[[-id] <String>] [<CommonParameters>]
DESCRIPTION¶
This function is used to query a list of host objects from IPAM.
EXAMPLES¶
EXAMPLE 1¶
EXAMPLE 2¶
PARAMETERS¶
-Name¶
Filter results by the host object name
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description¶
Filter results by the host object description
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Limit¶
Limits the number of results returned, the default is 100
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: 100
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
-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
-Fields¶
Specify a list of fields to return. The default is to return all fields.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
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: 6
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: 7
Default value: None
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: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CaseSensitive¶
Use Case Sensitive matching. By default, case-insensitive matching both for -Strict matching and regex matching.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-id¶
Use this parameter to query a particular host object by id
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
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.