Initialize-ADDeviceRegistration
Initialize-ADDeviceRegistration
Initializes the Device Registration Service configuration in the Active Directory forest.
Syntax
Parameter Set: Default
Initialize-ADDeviceRegistration -ServiceAccountName <String> [-Credential <PSCredential> ] [-DeviceLocation <String> ] [-Force] [-MaximumRegistrationInactivityPeriod <UInt32> ] [-RegistrationQuota <UInt32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Initialize-ADDeviceRegistration cmdlet initializes the Device Registration Service configuration in the Active Directory forest. To run this cmdlet, you must be logged in with enterprise administrator permissions and your Active Directory forest must have the Windows Server 2012 R2 schema. To join devices to a workplace, you must run the Enable-AdfsDeviceRegistration cmdlet on each Active Directory Federation Services (AD FS) server after this cmdlet has been run successfully.
Parameters
-Credential<PSCredential>
Specifies a PSCredential object based on a user name and password. This account must be a member of the Enterprise Admins group. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DeviceLocation<String>
Specifies the domain in which to store the device objects. Specify a domain in the current forest.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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 |
-MaximumRegistrationInactivityPeriod<UInt32>
Specifies the maximum number of days to elapse before a device object is deleted due to inactivity.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RegistrationQuota<UInt32>
Specifies the maximum number of devices that an individual user can register.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ServiceAccountName<String>
Specifies the account to which to grant read and write access to the Device Registration service configuration and containers in Active Directory.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Initialize the Device Registration Service
This command initializes the Device Registration Service in the Active Directory forest.
PS C:\> Initialize-ADDeviceRegistration -ServiceAccountName "CONTOSO\svc_adfs" -DeviceLocation "Contoso.com" -RegistrationQuota 10 -MaximumRegistrationInactivityPeriod 90 -Credential ContosoAdmin