|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Get-NaHelp
NAME
Get-NaHelp
SYNOPSIS
List cmdlets in the DataONTAP module, filtered by API, category, or cmdlet n
ame.
SYNTAX
Get-NaHelp [[-Cmdlet] <String[]>] [<CommonParameters>]
Get-NaHelp -Category <String[]> [<CommonParameters>]
Get-NaHelp -Api <String[]> [<CommonParameters>]
Get-NaHelp -ApiList [<CommonParameters>]
Get-NaHelp -CategoryList [<CommonParameters>]
DESCRIPTION
List cmdlets in the DataONTAP module, filtered by API, category, or cmdlet n
ame.
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? false
-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? false
-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? false
-ApiList
Specify to get a listing of all APIs supported by the toolkit.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CategoryList
Specify to get a listing of all cmdlet categories.
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-NaHelp
List all cmdlets in the Data ONTAP PowerShell toolkit.
Name Api Category
---- --- --------
Add-NaAggr {aggr-add} aggr
Add-NaCifsShare {cifs-share-add} cifs
Add-NaIgroupInitiator {igroup-add} igroup
Add-NaIgroupPortset {igroup-bind-portset} igroup
Add-NaIscsiInitiatorAuth {iscsi-initiator-add-auth} iscsi
Add-NaIscsiTargetPortal... {iscsi-tpgroup-interfac... iscsi
Add-NaLicense {license-add} license
Add-NaLunMap {lun-map} lun
Add-NaNfsExport {nfs-exportfs-append-ru... nfs
...
-------------- Example 2 --------------
C:\PS>Get-NaHelp -CategoryList
List the cmdlet categories supported by the Data ONTAP PowerShell Toolkit.
aggr
cf
cifs
clock
clone
disk
fc
fcp
igroup
iscsi
license
lun
net
nfs
options
portset
qtree
quota
sis
snapmirror
snapshot
snmp
system
toolkit
useradmin
vfiler
volume
-------------- Example 3 --------------
C:\PS>Get-NaHelp -Category snap* | sort Category
List all cmdlets with category names like 'snap*'.
Name Api Category
---- --- --------
Invoke-NaSnapmirrorResume {snapmirror-resume} snapmirror
Invoke-NaSnapmirrorResync {snapmirror-resync} snapmirror
Invoke-NaSnapmirrorUpdate {snapmirror-update} snapmirror
Invoke-NaSnapmirrorRelease {snapmirror-release} snapmirror
Invoke-NaSnapmirrorBreak {snapmirror-break} snapmirror
Invoke-NaSnapmirrorInit... {snapmirror-initialize} snapmirror
Invoke-NaSnapmirrorQuiesce {snapmirror-quiesce} snapmirror
Set-NaSnapmirrorSyncSch... {snapmirror-set-sync-sc... snapmirror
Test-NaSnapmirror {snapmirror-get-status} snapmirror
Test-NaSnapmirrorVolume {snapmirror-get-volume-... snapmirror
Set-NaSnapmirrorSchedule {snapmirror-set-schedule} snapmirror
Remove-NaSnapmirror {snapmirror-get-status,... snapmirror
Remove-NaSnapmirrorSche... {snapmirror-delete-sche... snapmirror
Remove-NaSnapmirrorSync... {snapmirror-delete-sync... snapmirror
Get-NaSnapmirrorDestina... {snapmirror-list-destin... snapmirror
Get-NaSnapmirrorSchedule {snapmirror-list-schedule} snapmirror
Get-NaSnapmirrorSyncSch... {snapmirror-list-sync-s... snapmirror
Disable-NaSnapmirror {snapmirror-off} snapmirror
Enable-NaSnapmirror {snapmirror-on} snapmirror
Get-NaSnapmirror {snapmirror-get-status} snapmirror
Invoke-NaSnapmirrorAbort {snapmirror-abort} snapmirror
Set-NaSnapshotAutodelete {snapshot-autodelete-se... snapshot
Get-NaSnapshotSchedule {snapshot-get-schedule} snapshot
Get-NaSnapshotReserve {snapshot-get-reserve} snapshot
Set-NaSnapshotReserve {snapshot-set-reserve} snapshot
Get-NaSnapshotAutodelete {snapshot-autodelete-li... snapshot
Get-NaSnapshotVolumeSpace {snapshot-volume-info} snapshot
Set-NaSnapshotSchedule {snapshot-set-schedule} snapshot
Restore-NaSnapshotVolume {snapshot-restore-volume} snapshot
Get-NaSnapshotDelta {snapshot-delta-info} snapshot
Get-NaSnapshot {snapshot-list-info} snapshot
New-NaSnapshot {snapshot-create} snapshot
Get-NaSnapshotReclaimable {snapshot-reclaimable-i... snapshot
Restore-NaSnapshotFile {snapshot-restore-file} snapshot
Rename-NaSnapshot {snapshot-rename} snapshot
Remove-NaSnapshot {snapshot-delete} snapshot
-------------- Example 4 --------------
C:\PS>Get-NaHelp -Api clock*
List all cmdlets that support the clock APIs.
Name Api Category
---- --- --------
Get-NaTime {clock-get-clock} clock
Get-NaTimezone {clock-get-timezone} clock
Set-NaTime {clock-set-clock} clock
Set-NaTimezone {clock-set-timezone} clock
-------------- Example 5 --------------
C:\PS>Get-NaHelp -ApiList
List the APIs supported by the Data ONTAP PowerShell Toolkit.
aggr-add
aggr-check-spare-low
aggr-create
aggr-destroy
aggr-get-filer-info
aggr-get-root-name
aggr-list-info
aggr-mediascrub-list-info
aggr-mirror
aggr-offline
aggr-online
aggr-options-list-info
aggr-rename
aggr-restrict
aggr-scrub-list-info
aggr-scrub-resume
aggr-scrub-start
aggr-scrub-stop
aggr-scrub-suspend
aggr-set-option
aggr-space-list-info
aggr-split
aggr-verify-list-info
aggr-verify-resume
aggr-verify-start
aggr-verify-stop
aggr-verify-suspend
cf-force-takeover
cf-get-partner
...
RELATED LINKS
Get-Help
Show-NaHelp
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|