Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP Cluster-mode documentation.

Cmdlet: Set-NaRole


NAME
Set-NaRole

SYNOPSIS
Modifies a role given the information provided.

SYNTAX
Set-NaRole [-Role] <String> [-Comment <String>] [-AddCapabilities <String[]>
] [-RemoveCapabilities <String[]>] [-Controller <NaController>] [-WhatIf] [-
Confirm] [<CommonParameters>]


DESCRIPTION
Modifies a role given the information provided.


PARAMETERS
-Role <String>
Role to modify.

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

-Comment <String>
Optional comment for role.

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

-AddCapabilities <String[]>
List of capabilities to add to this role.

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

-RemoveCapabilities <String[]>
List of capabilities to remove from this role.

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

-Controller <NaController>
The Data ONTAP controller object, embodied by an NaController object. T
his parameter is returned by the Connect-NaController cmdlet. If not sp
ecified, the value in the global variable CurrentNaController is used.

Required? false
Position? named
Default value
Accept pipeline input? false
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
NetApp.Ontapi.Filer.Useradmin.UseradminRoleInfo


NOTES


Category: useradmin
API: useradmin-role-modify

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

C:\PS>Set-NaRole script -AddCapabilities login-* -RemoveCapabilities cli-*


MOdify role 'script', adding 'login-*' permission and removing 'cli-*' permi
ssion.


Name : script
Comment : Role for running storage mgt scripts
AllowedCapabilities : {api-*, login-*}



RELATED LINKS
Get-NaRole
New-NaRole
Remove-NaRole







 Data ONTAP® PowerShell Toolkit