Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcSystemUserCapability


NAME
Get-NcSystemUserCapability

SYNOPSIS
Returns the objects and their operations which are permitted to user who cal
led this API.

SYNTAX
Get-NcSystemUserCapability [[-Name] <String[]>] [-Attributes <CapabilityInfo
>] [-VserverContext <String>] [-Controller <NcController[]>] [<CommonParamet
ers>]

Get-NcSystemUserCapability -Template [-VserverContext <String>] [-Controller
<NcController[]>] [<CommonParameters>]

Get-NcSystemUserCapability -Query <CapabilityInfo> [-Attributes <CapabilityI
nfo>] [-VserverContext <String>] [-Controller <NcController[]>] [<CommonPara
meters>]


DESCRIPTION
Returns the objects and their operations which are permitted to user who cal
led this API.


PARAMETERS
-Name <String[]>
Name of one or more objects to get capability info. Data ONTAP wildcard
s are accepted.

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

-Attributes <CapabilityInfo>
For improved scalability in large clusters, provide a CapabilityInfo obj
ect with various fields set to indicate which fields to return on all ob
jects. Undesired fields should remain set to null. Use "Get-NcSystemUs
erCapability -Template" to get the initially empty CapabilityInfo object
. If not specified, all data is returned for each object.

Required? false
Position? named
Default value
Accept pipeline input? false
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

-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 e
ach controller in succession.

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

-Template
Specify to get an empty CapabilityInfo object for use with advanced quer
ies involving the Query attribute.

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

-Query <CapabilityInfo>
For advanced queries, provide a CapabilityInfo object with various field
s set to indicate which records to retrieve. Other fields should remain
set to null. Use "Get-NcSystemUserCapability -Template" to get the ini
tially empty CapabilityInfo object.

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.C.Types.System.CapabilityInfo


NOTES


Category: system
API: system-user-capability-get-iter
Family: cluster, vserver

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

C:\PS>Get-NcSystemUserCapability volume*


Get the user capabilities for all the volume objects.


ObjectName OperationList
---------- -------------
volume {add-other-volumes,
autosize, cluster-max-volume, create...}
volume.64bit-upgrade {start, status}
volume.check {show, start, stop,
test}
volume.clone {create, show}
volume.clone.split {show, start, stop}
volume.copy {start}
volume.efficiency {check, clear-statis
tics, config, modify...}
volume.efficiency.policy {create, delete, mod
ify, show}
volume.efficiency.show-queue {show}
volume.file {modify, reservation
, show-disk-usage, show-filehandle}
volume.file.clone {autodelete, clear,
create, show-autodelete-list...}
volume.file.copy {destroy, modify, sh
ow, start}
volume.file.move {destroy, modify, sh
ow, start}
volume.file.repository.fhmap {show}
volume.file.source {destroy, recover, s
how}
volume.flexcache {create, delete, res
et, show}
volume.flexcache.cache-policy {create, delete, mod
ify, show}
volume.flexcache.delegations {show}
volume.flexcache.monitor.client {show}
volume.flexcache.monitor.server {show}
volume.lost-found {delete, show}
volume.move {abort, modify, show
, start...}
volume.move.target-aggr {show}
volume.qtree {create, delete, mod
ify, oplocks...}
volume.quota {modify, off, on, re
port...}
volume.quota.policy {copy, create, delet
e, rename...}
volume.quota.policy.rule {create, delete, mod
ify, show}
volume.snapshot {add-test-owners, co
mpute-reclaimable, create, delete...}
volume.snapshot.autodelete {modify, show}
volume.snapshot.policy {add-schedule, creat
e, delete, modify...}
volume.storage-service {locate-file, rename
, show}
volume.transition-log {delete, show}



RELATED LINKS







 Data ONTAP® PowerShell Toolkit