Skip to content

Commit 95a6de4

Browse files
committed
Update markdown and external help files
* Make the credential parameter optional because of the newly introduced GRRCredential variable * Update external help file for the new parameter "UseTsk"
1 parent 5e0d83b commit 95a6de4

28 files changed

+122
-123
lines changed

docs/Add-GRRArtifact.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Upload artifact to GRR.
1212
## SYNTAX
1313

1414
```
15-
Add-GRRArtifact [[-ArtifactFile] <String>] [-Credential] <PSCredential> [-ShowJSON] [-WhatIf] [-Confirm]
15+
Add-GRRArtifact [[-ArtifactFile] <String>] [[-Credential] <PSCredential>] [-ShowJSON] [-WhatIf] [-Confirm]
1616
[<CommonParameters>]
1717
```
1818

@@ -38,7 +38,6 @@ Upload artifact "OutlookFiles" to GRR. See https://github.com/ForensicArtifacts/
3838
information about artifact definition. No credentials parameter is used
3939
because `$GRRCredential` is set before running the command.
4040

41-
4241
## PARAMETERS
4342

4443
### -ArtifactFile
@@ -79,7 +78,7 @@ Type: PSCredential
7978
Parameter Sets: (All)
8079
Aliases:
8180

82-
Required: True
81+
Required: False
8382
Position: 1
8483
Default value: None
8584
Accept pipeline input: False

docs/ConvertFrom-Base64.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ therefore Convertfrom-Base64 provides the needed step in between.
4343

4444
### Example 3
4545
```
46-
PS C:\> $ret = $ret.items | ? {($_.payload | ConvertFrom-Base64) -match "false" }
46+
PS C:\> $ret = $ret.items | ? {($_.payload | ConvertFrom-Base64) -match "false" }
4747
```
4848

4949
Analyse return values from a hunt and filter them for specific payload values.

docs/Find-GRRClient.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ the computername or the whole GRR object.
1313
## SYNTAX
1414

1515
```
16-
Find-GRRClient [[-SearchString] <String>] [-Credential] <PSCredential> [-OnlyComputerName] [-ShowJSON]
16+
Find-GRRClient [[-SearchString] <String>] [[-Credential] <PSCredential>] [-OnlyComputerName] [-ShowJSON]
1717
[<CommonParameters>]
1818
```
1919

@@ -65,7 +65,7 @@ Type: PSCredential
6565
Parameter Sets: (All)
6666
Aliases:
6767

68-
Required: True
68+
Required: False
6969
Position: 1
7070
Default value: None
7171
Accept pipeline input: False

docs/Find-GRRClientByLabel.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Search for clients with a given label.
1212
## SYNTAX
1313

1414
```
15-
Find-GRRClientByLabel [[-SearchString] <String>] [-Credential] <PSCredential> [-OnlyComputerName] [-ShowJSON]
15+
Find-GRRClientByLabel [[-SearchString] <String>] [[-Credential] <PSCredential>] [-OnlyComputerName] [-ShowJSON]
1616
[<CommonParameters>]
1717
```
1818

@@ -45,7 +45,7 @@ Type: PSCredential
4545
Parameter Sets: (All)
4646
Aliases:
4747

48-
Required: True
48+
Required: False
4949
Position: 1
5050
Default value: None
5151
Accept pipeline input: False

docs/Get-GRRArtifact.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Get a list of all GRR artifacts.
1212
## SYNTAX
1313

1414
```
15-
Get-GRRArtifact [-Credential] <PSCredential> [-ShowJSON] [<CommonParameters>]
15+
Get-GRRArtifact [[-Credential] <PSCredential>] [-ShowJSON] [<CommonParameters>]
1616
```
1717

1818
## DESCRIPTION
@@ -80,7 +80,7 @@ Type: PSCredential
8080
Parameter Sets: (All)
8181
Aliases:
8282

83-
Required: True
83+
Required: False
8484
Position: 0
8585
Default value: None
8686
Accept pipeline input: False

docs/Get-GRRClientApproval.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ Get client approval identified by the given filters.
1313

