Skip to content

Commit d8d3606

Browse files
KarneadesKarneades
committed
Update help
1 parent 07a5845 commit d8d3606

6 files changed

Lines changed: 176 additions & 8 deletions

File tree

‎docs/ConvertFrom-Base64.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Decode a base64 encoded string.
1212
## SYNTAX
1313

1414
```
15-
ConvertFrom-Base64 [-String] <String> [-Encoding <String>]
15+
ConvertFrom-Base64 [-String] <String> [-Encoding <String>] [<CommonParameters>]
1616
```
1717

1818
## DESCRIPTION
@@ -40,7 +40,6 @@ Convert the collected sha256 hash (hash_entry e.g. from file finder flow) to
4040
the corresponding hex representation. The payload from GRR is base64 encoded,
4141
therefore Convertfrom-Base64 provides the needed step in between.
4242

43-
4443
## PARAMETERS
4544

4645
### -String
@@ -73,6 +72,9 @@ Accept pipeline input: False
7372
Accept wildcard characters: False
7473
```
7574
75+
### CommonParameters
76+
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).
77+
7678
## INPUTS
7779
7880
### System.String

‎docs/Get-GRRHuntInfo.md‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ Get hunt info for a specific hunt.
1212
## SYNTAX
1313

1414
```
15-
Get-GRRHuntInfo [[-HuntId] <String>] [-Credential] <PSCredential> [-ShowJSON] [<CommonParameters>]
15+
Get-GRRHuntInfo [[-HuntId] <String>] [-Credential] <PSCredential> [-ShowResultCount] [-ShowJSON]
16+
[<CommonParameters>]
1617
```
1718

1819
## DESCRIPTION
@@ -74,6 +75,21 @@ Accept pipeline input: False
7475
Accept wildcard characters: False
7576
```
7677
78+
### -ShowResultCount
79+
{{Fill ShowResultCount Description}}
80+
81+
```yaml
82+
Type: SwitchParameter
83+
Parameter Sets: (All)
84+
Aliases:
85+
86+
Required: False
87+
Position: Named
88+
Default value: None
89+
Accept pipeline input: False
90+
Accept wildcard characters: False
91+
```
92+
7793
### CommonParameters
7894
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).
7995

‎docs/Start-GRRHunt.md‎

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,18 @@ Start a GRR hunt based on the hunt id.
1111

1212
## SYNTAX
1313

14+
### Default (Default)
1415
```
15-
Start-GRRHunt [[-HuntId] <String>] [-Credential] <PSCredential> [-ShowJSON] [-WhatIf] [-Confirm]
16+
Start-GRRHunt [-Credential] <PSCredential> [[-HuntId] <String>] [-ShowJSON] [-WhatIf] [-Confirm]
1617
[<CommonParameters>]
1718
```
1819

20+
### WaitForApproval
21+
```
22+
Start-GRRHunt [-Credential] <PSCredential> [[-HuntId] <String>] [-Wait] -ApprovalId <String>
23+
[-TimeoutInMinutes <Int32>] [-ShowJSON] [-WhatIf] [-Confirm] [<CommonParameters>]
24+
```
25+
1926
## DESCRIPTION
2027
{{Fill in the Description}}
2128

@@ -113,6 +120,51 @@ Accept pipeline input: False
113120
Accept wildcard characters: False
114121
```
115122
123+
### -ApprovalId
124+
{{Fill ApprovalId Description}}
125+
126+
```yaml
127+
Type: String
128+
Parameter Sets: WaitForApproval
129+
Aliases:
130+
131+
Required: True
132+
Position: Named
133+
Default value: None
134+
Accept pipeline input: False
135+
Accept wildcard characters: False
136+
```
137+
138+
### -TimeoutInMinutes
139+
{{Fill TimeoutInMinutes Description}}
140+
141+
```yaml
142+
Type: Int32
143+
Parameter Sets: WaitForApproval
144+
Aliases:
145+
146+
Required: False
147+
Position: Named
148+
Default value: None
149+
Accept pipeline input: False
150+
Accept wildcard characters: False
151+
```
152+
153+
### -Wait
154+
{{Fill Wait Description}}
155+
156+
```yaml
157+
Type: SwitchParameter
158+
Parameter Sets: WaitForApproval
159+
Aliases:
160+
161+
Required: True
162+
Position: Named
163+
Default value: None
164+
Accept pipeline input: False
165+
Accept wildcard characters: False
166+
```
167+
116168
### CommonParameters
117169
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).
118170

‎docs/Wait-GRRClientApproval.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ schema: 2.0.0
1313

1414
```
1515
Wait-GRRClientApproval [-ComputerName] <String> [-Credential] <PSCredential> [-ApprovalId] <String>
16-
[[-TimeoutInMinutes] <Int32>] [[-Interval] <Int32>] [-ShowJSON] [-WhatIf] [-Confirm]
16+
[[-TimeoutInMinutes] <Int32>] [[-Interval] <Int32>] [-ShowJSON] [-WhatIf] [-Confirm] [<CommonParameters>]
1717
```
1818

1919
## DESCRIPTION
@@ -151,11 +151,13 @@ Accept pipeline input: False
151151
Accept wildcard characters: False
152152
```
153153
154+
### CommonParameters
155+
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).
156+
154157
## INPUTS
155158
156159
### Keine
157160
158-
159161
## OUTPUTS
160162
161163
### System.Object

‎docs/Wait-GRRHuntApproval.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ schema: 2.0.0
1313

1414
```
1515
Wait-GRRHuntApproval [-Credential] <PSCredential> [-HuntId] <String> [-ApprovalId] <String>
16-
[[-TimeoutInMinutes] <Int32>] [[-Interval] <Int32>] [-ShowJSON] [-WhatIf] [-Confirm]
16+
[[-TimeoutInMinutes] <Int32>] [[-Interval] <Int32>] [-ShowJSON] [-WhatIf] [-Confirm] [<CommonParameters>]
1717
```
1818

1919
## DESCRIPTION
@@ -151,11 +151,13 @@ Accept pipeline input: False
151151
Accept wildcard characters: False
152152
```
153153
154+
### CommonParameters
155+
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).
156+
154157
## INPUTS
155158
156159
### Keine
157160
158-
159161
## OUTPUTS
160162
161163
### System.Object

‎en-us/PowerGRR-help.xml‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2528,6 +2528,17 @@ False</dev:code>
25282528
</dev:type>
25292529
<dev:defaultValue>False</dev:defaultValue>
25302530
</command:parameter>
2531+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
2532+
<maml:name>ShowResultCount</maml:name>
2533+
<maml:Description>
2534+
<maml:para>{{Fill ShowResultCount Description}}</maml:para>
2535+
</maml:Description>
2536+
<dev:type>
2537+
<maml:name>SwitchParameter</maml:name>
2538+
<maml:uri />
2539+
</dev:type>
2540+
<dev:defaultValue>False</dev:defaultValue>
2541+
</command:parameter>
25312542
</command:syntaxItem>
25322543
</command:syntax>
25332544
<command:parameters>
@@ -2567,6 +2578,18 @@ False</dev:code>
25672578
</dev:type>
25682579
<dev:defaultValue>False</dev:defaultValue>
25692580
</command:parameter>
2581+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
2582+
<maml:name>ShowResultCount</maml:name>
2583+
<maml:Description>
2584+
<maml:para>{{Fill ShowResultCount Description}}</maml:para>
2585+
</maml:Description>
2586+
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
2587+
<dev:type>
2588+
<maml:name>SwitchParameter</maml:name>
2589+
<maml:uri />
2590+
</dev:type>
2591+
<dev:defaultValue>False</dev:defaultValue>
2592+
</command:parameter>
25702593
</command:parameters>
25712594
<command:inputTypes>
25722595
<command:inputType>
@@ -5047,6 +5070,41 @@ PS C:\&gt; "host1", "host2" | Set-GRRLabel -Label label1 -Credential $creds</dev
50475070
</dev:type>
50485071
<dev:defaultValue>False</dev:defaultValue>
50495072
</command:parameter>
5073+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
5074+
<maml:name>ApprovalId</maml:name>
5075+
<maml:Description>
5076+
<maml:para>{{Fill ApprovalId Description}}</maml:para>
5077+
</maml:Description>
5078+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
5079+
<dev:type>
5080+
<maml:name>String</maml:name>
5081+
<maml:uri />
5082+
</dev:type>
5083+
<dev:defaultValue>None</dev:defaultValue>
5084+
</command:parameter>
5085+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
5086+
<maml:name>TimeoutInMinutes</maml:name>
5087+
<maml:Description>
5088+
<maml:para>{{Fill TimeoutInMinutes Description}}</maml:para>
5089+
</maml:Description>
5090+
<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
5091+
<dev:type>
5092+
<maml:name>Int32</maml:name>
5093+
<maml:uri />
5094+
</dev:type>
5095+
<dev:defaultValue>None</dev:defaultValue>
5096+
</command:parameter>
5097+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
5098+
<maml:name>Wait</maml:name>
5099+
<maml:Description>
5100+
<maml:para>{{Fill Wait Description}}</maml:para>
5101+
</maml:Description>
5102+
<dev:type>
5103+
<maml:name>SwitchParameter</maml:name>
5104+
<maml:uri />
5105+
</dev:type>
5106+
<dev:defaultValue>False</dev:defaultValue>
5107+
</command:parameter>
50505108
</command:syntaxItem>
50515109
</command:syntax>
50525110
<command:parameters>
@@ -5110,6 +5168,42 @@ PS C:\&gt; "host1", "host2" | Set-GRRLabel -Label label1 -Credential $creds</dev
51105168
</dev:type>
51115169
<dev:defaultValue>False</dev:defaultValue>
51125170
</command:parameter>
5171+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
5172+
<maml:name>ApprovalId</maml:name>
5173+
<maml:Description>
5174+
<maml:para>{{Fill ApprovalId Description}}</maml:para>
5175+
</maml:Description>
5176+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
5177+
<dev:type>
5178+
<maml:name>String</maml:name>
5179+
<maml:uri />
5180+
</dev:type>
5181+
<dev:defaultValue>None</dev:defaultValue>
5182+
</command:parameter>
5183+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
5184+
<maml:name>TimeoutInMinutes</maml:name>
5185+
<maml:Description>
5186+
<maml:para>{{Fill TimeoutInMinutes Description}}</maml:para>
5187+
</maml:Description>
5188+
<command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
5189+
<dev:type>
5190+
<maml:name>Int32</maml:name>
5191+
<maml:uri />
5192+
</dev:type>
5193+
<dev:defaultValue>None</dev:defaultValue>
5194+
</command:parameter>
5195+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
5196+
<maml:name>Wait</maml:name>
5197+
<maml:Description>
5198+
<maml:para>{{Fill Wait Description}}</maml:para>
5199+
</maml:Description>
5200+
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
5201+
<dev:type>
5202+
<maml:name>SwitchParameter</maml:name>
5203+
<maml:uri />
5204+
</dev:type>
5205+
<dev:defaultValue>False</dev:defaultValue>
5206+
</command:parameter>
51135207
</command:parameters>
51145208
<command:inputTypes>
51155209
<command:inputType>

0 commit comments

Comments
 (0)