Data ONTAP® PowerShell Toolkit

Switch to clustered Data ONTAP documentation.

Cmdlet: Get-NaHelpAlias


NAME
Get-NaHelpAlias

SYNOPSIS
List aliases for cmdlet parameters.

SYNTAX
Get-NaHelpAlias [-Cmdlet] <String> [<CommonParameters>]


DESCRIPTION
List aliases for cmdlet parameters. Parameter aliases are not included in t
he output of PowerShell's Get-Help cmdlet. This cmdlet works for all PowerS
hell cmdlets available in the current session, not just those in the Data ON
TAP PowerShell Toolkit.


PARAMETERS
-Cmdlet <String>
The cmdlet name. Wildcards are supported.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
DataONTAP.Types.Help.CmdletAliasInfo


NOTES


Category: toolkit

-------------- Example 1 --------------

C:\PS>Get-NaHelpAlias Connect-NaController


Show parameter aliases for the Connect-NaController cmdlet.


Name Aliases
---- -------
Name {Filer}
Port {}
Credential {Cred, Creds}
ForceSecure {HTTPS, SSL, Secure}
ForceUnsecure {HTTP, NoSSL, Unsecure}
Transient {}
Vfiler {}
Timeout {}
Verbose {vb}
Debug {db}
ErrorAction {ea}
WarningAction {wa}
ErrorVariable {ev}
WarningVariable {wv}
OutVariable {ov}
OutBuffer {ob}


-------------- Example 2 --------------

C:\PS>Get-NaHelp -Category clone | Get-NaHelpAlias -Verbose


Get cmdlet parameter aliases for all cmdlets in the clone API category. The
-Verbose switch prints the cmdlet name to demarcate the output sections.


VERBOSE: Clear-NaClone

Name Aliases
---- -------
VolumeUuid {Uuid}
CloneId {}
OpsInfo {}
Controller {Filer, Server}
Verbose {vb}
Debug {db}
ErrorAction {ea}
WarningAction {wa}
ErrorVariable {ev}
WarningVariable {wv}
OutVariable {ov}
OutBuffer {ob}
VERBOSE: Get-NaClone
VolumeUuid {Uuid}
CloneId {}
OpsInfo {}
Controller {Filer, Server}
Verbose {vb}
Debug {db}
ErrorAction {ea}
WarningAction {wa}
ErrorVariable {ev}
WarningVariable {wv}
OutVariable {ov}
OutBuffer {ob}
VERBOSE: Start-NaClone
SourcePath {Source}
DestinationPath {Destination}
NoSnap {}
ChangeLog {}
BlockRanges {}
Controller {Filer, Server}
Verbose {vb}
Debug {db}
ErrorAction {ea}
WarningAction {wa}
ErrorVariable {ev}
WarningVariable {wv}
OutVariable {ov}
OutBuffer {ob}
VERBOSE: Stop-NaClone
VolumeUuid {Uuid}
CloneId {}
OpsInfo {}
Controller {Filer, Server}
Verbose {vb}
Debug {db}
ErrorAction {ea}
WarningAction {wa}
ErrorVariable {ev}
WarningVariable {wv}
OutVariable {ov}
OutBuffer {ob}



RELATED LINKS
Get-NaHelp







 Data ONTAP® PowerShell Toolkit