OntapClusterAPI - Contains the definitions and description of API Bindings for clustered Data ONTAP
my $s = NaServer->new($server, 1, 0); # create NaServer (server context)
$s->set_admin_user('admin', 'password'); # provide username and password
eval{
my $output = $s->system_get_version(); # use binding for system-get-version API
print "Data ONTAP version: $output->{version}\n"; # extract the required parameter from output
print "Clustered: $output->{is-clustered}\n";
my $tuple = $output->{'version-tuple'}->{'system-version-tuple'};
print "Generation: $tuple->{generation} Major: $tuple->{major} Minor: $tuple->{minor} \n";
$output = $s->quota_status_iter('query' => { 'quota-status-attributes' => {'volume' => 'vol0'}} ); # nested parameters as hashes of hashes
print "Quota Status: $output->{'attributes-list'}->{'quota-status-attributes'}->{'status'} \n";
};
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"
}
NetApp Manageability SDK 5.2.1 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.2.1 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.
[Family: vserver]
Create an Active Directory account for the given Vserver. If a CIFS server already exists for the requested Vserver, then this command will fail. The existing CIFS server should be deleted before retrying again.Inputs
Outputs
[Family: vserver]
Delete the Active Directory account. If a CIFS server already exists for the requested Vserver, cifs-server-delete API should be used to delete the machine account.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of active directory accountsInputs
Outputs
[Family: vserver]
Modify the Windows Active Directory domain. If a CIFS server already exists for the requested Vserver, cifs-server-modify API should be used to modify the Windows Active Directory domain.Inputs
Outputs
[Family: vserver]
Generate a new password for the machine account and change it in the Windows Active Directory domain.Inputs
Outputs
[Family: vserver]
Reset the machine account password in the Windows Active Directory domain. This may be required if the password stored along with the machine account in the Windows Active Directory domain is changed or reset without the Vserver's knowledge. This operation requires the credentials for a user with permission to reset the password in the organizational unit (OU) that the machine account is a member of.Inputs
Outputs
[Family: cluster]
Add disks to the specified aggregate, whether it is free-standing or embedded in a traditional volume. The disks to add are specified in the same way as for "aggr-create". Disks cannot be added to a mirrored aggregate if one or more of the plexes is offline. By the time the API returns, the disk(s) may not yet be completely added. Use 'aggr-list-info' to query the aggregate status to determine when it has finished growing due to the added disk(s). Same can be done using 'aggr-get-iter' when requested from Admin Vserver LIF. When the upgrade-64bit-mode input is provided to this API, the API produces a set of results in the background. These results are not available as output from aggr-add. Use the 'aggr-list-info' and 'volume-list-info' APIs to query the results of the 64-bit upgrade process on the aggregate and flexible volumes, respectively.Inputs
Outputs
[Family: cluster]
Return true if there is no suitable spare disk available for any filesystem (parity or data) disk.Inputs
Outputs
[Family: cluster]
Create a new aggregate with the given name. Up to 200 aggregates can be created on each filer (including the aggregates that are "embedded" in traditional volumes, which must be created as a side effect of a traditional volume creation). The aggregate may not yet be operational immediately after the API returns. Use 'aggr-list-info' to query the status of the newly-created aggregate to determine when it is fully operational. Same can be done using 'aggr-get-iter' when requested from Admin Vserver LIF. NOTE: If ECANT_USE_ALL_DISKS is returned, then the requested aggregate was indeed created, just not with all the disks that were specified.Inputs
Outputs
[Family: cluster]
Destroys the specified aggregate or plex. If an aggregate is specified, all plexes in the aggregate are destroyed. If the aggregate is embedded in a traditional volume, then the entire traditional volume is destroyed. If a plex is specified, only that plex is destroyed, leaving an unmirrored aggregate containing the remaining plex. The disks in the destroyed object become spare disks. Only offline aggregates and plexes can be destroyed. Note: Offline aggregates will be destroyed even if they contain one or more flexible volumes, which should not typically be the case. From cluster interface only aggregates are supported and plexes are not supported.Inputs
Outputs
[Family: cluster]
Get information on what possibilities and parameters exist for aggregates on a given filer.Inputs
Outputs
[Family: cluster]
Iterate over a list of aggrgate objects.Inputs
Outputs
[Family: cluster]
Turns an unmirrored aggregate into a mirrored aggregate by adding a plex to it. The plex is either newly formed from disks chosen from a spare pool or, if the "victim-aggregate" option is specified, taken from another existing unmirrored aggregate. The named aggregate must currently be unmirrored. Disks may be specified explicitly using the "mirror-disks" list option in the same way as with the "aggr-create" and "aggr-add" commands. The number of disks indicated must match the number present in the existing aggregate. If disks are not specified explicitly, then disks are automatically selected to match those in the aggregate's existing plex.Inputs
Outputs
[Family: cluster]
Modify the RAID type for the given aggregate to the specified "raid-type". This API can also selectively change the RAID type of specific raid groups in the aggregate based on the specified "disk-type". The change remains effective even if the filer is rebooted. This API does not support modifying options of a striped aggregate.Inputs
Outputs
[Family: cluster]
Take the specified aggregate or plex offline. The operation takes effect before the API returns. Except in maintenance mode, the current root aggregate may not be taken offline. An aggregate marked to become the root aggregate cannot be taken offline. An aggregate containing one or more flexible volumes cannot be taken offline; its contained volumes must first be destroyed. A number of operations being performed on the given aggregate can prevent this operation from succeeding, either at all or for various lengths of time. If such operations are found, the system waits up to one second for them to finish. If they don't, the command is aborted. A check is also made for files in the aggregate opened by internal ONTAP processes. The command is aborted if any are found.Inputs
Outputs
[Family: cluster]
Bring the specified aggregate or plex online. This command takes effect immediately. All volumes on the aggregate are brought to whatever state they were in before the aggregate was restricted or taken offline. If there are CIFS shares associated with the any of the aggregate's volumes that were also onlined, they are enabled.Inputs
Outputs
[Family: cluster]
Get the options that have been set for the specified aggregate. This API does not support listing options of striped aggregate.Inputs
Outputs
[Family: cluster]
Aggregate RelocationInputs
Outputs
[Family: cluster]
Iterate over the list of aggregate relocation statusInputs
Outputs
[Family: cluster]
Rename the specified aggregate.Inputs
Outputs
[Family: cluster]
Restrict the specified aggregate. If the aggregate is embedded in a traditional volume, the entire traditional volume will be restricted. An aggregate with one or more flexible volumes cannot be restricted; all of its contained volumes must first be destroyed.Inputs
Outputs
[Family: cluster]
Get the status of parity scrubbing on the named aggregate. Status includes percentage complete and the scrub's suspended status (if appropriate). If no name is given, then status is generated for all RAID groups.Inputs
Outputs
[Family: cluster]
Resume parity scrubbing on the named aggregate, plex, or RAID group. If no name is given, then resume parity scrubbing on all RAID groups for which it has been suspended. Use "aggr-scrub-list-info" to check scrubbing status.Inputs
Outputs
[Family: cluster]
Start parity scrubbing on the named aggregate, plex, or RAID group. Parity scrubbing compares the data disks to the parity disk in a RAID group, correcting the parity disk's contents as necessary. If no name is given, then parity scrubbing is started on all online aggregates. If an aggregate name is given, scrubbing is started on all RAID groups in the aggregate. If a plex name is given, scrubbing is started on all RAID groups contained in the plex. If a RAID group name is given, scrubbing is started only on that group. Use "aggr-scrub-list-info" to check scrubbing status.Inputs
Outputs
[Family: cluster]
Stop parity scrubbing on the named aggregate, plex, or RAID group. If no name is given, scrubbing will stop on all RAID groups currently being scrubbed. Use "aggr-scrub-list-info" to check scrubbing status.Inputs
Outputs
[Family: cluster]
Suspend parity scrubbing on the named aggregate, plex, or RAID group. If no name is given, suspend scrubbing on all RAID groups currently being scrubbed. Use "aggr-scrub-list-info" to check scrubbing status.Inputs
Outputs
[Family: cluster]
Set the specified option for the given aggregate to "option-value". The change remains effective even if the filer is rebooted. Some options have values that are numbers, and some have values that are "on" (also expressible as "yes", "true", or "1" ) or "off" (also expressible as "no", "false", or "0"). A mixture of uppercase and lowercase characters may be used when typing an option's value. Note that the "root" option is special in that it doesn't have a corresponding value. This API does not support modifying options of striped aggregate.Inputs
Outputs
[Family: cluster]
Get the status of RAID mirror verification on the named aggregate. Status includes percentage complete and whether it's currently suspended.Inputs
Outputs
[Family: cluster]
Resume RAID mirror verification on the named aggregate. If no name is given, then resume mirror verification on all aggregates that have been suspended.Inputs
Outputs
[Family: cluster]
Start RAID mirror verification on the named aggregate. Verification compares the data in both plexes of a mirrored aggregate. In the default case, any blocks that differ are logged and no changes are made. The fix-plex option is used to fix any mismatches. It specifies which plex to fix. If no name is given, then mirror verification is started on all online aggregates. Use the "aggr-verify-list-info" API to check mirror verification status. If the fix-plex option is used, then a name must be specified.Inputs
Outputs
[Family: cluster]
Stop RAID mirror verification on the named aggregate. If no name is given, stop mirror verification on all aggregates currently being verified.Inputs
Outputs
[Family: cluster]
Suspend RAID mirror verification on the named aggregate. If no name is given, suspend mirror verification on all aggregates currently being verified.Inputs
Outputs
[Family: cluster]
This gets the attributes of the Anti-Virus engine installed.Inputs
Outputs
[Family: cluster]
Get the attributes of the antivirus.Inputs
Outputs
[Family: cluster]
Get the attributes of the antivirus.Inputs
Outputs
[Family: cluster]
This gets the remedy information of the Anti-Virus engine installed. i.e. what to do when a virus is found.Inputs
Outputs
[Family: cluster]
This gets the version information of the Anti-Virus engine installed.Inputs
Outputs
[Family: cluster]
Iterate over a list of antivirus objects.Inputs
Outputs
[Family: cluster]
This sets the attributes of the Anti-Virus engine installed. If an optional attribute is not specified, the current value is left unchanged.Inputs
Outputs
[Family: cluster]
Modify the attributes of antivirus object.Inputs
Outputs
[Family: cluster]
Create a new antivirus.Inputs
Outputs
[Family: cluster]
This sets the quarantine information of the Anti-Virus engine installed. If an optional attribute is not specified, the current value is left unchanged.Inputs
Outputs
[Family: cluster]
This sets the version information of the Anti-Virus engine installed. If an optional attribute is not specified, the current value is left unchanged.Inputs
Outputs
[Family: cluster]
Run an Anti-Virus Update job immediatelyInputs
Outputs
[Family: cluster]
Get the cluster administrative audit settingsInputs
Outputs
[Family: cluster]
Modify the cluster administrative audit settingsInputs
Outputs
[Family: cluster]
Get AutoSupport time and size limits for the given node and subsystem.Inputs
Outputs
[Family: cluster]
Get AutoSupport time and size limits per subsystem for all nodes.Inputs
Outputs
[Family: cluster]
Return the total number of records.Inputs
Outputs
[Family: cluster]
Modify AutoSupport time and size limits per subsystem.Inputs
Outputs
[Family: cluster]
Get AutoSupport compliance hash mappingInputs
Outputs
[Family: cluster]
Get AutoSupport compliance hash mappingInputs
Outputs
[Family: cluster]
Return the total number of records.Inputs
Outputs
[Family: cluster]
Get AutoSupport configuration settings for the given node.Inputs
Outputs
[Family: cluster]
Get AutoSupport configuration settings for all nodes.Inputs
Outputs
[Family: cluster]
Return the total number of records.Inputs
Outputs
[Family: cluster]
Modify AutoSupport configuration settings for the given node.Inputs
Outputs
[Family: cluster]
Get the list of AutoSupport destinations for the given node.Inputs
Outputs
[Family: cluster]
Get the list of AutoSupport destinations for all nodes.Inputs
Outputs
[Family: cluster]
Return the total number of records. This sould be equal to the number of nodes in the cluster.Inputs
Outputs
[Family: cluster]
Get a history record for the given AutoSupport.Inputs
Outputs
[Family: cluster]
Get the history records for the last 50 AutoSupport messages.Inputs
Outputs
[Family: cluster]
Return the total number of records.Inputs
Outputs
[Family: cluster]
Selectively retransmit a previously collected AutoSupport message.Inputs
Outputs
[Family: cluster]
Generate a new AutoSupport messageInputs
Outputs
[Family: cluster]
Get a detailed manifest for the contents of an AutoSupport.Inputs
Outputs
[Family: cluster]
Return the total number of records.Inputs
Outputs
[Family: cluster]
Get the AutoSupport trigger data for the given node and EMS message.Inputs
Outputs
[Family: cluster]
Get a list of the AutoSupport trigger data for all nodes.Inputs
Outputs
[Family: cluster]
Return the total number of records.Inputs
Outputs
[Family: cluster]
Modify the AutoSupport trigger data for the given node and EMS message.Inputs
Outputs
[Family: cluster]
Returns giveback status of all the aggregates in the cluster which are taken over or were given back.Inputs
Outputs
[Family: cluster]
Forces one filer to take over its partner even though the filer detects an error that would otherwise prevent a takeover. For example, normally, if a detached or faulty interconnect cable between the filers causes the filers' NVRAM contents to be unsynchronized, takeover is disabled. However, this will allow the filer to take over its partner despite the unsynchronized NVRAM contents. cf-force-takeover is dangerous and can lead to data corruption; in almost all cases, use cf-takeover instead.Inputs
Outputs
[Family: cluster]
Iterate over a list of cf objects.Inputs
Outputs
[Family: cluster]
Get the host name of the partner. If the name is unknown, It will return partner-unknown.Inputs
Outputs
[Family: cluster]
Initiates a giveback of partner resources. Once the giveback is complete, the automatic takeover capability is disabled until the partner is rebooted. A giveback fails if outstanding CIFS sessions, active system dump processes, or other filer operations makes a giveback dangerous or disruptive.Inputs
Outputs
[Family: cluster]
Get useful information about statistics of hardware assisted takeover functionality.Inputs
Outputs
[Family: cluster]
Get useful information about stats of hw_assist functionality.Inputs
Outputs
[Family: cluster]
Get useful information about the status of hw_assist functionality.Inputs
Outputs
[Family: cluster]
Validates the hardware-assisted takeover configuration. functionality.Inputs
Outputs
[Family: cluster]
Modify the attributes of cf or a group of cf objects.Inputs
Outputs
[Family: cluster]
Disables the takeover capability of this filer in the cluster.Inputs
Outputs
[Family: cluster]
Enables the takeover capability of this filer in the cluster. This spawns a process to enable the serviceInputs
Outputs
[Family: cluster]
Get useful information about the status of the clustering service. If the monitor is not initialized, this returns an error.Inputs
Outputs
[Family: cluster]
Initiates a takeover of the storage partner. Takeover is done asynchronously; status may be monitored by calling the cf-status API and examining the state field. If automatic giveback is enabled then control will be returned to storage partner once it boots up.Inputs
Outputs
[Family: cluster]
Get the takeover status of a node and the takeover status of all its partner aggregates, for all nodes in a cluster.Inputs
Outputs
[Family: vserver]
Commits the snapshots that were started during the preceeding cg-start call that returned the cg-id key, and unfences the volumes that were fenced. If cg-commit API times out, then it means that either too many volumes were specified to the cg-start api or the timeout value for the cg-start api was very small. In this situation, the caller should try to perform the cg-start operation by specifying lesser volumes or by specifying higher timeout value.Inputs
Outputs
[Family: vserver]
Starts the checkpoint cycle for externally synchronized checkpoints in the filer. This operation fences the specified volumes and returns "success" (if successful). If the API returns "success", the call starts a snapshot create operation in these volumes. If the API returns "success", this operation SHOULD be followed by a call to cg-commit (below).This API is not supported on Infinite Volume.
Inputs
Outputs
[Family: vserver]
Create and setup the BranchCache service.Inputs
Outputs
[Family: vserver]
Flush (delete) all the BranchCache hashes that have been generated for a Vserver.Inputs
Outputs
[Family: vserver]
Retrieve information about the BranchCache service.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the per-Vserver BranchCache configurations for the cluster.Inputs
Outputs
[Family: vserver]
Force the generation of BranchCache hashes for a file or path.Inputs
Outputs
[Family: vserver]
Modify the CIFS BranchCache service settingsInputs
Outputs
[Family: vserver]
Remove the BranchCache serviceInputs
Outputs
[Family: cluster, vserver]
Retrieve the list of servers discovered by the cluster.Inputs
Outputs
[Family: vserver]
Command to trigger re-discovery of servers.Inputs
Outputs
[Family: vserver]
Add to the list of trusted domains for name-mapping searchInputs
Outputs
[Family: cluster, vserver]
Retrieve the list of trusted domains for name-mapping search.Inputs
Outputs
[Family: vserver]
Modify the list of trusted domains for name-mapping searchInputs
Outputs
[Family: vserver]
Remove from the list of trusted domains for name-mapping searchInputs
Outputs
[Family: vserver]
Add to a list of preferred domain controllersInputs
Outputs
[Family: cluster, vserver]
Retrieve the list of preferred domain controllers associated with Active Directory domains.Inputs
Outputs
[Family: vserver]
Remove from a list of preferred domain controllersInputs
Outputs
[Family: cluster, vserver]
Retrieve the list of discovered trusted domains.Inputs
Outputs
[Family: vserver]
Command to trigger re-discovery of trusted domains.Inputs
Outputs
[Family: vserver]
Add a path to the list of paths that will be searched to find a CIFS user's home directory.Inputs
Outputs
[Family: vserver]
Remove a home directory search path.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of cifs-home-directory-search-path objects.Inputs
Outputs
[Family: vserver]
Remove a home directory search path.Inputs
Outputs
[Family: vserver]
Change the position of this path in the list of paths that will be searched to find a CIFS user's home directory.Inputs
Outputs
[Family: vserver]
Create a single local groupInputs
Outputs
[Family: vserver]
Delete a single local groupInputs
Outputs
[Family: cluster, vserver]
Retrieve the list of local groupsInputs
Outputs
[Family: vserver]
Add local users or Active Directory users or groups to a local groupInputs
Outputs
[Family: cluster, vserver]
Retrieve the list of local group membersInputs
Outputs
[Family: vserver]
Remove local users or Active Directory users or groups from a local groupInputs
Outputs
[Family: vserver]
Modify a description of a single local groupInputs
Outputs
[Family: vserver]
Rename a local groupInputs
Outputs
[Family: vserver]
Configure and create a local user, associated with a VserverInputs
Outputs
[Family: vserver]
Delete a single local userInputs
Outputs
[Family: cluster, vserver]
Retrieve the list of local usersInputs
Outputs
[Family: cluster, vserver]
Retrieve local users' membership informationInputs
Outputs
[Family: vserver]
Modify a single local userInputs
Outputs
[Family: vserver]
Rename a local userInputs
Outputs
[Family: vserver]
Set password for a local userInputs
Outputs
[Family: cluster, vserver]
Retrieve the NetBIOS Name Service statistics for Vservers in cluster.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of cifs-options objects.Inputs
Outputs
[Family: vserver]
Modify the attributes of cifs-options object.Inputs
Outputs
[Family: vserver]
Generate a new password for the CIFS server's machine account and change it in the Windows Active Directory domain.Inputs
Outputs
[Family: vserver]
Reset the CIFS server's machine account password in the Windows Active Directory domain. This may be required if the password stored along with the machine account in the Windows Active Directory domain is changed or reset without the Vserver's knowledge. This operation requires the credentials for a user with permission to reset the password in the organizational unit (OU) that the machine account is a member of.Inputs
Outputs
[Family: vserver]
Add privileges to a local or Active Directory user or groupInputs
Outputs
[Family: cluster, vserver]
Retrieve the list of local groupsInputs
Outputs
[Family: vserver]
Remove privileges from a local or Active Directory user or groupInputs
Outputs
[Family: vserver]
Reset privileges for a local or Active Directory user or groupInputs
Outputs
[Family: cluster, vserver]
Iterate over a list of cifs-security objects.Inputs
Outputs
[Family: vserver]
Modify the attributes of cifs-security object.Inputs
Outputs
[Family: vserver]
Configure and setup CIFS services on a Vserver.Inputs
Outputs
[Family: vserver]
Delete a CIFS server. If the admin-username and admin-password are not specified, the CIFS server's machine account will not be deleted from the Windows Active Directory domain. The deletion of the CIFS server will also delete the CIFS shares associated with it.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of CIFS servers on the cluster and their basic configurations.Inputs
Outputs
[Family: vserver]
Modify the basic configurations of a CIFS server.Inputs
Outputs
[Family: vserver]
Start a CIFS server on the specified Vserver. The CIFS server must already exist. To create a CIFS server, use cifs-server-create.Inputs
Outputs
[Family: vserver]
Stop a CIFS server on the specified Vserver. Note that established sessions will be terminated and their open files closed. Workstations with cached data will not be able to save those changes, which could result in data loss.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of the opened CIFS files.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of the established CIFS sessions.Inputs
Outputs
[Family: vserver]
Add permissions for a user or group for a defined CIFS share.Inputs
Outputs
[Family: vserver]
Remove permissions for a user or group on a defined CIFS share.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of permissions on defined CIFS shares.Inputs
Outputs
[Family: vserver]
Modify the permissions for a user or group on a defined CIFS share.Inputs
Outputs
[Family: vserver]
Creates a new CIFS share rooted at the specified path.Inputs
Outputs
[Family: vserver]
Deletes the specified CIFS share.Inputs
Outputs
[Family: cluster, vserver]
Gives information about one or more CIFS shares.Inputs
Outputs
[Family: vserver]
Modifies settings of a CIFS share, even if the shares are in use.Inputs
Outputs
[Family: vserver]
Create a new CIFS symbolic link path mapping from a UNIX symlink to a target CIFS path. This symbolic link path mapping will be effective on symbolic links that have a prefix match with the value of 'unix-path'. e.g.: if the value of 'unix-path' is '/usr/local/' and there exists a symbolic link on the file system at '/home/user/link' which points to '/usr/local/share/dest'. If a CIFS client accesses the symbolic link 'link', this entry of path mapping would have a prefix match '/usr/local/'. The CIFS client would be redirected to the location pointed to by this path mapping's 'cifs-server', 'share-name' and 'cifs-path' fields.Inputs
Outputs
[Family: vserver]
Delete a CIFS symbolic link path mapping.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of CIFS symbolic link path mappings.Inputs
Outputs
[Family: vserver]
Modify a CIFS symbolic link path mapping parameters.Inputs
Outputs
[Family: cluster]
Gets current timezone and timezone file version.Inputs
Outputs
[Family: vserver]
Set autodelete on a lun clone.Inputs
Outputs
[Family: vserver]
Create a file/sub file or LUN/sub LUN clone.Inputs
Outputs
[Family: cluster]
Returns the cluster identity information.Inputs
Outputs
[Family: cluster]
Modifies the cluster identity information.Inputs
Outputs
[Family: cluster]
Returns information about a node in a cluster.Inputs
Outputs
[Family: cluster]
Returns information about nodes in a cluster.Inputs
Outputs
[Family: cluster]
Modifies state of a node in a cluster.Inputs
Outputs
[Family: cluster]
Create a cluster peer relationshipInputs
Outputs
[Family: cluster]
Delete a cluster peer relationshipInputs
Outputs
[Family: cluster]
Return the specified peer cluster relationship informationInputs
Outputs
[Family: cluster]
Returns a list of cluster peer relationshipsInputs
Outputs
[Family: cluster]
Get the health of the specified peer nodeInputs
Outputs
[Family: cluster]
Get the health of all local and peer nodes sequentiallyInputs
Outputs
[Family: cluster]
Modifies a cluster peer relationshipInputs
Outputs
[Family: cluster]
Ping the specified peer nodes. Ping operations take place between a node in a cluster and a node in a remote cluster. The originating node is the node which initiates the ping operation and the destination cluster and node specify the remote node which is the target of the ping.Inputs
Outputs
[Family: cluster]
Copy a configuration backup. A job will be queued to copy the configuration backup. A job will be spawned to operate on the config-backup and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
Create a configuration backup. A job will be queued to create the configuration backup in the background. Creation of configuration backup may take several minutes. This ZAPI creates an on demand backup. A job will be spawned to operate on the config-backup and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
Delete a configuration backup.Inputs
Outputs
[Family: cluster]
Download a configuration backup from a URL.Inputs
Outputs
[Family: cluster]
Return information about a specified configuration backup.Inputs
Outputs
[Family: cluster]
Return a list of configuration backups in the cluster.Inputs
Outputs
[Family: cluster]
Rename a configuration backup. Renamed backup stays on the same node.Inputs
Outputs
[Family: cluster]
Return information about the configuration backup settings.Inputs
Outputs
[Family: cluster]
Modify the settings for configuration backup operations.Inputs
Outputs
[Family: cluster]
Modify the password for destination URL.Inputs
Outputs
[Family: cluster]
Upload a configuration backup to a URL.Inputs
Outputs
[Family: cluster]
Get alarm monitoring data for the given node object.Inputs
Outputs
[Family: cluster]
Get alarm monitoring data for all objects in the cluster.Inputs
Outputs
[Family: cluster]
Return the total number of records.Inputs
Outputs
[Family: cluster]
Get alarm threshold settings for the given metric group.Inputs
Outputs
[Family: cluster]
Get alarm threshold settings for all metric groups.Inputs
Outputs
[Family: cluster]
Return the total number of records.Inputs
Outputs
[Family: cluster]
Modify alarm threshold settings for the given metric group.Inputs
Outputs
[Family: cluster]
Return alert definitionInputs
Outputs
[Family: cluster]
Iterate over a list of Alert Definition objects.Inputs
Outputs
[Family: cluster]
Return a subsystem alertInputs
Outputs
[Family: cluster]
Iterate over a list of Alert Information objects.Inputs
Outputs
[Family: cluster]
Acknowledge/suppress an alertInputs
Outputs
[Family: cluster]
Return the system health framework configurationInputs
Outputs
[Family: cluster]
Iterate over a list of Health Monitor Configuration objects.Inputs
Outputs
[Family: cluster]
Delete subsystem alertInputs
Outputs
[Family: cluster]
Return policy definitionInputs
Outputs
[Family: cluster]
Iterate over a list of Policy Definition objects.Inputs
Outputs
[Family: cluster]
Enable/disable policyInputs
Outputs
[Family: cluster]
Return the overall system healthInputs
Outputs
[Family: cluster]
Create a new Subscriptions for Notifications.Inputs
Outputs
[Family: cluster]
Return system health subscriptionInputs
Outputs
[Family: cluster]
Iterate over a list of Subscriptions for Notifications objects.Inputs
Outputs
[Family: cluster]
Modify system health subscriptionInputs
Outputs
[Family: cluster]
Get the attributes of the Health Monitor Subsystem Status.Inputs
Possible values:
Outputs
[Family: cluster]
Iterate over a list of Health Monitor Subsystem Status objects.Inputs
Outputs
[Family: cluster]
Fail a file system disk. Removes the specified file system disk from the RAID configuration, spinning the disk down when removal is complete. disk fail is used to remove a file system disk that may be logging excessive errors and requires replacement. Note that if optional input parameter 'is-immediate' is true, the specified disk will be immediately failed out, and the RAID group to which the disk belongs will enter degraded mode (meaning a disk is missing from the RAID group). If a spare disk at least as large as the disk being removed is available, the contents of the disk being removed will be reconstructed onto that spare disk. If 'is-immediate' options is false or not specified, system will prefail the disk and its content will be copied to a replacement disk if a suitable spare disk is available, and afterwards the prefailed disk will be failed out. This process can be observed by polling disk-list-info for this disk and tracking values of elements copy-destination and copy-percent. Same can be done using 'storage-disk-get-iter' when requested from Admin Vserver LIF. The disk being failed is marked as ``broken'', so that if it remains in the disk shelf, it will not be used by the filer as a spare disk. If the disk is moved to another filer, that filer will use it as a spare. This is not a recommended course of action, as the reason that the disk was failed may have been because it needed to be replaced. NOTE: Data ONTAP 7.0 and earlier releases don't indicate failure code properly.Inputs
Outputs
[Family: cluster]
Remove a spare disk. Removes the specified spare disk from the RAID configuration, spinning the disk down when removal is complete. You can use disk remove to remove a spare disk so that it can be used by another filer (as a replacement for a failed disk or to expand file system space). NOTE: Data ONTAP 7.0 and earlier releases don't indicate failure code properly.Inputs
Outputs
[Family: cluster]
Assigns ownership of a disk. The normal usage is when the disk is unowned, or to assign a disk to a pool.Inputs
Outputs
[Family: cluster]
Get sanown filer information.Inputs
Outputs
[Family: cluster]
Get sanown disk information.Inputs
Outputs
[Family: cluster]
Changes ownership on disks already belonging to an owner.Inputs
Outputs
[Family: cluster]
Removes ownership information on a disk. Default usage is to remove ownership information for all disks owned by the local node, in maintenance mode.Inputs
Outputs
[Family: cluster]
Unfail a disk in the broken pool, by clearing its FDR (Failed Disk Registry) entry and unfailing it at the Storage Layer, as necessary. If the "make-spare" option is set to B_TRUE, the disk is returned to the spare pool. Otherwise, label assimilation will bring the disk back according to its on-disk labels, with one of four possible outcomes. 1. Disk becomes a spare. This is the common case. The disk becomes a spare upon unfail, because its parent volume is complete and online. 2. Disk is assimilated into former volume. This is a recovery scenario. The disk is brought back into an existing volume, which may result in this volume coming back online. 3. Disk is assimilated into a new partial volume. This may occur in the rare case that the disk's former volume was destroyed or moved. 4. Disk returned to broken pool. This is the case if a fatal error occurs in process of unfailing the disk.Inputs
Outputs
[Family: cluster]
Start disk firmware download process to update firmware on disks. This operation is asynchronous, and therefore returns no errors that might occur during the download process. This operation will only update firmware on disks that do not have the latest firmware revision. The firmware revision on the disk can be monitored via the disk-list-info API.Inputs
Outputs
[Family: cluster]
Set up all non-zeroed spares owned by the filer to start zeroing. This operation is asynchronous, and therefore returns no errors that might occur when the zeroing operation actually starts, which could be several seconds after this API operation completes. Zeroing progress can be monitored via the disk-list-info API. Same can be done using 'storage-disk-get-iter' when requested from Admin Vserver LIF. The "zeroing-percent" element of disk-detail-info is returned if disk zeroing has started, and "is-zeroed" returns TRUE once the zeroing has completed (or, if zeroing wasn't necessary in the first place).Inputs
Outputs
[Family: vserver]
This API is used by SnapDrive to log SnapDrive specific events occurring on a host system to the the appliance and optionally use the appliance to generate an autosupport message. This event information will be encapsulated in an app.log.x EMS event based on error level. If auto-support is true, an autosupport message will be sent from the filer.Inputs
Outputs
[Family: cluster]
Return the EMS Configuration.Inputs
Outputs
[Family: cluster]
Modify the EMS Configuration.Inputs
Outputs
[Family: cluster]
Creates an EMS destination.Inputs
Outputs
[Family: cluster]
Deletes the specified EMS destination.Inputs
Outputs
[Family: cluster]
Deletes several EMS destinations.Inputs
Outputs
[Family: cluster]
Return the specified EMS destination information.Inputs
Outputs
[Family: cluster]
Return information on EMS destinations.Inputs
Outputs
[Family: cluster]
Modifies the specified EMS destination.Inputs
Outputs
[Family: cluster]
Modifies several EMS destinations.Inputs
Outputs
[Family: cluster]
Delete an individual mail history entry.Inputs
Outputs
[Family: cluster]
Delete mail history entries.Inputs
Outputs
[Family: cluster]
Return an individual mail history entry.Inputs
Outputs
[Family: cluster]
Return information mail history.Inputs
Outputs
[Family: cluster]
Return an EMS message.Inputs
Outputs
[Family: cluster]
Return EMS messages.Inputs
Outputs
[Family: cluster]
Add EMS Destinations.Inputs
Outputs
[Family: cluster]
Return the specified EMS route information.Inputs
Outputs
[Family: cluster]
Return information on several EMS routes.Inputs
Outputs
[Family: cluster]
Modifies the specified EMS route.Inputs
Outputs
[Family: cluster]
Modifies several EMS route.Inputs
Outputs
[Family: cluster]
Remote EMS Destinations.Inputs
Outputs
[Family: cluster]
Delete an individual SNMP history entry.Inputs
Outputs
[Family: cluster]
Delete SNMP history entries.Inputs
Outputs
[Family: cluster]
Return an individual SNMP history entry.Inputs
Outputs
[Family: cluster]
Return information SNMP history.Inputs
Outputs
[Family: cluster]
Return information an EMS message.Inputs
Outputs
[Family: cluster]
Return information on EMS messages.Inputs
Outputs
[Family: cluster]
Returns the sensors information from the environmental subsystem.Inputs
Outputs
[Family: vserver]
Create an Export policy configuration.Inputs
Outputs
[Family: vserver]
Delete an Export policy configuration.Inputs
Outputs
[Family: vserver]
Get an Export policy configuration.Inputs
Outputs
[Family: cluster, vserver]
Get a group of Export policy configurations.Inputs
Outputs
[Family: vserver]
Rename an Export policyInputs
Outputs
[Family: vserver]
Create an Export rule configuration.Inputs
Outputs
[Family: vserver]
Delete an Export rule configuration.Inputs
Outputs
[Family: vserver]
Get an Export rule configuration.Inputs
Outputs
[Family: cluster, vserver]
Obtain the default values for Export rule configurationInputs
Outputs
[Family: cluster, vserver]
Get a group of Export rule configurations.Inputs
Outputs
[Family: vserver]
Modify an Export rule configuration.Inputs
Outputs
[Family: vserver]
Move a rule to the specified indexInputs
Outputs
[Family: cluster]
Call the corresponding adapter driver disable function to bring the adapter offline. Under some circumstances an adapter can not be put offline. (e.g. when the adapter is being used by the RAID sub-system to provide disks in a volume). In some cases, manual intervention is required. When this happens, an appropriate error messages is returned.Inputs
Outputs
[Family: cluster]
Call the corresponding adapter driver enable function to bring the adapter online. Under some circumstances an adapter can not be brought online. (e.g. when that adapter is in the UNCONFIGURED state, or when there is no cable attached to the adapter port). When this happens, an appropriate error messages is returned.Inputs
Outputs
[Family: cluster]
Iterate over a list of fc objects.Inputs
Outputs
[Family: cluster]
fc-config-set-adapter-fc-type changes the adapter driver and/or configuration state. Each configurable adapter has an adapter-type and adapter-state. The adapter-type indicates which driver is attached to the adapter, the adapter-state indicates what the configuration state of the adapter is. The fc-type is used to modify both the adapter-type and the adapter-state. After setting the adapter fc-type a filer reboot is sometimes needed to make the change effective. Use fc-config-list-info to determine if a filer reboot is needed.Inputs
Outputs
[Family: cluster]
Bring a Fibre Channel target adapter offline. The adapter may not be offline immediately after the call returns, it may take up to a few seconds for the adapter to change state. In Data ONTAP 7-Mode, if the FCP service is not running then all adapters are automatically offlined. They cannot be brought online again until FCP service is started. adapter to change state. In Data ONTAP Cluster-Mode, offlining an adapter will operationally disable all FCP logical interfaces (LIFs) hosted by the adapter.Inputs
Outputs
[Family: cluster]
Bring a Fibre Channel target adapter online. The adapter may not be online immediately after the call returns, it may take up to a few seconds for the adapter to initialize. In Data ONTAP 7-Mode, if the FCP service is not running then all adapters are automatically offlined. They cannot be brought online again until FCP service is started. In Data ONTAP Cluster-Mode, offlining an adapter will operationally disable all FCP logical interfaces (LIFs) hosted by the adapter.Inputs
Outputs
[Family: cluster]
Iterate over the list of physical FC adapters.Inputs
Outputs
[Family: cluster]
Sets the speed on the Fibre Channel target adapter. It can be configured to run at 1Gb, 2Gb, 4Gb, or to autonegotiate. Note only 4Gb adapters support the 4Gb speed. If the adapter is online it must be brought offline before setting the speed, and then online in order for a new speed to take effect. This may temporarily disrupt fcp service on the target adapter.Inputs
Outputs
[Family: cluster]
Iterate over a list of fcp objects.Inputs
Outputs
[Family: cluster, vserver]
List all initiators connected to FCP target LIFs.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of FCP Target Logical Interfaces (LIF).Inputs
Outputs
[Family: vserver]
Get the current FCP World Wide Node Name (WWNN). This WWNN name is in the form XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit. In Data ONTAP 7-Mode, this is the WWNN of the individual storage system. In "single_image" cfmode, the WWNN of the system and its high availability partner will be the same. In Data ONTAP Cluster-Mode, this is the WWNN of the Vserver FCP Service.Inputs
Outputs
[Family: vserver]
Set the current FCP World Wide Node Name (WWNN). This WWNN is in the form XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit. The supplied WWNN must also match the vendor's registered namespace unless the force argument is also supplied. In Data ONTAP 7-Mode, the registered namespace is "50:0a:80:8X:XX:XX:XX" and all Fibre Channel adapters must be offline. Changes will take place when the adapters are brought online. In Data ONTAP Cluster-Mode, the registered namespace is "2X:XX:00:a0:98:XX:XX:XX" and the FCP service must be offline. Changes will take place when the service is brought online.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the list of valid Fibre Channel target port names on a Vserver's FCP LIFs.Inputs
Outputs
[Family: vserver]
Set a valid but unused port name on a Fibre Channel target interface.Inputs
Outputs
[Family: vserver]
Create an FCP Service in a Vserver. Each Vserver requires an online FCP Service in order to serve data via the Fibre Channel protocol.Inputs
Outputs
[Family: vserver]
Destroy the FCP Service in a Vserver.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the list of FCP Services.Inputs
Outputs
[Family: vserver]
Starts FCP service. When FCP service is started, the adapters are brought online. Service will be avaliable once the call returns with success. The adapters however, may not be available immediately after the call, it may take up to a few seconds for the adapters to initialize.Inputs
Outputs
[Family: vserver]
Get status of the FCP service, whether or not it is running.Inputs
Outputs
[Family: vserver]
Stops FCP service. When FCP service is stopped, the adapters are brought offline. Service will be unavaliable once the call returns with success.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the list of assigned World Wide Port Name (WWPN) aliases.Inputs
Outputs
[Family: vserver]
Remove an alias for a World Wide Port Name of an initiator. Either the alias or the wwpn argument must be provided.Inputs
Outputs
[Family: vserver]
Set an alias for a World Wide Port Name of an initiator that might login to the target.Inputs
Outputs
[Family: cluster]
Get the link state of a specific adapter on this system.Inputs
Outputs
[Family: cluster, vserver]
Returns status information for managed features.Inputs
Outputs
[Family: cluster]
Manage the association of QoS policy group to a specified file. QoS Policy groups define measurable Service Level Objectives (SLOs) that apply to the storage object with which the policy group is associated. In Data ONTAP 8.2 hierarchical QoS is not supported i.e. QoS policy groups cannot be assigned to multiple objects in the file's storage hierarchy - such as the parent LUN, volume or Vserver.Inputs
Outputs
[Family: vserver]
Create a directory.Inputs
Outputs
[Family: vserver]
Delete a directory.Inputs
Outputs
[Family: vserver]
Delete a file.Inputs
Outputs
[Family: vserver]
Obtains the file information or properties.Inputs
Outputs
[Family: vserver]
Queries the space reservation settings for the named file.Inputs
Outputs
[Family: vserver]
Return ranges of holes in a fileInputs
Outputs
[Family: vserver]
list of files in a given directory.Inputs
Outputs
[Family: vserver]
Punch hole in the file. Hole punching involves reclaiming of blocks in a file by unallocating them and then direct or indirect blocks can be made to point to 0.Inputs
Outputs
[Family: vserver]
Read data from a named file. API will fail if length exceeds 1 MB. This API should only be used on normal files. The results for other file types such as LUNs is undefined.Inputs
Outputs
[Family: vserver]
Rename a file or directory. Note that this API cannot be used to rename to a different volume.Inputs
Outputs
[Family: vserver]
Sets the space reservation settings for the named file. is-overwrite-enabled and is-fill-enabled both must be the same value.Inputs
Outputs
[Family: vserver]
Truncate a file. Any data past the truncation point will be lost, of course.Inputs
Outputs
[Family: vserver]
Reports unique bytes held in a file.Inputs
Outputs
[Family: vserver]
Used to poll and retrieve results for a previous file-usage-start call. EINPROGRESS indicates that the background job has not finished yet.Inputs
Outputs
[Family: vserver]
Starts a background job to compute unique bytes held in a file. The result can be obtained by passing the cookie to file-usage-result-get call.Inputs
Outputs
[Family: vserver]
Write data into a named file. If the file does not previously exist, it will be created - the owner of the file will be root and it will not be readable or writable by non-root users. API will fail if data exceeds 1 MB. This API should only be used on normal files. The results for other file types such as LUNs is undefined.Inputs
Outputs
[Family: vserver]
Returns security information of a file/folderInputs
Outputs
[Family: vserver]
Creates a new NTFS security descriptorInputs
Outputs
[Family: vserver]
Add a discretionary access control entry to NTFS security descriptor.Inputs
Outputs
[Family: cluster, vserver]
Returns information about one or more discretionary access control entriesInputs
Outputs
[Family: vserver]
Modify an discretionary access control entry of a file security descriptorInputs
Outputs
[Family: vserver]
Remove a discretionary access control entry from NTFS security descriptor.Inputs
Outputs
[Family: vserver]
Deletes an NTFS security descriptor informationInputs
Outputs
[Family: cluster, vserver]
Returns information about one or more NTFS security descriptorInputs
Outputs
[Family: vserver]
Modifies an NTFS security descriptorInputs
Outputs
[Family: vserver]
Add a system/audit access control entry to NTFS security descriptor.Inputs
Outputs
[Family: cluster, vserver]
Returns information about one or more system/audit access control entriesInputs
Outputs
[Family: vserver]
Modify an system/audit access control entry of a file security descriptorInputs
Outputs
[Family: vserver]
Remove an system/audit access control entry from NTFS security descriptor.Inputs
Outputs
[Family: vserver]
Creates a new file/folder security policy configuration. To preserve the security configuration of a file(or, folder) or set of files(or, folders) security policy has been defined. Policy is a container for tasks and a task associates a file/folder path name and the security descriptor that needs to be set on the file/folder. Every task in a policy is uniquely identified by the file/folder path. Policy can't have duplicate task entries and there is only one task per path.Inputs
Outputs
[Family: vserver]
Deletes a file/folder security policy. To preserve the security configuration of a file(or, folder) or set of files(or, folders) security policy has been defined. Policy is a container for tasks and a task associates a file/folder path name and the security descriptor that needs to be set on the file/folder. Every task in a policy is uniquely identified by the file/folder path. Policy can't have duplicate task entries and there is only one task per path.Inputs
Outputs
[Family: cluster, vserver]
Returns information about one or more security policies. To preserve the security configuration of a file(or, folder) or set of files(or, folders) security policy has been defined. Policy is a container for tasks and a task associates a file/folder path name and the security descriptor that needs to be set on the file/folder. Every task in a policy is uniquely identified by the file/folder path. Policy can't have duplicate task entries and there is only one task per path.Inputs
Outputs
[Family: vserver]
Add a file security policy task. A task maps security descriptor with a file or folder.Inputs
Outputs
[Family: cluster, vserver]
Returns information about one or more policy tasks. Policy is a container for tasks and a task associates a file/folder path name and the security descriptor that needs to be set on the file/folder. Every task in a policy is uniquely identified by the file/folder path. Policy can't have duplicate task entries and there is only one task per path.Inputs
Outputs
[Family: vserver]
Modify a file security policy taskInputs
Outputs
[Family: vserver]
Remove a task from the policy of a vserver.Inputs
Outputs
[Family: vserver]
Apply security descriptors on files and directories defined in a policy to a VserverInputs
Outputs
[Family: vserver]
Create audit configuration for a VserverInputs
Outputs
[Family: vserver]
Show Audit configuration details for a VserverInputs
Outputs
[Family: cluster, vserver]
Show Audit configuration details for all VserversInputs
Outputs
[Family: cluster]
Return the total number of recordsInputs
Outputs
[Family: vserver]
Modify audit configuration for a VserverInputs
Outputs
[Family: vserver]
Disable Auditing for specified VserverInputs
Outputs
[Family: vserver]
Enable Auditing for specified VserverInputs
Outputs
[Family: vserver]
Disable Audit Configuration for specified vserverInputs
Outputs
[Family: vserver]
Rotate audit log for specified vserverInputs
Outputs
[Family: cluster]
Iterate over a list of Flash Cache device info objects.Inputs
Outputs
[Family: cluster]
This API is used to retrieve information about the flash devices in the controller registered with Flash Management Module (FMM).Inputs
Outputs
[Family: cluster]
Get threshold profiles available in Flash Management Module.Inputs
Outputs
[Family: cluster]
Iterate over a list of Flash Cache threshold profiles objects.Inputs
Outputs
[Family: vserver]
Create a new flexcache-cache-policy.Inputs
Outputs
[Family: vserver]
Delete an existing flexcache-cache-policy object.Inputs
Outputs
[Family: vserver]
Get the attributes of the flexcache-cache-policy.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of flexcache-cache-policy objects.Inputs
Outputs
[Family: vserver]
Modify the attributes of flexcache-cache-policy object.Inputs
Outputs
[Family: cluster, vserver]
Create cluster-wide caching for a given volume.Inputs
Outputs
[Family: cluster, vserver]
Delete cluster-wide caching for a given volume.Inputs
Outputs
[Family: vserver]
Get the attributes of the flexcache.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of flexcache objects.Inputs
Outputs
[Family: cluster]
Get the cluster-wide attributes of FlexCache.Inputs
Outputs
[Family: cluster]
Modify the cluster-wide attributes of FlexCache.Inputs
Outputs
[Family: vserver]
Disables a specific named policy.Inputs
Outputs
[Family: vserver]
Enables a specific named policy. The operation will fail if the policy doesn't exist.Inputs
Outputs
[Family: vserver]
Create a policy.Inputs
Outputs
[Family: vserver]
Delete a policy.Inputs
Outputs
[Family: vserver]
Create FPolicy Event.Inputs
Outputs
[Family: vserver]
Delete FPolicy event.Inputs
Outputs
[Family: cluster, vserver]
Get a list of rows for FPolicy event options. FPolicy event is consist of protocol, file operations, vo lume operation and filters.Inputs
Outputs
[Family: vserver]
Set FPolicy event options. FPolicy event is consist of protocol, file operation, volume operation and f ilters.Inputs
Outputs
[Family: vserver]
Create an external engine.Inputs
Outputs
[Family: vserver]
Delete an external engine.Inputs
Outputs
[Family: cluster, vserver]
Returns information on external engines.Inputs
Outputs
[Family: vserver]
Modify an external engine. External engine can be modified only when none of the enabled policies are using it.Inputs
Outputs
[Family: cluster, vserver]
Returns information about policies.Inputs
Outputs
[Family: vserver]
Modify a policy.Inputs
Outputs
[Family: vserver]
Set FPolicy scope options. FPolicy Scope is consist of share, volume, export policy, volume, file extention.Inputs
Outputs
[Family: vserver]
Delete a scope.Inputs
Outputs
[Family: cluster, vserver]
Get a list of rows for FPolicy scope options. FPolicy Scope consists of share, volume, export policy, volume, file extention.Inputs
Outputs
[Family: vserver]
Set FPolicy scope options. FPolicy Scope is consist of share, volume, export policy, volume, file extention.Inputs
Outputs
[Family: cluster, vserver]
Returns FPolicy policy status information.Inputs
Outputs
[Family: vserver]
Make a connection to FPolicy serverInputs
Outputs
[Family: vserver]
Terminate connection to FPolicy serverInputs
Outputs
[Family: cluster, vserver]
Returns FPolicy server status information.Inputs
Outputs
[Family: cluster, vserver]
Get the list of entries of the applied GPO rules, organized on a per-Vserver basis.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the Vserver's group policy configuration.Inputs
Outputs
[Family: cluster, vserver]
Get a list of entries of the GPO RSoP(Resultant Set of Policy) data, organized on a per-Vserver basis.Inputs
Outputs
[Family: vserver]
Change the Vserver's group policy configuration.Inputs
Outputs
[Family: vserver]
Download and apply the latest version of the group policy defined in Active Directory.Inputs
Outputs
[Family: vserver]
Create a new group mapping for a Vserver.Inputs
Outputs
[Family: vserver]
Delete an existing group mapping entry.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of group mappings in the cluster.Inputs
Outputs
[Family: vserver]
Insert a group mapping into the table at a specified position.Inputs
Outputs
[Family: vserver]
Modify an existing group mapping entry.Inputs
Outputs
[Family: vserver]
Swap the position of one group mapping with another. The position is the place in the sequence of group mappings in which the mappings are applied.Inputs
Outputs
[Family: vserver]
Adds initiator to an existing initiator group.Inputs
Outputs
[Family: vserver]
Bind an existing igroup to a given portset.Inputs
Outputs
[Family: vserver]
Creates a new initiator group. In Data ONTAP 7.3 and upto ONTAP 8.0, the ALUA (Asymmetiric Logical Unit Access) attribute will be enabled by default if initiator-group-type is "fcp" and os-type is "aix", "hpux", or "linux. In Data ONTAP 7-mode 8.1 and later, the ALUA attribute is enabled by default for all os-type if initiator-group-type is "fcp". In Data ONTAP Cluster-Mode 8.1 and later, the ALUA attribute is enabled by default on all initiator groups.Inputs
Outputs
[Family: vserver]
Destroys an existing initiator group. By default a group cannot be destroyed if there are existing lun maps defined for that group. This behaviour can be overridden with the use of force option set to "true" which will destroy the initiator group and any associated lun maps.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of igroup objects.Inputs
Outputs
[Family: vserver]
Find the path to the lun mapped at a given lun-id for a given initiator group.Inputs
Outputs
[Family: vserver]
Removes node(s) from an initiator group. The operation is prohibited if there are existing lun maps defined for that group. The force option set to "true" can be used to forcibly remove the node regardless of mappings.Inputs
Outputs
[Family: vserver]
Rename an existing initiator group. The rename operation is non-disruptive.Inputs
Outputs
[Family: vserver]
Sets an attribute for an initiator group.Inputs
Outputs
[Family: vserver]
Unbind an existing igroup from a portset.Inputs
Outputs
[Family: vserver]
Generate a 128 bit random password that can be used as a CHAP secret.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of iSCSI Connection objects.Inputs
Outputs
[Family: vserver]
Add initiator to the authentication list.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of iSCSI initiator authentication configuration objects.Inputs
Outputs
[Family: vserver]
Delete initiator from the authentication listInputs
Outputs
[Family: vserver]
Get the authentication info for an initiator, if auth type is CHAP, only the user-name is returned, password is not returned for security purposes.Inputs
Outputs
[Family: vserver]
Get the default auth info for iscsi. If the auth type is CHAP, only the username is retuned, and not the password, for security purposes.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of remote iSCSI initiator objects.Inputs
Outputs
[Family: vserver]
Modify CHAP parameters to an existing per-initiator authentication info whose auth-type equals CHAP.Inputs
Outputs
[Family: vserver]
Configure the default authentication method. If an initiator is not configured with a specific authentication method using iscsi-initiator-add-auth the default authentication method will be applied to it.Inputs
Outputs
[Family: vserver]
Add the iSCSI LIFs to the accesslist of the specified initiatorInputs
Outputs
[Family: cluster, vserver]
Iterate over a list of iSCSI Interface Accesslist objects.Inputs
Outputs
[Family: vserver]
Remove the iSCSI LIFs from the accesslist of the specified initiatorInputs
Outputs
[Family: vserver]
Disables an interface for use by iSCSIInputs
Outputs
[Family: vserver]
Enables an interface for use by iSCSIInputs
Outputs
[Family: cluster, vserver]
Iterate over a list of iSCSI target interface objects.Inputs
Outputs
[Family: vserver]
Configures the iSNS service. In Data ONTAP Cluster-Mode, this this API can only modify the configuration of a Vserver where an iSNS service has already been created. To create an iSNS service in a Vserver where one does not exist, use the iscsi-isns-create API.Inputs
Outputs
[Family: vserver]
Create the iSNS Service for a Vserver.Inputs
Outputs
[Family: vserver]
Destroy the iSNS Service for a Vserver.Inputs
Outputs
[Family: vserver]
Gets iSNS service configuration.Inputs
Outputs
[Family: cluster, vserver]
Gets iSNS service configuration for a Vserver.Inputs
Outputs
[Family: vserver]
Start iSNS service. Service will be avaliable once the call returns with success.Inputs
Outputs
[Family: vserver]
Stops iSNS service. Service will not be available once the call returns with success.Inputs
Outputs
[Family: vserver]
Forces an update of the iSNS service configuration stored in the external iSNS server.Inputs
Outputs
[Family: vserver]
Return the current iscsi node name.Inputs
Outputs
[Family: vserver]
Set the current iscsi node name.Inputs
Outputs
[Family: vserver]
Create an iSCSI Service in a Vserver. Each Vserver requires an online iSCSI Service in order to serve data via the iSCSI protocol.Inputs
Outputs
[Family: vserver]
Destroy the iSCSI Service in a Vserver.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the list of iSCSI Services.Inputs
Outputs
[Family: vserver]
Start iSCSI service. Service will be avaliable once the call returns with success.Inputs
Outputs
[Family: vserver]
Get status of the iSCSI service, whether or not it is running.Inputs
Outputs
[Family: vserver]
Stops iSCSI service. Service will be not be available once the call returns with success.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of iSCSI session objects.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of iscsi objects.Inputs
Outputs
[Family: vserver]
Clear the current iscsi target aliasInputs
Outputs
[Family: vserver]
Return the current iscsi target aliasInputs
Outputs
[Family: vserver]
Set the current iscsi target aliasInputs
Outputs
[Family: vserver]
Create a new user defined target portal group.Inputs
Outputs
[Family: vserver]
Destroy a tpgroup. Only user defined target portal groups may be destroyed.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of iSCSI Target Portal Group objects.Inputs
Outputs
[Family: vserver]
Add an interface to a target portal group. Interfaces may only be added to a user defined target portal group.Inputs
Outputs
[Family: vserver]
Remove an interface from a target portal group. Interfaces may only be removed from a user defined target portal group. Removing an interface will return it to the system defined default group for the interface.Inputs
Outputs
[Family: vserver]
Get a single job entry. This is just a performance optimization for job-get that only searches for the job among the ones currently owned by the given node.Inputs
Outputs
[Family: cluster, vserver]
Get multiple job records organized by node. This is just a performance optimization for job-get-iter that only searches for the job among the ones currently owned by the given node.Inputs
Outputs
[Family: vserver]
Get a single completed job entry. This is just a performance optimization for job-get.Inputs
Outputs
[Family: cluster, vserver]
Get multiple completed job records. This is just a performance optimization for job-get-iter.Inputs
Outputs
[Family: vserver]
Get a single job entry.Inputs
Outputs
[Family: cluster, vserver]
Get multiple job records.Inputs
Outputs
[Family: vserver]
Get a single job history event.Inputs
Outputs
[Family: cluster, vserver]
Get multiple job history records.Inputs
Outputs
[Family: vserver]
Pause a job. A job must be of a type that has job-type-is-pausible set to true before it may be paused. Once notified of a pause request, a job should stop performing work until it is subsequently resumed.Inputs
Outputs
[Family: cluster, vserver]
Pause a collection of jobs.Inputs
Outputs
[Family: vserver]
Get a single completed, private job entry. This is just a performance optimization for job-private-get.Inputs
Outputs
[Family: cluster, vserver]
Get multiple completed, private job records. This is just a performance optimization for job-private-get-iter.Inputs
Outputs
[Family: vserver]
Get a single private job entry.Inputs
Outputs
[Family: cluster, vserver]
Get multiple private job records.Inputs
Outputs
[Family: vserver]
Pause a private job.Inputs
Outputs
[Family: cluster, vserver]
Pause a collection of private jobs.Inputs
Outputs
[Family: vserver]
Resume a job.Inputs
Outputs
[Family: cluster, vserver]
Resume a collection of jobs.Inputs
Outputs
[Family: vserver]
Soft pause a private job.Inputs
Outputs
[Family: cluster, vserver]
Soft pause a collection of private jobs.Inputs
Outputs
[Family: vserver]
Stop a job.Inputs
Outputs
[Family: cluster, vserver]
Stop a collection of jobs.Inputs
Outputs
[Family: vserver]
Resume a job from the paused state.Inputs
Outputs
[Family: cluster, vserver]
Resume a collection of jobs.Inputs
Outputs
[Family: cluster]
Create a new cron job schedule entry.Inputs
Outputs
[Family: cluster]
Delete a single cron job schedule entry. The entry must not be in use.Inputs
Outputs
[Family: cluster]
Delete multiple cron job schedule entries. The entries must not be in use.Inputs
Outputs
[Family: cluster, vserver]
Get a single cron job schedule entry.Inputs
Outputs
[Family: cluster, vserver]
Get multiple cron job schedule entries.Inputs
Outputs
[Family: cluster]
Modify an existing cron job schedule entry.Inputs
Outputs
[Family: cluster, vserver]
Get a single job schedule entry.Inputs
Outputs
[Family: cluster, vserver]
Get multiple job schedule entries.Inputs
Outputs
[Family: cluster]
Create a new interval job schedule entry.Inputs
Outputs
[Family: cluster]
Delete a single interval job schedule entry. The entry must not be in use.Inputs
Outputs
[Family: cluster]
Delete multiple interval job schedule entries. The entries must not be in use.Inputs
Outputs
[Family: cluster, vserver]
Get a single interval job schedule entry.Inputs
Outputs
[Family: cluster, vserver]
Get multiple interval job schedule entries.Inputs
Outputs
[Family: cluster]
Modify an existing interval job schedule entry.Inputs
Outputs
[Family: vserver]
Soft pause a job. Indicates to the job that a soft pause has been initiated. It is up to the job to do what it needs to do for a soft pause. As a result of this command the job may request to be moved into the runnnable queue to perform further processing of the soft pause.Inputs
Outputs
[Family: cluster, vserver]
Soft pause a collection of jobs.Inputs
Outputs
[Family: vserver]
Stop a job. A job must be of a type that has job-type-is-quittable set to true before it may be stopped. job-stop attempts to stop a job that's currently running. If the job allows itself to stop it completes its current run. If the job has a recurring schedule it will transition to the Queued state; otherwise it will transition into either the Success or Failure state.Inputs
Outputs
[Family: cluster, vserver]
Stop a collection of jobs.Inputs
Outputs
[Family: vserver]
Get Kerberos configuration information for a LIF.Inputs
Outputs
[Family: cluster, vserver]
Get Kerberos configuration information for a group of LIFs.Inputs
Outputs
[Family: vserver]
Modify Kerberos configuration informaiton for a LIFInputs
Outputs
[Family: cluster]
Create a new Kerberos realm configuration.Inputs
Outputs
[Family: cluster]
Delete the Kerberos realm configuration.Inputs
Outputs
[Family: cluster]
Retrieve the list of Kerberos realm configurations.Inputs
Outputs
[Family: cluster]
Modify the Kerberos realm configuration.Inputs
Outputs
[Family: cluster]
Create a new Lightweight Directory Access Protocol (LDAP) client configuration for the cluster.Inputs
Outputs
[Family: cluster]
Delete an existing Lightweight Directory Access Protocol (LDAP) client configuration from the cluster.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of Lightweight Directory Access Protocol (LDAP) client configurations for the cluster.Inputs
Outputs
[Family: cluster]
Modify an existing Lightweight Directory Access Protocol (LDAP) client configuration.Inputs
Outputs
[Family: cluster]
Copy an existing LDAP schema. If the LDAP server that the storage system needs to query does not support any of the default read-only schemas, this API can be used to create an editable copy of an existing read-only schema. After copying the schema, the copy can be modified using the ldap-client-schema-modify API.Inputs
Outputs
[Family: cluster]
Delete an existing Lightweight Directory Access Protocol (LDAP) schema configuration. Only the schemas that are defined using the ldap-client-schema-copy API can be deleted using this API.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of Lightweight Directory Access Protocol (LDAP) client schema configurations that are defined for the cluster.Inputs
Outputs
[Family: cluster]
Modify an existing Lightweight Directory Access Protocol (LDAP) schema configuration. If the LDAP server that the storage system needs to query does not support any of the default read-only schemas, the ldap-client-schema-copy API can be used to create a editable copy of an existing read-only schema. After copying the schema, the copy can be modified using this API to support the target schema.Inputs
Outputs
[Family: vserver]
Create a new association between a Lightweight Directory Access Protocol (LDAP) client configuration and a Vserver. A Vserver can have only one client configuration associated with it.Inputs
Outputs
[Family: vserver]
Delete a Vserver's association with a Lightweight Directory Access Protocol (LDAP) configuration.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of Lightweight Directory Access Protocol (LDAP) configurations in the cluster.Inputs
Outputs
[Family: vserver]
Modify the Lightweight Directory Access Protocol (LDAP) configuration for a Vserver.Inputs
Outputs
[Family: cluster]
Add license for a Data ONTAP service.Inputs
Outputs
[Family: cluster]
Returns licenses that can be cleaned up. A license can be cleaned up if it's a demo license and its expiration time has passed (expired), or if it is a license for a controller that is no longer part of a cluster (unused). One can use the cleanup apis to remove these licenses together, or alternatively, they can use the standard license-remove api to remove them one at a time.Inputs
Outputs
[Family: cluster]
Removes license for a Data ONTAP service.Inputs
Outputs
[Family: cluster]
Remove licenses that have expired in the cluster.Inputs
Outputs
[Family: cluster]
Remove licenses that have no controller affiliation in the cluster.Inputs
Outputs
[Family: cluster]
Returns infomation for DATA ONTAP licenses.Inputs
Outputs
[Family: cluster]
Returns license status information for cluster mode packages.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of lun objects.Inputs
Outputs
[Family: vserver]
Clear the SCSI-2 reservation or SCSI-3 persistent reservation information for a given LUN. Note: In Data ONTAP Cluster-Mode, the LUN must either be offline or not mapped to clear the persistent reservation information.Inputs
Outputs
[Family: vserver]
Create a new lun of given size, with initially zero contents. The lun is created at the path given. No file should already exist at the given path. The directory specified in the path must be a qtree root directory. The size of the created lun could be larger than the size specified, in order to get an integral number of cylinders while reporting the geometry using SAN protocols.Inputs
Outputs
[Family: vserver]
Create a lun from an existing file. A new lun is created, at the given lun path (which must be at a qtree root). A hard link is created to the existing file. The file contents are not copied or changed. The file can be resized to a larger size, rounding up to a cylinder boundary.Inputs
Outputs
[Family: vserver]
Destroy the specified LUN. This operation will fail if the LUN is currently mapped and is online. The force option can be used to destroy it regardless of being online or mapped.Inputs
Outputs
[Family: vserver]
Get a named attribute for a given LUN.Inputs
Outputs
[Family: vserver]
Get named attributes for a given LUN.Inputs
Outputs
[Family: vserver]
Get the optional descriptive comment for a LUN.Inputs
Outputs
[Family: vserver]
Get SCSI disk geometry for a given LUN.Inputs
Outputs
[Family: vserver]
Get the SCSI INQUIRY response data for vendor id (vid), product id (pid), and firmware revision (rev) based on the igroup that the lun in question is mapped to.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of lun objects.Inputs
Outputs
[Family: vserver]
Returns the maximum possible size in bytes of a lun on a given volume or qtree. The user can pass the path to a volume or qtree in which the lun is to be created. This returns the maximum size for different types of luns and the possible maximum size with or without snapshot reserves.Inputs
Outputs
[Family: vserver]
Returns the minimum possible size in bytes. This returns the minimum size for different types of luns (based on the specified OS type). Space reservation does not affect the minimum lun size, thus only a single minimum size is returned.Inputs
Outputs
[Family: vserver]
Get the size occupied by the LUN in the active FS.Inputs
Outputs
[Family: vserver]
Get the persistent reservation information for a given LUN.Inputs
Outputs
[Family: vserver]
Get the select attribute for the specified LUN.Inputs
Outputs
[Family: vserver]
Get the serial number for the specified LUN. Prior to Data ONTAP 8.1 release, the serial number is a 12-character string formed of upper and lower-case letters, numbers, and slash (/) and hyphen (-) characters. Starting Data ONTAP 8.1 release, the serial number is a 12-character string formed of upper and lower-case letters, numbers, and the characters /-#$%&*+<=>?[!]^~@ .Inputs
Outputs
[Family: vserver]
Queries the space reservation settings for the named LUN.Inputs
Outputs
[Family: cluster, vserver]
Lookup a LUN path and storage system by serial number.Inputs
Outputs
[Family: vserver]
Queries for all types of scsi reservations covering both iSCSI and FCP.Inputs
Outputs
[Family: cluster, vserver]
List all the luns mapped to an initiatorInputs
Outputs
[Family: vserver]
Determine if an initiator is logged in via FCP or iSCSI.Inputs
Outputs
[Family: vserver]
Maps the LUN to all the initiators in the specified initiator group.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of LUN map detail objects.Inputs
Outputs
[Family: vserver]
Returns a list of initiator groups and their members (the initiators) mapped to the given LUN.Inputs
Outputs
[Family: vserver]
Move (rename) a LUN.Inputs
Outputs
[Family: vserver]
Disables block-protocol accesses to the LUN. Mappings, if any, configured for the lun are not altered. Note that unless explicitly offlined, a lun is online.Inputs
Outputs
[Family: vserver]
Re-enables block-protocol accesses to the lun.Inputs
Outputs
[Family: vserver]
Queries for all types of scsi reservations covering both iSCSI and FCP for a given initiator name. Initiator name can be FCP portname in case of FCP or ISCSI nodename for ISCSI.Inputs
Outputs
[Family: vserver]
Changes the size of the lun. Note that client-side operations may be needed to ensure that client software recognizes the changed size.Inputs
Outputs
[Family: vserver]
Set a named attribute for a given LUN. Attributes are arbitrary key/value pairs for application-defined use.Inputs
Outputs
[Family: vserver]
Set the optional descriptive comment for a LUN.Inputs
Outputs
[Family: vserver]
Set a SCSI peripheral device identifying information value on a LUN. In Data ONTAP 7-Mode, the value set will be returned in response to the vendor unique SCSI command GET DEV ID. In Data ONTAP Cluster-Mode, the value set will be returned in response to the SCSI command REPORT IDENTIFYING INFORMATION for the appropriate INFORMATION TYPE:Inputs
Outputs
[Family: vserver]
nullInputs
Outputs
[Family: vserver]
Set the select attribute for the specified LUN. The select attribute is used by mult-pathing software to discriminate between luns when mirrored or cloned copies of a vdisk are mapped to the same host.Inputs
Outputs
[Family: vserver]
Set the serial number for the specified LUN. The lun must first be made offline before changing the serial number. Prior to Data ONTAP 8.1 release, the serial number is a 12-character string formed of upper and lower-case letters, numbers, and slash (/) and hyphen (-) characters. Starting Data ONTAP 8.1 release, the serial number is a 12-character string formed of upper and lower-case letters, numbers, and the characters /-#$%&*+<=>?[!]^~@ .Inputs
Outputs
[Family: vserver]
Modify the attributes of lun object.Inputs
Outputs
[Family: vserver]
Sets the space reservation settings for the named LUN.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of lun objects.Inputs
Outputs
[Family: vserver]
Reverses the effect of lun-map on the specified LUN for the specified group.Inputs
Outputs
[Family: vserver]
Clear a named attribute for a given LUN.Inputs
Outputs
[Family: vserver]
Remove a SCSI peripheral device identifying information value from a LUN.Inputs
Outputs
[Family: vserver]
Create a new name mapping for a Vserver.Inputs
Outputs
[Family: vserver]
Delete an existing name mapping entry.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of name mappings in the cluster.Inputs
Outputs
[Family: vserver]
Insert a name mapping into the table at a specified position.Inputs
Outputs
[Family: vserver]
Modify an existing name mapping entry.Inputs
Outputs
[Family: vserver]
Swap the position of one name mapping with another. The position is the place in the sequence of name mappings in which the mappings are applied.Inputs
Outputs
[Family: vserver]
Add a user to a UNIX groupInputs
Outputs
[Family: vserver]
Create a new UNIX group.Inputs
Outputs
[Family: vserver]
Delete a user from a UNIX groupInputs
Outputs
[Family: vserver]
Destroy an existing UNIX group.Inputs
Outputs
[Family: vserver]
Get the attributes of a UNIX group.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of UNIX groups.Inputs
Outputs
[Family: vserver]
Modify the attributes of a UNIX group.Inputs
Outputs
[Family: vserver]
Create a new UNIX user.Inputs
Outputs
[Family: vserver]
Destroy an existing UNIX user.Inputs
Outputs
[Family: vserver]
Get the attributes of a UNIX user.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of UNIX users.Inputs
Outputs
[Family: vserver]
Modify the attributes of a UNIX user.Inputs
Outputs
[Family: vserver]
Generate NDMP password for the given user in a specific Vserver context. The generated NDMP password is based on the actual login password for the user; hence it should be regenerated whenever the actual user password is changed.Inputs
Outputs
[Family: cluster]
Ping an IP address to verify whether the interface is aliveInputs
Outputs
[Family: cluster]
Get the receive buffer size of a serviceInputs
Outputs
[Family: cluster]
Iterate over connections returning receive window sizeInputs
Outputs
[Family: cluster]
Modify a receive buffer sizeInputs
Outputs
[Family: cluster]
Iterate over a list of network device discovery objects found by a discovery protocol such as CDP or LLDP.Inputs
Outputs
[Family: vserver]
Creates DNS configuration for a VserverInputs
Outputs
[Family: vserver]
Get the DNS configuration of the VserverInputs
Outputs
[Family: cluster, vserver]
Iterate through DNS configurations of the clusterInputs
Outputs
[Family: vserver]
Modify the DNS configuration of the specified Vserver. Omitted (optional) fields will not be changed.Inputs
Outputs
[Family: cluster]
Get the attributes of a failover group.Inputs
Outputs
[Family: cluster]
Iterate over a list of failover group objects.Inputs
Outputs
[Family: vserver]
Create a new IP to host names mappingInputs
Outputs
[Family: vserver]
Delete an existing hosts object.Inputs
Outputs
[Family: vserver]
Given an IP address, return the corresponding IP to host names mapping of the running Vserver contextInputs
Outputs
[Family: cluster, vserver]
Iterate all IP to host name mappings (over all Vserver) of the clusterInputs
Outputs
[Family: vserver]
Given an IP address, modify the corresponding IP to host name mapping. Omitted (optional) fields will not be changed.Inputs
Outputs
[Family: cluster]
Create a new logical interface.Inputs
Outputs
[Family: cluster]
Destroy an existing network interface object.Inputs
Outputs
[Family: vserver]
Get the attributes of a network interface.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of network interface objects.Inputs
Outputs
[Family: cluster]
Migrate a Logical Interface between nodes and portsInputs
Outputs
[Family: cluster]
Modify the attributes of network interface object.Inputs
Outputs
[Family: cluster]
Modify the attributes of network interface or a group of network interface objects.Inputs
Outputs
[Family: cluster]
Revert a logical interface back to its home port following a deliberate migration or failover.Inputs
Outputs
[Family: cluster]
Get the attributes of the net.Inputs
Outputs
[Family: cluster]
Modify the attributes of net object.Inputs
Outputs
[Family: cluster]
Delete LIF placement cached information.Inputs
Outputs
[Family: cluster]
Iterate over the LIF placement cached information.Inputs
Outputs
[Family: cluster]
Find the ports direcly connected to the IP addressInputs
Outputs
[Family: cluster]
Get the attributes of a network port.Inputs
Outputs
[Family: cluster]
Iterate over a list of network port objects.Inputs
Outputs
[Family: cluster]
Add port to a network interface group.Inputs
Outputs
[Family: cluster]
Create a new network interface group.Inputs
Outputs
[Family: cluster]
Destroy an existing network interface group.Inputs
Outputs
[Family: cluster]
Get the attributes of a network interface group (ifgrp).Inputs
Outputs
[Family: cluster]
Remove port from a network interface group.Inputs
Outputs
[Family: cluster]
Modify the given attributes of network port and the rest remain unchanged.Inputs
Outputs
[Family: cluster]
Modify the attributes of network port or a group of network port objects.Inputs
Outputs
[Family: cluster]
Create a new network routing group route.Inputs
Outputs
[Family: cluster]
Destroy an existing network routing group route.Inputs
Outputs
[Family: vserver]
Get the attributes of a network routing group route.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of network routing group route.Inputs
Outputs
[Family: cluster]
Get the attributes of the SAN LIF Placement.Inputs
Outputs
[Family: cluster]
Create a new vlan interface. In Data ONTAP 7-Mode, changes made by this API are not persisted across system reboots. In Data ONTAP Cluster-Mode, changes made by this API are persisted across system reboots.Inputs
Outputs
[Family: cluster]
Delete a vlan interface. In Data ONTAP 7-Mode, changes made by this API are not persisted across system reboots. In Data ONTAP Cluster-Mode, changes made by this API are persisted across system reboots.Inputs
Outputs
[Family: cluster]
Get the attributes of a VLAN.Inputs
Outputs
[Family: cluster]
Iterate over a list of VLAN objects.Inputs
Outputs
[Family: vserver]
In Data ONTAP 7-Mode, this API will disable NFS server access (effectively same as the CLI command "nfs off") In Data ONTAP Cluster-Mode, this will stop the Vserver's NFS service. If the NFS service was not explicitly created, this API does nothing.Inputs
Outputs
[Family: vserver]
In Data ONTAP 7-Mode, this API will enable NFS server access (effectively same as the CLI command "nfs on") In Data ONTAP Cluster-Mode, this will start the Vserver's NFS service. If the NFS service was not explicitly created, this API will create one with default options.Inputs
Outputs
[Family: vserver]
Enables pathnames for mounting according to the rules specified. New rules for the pathnames take effect immediately, ignoring previous rules for specified pathnames. In the Data ONTAP 7-Mode, set the persistent option to true to save the rule in the etc/exports file and keep the option persistent upon loading or reboot whereas it must be true in Data ONTAP Cluster-Mode as the export entries are always persistent.Inputs
Outputs
[Family: vserver]
Enables pathnames for mounting according to the rules specified. New rules for the pathnames take effect immediately, ignoring previous rules for specified pathnames. In the Data ONTAP 7-Mode, set the persistent option to true to save the rule in the etc/exports file and keep the option persistent upon loading or reboot whereas it must be true in Data ONTAP Cluster-Mode as the export entries are always persistent. The new security-rule-info structure contains finer grained information about security rules than exports-rule-info.Inputs
Outputs
[Family: vserver]
Returns true if the host IP has mount permissions for a specified path.Inputs
Outputs
[Family: vserver]
Removes the rules for a set of pathnames. This returns an error if any of the pathnames don't have a rule. In the Data ONTAP 7-Mode, set the persistent option to modify the etc/exports file and keep this change persistent upon reboots whereas it must be true in Data ONTAP Cluster-Mode as the export entries are always persistent.Inputs
Outputs
[Family: vserver]
Returns the rules associated with exports. If a pathname is specified, the rules associated with the export matching that pathname, are returned; otherwise, rules for all exports are returned.Inputs
Outputs
[Family: vserver]
Returns the rules associated with exports, using the new security info structure. If a pathname is specified, the rules associated with the export matching that pathname, are returned; otherwise, rules for all exports are returned.Inputs
Outputs
[Family: vserver]
Functionally similar to append with the following caveats. Returns an error if the rule does not exist. Only works for one rule at a time.Inputs
Outputs
[Family: vserver]
Functionally similar to append-2 with the following caveats. Returns an error if the rule does not exist. Only works for one rule at a time.Inputs
Outputs
[Family: vserver]
Returns a list of currently supported security flavors. Hosts with permmisions and connecting via the proper security flavor have access to directories on the filer. Default security flavor for all exports is "sys".Inputs
Outputs
[Family: vserver]
Create a new NFS configuration.Inputs
Outputs
[Family: vserver]
Delete an NFS configuration.Inputs
Outputs
[Family: vserver]
Get the NFS server configuration.Inputs
Outputs
[Family: cluster, vserver]
Obtain the default values for NFS server configuration.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the list of NFS servers.Inputs
Outputs
[Family: vserver]
Modify an NFS configuration. If no values are given, the NFS configuration is not modified.Inputs
Outputs
[Family: vserver]
Returns the status of the NFS server.Inputs
Outputs
[Family: vserver]
Create an NIS domain configuration. Multiple NIS domains can be configured on a single Vserver, but only one NIS domain can be active at any given time.Inputs
Outputs
[Family: vserver]
Destroy an existing NIS configuration.Inputs
Outputs
[Family: vserver]
Get NIS domain configuration.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of NIS configurations.Inputs
Outputs
[Family: vserver]
Modify the attributes of NIS configuration.Inputs
Outputs
[Family: vserver]
Get the value of a single option.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of options objects.Inputs
Outputs
[Family: vserver]
Get a list of all optionsInputs
Outputs
[Family: cluster, vserver]
Modify the attributes of options or a group of options objects.Inputs
Outputs
[Family: vserver]
Set the value of a single option. For complete list of names and values of options, please refer to options man pages.Inputs
Outputs
[Family: cluster]
Display the current Performance Archive configurationInputs
Outputs
[Family: cluster]
Modify the current Performance Archive configurationInputs
Outputs
[Family: cluster]
Save a new Performance ArchiveInputs
Outputs
[Family: cluster]
Destroy a Performance ArchiveInputs
Outputs
[Family: cluster]
Iteratively get information about Performance ArchivesInputs
Outputs
[Family: cluster]
Modify properties of a Performance ArchiveInputs
Outputs
[Family: cluster]
Get information about the counters of an object. This information is static and independent of any particular instance of the object. It includes counter names and descriptions, as well as properties which are necessary to to interpret counter values.Inputs
Outputs
[Family: cluster]
Get a list of current counter values of instances of an object. This will return the values of all specified counters and instances of the specified object with one call. If the object is expected to have a large number of instances and/or counters, the iterator version of this API should be used.Inputs
Outputs
[Family: cluster]
Iterate over a list of perf objects.Inputs
Outputs
[Family: cluster]
Get list of performance objects in the system.Inputs
Outputs
[Family: cluster]
Create a single Performance Preset configuration and all of its detailsInputs
Outputs
[Family: cluster]
Delete a Performance Preset and all of its Preset DetailsInputs
Outputs
[Family: cluster]
Get detailed information about a single Performance Preset configurationInputs
Outputs
[Family: cluster]
Iteratively get information about Performance PresetsInputs
Outputs
[Family: cluster]
Modify a Performance PresetInputs
Outputs
[Family: vserver]
Add a port to an existing port setInputs
Outputs
[Family: vserver]
Create a port setInputs
Outputs
[Family: vserver]
Destroys an existing port set. By default a set cannot be destroyed if there are existing igroup associated with that portset.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of portset objects.Inputs
Outputs
[Family: vserver]
Removes a port from a port set.Inputs
Outputs
[Family: cluster]
Create a new policy. A unique name must be provided for the new policy, and a uuid will be returned. The policy will not affect any work until it is assigned to a workload. Therefore a workload referencing the policy should usually be created along with the policy.Inputs
Outputs
[Family: cluster]
Delete single policy. The policy may not be attached to any workloads. Only user defined policies may be deleted.Inputs
Outputs
[Family: cluster]
Delete multiple policies. The policies may not be attached to any workloads. Only user defined policies may be deleted.Inputs
Outputs
[Family: cluster]
Get the attributes of a policy.Inputs
Outputs
[Family: cluster]
Iterate over list of policies.Inputs
Outputs
[Family: cluster]
Create a policy group. A unique name must be provided for the new policy group. A QoS Policy group defines measurable Service Level Objectives (SLOs) that apply to the storage object with which the policy group is associated.Inputs
Outputs
[Family: cluster]
Delete single policy group. The default policy group may not be deleted. The policy group may not be attached to any workloads. Only user defined policy groups may be deleted.Inputs
Outputs
[Family: cluster]
Delete multiple policy groups.Inputs
Outputs
[Family: cluster]
Get the attributes of a policy group.Inputs
Outputs
[Family: cluster]
Iterate over list of policy groups.Inputs
Outputs
[Family: cluster]
Modify an existing policy group.Inputs
Outputs
[Family: cluster]
Modify multiple policy groupsInputs
Outputs
[Family: cluster]
Rename a QoS Policy GroupInputs
Outputs
[Family: cluster]
Modify an existing policy.Inputs
Outputs
[Family: cluster]
Modify multiple policiesInputs
Outputs
[Family: cluster]
Create a new read-ahead policy. A unique name must be provided for the new read-ahead policy. If the 'default' field is set to true, these become the default read-ahead settings for policies that don't otherwise name read-ahead settings. Unless creating a new default, creating read-ahead policies should usually be assigned to an existing QoS policy.Inputs
Outputs
[Family: cluster]
Delete single read-ahead policy. The default policy may not be deleted. The policy may not be attached to any workloads. Only user defined policies may be deleted.Inputs
Outputs
[Family: cluster]
Delete multiple read-ahead policies.Inputs
Outputs
[Family: cluster]
Get the attributes of a read-ahead policy.Inputs
Outputs
[Family: cluster]
Iterate over list of read-ahead policies.Inputs
Outputs
[Family: cluster]
Modify an existing read-ahead policy.Inputs
Outputs
[Family: cluster]
Modify multiple read-ahead policiesInputs
Outputs
[Family: cluster]
Get the cluster-wide QoS workload archival settings.Inputs
Outputs
[Family: cluster]
Modify the cluster-wide QoS workload archival settings.Inputs
Outputs
[Family: cluster]
Get the cluster-wide QoS control settings.Inputs
Outputs
[Family: cluster]
Modify the existing cluster-wide QoS control settings.Inputs
Outputs
[Family: cluster]
Create a new read-ahead setting. A unique name must be provided for the new read-ahead setting. If the 'default' field is set to true, these become the default read-ahead settings for settings that don't otherwise name read-ahead settings. Unless creating a new default, creating read-ahead settings should usually be assigned to an existing QoS setting.Inputs
Outputs
[Family: cluster]
Destroy single read-ahead setting. The default setting may not be destroyed. The setting may not be attached to any workloads. Only user defined settings may be destroyed.Inputs
Outputs
[Family: cluster]
Destroy multiple read-ahead settings.Inputs
Outputs
[Family: cluster]
Get the attributes of a read-ahead setting.Inputs
Outputs
[Family: cluster]
Iterate over list of read-ahead settings.Inputs
Outputs
[Family: cluster]
Modify an existing read-ahead setting.Inputs
Outputs
[Family: cluster]
Modify multiple read-ahead settingsInputs
Outputs
[Family: cluster]
Create a new stream. A workload uuid and stream properties must be provided, and a new stream-id is returned.Inputs
Outputs
[Family: cluster]
Delete single stream.Inputs
Outputs
[Family: cluster]
Delete multiple streams.Inputs
Outputs
[Family: cluster]
Get the attributes of a stream.Inputs
Outputs
[Family: cluster]
Iterate over list of streams.Inputs
Outputs
[Family: cluster]
Returns SMF error with ZAPI error codesInputs
Outputs
[Family: cluster]
Create a new workload. A unique name must be provided for the new workload, and a uuid is returned. Subsequent management operations should index workloads by uuid as the name may be modified. No work will be classified to a workload unless the workload has at least one stream. Therefore at least one stream should usually be created along with a workload. If the performance of the workload is to be controlled by QoS, a policy must also be defined and attached to the workload.Inputs
Outputs
[Family: cluster]
Delete a single workload. Only user defined workloads may be deleted.Inputs
Outputs
[Family: cluster]
Delete multiple workloads. Only user defined workloads may be deleted.Inputs
Outputs
[Family: cluster]
Delete single workload. This also deletes any streams attached to the workload. Only user defined workloads may be deleted.Inputs
Outputs
[Family: cluster]
Delete multiple workloads. This also deletes any streams attached to the workloads. Only user defined workloads may be deleted.Inputs
Outputs
[Family: cluster]
Get the attributes of a workload.Inputs
Outputs
[Family: cluster]
Iterate over list of workloads.Inputs
Outputs
[Family: cluster]
Modify an existing workload. This may be used to rename the workload, modify the workload's ID, its class, or its category.Inputs
Outputs
[Family: cluster]
Modify multiple workloadsInputs
Outputs
[Family: vserver]
Create a new qtree.Inputs
For unclustered volumes, if this argument is missing, use the value specified in the option "wafl.default_qtree_mode".
For clustered volumes, if this argument is missing, the permissions of the volume is used.
Outputs
[Family: vserver]
Delete the specified qtree.For unclustered volumes, use the quota management APIs to delete the quota rules that reference this qtree in the /etc/quotas file.
For clustered volumes, all the quota rules that reference this qtree will be automatically deleted.
Inputs
For clustered volumes, if the qtree has a large number of files, it is recommended that the qtree-delete-async API be used.
Outputs
[Family: vserver]
Delete the specified qtree by spawning a background job. The jobid will be returned. The progress of the job can be tracked using the job APIs. All the quota rules that reference this qtree will be automatically deleted.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the list of qtrees in the cluster.Inputs
Outputs
[Family: vserver]
Modify the attributes of a qtree. If values are not provided for any of the fields, then that field will not be modified.Inputs
Outputs
[Family: vserver]
Renames the specified qtree to a new name specified by "new-qtree-name".For unclustered volumes, if the qtree is referenced in the file /etc/exportfs, use NFS API nfs-exportfs-append-rules to modify the file so that the affected file system can be exported by the filer immediately. The "qtree-rename" command does not automatically update the /etc/exports file. Also, if the qtree is referenced in the file /etc/quotas, use the quota management APIs to delete and re-create the quota rule with the new qtree name.
For clustered volumes, the qtree name in the quota rules will be automatically updated with the new qtree name.
Inputs
Outputs
[Family: vserver]
Adds a quota entry. If the type, target, volume, and tree do not exist, a new entry is created. If the type, target, volume, and tree exist, then an error is returned.Inputs
Outputs
[Family: vserver]
Deletes a quota entry specified by type, target, volume, and tree.Inputs
Outputs
[Family: vserver]
Obtains a quota entry specified by type, target, volume, and tree.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the list of quota rules in the cluster.Inputs
Outputs
[Family: vserver]
Modifys a quota entry. If the type, target, volume, and tree exist, the entry is modified. If the type, target, volume, and tree do not exist, then an error is returned.Inputs
Outputs
[Family: vserver]
Turns the quota subsystem off for a volume.For clustered volumes, a jobid will also be returned. The progress of the job can be tracked using the job APIs.
Inputs
Outputs
[Family: vserver]
Starts to turn quotas on for a volume. A successful return from this API does not mean that quotas are on, merely that an attempt to start it has been triggered. Use the quota-status API to check the status.For clustered volumes, a jobid will also be returned. The progress of the job can be tracked using the job APIs.
Inputs
Outputs
[Family: cluster, vserver]
Iterate over the quota report in the cluster.Inputs
Outputs
[Family: vserver]
Starts an ONTAP operation to resize quotas for a volume. A successful return from this API does not mean that the operation has finished, merely that an attempt to start it been triggered. Use the quota-status API to check the status.For clustered volumes, a jobid will also be returned. The progress of the job can be tracked using the job APIs.
Inputs
Outputs
[Family: vserver]
Sets a quota entry. If the type, target, volume, and tree do not exist, a new entry is created. If the type, target, volume, and tree exist, then the entry is modified.Inputs
Outputs
[Family: vserver]
Obtains the status of quotasInputs
Outputs
[Family: cluster, vserver]
Iterate over quota status for all volumes in the clusterInputs
Outputs
[Family: vserver]
Creates a new Security trace entry.Inputs
Outputs
[Family: vserver]
Deletes the specified Security trace entry.Inputs
Outputs
[Family: cluster, vserver]
Gives information about one or more Security trace entries.Inputs
Outputs
[Family: vserver]
Modifies settings of a Security trace entry, even if it is in use.Inputs
Outputs
[Family: vserver]
Delete the specified security tracing event record.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of permission tracing results for the cluster.Inputs
Outputs
[Family: cluster]
Create a new user account associated the specified application and authentication method.Inputs
Outputs
[Family: cluster]
Delete an existing user account object.Inputs
Outputs
[Family: cluster]
Delete an existing user account or a group of user account objects.Inputs
Outputs
[Family: cluster]
Get the attributes of a user account.Inputs
Outputs
[Family: cluster]
Iterate over a list of user account objects.Inputs
Outputs
[Family: cluster]
Lock a user account that uses password as the authentication method. Returns an error if the user account does not use password authentication.Inputs
Outputs
[Family: cluster]
Modify the attributes of a user account object. Omitted (optional) fields will not be changed.Inputs
Outputs
[Family: cluster]
Modify the attributes of a user account or a group of user account objects.Inputs
Outputs
[Family: vserver]
Changes the password of a specified user.Inputs
Outputs
[Family: cluster]
Get the attributes of a role configuration.Inputs
Outputs
[Family: cluster]
Iterate over a list of role objects.Inputs
Outputs
[Family: cluster]
Modify the specified attributes of role configuration object. Omitted (optional) fields will not be changed.Inputs
Outputs
[Family: cluster]
Modify the attributes of role configuration or a group of role configuration objects.Inputs
Outputs
[Family: cluster]
Create a new user role.Inputs
Outputs
[Family: cluster]
Delete an existing user role object.Inputs
Outputs
[Family: cluster]
Delete an existing user role or a group of user role objects.Inputs
Outputs
[Family: cluster]
Get the attributes of a user role.Inputs
Outputs
[Family: cluster]
Iterate over a list of user role objects.Inputs
Outputs
[Family: cluster]
Modify the attributes of user role object. Omitted (optional) fields will not be changed.Inputs
Outputs
[Family: cluster]
Modify the attributes of user role or a group of user role objects.Inputs
Outputs
[Family: cluster]
Unlock a user account that uses password as the authentication method. Returns an error if the user account does not use password authentication.Inputs
Outputs
[Family: cluster, vserver]
Adds the input algorithms and ciphers to the SSH configuration. Existing algorithms and ciphers remain in the configuration. API will succeed if requested algorithm or cipher is not currently enabled in the configuration.Inputs
Outputs
[Family: cluster, vserver]
Display SSH configuration optionsInputs
Outputs
[Family: cluster, vserver]
Removes the input algorithms and ciphers from the SSH configuration. API will succeed if requested algorithm or cipher is already currently enabled in the configuration.Inputs
Outputs
[Family: vserver]
Enable and replace SSH configuration options to this new settingInputs
Outputs
[Family: vserver]
Get the attributes of the security-certificate-ca-issued.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of security-certificate-ca-issued objects.Inputs
Outputs
[Family: cluster, vserver]
If a certificate is created with the existing Common Name then a new certificate is generated with a different serial numberInputs
Possible values:
Possible values:
Possible values:
Outputs
[Family: cluster, vserver]
Delete an existing security-certificate object.Inputs
Possible values:
Outputs
[Family: cluster, vserver]
Delete an existing security-certificate or a group of security-certificate objects.Inputs
Outputs
[Family: cluster]
Iterate over a list of security-certificate-file objects.Inputs
Outputs
[Family: cluster, vserver]
Generate a digital certificate signing request(CSR)Inputs
Possible values:
Possible values:
Outputs
[Family: vserver]
Get the attributes of the security-certificate.Inputs
Possible values:
Outputs
[Family: cluster, vserver]
Iterate over a list of security-certificate objects.Inputs
Outputs
[Family: cluster, vserver]
Install a digital certificateInputs
Possible values:
Outputs
[Family: cluster, vserver]
Revoke a digital certificateInputs
Outputs
[Family: cluster, vserver]
Sign a certificate using self-signed root CAInputs
Possible values:
Possible values:
Outputs
[Family: vserver]
Get the attributes of SSL securityInputs
Outputs
[Family: cluster, vserver]
Get the attributes of SSL securityInputs
Outputs
[Family: cluster, vserver]
Modify SSL authentication for a Vserver. Only field(s) that are provided will be modified.Inputs
Outputs
[Family: cluster]
Get basic information about the deviceInputs
Outputs
[Family: cluster]
Get information about installed firmware imagesInputs
Outputs
[Family: cluster]
Enable or disable automatic firmware updateInputs
Outputs
[Family: cluster]
Install new firmware imageInputs
Outputs
[Family: cluster]
Get firmware update progressInputs
Outputs
[Family: cluster]
Get the network configurationInputs
Outputs
[Family: cluster]
Modify the network configurationInputs
Outputs
[Family: cluster]
Reboot the Service ProcessorInputs
Outputs
[Family: cluster]
Returns information about storage shelf bays and ports for a selected number of shelves, or optionally all shelves connected to the storage controller.Inputs
Outputs
[Family: cluster]
Returns the environmental information for a selected number of shelves, or optionally all shelves connected to the storage controller.Inputs
Outputs
[Family: cluster]
This returns information about an identified shelf. The information is the number of bays present (bay-count), and which shelf bays have drives (bay-list). Shelf bays are numbered from 0 to bay-count minus 1. Shelf bay 0 is always on the right when looking at the front of the shelf. Incidentally, the bay-list may be empty indicating the absence of any drives. However, there are some shelf designs which require a disk drive in bay 0 or 1 for any SES functionality to operate (e.g., DS14 and DS14-Mk2-FC). In these cases, shelves without drives in bay 0 or 1 will not be listed.Inputs
Outputs
[Family: cluster]
This interface returns information about one or more shelves.Inputs
Outputs
[Family: vserver]
Disable sis on a volume. If the sis operation is active on the volume, it needs to be stopped by "sis-stop" API before disabling.This API is not supported for Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Disable sis on an Infinite Volume. If the sis operation is active on the Infinite Volume, it needs to be stopped by "sis-stop-async" API before disabling.This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents or Infinite Volumes that are managed by storage services.
Inputs
Outputs
[Family: vserver]
Enable sis on a volume.On a non-SnapVault secondary volume, the sis operation will be started periodically according to a per-volume schedule. By default, this schedule is sun-sat@0. (Everyday at 0:00 hours) On a SnapVault secondary volume, the sis operation will be kicked off at the end of the SnapVault transfer. This API does not enable compression on the volume. See the "sis-set-config" API for options to enable compression and for modifying the default schedule set on the volume. A sis operation can also be manually started using the sis-start API.
This API is not supported for Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Enable sis on an Infinite Volume.This is similar to 'sis-enable' API except that it operates on an Infinite Volume. Read about 'sis-enable' API for specific details.
This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents or Infinite Volumes that are managed by storage services.
Inputs
Outputs
[Family: vserver]
Get status of a sis volume.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of sis volumes.Inputs
Outputs
[Family: vserver]
Create a new sis policy.Inputs
Outputs
[Family: vserver]
Delete a sis policy.Inputs
Outputs
[Family: vserver]
Get attributes of a sis policy.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of sis policy objects.Inputs
Outputs
[Family: vserver]
Modify the attributes of a sis policy.Inputs
Outputs
[Family: vserver]
Setup or modify sis policy, schedule or options for a volume.This API is not supported for Infinite Volumes.
Inputs
The format of the schedule:
day_list[@hour_list] or hour_list[@day_list] or - or auto or manual
The day_list specifies which days of the week the sis operation should run. It is a comma-separated list of the first three letters of the day: sun, mon, tue, wed, thu, fri, sat. The names are not case sensitive. Day ranges such as mon-fri can also be given. The default day_list is sun-sat.
The hour_list specifies which hours of the day the sis operation should run on each scheduled day. The hour_list is a comma-separated list of the integers from 0 to 23. Hour ranges such as 8-17 are allowed. Step values can be used in conjunction with ranges. For example, 0-23/2 means "every two hours". The default hour_list is 0, i.e. midnight on the morning of each scheduled day.
If "-" is specified, no schedule is set. In Data ONTAP Cluster-Mode, policy-name and schedule must not be specified together in the same API call. If schedule is passed, any previous policy-name set on the volume is automatically reset.
The "auto" schedule string means the sis operation will be triggered by the amount of new data written to the volume. The criterion is subject to being changed later.
The "manual" schedule string prevents SIS from automatically triggering any operations and disables change-logging. This schedule string can only be used on SnapVault destination volumes. The use of this schedule is mainly desirable when inline compression is enabled on a SnapVault destination volume and background processing is not necessary.
Outputs
[Family: vserver]
Setup or modify sis policy, schedule or options for an Infinite Volume.This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents or Infinite Volumes that are managed by storage services.
Inputs
The format of the schedule:
day_list[@hour_list] or hour_list[@day_list] or - or auto or manual
The day_list specifies which days of the week the sis operation should run. It is a comma-separated list of the first three letters of the day: sun, mon, tue, wed, thu, fri, sat. The names are not case sensitive. Day ranges such as mon-fri can also be given. The default day_list is sun-sat.
The hour_list specifies which hours of the day the sis operation should run on each scheduled day. The hour_list is a comma-separated list of the integers from 0 to 23. Hour ranges such as 8-17 are allowed. Step values can be used in conjunction with ranges. For example, 0-23/2 means "every two hours". The default hour_list is 0, i.e. midnight on the morning of each scheduled day.
If "-" is specified, no schedule is set. In Data ONTAP Cluster-Mode, policy-name and schedule must not be specified together in the same API call. If schedule is passed, any previous policy-name set on the Infinite Volume is automatically reset.
The "auto" schedule string means the sis operation will be triggered by the amount of new data written to the Infinite Volume. The criterion is subject to being changed later.
If "manual" is specified, sis operation will never be triggered automatically. Only the user can manually execute the sis operation.
Outputs
[Family: vserver]
Start a sis operation on a volume. The volume must have sis enabled, before starting a sis operation. If the sis operation is already active on the volume, this API will fail.This API is not supported for Infinite Volumes.
Inputs
The scan will include whatever is enabled on the volume. For example: If compression is not enabled on the volume, the scan will not include compression. This default behavior can be changed by using the run-dedupe-scan and run-compression-scan parameters.
If scan is false only data added since the last sis operation will be processed. Default Value: "false"
Outputs
[Family: vserver]
Start a sis operation on an Infinite Volume. The Infinite Volume must have sis enabled, before starting a sis operation. If the sis operation is already active on the Infinite Volume, this API will fail.This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents or Infinite Volumes that are managed by storage services.
Inputs
The scan will include whatever is enabled on the Infinite Volume. For example: If compression is not enabled on the Infinite Volume, the scan will not include compression. This default behavior can be changed by using the run-dedupe-scan and run-compression-scan parameters.
If scan is false only data added since the last sis operation will be processed. Default value: "false"
Outputs
[Family: cluster, vserver]
Get Status of a sis volume This API is not optimal for use in Data ONTAP Cluster-Mode systems, and is deprecated. Use sis-get and sis-get-iter APIs for Data ONTAP Cluster Mode systems. This API is still supported for Data ONTAP 7-Mode systems.Inputs
Outputs
[Family: vserver]
Abort currently active sis operation on the volume. The sis operation will remain paused and the operation can be resumed by "sis-start", SnapVault transfer, or the scheduler.This API is not supported for Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Abort currently active sis operation on the Infinite Volume. The sis operation will remain paused and the operation can be resumed by "sis-start-async" or the scheduler.This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents or Infinite Volumes that are managed by storage services.
Inputs
Outputs
[Family: cluster]
The snapmirror-abort API stops ongoing transfers for a SnapMirror relationship. The relationship is identified by its destination endpoint. You must specify the destination endpoint when using snapmirror-abort. On Data ONTAP Cluster-Mode, the snapmirror-abort API stops all of the active transfers to each associated volume on the receiving side in a set of load-sharing mirrors. Load-sharing mirrors are either up to date and serving data to clients, or they are lagging and not serving data to clients. If the snapmirror-abort API identifies an up-to-date load-sharing mirror, then SnapMirror transfers to associated up-to-date load-sharing mirrors in the set of load-sharing mirrors are also aborted. If the snapmirror-abort API identifies a lagging load-sharing mirror, then only the SnapMirror transfer associated with the lagging load-sharing mirror is aborted. After the snapmirror-abort API successfully completes its operation, the volume on the receiving side of the transfer might contain a restart checkpoint. The restart checkpoint can be used by a subsequent transfer to restart and continue the aborted SnapMirror transfer. Snapmirror-abort API must be used from the destination filer on Data ONTAP 7-Mode, and from the destination cluster on Data ONTAP Cluster-Mode.This API is not supported if the destination end point is an Infinite Volume.
Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-abort-async API stops ongoing transfer for a SnapMirror relationship on Infinite Volume. The relationship is identified by its destination endpoint. You must specify the destination endpoint when using the snapmirror-abort-async API. After the snapmirror-abort-async API successfully aborted the transfer, the volume on the receiving side of the transfer might contain a restart checkpoint. The restart checkpoint can be used by a subsequent transfer to restart and continue the aborted SnapMirror transfer. Snapmirror-abort-async API must be used from the destination cluster on Data ONTAP Cluster-Mode. This API is not supported if the destination end point is a flexible volume or an Infinite Volume constituent. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
The snapmirror-abort-iter API aborts SnapMirror transfers for one or more SnapMirror relationships. This API is not supported on Infinite Volume constituents.Inputs
Outputs
[Family: cluster]
Breaks a SnapMirror relationship between a source and destination volume of a data protection mirror. When Data ONTAP breaks the relationship, the destination volume is made a read-write volume and can diverge from the source volume, client redirection is turned off on the destination volume, the restart checkpoint is cleared, and the clients can see the latest Snapshot copy. On Data ONTAP 7-Mode, no check to determined whether the operation is legal or successful is done. You need to query the status afterward by using the snapmirror-get-status API. Subsequent manual or scheduled SnapMirror updates to the broken relationship will fail until the SnapMirror relationship is re-established using the snapmirror-resync API. On Data ONTAP Cluster-Mode, this API applies only to data protection mirrors and not to load-sharing mirrors. The snapmirror-break API must be issued on destination filer on Data ONTAP 7-Mode, and on the destination cluster on Data ONTAP Cluster-Mode.This API is not supported if the destination end point is an Infinite Volume.
Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-break-async API breaks an Infinite Volume SnapMirror relationship between a source and destination volume of a data protection mirror. When Data ONTAP breaks the relationship, the destination volume is made a read-write volume and can diverge from the source volume, client redirection is turned off on the destination volume, the restart checkpoint is cleared, and the clients can see the latest Snapshot copy. You must specify the destination endpoint when using snapmirror-break-async. Subsequent manual or scheduled SnapMirror updates to the broken relationship will fail until the SnapMirror relationship is reestablished using the snapmirror-resync API. This API applies only to data protection mirrors for Infinite Volume. You must use the snapmirror-break-async API from the destination cluster. This API is not supported on Infinite Volume constituents. This API is not supported if the destination end point is a flexible volume. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
The snapmirror-break-iter API breaks one or more SnapMirror relationships.Inputs
Outputs
[Family: cluster]
The snapmirror-check API starts an operation to compare the contents of a snapshot between the source volume and destination volume. You must specify the destination endpoint when using snapmirror-check. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
The snapmirror-check-iter API checks one or more SnapMirror relationships. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
The snapmirror-create API creates a SnapMirror relationship between a source and destination volume. You can create either a load-sharing relationship or a data protection relationship using this API. You must specify the source endpoint and destination endpoint when using snapmirror-create. Before you can use this command you should have created a source and destination volume using the volume create command. The source volume should be in the online state and a read-write (RW) type. The destination volume should be in the online state and a data protection (DP) type. Note: The source volume might contain data and Snapshot copies prior to creating the Snapmirror relationship. If the destination volume is not empty, it must have a Snapshot copy in common with the source volume, that is, it must have once been a copy of the source volume. You must also take the volume style into consideration when creating SnapMirror relationships. Source and destination volumes might be required to be either both regular volumes or both striped volumes. Striped volumes might have the further restriction of requiring the same striping geometry on both the source and destination volume, and restriping volumes might be disallowed. Load-sharing mirrors have the following restrictions: They only use regular style volumes, no striped volumes. They are confined to a single Vserver; they are not allowed to span Vservers. A set of load-sharing mirrors can have one or more destination volumes. You create separate SnapMirror relationships between the common source volume and each destination volume to create the set of load-sharing mirrors. If the optional schedule is specified, the destination volume is initialized on the first scheduled update. The destination volume can also be initialized using the snapmirror-initialize API and the destination volumes in a set of load-sharing mirrors are initialized using the snapmirror-initialize-ls-set API. The snapmirror-create API must be used from the destination cluster.Inputs
Outputs
[Family: cluster]
The snapmirror-destroy API removes only the SnapMirror relationship of a source volume and a destination flexVols, the volumes are not destroyed and Snapshot copies on the volumes are not removed. You must specify the destination endpoint when using snapmirror-destroy. The snapmirror-destroy API fails if a SnapMirror transfer for the SnapMirror relationship is in progress. A set of load-sharing mirrors might contain multiple destination volumes, each destination volume having a separate SnapMirror relationship with the common source volume. When used on one of the SnapMirror relationships from the set of load-sharing mirrors, the snapmirror-destroy API deletes the specified SnapMirror relationship from the set of load-sharing mirrors. The snapmirror-destroy API preserves the read-write or read-only attributes of the volumes of a SnapMirror relationship after the relationship is deleted. Therefore, a read-write volume that was the source of a SnapMirror relationship retains its read-write attributes, and a data protection volume or a load-sharing volume that was a destination of a SnapMirror relationship retains its read-only attributes. Note: When a SnapMirror relationship from a set of load-sharing mirrors is deleted, the destination volume becomes a data protection volume and retains the read-only attributes of a data protection volume. You can use this API from the source or from the destination cluster. When used from the destination cluster, the SnapMirror relationship information on the source and destination clusters is deleted. When used from the source cluster, only the SnapMirror relationship information on the source cluster is deleted. Note: If the relationship does not exist, this API will return success. This API is not supported if the destination end point is a Infinite Volume.Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-destroy-async API removes only the SnapMirror relationship of a source and a destination Infinite Volume, the volumes are not destroyed and Snapshot copies on the volumes are not removed. You must specify the destination endpoint when using snapmirror-destroy-async. The snapmirror-destroy-async API fails if a SnapMirror transfer for the SnapMirror relationship is in progress. The snapmirror-destroy-async API preserves the read-write or read-only attributes of the volumes of a SnapMirror relationship after the relationship is deleted. Therefore, a read-write volume that was the source of a SnapMirror relationship retains its read-write attributes, and a data protection volume that was a destination of a SnapMirror relationship retains its read-only attributes. The snapmirror-destroy-async API should be used from the destination cluster. When used in this fashion, the destination-side information will be cleaned up. The destination will also attempt to cleanup source-side information. If the source cluster is not available, the destination-side information will still be cleaned up. This API is not supported if the destination end point is a flexible volume or an Infinite Volume constituent. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
Removes one or a group of SnapMirror relationships. This API is not supported on Infinite Volume constituents.Inputs
Outputs
[Family: cluster]
Get the attributes of a SnapMirror relationship. You must specify the destination endpoint when using snapmirror-get.Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-get-destination API returns information about a SnapMirror relationship whose source endpoint is on the cluster or Vserver it is issued on. The destination endpoint must be specified when using this API. The source endpoint can also be specified.The cluster or Vserver may have several entries for the specified endpoints, but with different relationship IDs. In this case the API returns information about the first entry. To get information about all the SnapMirror relationships matching the specified endpoints, the snapmirror-get-destination-iter API must be used.
Note that the information for a SnapMirror relationship will not be available on its source Vserver or source cluster until at least one transfer is initiated.
The information returned can be stale. Stale information corresponds to a SnapMirror relationship that has been deleted on its destination cluster or Vserver.
This API is only supported on Data ONTAP 8.2 and above operating in Cluster-Mode.
This API must be issued on the source Vserver or the source cluster of the relationship.
Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-get-destination-iter API returns information about, one or more SnapMirror relationships whose source endpoints are in the Vserver or the cluster the API is issued on.The information returned can be stale. Stale information corresponds to a SnapMirror relationship that has been deleted on its destination cluster or Vserver. Stale information may result to several entries being returned with the same source and destination endpoints, but with different relationship IDs.
Note that the information for a SnapMirror relationship will not be available on its source Vserver or source cluster until at least one transfer is initiated.
This API is only supported on Data ONTAP 8.2 and above operating in Cluster-Mode. It can be issued on a Vserver or a Cluster.
Inputs
Outputs
[Family: cluster]
Iterate over a list of SnapMirror relationships.Inputs
Outputs
[Family: cluster]
Obtain the total number of SnapMirror relationships. This is a point in time estimate and may be different on subsequent calls.Inputs
Outputs
[Family: cluster]
Returns SnapMirror status values for a given volume. Including whether: the volume is a source of a SnapMirror relationship; the volume is a destination of a SnapMirror relationship; a transfer is in progress; the relationship is broken off. On Data ONTAP Cluster-Mode, this API is provided for backward compatibility only. It will fail if the volume is the source or destination of a non Data Protection (DP) SnapMirror relationship. On Data ONTAP Cluster-Mode, this API must be issued on the cluster the volume belongs to.Inputs
Outputs
[Family: cluster]
Performs the initial update of a SnapMirror relationship. You must specify the destination endpoint when using snapmirror-initialize. This API must be used from the destination filer on Data ONTAP 7-Mode, or from the destination cluster on Data ONTAP Cluster-Mode. On Data ONTAP 7-Mode, If the destination endpoint is a volume, the volume must be in the restricted state. If the destination endpoint is a qtree, the qtree must not already exist. On Data ONTAP Cluster-Mode, this API is usually used after the snapmirror-create API, but it can be used alone, that is, without the snapmirror-create API, to create and initially update a SnapMirror relationship. A job will be spawned to operate on the SnapMirror relationship, and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
The snapmirror-initialize-iter API initializes the destination volume of one or more SnapMirror relationships. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
The snapmirror-initialize-ls-set API performs the initial manual update of a set of load-sharing mirrors. This API is usually used after the snapmirror-create API is used to create a SnapMirror relationship for each of the destination volumes in the set of load-sharing mirrors. You must specify the source endpoint when using snapmirror-initialize-ls-set. Data and Snapshot copies are transferred from the source volume to all up-to-date destination volumes in the set of load-sharing mirrors. Use the snapmirror-initialize API to add and initialize a new destination volume to an existing set of load-sharing mirrors. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
The snapmirror-modify API allows you to change one or more parameters of a SnapMirror relationship. The key parameter that identifies any SnapMirror relationship is the destination volume. You must specify the destination endpoint when using snapmirror-modify. For load-sharing mirrors, a change to a parameter affects all of the SnapMirror relationships in the set of load-sharing mirrors. Destination volumes in a set of load-sharing mirrors do not have individual parameter settings. Changes made by the snapmirror-modify API do not take effect until the next manual or scheduled update of the SnapMirror relationship. Changes do not affect updates that have started and have not finished yet. The snapmirror-modify API must be used from the destination cluster. This API is not supported on Infinite Volume constituents.Inputs
Outputs
[Family: cluster]
The snapmirror-modify-iter API allows you to change one or more parameters of one or more SnapMirror relationships. This API is not supported on Infinite Volume constituents.Inputs
Outputs
[Family: cluster]
The snapmirror-promote API performs a failover to the destination volume of a load-sharing SnapMirror relationship. This API changes the destination volume from a load-sharing volume to a read-write volume and makes the destination volume assume the identity of the source volume. The API then destroys the original source volume. The destination volume must be a load-sharing volume. However, you can still perform 'snapmirror-promote' on a destination load-sharing volume that has been left in read-write state by a previously failed promote operation. You must specify the destination endpoint when using snapmirror-promote. Note: The source volume and destination volume must be on the same Vserver for the promote to work. Client accesses are redirected from the original source volume to the promoted destination volume. The view clients see on the promoted destination volume is the latest transferred Snapshot copy, which might lag behind the view clients had of the original source volume before the promote. The SnapMirror relationship is usually deleted as part of the promotion process. This is not true for a set of load-sharing mirrors that contain more than one destination volume. In this case, the promoted destination volume becomes the new source volume to the set of load-sharing mirrors. It is possible that the original source volume is the source of multiple SnapMirror relationships. For such a configuration, the promoted destination volume becomes the new source volume of the other SnapMirror relationships. The snapmirror-promote API fails if a SnapMirror transfer is in progress for any SnapMirror relationship involving the original source volume.Inputs
Outputs
[Family: cluster]
The snapmirror-promote-iter API performs failover for one or more SnapMirror relationships.Inputs
Outputs
[Family: cluster]
Disables future transfers to a SnapMirror destination. If there is no transfer in progress, the SnapMirror relationship becomes 'Quiesced'. If there is a transfer in progress, the SnapMirror relationship becomes 'Quiescing' until the transfer completes. If the current transfer aborts, it will be treated like a future transfer and will not restart. When a SnapMirror relationship is quiesced, it remains in that state across reboots and fail-overs. The relationship must exist on the destination and you must specify the destination endpoint when using snapmirror-quiesce. On Data ONTAP Cluster-Mode, if applied to a load-sharing (LS) SnapMirror relationship, all the relationships in the set will be quiesced. This API must be issued on the destination filer on Data ONTAP 7-Mode, and on the destination cluster on Data ONTAP Cluster-Mode.Inputs
Outputs
[Family: cluster, vserver]
Disables future transfers for one or more SnapMirror relationships.Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-release API removes a SnapMirror relationship on the source endpoint. It unlocks and cleanups the snapshots pertaining to the relationship. It does not destroy any volume. You must specify the destination endpoint when using snapmirror-release. Unless relationship-info-only is specified, this operation will fail if it is unable to reach the source volume and clean up snapshots. On Data ONTAP 8.2 or later operating in Cluster-Mode, this API must be executed on the source Vserver or source cluster following the deletion of the relationship on the destination Vserver or destination cluster. It is possible to issue snapmirror-release on the source Vserver without deleting the relationship on the destination Vserver. However, the relationship will continue to exist because the destination is the authority. The relationship will reappear on the source on the next transfer. On Data ONTAP operating in 7-Mode, this API must be issued on the source storage system. On Data ONTAP 8.2 or later operating in Cluster-Mode, this API must be issued on the source Vserver if operating in Vserver context and on the source cluster if operating in a cluster context. This API is not supported on Data ONTAP 8.1 operating in Cluster-Mode, or Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.Inputs
Outputs
[Family: cluster, vserver]
releases one or a group of SnapMirror relationships.Inputs
Outputs
[Family: cluster, vserver]
The snapmirror-restore API restores the contents of a selected Snapshot copy from the source volume to the active file system of the destination volume. The destination volume is read write after the data is restored. The snapmirror-restore API creates a temporary SnapMirror relationship of the type RST. For this reason the destination volume cannot be the destination volume of another SnapMirror relationship. The temporary RST relationship is deleted after the operation completes successfully. If the destination volume is an empty data protection volume, the snapmirror-restore API performs a baseline restore. The baseline restore transfers the contents of the selected Snapshot copy from the source volume to the destination volume. If the destination volume is read-write and has at least one Snapshot which also appears on the source volume, an incremental restore is performed. The destination volume is made read only, if is not already read only. When the destination volume is made read only the latest snapshot on destination volume is made the exported snapshot. Note, that any data written to the destination volume since the last snapshot is lost during this operation. To save the contents of the active file system on the destination volume, stop all client access and take a snapshot before starting this operation. During an incremental restore a common Snapshot copy is selected. The snapshot chosen as the common snapshot must be on the source and destination volumes. The contents of the common Snapshot copy on the destination volume are copied to the active file system of the destination volume. Then the contents of the Snapshot copy to be restored are transferred from the source volume to the destination volume. Unless 'source-snapshot' is specified the most recent Snapshot copy on the source volume is restored. This API may be used to restart a failed snapmirror-restore operation. This API may be used to terminate an aborted or failed snapmirror-restore operation by specifying the 'clean-up-failure' parameter set to 'true'. Terminating an aborted or failed snapmirror-restore operation deletes any residual temporary RST relationship and converts the destination volume back to read-write if the destination volume was read-write prior to initial snapmirror-restore operation while removing any data transferred or copied during the snapmirror-restore operation. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
Enables future transfers for a SnapMirror relationship that has been quiesced. If there is a scheduled transfer, it will be triggered on the next schedule. If there is a restart checkpoint, it will be re-used if possible. On Data ONTAP Cluster-Mode, If applied on a load-sharing SnapMirror relationship, transfers will resume for all the relationships of the set. When a quiesced SnapMirror relationship is resumed, it remains in that state across reboots and fail-overs. The relationship must exist on the destination and you must specify the destination end point when using snapmirror-resume. This API must be issued on the destination filer on Data ONTAP 7-Mode, and on the destination cluster on Data ONTAP Cluster-Mode.Inputs
Outputs
[Family: cluster, vserver]
Enables future transfers for one or more SnapMirror relationships.Inputs
Outputs
[Family: cluster]
Re-establishes a mirroring relationship between a source volume and a destination volume, typically in the following cases:Inputs
Outputs
[Family: cluster]
The snapmirror-resync-iter API reestablishes one or more previously broken SnapMirror relationships. This API is not supported on Infinite Volume constituents. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: vserver]
Add an owner to preserve a Snapshot copy for a SnapMirror mirror-to-vault cascade configuration.Inputs
Outputs
[Family: vserver]
Delete an owner used to preserve a Snapshot copy for a SnapMirror mirror-to-vault cascade configuration.Inputs
Outputs
[Family: cluster, vserver]
List all owners used to preserve a Snapshot copy for a SnapMirror mirror-to-vault cascade configuration.Inputs
Outputs
[Family: cluster, vserver]
List all Snapshot copies that are preserved for a SnapMirror mirror-to-vault cascade configuration.Inputs
Outputs
[Family: cluster]
Updates the destination endpoint of the SnapMirror relationship. The update is asynchronously handled, and there is no guarantee that it will succeed. On Data ONTAP 7-Mode the snapmirror-get-status API can be used to check the status of the update. The API must be issued on the destination filer. On Data ONTAP Cluster-Mode a job is spawned to operate on the SnapMirror relationship and the job id is returned. The progress of the job can be tracked using the job APIs. You must specify the destination endpoint when using snapmirror-update. The API makes the destination volume an up-to-date mirror of the source volume. This API must be used from the destination filer on Data ONTAP 7-Mode, or from the destination cluster on Data ONTAP Cluster-Mode. On Data ONTAP 7-Mode, if the destination endpoint is a volume, the volume must be in the restricted state. If the destination endpoint is a qtree, the qtree must not already exist. On Data ONTAP Cluster-Mode if the destination volume is empty, the snapmirror-update API will fail. The snapmirror-initialize API must be called to perform the baseline transfer before the the snapmirror-update can be called. If the destination volume is not empty, the snapmirror-update API performs an incremental transfer. During an incremental transfer, Data ONTAP takes a Snapshot copy on the source volume to capture the current image of the source volume, finds the most recent common Snapshot copy between the source and destination volumes, and incrementally transfers Snapshot copies that are newer than the common Snapshot copy to the destination volume. After the snapmirror-update API successfully completes, the last Snapshot copy transferred is made the new exported Snapshot copy on the destination volume. If the snapmirror-update does not finish successfully, due to a network failure or because a snapmirror-abort API was issued for example, a restart checkpoint might be recorded on the destination volume. If a restart checkpoint is recorded, the next update restarts and continues the transfer from the restart checkpoint. On Data ONTAP Cluster-Mode you can use the snapmirror-update API to update a specific load-sharing mirror that lags behind up-to-date destination volumes in the set of load-sharing mirrors. An update to the lagging load-sharing mirror should bring it up to date with the other up-to-date destination volumes in the set of load-sharing mirrors. Note: You might have to run the snapmirror-update API more than once if the command does not finish before the next scheduled update of the set of load-sharing mirrors. The snapmirror-update API must be used from the destination cluster.Inputs
Outputs
[Family: cluster]
The snapmirror-update-iter API updates the destination volumes of one or more SnapMirror relationships. This API is not supported on Infinite Volume constituents. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: cluster]
The snapmirror-update-ls-set API updates destination volumes of the set of load-sharing mirrors. The API makes destination volumes, in the group of load-sharing mirrors, up-to-date mirrors of the source volume. You must specify the source endpoint when using snapmirror-update-ls-set. Separate SnapMirror transfers are performed from the source volume to each of the up-to-date destination volumes in the set of load-sharing mirrors. Load-sharing mirrors that lag behind the up-to-date destination volumes might not be updated by the snapmirror-update-ls-set API. Use the snapmirror-update API to update a lagging load-sharing mirror. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: vserver]
Add a rule to SnapMirror policyInputs
Outputs
[Family: vserver]
Create the specified SnapMirror PolicyInputs
Outputs
[Family: vserver]
Delete the specified SnapMirror PolicyInputs
Outputs
[Family: vserver]
Get Information about a single SnapMirror PolicyInputs
Outputs
[Family: cluster, vserver]
Get Information about multiple SnapMirror PoliciesInputs
Outputs
[Family: vserver]
Modify the specified SnapMirror PolicyInputs
Outputs
[Family: vserver]
Modify a SnapMirror policy ruleInputs
Outputs
[Family: vserver]
Remove a rule from SnapMirror policyInputs
Outputs
[Family: vserver]
Returns the current snapshot autodelete settings.Inputs
Outputs
[Family: vserver]
Set the option named 'option-name' to the value specified by 'option-value' in the autodelete settings of the specified volume.Inputs
Outputs
[Family: vserver]
Create a new snapshot on a specified volume.This API is not supported on Infinite Volume.
Inputs
Outputs
[Family: vserver]
Create a new snapshot on a specified Infinite Volume.This API is not supported on flexible volumes and Infinite Volume constituents.
Inputs
Outputs
[Family: vserver]
Delete a snapshot on a specified volume. EBUSY is returned when the snapshot is in use. EROFS is returned when the volume is read-only. EAGAIN is returned when splitting a blockmap or reverting.This API is not supported on Infinite Volume.
Inputs
The default value is false.
An example of an actual UUID is:
73a010ec-3d28-11df-84e8-123478563412
Outputs
[Family: vserver]
Delete a snapshot on a specified Infinite Volume. EBUSY is returned when the snapshot is in use. EROFS is returned when the Infinite Volume is read-only. EAGAIN is returned when splitting a blockmap or reverting.This API is not supported on flexible volumes and Infinite Volume constituents.
Inputs
Outputs
[Family: vserver]
Returns the amount of space consumed between two snapshots or a snapshot and active filesystem.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of snapshot objects.Inputs
Outputs
[Family: vserver]
Obtain the current snapshot reserve on a specified volume. Error Returns: Invalid volume name.Inputs
Outputs
[Family: vserver]
Obtain the current snapshot schedule on a specified volume. Error Returns: Invalid volume name.Inputs
Outputs
[Family: vserver]
Return snapshot information for a specified volume. A list of snapshots and information about each snapshot is returned. In Data ONTAP Cluster-Mode, 'snapshot-get-iter' API is the preferred way of retrieving snapshot information.Inputs
Outputs
[Family: cluster, vserver]
Modify the attributes of snapshot or a group of snapshot objects.Inputs
Outputs
[Family: vserver]
Create a snapshot with the specific name, on each of the specified volumes. It is the caller's responsibility to ensure that the data in the snapshots across all volumes is consistent, by quiescing I/O to these volumes (or the LUNs of interest in these volumes), across the call to this API. The API returns SUCCESS when a snapshot is successfully created on each of the specified volumes. This API bails out and reports FAILURE when an error is found at creating a snapshot on a volume. It does not continue on to create snapshots on the remaining volumes. When the API fails, the returned error code is for the failed volume. For clustered systems, the output 'status' will be set to FALSE in case of failure. In such case the caller should look at the output 'volume-errors' to find out in which volume snapshot creation failed. When an error occurs, it is possible that some snapshots may have been created. If the option cleanup is set to TRUE (default), API will attempt to delete these snapshots (but snapshot deletion may fail). When set to FALSE, it is users' responsibility to delete them. The output array volume-snapcreated-list records for each volume, if a snapshot has been created or not. There are at least two expected use cases for this API. The first one is to call this API with the cleanup option set to TRUE (default). If the call fails, any successfully created snapshots will be deleted before the function returns. This is a simple use case, but has the downside that in case of a failure, the call may take a long time to return due to snapshot cleanup. Another use case would be to call this API in a time critical environment. In such a scenario, it would be good to reduce the impact due to a failure. Hence, it would be better to first call the snapshot-multicreate-validate ZAPI, which would reduce the likelihood of failure of the snapshot-multicreate API. In case a failure does occur, the caller could avoid the cleanup delay by setting the cleanup option to FALSE, and performing snapshot cleanup later, outside the time-critical window.Inputs
Outputs
[Family: vserver]
This is a companion API of snapshot-multicreate. It validates the snapshot creation operation on the specified volumes. But it does not actually create any snapshot. This API only does validations on all volumes and report all errors in the output array. This API is intended to be issued before the snapshot-multicreate API to find out all the errors that may be found during the snapshot create. Its main purpose is to enable snapshot-multicreate's caller to reduce the likelihood of snapshot-multicreate's failure, thereby attempting to avoid the cleanup overhead (of deleting any newly created snapshots) during failure processing. However, this validation API does not guarantee that snapshot-multicreate API will actually work. Something could change between the two calls to cause the actual snapshot creations to fail.Inputs
Outputs
[Family: vserver]
Delete the snapshot from the given flexible volumes. This API will return failure if the volume could not be found or it is busy. All the volumes should be online when this API is invoked. It will only delete snapshots on Read-Write volumes. Once all the necessary information to delete snapshots is available, this API will start deleting snapshots on the volumes. If any of the snapshot delete failed, the API will remember the failed volume and continue deleting snapshot on the remaining volumes. In case of failure to delete the snapshots from all the given volumes, the API will return a SUCCESS and also return information about the failed snapshot deletes via the 'volume-errors' output. If the API returns SUCCESS, the applications should check if the 'volume-errors' output is returned or not to check for failed snapshot deletions.This API is not supported on Infinite Volume.
Inputs
Outputs
[Family: vserver]
Rename Snapshot copies with a specific name to a new name across multiple volumes. The API processes all the specified volumes even if rename fails on one or more volumes. The snapshot-multirename-errors field should be inspected for failures even if the API is successful.This API is not supported on Infinite Volume.Inputs
Outputs
[Family: vserver]
Restores a particular range of bytes in a file from a specified snapshot.Partial file restores are used to restore particular pieces of LUNs and NFS or CIFS container files that are used by a host to store multiple sources of data. For example, a host may be storing multiple user databases in the same LUN. A partial file restore can be used to restore one of those databases in the LUN while not touching the other databases that are also stored in the LUN. Compressed files will not be restored, thought compression may be enabled on the volume.
Partial file restores require significant management by the caller. The caller must understand the metadata of the host LUN or container file so that they can know which bytes belong to the object being restored.
Before the restore operation beings, the caller must quiesce the object being restored. It must remain quiesced for the duration of the restore operation. No host I/O should be issued for the object while it is being restored because the snapshot-partial-restore-file commands will be incrementally restoring the LUN or file and the host will therefore see inconsistent content for the object until the restore operation is completed. Host I/O is permitted for the other objects stored in the LUN or container file because the partial file restore will not touch the bytes belonging to those other objects.
During the restore the caller must issue a snapshot-partial-restore-file command for each of the byte ranges that belong to the object being restored, based on the metadata of the LUN or container file. Once each command returns, that byte range is restored and the changes are persistent. If the filer should halt while processing a command, that byte range of the LUN or container file is inconsistent. Some of the bytes at the beginning of the range may have been restored while bytes at the end of the range have not been restored. Once the filer is rebooted the caller should re-issue the command to restore that byte range to complete the restore.
Once the restore is completed, the caller must purge any host operating system or application buffers that may hold data for the LUN or file that is now stale. For NFS or CIFS mounted volumes the easiest way to purge any host buffers is to unmount and remount the volume. Applications holding buffered data may need to be shut down and restarted.
Multiple partial file restore requests may be issued to the same LUN or file simultaneously. There is no requirement that the requests are all restoring from the same snapshot so that multiple restore operations for different objects may be concurrent on the same file. There is no checking to prevent overlapping byte ranges between requests. Preventing this condition is the responsibility of the caller.
Partial file restores are not intended for restoring parts of normal user-level files that are stored in an NFS or CIFS exported volume. Use snapshot-restore-file to restore normal files like these.
The volume where the LUN or container file to restore and where the snapshot to restore from live must be online and must not be a mirror volume.
The partial file restore request may fail if there is not sufficient free space to overwrite all of the blocks in the byte range to be restored.
The partial file restore request is synchronous, meaning that the command will not return until the entire byte range is restored. The snapshot being restored from cannot be deleted while a request is being executed, but it can be deleted between requests. If this happens the next request will notice that the snapshot has been deleted and will return an error.
The maximum number of bytes of data that can be restored in a single request is given by the max-byte-count value returned by the snapshot-partial-restore-file-list-info command. This limit ensures that requests are periodically interruptible and avoids overloading the filer.
If the system halts while a partial file restore request is being executed, the request will not be restarted upon reboot. Some of the bytes at the beginning of the range may have been restored while bytes at the end of the range have not been restored. The caller should reissue the partial file restore request for that byte range to complete the restore.
Inputs
Outputs
[Family: vserver]
Returns partial file restore settings of the vserver.Inputs
Outputs
[Family: cluster]
Add a new schedule to the Snapshot Policy. A schedule can be created by using 'job-schedule-cron-create' or 'job-schedule-interval-create' APIs.Inputs
Outputs
[Family: cluster]
Create a new Snapshot Scheduling PolicyInputs
Outputs
[Family: cluster]
Delete the specified Snapshot Scheduling PolicyInputs
Outputs
[Family: cluster, vserver]
Get Information about a single Snapshot PolicyInputs
Outputs
[Family: cluster, vserver]
Get Information about multiple Snapshot PoliciesInputs
Outputs
[Family: cluster]
Enable or Disable the specified Snapshot Scheduling PolicyInputs
Outputs
[Family: cluster]
Modify a snapshot policyInputs
Outputs
[Family: cluster]
Remove a snapshot schedule from policyInputs
Outputs
[Family: vserver]
Returns the amount of space that would be freed when a set of snapshots are deleted from a specified volume.Inputs
Outputs
[Family: vserver]
Rename a specified snapshot to a new name on a specified volume. This API is not supported on Infinite Volume constituents.Inputs
Outputs
[Family: cluster, vserver]
Gets the percentage of disk space that is reserved for snapshots in the indicated volume. If no volume is specified, this will return the percentage of disk space reserved for snapshots for each of the volumes in the system. Reserve space can be used only by snapshots and not by the active file system.Inputs
Outputs
[Family: vserver]
Reverts a single file to a revision from a specified snapshot. The volume used for restoring the file must be online and must not be a mirror. Files other than normal files and LUNs are not restored. This includes directories (and their contents), and files with NT streams. Compressed files will not be restored, though compression may be enabled on the volume.If there is not enough space in the volume, the single file snap restore will not start. If the file already exists (in the active filesystem), it will be overwritten with the version in the snapshot. It could take up to several minutes for before the API invocation returns. During this time client exclusive oplocks are revoked and hard exclusive locks like the DOS compatibility lock are invalidated. Once the invocation returns, the file restore will proceed in the background.
For normal files while the restore is proceeding, any operation which tries to change the file will be suspended until the restore is done. The restore may take a long time to complete depending on the size of the file being restored. The file is unavailable for use during this time.
For LUNs that are restored over top of their existing LUN, a LUN clone can be created that is backed by the snapshot being restored from and then the clone is split. Snapshots are disabled during restore due to space efficient LUN clone split. In order to disable space efficient split during restore set the optional parameter space-efficient-split-disabled. While the restore is proceeding the LUN is available and I/O (both reads and writes) is permitted. Data that is modified in the LUN while the restore is proceeding will not be overwritten by the restore process. The restore may take a long time to complete depending on the size of the LUN being restored. Use lun-clone-status-list-info to see the progress of the LUN restore.
Other single file snap restores can be executed concurrently. Also it is possible for the single file snap restore to be aborted if we run out of disk space during the operation. When this happens the timestamp of the file being restored will be updated. Thus it will not be the same as the timestamp of the file in the snapshot.
For normal files, an in-progress restore can be aborted by removing the file. For NFS users, the last link to the file must be removed.
For LUNs that are restored over top of their existing LUN, an in-progress restore can be aborted by using lun-clone-stop when in 7-mode. The restored LUN will still be a clone in this case and it will still be partially backed by the snapshot it was restored from.
For all restored files, the snapshot used for the restore cannot be deleted. New snapshots cannot be created while a single-file snaprestore is in progress. Scheduled snapshots on the volume will be suspended for the duration of the restore. Tree, user and group quota limits are not enforced for the owner, group and tree in which the file is being restored. Thus if the user, group or tree quotas are exceeded, /etc/quotas will need to be altered after the single file snap restore operation has completed. Then quota resize will need to be run. When the restore completes, the file's attributes (size, permissions, ownership, etc.) should be identical as those in the snapshot.
If the system is halted or crashes while a single file snap restore is in progress then the operation will be restarted on reboot. A volume cannot have both a volume snaprestore and a single-file snaprestore executing simultaneously. Multiple single-file snaprestores can be in progress simultaneously.
Inputs
Outputs
[Family: vserver]
Get information about snapshot file restores on a given vserver. Returns maximum snapshot file restores limit and snapshot file restores in progress numbers.Inputs
Outputs
[Family: vserver]
Reverts a volume to a specified snapshot. The volume must be online and must not be a mirror. If reverting the root volume, the filer will be rebooted. Non-root volumes do not require a reboot. A volume cannot have both a volume snaprestore and a single-file snaprestore executing simultaneously. Multiple single-file snaprestores can be in progress simultaneously. After the reversion, the volume is in the same state as it was when the snapshot was taken.This API is not supported on Infinite Volume.
Inputs
The default value is false.
An example of an actual UUID is:
84a010ec-3d28-11df-84e8-123478653412
Outputs
[Family: vserver]
Reverts an Infinite Volume to a specified snapshot. The Infinite Volume must be online and unmounted and must not be a mirror. After the reversion, the Infinite Volume is in the same state as it was when the snapshot was taken.This API is not supported on flexible volumes and Infinite Volume constituents.
Inputs
Outputs
[Family: vserver]
Sets the size of the indicated volume's snapshot reserve to the specified percentage. Reserve space can be used only by snapshots and not by the active file system.Inputs
Outputs
[Family: vserver]
Returns snapshot related volume information. The information returned is valid at the time the API call reached the filer and maybe outdated soon after.Inputs
Outputs
[Family: cluster]
Adds a community to the list of communities.Inputs
Outputs
[Family: cluster]
Deletes a community from the list of communities.Inputs
Outputs
[Family: cluster]
Deletes all the communities.Inputs
Outputs
[Family: cluster]
Disables snmp protocol.Inputs
Outputs
[Family: cluster]
Enables snmp protocol.Inputs
Outputs
[Family: cluster]
Retrieves the value of a snmp object.Inputs
Outputs
[Family: cluster]
This is used to retrieve the next OID in the mib tree of data. Instead of returning the data you requested, it returns the next OID in the tree and its value. Unlike the snmp-get api, this api does return data for a OID which is too short or is missing the index part of the OID.Inputs
Outputs
[Family: cluster]
Returns configuration information of the SNMP agent daemon.Inputs
Outputs
[Family: cluster]
Disables snmp traps.Inputs
Outputs
[Family: cluster]
Enables snmp traps.Inputs
Outputs
[Family: cluster]
Adds a host to the list of trap hosts.Inputs
Outputs
[Family: cluster]
Deletes a host from the list of trap hosts.Inputs
Outputs
[Family: cluster]
Enables specified host adapter. I/O traffic can be issued on the adapter.Inputs
Outputs
[Family: cluster]
Display the information about a specified host adapter. The information is displayed base on the controller interface type. ATA, Paralell SCSI, SAS, FC.Inputs
Outputs
[Family: cluster]
Get the list of adapters present on this system.Inputs
Outputs
[Family: cluster]
Modify the adapter state.Inputs
Outputs
[Family: cluster]
Generates a high level summary of array LUN pathing (connectivity) information.Inputs
Outputs
[Family: cluster]
Retrieves a list of all array profiles known to the controller.Inputs
Outputs
[Family: cluster]
Update an array profile with new or changed information.Inputs
Outputs
[Family: cluster]
Update an array port with new or changed information.Inputs
Outputs
[Family: cluster]
generate a list of array ports and their associated arraysInputs
Outputs
[Family: cluster]
Rename an array profileInputs
Outputs
[Family: cluster]
Disk enumeration ZAPI. Get disk information about one or more disks, from the Storage Subsystem. Currently only the Data ONTAP Cluster-Mode iterator APIs support filtering of output, to constrain the disks that are included in the return list, and/or what information is returned about each disk. The default is to return all information about all disks in the cluster. That list may be reduced using the 'query' input element. For example, the return list may include only (1) Disks visible to a particular cluster node "nodeA", e.g., "query.disk-paths.disk-name=nodeA:*" (2) A particular disk visible to a particular node, e.g., "query.disk-paths.node=nodeA:6a.01". (3) A disk with a particular unique id, e.g., "query.disk-uid=20000000:87A9652B:00000000:00000000:00000000:00000000:00000000:00000000:00000000:00000000" (4) Disks with a name that matches a certain wildcard pattern, e.g., "query.disk-paths.disk-name=6a*". (5) Disks assigned to a particular node. e.g., "query.disk-ownership-info.home-node-id=1252487" or "query.disk-ownership-info.home-node-name=nodeA". (6) Some subset of disks in the cluster or visible to a particular node in the cluster. If 'desired-attributes' is included, then only those data specified by in 'desired-attributes' are returned for each disk. For the Data ONTAP 7-Mode API, since filtering based upon 'query' and 'desired-attributes' is not yet supported, the behavior is currently to return all available information about all disks visible to the local node. If there is badly formed input or an invalid input value is specified, then EINVALIDINPUTERROR is returned. If there is some internal error which prevents processing of this request, then EINTERNALERROR is returned.Inputs
Outputs
[Family: cluster]
Balances primary/secondary array LUN paths across available initiator ports based on I/O load.Inputs
Outputs
[Family: cluster]
Returns path information and statistics for a given disk or all disks. We use the word disk to refer to an array lun, real disk, or Solid State DeviceInputs
Outputs
[Family: cluster]
Lists all known disk/configuration errors associated with an array or shelves acting like array.Inputs
Outputs
[Family: cluster]
Gets disk I/O rates for a given fibre channel initiator port or for all initiator ports if no port is specified. The term disk refers to an array LUN, actual disk, or solid state device.Inputs
Outputs
[Family: cluster]
Returns information and statistics on all known paths to back end storage.Inputs
Outputs
[Family: cluster]
Quiesces an array LUN on a path. A quiesced array LUN will not be sent I/O on the specified path.Inputs
Outputs
[Family: cluster]
Resumes I/O to array LUN on a path that was previously quiesced. Resuming I/O to a non-quiesced array LUN is a no-op and not an error.Inputs
Outputs
[Family: cluster, vserver]
get elements for specified apisInputs
Outputs
[Family: cluster, vserver]
get list of apis. This returns the names only - to get the parameter info, use system-api-get-elementsInputs
Outputs
[Family: cluster, vserver]
get list and description of typedefsInputs
Outputs
[Family: cluster]
Obtain appliance information which includes cpu and backplane information. The output contains the head information in a sysconfig -a command. I/O information is not included. System refers to a node in a cluster.Inputs
Outputs
[Family: cluster, vserver]
Obtain the current ONTAPI major and minor versions.Inputs
Outputs
[Family: cluster]
Obtain the Data ONTAP vendor information.Inputs
Outputs
[Family: cluster, vserver]
Obtain the Data ONTAP version.Inputs
Outputs
[Family: cluster]
Fetch a file from a URL. This API will return immediately. The progress can be monitored using the 'system-image-update-progress-get' API.Inputs
Outputs
[Family: cluster]
Display software image informationInputs
Outputs
[Family: cluster]
Perform software image fresh installInputs
Outputs
[Family: cluster]
Modify software image configurationInputs
Outputs
[Family: cluster]
Delete a software packageInputs
Outputs
[Family: cluster]
Display software information for all packagesInputs
Outputs
[Family: cluster]
Perform software image upgrade/downgrade. This API will return immediately. The progress can be monitored using the 'system-image-update-progress-get' API.Inputs
Outputs
[Family: cluster]
Show progress information for current or previous updateInputs
Outputs
[Family: cluster]
Obtain the node information when the node is part of a cluster. Information returned includes details like location, serial-number, asset tag, uptime, vendor name etc.Inputs
Outputs
[Family: cluster]
Obtain the node information when the node is a part of the cluster in an iteration.Inputs
Outputs
[Family: cluster]
Reboot the specified node. Only an admin can reboot the node. If attempted by a user with insufficient privileges EAPIPRIVILEGE is returned.Inputs
Outputs
[Family: cluster]
Rename the specified node to a new name specified by 'new-name'Inputs
Outputs
[Family: cluster]
Shut down a node. Only an admin can initiate a node shutdown. If attempted by a user with insufficient privileges EAPIPRIVILEGE is returned.Inputs
Outputs
[Family: cluster, vserver]
Returns the objects and their operations which are permitted to user who called this API.Inputs
Outputs
[Family: cluster]
Get the attributes of the UC Adapter.Inputs
Outputs
[Family: cluster]
Iterate over a list of UC Adapter objects.Inputs
Outputs
[Family: cluster]
Modify configuration of an adapter under the Unified Connect Management (UCM) framework, including the mode and/or the FC-4 type.Inputs
Outputs
[Family: vserver]
Given the name of a flexible volume, get the autosize settings.Inputs
Outputs
[Family: vserver]
Given the name of a flexible volume, set the autosize settings.Inputs
Outputs
[Family: vserver]
Create a flexible volume that is a clone of a "backing" or "parent" flexible volume. A clone is a volume that is a writable snapshot of another volume. Initially, the clone and its parent share the same storage; more storage space is consumed only as one volume or the other changes. If a specific snapshot name within the parent volume is provided, it is chosen as the parent snapshot. Otherwise, the filer will create a new, distinctively- named snapshot in the parent volume for that purpose. The parent snapshot is locked in the parent volume, preventing its deletion until the clone is either destroyed or split from the parent using the 'volume-clone-split-start' command (see below). This command fails if the chosen parent volume is currently involved in a split operation. This command also fails if the chosen parent volume is a traditional volume. Cloning is a new capability that applies exclusively to flexible volumes.Inputs
The fully-qualified pathname in the owning vserver's namespace at which a volume is mounted. Note that this pathname may itself contain junctions, one for each volume (other than the namespace root volume) that provides storage along the pathname's length. As with all fully-qualified pathnames , this string must begin with '/'. In addition, it must not end with '/'.
An example of a valid junction path is: '/user/my_volume'.
Only one volume can be mounted at any given junction path. If an incorrect junction path is specified, EINVALIDINPUTERROR is returned. If another volume is mounted at the specified junction path, EVOLALREADYMOUNTED is returned.
Outputs
[Family: vserver]
Display details of a specific FlexClone volumeInputs
Outputs
[Family: cluster, vserver]
Display a list of FlexClone volumesInputs
Outputs
[Family: vserver]
Display an estimate of additional storage required in the underlying aggregate to perform a volume clone split operation. This command fails if applied to a traditional volume. Cloning is a new capability that applies exclusively to flexible volumes.Inputs
Outputs
[Family: vserver]
Begin the process by which the given clone is split off from its underlying parent volume and snapshot. New storage is allocated for the clone that is distinct from its parent. This process may take some time and proceeds in the background. Use the 'volume-clone-split-status' command to view the operation's progress. Both clone and parent volumes remain available during the process of splitting them apart. Upon completion, the snapshot on which the clone was based will be unlocked in the parent volume. Any snapshots in the clone are removed at the end of processing. Use the 'volume-clone-split-stop' command to stop this process. This command fails if applied to a traditional volume. Cloning is a new capability that applies exclusively to flexible volumes.In Data ONTAP Cluster-Mode, a job is created to perform the split operation. The job id of the job is returned in the API response. The progress of the job can be tracked using the job APIs.
Inputs
Outputs
[Family: vserver]
Display the progress in separating clones from their underlying parent volumes and snapshots. If a clone name is specified, then the split status for that clone is provided. If no clone name is provided, then status is provided for all clones currently being split. This command fails if applied to a traditional volume, and EONTAPI_EVOLNOTFLEX is thrown. Cloning is a capability that applies exclusively to flexible volumes. This command fails if the volume specified is not a clone, and EVOLNOTCLONE is thrown. This command fails if the volume specified is not being split, and EVOLOPNOTUNDERWAY is thrown.Inputs
Outputs
[Family: vserver]
Stop the process of splitting off a clone from its parent volume and snapshot. All of the blocks that were formerly shared between the given clone and its parent volume that have already been split off will remain that way. This command fails if applied to a traditional volume. Cloning is a new capability that applies exclusively to flexible volumes.Inputs
Outputs
[Family: vserver]
Return the name of the containing aggregate for the named flexible volume.Inputs
Outputs
[Family: cluster]
Copy a volume A job will be spawned to operate on the volume and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
Outputs
[Family: vserver]
Create a volume.The maximum number of volumes (traditional or flexible in any combination) on a filer is determined by the amount of main memory. All filers with less than 8GB of memory can support a maximum of 200 volumes, and all others can support a maximum of 500 volumes.
The detailed behavior of this API depends on where it is received:
1. In Data ONTAP Cluster-Mode, create a new flexible volume.
2. In Data ONTAP 7-Mode, create a new flexible, traditional, or sparse volume with the given name and characteristics. Freshly-created traditional volumes may not be operational immediately after the API returns. Use 'volume-list-info' to obtain information about volumes, including the status of the newly-created traditional volume in order to determine when it is fully operational.
This API is not supported for Infinite Volumes.
Inputs
If not specified when creating a volume, the Anti-Virus On-Access Policy is inherited from the owning vserver. Currently, this policy can only be managed using the 'antivirus' command line interfaces.
This input is required for creating a Cluster-Mode volume.
The default policy name is 'default'.
This policy applies only to FlexCache volumes and can be created using the 'flexcache-cache-policy-create' API.
The default policy name is 'default'.
This policy applies only to FlexCache volumes and can be created using the 'flexcache-fill-policy-create' API.
For 7-Mode volumes, it causes the invalidation of all NFS file handles on all volumes affected by the problem so that client-side users are forced to remount the affected file system (and thus not continue to use potentially incorrect data).
It is also possible to specify a set of files per volume that are to be renamed out of the way in these cases. The controller sends error messages to the console whenever such problems are found.
For Cluster-Mode volumes, the volume would be put in a special state called 'in-nvfailed-state' such that protocol access is blocked. This will cause the client applications to crash and thus prevent access to stale data on the volume.
To get out of this situation, the admin needs to manually clear the 'in-nvfailed-state' on the volume.
By default, this value is false.
When creating a volume, if this field is set to true, the new volume is to become the new namespace root volume of the vserver. This field can be used in a recovery scenario in which the namespace root volume of the vserver becomes unrecoverable.
The fully-qualified pathname in the owning vserver's namespace at which a volume is mounted. The pathname is case insensitive and must be unique within a Vserver's namespace. Note that this pathname may itself contain junctions, one for each volume (other than the namespace root volume) that provides storage along the pathname's length. As with all fully-qualified pathnames , this string must begin with '/'. In addition, it must not end with '/'.
An example of a valid junction path is: '/user/my_volume'.
Only one volume can be mounted at any given junction path. If an incorrect junction path is specified, EINVALIDINPUTERROR is returned. If another volume is mounted at the specified junction path, EVOLALREADYMOUNTED is returned.
For 7-Mode volumes, the default setting of 10240 limits directory size to 10 MBytes and allows it to hold up to approximately 300,000 files. For Cluster-Mode volumes, the default setting is 100 MBytes and it allows the directory to hold up to approximately 3,000,000 files. The number of files that the directory actually can hold varies depending on such things as the length of the names and whether it needs to use double-byte UNICODE characters.
Most users should not need to change this field's default setting. It is useful for environments where system users may grow a directory to a size that starts impacting system performance. When a user tries to create a file in a directory that is at the limit, the system returns a ENOSPC error and fails the create.
This feature is deprecated.
The default policy name is 'default'.
This policy can be created using the 'snapshot-policy-create' API. It can be managed using the 'snapshot-policy-*' APIs.
It's similar to Unix style permission bits:
In Data ONTAP 7-mode, the default setting of '0755' gives read/write/execute permissions to owner and read/execute to group and other users.
In Data ONTAP Cluster-Mode, for security style "mixed" or "unix", the default setting of '0755' gives read/write/execute permissions to owner and read/execute permissions to group and other users. For security style "ntfs", the default setting of '0000' gives no permissions to owner, group and other users.
It consists of 4 octal digits derived by adding up bits 4, 2 and 1. Omitted digits are assumed to be zeros. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. The second digit selects permission for the owner of the file: read (4), write (2) and execute (1); the third selects permissions for other users in the same group; the fourth for other users not in the group.
Possible values:
Security styles don't apply to GX-striped data volumes.
Possible values:
Outputs
[Family: vserver]
Create an Infinite Volume. This API will select one aggregate from the aggregates assigned to the VServer to create the namespace constituent. The remaining assigned aggregates will be used for data constituents. You must have the aggregates and the Vserver with Infinite Volume created, as well as assigned the aggregates to the Vserver. Infinite Volume creation and expansion operations may involve creation and initialization of Namespace Mirrors. The initialization is started during the creation or expansion operation, but can continue after the Infinite Volume operation has completed. When this happens, the Infinite Volume will be in a 'mixed' state, until the Namespace Mirror initialization is complete. While in a 'mixed' state, further operations of the Infinite Volume are not possible. This API is not supported for Flexible Volumes.Inputs
The Infinite Volume constituents would be put in a special state called 'in-nvfailed-state' such that protocol access is blocked. This will cause the client applications to crash and thus prevent access to stale data.
To get out of this situation, the admin needs to manually clear the 'in-nvfailed-state' on the Infinite Volume constituents.
By default, this value is true.
The fully-qualified pathname in the owning Vserver's namespace at which the Infinite Volume is mounted. The pathname is case insensitive. This string must begin with '/'. In addition, it must not end with '/', and may only have one element.
An example of a valid junction path is: '/My_InfiniteVolume'. The path '/My_InfiniteVolume/dir' is invalid, as it has two elements.
Only one Infinite Volume can be mounted at any given junction path. If an incorrect junction path is specified, EINVALIDINPUTERROR is returned. If another Infinite Volume is mounted at the specified junction path, EVOLALREADYMOUNTED is returned.
If the junction-path is not specified, the Infinite Volume is mounted at /NS.
Most users should not need to change this field's default setting. It is useful for environments where system users may grow a directory to a size that starts impacting system performance. When a user tries to create a file in a directory that is at the limit, the system returns a ENOSPC error and fails the create.
This policy can be created using the 'snapshot-policy-create' API. It can be managed using the 'snapshot-policy-*' APIs.
The default policy name is 'default-1weekly'.
If the client specifies this argument upon Infinite Volume creation, the argument will be used as the initial storage service for constituents of the Infinite Volume.
If the client does not specify this argument upon Infinite Volume creation, the Infinite Volume will be created without support for storage services. Support for storage services can be enabled at a later time using the volume-modify-iter-async API.
It's similar to Unix style permission bits:
The default setting of '0755' gives read/write/execute permissions to owner and read/execute permissions to group and other users.
It consists of 4 octal digits derived by adding up bits 4, 2 and 1. Omitted digits are assumed to be zeros. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. The second digit selects permission for the owner of the file: read (4), write (2) and execute (1); the third selects permissions for other users in the same group; the fourth for other users not in the group.
Possible values:
Security styles don't apply to GX-striped data volumes. Infinite Volumes can only use the 'unified' security style. FlexVol volumes cannot use the 'unified' security style.
Possible values:
Outputs
[Family: vserver]
Destroy the specified volume or plex. If a flexible volume is specified, all of its blocks are freed and returned to its containing aggregate; no other flexible volumes in the same containing aggregate (if any) are affected. If a traditional volume is specified, all of its plexes are destroyed, and its disks are returned to the appropriate spare pool(s). If a plex is specified, it must be for a mirrored aggregate (which could potentially be embedded in a traditional volume), leaving it unmirrored. Only offline volumes and plexes can be destroyed. Plexes are not supported for Cluster-Mode volumes.This API is not supported for Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Destroy an Infinite Volume. The Infinite Volume must be unmounted and must be offline before it can be destroyed.This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents.
Inputs
Outputs
[Family: cluster, vserver]
Display a list of volumes and their data and metadata footprints in their parent aggregate. The term footprint is used to refer to space that is considered used in an aggregate due to data in a specific volume.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of volume objects.Inputs
Outputs
[Family: vserver]
Get the given volume's language mapping.Inputs
Outputs
This field is of the following format: "<nfs-character-set>|<display-name>|<asctime>"
Note that "|" is not an OR syntax.
<asctime> is the timestamp in the language configuration file header and its format is based on the standard: "A la ISO/IEC 9945-1, ANSI/IEEE Std 1003.1, Second Edition, 1996-07-12."
It uses the C Programming Language Printf format: "%.3s %.3s%3d %02d:%02d:%02d %s %d"
This format takes the following parameters in order: <weekday name>, <month name>, <month day>, <hour>, <minute>, <second>, <timezone> OR <"">, <year>
E.g., If the volume language code is set to "en_US", the default NFS character set is as follows:
"iso-8859-1|iso-8859-1|Thu Oct 1 15:00:53 PDT 1998"
This field is of the following format: "<oem-code-page>|<display-name>|<asctime>"
Note that "|" is not an OR syntax.
<asctime> is the timestamp in the language configuration file header and its format is based on the standard: "A la ISO/IEC 9945-1, ANSI/IEEE Std 1003.1, Second Edition, 1996-07-12."
It uses the C Programming Language Printf format: "%.3s %.3s%3d %02d:%02d:%02d %s %d"
This format takes the following parameters in order: <weekday name>, <month name>, <month day>, <hour>, <minute>, <second>, <timezone> OR <"">, <year>
E.g., If the volume language code is set to "en_US", the default NFS character set is as follows:
"cp437|cp437|Thu Oct 1 15:00:53 PDT 1998"
[Family: vserver]
Return calculated volume limits, which are based on the current configuration of the vserver.This API is not supported for Flexible Volumes.
Inputs
Possible values:
Outputs
[Family: vserver]
Return the name of the "root" volume on the filer. If this request is executed in the context of a vfiler, the "root" volume of the vfiler will be returned. If this request is executed in the context of a vserver the "namespace root" volume of the vserver will be returned. If the "namespace root" volume of the Admin Vserver is requested, EVSERVER_OP_NOT_ALLOWED will be returned.Inputs
Outputs
[Family: vserver]
Return the junction-path of the volume.Inputs
Outputs
[Family: cluster, vserver]
Modify the attributes of a volume or a group of volume objects.This API is not supported for Infinite Volumes.
Inputs
Outputs
[Family: cluster, vserver]
Modify the attributes of an Infinite Volume or a group of repositories.Infinite Volume creation and expansion operations may involve creation and initialization of Namespace Mirrors. The initialization is started during the creation of expansion operation, but can continue after the Infinite Volume operation has completed. When this happens, the Infinite Volume will be in a 'mixed' state, until the Namespace Mirror initilization is complete. While in a 'mixed' state, further operations of the Infinite Volume are not possible.
This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents. This API does not require any license when operating on an Infinite Volume.
Inputs
Outputs
[Family: vserver]
Mount a volume on another volume (parent) with a junction-path. This API is not supported on Infinite Volume constituents.Inputs
The fully-qualified pathname in the owning Vserver's namespace at which a volume is mounted. The pathname is case insensitive and must be unique within a Vserver's context. Note that this pathname may itself contain junctions, one for each volume (other than the namespace root volume) that provides storage along the pathname's length. As with all fully-qualified pathnames , this string must begin with '/'. In addition, it must not end with '/'. An Infinite Volume has the additional restriction of allowing only one element.
An example of a valid FlexVol junction path is: '/user/my_volume'. An example of a valid InfiniteVol junction path is: '/repository'.
Only one volume can be mounted at any given junction path. If an incorrect junction path is specified, EINVALIDINPUTERROR is returned. If this volume is mounted at a different junction path, or if another volume is mounted at the specified junction path, EVOLALREADYMOUNTED is returned.
Outputs
[Family: cluster]
Get status of move operationInputs
Outputs
[Family: cluster]
This API is applicable to Data ONTAP 7-Mode as well as Data ONTAP Cluster-Mode. If the API is sent to a Data ONTAP 7-Mode controller, Vol Move will move a single 7-mode flexvol between two aggregates on the same controller. If the API is sent to the Admin Vserver LIF, the flexvol can be moved to any eligible aggregate in the cluster. The list of eligible aggregates can be obtained using the "volume-move-target-aggr-get-iter" API. This API will start the move. It will run a series of checks to determine if the volume can be moved. If any of the checks results in an error or warning, the API will return with an error. The user has to take the necessary corrective action before restarting the move. If all the checks pass, the API will return a success. If "perform-validation-only" is not true, the destination volume will be created and the move will start. By default, the move will cutover automatically. If "perform-validation-only" is set to true, all the errors and warnings encountered from the checks will be returned in the errors-warnings output element. The API will return successfully. The move will not be initiated. When the API is sent to a Data ONTAP 7-Mode controller, if "is-override-warnings" is set to true and the checks return no errors but one or more warnings, the API will return successfully. The warnings will be in the errors-warnings output element. If the API is sent to a Data ONTAP 7-Mode controller, the status of the move can be obtained using the "volume-move-status" API. If the move fails an EMS message will be generated. The reason for the failure can be obtained from the volume-move-status API. After a successful move, the source volume will be destroyed unless the user has specified the "is-keep-source" option. If cutover cannot be completed in the default or user specified number of attempts, an EMS message will be printed and the move will pause. The reason for the pause will be available in the "volume-move-status" API. The user can either resume or abort the move. This is an asynchronous API. If the API is sent to the Admin Vserver LIF, a background job will be created and the API returns immediately with the job ID information. The status of the move job can be obtained by using "job-get" or "job-get-iter" API.Inputs
Outputs
[Family: cluster, vserver]
Scans aggregates and returns a list of compatible target aggregates for the given volume move operation.Inputs
Outputs
[Family: cluster]
Stop a running volume move operation.This is an asynchrous API call and it does not wait for the abort to finish before returning. volume-move-get-iter can be used to monitor the progress of the abort and get the status. Unlike 'job stop', this API makes it possible to stop a move job by the vserver and volume name. If the specified volume has completed the volume move operation, an error is returned.
Inputs
Outputs
[Family: cluster]
Trigger cutover of a move jobInputs
Outputs
[Family: vserver]
Take the specified volume or plex offline, making it unavailable for both user-level data access and RAID-level access (unless it's a flexible volume, at which time its containing aggregate is not affected in any way, and will remain fully online). The operation takes effect before the API returns except in maintenance mode, when the current root volume may not be taken offline. A volume marked to become the root cannot be taken offline. Taking a flexible volume offline does not affect its containing aggregate in any way. A number of operations being performed on the given volume (or its containing aggregate) can prevent this operation from succeeding, either at all or for various lengths of time. If such operations are found, the system waits up to one second for them to finish. If they don't, the command is aborted. A check is also made for files on the volume opened by internal ONTAP processes. The command is aborted if any are found. Plexes are not supported for Cluster-Mode volumes.This API is not supported for Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Take the specified Infinite Volume offline, thereby making it unavailable for data access. The Infinite Volume must be unmounted before it can be made offline.This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents.
Inputs
Outputs
[Family: vserver]
Bring the specified volume or the plex online. This command takes effect immediately. If there are CIFS shares associated with the volume, they are enabled. Plexes are not supported for Cluster-Mode volumes.This API is not supported for Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Bring the specified Infinite Volume online.This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents.
Inputs
Outputs
[Family: vserver]
Get the options that have been set for the specified volume.Inputs
Outputs
[Family: vserver]
Renames the specified volume to a new name specified by "new-volume-name". If the volume is referenced in the /etc/exports file, remember to make the name change in /etc/exports also so that the affected file system can be exported by the filer after the filer reboots. The "volume-rename" command does not automatically update the /etc/exports file.This API is not supported for Infinite Volumes.
Inputs
Outputs
[Family: vserver]
Renames the specified Infinite Volume to a new name specified by "new-volume-name".This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents.
Inputs
Outputs
[Family: vserver]
Restrict the specified volume, making it unavailable for user-level data access but leaving it (or its containing aggregate, if it's a flexible volume) available to internal OnTAP RAID-level access.This API is not supported for Infinite Volumes. This API is not supported on Infinite Volume constituents.
Inputs
Outputs
[Family: vserver]
Restrict the specified Infinite Volume making it unavailable for data access.This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents.
Inputs
Outputs
[Family: vserver]
Set the option named 'option-name' to the value specified by 'option-value' in the specified volume. The change remains effective even after the filer is rebooted. Some options have values that are numbers or strings, and others have values that are 'on' (also expressible as 'yes', 'true', or '1' ) or "off" (also expressible as 'no', 'false', or '0'). A mixture of uppercase and lowercase characters may be used for an option's value. Note that the 'root' option is special in that it does not have an associated value. Also, note that some of these options can NOT be set for a flexible volume, as they relate only to aggregates (either free-standing ones or those embedded in traditional volumes). Other options may only apply for flexible volumes.Inputs
Outputs
[Family: vserver]
Set a volume's 'files-total' value to the given quantity. This specifies the maximum number of user-visible files that the given volume can hold, as reported by the 'files-total' value within: - the 'volumes' output parameter of the Data ONTAP 7-Mode 'volume-list-info' API, and - the 'attributes-list' output parameter of the Data ONTAP Cluster-Mode 'volume-get-iter' API. Note that this interface corresponds to the following Data ONTAP 7-Mode 'maxfiles' console command and Data ONTAP Cluster-Mode 'volume modify' console command: 'maxfiles <vol-name> <requested_new_max>' 'volume modify -vserver <vserver-name> -volume <volume-name%gt -files <requested_new_max>'Inputs
Outputs
[Family: vserver]
Given the name of a flexible volume, either return its current size or set the volume's size to the stated amount.This API is not supported for Infinite Volumes. Also, this API does not allow to set the volume's size from vFiler context.
Inputs
Outputs
[Family: vserver]
Given the name of an Infinite Volume, either return its current size or set the Infinite Volume's size to the stated amount.This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents.
Inputs
Outputs
[Family: cluster, vserver]
Display a list of volumes and a breakup of their used space. This information is only available when the volume is onlineInputs
Outputs
[Family: cluster, vserver]
Iterate over a list of volume-storage-service objects.Inputs
Outputs
[Family: vserver]
Volume Storage Service RenameInputs
Outputs
[Family: cluster]
Transition a volume between 7-Mode and Cluster-Mode. Currently the only supported operation type is transitioning a 7-Mode Flexible Volume that has been copied from a 7-Mode Filer for the purpose of transitioning it to a Cluster-Mode Flexible Volume. A job-id will be returned that can be used to query to progress of the transition job.Inputs
Outputs
[Family: cluster]
Check to see if a desired volume transition can be performed from one volume type to another. Only 7-mode flexible volume to cluster-mode flexible volume and vice versa with limited options are supported at this time.Inputs
Outputs
[Family: cluster]
Transition a volume from one type to another. Delete the logged information about a transition operation.Inputs
Outputs
[Family: cluster]
Retrieve the logged information about a transition operation.Inputs
Possible values:
If this argument is not provided, then it is equivalent to setting 'desired-levels' to 'all'.
If this argument is not provided, the default is 'all'.
Outputs
[Family: cluster, vserver]
Fence access to volume during Transition.Inputs
Outputs
[Family: vserver]
Unmount a volume from its parent volume and delete the junction path at which the volume is mounted. This API is not supported on Infinite Volume constituents.Inputs
Under certain circumstances, such as an unexpected reboot while in the middle of unmounting, the unmount operation might find that after the reboot, it is unable to delete the junction path at which the volume is mounted in the file system. In this situation, if the force option is set to false, the unmount operation is failed (EJUNCTIONDELETEFAILED), leaving the junction path information intact in the Volume Management Database. Instead, if the force option is set to true, the unmount operation proceeds to delete the junction path information in the Volume Management Database, irrespective of any failure to delete the junction path in the file system.
Outputs
[Family: cluster, vserver]
Returns active scanner pool configuration of a vserver.Inputs
Outputs
[Family: cluster, vserver]
Returns connection status.Inputs
Outputs
[Family: cluster, vserver]
Returns connection status.Inputs
Outputs
[Family: vserver]
Create an On-Access policy.Inputs
Outputs
[Family: vserver]
Delete an On-Access policy.Inputs
Outputs
[Family: cluster, vserver]
Returns list of On-Access policies.Inputs
Outputs
[Family: vserver]
Modify an On-Access policy.Inputs
Outputs
[Family: vserver]
Modify On-Access policy status.Inputs
Outputs
[Family: vserver]
Discard cached information of files that have been successfully scanned.Inputs
Outputs
[Family: vserver]
Apply scanner-policy to a scanner pool.Inputs
Outputs
[Family: vserver]
Create a virus scanner pool, which is used for validating and managing connections between clustered Data ONTAP and Vscan servers.Inputs
Outputs
[Family: vserver]
Delete a scanner pool.Inputs
Outputs
[Family: cluster, vserver]
Returns list of scanner pools. Scanner pool is a set of attributes which are used to validate and manage connections between clustered Data ONTAP and Vscan servers (virus scanners).Inputs
Outputs
[Family: vserver]
Modify a scanner pool.Inputs
Outputs
[Family: cluster, vserver]
Returns Vscan status information.Inputs
Outputs
[Family: vserver]
Modify Vscan status.Inputs
Outputs
[Family: cluster]
Create a new vserver.Inputs
Outputs
[Family: vserver]
Export a data policy for a Vserver with an Infinite Volume. The data policy is exported as a JSON string. For a description of the JSON format, please refer to the Data ONTAP System Administration Guide for Cluster-Mode.Inputs
Outputs
[Family: vserver]
Import a data policy for a Vserver with an Infinite Volume. The data policy is imported as a JSON string. For a description of the required JSON format, please refer to the Data ONTAP System Administration Guide for Cluster-Mode.Inputs
Outputs
[Family: vserver]
Validate without importing a data policy for a Vserver with an Infinite Volume. The data policy needs to be specified as a JSON string. For a description of the required JSON format, please refer to the Data ONTAP System Administration Guide for Cluster-Mode.Inputs
Outputs
[Family: cluster]
Destroys the Vserver and its objects. All volumes and mirrors belonging to the Vserver must be deleted using other APIs before destroying the Vserver. EVOLEXISTS is returned if the Vserver is found to have any volumes or mirrors. This APIS removes all other objects of this Vserver including its network Interfaces, routes, configurations, admin login accounts and roles.Inputs
Outputs
[Family: vserver]
Get the attributes of the vserver.Inputs
Outputs
[Family: cluster, vserver]
Display information about Vservers. Information about Admin Vserver, Node Vserver, and Cluster Vservers is displayed. If the ZAPI is issued to the Cluster LIF with no Vserver specified as input, then information about all Vservers is shown. If the request is sent to the Vserver LIF, then information about that Vserver is shown.Inputs
Outputs
[Family: cluster]
Modify the attributes of vserver object.Inputs
Outputs
[Family: cluster]
Modify the attributes of vserver or a group of vserver objects.Inputs
Outputs
[Family: cluster]
Rename a VserverInputs
Outputs
[Family: cluster]
Start a VserverInputs
Outputs
[Family: cluster]
Stop a VserverInputs
Outputs
[Family: cluster]
Accept a pending Vserver peer relationshipInputs
Outputs
[Family: cluster]
Create a new Vserver peer relationship between two existing VserversInputs
Outputs
[Family: cluster]
Delete a Vserver peer relationshipInputs
Outputs
[Family: vserver]
Display information about Vserver peer relationships. Displays the local Vserver, peer Vserver and the state of the peering relationship.Inputs
Outputs
[Family: cluster, vserver]
Display information about Vserver peer relationships. If the API is issued to the Cluster LIF, then information about all Vservers is shown. If the request is sent to the Vserver LIF, then information about that Vserver is shown.Inputs
Outputs
[Family: cluster]
Modify a Vserver peer relationshipInputs
Outputs
[Family: cluster]
Reject a Vserver peer relationshipInputs
Outputs
[Family: cluster]
Resume a Vserver peer relationshipInputs
Outputs
[Family: cluster]
Suspend a Vserver peer relationshipInputs
Outputs
[Family: cluster]
Create a new transition peer relationship between a Data ONTAP 7-Mode system and a Data ONTAP Cluster-Mode VserverInputs
Outputs
[Family: cluster]
Deletes a transition peer relationshipInputs
Outputs
[Family: cluster]
Deletes multiple transition peer relationshipInputs
Outputs
[Family: cluster, vserver]
Gets a transition peer relationship.Inputs
Outputs
[Family: cluster, vserver]
Gets list of transition peer relationship.Inputs
Outputs
[Family: cluster]
Modifies a transition peer relationshipInputs
Outputs
[Family: vserver]
Returns the status of the previously issued asynchronous Consistency Point operations.Inputs
Outputs
[Family: vserver]
Forces a WAFL consistency point (CP) in order to reduce the time for succeeding fence and snapshot related operations. In Data ONTAP 7-Mode this call is synchronous and will not return until the CP has completed. In Data ONTAP Cluster-Mode this API is asynchronous and will return immediately as soon as the CP is scheduled. The wafl-get-sync-status API can be used to check status of the previously scheduled CP. Two uses of this API areInputs
Outputs
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Possible values are:
"aborting" - wafliron is aborting.
"checking_lost_blocks" - wafliron is checking for lost blocks.
"checking_lost_inodes" - wafliron is checking link counts.
"finishing" - wafliron is cleaning up.
"not_running" - wafliron is not running on this aggregate.
"scanning" - wafliron is scanning inodes, and/or fixing file system inconsistencies.
"starting" - wafliron is starting, allocating, and/or in the initial mounting phase.
"unknown" - wafliron state could not be determined.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, assuming that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
It can be 'connected', 'disconnected' or 'connecting'. Attributes: non-creatable, non-modifiable
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
The UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s. The first grouping has 8 hexadecimal characters, the second through fourth groupings have four hexadecimal characters each, and the fifth and final grouping has 12 hexadecimal characters. Note that a leading '0x' is not used.
This field is available in Data ONTAP 7-mode 7.3.6, 8.0.2, 8.1.0 and later for the igroup-list-info API. This field is available in Data ONTAP Cluster-Mode 8.1.0 and later for the igroup-get-iter and lun-map-list-info APIs.
Here is an example of an actual UUID:
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
A "true" value for this field indicates a normal case when everything went fine while fetching the status values for this volume. All values returned are valid. A "false" value for this field indicates something went wrong while fetching the status values for this volume. Not all values returned are valid. The volume returned may not be a sis volume.
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller.
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
A "true" value for this field indicates a normal case when everything went fine while fetching the status values for this volume. All values returned are valid. A "false" value for this field indicates something went wrong while fetching the status values for this volume. Not all values returned are valid. The volume returned may not be a sis volume. Default: true
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
The default value is valid.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Possible values:
Fields
Starting in Data ONTAP 8.1, "zoned/block" is no longer supported.
Possible values:
Possible values:
Fields
Possible values:
Fields
Fields
Possible vaules:
Possible values:
Possible values:
Possible values:
Fields
Fields
Fields
Fields
Possible values:
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
The fully-qualified pathname in the owning Vserver's namespace at which a volume is mounted. Note that this pathname may itself contain junctions, one for each volume (other than the namespace root volume) that provides storage along the pathname's length. As with all fully-qualified pathnames , this string must begin with '/'. In addition, it must not end with '/'. An Infinite Volume has the additional restriction of allowing only one element.
An example of a valid FlexVol junction path is: '/user/my_volume'. An example of a valid InfiniteVol junction path is: '/repository'.
Only one volume can be mounted at any given junction path.
Fields
The following are the possible language codes along with their names:
To use UTF-8 as the NFS character set, append '.UTF-8' to the language code.
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Fields
If not specified when creating a volume, the Anti-Virus On-Access Policy is inherited from the owning vserver. Currently, this policy can only be managed using the 'antivirus' command line interfaces.
Attributes: optional-for-create, modifiable
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Attributes: optional-for-create, modifiable
Attributes: optional-for-create, modifiable
Attributes: optional-for-create, modifiable
Fields
Attributes: non-creatable, non-modifiable
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
The only legal value for a snapshot identifier is its Data Set ID.
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Fields
Attributes: non-creatable, non-modifiable
The default maximum directory size is set to 1% of the system memory. So if the system memory is 1GB, then the maximum directory size value will be 10MB which allows upto 300,000 files. The number of files that the directory actually can hold varies depending on such things as the length of the names and whether it needs to use double-byte UNICODE characters.
Most users should not need to change this field's default setting. It is useful for environments where system users may grow a directory to a size that starts impacting system performance. When a user tries to create a file in a directory that is at the limit, the system returns a ENOSPC error and fails the create.
Attributes: optional-for-create, modifiable
Attributes: non-creatable, non-modifiable
Fields
Attributes: optional-for-create, modifiable
Fields
The default policy name is 'default'.
This policy applies only to FlexCache volumes and can be created using the 'flexcache-cache-policy-create' API.
Attributes: optional-for-create, modifiable
The default policy name is 'default'.
This policy applies only to FlexCache volumes and can be created using the 'flexcache-fill-policy-create' API.
Attributes: optional-for-create, modifiable
Attributes: optional-for-create, modifiable
Attributes: optional-for-create, non-modifiable
Fields
Possible values:
Attributes: non-creatable, non-modifiable
Fields
Attributes: optional-for-create, modifiable
Possible values:
Attributes: optional-for-create, non-modifiable Possible values:
Attributes: required-for-create, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
This value serves as an internal index for a volume. All volumes on a given controller must have unique FSIDs, except for the two special values described below:
A value of 0 indicates that this volume does not currently have a legal FSID for some unexpected reason. Such volumes are forcibly kept offline until this attribute is assigned a legal value.
A value of 1 indicates that this volume has recently appeared on its current controller due to having its aggregate be copied from a different controller. All volumes in this newly-created aggregate must be assigned legal, controller-unique IDs when they are onlined. That will be handled automatically by WAFL upon mount.
If modifiable, this field may be set only when the volume is restricted. It may be set to any value that is not currently being used by any other volume on the same controller. If a request to set this value to '0' is received, the system will select a new value that is currently unused. Note that setting a volume's FSID sometimes has external effects. In particular, a 7-Mode volume's FSID is part of the NFS file handles constructed for its files.
Attributes: non-creatable, non-modifiable
UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s. The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used.
Here is an example of an actual UUID:
49e370d6-5b5a-11d9-9eb5-000100000529
Attributes: non-creatable, non-modifiable
The junction parent volume must belong to the same vserver that owns this volume.
Attributes: non-creatable, non-modifiable
Attributes: optional-for-create, non-modifiable
This field is valid only for a Cluster-Mode volume.
Attributes: non-creatable, non-modifiable
Attributes: key, required-for-create, non-modifiable
Ordinals are used to disambiguate volumes that have the same base name on the same controller. A value of zero indicates that the base volume name is unique on a controller. A value greater than zero indicates that the volume's base name is used by two or more volumes on the same controller, and that appending '(n)' to this volume's name uniquely identifies it on that controller. A value of -1 indicates that the name ordinal has not yet been determined.
Attributes: non-creatable, non-modifiable
Attributes: key, non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s. The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used.
Here is an example of an actual UUID:
49e370d6-5b5a-11d9-9eb5-000100000529
Attributes: non-creatable, non-modifiable
Possible values:
Default value is 'flex'.
Attributes: non-creatable, non-modifiable
Possible values:
Default value is 'rw'.
Attributes: optional-for-create, non-modifiable
Attributes: non-creatable, non-modifiable
Fields
Possible values:
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Fields
Note that this field can be set to false if and only if the volume is a 7-Mode volume, or a Cluster-Mode volume that was transitioned from 7-Mode.
Attributes: non-creatable, modifiable
Note that this field can be set to false if and only if the volume is a 7-Mode volume.
Attributes: non-creatable, non-modifiable
Example: 'en_US (English (US)).'
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
This field is of the following format:
<asctime> is the timestamp in the language configuration file header and its format is based on the standard: 'A la ISO/IEC 9945-1, ANSI/IEEE Std 1003.1, Second Edition, 1996-07-12.'
It uses the C Programming Language Printf format:
This format takes the following parameters in order:
E.g., If the volume language code is set to 'en_US,' the default NFS character set is as follows:
Attributes: non-creatable, non-modifiable
This field is of the following format:
<asctime> is the timestamp in the language configuration file header and its format is based on the standard: 'A la ISO/IEC 9945-1, ANSI/IEEE Std 1003.1, Second Edition, 1996-07-12.'
It uses the C Programming Language Printf format:
This format takes the following parameters in order:
E.g., If the volume language code is set to 'en_US,' the default OEM character set is as follows:
Attributes: non-creatable, non-modifiable
Fields
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
This mirror's active filesystem can be inconsistent during snapmirror transfer. As a result, snapshot create operation is temporary disabled on this mirror until the current transfer session finishes.
This field is set to true at the start of a SnapMirror transfer session and set to false at the end of that session.
Attributes: non-creatable, non-modifiable
If modifiable, when setting this attribute, invalid snapshot id or a non-existent snapshot id specified will be rejected with error ESNAPSHOTDOESNOTEXIST. Failure to set ('stamp') the attribute in the volume will cause error ESTAMPREDIRECTSNAPIDERROR to be returned. This field can be set only for online volumes. This option is valid only in Cluster-Mode. The volume can be set to have no redirection snapshot by using a value of 0. This option can be set only for Cluster-Mode volumes participating in a logical-mirror relationship. Setting this field on a Cluster-Mode volume which is not a logical mirror destination (yet) will not have any impact on client access or the volume's behavior. The client access will be impacted with regard to this value only when the volume is converted to a logical-mirror destination.
When reading this attribute, the value of 0 indicates volume has no redirection snapshot. The field cannot be interpreted authoritatively if the volume is offline or restricted.
Attributes: non-creatable, non-modifiable
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: key, non-creatable, non-modifiable
Attributes: key, non-creatable, non-modifiable
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
The following values are recognized:
By default, it is set to 'off'.
Using extents may help workloads that perform many small random writes followed by a large sequential read. However, using extents may increase the number of disk operations performed on the controller, so this field should only be turned on when applicable.
Attributes: non-creatable, modifiable
This value is useful for volumes with extremely high read traffic, since it prevents writes to the inode file for the volume from contending with reads from other files.
By default, this value is true.
This field should be used carefully. That is, use this field when you know in advance that the correct access time for inodes will not be needed for files on that volume.
Attributes: non-creatable, modifiable
This option is deprecated.
Attributes: optional-for-create, modifiable
By default, this field is false, causing the node that contains this volume to perform very aggressive read-ahead.
Attributes: non-creatable, modifiable
The following values are recognized:
By default, it is set to 'off'.
Using read reallocation may help workloads that perform a mixture of random writes and large sequential reads.
Attributes: non-creatable, modifiable
Fields
Possible values:
If this field is empty ('') or is not present, this attribute isn't applicable to this volume. For example, security styles don't apply to GX-striped data volumes.
Attributes: optional-for-create, modifiable
Fields
Attributes: optional-for-create, modifiable
It's similar to Unix style permission bits:
In Data ONTAP 7-mode, the default setting of '0755' gives read/write/execute permissions to owner and read/execute to group and other users.
In Data ONTAP Cluster-Mode, for security style 'mixed' or 'unix', the default setting of '0755' gives read/write/execute permissions to owner and read/execute permissions to group and other users. For security style 'ntfs', the default setting of '0000' gives no permissions to owner, group and other users.
It consists of 4 octal digits derived by adding up bits 4, 2 and 1. Omitted digits are assumed to be zeros. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. The second digit selects permission for the owner of the file: read (4), write (2) and execute (1); the third selects permissions for other users in the same group; the fourth for other users not in the group.
Attributes: optional-for-create, modifiable
Attributes: optional-for-create, modifiable
Fields
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
If SIS is enabled, this field is true. If SIS is disabled, this field is false.
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Fields
The default value is true.
Attributes: non-creatable, non-modifiable
The default value is true.
Attributes: non-creatable, modifiable
If true, all initial and intermediate backing snapshots are unlocked for all inactive LUN clones. For active LUN clones, only the backing snapshot will be locked.
If false, the backing snapshot will remain locked until all intermediate backing snapshots are deleted.
Attributes: non-creatable, modifiable
The default policy name is 'default'.
This policy can be created using the 'snapshot-policy-create' API. It can be managed using the 'snapshot-policy-*' APIs.
Attributes: optional-for-create, modifiable
Fields
This option determines the snapshots that 'snapshot autodelete' is allowed to delete to get back space. Setting this option to 'try' only permits the snapshots which are not locked by data protection utilities (dump, mirroring, NDMPcopy) and data-backing functionalities (volume and LUN clones) to be deleted. Setting this option to 'disrupt' permits all snapshots including the snapshots which are locked by data-backing functionalities (volume and LUN clones) to be deleted.
Attributes: non-creatable, modifiable
This option determines which kind of snapshots to delete. Setting this option value to 'scheduled' will delete the snapshots created by the snapshot scheduler last. Setting this option value to 'user_created' will delete the snapshots not created by the snapshot scheduler last. Setting this option value to 'prefix' will delete the snapshots matching the prefix string to be deleted last. Setting this option value to 'none' will disable the above choices.
Attributes: non-creatable, modifiable
This option determines if the oldest or newest snapshot is deleted first.
Attributes: non-creatable, modifiable
This options specifies the list of service that can be destroyed if the snapshot is backing that service. This option is valid only when the commitment is set to 'destroy'. The option 'lun_clone,file_clone' should be used for deleting snapshot backing LUN clone and/or File clone. The option 'lun_clone,sfsr' should be used for deleting snapshot backing LUN clone and/or SFSR. It must be noted that 'lun_clone', 'file_clone' and 'sfsr' individually are not valid values. Only pairs of 'lun_clone,file_clone' and 'lun_clone,sfsr' are supported.
Attributes: non-creatable, modifiable
Attributes: non-creatable, modifiable
Attributes: non-creatable, modifiable
Attributes: non-creatable, modifiable
This option determines the condition in which snapshots should be automatically deleted.
If modifiable, setting this option to 'volume' triggers snapshot autodelete to run when the volume is near full. Setting this option to 'snap_reserve' triggers snapshot autodelete to run when the snap reserve of the volume is near full. Setting this option to 'space_reserve' triggers snapshot autodelete to run when the space reserved in the volume is near full.
Attributes: non-creatable, modifiable
Fields
This option is automatically set to 'true' when a volume becomes SnapMirrored. It remains true after the SnapMirror relationship is broken for the volume. This field allows a volume to be SnapMirrored back to the source without needing to grow the source volume. If the volume size is larger than the file system size, setting this field to false forces the file system to grow to the size of the volume.
Attributes: non-creatable, modifiable
By default, space guarantee is enabled.
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
By default, it is set to 100, indicating that 100% of the required reserved space will actually be reserved so the objects are fully protected for overwrites.
Using a value of less than 100 indicates the percentage of the required reserved space should actually be reserved. This returns the extra space to the available space for the volume, decreasing the total amount of space used. However, this does leave the protected objects in the volume vulnerable to out of space errors, since less than 100% of the required reserved space is actually reserved. If reserved space becomes exhausted, this will cause disruptions on the hosts using the objects. If the percentage is decreased below 100%, it is highly recommended that the administrator actively monitor the space usage on the volume and take corrective action if the reserved space nears exhaustion.
Attributes: non-creatable, modifiable
Attributes: non-creatable, non-modifiable
Attributes: optional-for-create, modifiable
Attributes: non-creatable, non-modifiable
Attributes: optional-for-create, modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Possible options:
This field is valid only if this is a flexible volume and it is online.
Attributes: optional-for-create, modifiable
There are two available settings:
Attributes: non-creatable, modifiable
Fields
By default, this field is false.
Attributes: non-creatable, non-modifiable
By default, this field is false.
Attributes: non-creatable, non-modifiable
By default, this field is false.
Attributes: non-creatable, modifiable
Cluster-Mode volumes are not supported in 7-Mode Data ONTAP deployments. All such volumes are forced offline whenever they are detected in that environment.
Similarly, all 7-Mode volumes on a Data ONTAP Cluster-Mode system (except each controller's root volume) are by default forced offline. There are exceptions, in particular when a 7-Mode volume is being prepared to become that controller's new root volume in a recovery scenario.
At the moment, traditional volumes cannot be Cluster-Mode volumes. On the other hand, all striped volumes are Cluster-Mode volumes.
By default, this field is false.
Attributes: non-creatable, non-modifiable
The default value is false.
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
Attributes: optional-for-create, modifiable
Attributes: non-creatable, non-modifiable
Only the node's internal logic can change this option's value from true to false; this happens when some other volume has the value set to true.
By default, this field is false.
Attributes: non-creatable, non-modifiable
For 7-Mode volumes, it causes the invalidation of all NFS file handles on all volumes affected by the problem so that client-side users are forced to remount the affected file system (and thus not continue to use potentially incorrect data).
It is also possible to specify a set of files per volume that are to be renamed out of the way in these cases. The controller sends error messages to the console whenever such problems are found.
For Cluster-Mode volumes, the volume would be put in a special state called 'in-nvfailed-state' such that protocol access is blocked. This will cause the client applications to crash and thus prevent access to stale data on the volume.
To get out of this situation, the admin needs to manually clear the 'in-nvfailed-state' on the volume.
By default, this value is false.
Attributes: optional-for-create, modifiable
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
By default, this field is false.
Attributes: non-creatable, non-modifiable
Attributes: non-creatable, non-modifiable
When creating a volume, if this field is set to true, the new volume is to become the new namespace root volume of the Vserver. This field can be used in a recovery scenario in which the namespace root volume of the Vserver becomes unrecoverable.
Attributes: optional-for-create, non-modifiable
Possible values:
If an Infinite Volumes constituents are not all in the same state, it will return 'mixed'. The 'mixed' state is read-only.
Attributes: optional-for-create, modifiable
Fields
Possible values:
Attributes: optional-for-create, modifiable
The default setting is equal to the number of striped contituent aggregates.
Attributes: optional-for-create, non-modifiable
Possible values:
Attributes: optional-for-create, modifiable
Possible values:
Attributes: optional-for-create, non-modifiable
The default value is 64 MBytes.
Attributes: optional-for-create, modifiable
Fields
Fields
Fields
Fields
Attributes: optional-for-create, non-modifiable
Attributes: optional-for-create, non-modifiable
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Possible values:
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
Fields
Fields
Copyright (c) 1994-2013 NetApp, Inc. All rights reserved.
The product described in this manual may be protected by one or more U.S.A. patents, foreign patents, or pending applications.
RESTRICTED RIGHTS LEGEND: Use, duplication, or disclosure by the government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.277-7103 (October 1988) and FAR 52-227-19 (June 1987).