Synopsis
Description
The Identity parameter specifies the Active Directory MSA to install. You can identify a MSA by its distinguished name Members (DN), GUID, security identifier (SID) or Security Accounts Manager (SAM) account name. You can also set the parameter to a MSA object variable, such as $ or pass a MSA object through the pipeline to the Identity parameter. For example, you can use Get-ADServiceAccount to get a MSA object and then pass the object through the pipeline to the Install-ADServiceAccount.
The AccountPassword parameter allows you to pass a SecureString that contains the password of a standalone MSA and is ignored for group MSAs. Alternatively you can use PromptForPassword switch parameter to be prompted for the standalone MSA password. You need to enter the password of a standalone MSA if you want to install an account that you have pre-provisioned early on. This is required when you are installing a standalone MSA on a server located on a segmented network (site) with no access to writable DCs but only RODCs (e.g. perimeter network or DMZ). In this case you should create the standalone MSA, link it with the appropriate computer account and assign a well-known password that needs to be passed when installing the standalone MSA on the server on the RODC-only site with no access to writable DCs. If you pass both AccountPassword and PromptForPassword parameters the AccountPassword parameter takes precedence.
Parameters
-AccountPassword
The AccountPassword SecureString parameter will allow you to inline pass-in the password of a standalone Managed Service Account (MSA) that you have pre-provisioned early on and is ignored for group MSAs. This is required when you are installing a standalone MSA on a server located on a segmented network (site) with no access to writable DCs but only RODCs (e.g. perimeter network or DMZ). In this case you should create the standalone MSA, link it with the appropriate computer account and assign a well-known password that needs to be passed when installing the standalone MSA on the server on the RODC-only site with no access to writable DCs. If you pass both AccountPassword and PromptForPassword parameters the AccountPassword parameter takes precedence.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AuthType <ADAuthType>
Specifies the authentication method to use. Possible values for this parameter include:
Required? false
Position? named
Default value Microsoft.ActiveDirectory.Management.AuthType.Negotiate
Accept pipeline input? false
Accept wildcard characters? false
-Force <SwitchParameter>
Forces installation of the service account.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Identity <ADServiceAccount>
Specifies an Active Directory account object by providing one of the following property values. The identifier in parentheses is the LDAP display name for the attribute.
Required? true
Position? 1
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-PromptForPassword <SwitchParameter>
The PromptForPassword switch parameter will allow you to enter the password of a standalone Managed Service Account (MSA) that you have pre-provisioned early on and ignored for group MSAs. This is required when you are installing a standalone MSA on a server located on a segmented network (site) with no access to writable DCs but only RODCs (e.g. perimeter network or DMZ). In this case you should create the standalone MSA, link it with the appropriate computer account and assign a well-known password that needs to be passed when installing the standalone MSA on the server on the RODC-only site with no access to writable DCs. If you pass both AccountPassword and PromptForPassword parameters the AccountPassword parameter takes precedence.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm <SwitchParameter>
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf <SwitchParameter>
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
Syntax
Install-ADServiceAccount [-WhatIf] [-Confirm] [-AccountPassword <SecureString>] [-AuthType <ADAuthType>] [-Force] [-Identity] <ADServiceAccount> [-PromptForPassword] [<CommonParameters>]
This cmdlet does not work with AD LDS.
C:\PS>Install-ADServiceAccount -Identity ‘SQL-svc-01’
Install a Managed Service Account with name ‘SQL-svc-01’ on the local computer. (If a Group Managed Service Account is used, the service account must have the PrincipalsAllowedToRetrieveManagedPassword property set.)
C:\PS>$a = Get-ADServiceAccount -Filter { Name -eq ‘SQL-svc-01’}
Install-ADServiceAccount $a
Get a Managed Service Account with name ‘SQL-svc-01’ from the default directory and install it on the local machine. (If a Group Managed Service Account is used, the service account must have the PrincipalsAllowedToRetrieveManagedPassword property set.)
C:\PS>Install-ADServiceAccount -Identity ‘SQL-svc-01’ -PromptForPassword
Please enter the current password for 'CN=SQL-svc-01,CN=Managed Service Accounts,DC=TOSSolution,DC=com'
Password: *******
C:\PS>Install-ADServiceAccount -Identity ‘SQL-svc-01’ -AccountPassword (ConvertTo-SecureString -AsPlainText “p@ssw0rd” -Force)
Installs a standalone Managed Service Account with name ‘SQL-svc-01’ in a RODC-only site with not access to writable DCs passing the account password as a secure string. (If a Group Managed Service Account is used, the service account must have the PrincipalsAllowedToRetrieveManagedPassword property set.)
Get-Command Install-ADServiceAccount
. Get-ADServiceAccount
. New-ADServiceAccount
. Remove-ADServiceAccount
. Reset-ADServiceAccountPassword
. Set-ADServiceAccount
. Uninstall-ADServiceAccount