Import-DSAdUsers

Synopsis

Import users from the domain.

Syntax

ImportByName

Import-DSAdUsers -DomainName <string> -Name <string[]> [-AsLegacyResponse] [<CommonParameters>]

ImportAll

Import-DSAdUsers -DomainName <string> -All [-AsLegacyResponse] [<CommonParameters>]

Description

Import users from the domain. Two alternatives are offered: import all users or import users based on their name.

Examples

PS C:\> Import-DSAdUsers -DomainName "domain.loc" -All

Import all users of the domain "domain.loc".

Parameters

-All

Import all users from the specified domain.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ImportAll
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-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.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-DomainName

Name of the domain containing the users.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

Names of the users to import. It is corresponding to the samAccountName field from the users obtained from Get-DSDomainUsers.

Type: System.String[]
DefaultValue: ''
SupportsWildcards: false
Aliases:
- Names
ParameterSets:
- Name: ImportByName
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

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 Import-DSAdUsers -detailed". For technical information, type "Get-Help Import-DSAdUsers -full".