|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Invoke-NcSystemApi
NAME
Invoke-NcSystemApi
SYNOPSIS
Sends a raw API request to Data ONTAP.
SYNTAX
Invoke-NcSystemApi [-Request] <String> [-VserverContext <String>] [-Controll
er <NcController[]>] [<CommonParameters>]
Invoke-NcSystemApi [-RequestXML] <XmlDocument> [-VserverContext <String>] [-
Controller <NcController[]>] [<CommonParameters>]
DESCRIPTION
Sends a raw API request to Data ONTAP. The request must be formatted as XML
. See the Manage ONTAP SDK documentation for details.
PARAMETERS
-Request <String>
The Zephyr API (ZAPI) request. This argument accepts the request as a s
tring, but it must be a well-formed XML fragment. Do not include the XM
L header or the <netapp> wrapper tag.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, 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
-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
-RequestXML <XmlDocument>
The Zephyr API (ZAPI) request. This argument accepts the request as a .
NET XmlDocument object. Do not include the XML header or the <netapp> w
rapper tag when building the request.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
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
System.Xml.XmlDocument
OUTPUTS
System.Xml.XmlDocument
NOTES
Category: system
Family: cluster, vserver
-------------- Example 1 --------------
C:\PS>$xml = Invoke-NcSystemApi "<system-get-version/>"
$xml.results.version
Call the system-get-version API.
status : passed
build-timestamp : 1304922348
is-clustered : true
version : NetApp Release RollingRock__8.1.0 Cluster-Mode: Mon May 09
06:25:48 PDT 2011
version-tuple : version-tuple
-------------- Example 2 --------------
C:\PS>$request = new-object "System.Xml.XmlDocument"
$request.LoadXml("<aggr-get-iter/>")
$response = Invoke-NcSystemApi $request
$response.results."attributes-list"."aggr-attributes"[0]
Call the aggr-get-iter API to get the list of aggregates and display the fir
st record returned.
aggr-64bit-upgrade-attributes : aggr-64bit-upgrade-attributes
aggr-fs-attributes : aggr-fs-attributes
aggr-inode-attributes : aggr-inode-attributes
aggr-ownership-attributes : aggr-ownership-attributes
aggr-performance-attributes : aggr-performance-attributes
aggr-raid-attributes : aggr-raid-attributes
aggr-snaplock-attributes : aggr-snaplock-attributes
aggr-snapshot-attributes : aggr-snapshot-attributes
aggr-space-attributes : aggr-space-attributes
aggr-volume-count-attributes : aggr-volume-count-attributes
aggregate-name : aggr0
aggregate-uuid : b48decd3-704b-11e0-b9c5-123478563412
nodes : nodes
striping-type : unknown
RELATED LINKS
Get-NcSystemApi
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|