For the complete documentation index, see llms.txt. This page is also available as Markdown.

New-DSAdDomain

Synopsis

Add a domain.

Syntax

__AllParameterSets

New-DSAdDomain -DomainName <string> -DisplayName <string> -AdministrationUsername <string>
 -AdministrationPassword <string> [-IsLDAPS] [-LDAPSCustomPort <int>] [-AutoCreateEnabled]
 [-DomainUsernameFormatType <DomainUsernameFormatType>] [-DomainUserReadOnly]
 [-DefaultVault <string>] [-AsLegacyResponse] [<CommonParameters>]

Description

Add a domain with the supplied parameters. The Platinum Edition license is required to enable the Multi Domain feature. The administration account supplied needs to be able to retrieve user account information and group memberships. It may requires higher privileges than being part of the Domain Users built-in Active Directory group. In most case, it should be sufficient.

Examples

PS C:\> New-DSAdDomain -DomainName domain.loc -DisplayName Dom -AdministrationUsername admin -AdministrationPassword "Pa$$w0rd!" -IsLDAPS -LDAPSCustomPort 1500 -AutoCreateEnabled -DomainUsernameFormatType NetBios -DomainUserReadOnly

Create a new domain with the supplied parameters.

Parameters

-AdministrationPassword

Password part of the credentials of a domain or service account to access the Active Directory forest and obtain user account information through LDAP queries.

-AdministrationUsername

Username part of the credentials of a domain or service account to access the Active Directory forest and obtain user account information through LDAP queries.

-AsLegacyResponse

In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.

-AutoCreateEnabled

Automatically create the domain user account in the Devolutions Server on the first login attempt.

-DefaultVault

Name of the vault the user will have access to.

-DisplayName

Domain name that will be displayed in the application usage like informational messages.

-DomainName

Remote computer domain name

-DomainUsernameFormatType

Select the username format that will be created in the database. UPN : The user will be created using the UPN format ex: bill@windjammer.loc. NetBios : The user will be created using the NetBios format ex: WINDJAMMER\bill. Username : The user will be created using the SAM account name.

-DomainUserReadOnly

Set Read only user instead of User type account.

-IsLDAPS

Enable the LDAP over SSL communication.

-LDAPSCustomPort

LDAPS communication port. If not specified, it will be the default one.

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Notes

For more information, type "Get-Help New-DSAdDomain -detailed". For technical information, type "Get-Help New-DSAdDomain -full".

Last updated

Was this helpful?