Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Set-NcRole


NAME
Set-NcRole

SYNOPSIS
Modify the attributes of user role object.

SYNTAX
Set-NcRole [-Role] <String> -Vserver <String[]> -CommandDirectory <String[]>
[-AccessLevel <String>] [-RoleQuery <String>] [-Controller <NcController[]>
] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Modify the attributes of user role object. Omitted (optional) fields will n
ot be changed.


PARAMETERS
-Role <String>
Name of the role to modify.

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

-Vserver <String[]>
Vserver that owns the role.

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

-CommandDirectory <String[]>
The command or command directory to which the role has access.

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

-AccessLevel <String>
Access level for the role. Possible values: 'none', 'readonly', 'all'.

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

-RoleQuery <String>
A query for the role. The query must apply to the specified command or
directory name.

Example: The command is 'volume show' and the query is '-volume vol1'. T
he query is applied to the command resulting in populating only the volu
mes with name vol1.

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

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

-WhatIf


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

-Confirm


Required? false
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.Security.SecurityLoginRoleInfo


NOTES


Category: security
API: security-login-role-modify
Family: cluster

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

C:\PS>Get-NcRole kamino -Vserver costea01,costea02 -CommandDirectory "volume
clone","volume member" | Set-NcRole -AccessLevel all


Set the access level for the 'volume clone' and 'volume member' commands on
the 'kamino' role on vservers 'costea01' and 'costea02'.


RoleName Vserver AccessLevel CommandDirectoryName
-------- ------- ----------- --------------------
kamino costea01 all volume clone
kamino costea01 all volume member
kamino costea02 all volume clone
kamino costea02 all volume member



RELATED LINKS
Get-NcRole
New-NcRole
Remove-NcRole







 Data ONTAP® PowerShell Toolkit