Skip to content

Commit 2f19d17

Browse files
MichaelGrafnetterMichaelGrafnetter
committed
Updated doc
1 parent 3e2221c commit 2f19d17

File tree

3 files changed

+114
-4
lines changed

3 files changed

+114
-4
lines changed

‎Documentation/PowerShell/Get-ADDBKdsRootKey.md‎

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,14 @@ Reads KDS Root Keys from a ntds.dit. file. Can be used to aid DPAPI-NG decryptio
1212

1313
## SYNTAX
1414

15+
### All (Default)
1516
```
16-
Get-ADDBKdsRootKey -DatabasePath <String> [-LogPath <String>] [<CommonParameters>]
17+
Get-ADDBKdsRootKey [-All] -DatabasePath <String> [-LogPath <String>] [<CommonParameters>]
18+
```
19+
20+
### ByGuid
21+
```
22+
Get-ADDBKdsRootKey [-RootKeyId] <Guid> -DatabasePath <String> [-LogPath <String>] [<CommonParameters>]
1723
```
1824

1925
## DESCRIPTION
@@ -65,6 +71,21 @@ Retrieves a KDS Root Key from an AD database and then uses the "CQURE DPAPI NG P
6571

6672
## PARAMETERS
6773

74+
### -All
75+
Indicates that all KDS Root Keys should be fetched.
76+
77+
```yaml
78+
Type: SwitchParameter
79+
Parameter Sets: All
80+
Aliases:
81+
82+
Required: False
83+
Position: Named
84+
Default value: None
85+
Accept pipeline input: False
86+
Accept wildcard characters: False
87+
```
88+
6889
### -DatabasePath
6990
Specifies the path to a domain database, for instance, C:\Windows\NTDS\ntds.dit.
7091
@@ -95,12 +116,27 @@ Accept pipeline input: False
95116
Accept wildcard characters: False
96117
```
97118
119+
### -RootKeyId
120+
Specifies a single KDS Root Key to be fetched.
121+
122+
```yaml
123+
Type: Guid
124+
Parameter Sets: ByGuid
125+
Aliases: Id, KeyId
126+
127+
Required: True
128+
Position: 0
129+
Default value: None
130+
Accept pipeline input: True (ByPropertyName, ByValue)
131+
Accept wildcard characters: False
132+
```
133+
98134
### CommonParameters
99135
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).
100136
101137
## INPUTS
102138
103-
### None
139+
### System.Guid
104140
105141
## OUTPUTS
106142

‎Src/DSInternals.PowerShell/Chocolatey/dsinternals-psmodule.nuspec‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<package xmlns="http://schemas.microsoft.com/packaging/2015/06/nuspec.xsd">
44
<metadata>
55
<id>DSInternals-PSModule</id>
6-
<version>5.4</version>
6+
<version>5.4.1</version>
77
<packageSourceUrl>https://github.com/MichaelGrafnetter/DSInternals/tree/master/Src/DSInternals.PowerShell/Chocolatey</packageSourceUrl>
88
<owners>MichaelGrafnetter</owners>
99
<title>DSInternals PowerShell Module</title>

‎Src/DSInternals.PowerShell/en-US/DSInternals.PowerShell.dll-Help.xml‎

Lines changed: 75 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5309,6 +5309,56 @@ Epoch : 961
53095309
<command:syntax>
53105310
<command:syntaxItem>
53115311
<maml:name>Get-ADDBKdsRootKey</maml:name>
5312+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
5313+
<maml:name>All</maml:name>
5314+
<maml:description>
5315+
<maml:para>Indicates that all KDS Root Keys should be fetched.</maml:para>
5316+
</maml:description>
5317+
<dev:type>
5318+
<maml:name>SwitchParameter</maml:name>
5319+
<maml:uri />
5320+
</dev:type>
5321+
<dev:defaultValue>False</dev:defaultValue>
5322+
</command:parameter>
5323+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Database, DBPath, DatabaseFilePath, DBFilePath">
5324+
<maml:name>DatabasePath</maml:name>
5325+
<maml:description>
5326+
<maml:para>Specifies the path to a domain database, for instance, C:\Windows\NTDS\ntds.dit.</maml:para>
5327+
</maml:description>
5328+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
5329+
<dev:type>
5330+
<maml:name>String</maml:name>
5331+
<maml:uri />
5332+
</dev:type>
5333+
<dev:defaultValue>None</dev:defaultValue>
5334+
</command:parameter>
5335+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Log, TransactionLogPath">
5336+
<maml:name>LogPath</maml:name>
5337+
<maml:description>
5338+
<maml:para>Specifies the path to a directory where the transaction log files are located. For instance, C:\Windows\NTDS. The default log directory is the one that contains the database file itself.</maml:para>
5339+
</maml:description>
5340+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
5341+
<dev:type>
5342+
<maml:name>String</maml:name>
5343+
<maml:uri />
5344+
</dev:type>
5345+
<dev:defaultValue>None</dev:defaultValue>
5346+
</command:parameter>
5347+
</command:syntaxItem>
5348+
<command:syntaxItem>
5349+
<maml:name>Get-ADDBKdsRootKey</maml:name>
5350+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="Id, KeyId">
5351+
<maml:name>RootKeyId</maml:name>
5352+
<maml:description>
5353+
<maml:para>Specifies a single KDS Root Key to be fetched.</maml:para>
5354+
</maml:description>
5355+
<command:parameterValue required="true" variableLength="false">Guid</command:parameterValue>
5356+
<dev:type>
5357+
<maml:name>Guid</maml:name>
5358+
<maml:uri />
5359+
</dev:type>
5360+
<dev:defaultValue>None</dev:defaultValue>
5361+
</command:parameter>
53125362
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Database, DBPath, DatabaseFilePath, DBFilePath">
53135363
<maml:name>DatabasePath</maml:name>
53145364
<maml:description>
@@ -5336,6 +5386,18 @@ Epoch : 961
53365386
</command:syntaxItem>
53375387
</command:syntax>
53385388
<command:parameters>
5389+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
5390+
<maml:name>All</maml:name>
5391+
<maml:description>
5392+
<maml:para>Indicates that all KDS Root Keys should be fetched.</maml:para>
5393+
</maml:description>
5394+
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
5395+
<dev:type>
5396+
<maml:name>SwitchParameter</maml:name>
5397+
<maml:uri />
5398+
</dev:type>
5399+
<dev:defaultValue>False</dev:defaultValue>
5400+
</command:parameter>
53395401
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Database, DBPath, DatabaseFilePath, DBFilePath">
53405402
<maml:name>DatabasePath</maml:name>
53415403
<maml:description>
@@ -5360,11 +5422,23 @@ Epoch : 961
53605422
</dev:type>
53615423
<dev:defaultValue>None</dev:defaultValue>
53625424
</command:parameter>
5425+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="Id, KeyId">
5426+
<maml:name>RootKeyId</maml:name>
5427+
<maml:description>
5428+
<maml:para>Specifies a single KDS Root Key to be fetched.</maml:para>
5429+
</maml:description>
5430+
<command:parameterValue required="true" variableLength="false">Guid</command:parameterValue>
5431+
<dev:type>
5432+
<maml:name>Guid</maml:name>
5433+
<maml:uri />
5434+
</dev:type>
5435+
<dev:defaultValue>None</dev:defaultValue>
5436+
</command:parameter>
53635437
</command:parameters>
53645438
<command:inputTypes>
53655439
<command:inputType>
53665440
<dev:type>
5367-
<maml:name>None</maml:name>
5441+
<maml:name>System.Guid</maml:name>
53685442
</dev:type>
53695443
<maml:description>
53705444
<maml:para></maml:para>

0 commit comments

Comments
 (0)