|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Get-NcVserver
NAME
Get-NcVserver
SYNOPSIS
Display information about Vservers.
SYNTAX
Get-NcVserver [[-Name] <String[]>] [-VserverContext <String>] [-Attributes <
VserverInfo>] [-Controller <NcController[]>] [<CommonParameters>]
Get-NcVserver [-VserverContext <String>] -Template [-Fill] [-Controller <NcC
ontroller[]>] [<CommonParameters>]
Get-NcVserver [-VserverContext <String>] -Query <VserverInfo> [-Attributes <
VserverInfo>] [-Controller <NcController[]>] [<CommonParameters>]
DESCRIPTION
Display information about Vservers. Information about Admin Vserver, Node V
server, and Cluster Vservers is displayed. If the ZAPI is issued to the Clu
ster LIF with no Vserver specified as input, then information about all Vser
vers is shown. If the request is sent to the Vserver LIF, then information
about that Vserver is shown.
PARAMETERS
-Name <String[]>
The name of one or more vservers to get. Data ONTAP wildcards are permi
tted.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
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
-Attributes <VserverInfo>
For improved scalability in large clusters, provide a VserverInfo object
with various fields set to indicate which fields to return on all objec
ts. Undesired fields should remain set to null. Use "Get-NcVserver -Te
mplate" to get the initially empty VserverInfo 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 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 VserverInfo object for use with advanced queries
involving the Query attribute.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Fill
Specify when using the Template parameter to recursively fill in all obj
ect types.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Query <VserverInfo>
For advanced queries, provide a VserverInfo object with various fields s
et to indicate which records to retrieve. Other fields should remain se
t to null. Use "Get-NcVserver -Template" to get the initially empty Vse
rverInfo 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.Vserver.VserverInfo
NOTES
Category: vserver
API: vserver-get-iter
Family: cluster, vserver
-------------- Example 1 --------------
C:\PS>Get-NcVserver
List all vservers.
Name State VserverType Comment
---- ----- ----------- -------
fas3070cluster01 admin The administrative vserve
r.
fas3070cluster01-01 node
fas3070cluster01-02 node
vserver1 running cluster
vserver2 running cluster
-------------- Example 2 --------------
C:\PS>$v = Get-NcVserver -Template
$v.State = "running"
$v.VserverType = "cluster"
Get-NcVserver -Query $v
Build an advanced query to get only running vservers of type 'cluster'.
Name State VserverType Comment
---- ----- ----------- -------
vserver1 running cluster
vserver2 running cluster
RELATED LINKS
New-NcVserver
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|