Skip to content

Get-IBHost

SYNOPSIS

Retrieve host records from Infoblox.

SYNTAX

Specific (Default)

Get-IBHost [[-Name] <String>] [[-IP] <String>] [[-Properties] <String[]>] [-ExcludeDefaultProperties]
 [<CommonParameters>]

IncludeAll

Get-IBHost [[-Name] <String>] [[-IP] <String>] [-IncludeAllProperties] [<CommonParameters>]

DESCRIPTION

This function retrieves host records from Infoblox based on specified filters such as hostname or IP address. It supports retrieving specific properties, excluding default properties, or including all available properties.

EXAMPLES

EXAMPLE 1

Get-IBHost -Name "server01"

Retrieves host records from Infoblox with a hostname matching "server01".

EXAMPLE 2

Get-IBHost -IP "192.168.1.10"

Retrieves host records from Infoblox with an IP address matching "192.168.1.10".

EXAMPLE 3

Get-IBHost -Name "server01" -Properties @("name", "ipv4addrs", "aliases")

Retrieves specific properties for the host record with a hostname matching "server01".

EXAMPLE 4

Get-IBHost -IncludeAllProperties

Retrieves all available properties for all host records in Infoblox.

PARAMETERS

-Name

The hostname to search for in Infoblox. Supports partial matches.

Type: String
Parameter Sets: (All)
Aliases: Hostname

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-IP

The IP address to search for in Infoblox. Supports partial matches.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Properties

A list of specific properties to retrieve for the host record.

Type: String[]
Parameter Sets: Specific
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ExcludeDefaultProperties

A switch to exclude default properties from the result.

Type: SwitchParameter
Parameter Sets: Specific
Aliases:

Required: False
Position: 4
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IncludeAllProperties

A switch to include all available properties in the result.

Type: SwitchParameter
Parameter Sets: IncludeAll
Aliases:

Required: False
Position: 3
Default value: False
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.

INPUTS

OUTPUTS

NOTES