Get-Ipam
Syntax
Get-IpamDnsZone
[-ZoneType] <ZoneType[]>
[[-ZoneName] <String[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]Description
The Get-IpamDnsZone cmdlet gets information about all the Domain Name System (DNS) zones in the IPAM (IP Address Management) server database. A DNS zone is a distinct section of the domain name system for an organization. For instance, the DNS zone northamerica.contoso.com would maintain DNS records for contoso.com's northamerica subdomain. Likewise, the DNS zone southamerica.contoso.com would maintain DNS records for contoso.com's southamerica subdomain.
Examples
Example 1: Get information about all forward zones
PS C:\> Get-IpamDnsZone -ZoneType "Forward"This command returns information about all the forward zones in the IPAM database.
Example 2: Get information about the forward zones in a specific DNS zone
PS C:\> Get-IpamDnsZone -ZoneType "Forward" -ZoneName "northamerica.contoso.com"This command returns information for the DNS zone named northamerica.contoso.com.
Required Parameters
Specifies the type of DNS zone to be returned.
The acceptable values for this parameter are:
- Forward. Resolves host names to IP addresses.
- IPv4Reverse. Resolves IPv4 addresses to host names.
- IPv6Reverse. Resolves IPv6 addresses to host names.
For example:
-ZoneType "IPv4Reverse"
| Type: | ZoneType[] |
| Parameter Sets: | Forward, IPv4Reverse, IPv6Reverse |
| Position: | 1 |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Optional Parameters
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
You can continue to work in the session while the job completes.
To manage the job, use the
*-Job
cmdlets.
To get the job results, use the
Receive-Job
cmdlet.
For more information about Windows PowerShell background jobs, see about_Jobs .
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
| Type: | CimSession[] |
| Aliases: | Session |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
If this parameter is omitted or a value of
0
is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Specifies the name of the DNS zone to be returned. For example:
-ZoneName "northamerica.contoso.com"
| Type: | String[] |
| Position: | 2 |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
Outputs
This cmdlet returns an instance of the IpamDnsZone object.