|
APIs in Category: Perf |
API version 4.0 |
| PerfAssocViewListIterEnd (supported) | [top] |
Terminate a View list iteration and clean up any saved info by a previous call To PerfAssocViewListIterStart
Input Name Type PerfAssocViewListIterEnd PerfAssocViewListIterEnd
Output Name Type PerfAssocViewListIterEndResult PerfAssocViewListIterEndResult
Error Name Description EINVALIDTAG
| PerfAssocViewListIterNext (supported) | [top] |
Returns Objects From a previous call To PerfAssocViewListIterStart
Input Name Type PerfAssocViewListIterNext PerfAssocViewListIterNext
Output Name Type PerfAssocViewListIterNextResult PerfAssocViewListIterNextResult
Error Name Description EINVALIDINPUTERROR EINVALIDTAG
| PerfAssocViewListIterStart (supported) | [top] |
Initiates a Query for a list of performance Views.
Input Name Type PerfAssocViewListIterStart PerfAssocViewListIterStart
Output Name Type PerfAssocViewListIterStartResult PerfAssocViewListIterStartResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR EINVALIDINPUTERROR EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| PerfClientStatsListInfoIterEnd (supported) | [top] |
Ends an iteration started by PerfClientStatsListInfoIterStart
Input Name Type PerfClientStatsListInfoIterEnd PerfClientStatsListInfoIterEnd
Output Name Type PerfClientStatsListInfoIterEndResult PerfClientStatsListInfoIterEndResult
Error Name Description EACCESSDENIED EDATABASEERROR EINVALIDINPUTERROR EINVALIDTAG
| PerfClientStatsListInfoIterNext (supported) | [top] |
Returns the per-client statistics loaded in a previous call To PerfClientStatsListInfoIterStart
Input Name Type PerfClientStatsListInfoIterNext PerfClientStatsListInfoIterNext
Output Name Type PerfClientStatsListInfoIterNextResult PerfClientStatsListInfoIterNextResult
Error Name Description EACCESSDENIED EDATABASEERROR EINVALIDINPUTERROR EINVALIDTAG
| PerfClientStatsListInfoIterStart (supported) | [top] |
Iterates over the historical data of stored client statistics for storage systems. If no input filters are specified, all the available collections of statistics will be returned.
Input Name Type PerfClientStatsListInfoIterStart PerfClientStatsListInfoIterStart
Output Name Type PerfClientStatsListInfoIterStartResult PerfClientStatsListInfoIterStartResult
Error Name Description EACCESSDENIED EDATABASEERROR EINVALIDINPUTERROR
| PerfClientStatsPurge (supported) | [top] |
Remove collected client Stats From the database. If no input is specified, all collections for Hosts on which the user can perform the DFM.Database.Write Operation will be purged.
Input Name Type PerfClientStatsPurge PerfClientStatsPurge
Output Name Type PerfClientStatsPurgeResult PerfClientStatsPurgeResult
Error Name Description EACCESSDENIED EDATABASEERROR EINVALIDINPUTERROR
| PerfCollectClientOperationStatistics (supported) | [top] |
Collect per-client NFS and CIFS Operation statistics for a storage system. The collection of such statistics will be enabled on all vFiler units on the storage system for a short Period of time, and the collected Values will then be summarized and returned for the storage system as a whole. This ZAPI is synchronous and will not return an Error even if there are Errors collecting per-client statistics From some or all vFiler units on the storage system.
Input Name Type PerfCollectClientOperationStatistics PerfCollectClientOperationStatistics
Output Name Type PerfCollectClientOperationStatisticsResult PerfCollectClientOperationStatisticsResult
Error Name Description EACCESSDENIED EBADCREDENTIALS EDATABASEERROR EINVALIDINPUTERROR
| PerfCopyCounterConfiguration (supported) | [top] |
Propagates Source Host's current data collection settings To destination Hosts. When counter configuration is copied To destination Hosts, even if it fails for one Host, it proceeds further with the next available Host in the destination list. Privilege required is DFM.Database.Write.
Input Name Type PerfCopyCounterConfiguration PerfCopyCounterConfiguration
Output Name Type PerfCopyCounterConfigurationResult PerfCopyCounterConfigurationResult
Error Name Description EACCESSDENIED EAPIERROR EAPIPRIVILEDGE EINTERNALERROR EINVALIDINPUTERROR EOBJECTNOTFOUND
| PerfCounterGroupCreate (supported) | [top] |
Creates a counter Group. Global DFM.PerfView.Write is required To create historical counter Group. To create a RealTime counter Group Global DFM.PerfView.RealTimeRead is required.
Input Name Type PerfCounterGroupCreate PerfCounterGroupCreate
Output Name Type PerfCounterGroupCreateResult PerfCounterGroupCreateResult
Error Name Description EAPILICENSE EAPIPRIVILEDGE
| PerfCounterGroupDestroy (supported) | [top] |
Destroys a counter Group. Privilege To Destroy a historical counter Group is Global DFM.PerfView.Delete. And To Destroy a RealTime counter Group, Global DFM.PerfView.RealTimeRead is required.
Input Name Type PerfCounterGroupDestroy PerfCounterGroupDestroy
Output Name Type PerfCounterGroupDestroyResult PerfCounterGroupDestroyResult
Error Name Description EAPILICENSE EAPIPRIVILEDGE
| PerfCounterGroupGetData (supported) | [top] |
Retrieve a set of data for a set of data sources From a specific counter Group. The data is extracted for the given time interval bounded by StartTime and EndTime. This API is suitable for extracting the data for a single line in a chart (graph). Privilege required is DFM.Database.Read. For viewing RealTime data Global DFM.PerfView.RealTimeRead is also required.
Input Name Type PerfCounterGroupGetData PerfCounterGroupGetData
Output Name Type PerfCounterGroupGetDataResult PerfCounterGroupGetDataResult
Error Name Description EAPILICENSE EAPIPRIVILEDGE
| PerfCounterGroupGetDynamicDataSources (supported) | [top] |
Retrieve a list of top-n data sources for a counter. Privilege required is read.
Input Name Type PerfCounterGroupGetDynamicDataSources PerfCounterGroupGetDynamicDataSources
Output Name Type PerfCounterGroupGetDynamicDataSourcesResult PerfCounterGroupGetDynamicDataSourcesResult
Error Name Description EAPILICENSE EAPIPRIVILEDGE EGROUPDOESNOTEXIST
| PerfCounterGroupListInfo (supported) | [top] |
Retrieve one or more counter Groups. Privilege required is read.
Input Name Type PerfCounterGroupListInfo PerfCounterGroupListInfo
Output Name Type PerfCounterGroupListInfoResult PerfCounterGroupListInfoResult
Error Name Description EAPIERROR EAPILICENSE EAPIPRIVILEDGE
| PerfCounterGroupListIterEnd (supported) | [top] |
Terminate a counter Group list iteration and clean up any saved info. Privilege required is read.
Input Name Type PerfCounterGroupListIterEnd PerfCounterGroupListIterEnd
Output Name Type PerfCounterGroupListIterEndResult PerfCounterGroupListIterEndResult
Error Name Description EAPIPRIVILEDGE
| PerfCounterGroupListIterNext (supported) | [top] |
Returns items From a previous call To PerfCounterGroupListIterStart. Privilege required is read.
Input Name Type PerfCounterGroupListIterNext PerfCounterGroupListIterNext
Output Name Type PerfCounterGroupListIterNextResult PerfCounterGroupListIterNextResult
Error Name Description EAPIPRIVILEDGE
| PerfCounterGroupListIterStart (supported) | [top] |
Initiates a Query for a list of performance counter Group names. Privilege required is read.
Input Name Type PerfCounterGroupListIterStart PerfCounterGroupListIterStart
Output Name Type PerfCounterGroupListIterStartResult PerfCounterGroupListIterStartResult
Error Name Description EAPIPRIVILEDGE
| PerfCounterGroupModify (supported) | [top] |
Modify an existing counter Group. User can modify the sample-interval, SampleBuffer and the counter set of an existing counter Group at the individual Host level. Modifying a counter set of a counter Group means user can selectively enable/disable Counters according To the requirement of collecting data. If a counter is disabled data will not be collected for that counter and this gives the flexibility of controlling load on a storage system. This zapi will only enable the Counters mentioned in the 'DataSources' part of the input parameter 'PerfCounterGroupStart' and rest of the Counters of the counter Group will be automatically disabled. User can also disable all the Counters of a counter Group by setting the flag 'IsDisableAll' in the input parameter 'PerfCounterGroupStart'. Enabling/disabling Counters is not allowed for calculated Stats Counters in default counter Groups. Privilege required is DFM.Database.Write.
Input Name Type PerfCounterGroupModify PerfCounterGroupModify
Output Name Type PerfCounterGroupModifyResult PerfCounterGroupModifyResult
Error Name Description EAPILICENSE EAPIPRIVILEDGE
| PerfCounterGroupStart (supported) | [top] |
Start data collection for one counter Group. Privilege required is Global DFM.PerfView.Write for normal Views and Global DFM.PerfView.RealTimeRead for RealTime Views.
Input Name Type PerfCounterGroupStart PerfCounterGroupStart
Output Name Type PerfCounterGroupStartResult PerfCounterGroupStartResult
Error Name Description EAPILICENSE EAPIPRIVILEDGE
| PerfCounterGroupStop (supported) | [top] |
Stop data collection for one counter Group. Privilege required is Global DFM.PerfView.Write for normal Views and Global DFM.PerfView.RealTimeRead for RealTime Views.
Input Name Type PerfCounterGroupStop PerfCounterGroupStop
Output Name Type PerfCounterGroupStopResult PerfCounterGroupStopResult
Error Name Description EAPILICENSE EAPIPRIVILEDGE
| PerfDiagTroubleshoot (supported) | [top] |
This API shall troubleshoot the DFM object for performance related issues and provides the recommendations To help resolve them.
Input Name Type PerfDiagTroubleshoot PerfDiagTroubleshoot
Output Name Type PerfDiagTroubleshootResult PerfDiagTroubleshootResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR EINVALIDINPUTERROR
| PerfDisableDataCollection (supported) | [top] |
Disables DFM performance advisor data collection.
Input Name Type PerfDisableDataCollection PerfDisableDataCollection
Output Name Type PerfDisableDataCollectionResult PerfDisableDataCollectionResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR
| PerfDisableObjectUpdate (supported) | [top] |
Disables any modification To DFM performance advisor Views, counter Groups and object Instances.
Input Name Type PerfDisableObjectUpdate PerfDisableObjectUpdate
Output Name Type PerfDisableObjectUpdateResult PerfDisableObjectUpdateResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR
| PerfEnableDataCollection (supported) | [top] |
Enables DFM performance advisor data collection.
Input Name Type PerfEnableDataCollection PerfEnableDataCollection
Output Name Type PerfEnableDataCollectionResult PerfEnableDataCollectionResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR
| PerfEnableObjectUpdate (supported) | [top] |
Enables modifications To DFM performance advisor Views, counter Groups and object Instances.
Input Name Type PerfEnableObjectUpdate PerfEnableObjectUpdate
Output Name Type PerfEnableObjectUpdateResult PerfEnableObjectUpdateResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR
| PerfGetCounterData (supported) | [top] |
Retrieve data for all the related Objects for the given object and the specified performance Counters.
Input Name Type PerfGetCounterData PerfGetCounterData
Output Name Type PerfGetCounterDataResult PerfGetCounterDataResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR EINVALIDINPUTERROR EOBJECTNOTFOUND
| PerfGetCounterDependents (supported) | [top] |
Find out the Operations Manager Reports, Performance Advisor custom Views, Performance Advisor threshold templates and Performance Advisor Thresholds which depend on the specified performance Counters.
Input Name Type PerfGetCounterDependents PerfGetCounterDependents
Output Name Type PerfGetCounterDependentsResult PerfGetCounterDependentsResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINVALIDINPUTERROR
| PerfGetCounterListNotInView (supported) | [top] |
Given an array of performance Objects and Counters, the API will return a list of all Counters that are not part of any View.
Input Name Type PerfGetCounterListNotInView PerfGetCounterListNotInView
Output Name Type PerfGetCounterListNotInViewResult PerfGetCounterListNotInViewResult
Error Name Description EACCESSDENIED EAPIPRIVILEDGE EINTERNALERROR EINVALIDINPUTERROR EOBJECTNOTFOUND
| PerfGetDefaultView (supported) | [top] |
Gets the default View for an object.
Input Name Type PerfGetDefaultView PerfGetDefaultView
Output Name Type PerfGetDefaultViewResult PerfGetDefaultViewResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR
| PerfGetServerStatus (supported) | [top] |
Returns the Status of DFM Performance Advisor.
Input Name Type PerfGetServerStatus PerfGetServerStatus
Output Name Type PerfGetServerStatusResult PerfGetServerStatusResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR
| PerfObjectCounterListInfo (supported) | [top] |
Retrieve information about a performance object's Counters. (No iterator-based equivalent exists for this API because the number of object Counters is fewer than two hundred in number.) Privilege required is read.
Input Name Type PerfObjectCounterListInfo PerfObjectCounterListInfo
Output Name Type PerfObjectCounterListInfoResult PerfObjectCounterListInfoResult
Error Name Description EAPIPRIVILEDGE
| PerfObjectDependentCounterListInfo (supported) | [top] |
Retrieve information about a performance object's dependent Counters. Privilege required is read.
Input Name Type PerfObjectDependentCounterListInfo PerfObjectDependentCounterListInfo
Output Name Type PerfObjectDependentCounterListInfoResult PerfObjectDependentCounterListInfoResult
Error Name Description EACCESSDENIED EAPIERROR EAPIPRIVILEDGE EINTERNALERROR EOBJECTNOTFOUND
| PerfObjectInstanceListIterEnd (supported) | [top] |
Terminate an Instance list iteration and clean up any saved info. Privilege required is read.
Input Name Type PerfObjectInstanceListIterEnd PerfObjectInstanceListIterEnd
Output Name Type PerfObjectInstanceListIterEndResult PerfObjectInstanceListIterEndResult
Error Name Description EAPIPRIVILEDGE
| PerfObjectInstanceListIterNext (supported) | [top] |
Returns items From a previous call To PerfObjectInstanceListIterStart Privilege required is read.
Input Name Type PerfObjectInstanceListIterNext PerfObjectInstanceListIterNext
Output Name Type PerfObjectInstanceListIterNextResult PerfObjectInstanceListIterNextResult
Error Name Description EAPIPRIVILEDGE
| PerfObjectInstanceListIterStart (supported) | [top] |
Initiates a Query for a list of performance object Instance names. Privilege required is read.
Input Name Type PerfObjectInstanceListIterStart PerfObjectInstanceListIterStart
Output Name Type PerfObjectInstanceListIterStartResult PerfObjectInstanceListIterStartResult
Error Name Description EAPIPRIVILEDGE
| PerfObjectListInfo (supported) | [top] |
Get a list of performance Objects. (No iterator-based equivalent exists for this API because the number of performance Objects is fewer than twenty in number.) Privilege required is read.
Input Name Type PerfObjectListInfo PerfObjectListInfo
Output Name Type PerfObjectListInfoResult PerfObjectListInfoResult
Error Name Description EAPIPRIVILEDGE
| PerfSetDefaultView (supported) | [top] |
Sets the default View for an object.
Input Name Type PerfSetDefaultView PerfSetDefaultView
Output Name Type PerfSetDefaultViewResult PerfSetDefaultViewResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR
| PerfStatusGet (supported) | [top] |
Returns the DFM performance advisor Status
Input Name Type PerfStatusGet PerfStatusGet
Output Name Type PerfStatusGetResult PerfStatusGetResult
Error Name Description EAPIERROR EAPIPRIVILEDGE
| PerfThresholdCreate (supported) | [top] |
Sets threshold Values on one or more Objects based on a performance counter. Privilege required is DFM.Database.Write. Threshold will be set only if the User has DFM.Database.Write Permission over the object specified.
Input Name Type PerfThresholdCreate PerfThresholdCreate
Output Name Type PerfThresholdCreateResult PerfThresholdCreateResult
Error Name Description EACCESSDENIED EAPILICENSE EAPIPRIVILEDGE EINTERNALERROR EINVALIDINPUTERROR EOBJECTNOTFOUND ETHRESHOLDEXIST
| PerfThresholdCreate2 (supported) | [top] |
Creates one threshold composed of one or more Counters, and optionally applies it To an object. The user must have the Capability To perform the DFM.Database.Write Operation on the object on which the threshold is applied.
Input Name Type PerfThresholdCreate2 PerfThresholdCreate2
Output Name Type PerfThresholdCreate2Result PerfThresholdCreate2Result
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR EINVALIDINPUTERROR
| PerfThresholdDelete (supported) | [top] |
Removes threshold set on a counter. The user must have the Capability To perform the DFM.Database.Delete Operation on the object on which the threshold is directly applied. This ZAPI cannot be used To delete template Thresholds, and PerfThresholdTemplateModify should be used for that purpose.
Input Name Type PerfThresholdDelete PerfThresholdDelete
Output Name Type PerfThresholdDeleteResult PerfThresholdDeleteResult
Error Name Description EACCESSDENIED EAPILICENSE EAPIPRIVILEDGE EDATABASEERROR EINTERNALERROR EINVALIDINPUTERROR
| PerfThresholdListInfoIterEnd (supported) | [top] |
Terminate a counter-thresholds-list iteration and clean up any saved info. Privilege required is DFM.Database.Read. Only Thresholds on Objects over which the user has DFM.Database.Read permissions will be returned.
Input Name Type PerfThresholdListInfoIterEnd PerfThresholdListInfoIterEnd
Output Name Type PerfThresholdListInfoIterEndResult PerfThresholdListInfoIterEndResult
Error Name Description EAPIPRIVILEDGE EINVALIDTAG
| PerfThresholdListInfoIterNext (supported) | [top] |
The PerfThresholdListInfoIter* list of APIs are used To retrieve the list of all Counters on which Thresholds have been set. It loads the list of Counters on which Thresholds have been set into a temporary store. The API returns a Tag that identifies that temporary store so that subsequent APIs can be used To iterate over the threshold related Counters in the temporary store. Privilege required is DFM.Database.Read. Only Thresholds on Objects over which the user has DFM.Database.Read permissions will be returned.
Input Name Type PerfThresholdListInfoIterNext PerfThresholdListInfoIterNext
Output Name Type PerfThresholdListInfoIterNextResult PerfThresholdListInfoIterNextResult
Error Name Description EAPIPRIVILEDGE EINVALIDTAG
| PerfThresholdListInfoIterStart (supported) | [top] |
The PerfThresholdListInfoIter* list of APIs are used To retrieve the list of all Counters on which Thresholds have been set. It loads the list of Counters on which Thresholds have been set into a temporary store. The API returns a Tag that identifies a temporary store so that subsequent APIs can be used To iterate over the threshold related Counters in the temporary store. Privilege required is DFM.Database.Read. Only Thresholds on Objects over which the User has DFM.Database.Read permissions will be returned.
Input Name Type PerfThresholdListInfoIterStart PerfThresholdListInfoIterStart
Output Name Type PerfThresholdListInfoIterStartResult PerfThresholdListInfoIterStartResult
Error Name Description EACCESSDENIED EAPIERROR EAPILICENSE EAPIPRIVILEDGE EINTERNALERROR EINVALIDINPUTERROR EOBJECTNOTFOUND
| PerfThresholdListInfo2IterEnd (supported) | [top] |
Terminate a perf-thresholds-list-info2 iteration and clean up any saved info.
Input Name Type PerfThresholdListInfo2IterEnd PerfThresholdListInfo2IterEnd
Output Name Type PerfThresholdListInfo2IterEndResult PerfThresholdListInfo2IterEndResult
Error Name Description EAPIPRIVILEDGE EINVALIDTAG
| PerfThresholdListInfo2IterNext (supported) | [top] |
The PerfThresholdListInfo2Iter* list of APIs are used To retrieve the list of all Objects on which Thresholds have been set.
Input Name Type PerfThresholdListInfo2IterNext PerfThresholdListInfo2IterNext
Output Name Type PerfThresholdListInfo2IterNextResult PerfThresholdListInfo2IterNextResult
Error Name Description EAPIPRIVILEDGE EINVALIDTAG
| PerfThresholdListInfo2IterStart (supported) | [top] |
The PerfThresholdListInfo2Iter* list of APIs are used To retrieve the list of Objects on which Thresholds have been set. It loads the list of Thresholds into a temporary store. The API returns a Tag that identifies the temporary store so that subsequent APIs can be used To iterate over the Thresholds in it. The user must have the Capability To perform the DFM.Database.Read Operation on the object on which the threshold is applied, and only Thresholds which are applied on such Objects will be returned.
Input Name Type PerfThresholdListInfo2IterStart PerfThresholdListInfo2IterStart
Output Name Type PerfThresholdListInfo2IterStartResult PerfThresholdListInfo2IterStartResult
Error Name Description EACCESSDENIED EAPIERROR EAPILICENSE EAPIPRIVILEDGE EINTERNALERROR EINVALIDINPUTERROR EOBJECTNOTFOUND
| PerfThresholdModify (supported) | [top] |
Allows modification of threshold Value and threshold interval that have been set before. Privilege required is DFM.Database.Write.
Input Name Type PerfThresholdModify PerfThresholdModify
Output Name Type PerfThresholdModifyResult PerfThresholdModifyResult
Error Name Description EACCESSDENIED EAPILICENSE EAPIPRIVILEDGE EDATABASEERROR EINTERNALERROR EINVALIDINPUTERROR EOBJECTNOTFOUND
| PerfThresholdModify2 (supported) | [top] |
Modify an existing threshold. This ZAPI should be used only for changing the parameters of a threshold, not for changing the Objects it is not applied on. The ObjectsInfo structure is ignored in this ZAPI. This ZAPI cannot be used To modify template Thresholds, and PerfThresholdTemplateModify should be used for that purpose. The user must have the Capability To perform the DFM.Database.Write Operation on the object on which the threshold is applied.
Input Name Type PerfThresholdModify2 PerfThresholdModify2
Output Name Type PerfThresholdModify2Result PerfThresholdModify2Result
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR EINVALIDINPUTERROR
| PerfThresholdTemplateAttachObjects (supported) | [top] |
Attach one or more Objects To a performance template. Either all input Objects get attached or none of them get attached. The specified Objects will get associated To the applicable Thresholds in the template. Objects cannot be attached if the template has no Thresholds. Objects already attached To the template are left unchanged. The user must have the Capability To perform the DFM.Database.Write Operation on the object To which the template is To be attached.
Input Name Type PerfThresholdTemplateAttachObjects PerfThresholdTemplateAttachObjects
Output Name Type PerfThresholdTemplateAttachObjectsResult PerfThresholdTemplateAttachObjectsResult
Error Name Description EACCESSDENIED EAPILICENSE EAPIPRIVILEDGE EDATABASEERROR EINTERNALERROR EINVALIDINPUTERROR EOBJECTNOTFOUND
| PerfThresholdTemplateCreate (supported) | [top] |
Creates a template for perf Thresholds.
Input Name Type PerfThresholdTemplateCreate PerfThresholdTemplateCreate
Output Name Type PerfThresholdTemplateCreateResult PerfThresholdTemplateCreateResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR EINVALIDINPUTERROR EPERFTEMPLATEEXISTS
| PerfThresholdTemplateDelete (supported) | [top] |
Deletes a template.
Input Name Type PerfThresholdTemplateDelete PerfThresholdTemplateDelete
Output Name Type PerfThresholdTemplateDeleteResult PerfThresholdTemplateDeleteResult
Error Name Description EACCESSDENIED EAPILICENSE EAPIPRIVILEDGE EDATABASEERROR EINTERNALERROR EINVALIDINPUTERROR
| PerfThresholdTemplateDetachObjects (supported) | [top] |
Detaches one or more Objects From a performance template. Either all or none of the input Objects get detached. The user must have the Capability To perform the DFM.Database.Write Operation on the object which is To be detached From the template.
Input Name Type PerfThresholdTemplateDetachObjects PerfThresholdTemplateDetachObjects
Output Name Type PerfThresholdTemplateDetachObjectsResult PerfThresholdTemplateDetachObjectsResult
Error Name Description EACCESSDENIED EAPILICENSE EAPIPRIVILEDGE EDATABASEERROR EINTERNALERROR EINVALIDINPUTERROR EOBJECTNOTFOUND
| PerfThresholdTemplateListInfoIterEnd (supported) | [top] |
Terminate a perf-threshold-template-list iteration and clean up any saved information.
Input Name Type PerfThresholdTemplateListInfoIterEnd PerfThresholdTemplateListInfoIterEnd
Output Name Type PerfThresholdTemplateListInfoIterEndResult PerfThresholdTemplateListInfoIterEndResult
Error Name Description EAPIPRIVILEDGE EINVALIDTAG
| PerfThresholdTemplateListInfoIterNext (supported) | [top] |
The PerfThresholdTemplateListInfoIter* list of APIs are used To retrieve the list of all Objects on which Thresholds have been set.
Input Name Type PerfThresholdTemplateListInfoIterNext PerfThresholdTemplateListInfoIterNext
Output Name Type PerfThresholdTemplateListInfoIterNextResult PerfThresholdTemplateListInfoIterNextResult
Error Name Description EAPIPRIVILEDGE EINVALIDTAG
| PerfThresholdTemplateListInfoIterStart (supported) | [top] |
The PerfThresholdTemplateListInfoIter* list of APIs are used To retrieve the list of all threshold templates that have been created. It loads the templates into a temporary store. The API returns a Tag that identifies a temporary store so that subsequent APIs can be used To iterate over the threshold related Counters in the temporary store.
Input Name Type PerfThresholdTemplateListInfoIterStart PerfThresholdTemplateListInfoIterStart
Output Name Type PerfThresholdTemplateListInfoIterStartResult PerfThresholdTemplateListInfoIterStartResult
Error Name Description EACCESSDENIED EAPIERROR EAPILICENSE EINTERNALERROR EINVALIDINPUTERROR EOBJECTNOTFOUND
| PerfThresholdTemplateModify (supported) | [top] |
The PerfThresholdTemplateModify zapi is used To modify an existing threshold template. It can be used To add, remove or modify Thresholds in the template or modify Attributes of the template
Input Name Type PerfThresholdTemplateModify PerfThresholdTemplateModify
Output Name Type PerfThresholdTemplateModifyResult PerfThresholdTemplateModifyResult
Error Name Description EACCESSDENIED EAPILICENSE EDATABASEERROR EINTERNALERROR EINVALIDINPUTERROR
| PerfViewAssociatedObjectsList (supported) | [top] |
List all the Objects associated with the View.
Input Name Type PerfViewAssociatedObjectsList PerfViewAssociatedObjectsList
Output Name Type PerfViewAssociatedObjectsListResult PerfViewAssociatedObjectsListResult
Error Name Description EAPIERROR EDATABASEERROR EINTERNALERROR EINVALIDINPUTERROR EOBJECTNOTFOUND
| PerfViewCreate (supported) | [top] |
Create a performance View. A performance View consists of one or more Charts, but each View refers To only a single counter Group. Global DFM.PerfView.Write RBAC Capability is required To create normal Views while Global DFM.PerfView.RealTimeRead is required To create RealTime View.
Input Name Type PerfViewCreate PerfViewCreate
Output Name Type PerfViewCreateResult PerfViewCreateResult
Error Name Description EAPILICENSE EAPIPRIVILEDGE EINVALIDINPUTERROR EPERFUPDATEDISABLED
| PerfViewDestroy (supported) | [top] |
Destroy a performance View. Global DFM.PerfView.Delete is required for destroying normal Views while Global DFM.PerfView.RealTimeRead is required for destroying RealTime Views.
Input Name Type PerfViewDestroy PerfViewDestroy
Output Name Type PerfViewDestroyResult PerfViewDestroyResult
Error Name Description EAPILICENSE EAPIPRIVILEDGE
| PerfViewGetData (supported) | [top] |
Retrieve data for a single DataSource From a specific performance View. The data is extracted for the given time interval bounded by StartTime and EndTime.
Input Name Type PerfViewGetData PerfViewGetData
Output Name Type PerfViewGetDataResult PerfViewGetDataResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR EINVALIDINPUTERROR EOBJECTNOTFOUND
| PerfViewListIterEnd (supported) | [top] |
Terminate a View list iteration and clean up any saved info. Privilege required is read.
Input Name Type PerfViewListIterEnd PerfViewListIterEnd
Output Name Type PerfViewListIterEndResult PerfViewListIterEndResult
Error Name Description EAPILICENSE EAPIPRIVILEDGE
| PerfViewListIterNext (supported) | [top] |
Retrieve items From a previous call To PerfViewListIterStart Privilege required is read.
Input Name Type PerfViewListIterNext PerfViewListIterNext
Output Name Type PerfViewListIterNextResult PerfViewListIterNextResult
Error Name Description EAPILICENSE EAPIPRIVILEDGE
| PerfViewListIterStart (supported) | [top] |
Initiates a Query for a list of performance Views. Privilege required is read.
Input Name Type PerfViewListIterStart PerfViewListIterStart
Output Name Type PerfViewListIterStartResult PerfViewListIterStartResult
Error Name Description EAPILICENSE EAPIPRIVILEDGE
| PerfViewModify (supported) | [top] |
Modify an existing performance View. Global DFM.PerfView.Write RBAC Capability is required To modify performance Views.
Input Name Type PerfViewModify PerfViewModify
Output Name Type PerfViewModifyResult PerfViewModifyResult
Error Name Description EAPILICENSE EAPIPRIVILEDGE
| PerfViewObjectAssociationAdd (supported) | [top] |
Associates an object with a View
Input Name Type PerfViewObjectAssociationAdd PerfViewObjectAssociationAdd
Output Name Type PerfViewObjectAssociationAddResult PerfViewObjectAssociationAddResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR EINVALIDINPUTERROR EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| PerfViewObjectAssociationDelete (supported) | [top] |
Removes the association of an object with a View
Input Name Type PerfViewObjectAssociationDelete PerfViewObjectAssociationDelete
Output Name Type PerfViewObjectAssociationDeleteResult PerfViewObjectAssociationDeleteResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EINTERNALERROR EINVALIDINPUTERROR EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| Element definition: PerfAssocViewListIterEnd | [top] |
Terminate a View list iteration and clean up any saved info by a previous call To PerfAssocViewListIterStart
Name Type Description Tag xsd:string
Tag From a previous PerfAssocViewListIterStart.
| Element definition: PerfAssocViewListIterEndResult | [top] |
[none]
| Element definition: PerfAssocViewListIterNext | [top] |
Returns Objects From a previous call To PerfAssocViewListIterStart
Name Type Description Maximum xsd:integer
The Maximum number of entries To retrieve. Range: [1..2^31-1] Tag xsd:string
Tag From a previous perf-view-list-info-iter-start.
| Element definition: PerfAssocViewListIterNextResult | [top] |
Name Type Description Records xsd:integer
The number of Records actually returned. Range: [1..2^31-1] Views ArrayOfPerfView
A list of Views
| Element definition: PerfAssocViewListIterStart | [top] |
Initiates a Query for a list of performance Views.
Name Type Description AssocObjType PerfAssocObjType
optional
If specified, only Views with a matching associated object Type will be returned. This is ignored if ObjectNameOrId is specified. Otherwise, all performance Views will be returned (subject To the other optional parameters). IncludeEmptyViews xsd:boolean
optional
If false, the following will be removed From the output Views: By default, this is false.
- Lines without any data Source
- Charts without any Lines
- Views without any Charts
ObjectNameOrId ObjNameOrId
optional
Name or identifier of an object To list Views for. If not specified, all Views will be returned (subject To the other optional parameters). The allowed object types for this argument are
- Resource Group
- Dataset
- Resource Pool
- Host
- vFiler
- Aggregate
- Volume
- Qtree
- Lun
Verbose xsd:boolean
optional
If this is set To false, only a few fields for each View is returned instead of the entire metadata Default is true The following fields will be returned for each View
- ViewName
- ViewType
- AssocObjType
ViewType ViewType
optional
Indicates the Type of Views To be returned. If not specified, all types of Views will be returned (subject To the other optional parameters).
| Element definition: PerfAssocViewListIterStartResult | [top] |
Name Type Description Records xsd:integer
Number indicating how many items are available for future retrieval via calls To PerfViewListIterNext Tag xsd:string
Tag To be used in subsequent calls To PerfViewListIterNext or PerfViewListIterEnd
| Element definition: PerfClientStatsListInfoIterEnd | [top] |
Ends an iteration started by PerfClientStatsListInfoIterStart
Name Type Description Tag xsd:string
The Tag From a previous call To PerfClientStatsListInfoIterStart
| Element definition: PerfClientStatsListInfoIterEndResult | [top] |
[none]
| Element definition: PerfClientStatsListInfoIterNext | [top] |
Returns the per-client statistics loaded in a previous call To PerfClientStatsListInfoIterStart
Name Type Description Maximum xsd:integer
optional
The number of Records To retrieve in this iteration. If not specified, a default Value of 20 is assumed. Range: [ 1 .. 2^31 - 1 ] Tag xsd:string
The Tag From a previous call To PerfClientStatsListInfoIterStart
| Element definition: PerfClientStatsListInfoIterNextResult | [top] |
Name Type Description HostsClientStats ArrayOfHostClientStats
The per-client Operation statistics. Records xsd:integer
The number of Records returned. Range: [ 0 .. 2^31 - 1 ]
| Element definition: PerfClientStatsListInfoIterStart | [top] |
Iterates over the historical data of stored client statistics for storage systems. If no input filters are specified, all the available collections of statistics will be returned.
Name Type Description EndTime Timestamp
optional
If specified, only client statistics retrieved at or before this time will be returned. The time is specified in seconds From Epoch. LastOnly xsd:boolean
optional
A convenience input To fetch only the last recorded collection for all Hosts, if ObjectNameOrId is not specified, or a specific Host if ObjectNameOrId is specified. If specified, StartTime and EndTime will be ignored, and this cannot be specified in conjunction with StatId. ObjectNameOrId ObjNameOrId
optional
Specifies the Name or Id of the object for which historical client statistics are To be retrieved. If not specified, the statistics will be returned for all available Objects. The object must be a storage system. StartTime Timestamp
optional
If specified, only client statistics retrieved at or after this time will be returned. The time is specified in seconds From Epoch. StatId StatId
optional
If specified, only the collection of statistics with this Id will be returned and all other inputs will be ignored.
| Element definition: PerfClientStatsListInfoIterStartResult | [top] |
Name Type Description Records xsd:integer
The number of Records retrieved. Range: [ 0 .. 2^31 - 1 ] Tag xsd:string
The Tag To be used in subsequent calls To PerfClientStatsListInfoIterNext or PerfClientStatsListInfoIterEnd.
| Element definition: PerfClientStatsPurge | [top] |
Remove collected client Stats From the database. If no input is specified, all collections for Hosts on which the user can perform the DFM.Database.Write Operation will be purged.
Name Type Description EndTime Timestamp
optional
If specified, all statistics collection collected before this time will be removed. The Timestamp must be specified in seconds From Epoch. ObjectNameOrId ObjNameOrId
optional
Specifies the Name or Id, in the DFM database, of the object for which statistics collections should be purged. The object must be a storage system. StartTime Timestamp
optional
If specified, all statistics collection collected after this time will be removed. The Timestamp must be specified in seconds From Epoch. StatId StatId
optional
Specifies the Id, in the DFM database, of the collection To be removed. If specified, all other inputs will be ignored. The user must have the Capability To perform the DFM.Database.Write Operation on the storage system for which the collection with this Id was collected.
| Element definition: PerfClientStatsPurgeResult | [top] |
Name Type Description DeletedStatsCount xsd:integer
Returns the number of collections of statistics purged From the database. Range: [0 .. 2^31-1]
| Element definition: PerfCollectClientOperationStatistics | [top] |
Collect per-client NFS and CIFS Operation statistics for a storage system. The collection of such statistics will be enabled on all vFiler units on the storage system for a short Period of time, and the collected Values will then be summarized and returned for the storage system as a whole. This ZAPI is synchronous and will not return an Error even if there are Errors collecting per-client statistics From some or all vFiler units on the storage system.
Name Type Description CollectionPeriod xsd:integer
optional
Specifies, in seconds, the Period of time for which the collection of statistics should be enabled on the Filer. If not specified, a default Value of 15 will be assumed. The API will be blocked for at least this Period of time. In case of heavily loaded storage systems, the Duration of blocking may be significantly higher. Range: [15 .. 60] ObjectNameOrId ObjNameOrId
The Name or Id of the object on which the collection of per-client statistics is To be enabled. The object must be a storage system.
| Element definition: PerfCollectClientOperationStatisticsResult | [top] |
Name Type Description Errors ArrayOfClientStatError
optional
Returns Errors encountered while collecting the per-client statistics, if any. StatId StatId
Returns the Id, in the DFM database, of the collection of statistics stored.
| Element definition: PerfCopyCounterConfiguration | [top] |
Propagates Source Host's current data collection settings To destination Hosts. When counter configuration is copied To destination Hosts, even if it fails for one Host, it proceeds further with the next available Host in the destination list. Privilege required is DFM.Database.Write.
Name Type Description DestinationObjects ArrayOfObjNameOrId
Name or identifier of an object, allowed object types for this argument are Host, Resource Group. Preview xsd:boolean
optional
If this flag is true, it performs a dry run before actually committing the changes. It returns a list of Counters, Host details in case of any discrepancies between Source, destination Hosts. By default true. SourceHostNameOrId HostNameOrId
optional
DFM Hostname or Id, the allowed Value for this argument is a valid storage system. SrcIsDefault xsd:boolean
optional
This flag allows the destination Objects To attach To the default configuration. Default Value is set To FALSE.
| Element definition: PerfCopyCounterConfigurationResult | [top] |
Name Type Description CopyResult ArrayOfDestinationHostInfo
Result of copy Operation. This element will be included irrespective of Preview flag settings. On successful copy Operation 'CopyResult' will include only 'HostName, HostId' elements. In case of failure the output includes additional element 'ErrorReason'. MissingHostObjectCounters ArrayOfPerfMissingHostObjectCounter
optional
List of Counters not available with destination Hosts. The output will include these elements only if Preview flag is set To true and there is a discrepancy between Source, destination Hosts. PurgedHostObjectCounters ArrayOfPerfPurgedHostObjectCounter
optional
List of Counters for which historical data will be purged. The output will include these elements only if Preview flag is set To true and there is a discrepancy between Source, destination Hosts.
| Element definition: PerfCounterGroupCreate | [top] |
Creates a counter Group. Global DFM.PerfView.Write is required To create historical counter Group. To create a RealTime counter Group Global DFM.PerfView.RealTimeRead is required.
Name Type Description CounterGroup WrapperOfPerfCounterGroup
The counter Group To create.
| Element definition: PerfCounterGroupCreateResult | [top] |
[none]
| Element definition: PerfCounterGroupDestroy | [top] |
Destroys a counter Group. Privilege To Destroy a historical counter Group is Global DFM.PerfView.Delete. And To Destroy a RealTime counter Group, Global DFM.PerfView.RealTimeRead is required.
Name Type Description ApplianceNameOrId xsd:string
optional
The Name (or unique ID) of the Source storage system. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in the appliance-info structure From the appliance-list-iter-next. The API will accept a Vfiler Name or Id From DFM 3.3 onwards. CounterGroupName xsd:string
Name of counter Group To Destroy. All the Views that are using the counter Group are automatically destroyed. GroupNameOrId xsd:string
optional
The Name (or unique ID) of the Source Group. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in GroupListIterNext APIs. This field is ignored if ApplianceNameOrId is specified. This field defaults To global Group if ApplianceNameOrId is not specified.
| Element definition: PerfCounterGroupDestroyResult | [top] |
[none]
| Element definition: PerfCounterGroupGetData | [top] |
Retrieve a set of data for a set of data sources From a specific counter Group. The data is extracted for the given time interval bounded by StartTime and EndTime. This API is suitable for extracting the data for a single line in a chart (graph). Privilege required is DFM.Database.Read. For viewing RealTime data Global DFM.PerfView.RealTimeRead is also required.
Name Type Description ApplianceNameOrId xsd:string
optional
The Name (or unique ID) of the Source storage system. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in the appliance-info structure From the appliance-list-iter-next. The API will accept a Vfiler Name or Id From DFM 3.3 onwards. CounterGroupName xsd:string
Counter Group Name From which we want To fetch data. DataGroup WrapperOfPerfDataGroup
A definition of the data Source(s) requested, plus an optional consolidation method. EndTime xsd:integer
optional
Time stamp marking the end of requested data. The Timestamp Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC. If unspecified, server should end with the latest available data. GroupNameOrId xsd:string
optional
The Name (or unique ID) of the Source Group. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in GroupListIterNext APIs. This field is ignored if ApplianceNameOrId is specified. This field defaults To global Group if ApplianceNameOrId is not specified. SampleRate xsd:integer
optional
The desired interval between samples, in seconds. If the available samples have higher resolution than the one specified, multiple samples are consolidated into one sample To achieve the desired resolution, using the specified TimeConsolidationMethod. If unspecified, the data returned will be at the SampleRate specified upon creation of the counter Group. StartTime xsd:integer
optional
Time stamp marking the beginning of requested data. The Timestamp Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC. If unspecified, server should begin with the earliest available data. TimeConsolidationMethod xsd:string
optional
A function To apply across the data To achieve the desired time resolution, if the requested SampleRate is different From the actual SampleRate of the data. The Values can be average, min, max, or last. The default is last.
| Element definition: PerfCounterGroupGetDataResult | [top] |
Name Type Description CounterData xsd:string
The retrieved data - possibly consolidated, but just a single array. The format is a series of comma-separated Timestamp:Value pairs. The Timestamp Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC. The Values may have optional decimal extensions, for example 1064439599:127,1064439600:98.6,1064439601:12 Unit xsd:string
optional
Unit of CounterData. This element will not be present if the Unit is not known. Some possible Values are per_sec, percent, b_per_sec, kb_per_sec, msecs, usecs. Maximum Length: 32 characters.
| Element definition: PerfCounterGroupGetDynamicDataSources | [top] |
Retrieve a list of top-n data sources for a counter. Privilege required is read.
Name Type Description ApplianceNameOrId xsd:string
optional
The Name (or unique ID) of the Source storage system. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in the appliance-info structure From the appliance-list-iter-next. The API will accept a Vfiler Name or Id From DFM 3.3 onwards. CounterGroupName xsd:string
Counter Group Name From which we want To fetch data. DynamicDataSources WrapperOfPerfDynamicDataSources
Criteria for choosing top-n Instances for a counter. GroupNameOrId xsd:string
optional
The Name (or unique ID) of the Source Group. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in GroupListIterNext APIs. This field is ignored if ApplianceNameOrId is specified. This field defaults To global Group if ApplianceNameOrId is not specified.
| Element definition: PerfCounterGroupGetDynamicDataSourcesResult | [top] |
Name Type Description DataSources ArrayOfPerfDataSource
Identifiers for the data sources correspoing To dynamic Instances. Each PerfDataSource represents one Instance.
| Element definition: PerfCounterGroupListInfo | [top] |
Retrieve one or more counter Groups. Privilege required is read.
Name Type Description ApplianceNameOrId xsd:string
optional
The Name (or unique ID) of the Source storage system. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in the appliance-info structure From the appliance-list-iter-next. The API will accept a Vfiler Name or Id From DFM 3.3 onwards. Either ApplianceNameOrId or ObjectNameOrId should be specified, but not both. ObjectNameOrId is preferred as usage of ApplianceNameOrId, GroupNameOrId is deprecated. ConsolidateHosts xsd:boolean
optional
If true, then information for all the Hosts is consolidated and returned instead of information for individual Hosts. CounterGroupName xsd:string
optional
Counter Group Name To retrieve. If unspecified, all counter Groups will be retrieved. CounterInfoOnly xsd:boolean
optional
If true, the output element PerfCounterGroupStart, includes only the list of enabled Counters of the Host with object Type derived From the counter Group Name. In this case DataSources will not be returned. By default false. CustomOnly xsd:boolean
optional
If true, returns only custom counter Groups, by default false. DisabledCounterInfoOnly xsd:boolean
optional
If TRUE, returns counter information of the presently disabled Counters. Default Value is FALSE. GroupNameOrId xsd:string
optional
The Name (or unique ID) of the Source Group. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in GroupListIterNext APIs. This field is ignored if ApplianceNameOrId or ObjectNameOrId is specified. This field defaults To global Group if ApplianceNameOrId or ObjectNameOrId is not specified. ObjectNameOrId is preferred as usage of GroupNameOrId is deprecated. IncludeCalculatedStats xsd:boolean
optional
This Option is valid only if either 'CounterInfoOnly' or 'DisabledCounterInfoOnly' is set To TRUE. If this flag is set To TRUE, the counter information will include calculated Stats Counters otherwise by default it will exclude those Counters. MetaDataOnly xsd:boolean
optional
If true, do not return any perf-data-sources with the PerfCounterGroupStart. By default false. ObjectNameOrId ObjNameOrId
optional
If specified, output contains the CounterInfo element with list of enabled Counters belonging To supplied CounterGroupName. If CounterGroupName is not set then output includes Counters information for all counter Groups of the hosting Filer. Either ApplianceNameOrId or ObjectNameOrId should be specified, but not both. ObjectNameOrId is preferred as usage of ApplianceNameOrId, GroupNameOrId is deprecated.
| Element definition: PerfCounterGroupListInfoResult | [top] |
Name Type Description CounterGroups ArrayOfPerfCounterGroup
Counter Group(s) retrieved.
| Element definition: PerfCounterGroupListIterEnd | [top] |
Terminate a counter Group list iteration and clean up any saved info. Privilege required is read.
Name Type Description Tag xsd:string
The Tag From a previous perf-counter-group-list-iter- call.
| Element definition: PerfCounterGroupListIterEndResult | [top] |
[none]
| Element definition: PerfCounterGroupListIterNext | [top] |
Returns items From a previous call To PerfCounterGroupListIterStart. Privilege required is read.
Name Type Description Maximum xsd:integer
The Maximum number of entries To retrieve. Tag xsd:string
The Tag From a previous perf-counter-group-list-iter- call.
| Element definition: PerfCounterGroupListIterNextResult | [top] |
Name Type Description CounterGroups ArrayOfPerfCounterGroup
Counter Group(s) retrieved.
| Element definition: PerfCounterGroupListIterStart | [top] |
Initiates a Query for a list of performance counter Group names. Privilege required is read.
Name Type Description ApplianceNameOrId xsd:string
optional
The Name (or unique ID) of the Source storage system. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in the appliance-info structure From the appliance-list-iter-next. The API will accept a Vfiler Name or Id From DFM 3.3 onwards. CounterGroupName xsd:string
optional
Counter Group Name To retrieve. If unspecified, all counter Groups will be retrieved. CustomOnly xsd:boolean
optional
if TRUE, only custom Groups will be retrieved, by default false GroupNameOrId xsd:string
optional
The Name (or unique ID) of the Source Group. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in GroupListIterNext APIs. This field is ignored if ApplianceNameOrId is specified. This field defaults To global Group if ApplianceNameOrId is not specified. MetaDataOnly xsd:boolean
optional
If TRUE, do not include any perf-data-sources with each perf-counter-groups.
| Element definition: PerfCounterGroupListIterStartResult | [top] |
[none]
| Element definition: PerfCounterGroupModify | [top] |
Modify an existing counter Group. User can modify the sample-interval, SampleBuffer and the counter set of an existing counter Group at the individual Host level. Modifying a counter set of a counter Group means user can selectively enable/disable Counters according To the requirement of collecting data. If a counter is disabled data will not be collected for that counter and this gives the flexibility of controlling load on a storage system. This zapi will only enable the Counters mentioned in the 'DataSources' part of the input parameter 'PerfCounterGroupStart' and rest of the Counters of the counter Group will be automatically disabled. User can also disable all the Counters of a counter Group by setting the flag 'IsDisableAll' in the input parameter 'PerfCounterGroupStart'. Enabling/disabling Counters is not allowed for calculated Stats Counters in default counter Groups. Privilege required is DFM.Database.Write.
Name Type Description ApplianceNameOrId xsd:string
optional
The Name (or unique ID) of the Source storage system. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in the appliance-info structure From the appliance-list-iter-next. The API will accept a Vfiler Name or Id From DFM 3.3 onwards. CounterGroup WrapperOfPerfCounterGroup
The new counter Group information. Note that the new counter Group Name may be different From the old counter Group Name. If different, the new counter Group Name must not already exist. CounterGroupName xsd:string
The Name of the counter Group To modify. GroupNameOrId xsd:string
optional
The Name (or unique ID) of the Source Group. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in GroupListIterNext APIs. This field is ignored if ApplianceNameOrId is specified. This field defaults To global Group if ApplianceNameOrId is not specified.
| Element definition: PerfCounterGroupModifyResult | [top] |
[none]
| Element definition: PerfCounterGroupStart | [top] |
Start data collection for one counter Group. Privilege required is Global DFM.PerfView.Write for normal Views and Global DFM.PerfView.RealTimeRead for RealTime Views.
Name Type Description ApplianceNameOrId xsd:string
optional
The Name (or unique ID) of the Source storage system. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in the appliance-info structure From the appliance-list-iter-next. The API will accept a Vfiler Name or Id From DFM 3.3 onwards. CounterGroupName xsd:string
Counter Group Name To start data collection for. This must not be a default counter Group. GroupNameOrId xsd:string
optional
The Name (or unique ID) of the Source Group. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in GroupListIterNext APIs. This field is ignored if ApplianceNameOrId is specified. This field defaults To global Group if ApplianceNameOrId is not specified.
| Element definition: PerfCounterGroupStartResult | [top] |
[none]
| Element definition: PerfCounterGroupStop | [top] |
Stop data collection for one counter Group. Privilege required is Global DFM.PerfView.Write for normal Views and Global DFM.PerfView.RealTimeRead for RealTime Views.
Name Type Description ApplianceNameOrId xsd:string
optional
The Name (or unique ID) of the Source storage system. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in the appliance-info structure From the appliance-list-iter-next. The API will accept a Vfiler Name or Id From DFM 3.3 onwards. CounterGroupName xsd:string
Counter Group Name To stop data collection for. This must not be a default counter Group. GroupNameOrId xsd:string
optional
The Name (or unique ID) of the Source Group. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in GroupListIterNext APIs. This field is ignored if ApplianceNameOrId is specified. This field defaults To global Group if ApplianceNameOrId is not specified.
| Element definition: PerfCounterGroupStopResult | [top] |
[none]
| Element definition: PerfDiagTroubleshoot | [top] |
This API shall troubleshoot the DFM object for performance related issues and provides the recommendations To help resolve them.
Name Type Description Duration xsd:integer
optional
The recent time in seconds for which the data has To be analyzed Either Duration or start-time/end-time has be specified but not both. An Error will be returned if at least one of them is not supplied. EndTime xsd:unsignedInt
optional
Time stamp marking the end of diagnosis window The Timestamp Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC. Range: [0..(2^32)-1] Either Duration or start-time/end-time has To be specified but not both. An Error will be returned if at least one of them is not supplied. ObjectNameOrId ObjNameOrId
ObjectName or Id of the following Objects that needs troubleshooting.
- Storage System
StartTime xsd:unsignedInt
optional
Time stamp marking the beginning of diagnosis window The Timestamp Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC. Range: [0..(2^32)-1] Either Duration or start-time/end-time has To be specified but not both. An Error will be returned if at least one of them is not supplied.
| Element definition: PerfDiagTroubleshootResult | [top] |
Name Type Description Categories ArrayOfPerfDiagCategory
List of root causes or performance problems.
| Element definition: PerfDisableDataCollection | [top] |
Disables DFM performance advisor data collection.
Name Type Description IsAsync xsd:boolean
optional
Returns immediately without waiting for DFM performance advisor To disable the data collection completely (when set To true). By default this API is synchronous. IsPersistent xsd:boolean
optional
If true the disabling of Performance Advisor is saved in the database. If false, the disbling is temporary and the setting is not saved in the database. If the server restarts the data collection begins again.
| Element definition: PerfDisableDataCollectionResult | [top] |
[none]
| Element definition: PerfDisableObjectUpdate | [top] |
Disables any modification To DFM performance advisor Views, counter Groups and object Instances.
[none]
| Element definition: PerfDisableObjectUpdateResult | [top] |
[none]
| Element definition: PerfEnableDataCollection | [top] |
Enables DFM performance advisor data collection.
[none]
| Element definition: PerfEnableDataCollectionResult | [top] |
[none]
| Element definition: PerfEnableObjectUpdate | [top] |
Enables modifications To DFM performance advisor Views, counter Groups and object Instances.
[none]
| Element definition: PerfEnableObjectUpdateResult | [top] |
[none]
| Element definition: PerfGetCounterData | [top] |
Retrieve data for all the related Objects for the given object and the specified performance Counters.
Name Type Description Direction xsd:string
optional
This field is used only when Duration is specified It is used To derive the time Period for which data is To be retrieved. If the Value is set To 'forward', then the starting time is the time stamp of the oldest data. The ending time is the sum of time stamp of the oldest data and the Duration. If the Value is set To 'backward', then the starting time is the difference between time stamp of the most recent data and the Duration. The ending time is the time stamp of the most recent data. If the Value is set To 'backward-from-now', then the starting time is the difference between current time and the Duration. The ending time is the current time. Default Value is 'backward' Duration xsd:unsignedInt
optional
The Duration for which the data is To be returned, in seconds. The time Period is calculated based on the Direction flag. Duration should not be specified when either StartTime or EndTime is specified. If specfied, EINVALIDINPUTERROR Error will be returned. Range: [0..(2^32)-1] EndTime xsd:unsignedInt
optional
Time stamp marking the end of requested data. The Timestamp Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC. If unspecified, server should end with the latest available data. Range: [0..(2^32)-1] InstanceCounterInfo InstanceCounterInfo
This defines what counter data To be returned for the specified Instances. NumberSamples xsd:integer
optional
The Total number of samples To be returned. The SampleRate will be calculated based on the StartTime and EndTime. If the available samples have higher resolution than the one specified, multiple samples are consolidated into one sample To achieve the desired resolution, using the specified TimeConsolidationMethod. If unspecified, the number of samples returned will be based on the SampleRate specified upon creation of the View. Either SampleRate or NumberSamples should be specified, but not both. Range: [1..(2^32)-1] SampleRate xsd:integer
optional
The desired interval between samples, in seconds. If the available samples have higher resolution than the one specified, multiple samples are consolidated into one sample To achieve the desired resolution, using the specified TimeConsolidationMethod. If unspecified, the data returned will be at the SampleRate specified in the counter Group that the counter is present. Range: [1..(2^32)-1]. StartTime xsd:unsignedInt
optional
Time stamp marking the beginning of requested data. The Timestamp Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC. If unspecified, server should begin with the earliest available data. Range: [0..(2^32)-1] TimeConsolidationMethod xsd:string
optional
A function To apply across the data To achieve the desired time resolution, if the requested SampleRate is different From the actual SampleRate of the data. Possible Values : 'average' 'min' 'max' 'last' Default is 'last' TimeFilter TimeFilter
optional
Time based filter To reading data. This filter will be applied on the range derived From the start-time/end-time/duration/direction fields. This field is used only for Metrics calculations, if Metrics field is not specified in the input this field will be ignored.
| Element definition: PerfGetCounterDataResult | [top] |
Name Type Description InvalidCounterInstances ArrayOfInvalidCounterInstance
optional
A list of invalid counter Instance pairs, for which performance data could not be fetched. PerfInstances ArrayOfPerfInstanceCounterData
optional
List of Instances. Each element of this list contains the counter data for an Instance.
| Element definition: PerfGetCounterDependents | [top] |
Find out the Operations Manager Reports, Performance Advisor custom Views, Performance Advisor threshold templates and Performance Advisor Thresholds which depend on the specified performance Counters.
Name Type Description Counters ArrayOfPerfObjectCounter
The list of Counters. HostNameOrId HostNameOrId
optional
The Host Name or Id. If this parameter is specified, custom Views attached To object Instances will be returned in addition To the custom Views attached with object types.
| Element definition: PerfGetCounterDependentsResult | [top] |
Name Type Description BaseCounters ArrayOfPerfObjectCounter
optional
The list of Counters To which at least one of the input Counters are dependent. DependentCounters ArrayOfPerfObjectCounter
optional
The list of Counters dependent on at least one of the input Counters. This dependent counter list will contain both the calculated Stats as well as the basic Counters. Reports ArrayOfPerfReport
optional
The list of report names that have at least one of the input Counters. ThresholdTemplates ArrayOfThresholdTemplate
optional
The list of threshold template names that have at least one of the input Counters. Thresholds ArrayOfPerfThreshold
optional
The list of Thresholds that have at least one of the input Counters. Views ArrayOfPerfView
optional
The list of custom Views that have at least one of the input Counters.
| Element definition: PerfGetCounterListNotInView | [top] |
Given an array of performance Objects and Counters, the API will return a list of all Counters that are not part of any View.
Name Type Description ObjectCounterList ArrayOfPerfObjectCounterInfo
Array of PerfObjectCounterInfo elements for which information is needed, To know whether they belong To any View or not.
| Element definition: PerfGetCounterListNotInViewResult | [top] |
Name Type Description OrphanObjectCounterList ArrayOfPerfObjectCounterInfo
Array of PerfObjectCounterInfo elements that are not part of any View.
| Element definition: PerfGetDefaultView | [top] |
Gets the default View for an object.
Name Type Description ObjectNameOrId ObjNameOrId
optional
Specifies the object for which the View is To be retrieved. If not present, then Global Group is assumed.
| Element definition: PerfGetDefaultViewResult | [top] |
Name Type Description ViewName xsd:string
The ViewName which is To be displayed by default for the object. Maximum Length is 255 characters
| Element definition: PerfGetServerStatus | [top] |
Returns the Status of DFM Performance Advisor.
[none]
| Element definition: PerfGetServerStatusResult | [top] |
Name Type Description PerfServerStatus PerfServerStatus
Specifies the Status of Performance Advisor.
| Element definition: PerfObjectCounterListInfo | [top] |
Retrieve information about a performance object's Counters. (No iterator-based equivalent exists for this API because the number of object Counters is fewer than two hundred in number.) Privilege required is read.
Name Type Description ApplianceNameOrId xsd:string
optional
The Name or unique ID for the storage system. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in the appliance-info structure From the appliance-list-iter-next API. The API will accept a Vfiler Name or Id From DFM 3.3 onwards. IncludeCalculatedStats xsd:boolean
optional
If set To false the output will exclude the calculated Stats Counters. By default the Value is true i.e will always include calculated Stats. ObjectName xsd:string
Name of the performance object To retrieve Counters for. Object names are broad classes of system components and protocols, like NFS, VOLUME, DISK, ...
| Element definition: PerfObjectCounterListInfoResult | [top] |
Name Type Description Counters ArrayOfPerfCounter
Counters retrieved.
| Element definition: PerfObjectDependentCounterListInfo | [top] |
Retrieve information about a performance object's dependent Counters. Privilege required is read.
Name Type Description ApplianceNameOrId xsd:string
optional
The Name or unique ID for the storage system. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in the appliance-info structure From the appliance-list-iter-next API. The API will accept a Vfiler Name or Id From DFM 3.3 onwards. ObjectName xsd:string
Name of the performance object To retrieve dependent Counters. Object names are broad classes of system components and protocols, like NFS, VOLUME, DISK, ...
| Element definition: PerfObjectDependentCounterListInfoResult | [top] |
Name Type Description DependentCounters ArrayOfPerfDependentCounterInfo
List of dependent Counters.
| Element definition: PerfObjectInstanceListIterEnd | [top] |
Terminate an Instance list iteration and clean up any saved info. Privilege required is read.
Name Type Description Tag xsd:string
The Tag From a previous perf-object-instance-list-iter- call.
| Element definition: PerfObjectInstanceListIterEndResult | [top] |
[none]
| Element definition: PerfObjectInstanceListIterNext | [top] |
Returns items From a previous call To PerfObjectInstanceListIterStart Privilege required is read.
Name Type Description Maximum xsd:integer
The Maximum number of entries To retrieve. Tag xsd:string
The Tag From a previous perf-object-instance-list-iter- call.
| Element definition: PerfObjectInstanceListIterNextResult | [top] |
Name Type Description Instances ArrayOfPerfInstance
A list of Instances.
| Element definition: PerfObjectInstanceListIterStart | [top] |
Initiates a Query for a list of performance object Instance names. Privilege required is read.
Name Type Description ApplianceNameOrId xsd:string
Name (or unique ID) of the storage system. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in the appliance-info structure From the appliance-list-iter-next API. The API will accept a Vfiler Name or Id From DFM 3.3 onwards. ObjectName xsd:string
Name of the performance object To retrieve Instances for. Object names are broad classes of system components and protocols, like NFS, VOLUME, DISK, ...
| Element definition: PerfObjectInstanceListIterStartResult | [top] |
Name Type Description Records xsd:integer
Number indicating how many items are avialble for future retrieval with PerfObjectInstanceListIterNext. Tag xsd:string
Tag To be used in subsequent calls To PerfObjectInstanceListIterNext or PerfObjectInstanceListIterEnd.
| Element definition: PerfObjectListInfo | [top] |
Get a list of performance Objects. (No iterator-based equivalent exists for this API because the number of performance Objects is fewer than twenty in number.) Privilege required is read.
Name Type Description ApplianceNameOrId xsd:string
optional
Name (or unique ID) of the storage system. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in the appliance-info structure From the appliance-list-iter-next API. The API will accept a Vfiler Name or Id From DFM 3.3 onwards.
| Element definition: PerfObjectListInfoResult | [top] |
Name Type Description Objects ArrayOfPerfObject
A list of performance Objects.
| Element definition: PerfSetDefaultView | [top] |
Sets the default View for an object.
Name Type Description ObjectNameOrId ObjNameOrId
optional
Specifies the object for which the View is To be set. If not specfied, then the Global Group is assumed. ViewName xsd:string
The ViewName which is To be displayed by default for the object. Maximum Length is 255.
| Element definition: PerfSetDefaultViewResult | [top] |
[none]
| Element definition: PerfStatusGet | [top] |
Returns the DFM performance advisor Status
Name Type Description HostNameOrId xsd:string
DFM Name or Id of the Host
| Element definition: PerfStatusGetResult | [top] |
Name Type Description DataUnavailableReason ArrayOfPerfStatusError
optional
This element is included only if IsDataAvailable is set To false and indicates the Reason(s) for failure. IsDataAvailable xsd:boolean
Returns if the performance data can be collected for this Host
| Element definition: PerfThresholdCreate | [top] |
Sets threshold Values on one or more Objects based on a performance counter. Privilege required is DFM.Database.Write. Threshold will be set only if the User has DFM.Database.Write Permission over the object specified.
Name Type Description ThresholdInfo ThresholdInfo
Information about a threshold that needs To be set.
| Element definition: PerfThresholdCreate2 | [top] |
Creates one threshold composed of one or more Counters, and optionally applies it To an object. The user must have the Capability To perform the DFM.Database.Write Operation on the object on which the threshold is applied.
Name Type Description ObjectNameOrId ObjNameOrId
Specifies the object on which the threshold is To be applied. When applying a threshold To an object, in case of container Objects (like Groups) or parent Objects (like storage systems), if a counter is specified on a child object, the threshold applies To all such children. For example, if aggr:cp_reads is specified as one of the Counters in the threshold and there is no counter of an object which is a child of an Aggregate (viz. Volume or Qtree), and the ObjectNameOrId is that of a storage system, the threshold applies To all present and future Aggregates on the storage system. ThresholdInfo2 ThresholdInfo2
Specifies the Attributes of the threshold To be created.
| Element definition: PerfThresholdCreate2Result | [top] |
Name Type Description ThresholdId ThresholdId
Specifies the Id of the threshold that is created.
| Element definition: PerfThresholdCreateResult | [top] |
Name Type Description ThresholdId ThresholdId
If the threshold does not exist and is being created for the first time, then this parameter is present in the output. If a threshold already exists, then an Error is returned instead of this parameter.
| Element definition: PerfThresholdDelete | [top] |
Removes threshold set on a counter. The user must have the Capability To perform the DFM.Database.Delete Operation on the object on which the threshold is directly applied. This ZAPI cannot be used To delete template Thresholds, and PerfThresholdTemplateModify should be used for that purpose.
Name Type Description ThresholdId ThresholdId
The unique identifier of a threshold that needs To be deleted.
| Element definition: PerfThresholdDeleteResult | [top] |
[none]
| Element definition: PerfThresholdListInfo2IterEnd | [top] |
Terminate a perf-thresholds-list-info2 iteration and clean up any saved info.
Name Type Description Tag xsd:string
The Tag From a previous PerfThresholdListInfo2IterStart call.
| Element definition: PerfThresholdListInfo2IterEndResult | [top] |
[none]
| Element definition: PerfThresholdListInfo2IterNext | [top] |
The PerfThresholdListInfo2Iter* list of APIs are used To retrieve the list of all Objects on which Thresholds have been set.
Name Type Description Maximum xsd:integer
The Maximum number of entries To retrieve. Range: [1..2^31-1]
Tag xsd:string
The Tag From a previous PerfThresholdListInfo2IterStart call.
| Element definition: PerfThresholdListInfo2IterNextResult | [top] |
Name Type Description AttributesList ArrayOfThresholdInfo2
List of performance Thresholds. Records xsd:integer
The number of Records actually returned. Range: [0..2^31-1].
| Element definition: PerfThresholdListInfo2IterStart | [top] |
The PerfThresholdListInfo2Iter* list of APIs are used To retrieve the list of Objects on which Thresholds have been set. It loads the list of Thresholds into a temporary store. The API returns a Tag that identifies the temporary store so that subsequent APIs can be used To iterate over the Thresholds in it. The user must have the Capability To perform the DFM.Database.Read Operation on the object on which the threshold is applied, and only Thresholds which are applied on such Objects will be returned.
Name Type Description ObjectNameOrId ObjNameOrId
optional
If specified, only Thresholds set on this object will be returned. This includes Thresholds that apply To this object via inheritance. For example, if there is a threshold on an Aggregate counter applied To a Filer, and ObjNameOrId identifies an Aggregate in that Filer, the threshold will be returned. ThresholdId ThresholdId
optional
If specified, only information relevant To the threshold with this Id will be returned. This parameter takes precedence over all others, and it may not be specified in combination with any of the other arguments.
| Element definition: PerfThresholdListInfo2IterStartResult | [top] |
Name Type Description Records xsd:integer
Number indicating how many items are available for future retrieval via calls To PerfThresholdListInfo2IterNext Tag xsd:string
Tag To be used in subsequent calls To PerfThresholdListInfo2IterNext. It is an opaque handle used by the DFM station To identify a temporary store.
| Element definition: PerfThresholdListInfoIterEnd | [top] |
Terminate a counter-thresholds-list iteration and clean up any saved info. Privilege required is DFM.Database.Read. Only Thresholds on Objects over which the user has DFM.Database.Read permissions will be returned.
Name Type Description Tag xsd:string
The Tag From a previous perf-threshold-list-iter call.
| Element definition: PerfThresholdListInfoIterEndResult | [top] |
[none]
| Element definition: PerfThresholdListInfoIterNext | [top] |
The PerfThresholdListInfoIter* list of APIs are used To retrieve the list of all Counters on which Thresholds have been set. It loads the list of Counters on which Thresholds have been set into a temporary store. The API returns a Tag that identifies that temporary store so that subsequent APIs can be used To iterate over the threshold related Counters in the temporary store. Privilege required is DFM.Database.Read. Only Thresholds on Objects over which the user has DFM.Database.Read permissions will be returned.
Name Type Description Maximum xsd:integer
The Maximum number of entries To retrieve. Range: [1..2^31-1]
Tag xsd:string
The Tag From a previous perf-threshold-list-iter call.
| Element definition: PerfThresholdListInfoIterNextResult | [top] |
Name Type Description AttributesList ArrayOfThresholdInfo
List of performance Thresholds. Records xsd:integer
The number of Records actually returned. Range: [0..2^31-1].
| Element definition: PerfThresholdListInfoIterStart | [top] |
The PerfThresholdListInfoIter* list of APIs are used To retrieve the list of all Counters on which Thresholds have been set. It loads the list of Counters on which Thresholds have been set into a temporary store. The API returns a Tag that identifies a temporary store so that subsequent APIs can be used To iterate over the threshold related Counters in the temporary store. Privilege required is DFM.Database.Read. Only Thresholds on Objects over which the User has DFM.Database.Read permissions will be returned.
Name Type Description Query WrapperOfThresholdInfo
optional
Attributes of the Thresholds that need To be listed. If none of the parameters are specified, then all the Thresholds will be listed. If a single ThresholdId is specified, then only information relevant To that threshold will be returned and the rest of the parameters will be ignored.
If only an ObjectNameOrId is specified, then only Thresholds set on that object will be returned. Ex. if ObjectNameOrId identifies a Volume, Thresholds set on that Volume only will be returned. If ObjectNameOrId resolves To more than one Volume, Thresholds set on all of them will be returned. If no ObjectNameOrId is provided, all Thresholds will be listed.
Likewise, if only PerfObjectCounter is specified, only Thresholds that belong To this CounterName and object Type will be returned. If no CounterName is specified, Thresholds set on any counter is returned.
If both ObjectNameOrId and PerfObjectCounter is specified, then only Thresholds set on a combination of all these parameters will be listed.
The rest of the parameters in ThresholdInfo are ignored.
| Element definition: PerfThresholdListInfoIterStartResult | [top] |
Name Type Description Records xsd:integer
Number indicating how many items are available for future retrieval via calls To PerfThresholdListInfoIterNext Tag xsd:string
Tag To be used in subsequent calls To PerfThresholdListInfoIterNext. It is an opaque handle used by the DFM station To identify a temporary store.
| Element definition: PerfThresholdModify | [top] |
Allows modification of threshold Value and threshold interval that have been set before. Privilege required is DFM.Database.Write.
Name Type Description Attributes WrapperOfThresholdInfo
Attributes of a threshold that needs To be modified. If the ThresholdId is specified, then ObjectNameOrId and PerfObjectCounter are ignored. If the ThresholdId is not specified, then ObjectNameOrId and PerfObjectCounter are mandatory. The rest of the parameters are optional. If the ThresholdValue specified is in a different Metric, then the ThresholdUnit needs To be specified for appropriate conversion.
| Element definition: PerfThresholdModify2 | [top] |
Modify an existing threshold. This ZAPI should be used only for changing the parameters of a threshold, not for changing the Objects it is not applied on. The ObjectsInfo structure is ignored in this ZAPI. This ZAPI cannot be used To modify template Thresholds, and PerfThresholdTemplateModify should be used for that purpose. The user must have the Capability To perform the DFM.Database.Write Operation on the object on which the threshold is applied.
Name Type Description ThresholdInfo2 ThresholdInfo2
Information on the threshold To modify. The ThresholdId parameter must be specified To modify a threshold.
| Element definition: PerfThresholdModify2Result | [top] |
[none]
| Element definition: PerfThresholdModifyResult | [top] |
[none]
| Element definition: PerfThresholdTemplateAttachObjects | [top] |
Attach one or more Objects To a performance template. Either all input Objects get attached or none of them get attached. The specified Objects will get associated To the applicable Thresholds in the template. Objects cannot be attached if the template has no Thresholds. Objects already attached To the template are left unchanged. The user must have the Capability To perform the DFM.Database.Write Operation on the object To which the template is To be attached.
Name Type Description NewObjects ArrayOfObjectInfo
optional
The list of Objects To be attached To the template. At least one object should be specified. TemplateNameOrId xsd:string
Name or Id of a performance template
| Element definition: PerfThresholdTemplateAttachObjectsResult | [top] |
[none]
| Element definition: PerfThresholdTemplateCreate | [top] |
Creates a template for perf Thresholds.
Name Type Description MemberThresholds ArrayOfThresholdInfo2
optional
Specifies the Thresholds that are To be part of this template. TemplateDescription xsd:string
optional
Description of the template. TemplateName xsd:string
Name of the template.
| Element definition: PerfThresholdTemplateCreateResult | [top] |
Name Type Description TemplateId xsd:integer
This returns the Id of the template that is created Range: [1..2^32-1]
| Element definition: PerfThresholdTemplateDelete | [top] |
Deletes a template.
Name Type Description TemplateNameOrId xsd:string
The Name or Id of the template that is To be deleted.
| Element definition: PerfThresholdTemplateDeleteResult | [top] |
Name Type Description TemplateId xsd:integer
The Id of the deleted template. Range: [1..2^32-1] TemplateName xsd:string
The Name of the deleted template.
| Element definition: PerfThresholdTemplateDetachObjects | [top] |
Detaches one or more Objects From a performance template. Either all or none of the input Objects get detached. The user must have the Capability To perform the DFM.Database.Write Operation on the object which is To be detached From the template.
Name Type Description Objects ArrayOfObjectInfo
optional
The list of Objects To be detached From the template. At least one object should be specified. TemplateNameOrId xsd:string
Name or Id of a performance template
| Element definition: PerfThresholdTemplateDetachObjectsResult | [top] |
[none]
| Element definition: PerfThresholdTemplateListInfoIterEnd | [top] |
Terminate a perf-threshold-template-list iteration and clean up any saved information.
Name Type Description Tag xsd:string
The Tag From a previous perf-threshold-template-list-iter-start call.
| Element definition: PerfThresholdTemplateListInfoIterEndResult | [top] |
[none]
| Element definition: PerfThresholdTemplateListInfoIterNext | [top] |
The PerfThresholdTemplateListInfoIter* list of APIs are used To retrieve the list of all Objects on which Thresholds have been set.
Name Type Description Maximum xsd:integer
The Maximum number of entries To retrieve. Range: [1..2^31-1]
Tag xsd:string
The Tag From a previous PerfThresholdTemplateListInfoIterStart call.
| Element definition: PerfThresholdTemplateListInfoIterNextResult | [top] |
Name Type Description Records xsd:integer
The number of Records actually returned. Range: [0..2^31-1]. ThresholdTemplates ArrayOfThresholdTemplateInfo
List of performance Thresholds.
| Element definition: PerfThresholdTemplateListInfoIterStart | [top] |
The PerfThresholdTemplateListInfoIter* list of APIs are used To retrieve the list of all threshold templates that have been created. It loads the templates into a temporary store. The API returns a Tag that identifies a temporary store so that subsequent APIs can be used To iterate over the threshold related Counters in the temporary store.
Name Type Description IncludeObjects xsd:boolean
optional
If true, the output will include Objects on which the template(s) apply. Only the direct Objects will be returned. Only Objects on which the user has the Capability To perform the DFM.Database.Read Operation will be returned. Default Value is false. IncludeThresholds xsd:boolean
optional
If true, the output will include the Thresholds that are part of the template. Default Value is false. TemplateNameOrId xsd:string
optional
Return information of a specific template
| Element definition: PerfThresholdTemplateListInfoIterStartResult | [top] |
Name Type Description Records xsd:integer
Number indicating how many items are available for future retrieval via calls To PerfThresholdTemplateListInfoIterNext. Tag xsd:string
Tag To be used in subsequent calls To PerfThresholdTemplateListInfoIterNext. It is an opaque handle used by the DFM station To identify a temporary store.
| Element definition: PerfThresholdTemplateModify | [top] |
The PerfThresholdTemplateModify zapi is used To modify an existing threshold template. It can be used To add, remove or modify Thresholds in the template or modify Attributes of the template
Name Type Description IsEnabled xsd:boolean
optional
This specifies if the template is enabled or not. If not specified, the enabled/disabled state of the template is not modified. MemberThresholds ArrayOfThresholdInfo2
optional
Specifies the Thresholds that are To be part of this template. TemplateDescription xsd:string
optional
A new Description for the template, if the Description is To be modified. TemplateId xsd:integer
Specifies the Id of the template that is To be modified. Range: [1..2^32-1] TemplateName xsd:string
optional
The new Name for the template, if the Name is To be modified.
| Element definition: PerfThresholdTemplateModifyResult | [top] |
[none]
| Element definition: PerfViewAssociatedObjectsList | [top] |
List all the Objects associated with the View.
Name Type Description ViewName xsd:string
The View for which To list associated Objects
| Element definition: PerfViewAssociatedObjectsListResult | [top] |
Name Type Description Objects ArrayOfObjectInfo
The Objects that are associated with the View
| Element definition: PerfViewCreate | [top] |
Create a performance View. A performance View consists of one or more Charts, but each View refers To only a single counter Group. Global DFM.PerfView.Write RBAC Capability is required To create normal Views while Global DFM.PerfView.RealTimeRead is required To create RealTime View.
Name Type Description DataSources ArrayOfPerfDataSource
optional
Identifiers for the data sources To be retrieved in later queries. The DataSources can not contain 'Group' data Source. i.e. InstanceName must be specified for each PerfDataSource. The DataSources should not contain a data Source that specifies LabelNames field. This is because counter Group always collects data for the whole counter i.e. for all Labels. PerfDataSource is not required for default counter Groups. The PerfCounterGroupModify API ignores this element for default counter Groups. RealTime xsd:boolean
optional
Designates whether the counter Group is RealTime, in other words, if no user is getting data From the Group, then the counter Group will no longer get data. By default FALSE. View WrapperOfPerfView
A performance View To create.
| Element definition: PerfViewCreateResult | [top] |
[none]
| Element definition: PerfViewDestroy | [top] |
Destroy a performance View. Global DFM.PerfView.Delete is required for destroying normal Views while Global DFM.PerfView.RealTimeRead is required for destroying RealTime Views.
Name Type Description ApplianceNameOrId xsd:string
optional
Name (or unique ID) of the storage system. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in the appliance-info structure From the appliance-list-iter-next API. The API will accept a Vfiler Name or Id From DFM 3.3 onwards. GroupNameOrId xsd:string
optional
The Group that this View is associated with. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in GroupListIterNext APIs. IsCounterGroupAlsoDeleted xsd:boolean
optional
Also Destroy the associated counter Group. Default is false. This Option is ignored if the counter Group is default. ViewName xsd:string
Name of the View To be destroyed.
| Element definition: PerfViewDestroyResult | [top] |
[none]
| Element definition: PerfViewGetData | [top] |
Retrieve data for a single DataSource From a specific performance View. The data is extracted for the given time interval bounded by StartTime and EndTime.
Name Type Description Direction xsd:string
optional
This field is used only when Duration is specified It is used To derive the time Period for which data is To be retrieved. If the Value is set To 'forward', then the starting time is the time stamp of the oldest data. The ending time is the sum of time stamp of the oldest data and the Duration. If the Value is set To 'backward', then the starting time is the difference between time stamp of the most recent data and the Duration. The ending time is the time stamp of the most recent data. If the Value is set To 'backward-from-now', then the starting time is the difference between current time and the Duration. The ending time is the current time. Default Value is 'backward' Duration xsd:unsignedInt
optional
The Duration for which the data is To be returned, in seconds. The time Period is calculated based on the Direction flag. Duration should not be specified when either StartTime or EndTime is specified. If specfied, EINVALIDINPUTERROR Error will be returned. Range: [0..(2^32)-1] DynamicObjectInfo WrapperOfPerfDynamicDataSources
optional
This defines what Objects are To be displayed for dynamic Charts like top-N Objects EndTime xsd:unsignedInt
optional
Time stamp marking the end of requested data. The Timestamp Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC. If unspecified, server should end with the latest available data Range: [0..(2^32)-1] Instance WrapperOfPerfCounterInstance
optional
The object Instance for which data is To be retrieved IsDynamic xsd:boolean
optional
Indicates if top n data sources should be returned Default is false NumberSamples xsd:integer
optional
The Total number of samples To be returned. The SampleRate will be calculated based on the StartTime and EndTime If the available samples have higher resolution than the one specified, multiple samples are consolidated into one sample To achieve the desired resolution, using the specified TimeConsolidationMethod. If unspecified, the number of samples returned will be based on the SampleRate specified upon creation of the View. Either SampleRate or NumberSamples should be specified, but not both Range: [1..(2^32)-1] SampleRate xsd:integer
optional
The desired interval between samples, in seconds. If the available samples have higher resolution than the one specified, multiple samples are consolidated into one sample To achieve the desired resolution, using the specified TimeConsolidationMethod. If unspecified, the data returned will be at the SampleRate specified upon creation of the View Range: [1..(2^32)-1] StartTime xsd:unsignedInt
optional
Time stamp marking the beginning of requested data. The Timestamp Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC. If unspecified, server should begin with the earliest available data. Range: [0..(2^32)-1] TimeConsolidationMethod xsd:string
optional
A function To apply across the data To achieve the desired time resolution, if the requested SampleRate is different From the actual SampleRate of the data. Possible Values : 'average' 'min' 'max' 'last' Default is 'last' ViewName xsd:string
The View From which data is To be retrieved Maximum Length is 255
| Element definition: PerfViewGetDataResult | [top] |
Name Type Description CounterData xsd:string
optional
A single array of the retrieved data. The format is a series of comma-separated Timestamp:Value pairs. The Timestamp Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC. The Values may have optional decimal extensions, for example 1064439599:127,1064439600:98.6,1064439601:12 DynamicData ArrayOfDynamicData
optional
Contains data for top-N Objects Unit xsd:string
optional
Unit of CounterData. This element will not be present if the Unit is not known. Some possible Values are per_sec, percent, b_per_sec, kb_per_sec, msecs, usecs. Maximum Length: 32 characters.
| Element definition: PerfViewListIterEnd | [top] |
Terminate a View list iteration and clean up any saved info. Privilege required is read.
Name Type Description Tag xsd:string
Tag From a previous PerfViewListIterStart
| Element definition: PerfViewListIterEndResult | [top] |
[none]
| Element definition: PerfViewListIterNext | [top] |
Retrieve items From a previous call To PerfViewListIterStart Privilege required is read.
Name Type Description Maximum xsd:integer
The Maximum number of entries To retrieve. Tag xsd:string
The Tag From a previous perf-view-list-iter- call.
| Element definition: PerfViewListIterNextResult | [top] |
Name Type Description Views ArrayOfPerfView
A list of Views.
| Element definition: PerfViewListIterStart | [top] |
Initiates a Query for a list of performance Views. Privilege required is read.
Name Type Description ApplianceNameOrId xsd:string
optional
The Name (or unique ID) of the Source storage system. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in the appliance-info structure From the appliance-list-iter-next. The API will accept a Vfiler Name or Id From DFM 3.3 onwards. Only the Views for matching storage system are returned. CustomOnly xsd:boolean
optional
If TRUE, returns only custom Views, by default FALSE. GroupNameOrId xsd:string
optional
The Name (or unique ID) of the Source Group. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in the GroupListIterNext APIs. This is ignored if ApplianceNameOrId has been specified. Only the Views for matching Group are returned. IncludeEmptyViews xsd:boolean
optional
If false, the following will be removed From the output Views: By default, this is false.
- Lines without any data Source
- Charts without any Lines
- Views without any Charts
InstanceName xsd:string
optional
If specified, only Views with a matching Instance will be returned. Otherwise, all performance Views will be returned (subject To the other optional parameters). You must specify ApplianceNameOrId and ObjectName when specifying InstanceName. ObjectName xsd:string
optional
If specified, only Views with a matching object will be returned. Otherwise, all performance Views will be returned (subject To the other optional parameters). ViewName xsd:string
optional
If ViewName is specified, only the indicated View will be retrieved. Otherwise, all performance Views will be returned (subject To the other optional parameters).
| Element definition: PerfViewListIterStartResult | [top] |
Name Type Description Records xsd:integer
Number indicating how many items are available for future retrieval via calls To PerfViewListIterNext Tag xsd:string
Tag To be used in subsequent calls To PerfViewListIterNext or PerfViewListIterEnd
| Element definition: PerfViewModify | [top] |
Modify an existing performance View. Global DFM.PerfView.Write RBAC Capability is required To modify performance Views.
Name Type Description ApplianceNameOrId xsd:string
optional
Name (or unique ID) of the storage system. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in the appliance-info structure From the appliance-list-iter-next API. The API will accept a Vfiler Name or Id From DFM 3.3 onwards. GroupNameOrId xsd:string
optional
The Group that this View is associated with. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in GroupListIterNext APIs. View WrapperOfPerfView
The new performance View information. Note that the new performance View Name may be different From the old performance View Name. If the new Name is different, the new Name must not already exist. ViewName xsd:string
Name of the performance View To modify.
| Element definition: PerfViewModifyResult | [top] |
[none]
| Element definition: PerfViewObjectAssociationAdd | [top] |
Associates an object with a View
Name Type Description ObjectNameOrId ObjNameOrId
The object To be associated with the View ViewName xsd:string
The View for which the association is To be set
| Element definition: PerfViewObjectAssociationAddResult | [top] |
[none]
| Element definition: PerfViewObjectAssociationDelete | [top] |
Removes the association of an object with a View
Name Type Description ObjectNameOrId ObjNameOrId
The object To be dis-associated with the View ViewName xsd:string
The View for which the association is To be deleted
| Element definition: PerfViewObjectAssociationDeleteResult | [top] |
[none]
| Element definition: ArrayOfClientStatError | [top] |
Name Type Description ClientStatError ClientStatError[]
| Element definition: ArrayOfDestinationHostInfo | [top] |
Name Type Description DestinationHostInfo DestinationHostInfo[]
| Element definition: ArrayOfDynamicData | [top] |
Name Type Description DynamicData DynamicData[]
| Element definition: ArrayOfHostClientStats | [top] |
Name Type Description HostClientStats HostClientStats[]
| Element definition: ArrayOfInvalidCounterInstance | [top] |
Name Type Description InvalidCounterInstance InvalidCounterInstance[]
| Element definition: ArrayOfObjNameOrId | [top] |
Name Type Description ObjNameOrId ObjNameOrId[]
| Element definition: ArrayOfObjectInfo | [top] |
Name Type Description ObjectInfo ObjectInfo[]
| Element definition: ArrayOfPerfCounter | [top] |
Name Type Description PerfCounter PerfCounter[]
| Element definition: ArrayOfPerfCounterGroup | [top] |
Name Type Description PerfCounterGroup PerfCounterGroup[]
| Element definition: ArrayOfPerfDataSource | [top] |
Name Type Description PerfDataSource PerfDataSource[]
| Element definition: ArrayOfPerfDependentCounterInfo | [top] |
Name Type Description PerfDependentCounterInfo PerfDependentCounterInfo[]
| Element definition: ArrayOfPerfDiagCategory | [top] |
Name Type Description PerfDiagCategory PerfDiagCategory[]
| Element definition: ArrayOfPerfInstance | [top] |
Name Type Description PerfInstance PerfInstance[]
| Element definition: ArrayOfPerfInstanceCounterData | [top] |
Name Type Description PerfInstanceCounterData PerfInstanceCounterData[]
| Element definition: ArrayOfPerfMissingHostObjectCounter | [top] |
Name Type Description PerfMissingHostObjectCounter PerfMissingHostObjectCounter[]
| Element definition: ArrayOfPerfObject | [top] |
Name Type Description PerfObject PerfObject[]
| Element definition: ArrayOfPerfObjectCounter | [top] |
Name Type Description PerfObjectCounter PerfObjectCounter[]
| Element definition: ArrayOfPerfObjectCounterInfo | [top] |
Name Type Description PerfObjectCounterInfo PerfObjectCounterInfo[]
| Element definition: ArrayOfPerfPurgedHostObjectCounter | [top] |
Name Type Description PerfPurgedHostObjectCounter PerfPurgedHostObjectCounter[]
| Element definition: ArrayOfPerfReport | [top] |
Name Type Description PerfReport PerfReport[]
| Element definition: ArrayOfPerfStatusError | [top] |
Name Type Description PerfStatusError PerfStatusError[]
| Element definition: ArrayOfPerfThreshold | [top] |
Name Type Description PerfThreshold PerfThreshold[]
| Element definition: ArrayOfPerfView | [top] |
Name Type Description PerfView PerfView[]
| Element definition: ArrayOfThresholdInfo | [top] |
Name Type Description ThresholdInfo ThresholdInfo[]
| Element definition: ArrayOfThresholdInfo2 | [top] |
Name Type Description ThresholdInfo2 ThresholdInfo2[]
| Element definition: ArrayOfThresholdTemplate | [top] |
Name Type Description ThresholdTemplate ThresholdTemplate[]
| Element definition: ArrayOfThresholdTemplateInfo | [top] |
Name Type Description ThresholdTemplateInfo ThresholdTemplateInfo[]
| Element definition: HostNameOrId | [top] |
DFM Host. A Host can be a storage system, a vFiler Unit, a switch, a netcache or an agent. Value can be a DFM object Name (Maximum 255 characters), a fully qualified domain Name (FQDN)(Maximum 255 characters), the ip Address, or the DFM Id [1..2^31-1].
[none]
| Element definition: InstanceCounterInfo | [top] |
A specification for returning data for the given Instances and Counters.
Name Type Description CounterInfo ArrayOfPerfObjectCounter
List of performance Counters whose Values will be retrieved. InstanceName xsd:string
optional
For unmanaged Objects, this will be the Name of the Instance. When this input is specified, the ObjectNameOrId should have the Name or Id of the storage system. Maximum Length is 255 ObjectNameOrId ObjNameOrId
optional
If specified, all related Instances of the ObjectType mentioned in the PerfObjectCounter under this object are returned. For example, if ObjNameOrId is a Host and ObjectType in the PerfObjectCounter is Qtree, this would mean all Qtree under the Host. If the ObjNameOrId is Aggregate, all Qtrees under the Aggregate.
| Element definition: ObjNameOrId | [top] |
Name or internal ID of a DFM object. This typedef is an alias for the builtin ZAPI Type string. An ObjNameOrId must contain between 1 and 64 characters, and must conform To one of the following formats: Elements of Type ObjNameOrId are used only as inputs To ZAPIs. The Value must Match either the Name or internal ID of an existing DFM object. The ZAPI must specify the object's DFM object Type (e.g. Dataset, Host, DP Policy, etc.). Some ZAPIs allow the object To be one of several different types.
- It must have the format of an ObjName, or
- It must be the decimal numeric string form of a positive integer whose Value is in the range [1..2^31 - 1].
If the format of an ObjNameOrId input element does not conform, or the Value does not Match the Name or ID of an existing object, then generally the ZAPI documents that it fails with Error code EOBJECTNOTFOUND. A ZAPI may return more specific Error codes. In such cases, the ZAPI specification must document its behavior.
If a ZAPI can accept a null Value (e.g. reference To no object at all) for such an element, then the element is declared optional, and the absence of the input element represents a null Value.
[none]
| Element definition: PerfAssocObjType | [top] |
Name of the object Type. The possible Values are
- "resource_group"
- "data_set"
- "resource_pool"
- "Filer"
- "Vfiler"
- "Volume"
- "Qtree"
- "Lun"
- "Aggregate"
- "disk"
- "Interface"
- "processor"
- "Target"
[none]
| Element definition: PerfServerStatus | [top] |
Describes the Status of perf server.
Name Type Description DataCollectionStatus xsd:string
Specifies the Status of data collection. Possible Values are "enabled","disabled" and "disabling" ObjectUpdateStatus xsd:string
Specifies the Status of object updates. Possible Values are "enabled" and "disabled" ServerStatus xsd:string
Specifies the Status of Performance Advisor. Possible Values are "enabled" and "disabled". Status will be "enabled" only when both DataCollectionStatus and ObjectUpdateStatus are enabled.
| Element definition: StatId | [top] |
The Id, in the DFM database, of a collection of per-client statistics. Range: [ 1 .. 2^31 - 1 ]
[none]
| Element definition: ThresholdId | [top] |
A unique numeric identifier used To specify a threshold. This parameter is mandatory when modifying a threshold. This typedef is an alias for the builtin ZAPI Type integer. Range: [1..2^31-1]
[none]
| Element definition: ThresholdInfo | [top] |
Defines all the Attributes of a threshold.
Name Type Description IsEnabled xsd:boolean
optional
Specifies if the Threshold is enabled. Default Value is TRUE when setting or modifying a threshold. ObjectFullName ObjFullName
Fully qualified Name of the object. It is used as an output parameter while listing Thresholds. This parameter is unused for all other APIs. ObjectNameOrId ObjNameOrId
optional
The Name or Id of the object on which the threshold is To be created. Note that the API allows you To set only a single threshold at a time. So, container Objects like Resource Group, Dataset, Resource pool cannot be specified here. It is a mandatory parameter when setting a threshold. For the modify APIs, it is ignored if ThresholdId is also specified. While listing Thresholds, this parameter will always contain the ObjectId. The allowed object types for this argument are
- 'Host'
- 'Aggregate'
- 'Volume'
- 'Qtree'
- 'Lun'
PerfObjectCounter PerfObjectCounter
optional
Specifies a combination of an object and a counter. When setting a threshold the first time, it is a mandatory parameter. For the modify APIs, it is ignored if ThresholdId is also specified. ThresholdId ThresholdId
optional
ID of the threshold. Element is ignored while creating a threshold but is mandatory when modifying them. ThresholdInterval xsd:integer
optional
The amount of time in seconds for which an event generation is suppressed before deciding that a counter has crossed a specified threshold and an event needs To be generated. The same interval will also be used To generate a normal event. If a Value of zero is specified, any temporary spikes in counter Values above the threshold will generate an event, if the counter Values are sampled at that point of time. This parameter is mandatory when setting a threshold. Range: [0..2^31-1]
ThresholdType xsd:string
optional
The Type of threshold, can be upper or lower. In case of an Upper threshold Type, the counter Value must exceed the threshold Value for at least the specified amount of time for an event To be generated. In case of a Lower threshold Type, the counter Value must fall below the threshold Value for at least the specified amount of time for an event To be generated. Note that as the threshold types are mutually exclusive, so only one threshold Type may be specified. Default Value is 'upper' when setting or modifying a threshold. Possible Values:'upper', 'lower'
ThresholdUnit xsd:string
optional
Unit of the counter. This parameter is mandatory when setting or modifying a threshold. The Possible Values are: Possible Values: per_sec, b_per_sec (bytes/s), kb_per_sec (Kbytes/s), mb_per_sec (Mbytes/s), percent, millisec, microsec, sec, or none.
Note that the Metric used for a counter may vary depending upon the Data ONTAP Version.
ThresholdValue xsd:integer
optional
The threshold Value of a counter is used To generate an event if the observed counter Value breaches this Value. This parameter is mandatory when setting a threshold. Range: [1..2^64-1]
| Element definition: ThresholdInfo2 | [top] |
Defines a performance counter based threshold.
Name Type Description CounterThresholds ArrayOfCounterThresholdInfo
List of Thresholds on Counters. IsEnabled xsd:boolean
optional
If true, the threshold is enabled and Events will be generated if it is breached. Default Value is true. IsIndirect xsd:boolean
optional
Specifies whether the threshold applies on the object directly or through inheritance. For example, if the threshold is applied on a storage system, but applies on Qtree in it because of the constituent Counters, IsIndirect will be set To true. This Value is relevant only when the threshold details are returned; and is ignored when creating or modifying a threshold. It is, therefore, ignored in input. ObjectsInfo ArrayOfObjectInfo
optional
Contains the Id, the full Name and Type of the object on which the threshold is applied directly. ResourcePropertyConditions ArrayOfResourcePropertyCondition
optional
Specifies conditions on Properties of the Objects To which this threshold applies. TemplateId xsd:integer
optional
This returns the Id of the template To which this threshold belongs. Range: [1..2^32-1] TemplateName xsd:string
optional
Specifies the Name of the template To which this threshold belongs. ThresholdEventName xsd:string
Specifies the Name of the event that is raised when the threshold is breached. The default Name is derived From the counter. ThresholdId ThresholdId
optional
The ID, in the DFM database, of the threshold. This element should not be specified when creating a threshold, but is always returned when querying. ThresholdInterval xsd:integer
The amount of time in seconds for which an event generation is suppressed before deciding that a counter has crossed a specified threshold and an event needs To be generated. The same interval will also be used To generate a normal event. If a Value of zero is specified, any temporary spikes in counter Values above the threshold will generate an event, if the counter Values are sampled at that point of time. This parameter is mandatory when setting a threshold. Range: [0..2^31-1]
| Element definition: TimeFilter | [top] |
Filter data based on selected time range.
Name Type Description Days ArrayOfDay
optional
Days of week. Default: no Day filter Months ArrayOfMonth
optional
Months of year. Default: no Month filter TimeRanges ArrayOfTimeRange
optional
Range in minutes of Day. Default: no TimeRange filter
| Element definition: Timestamp | [top] |
Seconds since 1/1/1970 in UTC. Range: [0..2^31-1].
[none]
| Element definition: ViewType | [top] |
Type of the View. Possible Values are:
- custom_view - User defined View containing Counters of specific Instances. Creates a custom counter Group To hold the performance data.
- canned_view - Default Views.
- summary_view - Default Views.
- custom_view_instances - User defined View containing Counters of specific Instances. Doesn't create custom counter Group during View creation but uses data From default counter Group.
- custom_view_object_type - User defined View that is attached To a specific associated object Type. Exactly one AssocObjType element needs To be specified while creating this View. Counters for specific Instances cannot be present in the View. Only Counters related To the associated object Type can be added To it. Doesn't create custom counter Group during View creation but uses data From default counter Group.
[none]
| Element definition: WrapperOfPerfCounterGroup | [top] |
Name Type Description PerfCounterGroup PerfCounterGroup
| Element definition: WrapperOfPerfCounterInstance | [top] |
Name Type Description PerfCounterInstance PerfCounterInstance
| Element definition: WrapperOfPerfDataGroup | [top] |
Name Type Description PerfDataGroup PerfDataGroup
| Element definition: WrapperOfPerfDynamicDataSources | [top] |
Name Type Description PerfDynamicDataSources PerfDynamicDataSources
| Element definition: WrapperOfPerfView | [top] |
Name Type Description PerfView PerfView
| Element definition: WrapperOfThresholdInfo | [top] |
Name Type Description ThresholdInfo ThresholdInfo
| Element definition: ArrayOfCounterThresholdInfo | [top] |
Name Type Description CounterThresholdInfo CounterThresholdInfo[]
| Element definition: ArrayOfDay | [top] |
Name Type Description Day Day[]
| Element definition: ArrayOfMonth | [top] |
Name Type Description Month Month[]
| Element definition: ArrayOfResourcePropertyCondition | [top] |
Name Type Description ResourcePropertyCondition ResourcePropertyCondition[]
| Element definition: ArrayOfTimeRange | [top] |
Name Type Description TimeRange TimeRange[]
| Element definition: ClientStatError | [top] |
Describes an Error encountered while collecting per-client statistics on the storage system or Vfiler.
Name Type Description CifsError xsd:string
optional
Error encountered while collecting CIFS per-client statistics NfsError xsd:string
optional
Error encountered while collecting NFS per-client statistics ObjectName ObjName
The Name of the vFiler Unit or storage system for which this Error was encountered.
| Element definition: DestinationHostInfo | [top] |
Name Type Description ErrorReason xsd:string
optional
If the copy Operation failed, this element will have the Reason for the failure. This element will not be present when the copy Operation was sucessful. HostId ObjId
Identifier of the destination storage system. HostName ObjFullName
Name of the destination storage system.
| Element definition: DynamicData | [top] |
Contains data for top-N Objects
Name Type Description Hostname ObjName
optional
Name of the Host. Will not be set when the Objects are selected within a Host InstanceName WrapperOfPerfInstance
optional
Name of the perf Instance. Will not be set for single Instance Objects like system, nfsv3 ObjId ObjId
optional
Identifier of the object. Will not be set for unmanaged Objects Value xsd:string
Value for the object Max Length is 32
| Element definition: HostClientStats | [top] |
Contains the per-client operations on a Host.
Name Type Description CollectionPeriod xsd:integer
The Duration, in seconds, for which the collection of per-client statistics was enabled. Range: [ 15 .. 60 ] ObjectId ObjId
The Id, in the DFM database, of the storage system for which these client statistics have been collected. ObjectName ObjName
The Name of the storage system for which the per-client statistics were collected. StartTime Timestamp
The time at which the collection of per-client statistics was enabled, in seconds From Epoch time. StatId StatId
The Id, in the DFM datbase, of this collection of statistics. Stats ArrayOfClientStats
Contains the operations performed by the top 20 clients operating on the Host. If 20 clients are not available, the operations for the Maximum available clients will be present.
| Element definition: InvalidCounterInstance | [top] |
A performance counter, an object Instance pair.
Name Type Description CounterInfo WrapperOfPerfObjectCounter
Specification of the performance counter. ErrCode xsd:string
The string To specify the Reason why this counter Instance pair is invalid. Possible Values are: "invalid_instance": The Instance provided is invalid. "invalid_object_type": The object Type provided is invalid. "no_instances_available": No Instances found for the provided counter. "invalid_counter": The counter specified is not valid. "counter_unavailable": The counter specified is unavailable for this storage system. "incompatible_counter_instance": The counter and Instance are incompatible (For example: data requested for a network Interface counter but an Aggregate is provided as Instance). ErrReason xsd:string
The Reason why this Instance pair is invalid. HostId ObjId
optional
Name of the storage system To which the Instance belongs To. InstanceName xsd:string
optional
Name of the Instance.
| Element definition: ObjFullName | [top] |
Full Name of a DFM object. This typedef is an alias for the builtin ZAPI Type string. An object full Name conforms To all the rules of an ObjName, except that the full Name may be up To 255 characters long. DFM creates full names by concatenating an object Name with any parent object names, so as To create a unique Name for an object. The format of full names is as follows:
- Host full names are the either the fully-qualified domain Name or the IP Address of the Host.
- Aggregate full names are the Host Name and the Aggregate Name, separated by a colon, e.g. Hostname:aggr0.
- Volume full names are the Host Name and the Volume Name, separated by ":/", e.g. Hostname:/volume. Note this does not include "/vol". Volume and Aggregate full names are distinguished by the presence of a forward slash after the colon.
- Qtree full names are the containing Volume full Name and the Qtree Name, separated by a slash, e.g. Hostname:/volume/qtree. The data not contained by any Qtree may be represented by "-", e.g. Hostname:/volume/-.
- Lun Path full names are either a Volume or Qtree full Name and the LUN Path, separated by a slash, e.g. Hostname:/volume/LUN or Hostname:/volume/qtree/LUN.
- Network full names are a network Address block in CIDR format, e.g. 1.2.3.0/8.
- OSSV Directory full names are the OSSV Host Name and the OSSV Path, separated by a colon, e.g. host-lnx:/usr/local or host-w2k:c:/temp
- Include any others here...
- Initiator Group full names are Host Name and the initiator Group Name, separated by a colon, e.g. Hostname:igroup.
For any DFM object not listed above, the ObjName and ObjFullName are identical.
[none]
| Element definition: ObjectInfo | [top] |
Associated object's information
Name Type Description ObjectFullName ObjFullName
optional
The full Name of the object that is associated with the View ObjectId ObjId
The object that is associated with the View ObjectName ObjName
optional
ObjectName is the Name of the DFM object ObjectType xsd:string
optional
Type of the DFM object. The possible Values are
- "resource_group"
- "data_set"
- "resource_pool"
- "Filer"
- "Vfiler"
- "Volume"
- "Qtree"
- "Lun"
- "Aggregate"
- "Interface"
| Element definition: PerfCounter | [top] |
Describes a performance counter (a measurable quantity on a performance object). This might be, for example, the number of writes per second on a specific Volume.
Name Type Description BaseCounter xsd:string
optional
Name of the counter used as the denominator To calculate Values of Counters involving percentages. For additional details, please refer To the ONTAP API PerfObjectCounterListInfo Desc xsd:string
Description of the counter IsDisplay xsd:boolean
optional
If TRUE, this counter can be displayed To the user. If FALSE, this counter is a base counter used as the denominator To calculate Values of Counters involving percentages. The base Counters should not be displayed To the user. Default Value is TRUE. Labels ArrayOfPerfLabel
optional
A list of Labels for this counter. For additional details, please refer To the ONTAP API PerfObjectCounterListInfo Name xsd:string
Name of the counter PrivilegeLevel xsd:string
optional
The counter Privilege level, can be "basic", "advanced" or "diag". Any counter with a Privilege level of "diag" is not guaranteed To work, To exist in future releases, or To remain unchanged. Properties xsd:string
optional
Properties of the counter. For additional details, please refer To the ONTAP API PerfObjectCounterListInfo Type xsd:string
optional
Type of the counter. For additional details, please refer To the ONTAP API PerfObjectCounterListInfo Unit xsd:string
optional
Unit of the counter. For additional details, please refer To the ONTAP API PerfObjectCounterListInfo
| Element definition: PerfCounterGroup | [top] |
A counter Group. A counter Group is a collection of measurable data sources coupled with an associated sampling rate and sample History.
Name Type Description ApplianceNameOrId xsd:string
optional
The Name (or unique ID) of the Source storage system. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in the appliance-info structure From the appliance-list-iter-next. The API will accept a Vfiler Name or Id From DFM 3.3 onwards. CounterGroupName xsd:string
Name of the counter Group. CounterInfo ArrayOfPerfObjectCounter
optional
Counters retrieved. DataSources ArrayOfPerfDataSource
optional
Identifiers for the data sources To be retrieved in later queries. The DataSources can not contain 'Group' data Source. i.e. InstanceName must be specified for each PerfDataSource. The DataSources should not contain a data Source that specifies LabelNames field. This is because counter Group always collects data for the whole counter i.e. for all Labels. DataSourcesToBeDisabled ArrayOfPerfDataSource
optional
The data sources To be disabled. Presently this parameter is valid for the default cgs. If 'DataSources' field contains a valid data sources To be enabled on this counter Group, this field should not be specified. EndTime xsd:integer
optional
Present in output only. Indicates the Timestamp of the last available data sample. The Timestamp Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC. GroupNameOrId xsd:string
optional
The Name (or unique ID) of the Source Group. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in GroupListIterNext APIs. This field is ignored if ApplianceNameOrId is specified. This field defaults To global Group if ApplianceNameOrId is not specified. IsDefault xsd:boolean
optional
Indicates whether the counter Group is a "default" counter Group. Defaults To false. IsDisableAll xsd:boolean
optional
Indicates whether To disable all the Counters in the counter Group. Default is false. IsStopped xsd:boolean
optional
Present in output only. Indicates whether data collection has been stopped for the counter Group using PerfCounterGroupStop API. When this field is false, it indicates server's intention To collect data for the counter Group. But many other factors can affect whether data is actually collected or not. NumberRecords xsd:integer
optional
Present in output only. Indicates the number of Records currently collected for the counter Group and storage system. This information is sent in the output only if the Host information is not consolidated PerfFileName xsd:string
optional
Present in output only. This indicates the Name of the file that contains the performance information for the counter Group and storage system. This information is sent in the output only if the Host information is not consolidated RealTime xsd:boolean
optional
Designates whether the counter Group is RealTime, in other words, if no user is getting data From the Group, then the counter Group will no longer get data. By default FALSE. SampleBuffer xsd:integer
optional
Length of sample buffer To retain, in seconds. If unspecified on input, the Value will be chosen by the server. SampleRate xsd:integer
optional
Length of interval between samples, in seconds. Defaults To one minute. SpaceConsumed xsd:unsignedLong
optional
Present in output only. Indicates the amount of server storage currently consumed by the counter Group data, in bytes.Range: [0..2^64-1]. SpaceProjected xsd:unsignedLong
optional
Present in output only. Indicates the Maximum amount of server storage required by the counter Group data, in bytes. Range: [0..2^64-1]. StartTime xsd:integer
optional
Present in output only. Indicates the Timestamp of the first available data sample. The Timestamp Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC.
| Element definition: PerfCounterInstance | [top] |
Defines a perf counter for a specific Instance.
Name Type Description CounterInfo WrapperOfPerfObjectCounter
The counter for which data is To be retrieved InstanceName xsd:string
optional
For unmanaged object, this will be the Name of the Instance. In this case, ObjectNameOrId will be the Id for the storage system Maximum Length is 255 ObjectNameOrId ObjNameOrId
The object for which data is To be retrieved or the Id of the parent storage system, if InstanceName is specified
| Element definition: PerfDataGroup | [top] |
Definition of a set of data sources and a consolidation method.
Name Type Description DataGroupMethod xsd:string
optional
A function To apply across the data sources. Valid Values are average (average of all sources), Total (sum of all sources). The default is Total (which for one data Source is just the Value of the single data Source). DataSources ArrayOfPerfDataSource
Identifiers for the data sources To be retrieved in later queries. The DataSources should be either one 'Group' data Source, or many (one or more) of 'Instance' data sources. If DataSources contains a data Source that has an array counter, specify LabelNames field of PerfDataSource To select a single element of the array.
| Element definition: PerfDataSource | [top] |
An unique identifier for a Source of data. When optional InstanceName field is not specified, PerfDataSource represents all relevant Instances in a storage system or in a Group.
Name Type Description ApplianceNameOrId xsd:string
optional
The Name (or unique ID) of the Source storage system. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in the appliance-info structure From the appliance-list-iter-next. The API will accept a Vfiler Name or Id From DFM 3.3 onwards. CounterName xsd:string
The Name of the counter measured. Counters are specifc measurable quantities on an Instance of a performance object, for example the number of write operations on a Volume. GroupNameOrId xsd:string
optional
The Name (or unique ID) of the Source Group. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in GroupListIterNext APIs. This field is ignored if ApplianceNameOrId is specified. This field defaults To global Group if ApplianceNameOrId is not specified. InstanceName xsd:string
optional
The Name of the specific object referenced (vol2, disk2, ...). If this field is specified, ApplianceNameOrId must also be specified. If this field is not specified, it is considered as a wildcard that implies combining data for all Instances of a storage system or a Group. LabelNames xsd:string
optional
An optional list of comma-separated label names. These represent an index into the array of Values when a counter has more than one Value (as implicitly indicated by the number of Labels). The Values should be the Name of the label (for example 'getattr' for the 'nfs_v3_ops' counter). In some cases, the array of Labels is multi-dimensional, in which case there should be one label Name From each row in the array of Labels. Each entry should be comma-separated. If unspecified, the default Value is blank. In that case, its interpretation depends on the context. ObjectFullName ObjFullName
optional
The object Id for the specific object referenced ObjectName xsd:string
The Name of the referenced object. Object names are broad classes of system components and protocols, like NFS, VOLUME, DISK, ... ObjectNameOrId ObjNameOrId
optional
The object Id for the specific object referenced. For dynamic data sources, this will specify the container From which Objects will be selected ObjectType xsd:string
optional
Type of the DFM object. The possible Values are
- "Filer"
- "Vfiler"
- "Volume"
- "Qtree"
- "Lun"
- "Aggregate"
| Element definition: PerfDependentCounterInfo | [top] |
Describes a performance counter and its dependent Counters list, for example system:load_inbound_mbps is dependent on system:net_data_recv, fcp:fcp_write_data, iscsi:iscsi_write_data Counters.
Name Type Description CounterName xsd:string
Name of the counter. ObjectCounters ArrayOfPerfObjectCounter
optional
List of dependents for this counter.
| Element definition: PerfDiagCategory | [top] |
Diagnosis Category.
Name Type Description CategoryName xsd:string
Name of the category CategoryStatus ObjStatus
Violation Status of the category The possible Status for a Diagnosis Category are "information" (If none of its health checks are violated), "warning" (If it contains only performance tips) and "Error" (If atleast one of its health checks are violated). Details of 'Performance tips' shall not be included in the category output if it is not violated. HealthChecks ArrayOfPerfHealthCheck
List of Performance Health Checks and performance improvement tips.
| Element definition: PerfDynamicDataSources | [top] |
A specification for selecting top-n Instances for a single counter. Data for each Instance is drawn on the chart as one line. e.g. top 5 busy storage systems in a Group.
Name Type Description Color xsd:string
optional
Color of the line. The Values and their interpretation are determined by the client. Recommended usage includes common names like "black" or "blue", as well RGB hex specification like "AAFF00". DataSource WrapperOfPerfDataSource
optional
Describes the Properties of Instances that should be considered for top-n Query. The DataSource must be 'Group' data Source i.e. InstanceName field must be empty. If DataSource has an array counter, specify LabelNames field To select a single element of the array. MaximumInstances xsd:integer
optional
Maximum number of Instances To pick. Default is 5. SelectAllInstances xsd:boolean
optional
If true, this will pick all the Instances being considered. If MaximumInstances element is present and SelectAllInstances is true, then SelectAllInstances will be considered over MaximumInstances. By default this is false. SortOrder xsd:string
optional
The sort order when comparing data From different Instances. After sorting data in this order, top MaximumInstances are picked. Valid Values are "ascending" and "descending". Default is "descending". TimeInterval xsd:integer
optional
When considering the historical data samples, how far back in time (in seconds) we should go. Default is 300.
| Element definition: PerfInstance | [top] |
Describes an Instance. An Instance is a manifestation of a performance object. For example, the performance object might be "VOLUME" whereas the Instance might be "vol0".
Name Type Description InstanceName xsd:string
Name of the Instance.
| Element definition: PerfInstanceCounterData | [top] |
Array of counter Values of an Instance.
Name Type Description Counters ArrayOfPerfCounterData
List of counter Values for this Instance. InstanceName xsd:string
optional
Name of the Instance To get counter Values for. ObjectId ObjId
Identifier of the object
| Element definition: PerfMissingHostObjectCounter | [top] |
Counters not available with a particular Host.
Name Type Description HostNameOrId HostNameOrId
DFM Host Name. MissingObjectCounters ArrayOfPerfObjectCounter
List of unavailable Counters.
| Element definition: PerfObject | [top] |
A performance object. A performance object is a (somewhat abstract) representation of a class of measurable items. These are roughly akin To system subcomponents or protocols, for example "VOLUME", "DISK" or "NFS". These are broad classes and do not represent specific Instances.
Name Type Description AssocObjType PerfAssocObjType
Name of the DFM object To which the performance object is associated. Performance Objects that have single Instances such as "system", "cifs", "nfsv3", etc are associated with DFM object "Filer". Other performance Objects are associated with respective DFM object types. ObjectName xsd:string
Name of the performance object.
| Element definition: PerfObjectCounter | [top] |
Performance Counters can be a combination of an object and a counter.
Name Type Description CounterDescription xsd:string
optional
Description of the counter on which the threshold has been set. CounterName xsd:string
The Name of the counter measured. Counters are specifc measurable quantities on an Instance of a performance object like avg_latency, nfs_ops. Maximum Length of 255 characters.
IsCalculatedStats xsd:boolean
optional
This field says whether the counter is a calculated stat counter or not. LabelNames xsd:string
optional
An optional list of comma-separated label names. These represent an index into the array of Values when a counter has more than one Value (as implicitly indicated by the number of Labels). The Values should be the Name of the label (for example 'getattr' for the 'nfs_v3_ops' counter). In some cases, the array of Labels is multi-dimensional, in which case there should be one label Name From each row in the array of Labels. Each entry should be comma-separated. If unspecified, the default Value is blank. In that case, its interpretation depends on the context. Maximum Length of 255 characters Metrics ArrayOfMetric
optional
Container of Metric requested. Only PerfGetCounterData uses this field, for all other ZAPIs this field is ignored. ObjectType xsd:string
ObjectType is the Name of the object classification as defined by ONTAP counter manager. Maximum Length of 255 characters.
PerfLabels ArrayOfPerfLabel
optional
A list of Labels for this counter. For additional details, please refer To the ONTAP API PerfObjectCounterListInfo TimeConsolidationMethod xsd:string
optional
This element will be used by PerfGetCounterData ZAPI only. A function To apply across the data for this counter To achieve the desired time resolution, if the requested SampleRate is different From the actual SampleRate of the data. Possible Values : 'average' 'min' 'max' 'last' Default is 'last'
| Element definition: PerfObjectCounterInfo | [top] |
Performance Counters can be a combination of an object and a counter.
Name Type Description ObjectNameOrId ObjNameOrId
ObjectName or ObjectId for which counter information is being collected. PerfObjectCounter PerfObjectCounter
Attributes of the counter being collected.
| Element definition: PerfPurgedHostObjectCounter | [top] |
Lists the effected Counters deatils for a particular Host.
Name Type Description HostNameOrId HostNameOrId
DFM Host Name. PurgedObjectCountersDetails ArrayOfPerfPurgedObjectCountersDetails
Lists the effected Counters details.
| Element definition: PerfReport | [top] |
The Description of a performance report.
Name Type Description ReportName xsd:string
Name of the report.
| Element definition: PerfStatusError | [top] |
Possible resons for data unavailability.
Name Type Description Error xsd:string
The following are the possible reasons: 1) "perf-advisor-not-enabled" This indicates that the performance advisor is not enabled on DFM. 2) "host-bad-credentials" This indicates that the authetication credentials for the Host are incorrect. 3) "host-no-credentials" This indicated that the Host login is empty. 4) "host-not-reachable" This indicates that the Host is down and hence not reachable. 5) "host-transport-incorrect" This indicates that the Host transport is in compatible with the performance advisor transport. 6) "filer-os-version-less-than-6.5" This indicates that the storage system is running OS with a release Version less than 6.5. 7) "filer-data-unavailable" This indicates that DFM has not discovered Instances of performance Objects on the storage system yet.
| Element definition: PerfThreshold | [top] |
The Description of a performance threshold.
Name Type Description PerfThresholdName xsd:string
Name of the threshold event.
| Element definition: PerfView | [top] |
A performance View.
Name Type Description ApplianceNameOrId xsd:string
optional
Name (or unique ID) of the storage system. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in the appliance-info structure From the appliance-list-iter-next API. The API will accept a Vfiler Name or Id From DFM 3.3 onwards. AreEventsShown xsd:boolean
optional
Indicates whether an event block should be shown as part of the View. Defaults To false. AssocObjType ArrayOfPerfAssocObjType
optional
Indicates all the ObjectType that the View provides information for. Could be more than one for custom Views Charts ArrayOfPerfChart
optional
The Charts (Graphs) appearing in this View. CounterGroupName xsd:string
optional
Name of the referenced counter Group. GroupNameOrId xsd:string
optional
The Group that this View is associated with. If a unique ID is supplied, it should originate From an API such as the 'Id' field returned in GroupListIterNext APIs. IsDefault xsd:boolean
optional
Indicates whether the View is a "default" performance View. Defaults To false. IsStopped xsd:boolean
optional
Indicates whether data collection is stopped for the View. Defaults To false. SampleBuffer xsd:integer
optional
Length of sample buffer To retain, in seconds. If unspecified on input, the Value will be chosen by the server. SampleRate xsd:integer
optional
Length of interval between samples, in seconds. Defaults To one minute. ViewName xsd:string
Name of the View. ViewType ViewType
optional
Indicates the Type of View. If unspecified during View creation, it defaults To "custom_view".
| Element definition: ThresholdTemplate | [top] |
The Description of a threshold template.
Name Type Description TemplateName xsd:string
Name of the template.
| Element definition: ThresholdTemplateInfo | [top] |
Contains info on performance threshold templates
Name Type Description AppliedObjects ArrayOfObjectInfo
Name of the template. IsEnabled xsd:boolean
optional
This specifies if the template is enabled or not. MemberThresholds ArrayOfThresholdInfo2
optional
Specifies the Thresholds that are To be part of this template. TemplateDescription xsd:string
optional
Description of the template. TemplateId xsd:integer
This returns the Id of the template that is created Range: [1..2^32-1] TemplateName xsd:string
optional
Name of the template.
| Element definition: ArrayOfClientStats | [top] |
Name Type Description ClientStats ClientStats[]
| Element definition: ArrayOfMetric | [top] |
Name Type Description Metric Metric[]
| Element definition: ArrayOfPerfAssocObjType | [top] |
Name Type Description PerfAssocObjType PerfAssocObjType[]
| Element definition: ArrayOfPerfChart | [top] |
Name Type Description PerfChart PerfChart[]
| Element definition: ArrayOfPerfCounterData | [top] |
Name Type Description PerfCounterData PerfCounterData[]
| Element definition: ArrayOfPerfHealthCheck | [top] |
Name Type Description PerfHealthCheck PerfHealthCheck[]
| Element definition: ArrayOfPerfLabel | [top] |
Name Type Description PerfLabel PerfLabel[]
| Element definition: ArrayOfPerfPurgedObjectCountersDetails | [top] |
Name Type Description PerfPurgedObjectCountersDetails PerfPurgedObjectCountersDetails[]
| Element definition: CounterThresholdInfo | [top] |
Specifies all the Attributes of a threshold on a single counter.
Name Type Description PerfObjectCounter PerfObjectCounter
Specifies a combination of an object and a counter, e.g. system:cpu_busy. ThresholdType xsd:string
optional
Specifies whether an event is To be generated when the Value of the counter is above ('upper') or below ('lower') the ThresholdValue. Possible Values are 'upper' and 'lower'. Default is 'upper' ThresholdUnit CounterUnit
Unit of the counter. The Metric used for a counter may vary depending on the ONTAP Version. ThresholdValue xsd:unsignedLong
The threshold Value To trigger an event. Range: [0..2^64-1].
| Element definition: Day | [top] |
Day of week. Possible Values : 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday' or 'sunday'
[none]
| Element definition: Month | [top] |
Month of year. Possible Values : 'january', 'february', 'march', 'april', 'may', 'june', 'july', 'august', 'september', 'october', 'november' or 'december'
[none]
| Element definition: ObjId | [top] |
Identification number (ID) for a DFM object. This typedef is an alias for the builtin ZAPI Type integer. Object IDs are unsigned integers in the range [1..2^31 - 1]. In some contexts, an object ID is also allowed To be 0, which is interpreted as a null Value, e.g., a reference To no object at all. The ID for a DFM object is always assigned by the system; the user is never allowed To assign an ID To an object. Therefore, an input element of Type ObjId is always used To refer To an existing object by its ID. The ZAPI must specify the object's DFM object Type (e.g. Dataset, Host, DP Policy, etc.). Some ZAPIs allow the object To be one of several different types.
If the Value of an ObjId input element does not Match the ID of any existing DFM object of the specified Type or types, then typically the ZAPI fails with Error code EOBJECTNOTFOUND. A ZAPI may deviate From this general rule, for example, it may return a more specific Error code. In either case, the ZAPI specification must document its behavior.
[none]
| Element definition: ObjName | [top] |
Name of a DFM object. This typedef is an alias for the built in ZAPI Type string. An object Name must conform To the following format: The behavior of a ZAPI when it encounters an Error involving an ObjName input element depends on how the ZAPI uses the input element. Here are the general rules:
- It must contain between 1 and 64 characters.
- It may start with any character and may contain any combination of characters, except that it may not consist solely of decimal digits ('0' through '9').
- In some contexts, a Name may be the empty string (""), which is interpreted as a null Value, e.g., a reference To no object at all.
A ZAPI may deviate From these general rules, for example, it may return more specific Error codes. In such cases, the ZAPI specification must document its behavior.
- If the input Name element is used To create a new object with the given Name, or rename an existing object To that Name, and the Name does not conform To the above format, then the ZAPI fails with Error code EINVALIDINPUTERROR. Note that because EINVALIDINPUTERROR is such a common Error code, ZAPI specifications are not required To document cases when they may return it.
- If the input Name element is used To refer To an existing object with that Name, and there is no object with that Name, then the ZAPI fails with Error code EOBJECTNOTFOUND. Generally the ZAPI specification documents cases when it may return this Error code.
If an input Name element is used To refer To an existing object, then the ZAPI specification must specify which DFM object Type (e.g. data set, Host, DP Policy, etc.) is allowed. Some ZAPIs allow the object To be one of several different types. See the Description of ObjFullName for examples of valid input formats.
Note that there is no requirement that all object names must be unique. However, the names for some specific types of Objects are constrained such that no two Objects of that Type may have the same Name. For example, this constraint applies To Datasets, DP schedules, and DP policies. This means that no two Datasets may have the same Name, but a Dataset may have the same Name as a DP schedule or DP Policy.
In general, object names are compared in a case-insensitive manner. This means that, for example, "MyObject" and "MYOBJECT" are considered To be the same Name for purposes of: creating new Objects, renaming existing Objects, or looking up an object by Name. On the other hand, ZAPIs that return an ObjName generally do not change the capitalization at all. For example, if an object's Name has been set To "MyObject", then list iteration ZAPIs that return the object's Name return it as "MyObject" rather than "MYOBJECT" or "myobject".
ZAPIs that operate on ObjName Values and do not follow these general rules about case sensitivity must document the rules that they do follow.
One important exception To these general rules is that Volumes, Qtrees, OSSV Directories, SRM Paths, Interfaces, FCP Targets and FC switch ports all have case-sensitive names. When looking up Objects of these types by Name, the case must Match the object Name.
[none]
| Element definition: ObjStatus | [top] |
A Status Value which can be associated with a DFM object. This typedef is an alias for the builtin ZAPI Type string. The Severity associated with an event has this Type. Possible Values are: 'unknown', 'normal', 'information', 'unmanaged' 'warning', 'Error', 'critical', 'emergency'.
In some contexts, it is important that severities are ordered (as above). For example, an alarm might be triggered if an event with a given Severity "or worse" occurs. In this example, worse means "after" in the list above.
- unknown: An object has an unknown Status when it transitions From one state To another. Ideally, an object will have this Status briefly. For example, when an object has been added, but not yet discovered.
- normal: An object has normal Status when it is working within the Thresholds specified in DFM.
- information: The information Events are normal occurrences on an object for which you can define alarms.
- unmanaged: An object is considered To be unmanaged when the login and Password are not set for the storage system or agent.
- warning: An object has the warning Status when an event related To the object occurred that an administrator should know about. The event will not cause Service disruption.
- Error: An object has Error Status when it does not cause any Service disruption, but it may affect performance.
- critical: An object has critical Status when it is still performing, but Service disruption may occur if corrective Action is not taken immediately.
- emergency: An object is in emergency Status when it stops performing unexpectedly and could lose data.
[none]
| Element definition: ResourcePropertyCondition | [top] |
Specifies conditions on Resource Properties. In case of Values for the same property, the conditions are assumed To be either-or conditions. For example, if the conditions "Disk RPM=7200" and "Disk RPM=10000" are specified, the threshold applies To all Disks with Speed 7200 RPM or 10000 RPM. In case of conditions on different Properties, the conditions are assumed To be "and" conditions. For example, if the conditions Name = "Disk RPM", Value = "10000" and name="Filer Model", value="FAS270" are specified, the threshold applies To all Disks with Speed 10000 RPM on FAS270 storage systems. During template modification, if no Resource Properties are specified, existing Resource Properties, if any, will be cleared.
Name Type Description Name xsd:string
The Name of the Resource property. Value xsd:string
The Value that this Resource property should have.
| Element definition: TimeRange | [top] |
Holds the 'From' and 'To' range as minutes in a Day. Ex: 9.25AM To 4.45PM will become from=565 and to=1005
Name Type Description From xsd:integer
Start time in minute of Day. Ex: 9.25AM corresponds To (9*60)+25 => 565 Range: [0..1439] To xsd:integer
End time in minute of Day. Ex: 4.45PM corresponds To (16*60)+45 => 1005 Range: [0..1439]
| Element definition: WrapperOfPerfDataSource | [top] |
Name Type Description PerfDataSource PerfDataSource
| Element definition: WrapperOfPerfInstance | [top] |
Name Type Description PerfInstance PerfInstance
| Element definition: WrapperOfPerfObjectCounter | [top] |
Name Type Description PerfObjectCounter PerfObjectCounter
| Element definition: ClientStats | [top] |
Contains the per-protocol operations performed by a client on a storage system.
Name Type Description CifsOpStats CifsOpStats
optional
The number of CIFS operations performed by the client. ClientNameOrIp xsd:string
The Name or IP Address of the client. NfsOpStats NfsOpStats
optional
The number of NFS operations performed by the client.
| Element definition: CounterUnit | [top] |
A Unit in which a counter is measured. Possible Values are per_sec, b_per_sec (bytes/s), kb_per_sec (kb/s), mb_per_sec (mb/s), percent, millisec (milliseconds), microsec (microseconds), sec (seconds) and none.
[none]
| Element definition: Metric | [top] |
Contains the computation performed and the Value
Name Type Description Id xsd:string
Unique identifier To be set by the user To map the requested Metrics To its Value when multiple Type of Metrics are requested for the same counter. This field is not processed and returned as it is in the output. Length not more than 16 characters. MetricResult xsd:string
optional
The computed Value. The format multiple comma separated Timestamp:Value. This is an output-only field. Period xsd:integer
optional
Computation window in seconds. Valid only when Slide field is specified as "step", "rolling" or "cumulative". One Metric Value is calculated for each window of Size Period. Range: [1..2^31-1] Slide xsd:string
optional
Defines the method To Slide the compute window specified by Period field. Possible Values: "simple": No Slide. Compute a single Metric for the entire time range. "rolling": Slide the window by one sample at a time. Period field has To be specified. "step": Slide the window Value equal To Period. Period field has To be specified. "cumulative": The window keeps growing by the Value equal To Period
Default Value: "simple"Type xsd:string
The computation Type Possible Values: "mean": Mean of the data for the specified time Period. "min": Minimum Value "max": Maximum Value "value_at_percentile": nth percentile of the samples, where n is specified in the Value field. Value xsd:string
optional
Valid only when the Type field is set To "value_at_percentile" Requested percentile Value. This field accepts only positive real numbers as inputs. Range : (0..100]
| Element definition: PerfChart | [top] |
Information about a chart. A chart is a display (graph) with one or more data sources (Lines).
Name Type Description ChartName xsd:string
Name of the chart. This is intended To be a user-visible label like "CPU Graph". It should be unique To the performance View. DynamicDataSources WrapperOfPerfDynamicDataSources
optional
Lines representing dynamic Members. Data for each data Source is drawn as one line in the chart. Lines ArrayOfPerfLine
optional
Line definitions. MaximumY xsd:integer
optional
An optional Maximum Value for the y axis. The units are arbitrary and determined by the client. This may be used To help guide the chart construction in the client. Type xsd:string
optional
Type of the chart. Arbitrary string meaningful To the client only.
| Element definition: PerfCounterData | [top] |
Value of the performance counter.
Name Type Description CounterData xsd:string
A single Array of retrieved Values counter data. The format is a series of comma-separated Timestamp:Value pairs. The Timestamp Value is the time in seconds since 00:00:00 Jan 1, 1970, UTC. The Values may have optional decimal extensions. CounterName xsd:string
Name of the counter. LabelNames xsd:string
A list of comma-separated label names To completely qualify the counter. This element will be empty for Counters without Labels. Metrics ArrayOfMetric
optional
Container of computed Metric Values. Returned only in the PerfGetCounterData ZAPI when Metrics Value is requested. ObjectType xsd:string
ObjectType is the Name of the object classification as defined by ONTAP counter manager. Maximum Length of 255 characters. Unit xsd:string
optional
Unit of CounterData. This element will not be present if the Unit is not known. Some possible Values are per_sec, percent, b_per_sec, kb_per_sec, msecs, usecs. Maximum Length: 32 characters.
| Element definition: PerfHealthCheck | [top] |
A check which if violated could affect the performance of the given object.
Name Type Description HealthCheckName xsd:string
Name of the health check HealthCheckStatus ObjStatus
Violation Status of the health check. Possible Values are "Error", "warning" (in case of performance tip), "information". Observation xsd:string
Observations found for the health check. Recommendation xsd:string
Recommendation To avoid the issue. This will be "N/A" if the health-check Status is "information".
| Element definition: PerfLabel | [top] |
When a counter has more than one Value (an array), the Labels describe the indvidual array entries, and define an implicit indexing scheme into the array. The array may be multi-dimensional, in which case each occurrence of a PerfLabel represents a dimension in the array of Labels.
Name Type Description LabelNames xsd:string
A comma-separated list of Labels, representing a row in the array of Labels.
| Element definition: PerfPurgedObjectCountersDetails | [top] |
Lists the effected Counters for each object along with Retention Period details.
Name Type Description CurrentRetentionPeriod xsd:integer
Existing Retention Period in seconds. NewRetentionPeriod xsd:integer
New Retention Period in seconds after applying copy configuration Operation. PurgedObjectCounters ArrayOfPerfObjectCounter
List of effected Counters for which historical data will be purged.
| Element definition: ArrayOfPerfLine | [top] |
Name Type Description PerfLine PerfLine[]
| Element definition: CifsOpStats | [top] |
Contains the CIFS operations performed by the client on the storage system.
Name Type Description OtherOperations xsd:integer
Specifies operations that do not fall into either read or write Categories. Range: [ 0 .. 2^31 - 1 ] ReadOperations xsd:integer
The number of read operations performed by the client on the storage system. Range: [ 0 .. 2^31 - 1 ] WriteOperations xsd:integer
The number of write operations performed by the client on the storage system. Range: [ 0 .. 2^31 - 1 ]
| Element definition: NfsOpStats | [top] |
Contains the NFS operations performed by the client on the storage system.
Name Type Description OtherOperations xsd:integer
Specifies operations that do not fall into either read or write Categories. Range: [ 0 .. 2^31 - 1 ] ReadOperations xsd:integer
The number of read operations performed by the client on the storage system. Range: [ 0 .. 2^31 - 1 ] WriteOperations xsd:integer
The number of write operations performed by the client on the storage system. Range: [ 0 .. 2^31 - 1 ]
| Element definition: PerfLine | [top] |
A line of data on the chart. Often a line will have a single data Source (e.g. CPU percent busy), but we allow for the Capability for many sources To be combined (e.g. average CPU busy over 10 storage systems).
Name Type Description Color xsd:string
optional
Color of the line. The Values and their interpretation are determined by the client. Recommended usage includes common names like "black" or "blue", as well RGB hex specification like "AAFF00". DataGroup WrapperOfPerfDataGroup
The data Source(s) and consolidation method for the line. If DataSources contains a data Source that has an array counter, specify LabelNames field of PerfDataSource To select a single element of the array. LineName xsd:string
Name of the line. This is intended To be a user-visible label. Type xsd:string
Type of display for the line. The Values and their interpretation are determined by the client.