Skip to content

Missing help documentation for parameter SslProtocol of Invoke-WebRequest and Invoke-RestMethod cmdlets #1866

Closed
@ScriptAutomate

Description

@ScriptAutomate

Issue Details

Note: Directly related to PR #5329 in PowerShell/PowerShell

Definition and summary information, that can be used for creating the documentation, could be taken from the commits themselves, which I have pretty much copy/pasted below.

Documentation for -SslProtocol is missing for:

Default value is Default

Accepted/Restricted values at the moment are based on available values for the Microsoft.PowerShell.Commands.WebSslProtocol type:

  • Default
  • Tls
  • Tls11
  • Tls12

Potential definitions:

Could be simple:

Sets the TLS/SSL protocol used by the Web Cmdlet.

Or, if after each new value is made available for the Microsoft.PowerShell.Commands.WebSslProtocol type, start with the following description (and update over time):

Sets the TLS/SSL protocol used by the Web Cmdlet. The following values can be used: Default, Tls, Tls11, or Tls12.

Default means no SSL protocol will be set and the system defaults will be used. Tls is the TLS 1.0 security protocol. The TLS protocol is defined in IETF RFC 2246. Tls11 is the TLS 1.1 security protocol. The TLS protocol is defined in IETF RFC 4346. Tls12 is the TLS 1.2 security protocol. The TLS protocol is defined in IETF RFC 5246

May look something like this in the parameter YAML:

Type: WebSslProtocol
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Default
Accept pipeline input: False
Accept wildcard characters: False

Note: I have not tested whether values can be passed in via pipeline, or whether it is available for all parameter sets.

Version(s) of document impacted

  • Impacts 6 document
  • Impacts 5.1 document
  • Impacts 5.0 document
  • Impacts 4.0 document
  • Impacts 3.0 document

Reason(s) for not selecting all version of documents

  • The documented feature was introduced in selected version of PowerShell
  • This issue only shows up in selected version of the document

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions