|
|
 Data ONTAP® PowerShell Toolkit
|
Cmdlet: Invoke-NaSystemApi
NAME
Invoke-NaSystemApi
SYNOPSIS
Sends a raw API request to Data ONTAP.
SYNTAX
Invoke-NaSystemApi [-Request] <String> [-Controller <NaController>] [<Common
Parameters>]
Invoke-NaSystemApi [-RequestXML] <XmlDocument> [-Controller <NaController>]
[<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
-Controller <NaController>
The Data ONTAP controller object, embodied by an NaController object. T
his parameter is returned by the Connect-NaController cmdlet. If not sp
ecified, the value in the global variable CurrentNaController is used.
Required? false
Position? named
Default value
Accept pipeline input? false
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
-------------- Example 1 --------------
C:\PS>$xml = Invoke-NaSystemApi "<system-get-version/>"
$xml.results.version
Call the system-get-version API.
NetApp Release 7.3.3: Thu Mar 11 22:29:52 PST 2010
-------------- Example 2 --------------
C:\PS>$request = new-object "System.Xml.XmlDocument"
$request.LoadXml("<aggr-list-info><aggregate>aggr0</aggregate></aggr-list-in
fo>")
$response = Invoke-NaSystemApi $request
$response.results.aggregates."aggr-info"
Build an XML document that invokes the aggr-list-info API to retrieve detail
s about aggregate 'aggr0'.
name : aggr0
uuid : 31d60ef0-6a41-11dd-8d86-00a09806c227
type : aggr
state : online
mirror-status : unmirrored
size-total : 121910042624
size-used : 115444699136
size-percentage-used : 95
size-available : 6465343488
files-total : 31142
files-used : 142
checksum-style : block
raid-size : 16
raid-status : raid_dp,redirect
is-checksum-enabled : true
checksum-status : active
has-local-root : true
has-partner-root : false
is-inconsistent : false
is-snaplock : false
disk-count : 3
volume-count : 1
plex-count : 1
plexes : plexes
volumes : volumes
RELATED LINKS
Get-NaSystemApi
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|