|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Get-NcCommand
NAME
Get-NcCommand
SYNOPSIS
Get a list of clustered Data ONTAP cmdlets.
SYNTAX
Get-NcCommand [[-Name] <String[]>] [-Api <String[]>] [-Family <String[]>] [-
Category <String[]>] [-Verb <String[]>] [-Noun <String[]>] [-Controller <NcC
ontroller>] [-VserverContext <String>] [<CommonParameters>]
Get-NcCommand [[-Name] <String[]>] [-Api <String[]>] [-Family <String[]>] [-
Category <String[]>] [-Verb <String[]>] [-Noun <String[]>] -ListAvailable [-
Controller <NcController>] [-VserverContext <String>] [<CommonParameters>]
Get-NcCommand [[-Name] <String[]>] [-Api <String[]>] [-Family <String[]>] [-
Category <String[]>] [-Verb <String[]>] [-Noun <String[]>] -ListUnavailable
[-Controller <NcController>] [-VserverContext <String>] [<CommonParameters>]
DESCRIPTION
Get a list of clustered Data ONTAP cmdlets.
Get-NcCommand is similar in functionality to Get-NcHelp, while offering adva
nced filtering of available cmdlets in the DataONTAP module. Cmdlets may be
searched by Name, Api, Category, Family, 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
-Family <String[]>
Family the cmdlet belongs to. 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 <NcController>
A clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on t
he first controller in the collection.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-VserverContext <String>
Vserver to which to direct this command. If the currently connected con
troller (as embodied by an NcController object) represents a cluster, th
ere are multiple means to address commands to one of its vservers. Eith
er set the Vserver field on the NcController object to direct all subseq
uent commands to that vserver, or supply the VserverContext parameter to
an individual cmdlet. Only cmdlets which may be invoked on vservers of
fer the VserverContext parameter.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ListAvailable
If specified, only cmdlets available on the given controller are listed.
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-NcCommand -Category net -Verb Get, Set
Get all of the get and set cmdlets in the net category.
Name Category Family Api
---- -------- ------ ---
Get-NcNetDns net {cluster, vserver} {ne
t-dns-get-iter}
Get-NcNetDnsHost net {cluster, vserver} {ne
t-hosts-get-iter}
Get-NcNetInterface net {cluster, vserver} {ne
t-interface-get-iter}
Get-NcNetPort net {cluster} {ne
t-port-get-iter}
Get-NcNetPortIfgrp net {cluster} {ne
t-port-get-iter, net-port-ifgrp-get}
Get-NcNetPortVlan net {cluster} {ne
t-vlan-get-iter}
Get-NcNetRoutingGroupRoute net {cluster} {ne
t-routing-group-route-get-iter}
Set-NcNetDns net {vserver} {ne
t-dns-modify}
Set-NcNetDnsHost net {vserver} {ne
t-hosts-modify}
Set-NcNetInterface net {cluster} {ne
t-interface-modify}
Set-NcNetPort net {cluster} {ne
t-port-modify}
-------------- Example 2 --------------
C:\PS>Get-NcCommand -Category net -Verb Get, Set -ListAvailable
Get all of the get and set cmdlets in the net category available to the curr
ent controller connection.
Name Category Family Api
---- -------- ------ ---
Get-NcNetDns net {cluster, vserver} {ne
t-dns-get-iter}
Get-NcNetDnsHost net {cluster, vserver} {ne
t-hosts-get-iter}
Get-NcNetInterface net {cluster, vserver} {ne
t-interface-get-iter}
Get-NcNetRoutingGroupRoute net {cluster} {ne
t-routing-group-route-get-iter}
Set-NcNetDns net {vserver} {ne
t-dns-modify}
Set-NcNetDnsHost net {vserver} {ne
t-hosts-modify}
-------------- Example 3 --------------
C:\PS>Get-NcCommand -Category net -Verb Get, Set -ListUnavailable
Get all of the get and set cmdlets in the net category unavailable to the cu
rrent controller connection.
Name Category Family Api
---- -------- ------ ---
Get-NcNetPort net {cluster} {ne
t-port-get-iter}
Get-NcNetPortIfgrp net {cluster} {ne
t-port-get-iter, net-port-ifgrp-get}
Get-NcNetPortVlan net {cluster} {ne
t-vlan-get-iter}
Set-NcNetInterface net {cluster} {ne
t-interface-modify}
Set-NcNetPort net {cluster} {ne
t-port-modify}
RELATED LINKS
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|