NAME

OCUMAPI - Contains the definitions and description of API Bindings for OnCommand Unified Manager server 6.0 or later

SYNOPSIS

         my $s = NaServer->new($server, 1, 0); # create NaServer (server context)
         $s->set_admin_user('admin', 'password'); # provide username and password
         $s->set_server_type('OCUM'); # set the server type to OCUM for OnCommand Unified Manager 6.0 or later
         eval{ 
                 my $output = $s->system_about(); # use binding for system-about API
                 print "OCUM server version is: $output->{version}\n"; # extract the required parameter from output
         };
         if($@) { # check for any exception
                 my ($error_reason, $error_code) = $@ =~ /(.+)\s\((\d+)\)/;  # parse out error reason and error code
                 print "Error Reason: $error_reason  Code: $error_code\n"
         }

DESCRIPTION

NetApp Manageability SDK 5.5 provides support for Perl API bindings for both Data ONTAP APIs and OnCommand Unified Manager APIs. The Perl API bindings libraries contain interfaces to establish a connection with either the Data ONTAP server or the OnCommand Unified Manager server. By using these libraries, you can create Perl applications to access and manage the Data ONTAP server or OnCommand Unified Manager server.

NetApp Manageability SDK 5.5 Perl API bindings provide a runtime library NaServer.pm, which is available at <installation_folder>/lib/perl/NetApp. This library file enables you to establish a server connection, send requests and receive responses, and interpret error messages. Each binding can be called as a subroutine of NaServer module which in turn invokes the corresponding Data ONTAP or OnCommand Unified Manager API.

API BINDINGS

aggregate_iter

Iterate over existing aggregates.

Inputs

Outputs

cluster_iter

Iterate over clusters.

Inputs

Outputs

cluster_node_iter

Iterate over cluster nodes.

Inputs

Outputs

dp_relationship_iter

Lists data protection relationships. For example, SnapVault or SnapMirror relationships. List relationships for a single storage service connection or for a particular source or destination name or id.

Inputs

Outputs

dp_restore_start

Starts a restore/retrieval operation on part of a storage object. This API copies storage objects (files, LUNS, directories, qtrees, and volumes) from a given Snapshot copy to a specified location.

Users can run one of the following APIs to obtain the source snapshot resource key.

  1. resource-lookup
  2. snapshot-get-location

This API returns the job-id of the job created for the restore operation. The job ID can be used to lookup detailed information on the progress of the restore operation.

Inputs

Outputs

disk_iter

Iterate over disks.

Inputs

Outputs

disk_physical_summary_get

Retrieve data, parity, spare, and total space usage (by number of disks and bytes) for the specified aggregate, cluster, or cluster node. For a V-Series storage system, data LUNs, spare LUNs and total LUNs are also reported, if array LUNs exist. For an aggregate, spares and spare space is not reported.
Error Conditions:

Inputs

Outputs

event_acknowledge

Acknowledge events. This terminates repeated notifications due to that event.

Inputs

Outputs

event_assign

Assign the events to the specified user.

Inputs

Outputs

event_class_iter

Iterate and list event-classes.

Inputs

Outputs

event_class_modify

Modify one or more properties of an event class.

Error Conditions:

Inputs

Outputs

event_iter

Iterate over events ordered by event-id.

Inputs

Outputs

event_purge

Purges the events that are older than the specified interval.

Inputs

Outputs

event_resolve

Resolve events. Terminates repeated notifications due to the event.

Inputs

Outputs

event_status_change_list_iter_end

event-status-change-list-iter-end is used to indicate that the temporary store used to support the event-status-change-list-iter-next API for the particular tag is no longer necessary.

Inputs

Outputs

event_status_change_list_iter_next

The event-status-change-list-iter-next API is used to iterate over the list of events stored in the temporary store created by the event-status-change-list-iter-start API.

A cursor is maintained pointing to the last record returned. Subsequent calls to this API will return the records after the cursor up to the specified "maximum" or number of actual records left.

Inputs

Outputs

event_status_change_list_iter_start

List events that had status changes (acknowledged or resolved) within the specified time range.

The event-status-change-list-iter-* set of APIs are used to retrieve the list of events that had status changes.

The event-status-change-list-iter-start API is used to load the list of events into a temporary store. The API returns a tag to temporary store so that subsequent APIs can be used to iterate over the list in the temporary store.

The returned list of events will be sorted according to when they had their status changed (either eventAcked timestamp or eventresolved timestamp). An event that's both acked and resolved within the requested timeframe would appear twice in the returned list of events, because those would count as 2 status changes, and appear in the returned list based on acked timestamp and resolved timestamp respectively.

Note that, depending on the input parameters, this API may take up to "timeout" seconds to return. Subsequent calls to event-status-change-list-iter-next() will return immediately.

Inputs

Outputs

event_unassign

Unassign the owner of an event or a set of events.

Inputs

Outputs

igroup_iter

Iterate over initiator groups.

Inputs

Outputs

job_abort

Abort a running management job.

Inputs

Outputs

job_delete

Delete the results of a completed job.

Inputs

Outputs

job_iter

Retrieve information about management jobs.