Skip to content

Latest commit

 

History

History
224 lines (164 loc) · 6.73 KB

Get-ParameterInfo.md

File metadata and controls

224 lines (164 loc) · 6.73 KB
Raw
external help file Module Name online version schema
PSScriptTools-help.xml
PSScriptTools
2.0.0

Get-ParameterInfo

SYNOPSIS

Retrieve command parameter information.

SYNTAX

Get-ParameterInfo [-Command] <String> [-Parameter <String>]
[<CommonParameters>]

DESCRIPTION

Using Get-Command, this function will return information about parameters for any loaded cmdlet or function. The common parameters like Verbose and ErrorAction are omitted. Get-ParameterInfo returns a custom object with the most useful information an administrator might need to know. See examples.

EXAMPLES

EXAMPLE 1

PS C:\> Get-ParameterInfo Export-Clixml

   ParameterSet: __AllParameterSets

Name            Aliases         Mandatory    Position    Type
----            -------         ---------    --------    ----
Depth                           False        Named       System.Int32
Encoding                        False        Named       System.Text.Encoding
Force                           False        Named       System.Management.Auto…
InputObject                     True         Named       System.Management.Auto…
NoClobber       NoOverwrite     False        Named       System.Management.Auto…

   ParameterSet: ByLiteralPath

Name            Aliases         Mandatory    Position    Type
----            -------         ---------    --------    ----
LiteralPath     PSPath,LP       True         Named       System.String

   ParameterSet: ByPath

Name            Aliases         Mandatory    Position    Type
----            -------         ---------    --------    ----
Path                            True         0           System.String

Return parameter information for Export-Clixml using the default table view.

EXAMPLE 2

PS C:\> Get-ParameterInfo mkdir | Select-Object Name,Type,Position,ParameterSet

Name       Type                                         Position ParameterSet
----       ----                                         -------- ------------
Credential System.Management.Automation.PSCredential    Named    __AllParameter…
Force      System.Management.Automation.SwitchParameter Named    __AllParameter…
Value      System.Object                                Named    __AllParameter…
Path       System.String[]                              0        nameSet
Name       System.String                                Named    nameSet
Path       System.String[]                              0        pathSet

Get selected parameter information for the mkdir command.

EXAMPLE 3

PS C:\> Get-ParameterInfo Test-WSMan | Format-List

   ParameterSet: __AllParameterSets

Name                            : ComputerName
Aliases                         : cn
Mandatory                       : False
IsDynamic                       : False
Position                        : 0
Type                            : System.String
ValueFromPipeline               : True
ValueFromPipelineByPropertyName : False

Name                            : Authentication
Aliases                         : auth,am
Mandatory                       : False
IsDynamic                       : False
Position                        : Named
Type                            : Microsoft.WSMan.Management.AuthenticationMecha
                                  nism
ValueFromPipeline               : False
ValueFromPipelineByPropertyName : False

Name                            : CertificateThumbprint
Aliases                         :
Mandatory                       : False
IsDynamic                       : False
Position                        : Named
Type                            : System.String
ValueFromPipeline               : False
ValueFromPipelineByPropertyName : False

Name                            : Credential
Aliases                         : cred,c
Mandatory                       : False
IsDynamic                       : False
Position                        : Named
Type                            : System.Management.Automation.PSCredential
ValueFromPipeline               : False
ValueFromPipelineByPropertyName : True


   ParameterSet: ComputerName

Name                            : ApplicationName
Aliases                         :
Mandatory                       : False
IsDynamic                       : False
Position                        : Named
Type                            : System.String
ValueFromPipeline               : False
ValueFromPipelineByPropertyName : False

Name                            : Port
Aliases                         :
Mandatory                       : False
IsDynamic                       : False
Position                        : Named
Type                            : System.Int32
ValueFromPipeline               : False
ValueFromPipelineByPropertyName : False

Name                            : UseSSL
Aliases                         :
Mandatory                       : False
IsDynamic                       : False
Position                        : Named
Type                            : System.Management.Automation.SwitchParameter
ValueFromPipeline               : False
ValueFromPipelineByPropertyName : False

Get all parameters from Test-WSMan and display details as a list.

Example 4

PS C:\> Get-ParameterInfo -Command Get-Counter -Parameter computername

   ParameterSet: __AllParameterSets


Name                            : computername
Aliases                         : Cn
Mandatory                       : False
IsDynamic                       : False
Position                        : Named
Type                            : System.String[]
ValueFromPipeline               : False
ValueFromPipelineByPropertyName : False

Get details on the Computername parameter of the Get-Counter cmdlet.

PARAMETERS

-Command

The name of a cmdlet or function. The parameter has an alias of Name.

Type: String
Parameter Sets: (All)
Aliases: name

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Parameter

Type: String
Parameter Sets: (All)
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

OUTPUTS

PSParameterInfo

NOTES

Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/

RELATED LINKS

Get-Command

Get-CommandSyntax