|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Get-NcHelp
NAME
Get-NcHelp
SYNOPSIS
List cmdlets in the DataONTAP cluster-mode module, filtered by API, category
, or cmdlet name.
SYNTAX
Get-NcHelp [[-Cmdlet] <String[]>] [<CommonParameters>]
Get-NcHelp -Category <String[]> [<CommonParameters>]
Get-NcHelp -Api <String[]> [<CommonParameters>]
Get-NcHelp -ApiList [<CommonParameters>]
Get-NcHelp -CategoryList [<CommonParameters>]
Get-NcHelp -Family <String[]> [<CommonParameters>]
DESCRIPTION
List cmdlets in the DataONTAP cluster-mode module, filtered by API, category
, or cmdlet name.
This cmdlet provides a convenient mechanism to determine which DataONTAP cmd
lets are available by supporting filtering on API or category.
PARAMETERS
-Cmdlet <String[]>
Specify one or more cmdlet names to list only those cmdlets. Wildcards
are supported.
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? true
-Category <String[]>
Specify one or more category names to find all cmdlets in any of them.
Wildcards are supported.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true
-Api <String[]>
Specify one or more API names to find all cmdlets that use any of them.
Wildcards are supported.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true
-ApiList
Specify to get a listing of all APIs supported by the cluster-mode toolk
it module.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CategoryList
Specify to get a listing of all cmdlet categories supported by the clust
er-mode toolkit module.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Family <String[]>
Specify to restrict results to "vserver" or "cluster" or both.
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.HelpInfo
NOTES
Category: toolkit
-------------- Example 1 --------------
C:\PS>Get-NcHelp
List all cluster-mode cmdlets in the Data ONTAP PowerShell toolkit.
Name Api Category
---- --- --------
Confirm-NcAggrSpareLow {aggr-check-spare-low} aggr
Connect-NcController toolkit
...
RELATED LINKS
Show-NcHelp
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|