Skip to content

Commit 45c6032

Browse files
committed
Added parameter help to Invoke-SgwRequest
1 parent a8e6380 commit 45c6032

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

src/StorageGRID-Webscale.psm1

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -278,8 +278,32 @@ function ConvertTo-SgwConfigFile {
278278
}
279279
}
280280

281-
## function to trigger request to StorageGRID Webscale Server ##
282-
281+
<#
282+
.SYNOPSIS
283+
Invoke request to StorageGRID Webscale Server
284+
.DESCRIPTION
285+
Invoke request to StorageGRID Webscale Server
286+
.PARAMETER Uri
287+
Uri
288+
.PARAMETER WebSession
289+
WebSession
290+
.PARAMETER Method
291+
HTTP Method
292+
.PARAMETER Headers
293+
HTTP Headers
294+
.PARAMETER Body
295+
Body
296+
.PARAMETER ContentType
297+
Content Type
298+
.PARAMETER SessionVariable
299+
Variable to store session details in
300+
.PARAMETER TimeoutSec
301+
Timeout in seconds
302+
.PARAMETER SkipCertificateCheck
303+
Skip certificate check
304+
.PARAMETER OutFile
305+
File to output result to
306+
#>
283307
function Invoke-SgwRequest {
284308
[CmdletBinding()]
285309

@@ -295,7 +319,7 @@ function Invoke-SgwRequest {
295319
HelpMessage = "HTTP Method")][ValidateSet("Default", "Get", "Head", "Post", "Put", "Delete", "Trace", "Options", "Merge", "Patch")][String]$Method = "Get",
296320
[parameter(Mandatory = $False,
297321
Position = 3,
298-
HelpMessage = "Headers")][Hashtable]$Headers,
322+
HelpMessage = "HTTP Headers")][Hashtable]$Headers,
299323
[parameter(Mandatory = $False,
300324
Position = 4,
301325
HelpMessage = "Body")][Object]$Body,
@@ -310,7 +334,7 @@ function Invoke-SgwRequest {
310334
HelpMessage = "Timeout in seconds")][Int]$TimeoutSec = 60,
311335
[parameter(Mandatory = $False,
312336
Position = 8,
313-
HelpMessage = "Skip certificate checks")][Switch]$SkipCertificateCheck,
337+
HelpMessage = "Skip certificate check")][Switch]$SkipCertificateCheck,
314338
[parameter(
315339
Mandatory=$False,
316340
Position=9,

0 commit comments

Comments
 (0)