Data ONTAP PowerShell Toolkit: Cmdlet Get-NaRole

Overview
Categories
Cmdlets
APIs
Provider
Release notes
License
Data ONTAP® PowerShell Toolkit
Switch to clustered Data ONTAP documentation.
Cmdlet: Get-NaRole


NAME
    Get-NaRole
    
SYNOPSIS
    Lists full information for all roles on the system.
    
SYNTAX
    Get-NaRole [[-Role] <String>] [-Controller <NaController>] [<CommonParameter
    s>]
    
    
DESCRIPTION
    Lists full information for all roles on the system.
    

PARAMETERS
    -Role <String>
        List only the information associated with this role.
        
        Required?                    false
        Position?                    1
        Default value                
        Accept pipeline input?       true (ByValue, ByPropertyName)
        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
        
    <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.Types.Useradmin.UseradminRoleInfo
     
    
NOTES
    
    
        Category: useradmin
        API: useradmin-role-list
    
    --------------  Example 1 --------------
    
    C:\PS>Get-NaRole
    
    
    List all of the RBAC roles on the current controller.
    
    
    Name                : admin
    Comment             : Default role for administrator privileges.
    AllowedCapabilities : {login-*, cli-*, api-*, security-*}
    
    Name                : audit
    Comment             : Default role for audit privileges.
    AllowedCapabilities : {api-snmp-get, api-snmp-get-next, api-system-api-*}
    
    Name                : backup
    Comment             : Default role for NDMP privileges.
    AllowedCapabilities : {login-ndmp}
    
    Name                : compliance
    Comment             : Default role for compliance privileges.
    AllowedCapabilities : {cli-cifs*, cli-exportfs*, cli-nfs*, cli-useradmin*...
    }
    
    Name                : none
    Comment             : Default role for no privileges.
    AllowedCapabilities : {}
    
    Name                : power
    Comment             : Default role for power user privileges.
    AllowedCapabilities : {cli-cifs*, cli-exportfs*, cli-nfs*, cli-useradmin*...
    }
    
    Name                : root
    Comment             : Default role for root privileges.
    AllowedCapabilities : {*}
    
    Name                : script
    Comment             : Role for running storage mgt scripts
    AllowedCapabilities : {api-*, login-*}
    
    
    
RELATED LINKS
Data ONTAP® PowerShell Toolkit