Data ONTAP® PowerShell Toolkit

Switch to clustered Data ONTAP documentation.

Cmdlet: Get-NaCommand


NAME
Get-NaCommand

SYNOPSIS
Get a list of Data ONTAP cmdlets.

SYNTAX
Get-NaCommand [[-Name] <String[]>] [-Api <String[]>] [-Category <String[]>]
[-Verb <String[]>] [-Noun <String[]>] [-Controller <NaController>] [<CommonP
arameters>]

Get-NaCommand [[-Name] <String[]>] [-Api <String[]>] [-Category <String[]>]
[-Verb <String[]>] [-Noun <String[]>] -ListAvailable [-Controller <NaControl
ler>] [<CommonParameters>]

Get-NaCommand [[-Name] <String[]>] [-Api <String[]>] [-Category <String[]>]
[-Verb <String[]>] [-Noun <String[]>] -ListUnavailable [-Controller <NaContr
oller>] [<CommonParameters>]


DESCRIPTION
Get a list of Data ONTAP cmdlets.

Get-NaCommand is similar in functionality to Get-NaHelp, while offering adva
nced filtering of available cmdlets in the DataONTAP module. Cmdlets may be
searched by Name, Api, Category, Verb and/or Noun.

The ListAvailable switch will restrict the results to only cmdlets available
on the given (or current) controller connection.

The ListUnavailable switch will restrict the results to only cmdlets unavail
able on the given (or current) controller connection.


PARAMETERS
-Name <String[]>
Name of the cmdlet. Wildcards are accepted.

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

-Api <String[]>
Api of the cmdlet. Wildcards are accepted.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Category <String[]>
Category the cmdlet belongs to. Wildcards are accepted.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Verb <String[]>
Cmdlet verb. Wildcards are accepted.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Noun <String[]>
Cmdlet noun. Wildcards are accepted.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Controller <NaController>
The Data ONTAP controller object, embodied by an NaController object. T
his parameter is returned by the Connect-NaController cmdlet. If not sp
ecified, the value in the global variable CurrentNaController is used.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-ListAvailable
If specified, only cmdlets compatible with the given controller are list
ed.

Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-ListUnavailable
If specified, only cmdlets unavailable on the given controller are liste
d.

Required? true
Position? named
Default value
Accept pipeline input? false
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.PowerShell.SDK.Cmdlets.Help.HelpInfo


NOTES


Category: toolkit

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

C:\PS>Get-NaCommand -Category net -Verb Get, Set


Get all of the get and set commands in the net category.


Name Category Api
---- -------- ---
Get-NaNetActiveConfig net {net-config-get-active}
Get-NaNetDcb net {net-dcb-list-info}
Get-NaNetDcbPriority net {net-dcb-priority-list-i
nfo}
Get-NaNetInterface net {net-ifconfig-get}
Get-NaNetIpspace net {net-ipspace-list}
Get-NaNetPersistentConfig net {net-config-get-persiste
nt}
Get-NaNetRoute net {net-config-get-active}
Get-NaNetVif net {net-config-get-active}
Get-NaNetVlan net {net-config-get-active}
Set-NaNetInterface net {system-cli, net-ifconfi
g-set}
Set-NaNetIpspace net {net-ipspace-assign}
Set-NaNetPersistentConfig net {net-config-set-persiste
nt}
Set-NaNetVif net {system-cli}
Set-NaNetVlan net {system-cli}


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

C:\PS>Get-NaCommand -Category net -Verb Get, Set -ListAvailable


Get all of the get and set commands in the net category that are available t
o run on the current controller.


Name Category Api
---- -------- ---
Get-NaNetActiveConfig net {net-config-get-active}
Get-NaNetInterface net {net-ifconfig-get}
Get-NaNetIpspace net {net-ipspace-list}
Get-NaNetPersistentConfig net {net-config-get-persiste
nt}
Get-NaNetRoute net {net-config-get-active}
Get-NaNetVif net {net-config-get-active}
Get-NaNetVlan net {net-config-get-active}
Set-NaNetInterface net {system-cli, net-ifconfi
g-set}
Set-NaNetIpspace net {net-ipspace-assign}
Set-NaNetPersistentConfig net {net-config-set-persiste
nt}
Set-NaNetVif net {system-cli}
Set-NaNetVlan net {system-cli}


-------------- Example 3 --------------

C:\PS>Get-NaCommand -Category net -Verb Get, Set -ListUnavailable


Get all of the get and set cmdlets in the net category are not available to
run on the current controller.


Name Category Api
---- -------- ---
Get-NaNetDcb net {net-dcb-list-info}
Get-NaNetDcbPriority net {net-dcb-priority-list-i
nfo}



RELATED LINKS







 Data ONTAP® PowerShell Toolkit