Set-ADForest

Windows Server 2012 R2 and Windows 8.1

업데이트 날짜: 2015년 7월

적용 대상: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Set-ADForest

Modifies an Active Directory forest.

구문

Parameter Set: Default
Set-ADForest [-Identity] <ADForest> [-AuthType <ADAuthType> {Negotiate | Basic} ] [-Credential <PSCredential> ] [-PassThru] [-Server <String> ] [-SPNSuffixes <Hashtable> ] [-UPNSuffixes <Hashtable> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




자세한 설명

The Set-ADForest cmdlet modifies the properties of an Active Directory forest. You can modify commonly used property values by using the cmdlet parameters. Property values that are not associated with cmdlet parameters can be modified by using the Add, Replace, Clear and Remove parameters.

The Identity parameter specifies the Active Directory forest to modify. You can identify a forest by its fully qualified domain name (FQDN), GUID, DNS host name, or NetBIOS name. You can also set the Identity parameter to an object variable such as $<localADForestObject>, or you can pass an object through the pipeline to the Identity parameter. For example, you can use the Get-ADForest cmdlet to retrieve a forest object and then pass the object through the pipeline to the Set-ADForest cmdlet.

The Instance parameter provides a way to update a forest object by applying the changes made to a copy of the object. When you set the Instance parameter to a copy of an Active Directory forest object that has been modified, the Set-ADForest cmdlet makes the same changes to the original forest object. To get a copy of the object to modify, use the Get-ADForest object. The Identity parameter is not allowed when you use the Instance parameter. For more information about the Instance parameter, see the Instance parameter description.

매개 변수

-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

-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

-PassThru

작업하고 있는 항목을 나타내는 개체를 반환합니다. 기본적으로 이 cmdlet은 출력을 생성하지 않습니다.


별칭

없음

필수 여부

false

위치

named

기본값

없음

파이프라인 입력 적용 여부

false

와일드카드 문자 허용 여부

false

-SPNSuffixes<Hashtable>

Modifies the list of service principal name (SPN) suffixes of the forest. This parameter sets the multi-valued msDS-SPNSuffixes property of the cross-reference container. This parameter uses the following syntax to add remove, replace, or clear SPN suffix values.

To add values:

-SPNSuffixes @{Add=value1,value2,...}

To remove values:

-SPNSuffixes @{Remove=value3,value4,...}

To replace values:

-SPNSuffixes @{Replace=value1,value2,...}

To clear all values:

-SPNSuffixes $Null

You can specify more than one change by using a list separated by semicolons. For example, use the following syntax to add and remove SPN suffix values:

@{Add=value1,value2,...};@{Remove=value3,value4,...}

The operators are applied in the following sequence:

-- Remove
-- Add
-- Replace


별칭

없음

필수 여부

false

위치

named

기본값

없음

파이프라인 입력 적용 여부

false

와일드카드 문자 허용 여부

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

-UPNSuffixes<Hashtable>

Modifies the list of user principal name (UPN) suffixes of the forest. This parameter sets the multi-valued msDS-UPNSuffixes property of the cross-reference container. This parameter uses the following syntax to add remove, replace, or clear UPN suffix values.

To add values:

-UPNSuffixes @{Add=value1,value2,...}

To remove values:

-UPNSuffixes @{Remove=value3,value4,...}

To replace values:

-UPNSuffixes @{Replace=value1,value2,...}

To clear all values:

-UPNSuffixes $Null

You can specify more than one change by using a list separated by semicolons. For example, use the following syntax to add and remove UPN suffix values:

@{Add=value1,value2,...};@{Remove=value3,value4,...}

The operators are applied in the following sequence:

-- Remove
-- Add
-- Replace


별칭

없음

필수 여부

false

위치

named

기본값

없음

파이프라인 입력 적용 여부

false

와일드카드 문자 허용 여부

false

-Confirm

cmdlet을 실행하기 전에 확인 메시지가 표시됩니다.


필수 여부

false

위치

named

기본값

false

파이프라인 입력 적용 여부

false

와일드카드 문자 허용 여부

false

-WhatIf

cmdlet이 실행될 경우 결과 동작을 표시합니다. cmdlet이 실행되지 않습니다.


필수 여부

false

위치

named

기본값

false

파이프라인 입력 적용 여부

false

와일드카드 문자 허용 여부

false

<CommonParameters>

이 cmdlet은 일반 매개 변수 -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer 및 -OutVariable을 지원합니다. 자세한 내용은 다음을 참조하세요. about_CommonParameters(http://go.microsoft.com/fwlink/p/?LinkID=113216).

입력

입력 유형은 cmdlet에 파이프할 수 있는 개체의 유형입니다.

  • None or Microsoft.ActiveDirectory.Management.ADForest

    A forest object is received by the Identity parameter.

    A forest object that was retrieved by using the Get-ADForest cmdlet and then modified is received by the Instance parameter.


출력

출력 유형은 cmdlet이 내보내는 개체의 유형입니다.

  • None or Microsoft.ActiveDirectory.Management.ADForest

    Returns the modified forest object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.


참고

  • This cmdlet does not work with AD LDS.

  • This cmdlet does not work with an Active Directory snapshot.

  • This cmdlet does not work with a read-only domain controller.

예제

Example 1: Update a property for a forest

This command sets the UPNSuffixes property for the fabrikam.com forest.


PS C:\> Set-ADForest -Identity fabrikam.com -UPNSuffixes @{replace="fabrikam.com","fabrikam","corp.fabrikam.com"}

Example 2: Add a value to a forest property

This command adds corp.fabrikam.com to the SPNSuffixes property on the forest fabrikam.com.


PS C:\> Set-ADForest -Identity fabrikam.com -SPNSuffixes @{add="corp.fabrikam.com"}

Example 3: Update a property for a forest

This command gets the forest of the current logged on user and updates the SPNSuffixes property.


PS C:\> Get-ADForest | Set-ADForest -SPNSuffixes @{Add="corp.fabrikam.com";Remove="fabrikam"}

Example 4: Clear a property for a forest

This command gets the forest of the current logged on user and clears the UPNSuffixes property.


PS C:\> Get-ADForest | Set-ADForest -UPNSuffixes $Null

Example 5: Update a property for a local forest

This example modifies the UPNSuffixes property for the fabrikam.com forest. The example modifies a local instance of the fabrikam.com forest, and then specifies the Instance parameter for the current cmdlet as the local instance.


PS C:\> $Forest = Get-ADForest -Identity fabrikam.com
PS C:\> $Forest.UPNSuffixes = "fabrikam.com","fabrikam","corp.fabrikam.com"
PS C:\> Set-ADForest -Instance $Forest

관련 항목

커뮤니티 추가 항목

추가
표시: