|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Get-NcUser
NAME
Get-NcUser
SYNOPSIS
Returns a list of user account objects.
SYNTAX
Get-NcUser [[-Name] <String[]>] [-Vserver <String[]>] [-Application <String[
]>] [-AuthMethod <String[]>] [-Role <String[]>] [-Locked [<Boolean>]] [-Attr
ibutes <SecurityLoginAccountInfo>] [-Controller <NcController[]>] [<CommonPa
rameters>]
Get-NcUser -Template [-Controller <NcController[]>] [<CommonParameters>]
Get-NcUser -Query <SecurityLoginAccountInfo> [-Attributes <SecurityLoginAcco
untInfo>] [-Controller <NcController[]>] [<CommonParameters>]
DESCRIPTION
Returns a list of user account objects.
PARAMETERS
-Name <String[]>
Restrict results to the specified users(s). Data ONTAP wildcards are pe
rmitted.
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
-Application <String[]>
Restrict results to the specified application(s). Possible values: 'con
sole', 'http', 'ontapi', 'snmp', 'sp', 'ssh'. Data ONTAP wildcards are
permitted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-AuthMethod <String[]>
Restrict results to the specified authentication method(s). Possible va
lues: 'community', 'password', 'publickey', 'domain', 'nsswitch' and 'us
m'. Data ONTAP wildcards are permitted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Role <String[]>
Restrict results to the specified role(s). Data ONTAP wildcards are per
mitted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Locked [<Boolean>]
Restrict results to the specified locked status.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Attributes <SecurityLoginAccountInfo>
For improved scalability in large clusters, provide a SecurityLoginAccou
ntInfo object with various fields set to indicate which fields to return
on all objects. Undesired fields should remain set to null. Use "Get-
NcUser -Template" to get the initially empty SecurityLoginAccountInfo ob
ject. 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 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 SecurityLoginAccountInfo object for use with adv
anced queries involving the Query attribute.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Query <SecurityLoginAccountInfo>
For advanced queries, provide a SecurityLoginAccountInfo object with var
ious fields set to indicate which records to retrieve. Other fields sho
uld remain set to null. Use "Get-NcUser -Template" to get the initially
empty SecurityLoginAccountInfo 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.Security.SecurityLoginAccountInfo
NOTES
Category: security
API: security-login-get-iter
Family: cluster
-------------- Example 1 --------------
C:\PS>Get-NcUser rcuuser
List all user entries for the user 'rcuuser'.
UserName Application AuthMethod RoleName IsLocked Vserver
-------- ----------- ---------- -------- -------- -------
rcuuser http password rcu False dlamotta02
rcuuser ontapi password rcu False dlamotta02
rcuuser ssh password rcu False dlamotta02
-------------- Example 2 --------------
C:\PS>Get-NcUser -Application ontapi -Locked $false
List all users with active API access.
UserName Application AuthMethod RoleName IsLocked Vserver
-------- ----------- ---------- -------- -------- -------
root ontapi password kamino False costea01
test ontapi password kamino False costea01
test2 ontapi password vsadmin False costea01
vsadmin ontapi password vsadmin False costea01
rcuuser ontapi password rcu False dlamotta02
admin ontapi password admin False VxeRubble
root ontapi password admin False VxeRubble
RELATED LINKS
New-NcUser
Remove-NcUser
Set-NcUser
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|