CmdletInfo Class

  • Reference

Definition

Namespace:
System.Management.Automation
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
System.Management.Automation v7.0.13
Package:
System.Management.Automation v7.1.7
Package:
System.Management.Automation v7.2.12
Package:
System.Management.Automation v7.3.5
Package:
System.Management.Automation v7.4.0
Package:
Microsoft.WSMan.Runtime v6.1.0
Package:
Microsoft.WSMan.Runtime v6.2.0

The command information for cmdlets that are directly executable by PowerShell.

public ref class CmdletInfo : System::Management::Automation::CommandInfo
public class CmdletInfo : System.Management.Automation.CommandInfo
type CmdletInfo = class
    inherit CommandInfo
Public Class CmdletInfo
Inherits CommandInfo
Inheritance
Object
CommandInfo
CmdletInfo

Constructors

CmdletInfo(String, Type)

Directly create a cmdlet object from a type. This allows unregistered commands to be called. It also allows the overhead of command discovery to be bypassed.

Properties

CommandType

Gets the type of the command.

(Inherited from CommandInfo)
DefaultParameterSet

Gets the name of the default parameter set.
Definition

Gets the synopsis of the cmdlet.
HelpFile

Gets the help file path for the cmdlet.
ImplementingType

Gets the type that implements the cmdlet.
Module

The module that defines this cmdlet. This will be null for commands that are not defined in the context of a module.

(Inherited from CommandInfo)
ModuleName

The module name of this command. It will be empty for commands not imported from either a module or snapin.

(Inherited from CommandInfo)
Name

Gets the name of the command.

(Inherited from CommandInfo)
Noun

Gets the noun of the cmdlet.
Options

Gets or sets the scope options for the alias.
OutputType

Return the output types specified on the cmdlet.
Parameters

Return the parameters for this command.

(Inherited from CommandInfo)
ParameterSets

Gets the information about the parameters and parameter sets for this command.

(Inherited from CommandInfo)
PSSnapIn

Gets the Snap-in in which the cmdlet is implemented.
RemotingCapability

The remoting capabilities of this cmdlet, when exposed in a context with ambient remoting.

(Inherited from CommandInfo)
Source

Gets the source of the command (shown by default in Get-Command)

(Inherited from CommandInfo)
Verb

Gets the verb of the cmdlet.
Version

Gets the source version.
Visibility

Indicates if the command is to be allowed to be executed by a request external to the runspace.

(Inherited from CommandInfo)

Methods

ResolveParameter(String)

Resolves a full, shortened, or aliased parameter name to the actual cmdlet parameter name, using PowerShell's standard parameter resolution algorithm.

(Inherited from CommandInfo)
ToString()

For diagnostic purposes.

(Inherited from CommandInfo)

Applies to