|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Get-NcOption
NAME
Get-NcOption
SYNOPSIS
Get a list of options.
SYNTAX
Get-NcOption [[-Name] <String[]>] [-Vserver <String[]>] [-Hashtable] [-Vserv
erContext <String>] [-Attributes <OptionInfo>] [-Controller <NcController[]>
] [<CommonParameters>]
Get-NcOption [-Hashtable] [-VserverContext <String>] -Query <OptionInfo> [-A
ttributes <OptionInfo>] [-Controller <NcController[]>] [<CommonParameters>]
Get-NcOption [-VserverContext <String>] -Template [-Controller <NcController
[]>] [<CommonParameters>]
DESCRIPTION
Get a list of options.
PARAMETERS
-Name <String[]>
The name of one or more options to get. Data ONTAP wildcards are permit
ted.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Vserver <String[]>
Restrict results to the specified vservers. Data ONTAP wildcards are pe
rmitted.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Hashtable
Specify to get all values in a hashtable instead of separate objects. B
ecause options must be specified by name and vserver, this parameter is
only supported when this cmdlet is directed to a vserver.
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
-Attributes <OptionInfo>
For improved scalability in large clusters, provide a OptionInfo object
with various fields set to indicate which fields to return on all object
s. Undesired fields should remain set to null. Use "Get-NcOption -Temp
late" to get the initially empty OptionInfo object. If not specified, a
ll 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
-Query <OptionInfo>
For advanced queries, provide an OptionInfo object with various fields s
et to indicate which records to retrieve. Other fields should remain se
t to null. Use "Get-NcOption -Template" to get the initially empty Opti
onInfo object.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Template
Specify to get an empty OptionInfo object for use with advanced queries
involving the Query attribute.
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.Options.OptionInfo
NOTES
Category: options
API: options-get-iter
Family: cluster, vserver
-------------- Example 1 --------------
C:\PS>Get-NcOption backup.log.enable
Get the value of 'backup.log.enable' for each vserver.
Vserver Name Value
------- ---- -----
Cerebus-03 backup.log.enable on
Cerebus-04 backup.log.enable on
Cerebus-05 backup.log.enable on
Cerebus-06 backup.log.enable on
RELATED LINKS
Set-NcOption
Update-NcOption
| Copyright © 2013 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|