Introduction to DataFabric Manager APIs for the OnCommand Package

The NetApp Manageability SDK contains resources to develop third-party applications to monitor and manage NetApp storage systems using APIs. You can manage and monitor storage system by using the advanced functionality provided by the APIs of the applications included in the DataFabric Manager server. The NetApp Manageability SDK also provides APIs that enable you to manage the DataFabric Manager server infrastructure.

 

The following table lists common management tasks and the corresponding API set that you can use:

Tasks to be performed

What to use

Storage system health monitoring

OnCommand APIs

Storage system performance monitoring

Performance Advisor APIs

Data protection

Protection Manager APIs

Storage provisioning and space management

Provisioning Manager APIs

Command-line tasks not covered by any other API

ssh, rsh or telnet

API classification

This section provides guidelines on how to use the APIs for various operations related to the DataFabric Manager server and its components.

The DataFabric Manager APIs are broadly classified into:

Note: Some APIs fall under more than one of the above categories.

The following table lists the DataFabric Manager APIs and the corresponding API families:

DataFabric Manager product APIs API family
DataFabric Manager server infrastructure APIs
  • api
  • client
  • dfm
OnCommand APIs
  • aggregate
  • alarm
  • audit
  • cifs
  • comment
  • dataset
  • dfm-schedule
  • disk
  • event
  • eventclass
  • fcp-target
  • graph
  • group
  • group_member
  • host
  • host-service
  • ifc
  • ldap
  • lun
  • netif
  • networks
  • qtree
  • rbac
  • report
  • snapshot
  • srm
  • timezone
  • user_report_profile
  • virtual-infrastructure
  • volume
Performance Advisor APIs
  • perf
Protection capability APIs
  • application-policy
  • dataset
  • dp-backup
  • dp-dashboard
  • dp-job
  • dp-ossv-directory
  • dp-policy
  • dp-relationship
  • dp-restore
  • dp-schedule
  • dp-throttle
  • resourcepool
  • storage-service
Provisioning capability APIs
  • dataset
  • dp-job
  • dp-relationship
  • migrate
  • provisioning-policy
  • resourcepool
  • storage-service
  • vfiler

 

Apart from managing and monitoring NetApp storage systems, the DataFabric Manager APIs also provide SNMP traps, which are generated by the DataFabric Manager server. These trap definitions are present in the DataFabric Manager MIB files, which are located in the doc/mib folder.

 

Introduction to Web services

Web service, as defined by W3C, is a software system designed to support interoperable machine-to-machine interaction over a network. It has an interface described in a machine-processable format (specifically Web Services Description Language, or WSDL). Other systems interact with the Web service in a manner prescribed by its description using Simple Object Access Protocol (SOAP) messages, typically conveyed using HTTP with an XML serialization in conjunction with other web-related standards.

DataFabric Manager 4.0 provides support for the Web services feature and supports Web services APIs. These Web services APIs, defined in the WSDL file, use SOAP 1.2 over HTTP or HTTPS. You can use various SOAP toolkits, such as gSOAP, Axis, Apache CXF, Perl SOAP::Lite, and so on, to develop a Web services application.

The SDK provides Web services APIs that you can use with any third-party management tool, orchestration tool, or customer-created tools. You can use the WSDL to develop applications; the WSDL file is bundled with the SDK. To obtain further help to develop Web service applications, see the Web services sample codes.

This section contains