1414
### ByUser (Default)
1515
```
16-
Get-GRRClientApproval [-Credential] <PSCredential> [[-ComputerName] <String>] [[-Offset] <Int32>]
16+
Get-GRRClientApproval [[-Credential] <PSCredential>] [[-ComputerName] <String>] [[-Offset] <Int32>]
1717
[[-Count] <Int32>] [[-State] <String>] [-ShowJSON] [<CommonParameters>]
1818
```
1919

2020
### ByApproval
2121
```
22-
Get-GRRClientApproval [-Credential] <PSCredential> [-ComputerName] <String> [-ApprovalId] <String> [-OnlyState]
23-
[-ShowJSON] [<CommonParameters>]
22+
Get-GRRClientApproval [[-Credential] <PSCredential>] [-ComputerName] <String> [-ApprovalId] <String>
23+
[-OnlyState] [-ShowJSON] [<CommonParameters>]
2424
```
2525

2626
## DESCRIPTION
@@ -152,7 +152,7 @@ Type: PSCredential
152152
Parameter Sets: (All)
153153
Aliases:
154154

155-
Required: True
155+
Required: False
156156
Position: Benannt
157157
Default value: None
158158
Accept pipeline input: False

docs/Get-GRRClientIdFromComputerName.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Convert a list of computer names into the corresponding GRR client id.
1212
## SYNTAX
1313

1414
```
15-
Get-GRRClientIdFromComputerName [[-ComputerName] <String[]>] [-Credential] <PSCredential> [-OnlyLastSeen]
15+
Get-GRRClientIdFromComputerName [[-ComputerName] <String[]>] [[-Credential] <PSCredential>] [-OnlyLastSeen]
1616
[-ShowJSON] [<CommonParameters>]
1717
```
1818

@@ -85,7 +85,7 @@ Type: PSCredential
8585
Parameter Sets: (All)
8686
Aliases:
8787

88-
Required: True
88+
Required: False
8989
Position: 1
9090
Default value: None
9191
Accept pipeline input: False

docs/Get-GRRClientInfo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Get important client infos.
1212
## SYNTAX
1313

1414
```
15-
Get-GRRClientInfo [[-ComputerName] <String[]>] [-Credential] <PSCredential> [-OnlyLastSeen] [-ShowJSON]
15+
Get-GRRClientInfo [[-ComputerName] <String[]>] [[-Credential] <PSCredential>] [-OnlyLastSeen] [-ShowJSON]
1616
[<CommonParameters>]
1717
```
1818

@@ -61,7 +61,7 @@ Type: PSCredential
6161
Parameter Sets: (All)
6262
Aliases:
6363

64-
Required: True
64+
Required: False
6565
Position: 1
6666
Default value: None
6767
Accept pipeline input: False

docs/Get-GRRComputerNameFromClientId.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Search for a specific client id and return the computer name.
1212
## SYNTAX
1313

1414
```
15-
Get-GRRComputerNameFromClientId [[-ClientId] <String[]>] [-Credential] <PSCredential> [-ShowJSON]
15+
Get-GRRComputerNameFromClientId [[-ClientId] <String[]>] [[-Credential] <PSCredential>] [-ShowJSON]
1616
[<CommonParameters>]
1717
```
1818

@@ -67,7 +67,7 @@ Type: PSCredential
6767
Parameter Sets: (All)
6868
Aliases:
6969

70-
Required: True
70+
Required: False
7171
Position: 1
7272
Default value: None
7373
Accept pipeline input: False

docs/Get-GRRFlowDescriptor.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Get a list of all available flows.
1212
## SYNTAX
1313

1414
```
15-
Get-GRRFlowDescriptor [-Credential] <PSCredential> [-ShowJSON] [<CommonParameters>]
15+
Get-GRRFlowDescriptor [[-Credential] <PSCredential>] [-ShowJSON] [<CommonParameters>]
1616
```
1717

1818
## DESCRIPTION
@@ -68,7 +68,7 @@ Type: PSCredential
6868
Parameter Sets: (All)
6969
Aliases:
7070

71-
Required: True
71+
Required: False
7272
Position: 0
7373
Default value: None
7474
Accept pipeline input: False

docs/Get-GRRFlowResult.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Get flow results for a specific client and a flow.
1212
## SYNTAX
1313

