Get-ADForest

更新日: 2015年7月

適用対象: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-ADForest

Gets an Active Directory forest.

構文

Parameter Set: Current
Get-ADForest [-AuthType <ADAuthType> {Negotiate | Basic} ] [-Credential <PSCredential> ] [-Current <ADCurrentForestType> {LocalComputer | LoggedOnUser} ] [-Server <String> ] [ <CommonParameters>]

Parameter Set: Identity
Get-ADForest [-Identity] <ADForest> [-AuthType <ADAuthType> {Negotiate | Basic} ] [-Credential <PSCredential> ] [-Server <String> ] [ <CommonParameters>]




詳細説明

The Get-ADForest cmdlet gets the specified Active Directory forest. You can specify the forest by setting the Identity or Current parameters.

The Identity parameter specifies the Active Directory forest to get. You can identify a forest by its fully qualified domain name (FQDN), DNS host name, or NetBIOS name. You can also set the parameter to a forest object variable, such as $<localForestObject>, or you can pass a forest object through the pipeline to the Identity parameter.

To get the forest of the local computer or current logged on user, set the Current parameter to LocalComputer or LoggedOnUser. When you set the Current parameter, you do not need to set the Identity parameter.

When the Current parameter is set to LocalComputer or LoggedOnUser, the cmdlet uses the Server and Credential parameter values to determine the domain and the credentials to use to identify the domain of the forest according to the following rules:

-- If both the Server and Credential parameters are not specified:

The domain is set to the domain of the LocalComputer or LoggedOnUser and a server is located in this domain. The credentials of the current logged on user are used to get the domain.

-- If the Server parameter is specified and the Credential parameter is not specified:

The domain is set to the domain of the specified server and the cmdlet checks to make sure that the server is in the domain of the LocalComputer or LoggedOnUser. Then the credentials of the current logged on user are used to get the domain. An error is returned when the server is not in the domain of the LocalComputer or LoggedOnUser.

-- If the Server parameter is not specified and the Credential parameter is specified:

The domain is set to the domain of the LocalComputer or LoggedOnUser and a server is located in this domain. Then the credentials specified by the Credential parameter are used to get the domain.

-- If the Server and Credential parameters are specified:

The domain is set to the domain of the specified server and the cmdlet checks to make sure that the server is in the domain of the LocalComputer or LoggedOnUser. Then the credentials specified by the Credential parameter are used to get the domain. An error is returned when the server is not in the domain of the LocalComputer or LoggedOnUser.

パラメーター

-AuthType<ADAuthType>

Specifies the authentication method to use. このパラメーターに対して使用できる値:

-- Negotiate or 0
-- Basic or 1

The default authentication method is Negotiate.

A Secure Sockets Layer (SSL) connection is required for the Basic authentication method.


エイリアス

なし

必須?

false

位置は?

named

既定値

Microsoft.ActiveDirectory.Management.AuthType.Negotiate

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Credential<PSCredential>

Specifies the user account credentials to use to perform this task. The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Active Directory module for Windows PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the default.

To specify this parameter, you can type a user name such as User1 or Domain01\User01, or you can specify a PSCredential object. If you specify a user name for this parameter, the cmdlet prompts for a password.

You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. You can then set the Credential parameter to the PSCredential object.

If the acting credentials do not have directory-level permission to perform the task, Active Directory module for Windows PowerShell returns a terminating error.


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Current<ADCurrentForestType>

Specifies whether to return the domain of the local computer or the current logged on user. このパラメーターに対して使用できる値:

-- LocalComputer or 0
-- LoggedOnUser or 1


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

-Identity<ADForest>

Specifies an Active Directory forest object by providing one of the following attribute values. The identifier in parentheses is the Lightweight Directory Access Protocol (LDAP) display name for the attribute. このパラメーターに対して使用できる値:

-- A fully qualified domain name
-- A GUID (objectGUID)
-- A DNS host name
-- A NetBIOS name

The cmdlet searches the default naming context or partition to find the object. If two or more objects are found, the cmdlet returns a non-terminating error.

This parameter can also get this object through the pipeline or you can set this parameter to a forest object instance.


エイリアス

なし

必須?

true

位置は?

1

既定値

なし

パイプライン入力を許可する

True (ByValue)

ワイルドカード文字を許可する

false

-Server<String>

Specifies the Active Directory Domain Services (AD DS) instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following: Active Directory Lightweight Directory Services (AD LDS), AD DS, or Active Directory snapshot instance.

Specify the AD DS instance in one of the following ways:

Domain name values:

-- Fully qualified domain name
-- NetBIOS name

Directory server values:

-- Fully qualified directory server name
-- NetBIOS name
-- Fully qualified directory server name and port

The default value for this parameter is determined by one of the following methods in the order that they are listed:

-- By using the Server value from objects passed through the pipeline
-- By using the server information associated with the AD DS Windows PowerShell provider drive, when the cmdlet runs in that drive
-- By using the domain of the computer running Windows PowerShell


エイリアス

なし

必須?

false

位置は?

named

既定値

なし

パイプライン入力を許可する

false

ワイルドカード文字を許可する

false

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

  • None or Microsoft.ActiveDirectory.Management.ADForest

    A forest object is received by the Identity parameter.


出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

  • Microsoft.ActiveDirectory.Management.ADForest

    Returns one or more forest objects.

    This cmdlet returns all of the properties of the forest. To view all of the properties for an ADForest object, use the following command and replace <forest> with a forest identifier such as a DNS host name.

    Get-ADForest <forest> | Get-Member


  • This cmdlet does not work with AD LDS.

  • This cmdlet does not work when targeting a snapshot using the Server parameter.

Example 1: Get information for a domain forest

This command gets information for the Fabrikam.com forest.


PS C:\> Get-ADForest -Identity Fabrikam.com

Example 2: Get information for a local computer forest

This command gets the information for the current local computer's forest.


PS C:\> Get-ADForest -Current LocalComputer

Example 3: Get information for the current user's forest

This command gets the forest information of the currently logged on user.


PS C:\> Get-ADForest -Current LoggedOnUser

Example 4: Get information for the current user's forest

This command gets the forest information of the currently logged on user.


PS C:\> Get-ADForest

Example 5: Get all of the domain controllers for all domains in a forest

This command gets all the domain controllers for all domains in a forest.


PS C:\> $AllDCs = (Get-ADForest).Domains | %{ Get-ADDomainController -Filter * -Server $_ }

関連トピック

コミュニティの追加

追加
表示: