|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Get-NcActiveDirectoryAccount
NAME
Get-NcActiveDirectoryAccount
SYNOPSIS
Retrieve the list of active directory accounts.
SYNTAX
Get-NcActiveDirectoryAccount [[-Name] <String[]>] [[-Vserver] <String[]>] [-
Attributes <ActiveDirectoryAccountConfig>] [-VserverContext <String>] [-Cont
roller <NcController[]>] [<CommonParameters>]
Get-NcActiveDirectoryAccount -Template [-VserverContext <String>] [-Controll
er <NcController[]>] [<CommonParameters>]
Get-NcActiveDirectoryAccount -Query <ActiveDirectoryAccountConfig> [-Attribu
tes <ActiveDirectoryAccountConfig>] [-VserverContext <String>] [-Controller
<NcController[]>] [<CommonParameters>]
DESCRIPTION
Retrieve the list of active directory accounts.
PARAMETERS
-Name <String[]>
One or more Active Directory account names to get. Data ONTAP wildcards
are permitted.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Vserver <String[]>
Restrict the results to one or more vservers. Data ONTAP wildcards are
permitted.
Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Attributes <ActiveDirectoryAccountConfig>
For improved scalability in large clusters, provide a ActiveDirectoryAcc
ountConfig object with various fields set to indicate which fields to re
turn on all objects. Undesired fields should remain set to null. Use "
Get-NcActiveDirectoryAccount -Template" to get the initially empty Activ
eDirectoryAccountConfig 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
-VserverContext <String>
Vserver to which to direct this command. If the currently connected con
troller (as embodied by an NcController object) represents a cluster, th
ere are multiple means to address commands to one of its vservers. Eith
er set the Vserver field on the NcController object to direct all subseq
uent commands to that vserver, or supply the VserverContext parameter to
an individual cmdlet. Only cmdlets which may be invoked on vservers of
fer the VserverContext parameter.
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 ActiveDirectoryAccountConfig 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 <ActiveDirectoryAccountConfig>
For advanced queries, provide a ActiveDirectoryAccountConfig object with
various fields set to indicate which records to retrieve. Other fields
should remain set to null. Use "Get-NcActiveDirectoryAccount -Template
" to get the initially empty ActiveDirectoryAccountConfig 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.ActiveDirectory.ActiveDirectoryAccountConfig
NOTES
Category: active directory
API: active-directory-account-get-iter
Family: cluster,vserver
-------------- Example 1 --------------
C:\PS>Get-NcActiveDirectoryAccount
Get all of the active directory accounts for the current cluster.
AccountName Domain DomainWorkgrou
p Vserver
----------- ------ --------------
- -------
TEST01 RTPRRE.TESTDOMAIN RTPRRE
beam_vsim01
-------------- Example 2 --------------
C:\PS>$q = Get-NcActiveDirectoryAccount -Template
$q.Domain = "RTPRRE.TESTDOMAIN"
Get-NcActiveDirectoryAccount -Query $q
Get all of the Active Directory accounts in the cluster for the given domain
.
AccountName Domain DomainWorkgrou
p Vserver
----------- ------ --------------
- -------
TEST01 RTPRRE.TESTDOMAIN RTPRRE
beam_vsim01
RELATED LINKS
New-NcActiveDirectoryAccount
Set-NcActiveDirectoryAccount
Remove-NcActiveDirectoryAccount
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|