1414
```
15-
Get-GRRFlowResult [-ComputerName] <String> [-Credential] <PSCredential> [-FlowId] <String> [-OnlyPayload]
15+
Get-GRRFlowResult [-ComputerName] <String> [[-Credential] <PSCredential>] [-FlowId] <String> [-OnlyPayload]
1616
[-ShowJSON] [<CommonParameters>]
1717
```
1818

@@ -62,7 +62,7 @@ Type: PSCredential
6262
Parameter Sets: (All)
6363
Aliases:
6464

65-
Required: True
65+
Required: False
6666
Position: 1
6767
Default value: None
6868
Accept pipeline input: False

docs/Get-GRRHunt.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,18 @@ afterwards with PowerShell.
1414

1515
### Count (Default)
1616
```
17-
Get-GRRHunt [-Credential] <PSCredential> [-Count <Int32>] [-Offset <Int32>] [-ShowJSON] [<CommonParameters>]
17+
Get-GRRHunt [[-Credential] <PSCredential>] [-Count <Int32>] [-Offset <Int32>] [-ShowJSON] [<CommonParameters>]
1818
```
1919

2020
### CreatedBy
2121
```
22-
Get-GRRHunt [-Credential] <PSCredential> [-CreatedBy <String>] -ActiveWithin <String> [-ShowJSON]
22+
Get-GRRHunt [[-Credential] <PSCredential>] [-CreatedBy <String>] -ActiveWithin <String> [-ShowJSON]
2323
[<CommonParameters>]
2424
```
2525

2626
### DescriptionContains
2727
```
28-
Get-GRRHunt [-Credential] <PSCredential> [-DescriptionContains <String>] -ActiveWithin <String> [-ShowJSON]
28+
Get-GRRHunt [[-Credential] <PSCredential>] [-DescriptionContains <String>] -ActiveWithin <String> [-ShowJSON]
2929
[<CommonParameters>]
3030
```
3131

@@ -64,7 +64,7 @@ Type: PSCredential
6464
Parameter Sets: (All)
6565
Aliases:
6666

67-
Required: True
67+
Required: False
6868
Position: 0
6969
Default value: None
7070
Accept pipeline input: False

docs/Get-GRRHuntApproval.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ Get hunt approval identified by the given filters.
1313

1414
### ByUser (Default)
1515
```
16-
Get-GRRHuntApproval [-Credential] <PSCredential> [[-Offset] <Int32>] [[-Count] <Int32>] [-ShowJSON]
16+
Get-GRRHuntApproval [[-Credential] <PSCredential>] [[-Offset] <Int32>] [[-Count] <Int32>] [-ShowJSON]
1717
[<CommonParameters>]
1818
```
1919

2020
### ByApproval
2121
```
22-
Get-GRRHuntApproval [-Credential] <PSCredential> [-HuntId] <String> [-ApprovalId] <String> [-OnlyState]
22+
Get-GRRHuntApproval [[-Credential] <PSCredential>] [-HuntId] <String> [-ApprovalId] <String> [-OnlyState]
2323
[-ShowJSON] [<CommonParameters>]
2424
```
2525

@@ -131,7 +131,7 @@ Type: PSCredential
131131
Parameter Sets: (All)
132132
Aliases:
133133

134-
Required: True
134+
Required: False
135135
Position: Benannt
136136
Default value: None
137137
Accept pipeline input: False

docs/Get-GRRHuntInfo.md

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

1414
```
15-
Get-GRRHuntInfo [[-HuntId] <String>] [-Credential] <PSCredential> [-ShowResultCount] [-ShowJSON]
15+
Get-GRRHuntInfo [[-HuntId] <String>] [[-Credential] <PSCredential>] [-ShowResultCount] [-ShowJSON]
1616
[<CommonParameters>]
1717
```
1818

@@ -38,7 +38,7 @@ Type: PSCredential
3838
Parameter Sets: (All)
3939
Aliases:
4040

41-
Required: True
41+
Required: False
4242
Position: 1
4343
Default value: None
4444
Accept pipeline input: False

docs/Get-GRRHuntResult.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Get hunt results for a specific hunt.
1212
## SYNTAX
1313

