| external help file | Module Name | online version | schema |
|---|---|---|---|
PSScriptTools-help.xml |
PSScriptTools |
2.0.0 |
Get a summary of module commands.
Get-ModuleCommand [-Name] <String> [-ListAvailable] [<CommonParameters>]Get-ModuleCommand -FullyQualifiedName <ModuleSpecification> [-ListAvailable] [<CommonParameters>]This is an alternative to Get-Command to make it easier to see at a glance what commands are contained within a module and what they can do. By default, Get-ModuleCommand looks for loaded modules. Use -ListAvailable to see commands in module not currently loaded. Note that if the help file is malformed or missing, you might get oddly formatted results.
PS C:\> Get-ModuleCommand PSCalendar
ModuleName: PSCalendar
Name Alias Synopsis
---- ----- --------
Get-Calendar cal Displays a visual representation of a calendar.
Show-Calendar scal Display a colorized calendar month in the console.
Show-GuiCalendar gcal Display a WPF-based calendarGet module commands using the default formatted view. You can install this module from the PowerShell Gallery.
PS C:\> Get-ModuleCommand smbshare -ListAvailable | format-list
Name : Block-SmbShareAccess
Alias : blsmba
Synopsis : Adds a deny ACE for a trustee to the security descriptor of the SMB share.
Name : Close-SmbOpenFile
Alias : cssmbo
Synopsis : Closes a file that is open by one of the clients of the SMB server.
Name : Close-SmbSession
Alias : cssmbse
Synopsis : Ends forcibly the SMB session.
...Using the default list view.
PS C:\> Get-ModuleCommand PSScriptTools | format-table -view verb
Verb: Add
Name Alias Type Synopsis
---- ----- ---- --------
Add-Border Function Create a text border around a string.
Verb: Compare
Name Alias Type Synopsis
---- ----- ---- --------
Compare-Module cmo Function Compare PowerShell module versions.
Verb: Convert
Name Alias Type Synopsis
---- ----- ---- --------
Convert-CommandtoHashtable Function Convert a PowerShell expression into a
hashtable.
Convert-EventLogRecord clr Function Convert EventLogRecords to structured
objects.
...Display commands using a custom table view called 'Verb'.
Specifies names of modules in the form of ModuleSpecification objects. The FullyQualifiedName parameter accepts a module name that is specified in the following formats:
@{ModuleName = "modulename"; ModuleVersion = "version_number"}
@{ModuleName = "modulename"; ModuleVersion = "version_number"; Guid = "GUID"}
ModuleName and ModuleVersion are required, but Guid is optional.
You cannot specify the FullyQualifiedName parameter in the same command as a Name parameter.
Type: ModuleSpecification
Parameter Sets: fqdn
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIndicates that this cmdlet gets all installed modules. Get-Module gets modules in paths listed in the PSModulePath environment variable. Without this parameter, Get-ModuleCommand gets only the modules that are both listed in the PSModulePath environment variable, and that are loaded in the current session.
ListAvailable does not return information about modules that are not found in the PSModulePath environment variable, even if those modules are loaded in the current session.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe name of an installed module.
Type: String
Parameter Sets: name
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/