Export (0) Print
Expand All

Install-AdcsNetworkDeviceEnrollmentService

Updated: August 15, 2012

Applies To: Windows Server 2012

Install-AdcsNetworkDeviceEnrollmentService

Installs Network Device Enrollment Service

Syntax

Parameter Set: DefaultParameterSet
Install-AdcsNetworkDeviceEnrollmentService [-ApplicationPoolIdentity] [-CAConfig <String> ] [-Credential <PSCredential> ] [-EncryptionKeyLength <Int32> ] [-EncryptionProviderName <String> ] [-Force] [-RACity <String> ] [-RACompany <String> ] [-RACountry <String> ] [-RADepartment <String> ] [-RAEmail <String> ] [-RAName <String> ] [-RAState <String> ] [-SigningKeyLength <Int32> ] [-SigningProviderName <String> ] [ <CommonParameters>]

Parameter Set: ServiceAccountParameterSet
Install-AdcsNetworkDeviceEnrollmentService -ServiceAccountName <String> -ServiceAccountPassword <SecureString> [-CAConfig <String> ] [-Credential <PSCredential> ] [-EncryptionKeyLength <Int32> ] [-EncryptionProviderName <String> ] [-Force] [-RACity <String> ] [-RACompany <String> ] [-RACountry <String> ] [-RADepartment <String> ] [-RAEmail <String> ] [-RAName <String> ] [-RAState <String> ] [-SigningKeyLength <Int32> ] [-SigningProviderName <String> ] [ <CommonParameters>]




Detailed Description

The Install-AdcsNetworkDeviceEnrollmentService cmdlet performs the configuration of the Network Device Enrollment Service (NDES) role service.

To remove the NDES role service, use the Uninstall-AdcsNetworkDeviceEnrollmentService cmdlet

You can import the cmdlet by running the following commands from Windows PowerShell:
Import-Module ServerManager
Add-WindowsFeature Adcs-Device-Enrollment

Int is equivalent to Int32 in the .NET Framework (http://msdn.microsoft.com/en-us/library/ya5y69ds.aspx).

Parameters

-ApplicationPoolIdentity

Specifies the identity that the Network Device Enrollment Service (NDES) will use when communicating with the certification authority (CA). This parameter is only valid when NDES is using a remote CA. If the CA is local, the application pool identity account cannot be used.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-CAConfig<String>

Specifies remote certification authority (CA) that the Network Device Enrollment Service uses. This parameter is mandatory when used within the ApplicationPoolIdentity parameter. Do not use this parameter when a local CA is installed.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Credential<PSCredential>

The Network Device Enrollment Service (NDES) must be installed on a server that is a member of an Active Directory Domain Services (AD DS) domain. If NDES is configured to use a Standalone certification authority (CA), then an account that is a member of the local Administrators on the CA is required. If NDES is installed to use an Enterprise CA, then using an account that is a member of Domain Admins group is required.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-EncryptionKeyLength<Int32>

Specifies the encryption key length. This option is not valid if you use existing keys during installation.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-EncryptionProviderName<String>

Specifies the name of the encryption provider, such as the name of cryptographic service provider (CSP).


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Force

Forces the command to run without asking for user confirmation.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RACity<String>

Specifies the city of the registration authority.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-RACompany<String>

Specifies the organization or company that the registration authority represents.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-RACountry<String>

Specifies the country of the registration authority.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-RADepartment<String>

Specifies the department of the registration authority.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-RAEmail<String>

Specifies the email address of the registration authority.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-RAName<String>

Specifies the name of the Network Device Enrollment Service registration authority.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-RAState<String>

Specifies the state or province (geographical political boundary), if applicable, of the registration authority.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-ServiceAccountName<String>

Specifies the name of the account that is used by the Network Device Enrollment Service.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-ServiceAccountPassword<SecureString>

Specifies the password of the service account that is used by the Network Device Enrollment Service.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-SigningKeyLength<Int32>

Specifies the signing key length.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-SigningProviderName<String>

Specifies the name of the signing device.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • bool, int, string, string, string, string, string, string, string, string, string, SecurePassword, int, string

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.CertificateServices.Deployment.Commands.NDES.NetworkDeviceEnrollmentServiceResult

Notes

  • Ensure you run Windows PowerShell as an administrator. You can use the -f switch to bypass the prompt for confirmation.
    To see parameters, run the following command: install-AdcsNetworkDeviceEnrollmentService -?

Examples

-------------------------- EXAMPLE 1 --------------------------

Description

-----------

This command displays the default Network Device Enrollment Service settings when the service is running as the default application identity without making any changes to the configuration.


C:\PS>Install-AdcsNetworkDeviceEnrollmentService -ApplicationPoolIdentity -WhatIf

-------------------------- EXAMPLE 2 --------------------------

Description

-----------

This command displays the default settings when NDES is using a service account without making any changes to the configuration. This command assumes that the <Domain>\<AccountName> service account is a member of the local machine's IIS_USRS group. Substitute the domain name for <Domain> and the user account name for <AccountName>.


C:\PS>Install-AdcsNetworkDeviceEnrollmentService -ServiceAccountName <Domain>\<AccountName> -ServiceAccountPassword (read-host "Set user password" -assecurestring) -WhatIf

-------------------------- EXAMPLE 3 --------------------------

Description

-----------

This command installs the Network Device Enrollment Service using the application pool identity to use a remote CA as specified by the CA computer <CACompterName>\<CACommonName>. Substitute the appropriate CA computer name and common name for <CAComputerName> and <CACommonName>.


C:\PS>Install-AdcsNetworkDeviceEnrollmentService -ApplicationPoolIdentity -CAConfig <CAComputerName>\<CACommonName>

-------------------------- EXAMPLE 4 --------------------------

Description

-----------

This command installs the Network Device Enrollment Service using a specific service account, which is indicated by <Domain>\<AccountName>. The command also specifies several non-default parameters. The example assumes that the <Domain>\<AccountName> user/service account is a member of the local machine's IIS_USRS group. Substitute the domain name for <Domain> and the user account name for <AccountName>.


C:\PS>Install-AdcsNetworkDeviceEnrollmentService -ServiceAccountName MyDomain\AccountName -ServiceAccountPassword (read-host "Set user password" -assecurestring) -CAConfig "CAMachineName\CAName" -RAName "Contoso-NDES-RA" -RACountry "US" -RACompany "Contoso" -SigningProviderName "Microsoft Strong Cryptographic Provider" -SigningKeyLength 4096 -EncryptionProviderName "Microsoft Strong Cryptographic Provider" -EncryptionKeyLength 4096

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft