DSInternals/Documentation/PowerShell/Get-ADDBAccount.md

197 lines
3.6 KiB
Markdown

---
external help file: DSInternals.PowerShell.dll-Help.xml
Module Name: DSInternals
online version: https://github.com/MichaelGrafnetter/DSInternals/blob/master/Documentation/PowerShell/Get-ADDBAccount.md
schema: 2.0.0
---
# Get-ADDBAccount
## SYNOPSIS
Reads one or more accounts from a ntds.dit file, including secret attributes.
## SYNTAX
### All
```
Get-ADDBAccount [-All] [-BootKey <Byte[]>] -DBPath <String> [-LogPath <String>] [<CommonParameters>]
```
### ByName
```
Get-ADDBAccount [-BootKey <Byte[]>] [-SamAccountName] <String> -DBPath <String> [-LogPath <String>]
[<CommonParameters>]
```
### BySID
```
Get-ADDBAccount [-BootKey <Byte[]>] -ObjectSid <SecurityIdentifier> -DBPath <String> [-LogPath <String>]
[<CommonParameters>]
```
### ByDN
```
Get-ADDBAccount [-BootKey <Byte[]>] -DistinguishedName <String> -DBPath <String> [-LogPath <String>]
[<CommonParameters>]
```
### ByGuid
```
Get-ADDBAccount [-BootKey <Byte[]>] -ObjectGuid <Guid> -DBPath <String> [-LogPath <String>]
[<CommonParameters>]
```
## DESCRIPTION
{{Fill in the Description}}
## EXAMPLES
### Example 1
```powershell
PS C:\> {{ Add example code here }}
```
{{ Add example description here }}
## PARAMETERS
### -All
TODO
```yaml
Type: SwitchParameter
Parameter Sets: All
Aliases: AllAccounts, ReturnAllAccounts
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -BootKey
TODO
```yaml
Type: Byte[]
Parameter Sets: (All)
Aliases: key, SysKey, SystemKey
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -DBPath
TODO
```yaml
Type: String
Parameter Sets: (All)
Aliases: Database, DatabasePath, DatabaseFilePath, DBFilePath
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -DistinguishedName
TODO
```yaml
Type: String
Parameter Sets: ByDN
Aliases: dn
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -LogPath
TODO
```yaml
Type: String
Parameter Sets: (All)
Aliases: Log, TransactionLogPath
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ObjectGuid
TODO
```yaml
Type: Guid
Parameter Sets: ByGuid
Aliases: Guid
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -ObjectSid
TODO
```yaml
Type: SecurityIdentifier
Parameter Sets: BySID
Aliases: Sid
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -SamAccountName
TODO
```yaml
Type: String
Parameter Sets: ByName
Aliases: Login, sam
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
### System.Security.Principal.SecurityIdentifier
### System.Guid
## OUTPUTS
### DSInternals.Common.Data.DSAccount
## NOTES
## RELATED LINKS
[Get-ADReplAccount](Get-ADDBAccount.md)
[Get-ADSIAccount](Get-ADSIAccount.md)
[Test-PasswordQuality](Test-PasswordQuality.md)
[Save-DPAPIBlob](Save-DPAPIBlob.md)