1414
```
15-
Get-GRRHuntResult [[-HuntId] <String>] [-Credential] <PSCredential> [-ShowJSON] [<CommonParameters>]
15+
Get-GRRHuntResult [[-HuntId] <String>] [[-Credential] <PSCredential>] [-ShowJSON] [<CommonParameters>]
1616
```
1717

1818
## DESCRIPTION
@@ -42,7 +42,7 @@ Type: PSCredential
4242
Parameter Sets: (All)
4343
Aliases:
4444

45-
Required: True
45+
Required: False
4646
Position: 1
4747
Default value: None
4848
Accept pipeline input: False

docs/Get-GRRLabel.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Get all labels.
1212
## SYNTAX
1313

1414
```
15-
Get-GRRLabel [-Credential] <PSCredential> [-ShowJSON] [<CommonParameters>]
15+
Get-GRRLabel [[-Credential] <PSCredential>] [-ShowJSON] [<CommonParameters>]
1616
```
1717

1818
## DESCRIPTION
@@ -44,7 +44,7 @@ Type: PSCredential
4444
Parameter Sets: (All)
4545
Aliases:
4646

47-
Required: True
47+
Required: False
4848
Position: 0
4949
Default value: None
5050
Accept pipeline input: False

docs/Get-GRRSession.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Return the headers and the websession for a specific GRR server.
1212
## SYNTAX
1313

1414
```
15-
Get-GRRSession [-Credential] <PSCredential> [<CommonParameters>]
15+
Get-GRRSession [[-Credential] <PSCredential>] [<CommonParameters>]
1616
```
1717

1818
## DESCRIPTION
@@ -40,7 +40,7 @@ Type: PSCredential
4040
Parameter Sets: (All)
4141
Aliases:
4242

43-
Required: True
43+
Required: False
4444
Position: 0
4545
Default value: None
4646
Accept pipeline input: False

docs/Invoke-GRRRequest.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,18 @@ can use this function to run the needed request.
1515
### FILE
1616
```
1717
Invoke-GRRRequest [-Url] <String> -File <FileInfo> [-Headers] <Hashtable> [-Websession] <WebRequestSession>
18-
[-Method <String>] [-Credential] <PSCredential> [-ShowJSON] [<CommonParameters>]
18+
[-Method <String>] [[-Credential] <PSCredential>] [-ShowJSON] [<CommonParameters>]
1919
```
2020

2121
### POST
2222
```
2323
Invoke-GRRRequest [-Url] <String> [-Body] <String> [-Headers] <Hashtable> [-Websession] <WebRequestSession>
24-
[-Method <String>] [-Credential] <PSCredential> [-ShowJSON] [<CommonParameters>]
24+
[-Method <String>] [[-Credential] <PSCredential>] [-ShowJSON] [<CommonParameters>]
2525
```
2626

2727
### GET
2828
```
29-
Invoke-GRRRequest [-Url] <String> [-Method <String>] [-Credential] <PSCredential> [-ShowJSON]
29+
Invoke-GRRRequest [-Url] <String> [-Method <String>] [[-Credential] <PSCredential>] [-ShowJSON]
3030
[<CommonParameters>]
3131
```
3232

@@ -69,7 +69,7 @@ Type: PSCredential
6969
Parameter Sets: (All)
7070
Aliases:
7171

72-
Required: True
72+
Required: False
7373
Position: Benannt
7474
Default value: None
7575
Accept pipeline input: False

docs/New-GRRClientApproval.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Create a new client approval.
1212
## SYNTAX
1313

1414
```
15-
New-GRRClientApproval [-ComputerName] <String> [-Credential] <PSCredential> [-NotifiedUsers] <String[]>
15+
New-GRRClientApproval [-ComputerName] <String> [[-Credential] <PSCredential>] [-NotifiedUsers] <String[]>
1616
[-Reason] <String> [-OnlyId] [-ShowJSON] [-WhatIf] [-Confirm] [<CommonParameters>]
1717
```
1818

@@ -68,7 +68,7 @@ Type: PSCredential
6868
Parameter Sets: (All)
6969
Aliases:
7070

71-
Required: True
71+
Required: False
7272
Position: 1
7373
Default value: None
7474
Accept pipeline input: False

0 commit comments

Comments
 (0)