Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Get-NcRoleConfig


NAME
Get-NcRoleConfig

SYNOPSIS
Returns a list of role configuration objects.

SYNTAX
Get-NcRoleConfig [[-Role] <String[]>] [-Vserver <String[]>] [-Attributes <Se
curityLoginRoleConfigInfo>] [-Controller <NcController[]>] [<CommonParameter
s>]

Get-NcRoleConfig -Template [-Controller <NcController[]>] [<CommonParameters
>]

Get-NcRoleConfig -Query <SecurityLoginRoleConfigInfo> [-Attributes <Security
LoginRoleConfigInfo>] [-Controller <NcController[]>] [<CommonParameters>]


DESCRIPTION
Returns a list of role configuration objects.


PARAMETERS
-Role <String[]>
Restrict results to the specified role(s). Data ONTAP wildcards are per
mitted.

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

-Vserver <String[]>
Restrict results to the specified vserver(s). Data ONTAP wildcards are
permitted.

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

-Attributes <SecurityLoginRoleConfigInfo>
For improved scalability in large clusters, provide a SecurityLoginRoleC
onfigInfo object with various fields set to indicate which fields to ret
urn on all objects. Undesired fields should remain set to null. Use "G
etNcRoleConfig -Template" to get the initially empty SecurityLoginRoleCo
nfigInfo 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

-Controller <NcController[]>
A Data ONTAP cluster-mode controller to receive this cmdlet, as embodied
by an NcController object. This parameter is returned by the Connect-N
cController cmdlet. If not specified, the value in the global variable
CurrentNcController is used. In the latter case, if CurrentNcController
contains a collection of NcController objects, this cmdlet is invoked o
n each 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 SecurityLoginRoleConfigInfo object for use with
advanced queries involving the Query attribute.

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

-Query <SecurityLoginRoleConfigInfo>
For advanced queries, provide a SecurityLoginRoleConfigInfo object with
various fields set to indicate which records to retrieve. Other fields
should remain set to null. Use "Get-NcRoleConfig -Template" to get the
initially empty SecurityLoginRoleConfigInfo 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
NetApp.Ontapi.Filer.C.Security810.SecurityLoginRoleConfigInfo


NOTES


Category: security
API: security-login-role-config-get-iter
Family: cluster

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

C:\PS>Get-NcRoleConfig -Vserver costea01 -Role kamino


List the role config parameters for role 'kamino' on vserver 'costea01'.


RoleName : kamino
Vserver : costea01
MinUsernameSize : 3
RequireUsernameAlphaNumeric : False
MinPasswordSize : 8
RequirePasswordAlphaNumeric : True
ChangePasswordDurationInDays : 0
LastPasswordsDisallowedCount : 6
NcController : VxeRubble


-------------- Example 2 --------------

C:\PS>$query = Get-NcRoleConfig -Template
$query.ChangePasswordDurationInDays = ">0"
Get-NcRoleConfig -Query $query


Use an advanced query to find all role configurations with a password durati
on value greater than zero.


RoleName : vsadmin-volume
Vserver : costea01
MinUsernameSize : 3
RequireUsernameAlphaNumeric :
MinPasswordSize : 8
RequirePasswordAlphaNumeric :
ChangePasswordDurationInDays : 30
LastPasswordsDisallowedCount : 6
NcController : VxeRubble



RELATED LINKS
Get-NcRole
Set-NcRoleConfig







 Data ONTAP® PowerShell Toolkit