NAME

Ontap7ModeAPI - Contains the definitions and description of API Bindings for 7-Mode/7G Data ONTAP systems

SYNOPSIS

         my $s = NaServer->new($server, 1, 0); # create NaServer (server context)
         $s->set_admin_user('admin', 'password'); # provide username and password
         $s->set_bindings_family('7-Mode'); # set the bindings family to 7-Mode for bindings validation
         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
         };
         if($@) { # check for any exception
                 my ($error_reason, $error_code) = $@ =~ /(.+)\s\((\d+)\)/;  # parse out error reason and error code
                 print "Error Reason: $error_reason  Code: $error_code\n"
         }

DESCRIPTION

NetApp Manageability SDK 5.3.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.3.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.

API BINDINGS

aggr_add

[Family: ontap-classic]

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

aggr_check_spare_low

[Family: ontap-classic]

Return true if there is no suitable spare disk available for any filesystem (parity or data) disk.

Inputs

Outputs

aggr_create

[Family: ontap-classic]

Create a new aggregate with the given name. The maximum number of aggregates that can be created on a filer varies by the type of configuration. In a standalone configuration, up to 200 aggregates can be created on a filer (including the aggregates that are "embedded" in traditional volumes, which must be created as a side effect of a traditional volume creation). In an HA configuration, this number drops to 100 and to 50 in a C-mode MetroCluster configuration. 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

aggr_destroy

[Family: ontap-classic]

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

aggr_get_filer_info

[Family: ontap-classic]

Get information on what possibilities and parameters exist for aggregates on a given filer.

Inputs

Outputs

aggr_get_root_name

[Family: ontap-classic, vfiler]

Return the name of the "root" volume on the filer.

Inputs

Outputs

aggr_list_info

[Family: ontap-classic, vfiler]

Get aggregate status.

Inputs

Outputs

aggr_mediascrub_list_info

[Family: ontap-classic]

Get the status of media scrubbing on the named aggregate, plex, or RAID group. Status includes percentage complete and the media scrub's status.

Inputs

Outputs

aggr_mirror

[Family: ontap-classic]

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

aggr_modify_raid_type

[Family: ontap-classic]

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

aggr_offline

[Family: ontap-classic]

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 Data ONTAP processes. The command is aborted if any are found.

Inputs

Outputs

aggr_online

[Family: ontap-classic]

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

aggr_options_list_info

[Family: ontap-classic]

Get the options that have been set for the specified aggregate. This API does not support listing options of striped aggregate.

Inputs

Outputs

aggr_rename

[Family: ontap-classic]

Rename the specified aggregate.

Inputs

Outputs

aggr_restrict

[Family: ontap-classic]

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

aggr_scrub_list_info

[Family: ontap-classic]

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

aggr_scrub_resume

[Family: ontap-classic]

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

aggr_scrub_start

[Family: ontap-classic]

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

aggr_scrub_stop

[Family: ontap-classic]

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

aggr_scrub_suspend

[Family: ontap-classic]

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

aggr_set_option

[Family: ontap-classic]

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

aggr_space_list_info

[Family: ontap-classic]

Show the space usage of the aggregate on a per flexible volume basis. This API is deprecated in Data ONTAP 8.2 and later. Use the aggr-space-info attributes in the aggr-list-info API for details related to aggregate space usage. Use volume-space-list-info and volume-footprint-list-info APIs for details related to volume space usage.

Inputs

Outputs

aggr_split

[Family: ontap-classic]

Remove the specified plex from a mirrored aggregate and create a new unmirrored aggregate with the specified name that contains the plex. The original mirrored aggregate thus becomes unmirrored. The plex to be split from the original aggregate must be functional (not partial), but it can otherwise be inactive, resyncing, or out-of-date. "Aggr split" can therefore be used to gain access to a plex that isn't up to date with respect to its partner plex if its partner plex is currently failed. If the plex is offline at the time of the split, the resulting aggregate will be offline. Otherwise, the resulting aggregate will be in the same online/offline/restricted state as the original aggregate. A split mirror can be joined back together via the "victim-aggregate" option to "aggr-mirror".

Inputs

Outputs

aggr_verify_list_info

[Family: ontap-classic]

Get the status of RAID mirror verification on the named aggregate. Status includes percentage complete and whether it's currently suspended.

Inputs

Outputs

aggr_verify_resume

[Family: ontap-classic]

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

aggr_verify_start

[Family: ontap-classic]

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

aggr_verify_stop

[Family: ontap-classic]

Stop RAID mirror verification on the named aggregate. If no name is given, stop mirror verification on all aggregates currently being verified.

Inputs

Outputs

aggr_verify_suspend

[Family: ontap-classic]

Suspend RAID mirror verification on the named aggregate. If no name is given, suspend mirror verification on all aggregates currently being verified.

Inputs

Outputs

cf_force_takeover

[Family: ontap-classic]

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

cf_get_partner

[Family: ontap-classic, vfiler]

Get the host name of the partner. If the name is unknown, It will return partner-unknown.

Inputs

Outputs

cf_giveback

[Family: ontap-classic]

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

cf_hwassist_stats

[Family: ontap-classic]

Get useful information about statistics of hardware assisted takeover functionality.

Inputs

Outputs

cf_hwassist_status

[Family: ontap-classic]

Get useful information about the status of hw_assist functionality.

Inputs

Outputs

cf_negotiated_failover_disable

[Family: ontap-classic]

Disables negotiated failover. disk_shelf is the negotiated failover module currently supported.

Inputs

Outputs

cf_negotiated_failover_enable

[Family: ontap-classic]

Enables negotiated failover. disk_shelf is the negotiated failover module currently supported.

Inputs

Outputs

cf_negotiated_failover_status

[Family: ontap-classic]

Returns the status of the negotiated failover module. Negotiated failover is a general facility which supports negotiated failover on the basis of decisions made by various modules.

Inputs

Outputs

cf_service_disable

[Family: ontap-classic]

Disables the takeover capability of this filer in the cluster.

Inputs

Outputs

cf_service_enable

[Family: ontap-classic]

Enables the takeover capability of this filer in the cluster. This spawns a process to enable the service

Inputs

Outputs

cf_status

[Family: ontap-classic, vfiler]

Get useful information about the status of the high availability service. If the monitor is not initialized, this returns an error.

Inputs

Outputs

cf_takeover

[Family: ontap-classic]

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

cg_commit

[Family: ontap-classic, vfiler]

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

cg_delete

[Family: ontap-classic]

Deletes the snaps associated with a CG checkpoint in this filer. This API is deprecated as of Data ONTAP 8.2. Applications using this API should transition to snapshot-multidelete API as appropriate.

Inputs

Outputs

cg_start

[Family: ontap-classic, vfiler]

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

cifs_branchcache_hash_stat

[Family: ontap-classic, vfiler]

Display the CIFS BranchCache statistics

Inputs

Outputs

cifs_branchcache_set_key

[Family: ontap-classic, vfiler]

Sets the server secret for BranchCache.

Inputs

Outputs

cifs_homedir_path_get_for_user

[Family: ontap-classic, vfiler]

Return path to the user's CIFS home directory if it exists.

Inputs

Outputs

cifs_homedir_paths_get

[Family: ontap-classic, vfiler]

Return the current list of paths to users' cifs home directories, if any.

Inputs

Outputs

cifs_homedir_paths_set

[Family: ontap-classic, vfiler]

Provides a list of CIFS home directory paths for the filer. Replaces the current list of paths in use by the filer. Note that supplying an empty path list causes the filer to delete any current entries.

Inputs

Outputs

cifs_list_config

[Family: ontap-classic, vfiler]

This ZAPI is used to display the CIFS configuration.

Inputs

Outputs

cifs_nbalias_names_get

[Family: ontap-classic, vfiler]

Return the current list of NetBIOS alias names for the filer

Inputs

Outputs

cifs_nbalias_names_set

[Family: ontap-classic, vfiler]

Provides a list of NetBIOS alias names for the filer. The filer replaces the current list of aliases with with this list. Note that supplying an empty name list causes the filer to delete all current entries.

Inputs

Outputs

cifs_session_list_iter_end

[Family: ontap-classic, vfiler]

Terminate a list iteration and clean up any saved info.

Inputs

Outputs

cifs_session_list_iter_next

[Family: ontap-classic, vfiler]

Returns items from a previous call to cifs-session-list-iter-start.

Inputs

Outputs

cifs_session_list_iter_start

[Family: ontap-classic, vfiler]

Gives information on current CIFS activity. Without arguments, it returns a summary of information about the filer and lists the users who are connected to the filer.

Inputs

Outputs

cifs_setup

[Family: ontap-classic, vfiler]

Configures the filer's CIFS service. The CIFS service will start automatically once this call completes successfully.

Inputs

Outputs

cifs_setup_create_group_file

[Family: ontap-classic, vfiler]

Creates a basic /etc/group file. Note: This will overwrite an existing /etc/group file. See cifs-setup-verify-passwd-and-group for more information.

Inputs

Outputs

cifs_setup_create_passwd_file

[Family: ontap-classic, vfiler]

Creates a basic /etc/passwd file including a root user with the specified password. Note: This will overwrite an existing /etc/passwd file. See cifs-setup-verify-passwd-and-group for more information.

Inputs

Outputs

cifs_setup_ou_list_iter_end

[Family: ontap-classic, vfiler]

Terminate a list iteration and clean up any saved info.

Inputs

Outputs

cifs_setup_ou_list_iter_next

[Family: ontap-classic, vfiler]

Returns items from a previous call to cifs-setup-ou-list-iter-start

Inputs

Outputs

cifs_setup_ou_list_iter_start

[Family: ontap-classic, vfiler]

Gathers a list of joinable sites and organizational units from Active Directory for the login-user specified, which is retrieved by using cifs-setup-ou-list-iter-next. For more information regarding Active Directory organizational units and their use, please reference Microsoft's Active Directory documentation.

Inputs

Outputs

cifs_setup_site_list_iter_end

[Family: ontap-classic, vfiler]

Terminate a list iteration and clean up any saved info.

Inputs

Outputs

cifs_setup_site_list_iter_next

[Family: ontap-classic, vfiler]

Returns items from a previous call to cifs-setup-site-list-iter-start

Inputs

Outputs

cifs_setup_site_list_iter_start

[Family: ontap-classic, vfiler]

Gathers a list of joinable sites and organizational units from Active Directory for the login-user specified, which is retrieved by using cifs-setup-site-list-iter-next. For more information regarding Active Directory sites and their use, please reference Microsoft's Active Directory documentation.

Inputs

Outputs

cifs_setup_verify_name

[Family: ontap-classic, vfiler]

Determines whether or not a particular CIFS server name is already in use on the network and a specified domain.

Inputs

Outputs

cifs_setup_verify_passwd_and_group

[Family: ontap-classic, vfiler]

Determines whether or not the /etc/passwd and /etc/group files exist, which would be used in the event that the configured CIFS authentication method fails.

Inputs

Outputs

cifs_share_ace_delete

[Family: ontap-classic, vfiler]

Deletes the access control entry of the given share or the unix group. This API is equivalent to "cifs access [-g] " CLI.

Inputs

Outputs

cifs_share_ace_set

[Family: ontap-classic, vfiler]

Sets the ace to the share for the given user or unix group. This API is equivalent to "cifs access [-g] " CLI.

Inputs

  • access-rights => string

    • Access rights to be set to the above share and user. The format of the rights can be Unix-style combinations of r w x - or NT-style "No Access", "Read", "Change", and "Full Control"
  • is-unixgroup => boolean, optional

    • This filter is used to tell that the access rights are to be set to the unix group. If its value is true, unix-group-name needs to be provided. Otherwise API fails with the reason "group-name missing". The default value of this is false.
  • share-name => string

    • CIFS share name. It specifies name of the share to which the access rights have to be set. This is a case insensitive field. The maximum size of the share name is 256 characters.
  • unix-group-name => string, optional

    • Name of the unix group. This field specifies the unix group to which the access rights are to be set. The format of this field . This is a case sensitive field. If the specified group name does not exist, it fails with the reason "Unknown Unix group : ".
  • user-name => string, optional

    • Name of the user. This API sets the access rights to the specified user. This is a case sensitive field. The format of the field . If specified user does not exist, It fails with the reason "Unknown user: ".

Outputs

  • None

cifs_share_acl_list_iter_end

[Family: ontap-classic, vfiler]

Terminates a list iteration and cleans up any saved info.

Inputs

  • tag => string

    • Tag from the previous cifs-share-acl-list-iter-start

Outputs

  • None

cifs_share_acl_list_iter_next

[Family: ontap-classic, vfiler]

Returns items from a previous call to cifs-share-acl-list-iter-start.

Inputs

  • maximum => integer

    • The maximum number of entries to retrieve. Range:[0..2^32-1]
  • tag => string

    • Tag from the previous cifs-share-acl-list-iter-start

Outputs

  • records => integer

    • This tells you how many records are being returned from this particular call to cifs-share-acl-list-iter-next. When this value is 0, you have retrieved everything. Range:[0..2^32-1]

cifs_share_acl_list_iter_start

[Family: ontap-classic, vfiler]

Gives information about one or more shares acl.

Inputs

  • share-name => string, optional

    • Cifs share name. If share-name is specified, only information about that share is returned. If share-name is not specified, then information about all the shares is returned. If the name contains the wildcard characters * or ?, then all the shares matching the specified pattern are listed.

Outputs

  • records => integer

    • Number which tells you how many items have been saved for future retrieval with cifs-share-acl-list-iter-next. Range:[0..2^32-1]
  • tag => string

    • Tag to be used in subsequent calls to cifs-share-acl-list-iter-next

cifs_share_add

[Family: ontap-classic, vfiler]

Creates a new CIFS share rooted at the specified path.

Inputs

  • caching => string, optional

    • If specified, the following is done based on the value of the string: "no_caching": disallow Windows clients from caching any files on this share. This is the default value. "auto_document_caching": allow Windows clients to cache user documents on this share. "auto_program_caching": allow Windows clients to cache programs on this share. The actual caching behavior depends on the Windows client. "branchcache": clients connecting to this share can make requests using BranchCache technology that allows them to cache the content in an attempt to reduce WAN utilization from a remote office.
  • comment => string, optional

    • If specified, gives description of the new share. CIFS clients see this description when browsing the filer's shares. If not specified, the description is blank.
  • dir-umask => integer, optional

    • If specified, sets file mode creation mask for a share in qtrees with Unix or mixed security styles. The mask restricts the initial permissions setting of a newly created directory. For directories, this mask overrides one set with "umask".
  • file-umask => integer, optional

    • If specified, sets file mode creation mask for a share in qtrees with Unix or mixed security styles. The mask restricts the initial permissions setting of a newly created file. For files, this mask overrides one set with "umask".
  • forcegroup => string, optional

    • If specified, provides name of the group to which files to be created in the share belong. The groupname is the name of a group in the UNIX group database. If it is an empty string or else not specified, then files to be created in the share do not belong to a particular UNIX group. That is, each file belongs to the same group as the owner of the file.
  • is-access-based-enum => boolean, optional

    • If true Access Based Enumeration (ABE) is enabled, else it is disabled. ABE filtered shared folders are visible to a user based on that individual user's access rights, preventing the display of folders or other shared resources that the user does not have rights to access.
  • is-symlink-strict-security => boolean, optional

    • If true or not specified, strict symlink security is enabled. If false, allows clients to follow symbolic links to destinations on this filer but outside of the current share. It is not checked if the client is authenticated to the symbolic link's destination.
  • is-vscanread => boolean, optional

    • If true or not specified, virus scan is done when clients open files on this share for read access, else no virus scan is done for read access on this share.
  • is-widelink => boolean, optional

    • If true, allows clients to follow absolute symbolic links outside of this share, subject to NT security. This feature requires an entry in the /etc/symlink.translations file and it requires that the client supports Microsoft's Distributed File System (DFS). If false or not specified, widelinks in the share are disabled.
  • maxusers => integer, optional

    • If specified, gives the maximum number of simultaneous connections to the new share. It must be a positive number. If not specified, the filer does not impose a limit on the number of connections to the share.
  • path => string

    • Full path name of the directory on the filer corresponding to the root of the new share.
  • share-name => string

    • Name of the share to be added. The name cannot exceed 12 characters for DOS-style shares and 256 characters for others.
  • umask => integer, optional

    • If specified, sets file mode creation mask for a share in qtrees with Unix or mixed security styles. The mask restricts the initial permissions setting of a newly created file or directory. If not specified, the file mode creation mask of the share is 0. This field is ignored when both dir-umask and file-umask are present.

Outputs

  • None

cifs_share_change

[Family: ontap-classic, vfiler]

Changes settings of one or more CIFS shares at any time, even if the shares are in use.

Inputs

  • caching => string, optional

    • If specified, the following is done based on the value of the string: "no_caching": disallow Windows clients from caching any files on this share. This is the default value. "auto_document_caching": allow Windows clients to cache user documents on this share. "auto_program_caching": allow Windows clients to cache programs on this share. The actual caching behavior depends on the Windows client. "manual_caching": allow users on Windows clients to manually select files to be cached. "branchcache": clients connecting to this share can make requests using BranchCache technology that allows them to cache the content in an attempt to reduce WAN utilization from a remote office.
  • comment => string, optional

    • If specified, changes description of the share. CIFS clients see this description when browsing the filer's shares. Specifying an empty string clears the previous description.
  • dir-umask => integer, optional

    • If specified, changes file mode creation mask for a share in qtrees with Unix or mixed security styles. The mask restricts the initial permissions setting of a newly created directory. For directories, this mask overrides one set with "umask". Specifying an empty string resets (removes) this dir-umask.
  • file-umask => integer, optional

    • If specified, changes file mode creation mask for a share in qtrees with Unix or mixed security styles. The mask restricts the initial permissions setting of a newly created file. For files, this mask overrides one set with "umask". Specifying an empty string resets (removes) this file-umask.
  • forcegroup => string, optional

    • If specified, changes name of the group to which files to be created in the share belong. The groupname is the name of a group in the UNIX group database. If the string is empty, files to be created in the share do not belong to a particular UNIX group. That is, each file belongs to the same group as the owner of the file.
  • is-access-based-enum => boolean, optional

    • If true Access Based Enumeration (ABE) is enabled, if false it is disabled. ABE filtered shared folders are visible to a user based on that individual user's access rights, preventing the display of folders or other shared resources that the user does not have rights to access.
  • is-browse => boolean, optional

    • If true or undefined, share is visible to browsers and can be enumerated.
  • is-namespace-caching-allowed => boolean, optional

    • If true, namespace caching is enabled on the share. If false, namespace caching is disabled on the share. If namespace caching is enabled on a share, clients are allowed to cache the directory enumeration results for better performance.
  • is-symlink-strict-security => boolean, optional

    • If true, strict symlink security is enabled. If false, allows clients to follow symbolic links to destinations on this filer but outside of the current share. It is not checked if the client is authenticated to the symbolic link's destination.
  • is-vscan => boolean, optional

    • If true, virus scan is done when clients open files on this share, else virus scan is not done.
  • is-vscanread => boolean, optional

    • If true, virus scan is done when clients open files on this share for read access, else virus scan is not done for read access.
  • is-widelink => boolean, optional

    • If true, allows clients to follow absolute symbolic links outside of this share, subject to NT security. This feature requires an entry in the /etc/symlink.translations file and it requires that the client supports Microsoft's Distributed File System (DFS). If false, widelinks in the share are disabled.
  • maxusers => integer, optional

    • If specified, changes the maximum number of simultaneous connections to the new share. It must be a positive number or else zero, in which case no limit is imposed on the number of connections to the share.
  • share-name => string

    • If fully specified, it's the name of the existing share to be changed. If the name contains the wildcard characters * or ?, then all the shares matching the specified name are to be changed.
  • umask => integer, optional

    • If specified, changes file mode creation mask for a share in qtrees with Unix or mixed security styles. The mask restricts the initial permissions setting of a newly created file or directory. Specifying a zero value resets (removes) the file mode creation mask. This field is ignored when both dir-umask and file-umask are present.

Outputs

  • None

cifs_share_delete

[Family: ontap-classic, vfiler]

Deletes the specified CIFS share.

Inputs

  • share-name => string

    • The name of the CIFS share. The CIFS share name is a UTF-8 string with the following characters being illegal: control characters from 0x00 to 0x1F, both inclusive, 0x22 (double quotes) and the characters \/[]:|<>+=;,?"*

Outputs

  • None

cifs_share_list_iter_end

[Family: ontap-classic, vfiler]

Terminate a list iteration and clean up any saved info.

Inputs

  • tag => string

    • Tag from a previous cifs-share-list-iter-start.

Outputs

  • None

cifs_share_list_iter_next

[Family: ontap-classic, vfiler]

Returns items from a previous call to cifs-share-list-iter-start

Inputs

  • maximum => integer

    • The maximum number of entries to retrieve.
  • tag => string

    • Tag from a previous cifs-share-list-iter-start.

Outputs

  • records => integer

    • This tells you how many records are being returned from this particular call to cifs-share-list-iter-next. When this value is 0, you have retrieved everything. Range:[0..2^32-1]

cifs_share_list_iter_start

[Family: ontap-classic, vfiler]

Gives information about one or more shares, the results of which are retrieved by using cifs-share-list-iter-next.

Inputs

  • share-name => string, optional

    • Cifs share name. If share-name is specified, only information about that share is returned. If share-name is not specified, then information about all the shares is returned. If the name contains the wildcard characters * or ?, then all the shares matching the specified name are listed.

Outputs

  • records => integer

    • Number which tells you how many items have been saved for future retrieval with cifs-share-list-iter-next.
  • tag => string

    • Tag to be used in subsequent calls to cifs-share-list-iter-next.

cifs_start

[Family: ontap-classic, vfiler]

Starts the CIFS service, usually after a previous call to cifs-stop as the CIFS service starts automatically when cifs-setup completes successfully or the system reboots.

Inputs

  • None

Outputs

  • None

cifs_status

[Family: ontap-classic, vfiler]

Returns the running state of the CIFS service.

Inputs

  • None

Outputs

  • status => string

    • The current status of the CIFS service, which will be one of the following: STOPPED, STARTED, STOPPING, STARTING

cifs_stop

[Family: ontap-classic, vfiler]

Stops the CIFS service for all users or a particular workstation, if specified. Appropriate warning should be given to connected clients before calling this API, as it will immediately terminate those sessions regardless of their current state. See the cifs-sessions API for the list of clients that are currently connected.

Inputs

  • workstation => string, optional

    • The name or IP address of a workstation that will be disconnected from the CIFS service. Note that the CIFS service does not stop if this value is specified, it simply disconnects related sessions.

Outputs

  • None

cifs_top_iter_end

[Family: ontap-classic, vfiler]

Terminate a list iteration and clean up any saved info.

Inputs

  • tag => string

    • Tag from a previous cifs-top-iter-start.

Outputs

  • None

cifs_top_iter_next

[Family: ontap-classic, vfiler]

Returns items from a previous call to cifs-top-iter-start.

Inputs

  • maximum => integer

    • The maximum number of entries to retrieve.
  • tag => string

    • Tag from a previous cifs-top-iter-start.

Outputs

  • records => integer

    • This tells you how many records are being returned from this particular call to cifs-top-iter-next. When this value is 0, you have retrieved everything.

cifs_top_iter_start

[Family: ontap-classic, vfiler]

Display CIFS client statistics

Inputs

  • avgtype => string, optional

    • Specifies how the client statistics are to be averaged for display: "smooth": Use a smoothed average which is weighted towards recent behavior but takes into account previous history of the client. "now": Use a one-second sample taken immediately and no history is taken into account. "total": Use the total count of each statistic divided by the total time since sampling started. If the is-verbose option is also set, the totals are given without dividing by the sample time.
  • sortgroup => string, optional

    • If specified, the client statistics are sorted by the value of the string: "ops": Sort by the number of operations per second of any type. "reads": Sort by kbytes/sec of data in response to read requests. "writes": Sort by kbytes/sec of data written to the filer. "ios": Sort by the combined total of reads plus writes for each client. "suspicious": Sort by the number of "suspicious" events per second by each client.

Outputs

  • records => integer

    • Number which tells you how many items have been saved for future retrieval with cifs-session-list-iter-next. Range:[0..2^32-1]
  • tag => string

    • Tag to be used in subsequent calls to cifs-session-list-iter-next.

clock_get_clock

[Family: ontap-classic]

gets current date and time from filer.

Inputs

  • is-compliance-clock => boolean, optional

    • If true, then local-time and utc-time are values for the compliance clock, otherwise they are values for the local clock. Default is false. Note: This field is deprecated in Data ONTAP 8.1 and later. If true, the operation will fail with error EOPNOTSUPPORTED. Clients should use the API snaplock-get-system-compliance-clock or snaplock-get-volume-compliance-clock as applicable to get the compliance clock time.

Outputs

  • local-time => integer

    • Local date and time of the filer in seconds since Midnight, 1/1/1970. Depending on the time zone and clock settings, this might be negative by up to 12 hours.

clock_get_timezone

[Family: ontap-classic]

Gets current timezone and timezone file version.

Inputs

  • None

Outputs

  • timezone => string

    • Current timezone name where the storage system is operating. A timezone can have one of the two formats:
    1. "Using a location string specified in Arthur David Olsen's public domain time zone database. For example, "Americas/New_York" represents most of the Eastern Time Zone.";
    2. "A traditional time zone abbreviation incorporating default rules for daylight savings time. For example, "EST5EDT" for the US Eastern Time Zone.";
  • timezone-UTC => string

    • Current timezone of the storage system in UTC +/-hhmm format. This indicates that the local time zone is hh hours and mm minutes ahead or behind UTC. For example, Central European Time(CET) is +0100 and U.S./Canadian Eastern Standard Time(EST) is -0500.
  • timezone-version => string

    • Version of the time zone database. "YYYY" is the year the data base was released and "v" is the version within that year. "YYYY" will be four decimal digits and "v" will be an ASCII letter starting with "a" and increasing with each version. For example, the second 2007 version is "2007b".

clock_set_clock

[Family: ontap-classic]

Set current date and time to the specified date and time.

Inputs

  • time => integer

    • Actual value of the date and time which has to be set as the current date and time on filer. Value will be seconds since Midnight, 1/1/1970. Depending on the time zone and clock settings, this might be negative by up to 12 hours.

Outputs

  • None

clock_set_timezone

[Family: ontap-classic]

Set current timezone to the specified timezone.

Inputs

  • timezone => string

    • Name of the timezone value which has to be set as current timezone value. A timezone can have one of the two formats:
    1. "Using a location string specified in Arthur David Olsen's public domain time zone database. For example, "Americas/New_York" represents most of the Eastern Time Zone.";
    2. "A traditional time zone abbreviation incorporating default rules for daylight savings time. For example, "EST5EDT" for the US Eastern Time Zone.";

Outputs

  • None

clone_clear

[Family: ontap-classic, vfiler]

Clears information of a failed clone operation. If not successful, the error code will be returned as API error. This API is deprecated in Data ONTAP 8.1 and later, and will always fail with EDENSE_CLONE_NOT_RUNNING.

Inputs

Outputs

  • None

clone_list_status

[Family: ontap-classic, vfiler]

Gets the information of a clone operations identified by clone-id. If clone-id is not specified, then it will get the status of all running and failed clone operation on the filer. It will get the status as 'running', 'failed' or 'completed'. User may see some other transient status for the clone operation, but any other status should be considered for polling clone-list-status again. User should keep polling clone-list-status till status returned is 'failed' or 'completed'. If status is 'completed', the clone operation has been completed successfully. If status is 'failed', then user is responsible for doing clone-clear to clean the status of the clone information. When a clone operation is aborted using clone-stop, it may take some time to stop the clone operation. User should poll clone-list-status till status returned is 'completed'. When status returned is 'completed' after clone-stop, the clone operation has been stopped successfully. This API is deprecated in Data ONTAP 8.1 and later. If a clone-id from a previous successful call to clone-start is provided, the operation will always be in the "completed" state.

Inputs

  • clone-id => clone-id-info, optional

    • ID information of the clone operation. If not specified, it will get the status of all running and failed clone operations on the filer.

Outputs

  • status => ops-info[], optional

    • List of information of running and failed clone operations on the filer.

clone_start

[Family: ontap-classic, vfiler]

In Data ONTAP 8.0 and earlier this API starts a file/LUN or sub-file/sub-LUN clone operation asynchronously. If clone operation starts successfully, a unique clone-id is returned. User is supposed to poll clone-list-status specifying clone-id to get the status of the clone operation. When clone-list-status returns status as completed, user can consider that the clone operation has been completed successfully. If user gets status as failed, user is responsible for doing clone-clear which will clean the status of the clone operation. In Data ONTAP 8.1 and later, this API performs a file/LUN or sub-file/sub-LUN clone operation synchronously. When this API returns successfully, the destination file is ready for use.

Inputs

  • block-ranges => block-range[], optional

    • List of block ranges for sub-file/sub-LUN cloning. The number of block ranges is limited to 32. For sub-LUN cloning the block range specified will be considered as SCSI LBA range. If only one block range is supplied, the source and destination range must not overlap and both ranges must not extend past the end of the file If multiple block ranges are specified in one operation, the user must ensure all source and destination ranges do not overlap, otherwise the result is undefined. In case of sub-LUN cloning, the API will copy data in case the LBAs are not block aligned. If the user provides LBAs such that actual number of blocks to be cloned is zero, then API will return error. The API will fail if the source range overlaps with the destination range or if the source and the destination ranges overlap amongst themselves. If block range is not provided then the file/LUN cloning is fully cloned.
  • change-log => boolean, optional

    • If this option is "true", fingerprints of data blocks of the destination file/block ranges created will be change logged to the change log file if A-SIS is enabled on the volume. With change logging clone operation will be slow, as to get fingerprints all the data blocks will be read. Without change logging clone operation deals with only indirect blocks without reading data blocks. Without change logging, fingerprints of the clone blocks are not recorded. The clone blocks are shared with the source blocks, but as later the source blocks are modified, corresponding clone blocks will no longer be shared. If change logging option is not used, clone blocks, which could be involved in sharing with rest of the file system, can not be shared in next sis operation. The only option, in case user had not used change logging while creating clone, will be to start sis from beginning using "sis start -s" to gather fingerprints of clone blocks. In Data ONTAP 8.1 and later, this field is accepted for backwards compatibility and is ignored.
  • destination-path => string, optional

    • Full path of the Destination file or LUN in //file-path format. Destination path should be in same flexible volume as "source-path". If not specified, a sub-range clone of the source file or LUN will be performed onto itself. Either "destination-path" or "block-ranges" must be specified.
  • ignore-locks => boolean, optional

    • Clone even if (advisory/mandatory) byte_range locks or share_mode locks exist on the source or destination. By default value is false.
  • ignore-streams => boolean, optional

    • Clone only the base file and ignore streams on source or destination. By default value is false so streams are also cloned from source and existing destination streams are deleted.
  • no-snap => boolean, optional

    • If no-snap is FALSE or unspecified, then a temporary snapshot will be taken and source file locked in snapshot will be considered for cloning. So that the clone operation does not get affected by writes to the source file in parallel to the clone operation. User will get atomic point in time copy of the source. Irrespective of clone operation completes successfully or unsuccessfully, any temporary snapshot taken for cloning will be deleted automatically. If no-snap is "true", then the source file in AFS will be used for cloning. In this case user may get random data in clone if source file is modified while clone operation is in progress. This option should only be used when user is assured that the source file will remain consistent during the clone operation. Destination file is not protected against any modification while clone operation is in progress. User should use the destination file or destination block ranges after clone operation is finished. In Data ONTAP 8.1 and later, this field is accepted for backwards compatibility and is ignored.
  • snapshot-name => string, optional

    • Snapshot name from which to clone the source file or LUN. If not specified, the contents of in the active filesystem will be used. This field is available in Data ONTAP 8.1 or later
  • space-reserve => boolean, optional

    • Set the space reservation of the destination clone. By default space reservation is inherited from source. The API errors out if used in conjunction with block range arguments, since space reservations cannot be set for a block range.

Outputs

  • clone-id => clone-id-info

    • Unique ID information for the clone operation returned if clone operation starts successfully. This field is deprecated in Data ONTAP 8.1 and later, the returned value is guaranteed to be a completed clone operation if supplied to clone-list-info.

clone_stop

[Family: ontap-classic, vfiler]

Stops a running clone operation. If not successful, the error code will be returned as API error. This API is deprecated in Data ONTAP 8.1 and later, and will always fail with EDENSE_CLONE_NOT_RUNNING.

Inputs

  • clone-id => clone-id-info

    • ID information of the clone operation.

Outputs

  • None

copyoffload_copy_abort

[Family: ontap-classic, vfiler]

Abort an on-going copyoffload-copy-file request.

Inputs

Outputs

copyoffload_copy_start

[Family: ontap-classic, vfiler]

Copy specified whole/sub source file to specified destination file. This operation is handled asynchronously. Source and destination files must exist. The calling entity must poll for a status indication, via the copyoffload-copy-status, until either a failure or completed state is returned. still have copied some portion of the source to the destination: a copy operation involves multiple iterations of data copy before completing and may fail after some number of sub-copy operations. The caller should reissue the copy operation request to either reattempt the operation or to restore the destination to its previous content. Copy operations are not persistent over reboots or takeover scenarios.

Inputs

  • length => integer, optional

    • Number of bytes to copy from the source file to the destination file. The byte count must be a multiples of 4,096. If not specified, the source file is copied from the source offset to the end of file. An error of ECOL_COPY_INVALIDINPUTERROR will be returned if length is zero or not a multiple of 4,096.
  • source-offset => integer, optional

    • Byte offset in source file which to start the copy of data, aligned on a 512 byte boundary. If not specified, copy will start at beginning of file.
  • source-path => string

    • Full path of the source file from where the data will be copied, in /vol// format.

Outputs

  • copy-id => string

    • Unique identifier for the copy operation returned if copy operation begins successfully. This copy identifier must be presented in any subsequent request for this on-going copy operation.

copyoffload_copy_status

[Family: ontap-classic, vfiler]

Provide status on an on-going copyoffload-copy-file request. The response will indicate the state of the on-going operation and the number of bytes copied thus far.

Inputs

Outputs

copyoffload_modify

[Family: ontap-classic, vfiler]

Set copy offload feature state {enable | disable}.

Inputs

Outputs

  • None

copyoffload_show

[Family: ontap-classic, vfiler]

Show current copy offload feature state.

Inputs

  • None

Outputs

  • copyoffload-state => string

    • Displays current Copy Offload feature state. Possible values are: "enabled" or "disabled".

dfm_get_server_info

[Family: ontap-classic, vfiler]

Get the DFM server configuration

Inputs

  • None

Outputs

  • dfm-server => string

    • DFM server identifier which was previously saved with the API DFM-set-server. If no server has been set, then error EONTAPI_ENOENT is returned.
  • is-dfm-cross-linked => boolean

    • The previously saved setting for cross-linked status. If DFM has been previously been marked as cross-linked then "true" is returned. If DFM has been previously marked as not cross-linked or is not set then "false" is returned. When this setting is true, FilerView will provide cross-links to the DFM server.
  • protocol => string, optional

    • Protocol in use by DFM. Possible values are "http" and "https". Not returned if not previously set.

dfm_set_server_info

[Family: ontap-classic, vfiler]

Set the DFM server configuration

Inputs

  • force => boolean, optional

    • If true then overwrite existing settings if they exist. If false, write the new settings only if no DFM server is set, otherwise do not perform any modifications. By default, the value for this parameter is true.
  • is-dfm-cross-linked => boolean, optional

    • If true then set DFM's cross-linked status. If false or not supplied, set cross-linked status to false. When this setting is true, FilerView provides cross-links to the specified DFM server.
  • port => integer, optional

    • Port used for DFM requests. If not supplied then clear the current value. Range : [1..2^16-1]
  • protocol => string, optional

    • Protocol in use by DFM. Possible values are "http" and "https". If not supplied then clear the current value.

Outputs

  • None

diagnosis_alert_definition_get

[Family: ontap-classic]

Return alert definition

Inputs

  • desired-attributes => diagnosis-alert-definition-info, optional

    • Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.

Outputs

diagnosis_alert_definition_get_iter

[Family: ontap-classic]

Iterate over a list of Alert Definition objects.

Inputs

  • desired-attributes => diagnosis-alert-definition-info, optional

    • Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
  • query => diagnosis-alert-definition-info, optional

    • A query that specifies which objects to return. A query could be specified on any number of attributes in the Alert Definition object. All Alert Definition objects matching this query up to 'max-records' will be returned.
  • tag => string, optional

    • Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.

Outputs

diagnosis_alert_get

[Family: ontap-classic]

Return a subsystem alert

Inputs

  • alert-id => string

    • Alert identification.
  • desired-attributes => diagnosis-alert-info, optional

    • Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
  • monitor => hm-type

    • Type of health monitor (e.g. node_connect, system_connect, system).
  • node => string

    • Node hosting this health monitor.

Outputs

diagnosis_alert_get_iter

[Family: ontap-classic]

Iterate over a list of Alert Information objects.

Inputs

  • desired-attributes => diagnosis-alert-info, optional

    • Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
  • max-records => integer, optional

    • The maximum number of records to return in this call. Default: 20
  • query => diagnosis-alert-info, optional

    • A query that specifies which objects to return. A query could be specified on any number of attributes in the Alert Information object. All Alert Information objects matching this query up to 'max-records' will be returned.
  • tag => string, optional

    • Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.

Outputs

  • next-tag => string, optional

    • Tag for the next call. Not present when there are no more Alert Information objects to return.
  • num-records => integer

    • The number of records returned in this call.

diagnosis_alert_modify

[Family: ontap-classic]

Acknowledge/suppress an alert

Inputs

  • alert-id => string

    • Alert identification.
  • alerting-resource => string

    • Unique name of resource that generated the alert.
  • monitor => hm-type

    • Type of health monitor (e.g. node_connect, system_connect, system).
  • node => string

    • Node hosting this health monitor.

Outputs

  • None

diagnosis_config_get

[Family: ontap-classic]

Return the system health framework configuration

Inputs

  • desired-attributes => diagnosis-config-info, optional

    • Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
  • monitor => hm-type

    • Type of health monitor (e.g. node_connect, system_connect, system).
  • node => string

    • Node hosting this health monitor.

Outputs

diagnosis_config_get_iter

[Family: ontap-classic]

Iterate over a list of Health Monitor Configuration objects.

Inputs

  • desired-attributes => diagnosis-config-info, optional

    • Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
  • max-records => integer, optional

    • The maximum number of records to return in this call. Default: 20
  • query => diagnosis-config-info, optional

    • A query that specifies which objects to return. A query could be specified on any number of attributes in the Health Monitor Configuration object. All Health Monitor Configuration objects matching this query up to 'max-records' will be returned.
  • tag => string, optional

    • Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.

Outputs

  • next-tag => string, optional

    • Tag for the next call. Not present when there are no more Health Monitor Configuration objects to return.
  • num-records => integer

    • The number of records returned in this call.

diagnosis_delete_alert

[Family: ontap-classic]

Delete subsystem alert

Inputs

  • alert-id => string

    • Alert identification.
  • alerting-resource => string

    • Unique name of resource that generated the alert.
  • monitor => hm-type

    • Type of health monitor (e.g. node_connect, system_connect, system).
  • node => string

    • Node hosting this health monitor.

Outputs

  • None

diagnosis_policy_definition_get

[Family: ontap-classic]

Return policy definition

Inputs

  • desired-attributes => diagnosis-policy-definition-info, optional

    • Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
  • monitor => hm-type

    • Type of health monitor (e.g. node_connect, system_connect, system).
  • node => string

    • Node hosting this health monitor.

Outputs

diagnosis_policy_definition_get_iter

[Family: ontap-classic]

Iterate over a list of Policy Definition objects.

Inputs

  • desired-attributes => diagnosis-policy-definition-info, optional

    • Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
  • max-records => integer, optional

    • The maximum number of records to return in this call. Default: 20
  • query => diagnosis-policy-definition-info, optional

    • A query that specifies which objects to return. A query could be specified on any number of attributes in the Policy Definition object. All Policy Definition objects matching this query up to 'max-records' will be returned.
  • tag => string, optional

    • Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.

Outputs

  • next-tag => string, optional

    • Tag for the next call. Not present when there are no more Policy Definition objects to return.
  • num-records => integer

    • The number of records returned in this call.

diagnosis_policy_modify

[Family: ontap-classic]

Enable/disable policy

Inputs

  • monitor => hm-type

    • Type of health monitor (e.g. node_connect, system_connect, system).
  • node => string

    • Node hosting this health monitor.
  • policy-id => string

    • Policy identifier.

Outputs

  • None

diagnosis_status_get

[Family: ontap-classic]

Return the overall system health

Inputs

  • desired-attributes => diagnosis-status, optional

    • Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.

Outputs

diagnosis_subscriptions_create

[Family: ontap-classic]

Create a new Subscriptions for Notifications.

Inputs

  • monitor => hm-type

    • Type of source health monitor (e.g. node_connect, system_connect, system).
  • node => string

    • Node hosting this health monitor and sends out notifications

Outputs

diagnosis_subscriptions_get

[Family: ontap-classic]

Return system health subscription

Inputs

  • class-name => string

    • Class name of changed resource.
  • desired-attributes => diagnosis-subscriptions-info, optional

    • Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
  • event-type => hm-event-type

    • Type of event (rm-add, rm-del, rm-mod) for which notification is to be generated.
  • monitor => hm-type

    • Type of source health monitor (e.g. node_connect, system_connect, system).
  • node => string

    • Node hosting this health monitor and sends out notifications
  • notify-dest-hm => hm-type

    • Health monitor subsribing for notification.
  • notify-dest-node => node-name

    • Node hosting the health monitor that is subscribing for notification.
  • subscription-id => string

    • Subscription identifier.

Outputs

diagnosis_subscriptions_get_iter

[Family: ontap-classic]

Iterate over a list of Subscriptions for Notifications objects.

Inputs

  • desired-attributes => diagnosis-subscriptions-info, optional

    • Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
  • max-records => integer, optional

    • The maximum number of records to return in this call. Default: 20
  • query => diagnosis-subscriptions-info, optional

    • A query that specifies which objects to return. A query could be specified on any number of attributes in the Subscriptions for Notifications object. All Subscriptions for Notifications objects matching this query up to 'max-records' will be returned.
  • tag => string, optional

    • Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.

Outputs

  • next-tag => string, optional

    • Tag for the next call. Not present when there are no more Subscriptions for Notifications objects to return.
  • num-records => integer

    • The number of records returned in this call.

diagnosis_subscriptions_modify

[Family: ontap-classic]

Modify system health subscription

Inputs

  • class-name => string

    • Class name of changed resource.
  • event-type => hm-event-type

    • Type of event (rm-add, rm-del, rm-mod) for which notification is to be generated.
  • fail-thresh => integer, optional

    • Failure threshold for notification.
  • instance-name => string, optional

    • Instance name of changed resource.
  • max-notify-period => integer, optional

    • Maximum expected time for Notification to complete.
  • monitor => hm-type

    • Type of source health monitor (e.g. node_connect, system_connect, system).
  • node => string

    • Node hosting this health monitor and sends out notifications
  • notify-dest-hm => hm-type

    • Health monitor subsribing for notification.
  • notify-dest-node => node-name

    • Node hosting the health monitor that is subscribing for notification.
  • notify-table => string, optional

    • Table name for DSMF notification.
  • psc-option => boolean, optional

    • Enable/Disable periodic status confirmation.
  • subscription-id => string

    • Subscription identifier.
  • time-gap-notify => integer, optional

    • Time Period between two notifications.

Outputs

  • None

diagnosis_subsystem_config_get

[Family: ontap-classic]

Get the attributes of the Health Monitor Subsystem Status.

Inputs

  • desired-attributes => diagnosis-subsystem-config-info, optional

    • Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.

Outputs

diagnosis_subsystem_config_get_iter

[Family: ontap-classic]

Iterate over a list of Health Monitor Subsystem Status objects.

Inputs

  • desired-attributes => diagnosis-subsystem-config-info, optional

    • Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
  • max-records => integer, optional

    • The maximum number of records to return in this call. Default: 20
  • query => diagnosis-subsystem-config-info, optional

    • A query that specifies which objects to return. A query could be specified on any number of attributes in the Health Monitor Subsystem Status object. All Health Monitor Subsystem Status objects matching this query up to 'max-records' will be returned.
  • tag => string, optional

    • Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.

Outputs

  • next-tag => string, optional

    • Tag for the next call. Not present when there are no more Health Monitor Subsystem Status objects to return.
  • num-records => integer

    • The number of records returned in this call.

disk_fail

[Family: ontap-classic]

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

  • disk => string

    • Name of the disk to fail, e.g. "v0.1". On Admin Vserver LIF, this will be disk path name with format of ":". e.g. "Filer01:v0.1"

Outputs

  • None

disk_list_info

[Family: ontap-classic, vfiler]

Get disk/array LUN status information from RAID. By default, only disks/array LUNs owned by the storage system or its partner are eligible for inclusion in the returned list. Unowned disks/array LUNs may be displayed by using the ownership-type option. To obtain information about disks/array LUNs connected to the storage system, but owned by a system other than the local system or its CFO partner use the disk-sanown-list-info api.

Inputs

  • disk => string, optional

    • Get status for given disk, if not supplied, get status for all disks owned by the system and its CFO partner.
  • ownership-type => string, optional

    • This field is used to specify which disks/array LUNs are listed. Valid values are 'assigned', 'unassigned' and 'all'. If ownership-type is set to 'assigned' then only assigned disks/array LUNs are returned. If ownership-type is set to 'unassigned' then only unassigned disks/array LUNs are returned. If ownership-type is set to 'all' then both assigned and unassigned disks/array-LUNs are returned. The default is to return assigned disks/array LUNs. Default: 'assigned'.

Outputs

disk_release_all_reservations

[Family: ontap-classic]

Release reservations on all reserved disks. When invoked from maintenance mode, all reservations are released on all disks until the system is rebooted. When not in maintenance mode, then the system will automatically re-issue reservations for disks it owns. In sanown environment the system will reserve its disks everu 30 seconds.

Inputs

  • None

Outputs

  • None

disk_remove

[Family: ontap-classic]

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

  • disk => string

    • Name of the disk to remove, e.g. "v0.1". On Admin Vserver LIF, this will be disk path name with format of ":Disk Name". e.g. "Filer01:2a.32"

Outputs

  • None

disk_replace_start

[Family: ontap-classic]

Initiate replacing a file system disk with an appropriate spare disk. Uses Rapid RAID Recovery to copy data from the source file system disk to the destination spare disk. Roles of disks are reversed at the end of that process. The spare disk will replace the file system disk in the RAID group and the file system disk will become a spare. This interface returns as soon as possible while disk replace starts in the background. This process can be observed by polling disk-list-info for this disk and tracking values of elements copy-destination and copy-percent. Note: The operation performs limited error checking. Disk replace starts asynchronously in the background, and it can fail even if ZAPI reports success.

Inputs

  • allow-same-carrier => boolean, optional

    • Using two disks from one carrier that houses multiple disks in one RAID group is not desirable. If that happens, Data ONTAP initiates a series of disk copy operations to correct that situation. Sometimes, selection of available spare disks makes it impossible to avoid placing two disks from one carrier in one RAID group. Setting this option to true allows placing two disks from one carrier in one RAID group.
  • disk => string

    • Name of the file system disk to replace.
  • force => boolean, optional

    • Allow replacement-disk to come from the opposite spare pool. Also allow replacement-disk not matching rotational speed of majority of disks in the aggregate.

Outputs

  • None

disk_replace_stop

[Family: ontap-classic]

Abort disk replace.

Inputs

  • disk => string

    • Name of the file system disk being replaced.

Outputs

  • None

disk_sanown_assign

[Family: ontap-classic]

Assigns ownership of a disk. The normal usage is when the disk is unowned, or to assign a disk to a pool.

Inputs

  • all => boolean, optional

    • Assign all unowned visible disks to the specified node. The node parameter is mandatory. No other parameter is allowed with this option.
  • auto => boolean, optional

    • Auto-assign unowned disks which are on loops where only 1 filer owns the disks and the pool information is the same, to the specified node. The node parameter is mandatory. No other parameter is allowed with this option.
  • checksum => string, optional

    • Assign checksum type to disk. Option may only be specified on a RAID array LUNs. Possible values: 'block' or 'zoned'.
  • disk => string, optional

    • Name of disk to assign. Wildcarding for disk string is supported. Either owner or owner-id is mandatory. The node parameter is not allowed with this option.
  • disk-count => integer, optional

    • Assign specified count of disks
  • disk-type => string, optional

    • Assign specified type of disk(or set of disks). The disk-count parameter is mandatory. Type of disk: ATA, BSAS, EATA, FCAL, FSAS, LUN, MSATA, SAS, SATA, SCSI, SSD, BSSD, XATA, XSAS, or unknown.
  • force => boolean, optional

    • Force flag need to be set to 'true' if assigning disks which are already owned a Filer. However, if that Filer is up and has put a reservation on the disk, even the force option won't work.
  • node-name => string, optional

    • Used only with auto or all parameter. It specifies the node to which autoassignment or assignment of all unowned disks must be done.
  • owner-id => integer, optional

    • Assign disk to specific owner ID (NVRAM ID or serial number). Either owner or owner-id is mandatory Range : [0..2^32-1].

Outputs

  • None

disk_sanown_filer_list_info

[Family: ontap-classic]

Get sanown filer information.

Inputs

  • None

Outputs

disk_sanown_list_info

[Family: ontap-classic]

Get sanown disk information. This API is not supported as of Data ONTAP 8.2. Use storage-disk-get-iter instead.

Inputs

  • disk => string, optional

    • Get ownership status for given disk, if not supplied, get ownership for all disks or if onership-type is supplied, get ownership info for disks of specific type. '6a*' wildcarding is supported.
  • ownership-type => string, optional

    • Possible values are 'all' which will list all disks. 'unowned' which will list all disks without owners. 'owned' which will list all disks with owners. 'visible' which will list all disks belonging to the local and partner filer. Default is 'all'. If specific disk is specified, ownership-type will be ignored.

Outputs

disk_sanown_reassign

[Family: ontap-classic]

Changes ownership on disks already belonging to an owner.

Inputs

  • force => boolean, optional

    • Force flag need to be set to 'true' if reassigning disks which are owned by another Filer. However, if that Filer is up and has put a reservation on the disk, even the force option won't work. In this case reassign will need to be run on the Filer which owns the disks.
  • new-owner-id => integer, optional

    • ID of new owner. This form will assign all the disks belonging to the old owner to the specific owner ID. Either new-owner or new-owner-id (or both) must be specified. Range : [0..2^32-1].
  • old-owner => string, optional

    • Name of old owner. This form takes all disks currently belonging to the specific old owner, and reassigns them to a new owner.
  • old-owner-id => integer, optional

    • ID of old owner. This form takes all disks currently belonging to the specific old owner ID, and reassign them to a new owner. Either old-owner or old-owner-id must be specified, but not both. Range : [0..2^32-1].

Outputs

  • None

disk_sanown_remove_ownership

[Family: ontap-classic]

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

  • all => boolean, optional

    • If 'true' remove ownership information from all disks. (maintenance mode only)
  • force => boolean, optional

    • If 'true' override the RAID checks. Eg: Disk is part of aggregate. Otherwise defaults to false.
  • owner => string, optional

    • Remove ownership of all disks owned by owner. Either owner or owner-id is mandatory
  • owner-id => integer, optional

    • Remove ownership of all disks owned by this owner-id (maintenance mode only). Range [0..2^32-1]

Outputs

  • None

disk_swap

[Family: ontap-classic]

Prepare (quiet) bus for swap. Applies to SCSI disks only. It stalls all I/O on the filer to allow a disk to be physically added or removed from a disk shelf. Typically, this command would be used to allow removal of a failed disk, or of a file system or spare disk that was prepared for removal using the disk fail or disk remove command. Once a disk is physically added or removed from a disk shelf, system I/O will automatically continue. NOTE: It is important to issue the disk swap command only when you have a disk that you want to physically remove or add to a disk shelf, because all I/O will stall until a disk is added or removed from the shelf. This API is not supported in Data ONTAP 8.0 and later.

Inputs

  • None

Outputs

  • None

disk_unfail

[Family: ontap-classic]

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

  • disk => string

    • Name of the disk, e.g. "v0.1". On Admin Vserver LIF, this will be disk path name with format of ":Disk Name". e.g. "Filer01:2a.32"

Outputs

  • None

disk_unswap

[Family: ontap-classic]

Undo disk swap and resume service. This API is not supported in Data ONTAP 8.0 and later.

Inputs

  • None

Outputs

  • None

disk_update_disk_fw

[Family: ontap-classic]

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

  • disk-list => disk-name[], optional

    • List of disks to be updated. If not specified, all disks are updated. Example: 4a.18 5b.16 switch1:10.126L4

Outputs

  • None

disk_zero_spares

[Family: ontap-classic]

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

  • None

Outputs

  • None

ems_autosupport_log

[Family: ontap-classic, vfiler]

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

  • log-level => integer

    • Log level. Accepted values are 0 for 'emergency', 1 for 'alert', 2 for 'critical', 3 for 'error', 4 for 'warning', 5 for 'notice', 6 for 'info', and 7 for 'debug'.

Outputs

  • None

ems_invoke

Invoke an ems event. This functionality is intended for use in testing syslog parsers or upper level SNMP management software. The event will be forwarded to the ems log at /etc/log/ems and optionally to the syslog or SNMP trap generator. Invoked events in /etc/log/ems will have the attribute 'inv' set to "1". This is to allow auto-support to differentiate between real and invoked events. Syslog entries resulting from invoked events will contain the text "invoked event:" so that they aren't confused with real events. Invoked events by default are only logged to the /etc/log/ems log. To have an event go to the syslog or generate an snmp trap, the 'syslog' and/or 'snmp' flags need to be set.

Inputs

  • event-id => string

    • Name of the event to invoke. Each ems event has a unique identifier (event-id) that can be used by this api to 'fake' an event. Example event-id's: kern.syslog.msg kern.uptime.filer raid.cksum.replay.nvram raid.cksum.replay.summary raid.fsm.commitStateTransit
  • event-version => integer, optional

    • If set, specifies the version of the event to invoke. By default, the latest version is used. Accepted values are [1..n]. Event-version is only used when multiple versions of an event exist simultaneously within a given build of ONTAP. Most events have an event-version of 1.
  • severity => string, optional

    • For events with variable severity, specfies the severity to invoke the event at. Shouldn't be set for events that don't have variable severity. Possible Values: debug info notice warning svc_error node_error svc_fault node_fault
  • snmp => boolean, optional

    • If set, and event has an SNMP definition, generate SNMP trap for event. Invoked messages by default do not generate SNMP traps.
  • syslog => boolean, optional

    • If set, and the event has a syslog format definition, forward invoked message to syslog. Invoked messages are by default not forwarded to syslog

Outputs

  • None

fc_config_adapter_disable

[Family: ontap-classic]

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

  • None

fc_config_adapter_enable

[Family: ontap-classic]

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

  • adapter-name => string

    • FC adapter name (e.g 0a)

Outputs

  • None

fc_config_list_iter_end

[Family: ontap-classic]

Terminate the fc-config-list iteration

Inputs

  • tag => string

    • Tag from a previous fc-config-list-iter-start.

Outputs

  • None

fc_config_list_iter_next

[Family: ontap-classic]

Obtain a list of FC adapter configuration information. Only provides information for adapters that are configurable.

Inputs

  • maximum => integer

    • Maximum number of entries to retrieve.
  • tag => string

    • Tag from a previous fc-config-list-iter-start.

Outputs

  • records => integer

    • This tells you how many records are being returned. When this value is 0, you have retrieved everything.

fc_config_list_iter_start

[Family: ontap-classic]

Start iteration through the list of adapter configuration information.

Inputs

  • None

Outputs

  • records => integer

    • Number of items that have been saved for future retrieval with fc-config-list-iter-next.
  • tag => string

    • Tag to be used in subsequent iterations.

fc_config_set_adapter_fc_type

[Family: ontap-classic]

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

  • adapter-name => string

    • FC adapter name (e.g 0a)
  • fc-type => string

    • Sets the type and state of the adapter. Possible inputs:
      "unconfigured" - set adapter-type to "initiator" and adapter-state to UNCONFIGURED
      "initiator" - set adapter-type to "initiator" and adapter-state to CONFIGURED
      "target" - set adapter-type to "target" and adapter-state to CONFIGURED
      "vi" - set adapter-type to "vi" and adapter-state to CONFIGURED

Outputs

  • None

fcp_adapter_clear_partner

[Family: ontap-classic]

Removes the name of the partner adapter which the local adapter should takeover. Partner adapter setting is obsolete and this operation is no longer supported.

Inputs

Outputs

  • None

fcp_adapter_config_down

[Family: ontap-classic]

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

  • fcp-adapter => string

    • FC adapter to bring offline.

Outputs

  • None

fcp_adapter_config_media_type

[Family: ontap-classic]

Sets the link type on the Fibre Channel target adapter. It can be configured to establish a point-to-point link, a loop configuration or to automatically sense whether the connection type is a point-to-point or loop link. Setting the link to point-to-point in a loop configuration can prevent the loop from coming up properly. If the adapter is online, it must be brought offline and then online in order for a new mediatype to take effect. This may temporarily disrupt fcp service on the target adapter.

Inputs

  • fcp-adapter => string

    • FC adapter to bring offline.
  • media-type => string

    • Media type to set. Valid values are point-to-point ("ptp"), loop configuration ("loop"), or automatic ("auto").

Outputs

  • None

fcp_adapter_config_up

[Family: ontap-classic]

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

  • fcp-adapter => string

    • FC adapter to bring online.

Outputs

  • None

fcp_adapter_initiators_list_info

[Family: ontap-classic, vfiler]

Get the list of initiators currently connected to the specified Fibre Channel target adapter, or if none specified, a list of initiators connected to any FC target adapter. Information returned for each initiator includes the portname of initiators that are currently logged in with the the FC target adapters. If the portname is in an initiator group, then the group name is also included. Also the Fibre Channel host address and the nodename/portname of the initiators are included as well. Connectivity of adapters running on behalf of partners are not included in the list when requesting for all adapters. If listing for all adapters and an error occurred for while retrieving connection status for an adapter, status for that adapter will not be returned, and the API will continue on with the rest of the adapters without erroring out. You can get the error msg for that adapter, by specifically specifying that adapter.

Inputs

  • fcp-adapter => string, optional

    • Adapter to get initiator list for. If no adapter is specified, information is returned for all initiators connected through any fcp adapter in the system.

Outputs

fcp_adapter_list_info

[Family: ontap-classic, vfiler]

Gets information such as nodename/portname and link state about the specified Fibre Channel target adapter, or if no adapter is specified, about all the FC target adapters.

Inputs

  • fcp-adapter => string, optional

    • FC target Adapter to get config information for. If no adapter is specified, information is returned for all FC target Adapters.
  • verbose => boolean, optional

    • If specified with "true", additional adapter info is returned. Look at description of output for what additions.

Outputs

fcp_adapter_nameserver_list_iter_end

[Family: ontap-classic, vfiler]

Terminate a list iteration and clean up any saved info.

Inputs

  • tag => string

    • Tag from a previous fcp-adapter-nameserver-list-iter-start.

Outputs

  • None

fcp_adapter_nameserver_list_iter_next

[Family: ontap-classic, vfiler]

Return items from a previous call to fcp-adapter-nameserver-list-iter-start Information returned for each nameserver entry include the port identifier, port type, port name, node name, symbolic port name, symbolic node name, fabric port name, class of service, and registered FC4 types.

Inputs

  • maximum => integer

    • The maximum number of entries to retrieve.
  • tag => string

    • Tag from a previous fcp-adapter-nameserver-list-iter-start.

Outputs

  • records => integer

    • This tells you how many records are being returned from this particular call to fcp-adapter-nameserver-list-iter-next When this value is 0, you have retrieved everything.

fcp_adapter_nameserver_list_iter_start

[Family: ontap-classic, vfiler]

Get the fabric nameserver objects the results of which are retreived by using fcp-adapter-nameserver-list-iter-next. Connectivity of adapters running on behalf of partners are not included in the list when requesting for all adapters. If listing for all adapters and an error occurs while retrieving connection status for an adapter, status for that adapter will not be returned and the API will continue on with the rest of the adapters without erroring out. You can get the error msg for that adapter, by specifically specifying that adapter.

Inputs

  • fcp-adapter => string, optional

    • Adapter to get nameserver objects for. If no adapter is specified, information is returned for all fcp adapter.
  • zoned => boolean, optional

    • If true, returns only devices that are zoned to the target adapter. Otherwise, all devices in the fabric are returned. Default is false.

Outputs

  • records => integer

    • Number which tells you how many items have been saved for future retrieval with fcp-adapter-nameserver-list-iter-next.
  • tag => string

    • Tag to be used in subsequent calls to fcp-adapter-nameserver-list-iter-next.

fcp_adapter_reset_stats

[Family: ontap-classic]

Resets the stats for the specified Fibre Channel Target Adapter. If none specified, reset stats for all FC adapters.

Inputs

  • fcp-adapter => string, optional

    • FC Target adapter.

Outputs

  • None

fcp_adapter_set_partner

[Family: ontap-classic]

Sets the name of the partner adapter which the local adapter should takeover. Partner adapter setting is obsolete and this operation is no longer supported.

Inputs

  • fcp-adapter => string

    • Local FC adapter.

Outputs

  • None

fcp_adapter_set_speed

[Family: ontap-classic]

Sets the speed on the Fibre Channel target adapter. It can be configured to run at 1Gb, 2Gb, 4Gb, 8Gb, 10Gb, 16Gb or to auto negotiate. The 10Gb adapter only supports the 10Gb speed. The 16Gb adapter only supports speeds of 16Gb, 8Gb, and 4Gb. The 8Gb adapter only supports speeds of 8Gb, 4Gb, and 2Gb. The 4Gb adapter only supports speeds of 4Gb, 2Gb, and 1Gb. 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

  • fcp-adapter => string

    • FC Target adapter
  • speed => string

    • Link speed (in Gb). Possible values: "1", "2", "4", "8", "10", "16" or "auto" (auto negotiate speed).

Outputs

  • None

fcp_adapter_stats_list_info

[Family: ontap-classic]

Get statistics about the Fibre Channel target adapters. Statistics of adapters running on behalf of partners are not included in the list when requesting stats for all adapters. If listing stats for all adapters and an error occurred for while retrieving stats for an adapter, stats for that adapter will not be returned, and the API will continue on with the rest of the adapters without erroring out. You can get the error msg for that adapter, by specifically specifying that adapter.

Inputs

  • fcp-adapter => string, optional

    • FC target Adapter. If no adapter is specified, stats for all adapters are retruned.

Outputs

fcp_adapter_topology_list_iter_end

[Family: ontap-classic, vfiler]

Terminate a list iteration and clean up any saved info.

Inputs

  • tag => string

    • Tag from a previous fcp-adapter-topology-list-iter-start.

Outputs

  • None

fcp_adapter_topology_list_iter_next

[Family: ontap-classic, vfiler]

Return items from a previous call to fcp-adapter-topology-list-iter-start Information returned for each switch includes the nodename, logical name, domain identifier, vendor, release version, and port information. If a port has devices attached to it, then information about each attached device is included as well.

Inputs

  • maximum => integer

    • The maximum number of entries to retrieve.
  • tag => string

    • Tag from a previous fcp-adapter-topology-list-iter-start.

Outputs

  • records => integer

    • This tells you how many records are being returned from this particular call to fcp-adapter-topology-list-iter-next When this value is 0, you have retrieved everything.

fcp_adapter_topology_list_iter_start

[Family: ontap-classic, vfiler]

Get the fabric topology for one or more switches the results of which are retreived by using fcp-adapter-topology-list-iter-next. Connectivity of adapters running on behalf of partners are not included in the list when requesting for all adapters. If listing for all adapters and an error occurrs while retrieving connection status for an adapter, information for that adapter will not be returned and the API will continue on with the rest of the adapters without erroring out. You can get the error msg for that adapter, by specifically specifying that adapter.

Inputs

  • fcp-adapter => string, optional

    • Adapter to get topology information for. If no adapter is specified, information is returned for all fcp adapter.
  • verbose => boolean, optional

    • If true, returns verbose information including port information about each switch in the fabric. Default is true.
  • zoned => boolean, optional

    • If true, returns only devices in the fabric that are zoned to the target adapter. Default is false.

Outputs

  • records => integer

    • Number which tells you how many items have been saved for future retrieval with fcp-adapter-topology-list-iter-next.
  • tag => string

    • Tag to be used in subsequent calls to fcp-adapter-topology-list-iter-next.

fcp_adapter_zone_list_iter_end

[Family: ontap-classic, vfiler]

Terminate a list iteration and clean up any saved info.

Inputs

  • tag => string

    • Tag from a previous fcp-adapter-zone-list-iter-start.

Outputs

  • None

fcp_adapter_zone_list_iter_next

[Family: ontap-classic, vfiler]

Return items from a previous call to fcp-adapter-zone-list-iter-start Information returned for each zone entry include the active zone set name, the zone name, and the zone members.

Inputs

  • maximum => integer

    • The maximum number of entries to retrieve. Range: [0..2^32-1]
  • tag => string

    • Tag from a previous fcp-adapter-zone-list-iter-start.

Outputs

  • records => integer

    • This tells you how many records are being returned from this particular call to fcp-adapter-zone-list-iter-next When this value is 0, you have retrieved everything. Range: [0..2^32-1]

fcp_adapter_zone_list_iter_start

[Family: ontap-classic, vfiler]

Get the active zone set information from the zone server. The results can then be retreived by using fcp-adapter-zone-list-iter-next. Connectivity of adapters running on behalf of partners is not included in the list when requesting for all adapters. If listing for all adapters and an error occurs while retrieving connection status for an adapter, status for that adapter will not be returned and the API will continue on with the rest of the adapters without erroring out. You can get the error msg for that adapter, by specifically specifying that adapter.

Inputs

  • fcp-adapter => string, optional

    • Adapter to get zone information for. If no adapter is specified, information is returned for all fcp adapter.

Outputs

  • records => integer

    • Number which tells you how many items have been saved for future retrieval with fcp-adapter-zone-list-iter-next. Range: [0..2^32-1]
  • tag => string

    • Tag to be used in subsequent calls to fcp-adapter-zone-list-iter-next.

fcp_get_cfmode

[Family: ontap-classic]

Get the current cfmode setting for the system.

Inputs

  • None

Outputs

fcp_node_get_name

[Family: ontap-classic]

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

  • None

Outputs

fcp_node_set_name

[Family: ontap-classic]

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

  • force => boolean, optional

    • If true, allow setting the WWNN to a value outside the vendor's registered namespace for the current mode. If false or not present, the request will fail unless the supplied WWNN is inside the correct namespace.
  • node-name => string

    • FCP World Wide Node Name.

Outputs

  • None

fcp_ping

[Family: ontap-classic]

Send an ELS ECHO frame to a Fibre Channel address or WWPN. EHOSTNOTFOUND is returned if the WWPN cannot be resolved. EONTAPI_EHOSTDOWN is returned if the address cannot be pinged.

Inputs

  • fcp-adapter => string

    • Adapter to send the ping request from.
  • payload => string, optional

    • Additional data to send in the payload of the ELS ECHO frame. The payload can be up to 248 characters long.
  • port-id-or-wwpn => string

    • The Fibre Channel address or the WWPN to ping. The format of a Fibre channel address is a hexadecimal or numeric value with the range [0..2^24-1]. The format of a WWPN is XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit.

Outputs

  • None

fcp_ping_info

[Family: ontap-classic]

Send an ELS ECHO frame to a Fibre Channel address or WWPN. The API pings the address or WWPN count times and returns the number of successful pings and times. EHOSTNOTFOUND is returned if the WWPN cannot be resolved. EONTAPI_EHOSTDOWN is returned if the address cannot be pinged. The interval between ping attempts is 1 second.

Inputs

  • fcp-adapter => string

    • Adapter to send the ping request from.
  • payload => string, optional

    • Additional data to send in the payload of the ELS ECHO frame. The payload can be up to 248 characters long.
  • port-id-or-wwpn => string

    • The Fibre Channel address or the WWPN to ping. The format of a Fibre channel address is a hexadecimal or numeric value with the range [0..2^24-1]. The format of a WWPN is XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit.

Outputs

fcp_port_name_list_info

[Family: ontap-classic]

Get the list of valid Fibre Channel target port names on a filer's local adapters. The filer needs to be in standby or single_image cfmode.

Inputs

  • verbose => boolean, optional

    • If specified with "true", unused port names are also reported. Default value is "false".

Outputs

fcp_port_name_set

[Family: ontap-classic]

Set a valid but unused port name on a Fibre Channel target interface.

Inputs

  • fcp-adapter => string

    • FCP target interface to set the WWPN on. In Data ONTAP 7-Mode, the name of a local adapter in standby single_image cfmode. In Data ONTAP Cluster-Mode, the name of an FCP data LIF in the vserver.

Outputs

  • None

fcp_port_name_swap

[Family: ontap-classic]

Swap port names of two local Fibre Channel target adapters.

Inputs

  • fcp-adapter-1 => string

    • One of the adapters to swap their port names. It has to be a local adapter in standby or single_image cfmode.
  • fcp-adapter-2 => string

    • One of the adapters to swap their port names. It has to be a local adapter in standby or single_image cfmode.

Outputs

  • None

fcp_service_start

[Family: ontap-classic]

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

  • None

Outputs

  • None

fcp_service_status

[Family: ontap-classic]

Get status of the FCP service, whether or not it is running.

Inputs

  • None

Outputs

fcp_service_stop

[Family: ontap-classic]

Stops FCP service. When FCP service is stopped, the adapters are brought offline. Service will be unavaliable once the call returns with success.

Inputs

  • None

Outputs

  • None

fcp_set_cfmode

[Family: ontap-classic]

Set the current cfmode setting for the system. This setting controls how the cluster behaves during a takeover/giveback. It also controls if the filer should use multiple virtual target adapters per physical target adapter. fcp service must be stopped before executing this API. The only valid value for cfmode is 'single_image' If cfmode is set to 'single_image' the filer connects to the FC fabric in ptp mode by default but is configurable, and all luns in the cluster are visible on all FC target ports. In this mode all hosts require multipathing software. When setting the cfmode to 'single_image' configuration checks are performed. If these checks fail an EPERM error will be returned. See the lun-config-check-single-image-info API for more information.

Inputs

  • fcp-cfmode => string

    • Set current cfmode setting. Possible values: single_image
  • force => boolean, optional

    • Forcibly change the cfmode, overriding cluster partner checks. Obsolete.

Outputs

  • None

fcp_wwpnalias_get_alias_info

[Family: ontap-classic, vfiler]

Get the list of WWPN for a given alias or an alias for for a given WWPN or complete list of all current alias- WWPN mappings.

Inputs

  • alias => string, optional

    • Alias for a WWPN is the 32-character alias that may contain A-Z, a-z, 0-9, _,-,.,{,} and no spaces. When supplied, the alias with the corresponding WWPN will be returned. Otherwise, all aliases with their WWPNs present in the system will be returned.
  • wwpn => string, optional

    • WWPN for which all aliases will be returned. When supplied all aliases for that WWPN will be returned. Otherwise, all aliases with their WWPNs present in the system will be returned.

Outputs

fcp_wwpnalias_remove

[Family: ontap-classic]

Remove an alias for a World Wide Port Name of an initiator. Either the alias or the wwpn argument must be provided.

Inputs

  • alias => string, optional

    • WWPN Alias to be removed. Either the alias or the wwpn argument must be provided.
  • wwpn => string, optional

    • WWPN for which all aliases are to be removed. Either the wwpn or the alias argument must be provided.

Outputs

  • None

fcp_wwpnalias_set

[Family: ontap-classic]

Set an alias for a World Wide Port Name of an initiator that might login to the target.

Inputs

  • alias => string

    • Alias to be set for the given WWPN ("wwpn"); The alias can be 32-characters long and may contain: A-Z, a-z, 0-9, _,-,.,{,} and no spaces
  • force => boolean, optional

    • When set to true, the WWPN associated with the alias will be over-written. Default value is false.

Outputs

  • None

fcport_get_link_state

[Family: ontap-classic]

Get the link state of a specific adapter on this system.

Inputs

  • adapter-name => string

    • The adapter name is either a slot number, or, if a port letter is also presented, a slot number and port letter concatenated into a single name -- for example, "8a" or "11b". If adapter-name is not supplied, the command will return EAPIMISSINGARGUMENT.

Outputs

  • adapter-name => string

    • The adapter name is either a slot number, or, if a port letter is also presented, a slot number and port letter concatenated into a single name.

fcport_reset_dev

[Family: ontap-classic]

When invoked the device will be reset. The device will be temporarily suspended while it is reset, after which it will resume processing device operations. This command should be used with care as it can have adverse effects, for instance pending commands to the device will be aborted when issuing this command.

Inputs

  • device-id => string

    • The device id is presented as a slot number followed by the port letter concatenated with the device-id. These two parts are separated by a period. For example 6b.5 If the device-id is omitted EAPIMISSINGARGUMENT will be returned. If the device-id is invalid EINVALIDINPUTERROR will be returned.

Outputs

  • None

fcport_send_lip

[Family: ontap-classic]

This will initiate a loop initialization on the specified fibrechannel loop port. The loop will be temporarily suspended while it is initialized, after which it will resume processing loop operations. This command should be used with care, because it can have adverse effects, like pending commands will be aborted when issuing this command.

Inputs

  • loop-id => string

    • The loop id is presented as a slot number and port letter concatenated (for example 6a). If the loop-id is omitted EAPIMISSINGARGUMENT will be returned. If the loop-id is invalid EINVALIDINPUTERROR will be returned.

Outputs

  • None

fcport_set_offline

[Family: ontap-classic]

Offline a specific adapter on this system. This API should be used with care, as it can have adverse side effects, which you lose access to all devices of that port. The operation of offlining the already offlined adapter will be considered success.

Inputs

  • adapter-name => string

    • The adapter name is either a slot number, or, if a port letter is also presented, a slot number and port letter concatenated into a single name -- for example, "8a" or "11b". If adapter-name is not supplied, the command will return EAPIMISSINGARGUMENT.

Outputs

  • None

fcport_set_online

[Family: ontap-classic]

Online a specific adapter on this system. The operation of onlining the already onlined adapter will be considered success.

Inputs

  • adapter-name => string

    • The adapter name is either a slot number, or, if a port letter is also presented, a slot number and port letter concatenated into a single name -- for example, "8a" or "11b". If adapter-name is not supplied, the command will return EAPIMISSINGARGUMENT.

Outputs

  • None

feature_status_list_info

[Family: ontap-classic]

Returns status information for managed features.

Inputs

  • None

Outputs

file_create_directory

[Family: ontap-classic, vfiler]

Create a directory.

Inputs

  • path => string

    • Path of the directory to be created. The value is expected to begin with /vol/.
  • perm => string

    • Permission of the directory to be created. It's similar to Unix style permission bits: 0755 gives read/write/execute permissions to owner and read/execute 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. Note: Prior to Data ONTAP 7.3.1 this value was treated as a base-10 number.

Outputs

  • None

file_create_symlink

[Family: ontap-classic, vfiler]

Create a symlink.

Inputs

  • path => string

    • Path of the symlink file to create. The value is expected to begin with /vol/.

Outputs

  • None

file_delete_directory

[Family: ontap-classic, vfiler]

Delete a directory.

Inputs

  • path => string

    • Path of the directory to delete. The value is expected to begin with /vol/. The directory must be empty in order for this API to succeed.

Outputs

  • None

file_delete_file

[Family: ontap-classic, vfiler]

Delete a file.

Inputs

  • path => string

    • Path of the file or symlink to delete. The value is expected to begin with /vol/.

Outputs

  • None

file_get_file_info

[Family: ontap-classic, vfiler]

Obtains the file information or properties.

Inputs

  • path => string

    • Pathname of the directory to list. The value is expected to begin with /vol/.

Outputs

file_get_fingerprint

[Family: ontap-classic, vfiler]

Get the fingerprint or digest of a file. Fingerprint is calculated using md5 or sha-256 digest algorithm depending on the algorithm specified. Fingerprint is calculated over the file data or metadata or on both data and metadata depending on the scope selected. Data fingerprint is calculated over file contents. Metadata fingerprint is calculated over the selected attributes of the file. Attributes used for metadata fingerprint calculations are file type (file-type), file size (file-size), file crtime (creation-time), file mtime (modified-time), file ctime (changed-time), file retention time (retention-time, is-wraparound), file uid (owner-id), file gid (group-id). File retention time is applicable to worm protected files only. The fingerprints are base64 encoded.

Inputs

  • path => string

    • Full path of the file to be fingerprinted. The value is expected to begin with /vol/.

Outputs

file_get_space_reservation_info

[Family: ontap-classic, vfiler]

Queries the space reservation settings for the named file.

Inputs

  • path => string

    • File to be queried.

Outputs

file_inode_info

[Family: ontap-classic, vfiler]

Get parent information for a given inode.

This API corresponds to the "inodepath" diagnostic-level CLI in ONTAP-Classic, and has the same defaults.

The input is:

  • Required, a volume identifier. A volume may be specified by name, fsid, or (in some ONTAP products) UUID/DSID.
  • Required, an inode number.
  • Optional, a snapshot identifier to get information from a snapshot rather than the active volume. A snapshot may be specified by name or by id.
  • Optional, various reporting flags (see below) to enable or disable optional output information.

The output is:

  • All volume identifiers, the one used as input plus the values of the others.
  • Optionally, all snapshot identifiers; the one used as input plus the value of the other.
  • The number of parents for the inode.
  • Optionally, one or more volume relative pathnames to the inode
  • Optionally, one or more leaf names for the inode.
  • Optionally, one or more of the actual parent info stored for the inode, in the form of the parent dir inode number and the parent directory cookie (fbn and offset into the fbn) used to find the dir entry that refers to the inode in the parent directory (ie. the info used to get the leaf name).

Inputs

  • encoded => boolean, optional

    • Specifies if non ASCII characters present in the filename will be hex encoded or not. If set to true, then all non-ASCII characters present in the filename are transformed to \XX where XX is the hex equivalent of the character. For example, if the filename has a non-ASCII character whose hex equivalent is 0x5C then the character would be encoded as a three byte sequence of '\','5' and 'C' & returned as "\5C". By default, the value is false.
  • logical-snap-id => integer, optional

    • All snapshots are associated with an internal index. "logical-snap-id" is the client-visible index that maps the the underlying internal index.

    Range: [1..255].

  • report-leaf-name => boolean, optional

    • If set to true, report the leaf name of the given inode. The leaf name is equivalent to the final component of a full pathname. For example, the leaf name of:

    /vol/vol0/foo/bar/baz
    is:
    baz

    By default, the inode's leaf name is not shown.

  • report-other-parents => boolean, optional

    • If set to true, report the requested information for all of the parents for the given inode. By default, only information about one of the given inode's parents is reported.
  • report-parent-data => boolean, optional

    • If set to true, report various other pieces of information about the given inode. This information includes the inode of the parent directory containing the given inode, along with the directory cookie by which the given inode is known in that parent directory inode. By default, this other information is not reported for the given inode.
  • snap-id => integer, optional

    • The snapshot number within the given volume in which the given inode is to be referenced. At most, one of snap-id or snap-name can be provided. If neither is provided, we reference the given inode within the active file system of the given volume. Valid snapshot ids have a range of 0 to (WAFL_SNAP_CNT - 1) (currently 255). A value of 0 will refer to the active file system of the given volume. This refers to the physical snapshot identifier.
  • snap-name => string, optional

    • A snapshot name within the given volume in which the given inode is to be referenced. At most, one of snap-id or snap-name can be provided. If neither is provided, we reference the given inode within the active file system of the given volume.
  • volume-dsid => string, optional

    • The DSID (Data Set IDentifier) of the volume containing the given inode. Exactly one of volume-fsid, volume-name, volume-uuid or volume-dsid must be specified.

    DSIDs are formatted as 18-character strings composed of 16 hex characters prefixed with '0x'. NOTE: This form of volume identification is only supported in some ONTAP products (ONTAP-NG).

  • volume-fsid => integer, optional

    • The FSID (file system identifier) of the volume containing the given inode. Exactly one of volume-fsid, volume-name, volume-uuid, or volume-dsid must be specified. An FSID may have any uint32_t value.
  • volume-name => string, optional

    • The name of the volume containing the given inode. Exactly one of volume-fsid, volume-name, volume-uuid, or volume-dsid must be specified.
  • volume-uuid => string, optional

    • The UUID (Universally Unique IDentifier) of the volume containing the given inode. Exactly one of volume-fsid, volume-name, volume-uuid or volume-dsid must be specified.

    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.

    An example UUID is 532ad684-c8ec-11d9-945f-00065b8c8a1e. NOTE: This form of volume identification is only supported in some ONTAP products (ONTAP-NG).

Outputs

  • inode-number => integer

    • The number identifying the inode.
  • logical-snap-id => integer, optional

    • Logical snapshot index. This index maps to the above internal index. Logical index allows users to choose the same snapshot index across all members of a striped volume. This index is also useful for logical volume replication. A logical snapshot index of 0 implies that the snapshot is is not client-visible i.e. this is a un-coordinated snapshot.

    Range: [0..255].

  • snapshot-name => string, optional

    • The name of the snapshot, if requested info is from a snapshot.
  • volume-dsid => string, optional

    • The volume DSID.

file_list_directory_iter_end

[Family: ontap-classic, vfiler]

Terminate a directory iteration.

Inputs

  • tag => string

    • Tag from a previous file-list-directory-iter-start.

Outputs

  • None

file_list_directory_iter_next

[Family: ontap-classic, vfiler]

Obtain a list of files in a given directory.

Inputs

  • maximum => integer

    • Maximum number of directory entries to retrieve.
  • tag => string

    • Tag from a previous file-list-directory-iter-start.

Outputs

  • records => integer

    • This tells you how many records are being returned from this particular call to file-list-directory-iter-next. When this value is 0, you have retrieved everything.

file_list_directory_iter_start

[Family: ontap-classic, vfiler]

Start in iteration through the list of files in a given directory.

Inputs

  • encoded => boolean, optional

    • Specifies if non ASCII characters present in the filename will be hex encoded or not. If set to true, then all non-ASCII characters present in the filename are transformed to \XX where XX is the hex equivalent of the character. For example, if the filename has a non-ASCII character whose hex equivalent is 0x5C then the character would be encoded as a three byte sequence of '\','5' and 'C' & returned as "\5C". By default, the value is false.
  • path => string

    • Pathname of the directory to list. The value is expected to begin with /vol/.

Outputs

  • records => integer

    • Number of items that have been saved for future retrieval with file-list-directory-iter-next.
  • tag => string

    • Tag to be used in subsequent iterations.

file_punch_hole

[Family: ontap-classic, vfiler]

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

  • path => string

    • Path of the file. Format must be of the following: /vol/my_vol/path-to-file

Outputs

  • None

file_read_file

[Family: ontap-classic, vfiler]

Read data from a named file. API will fail if length exceeds 1 MB. This API should only be used on normal files or streams associated with files. The results for other file types such as LUNs is undefined.

Inputs

  • offset => integer

    • Offset into file to start reading from. If the value of offset is beyond the eof, the API will fail with EAPIERROR.
  • path => string

    • Name of the file to read. For example: "/vol/<volume>/<file>".

Outputs

  • data => string

    • Data read from the file. The format of the data is ASCII hex characters, two characters representing one byte from the file. (This format allows the representation of 0-valued bytes.)
  • length => integer

    • Number of bytes actually read from the file. If this value is 0, then you have attempted to read at or past the end of the file.

file_read_symlink

[Family: ontap-classic, vfiler]

Read the contents of a symlink.

Inputs

  • path => string

    • Path of the symlink file to read. The value is expected to begin with /vol/.

Outputs

  • symlink => string

    • Value of the symlink. In other words, this is the destination path contained in the symlink.

file_rename_directory

[Family: ontap-classic, vfiler]

Rename a directory. Note that this API cannot be used to rename a directory to a different volume.

Inputs

  • to-path => string

    • Final path of the directory. The value must begin with /vol/. All path components except the final directory name must already exist.

Outputs

  • None

file_set_space_reservation_info

[Family: ontap-classic, vfiler]

Sets the space reservation settings for the named file. is-overwrite-enabled and is-fill-enabled both must be the same value.

Inputs

  • path => string

    • File to be queried.

Outputs

  • None

file_truncate_file

[Family: ontap-classic, vfiler]

Truncate a file. Any data past the truncation point will be lost, of course.

Inputs

  • path => string

    • Path of the file to truncate. The value is expected to begin with /vol/.

Outputs

  • None

file_usage_get

[Family: ontap-classic]

Reports unique bytes held in a file.

Inputs

  • length => integer, optional

    • Length of the range in bytes. If it is not specified, the range that is reported is from start-offset to end-of-file. Range : [0..2^63-1].
  • path => string

    • File name to generate report: E.g., /vol/vol1/file1

Outputs

file_usage_result_get

[Family: ontap-classic]

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

  • total-bytes => integer

    • Number of bytes held by this file. Range : [0..2^63-1].
  • unique-bytes => integer

    • Number of bytes 'uniquely' held by this file. Range : [0..2^63-1].

file_usage_start

[Family: ontap-classic]

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

  • length => integer, optional

    • Length of the range in bytes. If it is not specified, the range that is reported is from start-offset to end-of-file. Range : [0..2^63-1].
  • path => string

    • File name to generate report: E.g., /vol/vol1/file1
  • start-offset => integer, optional

    • Start range of file in bytes. If this is not specified, it is assumed to be beginning of file (offset 0). Range : [0..2^63-1].

Outputs

  • cookie => string

    • Cookie to be used with subsequent file-usage-result-get call.

file_write_file

[Family: ontap-classic, vfiler]

Write data into a named file. If the file/stream 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 or streams associated with files.. The results for other file types such as LUNs is undefined.

Inputs

  • data => string

    • Data to be written. The format of the data is ASCII hex characters, two characters representing one byte. Whitespace characters, for convenience in formatting, can be present in the value and are ignored.
  • offset => integer

    • Offset into file at which to start writing. If the offset is -1, the data is appended to the file. The valid maximum value for (offset + data length) is the maximum total file size which is Data ONTAP version and file system dependent. If the value of the (offset + data length) is beyond the maximum total file size, the API will fail with EAPIERROR.
  • overwrite => boolean, optional

    • If false, and the file already exists, then the API will fail, with an errno of EEXIST. This allows the client to ensure that it was the exclusive creator of the file. The default value is true.
  • path => string

    • Pathname of the file to write. For example: "/vol/<volume>/<file>".

Outputs

  • length => integer

    • Number of bytes actually written.

flash_device_list_info

[Family: ontap-classic]

This API is used to retrieve information about the flash devices in the controller registered with Flash Management Module (FMM).

Inputs

Outputs

flash_get_thresholds

[Family: ontap-classic]

Get threshold profiles available in Flash Management Module.

Inputs

Outputs

fpolicy_create_policy

[Family: ontap-classic, vfiler]

Creates a new policy.

Inputs

Outputs

  • None

fpolicy_destroy_policy

[Family: ontap-classic, vfiler]

Destroys existing policy.

Inputs

  • policy-name => string

    • Name of the policy.

Outputs

  • None

fpolicy_disable

[Family: ontap-classic, vfiler]

Sets options fpolicy enable to off.

Inputs

  • None

Outputs

  • None

fpolicy_disable_policy

[Family: ontap-classic, vfiler]

Disables a specific named policy.

Inputs

  • policy-name => string

    • Name of the policy.

Outputs

  • None

fpolicy_enable

[Family: ontap-classic, vfiler]

Sets options fpolicy enable to on.

Inputs

  • None

Outputs

  • None

fpolicy_enable_policy

[Family: ontap-classic, vfiler]

Enables a specific named policy. The operation will fail if the policy doesn't exist.

Inputs

  • policy-name => string

    • Name of the policy.

Outputs

  • None

fpolicy_extensions

[Family: ontap-classic, vfiler]

Manipulates with list of extensions in exclude or include set. Exlude set defines extension patterns that won't trigger fpolicy processing.

Inputs

  • command => string

    • Command to be applied on the specified set. Supported values: "add", "remove", "set", "reset".
  • policy-name => string

    • Name of the policy.
  • set-name => string

    • Defines to which set (exclude or include) a command (add, remove, etc) will be applied to. For instance, command = add, set-name = include will add specified list of extensions to the include set. Possible values: "exclude", "include".

Outputs

  • None

fpolicy_extensions_list_info

[Family: ontap-classic, vfiler]

Returns information on existing extension sets.

Inputs

  • policy-name => string

    • Name of the policy.

Outputs

fpolicy_get_policy_options

[Family: ontap-classic, vfiler]

Shows value of policy options.

Inputs

  • policy-name => string

    • Name of the policy.

Outputs

  • is-required => boolean

    • Indicator if the screening with this policy is required, i.e. will it fail if the server is not registered. If set to true, the request will fail if there is no server to evaluate it. If it's false, the request will succeed.

fpolicy_get_required_info

[Family: ontap-classic, vfiler]

Shows current options for the policy.

Inputs

  • policy-name => string

    • Name of the policy.

Outputs

  • is-required => boolean

    • Indicator if the policy is required, i.e. will it fail if the server is not responding. If set to true, the request will fail if there is no server to evaluate it. If it's false, the request will succeed.

fpolicy_get_secondary_servers_info

[Family: ontap-classic, vfiler]

Shows current options for the policy.

Inputs

  • policy-name => string

    • Name of the policy.

Outputs

fpolicy_list_info

[Family: ontap-classic, vfiler]

Returns a list of existing policies.

Inputs

  • policy-name => string, optional

    • Name of the policy. If this parameter is set, policies will have information pertaining to the policy named. If there is no such a policy, policies will be empty.

Outputs

fpolicy_operations_list_set

[Family: ontap-classic, vfiler]

Manipulate a list of operations and network protocols for a policy. This determines which user requests cause the filer to notify fpolicy servers for this policy. The list provided will replace the list currently in place, if any. Note that this can be confusing to a server which has already connected to a policy and provided a list of operations. For example, it may have requested notifications when users open files, but start receiving notifications when users create symlinks. This API is provided in support of "native file blocking" in which there is no server connected to the filer for a policy. Note that it is possible to get the list of operations and protocols currently set for a policy with the fpolicy-list-info API.

Inputs

  • force => boolean, optional

    • If a server is connected to the filer and has already set the list of operations, should this API override the server's setting? If "force" is "true", the policy's set of operations will be dropped and replaced with the values provided by this API. Default value is false.
  • offline-only => boolean, optional

    • Sets the state of offline filtering. If offline filtering is set, then only user requests for files which are marked "offline" cause notifications. Default value is false.
  • policy-name => string

    • Name of the policy.

Outputs

  • None

fpolicy_server_list_info

[Family: ontap-classic, vfiler]

Shows a list of primary servers serving the policy.

Inputs

  • policy-name => string

    • Name of the policy.

Outputs

fpolicy_server_stop

[Family: ontap-classic, vfiler]

Stops specific primary server serving the policy. Effectively, this will unregister the fpolicy server.

Inputs

  • policy-name => string

    • Name of the policy.

Outputs

  • None

fpolicy_set_policy_options

[Family: ontap-classic, vfiler]

Sets policy's options to on/off.

Inputs

  • is-ads-monitored => boolean, optional

    • Indicates if the policy monitors the cifs operations on Alternate Data Streams. Default is false.
  • is-cifs-disconnect-check-enabled => boolean, optional

    • 'true' if requests associated with disconnected CIFS sessions must not be screened, 'false' otherwise.
  • is-required => boolean, optional

    • Indicator if the screening with this policy is required, i.e. will it fail if the server is not registered. If set to true, the request will fail if there is no server to evaluate it. If it's false, the request will succeed. Default is false.
  • policy-name => string

    • Name of the policy.
  • secondary-servers => secondary-server-info[], optional

    • List of server's IP addresses. Servers registered from these IP will be considered as secondary servers.

Outputs

  • None

fpolicy_set_required

[Family: ontap-classic, vfiler]

Sets policy's "required" option to on/off.

Inputs

  • policy-name => string

    • Name of the policy.
  • required => boolean

    • Indicator if the policy is required. If set to true, the request will fail if there is no server to evaluate it. If it's false, the request will succeed.

Outputs

  • None

fpolicy_set_secondary_servers

[Family: ontap-classic, vfiler]

Sets secondary servers information in a form of a list of ip addresses. These servers will be used if all primary servers are not available, thus increasing system availabilty.

Inputs

  • policy-name => string

    • Name of the policy.

Outputs

  • None

fpolicy_status

[Family: ontap-classic, vfiler]

Returns status of options fpolicy enable.

Inputs

  • None

Outputs

  • is-enabled => boolean

    • Shows if the fpolicy mechanism is enabled or not.

fpolicy_volume_list_info

[Family: ontap-classic, vfiler]

Returns a volume-regular-expression list for an exclude or include set. The list describes limits to the set of volumes for which client requests trigger (include) or suppress (exclude) fpolicy processing for the provided policy.

Inputs

  • policy-name => string

    • Name of the policy.

Outputs

  • exclude-volumes => fpolicy-volumes-list-info[]

    • List of volumes that are inactive for the file policy. The list can include items which are regular expressions, such as "vol*" or "user?". Note that if a policy has both an exclude list and an include list, the include list is ignored by the filer when processing user requests.

fpolicy_volume_list_set

[Family: ontap-classic, vfiler]

Manipulate a list of volumes in an exclude or include set. This limits the set of volumes for which client requests trigger (include) or suppress (exclude) fpolicy processing for the provided policy. The list provided will replace the list currently in place, if any. Note that if a policy has both an exclude list and an include list, the include list is ignored by the filer.

Inputs

  • list-type => string

    • Defines to which set (exclude or include) a list will be applied. Possible values: "exclude", "include".
  • policy-name => string

    • Name of the policy.

Outputs

  • None

ic_config_show

[Family: ontap-classic]

Print HA Interconnect configuration information.

Inputs

  • None

Outputs

ic_get_error_stats

[Family: ontap-classic]

Get Interconnect and nvram related statistics and device specific counters

Inputs

  • sfo-rv-name => string, optional

    • It give error counters specific to either cfo_rv or cfo_rv1. If it is not given then it displays error counters of cfo_rv.
  • verbose => boolean, optional

    • If set to true the output is detailed.

Outputs

  • sfo-connection-state => string

    • Connection state with peer. Possible value: "not connected", "waiting for connected", "waiting for not connected", "connected", "waiting for teardown", "unknown".
  • sfo-rv-role => string, optional

    • Role of sfo rv (rendezvous connection used for the cluster interconnect). Possible value: "source_rv", "dest_rv", "not applicable", "none".

ic_get_infiniband_hw_stats

[Family: ontap-classic]

Retrieve Infiniband hardware health and status statistics

Inputs

  • None

Outputs

  • doorbell-stats => ic-counter[]

    • Number of errors relating to ringing the doorbell on a RDMA transfer to notify that a new work entry has been added to a queue. Counter name:
    • bad_doorbells
  • requester-stats => ic-counter[]

    • List of Basic IC performance and error counters for the side of the infiniband connection initiating the data transfer. Counter names:
    • local_lenth_errors
    • local_qp_operation_errors
    • local_protection_errors
    • wr_flushed_errors
    • memory_window_bind_errors
    • bad_response_errors
    • remote_invalid_request_errors
    • remote_access_errors
    • transport_retries_exceeded_errors
    • rnr_nak_retries_exceded_errors
    • rnr_naks_received
    • out_of_sequence_naks_received
    • local_ee_operation_errors
    • resync_operations
  • responder-stats => ic-counter[]

    • List of Basic IC performance and error counters for the side of the infiniband connection that is receiving the data. Counter names:
    • local_length_errors
    • local_qp_operation_errors
    • local_protection_errors
    • wr_flushed_errors
    • local_access_errors
    • remote_invalid_request_errors
    • remote_access_errors
    • rnr_naks_sent
    • out_of_sequence_requests_received
    • bad_multicast_packets_received
    • local_ee_operation_error
    • resync_operations

ic_get_infiniband_port_stats

[Family: ontap-classic]

Retrieve Infiniband port health and status statistics

Inputs

  • None

Outputs

  • port1-stats => ic-counter[]

    • MLX4 port 1 Stats including:
    • packets_tx
    • packets_rx
    • data_tx
    • data_rx
    • wait_tx
    • symbol_error
    • link_error_recovery
    • link_down
    • error_rx
    • remote_physical_error
    • switch_relay_error_rx
    • discard_tx
    • constraint_error_tx
    • constraint_error_rx
    • local_link_integrity_error
    • excessive_buffer_overrun_error
    • vl15_dropped
  • port2-stats => ic-counter[]

    • MLX4 port 2 Stats including:
    • packets_tx
    • packets_rx
    • data_tx
    • data_rx
    • wait_tx
    • symbol_error
    • link_error_recovery
    • link_down
    • error_rx
    • remote_physical_error
    • switch_relay_error_rx
    • discard_tx
    • constraint_error_tx
    • constraint_error_rx
    • local_link_integrity_error
    • excessive_buffer_overrun_error
    • vl15_dropped

ic_get_perf_stats

[Family: ontap-classic]

Get Interconnect related performance statistics

Inputs

  • None

Outputs

ic_get_queue_info

[Family: ontap-classic]

Print information about the pending descriptors on the send queue and recvQ, if any, for the specified Virtual Interface.

Inputs

Outputs

  • recv-queue-info => queue-info, optional

    • Last descriptor posted, completed and polled on the receive queue. No recvq-info element means either there are no descriptors queued on the receive queue, or the Virtual Interface doesn't exist or hasn't connected successfully.
  • send-queue-info => queue-info, optional

    • Last descriptor posted, completed and polled on the send queue. No sendq-info element means either there are no descriptors queued on the send queue, or the Virtual Interface doesn't exist or hasn't connected successfully.

ic_reset_nic

[Family: ontap-classic]

Reset the interconnect device if the device is determined to be in an unstable state by the administrator or NetApp Global Support. An unstable state can consist of unsynchronized NVRAM logs causing failover functionality to be disabled, RDMA connection being reported as down, EMS is reporting loss of heartbeat between nodes, or the QP is in a disconnected state. Upon execution the interconnect device will be reset and reprogrammed to restore the High Availability (HA) interface.

Inputs

  • None

Outputs

  • None

ic_reset_nic_auto_off

[Family: ontap-classic]

Disable auto reset functionality for the interconnect device when an unstable state is detected. An unstable state can consist of unsynchronized NVRAM logs causing failover functionality to be disabled, RDMA connection being reported as down, EMS is reporting loss of heartbeat between nodes, or the message transport mechanism is in a disconnected state. Upon execution the automatic reset detection logic will be disabled.

Inputs

  • None

Outputs

  • None

ic_reset_nic_auto_on

[Family: ontap-classic]

Enable auto reset functionality for the interconnect device when an unstable state is detected. An unstable state can consist of unsynchronized NVRAM logs causing failover functionality to be disabled, RDMA connection being reported as down, EMS is reporting loss of heartbeat between nodes, or the message transport mechanism is in a disconnected state. Upon execution the automatic reset detection logic will be disabled.

Inputs

  • None

Outputs

  • None

ic_zero_error_stats

[Family: ontap-classic]

Zeroes out the interconnect error stats

Inputs

  • None

Outputs

  • None

igroup_add

[Family: ontap-classic, vfiler]

Adds initiator to an existing initiator group.

Inputs

  • force => boolean, optional

    • Forcibly add the initiator, disabling mapping and type conflict checks with the high-availability partner. If not specified all conflict checks are performed. In Data ONTAP Cluster-Mode, this field is accepted for backwards compatibility and is ignored.

Outputs

  • None

igroup_bind_portset

[Family: ontap-classic]

Bind an existing igroup to a given portset.

Inputs

  • initiator-group-name => string

    • Name of initiator group to bind the portset to.

Outputs

  • None

igroup_create

[Family: ontap-classic, vfiler]

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

  • initiator-group-name => string

    • Name of initiator group.
  • initiator-group-type => string

    • Type of the initiator group. Possible values: "fcp", "iscsi", "mixed". "mixed" is available in Data ONTAP Cluster-Mode 8.1 or later only.
  • os-type => initiator-group-os-type, optional

    • OS type of the initiators within the group. The default value if not specified is "default". The os type applies to all initiators within the group and governs the finer details of SCSI protocol interaction with these initiators. It is strongly recommended for the caller of this API to specify an OS type that is not "default". Some host OSes require this type field be set correctly in order to function properly.

Outputs

  • None

igroup_destroy

[Family: ontap-classic, vfiler]

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

  • force => boolean, optional

    • Forcibly destroy the initiator group, even if there are existing lun maps. Best practice is to attempt to unmap all the luns associated with a group before destroying it.
  • initiator-group-name => string

    • Name of initiator group.

Outputs

  • None

igroup_list_info

[Family: ontap-classic, vfiler]

Get information for initiator group(s).

Inputs

Outputs

igroup_lookup_lun

[Family: ontap-classic, vfiler]

Find the path to the lun mapped at a given lun-id for a given initiator group.

Inputs

  • initiator-group-name => string

    • Name of initiator group to search.

Outputs

  • path => string

    • Path to the lun.

igroup_remove

[Family: ontap-classic, vfiler]

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

  • force => boolean, optional

    • Forcibly remove the initiator even if there are existing LUNs mapped to this initiator group. Best practice is to attempt to unmap all the luns associated with a group before removing the initiator.
  • initiator => string

    • WWPN or WWPN Alias of Initiator to remove.
  • initiator-group-name => string

    • Name of initiator group.

Outputs

  • None

igroup_rename

[Family: ontap-classic, vfiler]

Rename an existing initiator group. The rename operation is non-disruptive.

Inputs

  • initiator-group-name => string

    • Name of initiator group to be renamed.

Outputs

  • None

igroup_set_attribute

[Family: ontap-classic]

Sets an attribute for an initiator group.

Inputs

  • attribute => string

    • Name of the attribute to change. Possible values: "alua", "os-type", "throttle_borrow", "throttle_reserve", "report_scsi_name". "alua" is available in Data ONTAP 7.2 or later. "report_scsi_name" is available in Data ONTAP 8.1.0 or later. "throttle_reserve","throttle_borrow" and "report_scsi_name" are not available in Data ONTAP Cluster-Mode.
  • force => boolean, optional

    • If the requested attribute is "os-type", forcibly set the attribute, disabling conflict checks with the high-availability partner where and when applicable. If not specified all conflict checks are performed. This field is ignored in Data ONTAP Cluster-Mode or if the requested attribute is not "os-type".
  • initiator-group-name => string

    • Name of initiator group.
  • value => string

    • Value for the attribute. The valid values for "os-type" are the supported os-types listed in the igroup-create API. In Data ONTAP 7-Mode, setting the "os-type" attribute will perform checks with the high-availability partner if this filer is running in the 'single_image' fcp cfmode and this igroup is an FCP igroup. The optional force argument can be used to override these checks if the high-availability partner can not be reached. It is also strongly recommended the "default" os-type not be used. Using "default" may cause problems with LUN access. API to always require the proper OS type information The valid values for "throttle_reserve" are 0-99 The valid values for "throttle_borrow" are true or false The valid values for "alua" are true or false The valid values for "report_scsi_name" are true or false

Outputs

  • None

igroup_unbind_portset

[Family: ontap-classic]

Unbind an existing igroup from a portset.

Inputs

  • initiator-group-name => string

    • Name of initiator group to unbind from the portset.

Outputs

  • None

ipspace_list_info

Retrieve information about ipspaces. An optional ipspace parameter lets you retrive information about a single ipspace.

Inputs

  • ipspace => string, optional

    • Name of the ipspace whose information you want to retrieve. If this parameter is not provided, information about all ipspaces will be returned.

Outputs

iscsi_adapter_config_down

Configures the specified adapter down. This API is obsolete beginning with ONTAP 7.1 and will always return the error EOPNOTSUPPORTED. There is no equivalent API to replace it.

Inputs

Outputs

  • None

iscsi_adapter_config_up

Configures the specified adapter up. This API is obsolete beginning with ONTAP 7.1 and will always return the error EOPNOTSUPPORTED. There is no equivalent API to replace it.

Inputs

  • iscsi-adapter => string

    • iscsi adapter.

Outputs

  • None

iscsi_adapter_initiators_list_info

[Family: ontap-classic, vfiler]

Get the list of initiators currently connected to any of the portal groups associated with specified adapter. Information returned for each initiator includes the target portal group number to which the initiator is connected, as well as the iSCSI initiator nodename and ISID. If no adapter is specified, information is returned for all initiators connected through any adapter in the system. NOTE: Beginning with ONTAP 7.1 this API is only intended for use by legacy applications that are already coded to this API. New applications should use iscsi-portal-list-info to get the list of iSCSI portals. associated with this filer. Complete removal of this ZAPI may occur in any release after 7.1.

Inputs

  • iscsi-adapter => string, optional

    • Adapter to get initiator list for. If no adapter is specified, information is returned for all initiators connected through any iscsi adapter in the system.

Outputs

iscsi_adapter_list_info

[Family: ontap-classic, vfiler]

Display the configuration information for iscsi adaptor(s), including the iSCSI portals associated with a virtual adapter. NOTE: Beginning with ONTAP 7.1 this API is only intended for use by legacy applications that are already coded to this API. New applications should use iscsi-portal-list-info to get the list of iSCSI portals. associated with this filer. Complete removal of this ZAPI may occur in any release after 7.1.

Inputs

  • iscsi-adapter => string, optional

    • Returns configuration information for adapter if specified. If not specified, then configuration information for all adapters are returned.

Outputs

iscsi_adapter_reset_stats

This API is obsolete beginning with ONTAP 7.1 and will always return the error EOPNOTSUPPORTED. For the equivalent functionality use the ZAPI iscsi-reset-stats

Inputs

  • iscsi-adapter => string, optional

    • Adapter to reset statistics for.

Outputs

  • None

iscsi_adapter_stats_list_info

This API is obsolete beginning with ONTAP 7.1 and will always return the error EOPNOTSUPPORTED. For the equivalent functionality use the ZAPI iscsi-stats-list-info The fields returned by iscsi-stats-list-info are very slightly different from those previously returned by iscsi-adapter-stats-list-info

Inputs

  • iscsi-adapter => string, optional

    • Adapter to get statistics for.

Outputs

  • None

iscsi_auth_generate_chap_password

[Family: ontap-classic, vfiler]

Generate a 128 bit random password that can be used as a CHAP secret.

Inputs

  • None

Outputs

iscsi_connection_list_info

[Family: ontap-classic, vfiler]

list iscsi connections on filer

Inputs

  • None

Outputs

iscsi_initiator_add_auth

[Family: ontap-classic, vfiler]

Add initiator to the authentication list.

Inputs

  • auth-type => string

    • Authentication type. Possible values: "CHAP", "none", "deny".
  • initiator => string

    • Name of initiator. The initiator name must conform to RFC 3720, for example: "iqn.1987-06.com.initvendor1:appsrv.sn.2346".
  • outbound-user-name => string, optional

    • Outbound CHAP user name. Outbound authentication is optional. If Outbound authentication is not specified, then the initiator can only do inbound traffic.
  • user-name => string, optional

    • Inbound CHAP user name, required for auth-type equals to CHAP.

Outputs

  • None

iscsi_initiator_auth_list_info

[Family: ontap-classic, vfiler]

Get authentication information for the specified initiator If no initiator is specified, get authentication infomation for all the known initiators. Password, if present is left out for security purposes.

Inputs

  • initiator => string, optional

    • Name of initiator. The initiator name must conform to RFC 3720, for example: "iqn.1987-06.com.initvendor1:appsrv.sn.2346". If initiator is not supplied, all initiators are returned.

Outputs

iscsi_initiator_delete_auth

[Family: ontap-classic, vfiler]

Delete initiator from the authentication list

Inputs

  • initiator => string

    • Name of initiator. The initiator name must conform to RFC 3720, for example: "iqn.1987-06.com.initvendor1:appsrv.sn.2346".

Outputs

  • None

iscsi_initiator_get_auth

[Family: ontap-classic, vfiler]

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

  • initiator => string

    • Name of initiator. The initiator name must conform to RFC 3720, for example: "iqn.1987-06.com.initvendor1:appsrv.sn.2346". If initiator is not found, default authentication method is returned

Outputs

  • auth-type => string

    • Authentication type. Possible values: "CHAP", "none", "deny".
  • outbound-user-name => string, optional

    • Outbound CHAP user name, returned only if auth-type is CHAP and outbound authentication is enabled for this initiator.
  • user-name => string, optional

    • Inbound CHAP user name, returned only if auth-type is CHAP.

iscsi_initiator_get_default_auth

[Family: ontap-classic, vfiler]

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

  • None

Outputs

  • auth-chap-policy => string, optional

    • CHAP authentication path. possible values: "radius", "local".
  • auth-type => string

    • Authentication type Possible values: "CHAP", "none", "deny".
  • outbound-user-name => string, optional

    • Outbound CHAP user name, returned only if auth-type is CHAP, and outbound authentication is set for initiator.
  • user-name => string, optional

    • Inbound CHAP user name, returned only if auth-type is CHAP.

iscsi_initiator_list_info

[Family: ontap-classic, vfiler]

Gives list of initiators logged in

Inputs

  • None

Outputs

iscsi_initiator_modify_chap_params

[Family: ontap-classic, vfiler]

Modify CHAP parameters to an existing per-initiator authentication info whose auth-type equals CHAP.

Inputs

  • initiator => string

    • Name of initiator. The initiator name must conform to RFC 3720, for example: "iqn.1987-06.com.initvendor1:appsrv.sn.2346". The per-initiator authentication info must have an auth-type equal to CHAP.
  • outbound-password => string, optional, encrypted

    • Outbound CHAP user password. If Outbound CHAP parameters are specified they will replace existing Outbound CHAP parameters. If no Outbound CHAP parameters were previously specified, then the specified Outbound CHAP parameters will enable mutual CHAP authentication. If no Outbound CHAP parameters are specified and no Outbound CHAP parameters exist, then one-way Inbound CHAP authentication will be continue to be used.
  • outbound-user-name => string, optional

    • Outbound CHAP user name. If Outbound CHAP parameters are specified they will replace existing Outbound CHAP parameters. If no Outbound CHAP parameters were previously specified, then the specified Outbound CHAP parameters will enable mutual CHAP authentication. If no Outbound CHAP parameters are specified and no Outbound CHAP parameters exist, then one-way Inbound CHAP authentication will be continue to be used.
  • password => string, optional, encrypted

    • Inbound CHAP user password. If Inbound CHAP parameters are specified they will replace the existing Inbound CHAP parameters. If they are not specified, the existing Inbound CHAP parameters will continue to be used.
  • radius => boolean, optional

    • "true" if RADIUS is the only forced CHAP authentication policy, Default is "false".
  • remove-outbound => boolean, optional

    • Flag which indicates that mutual CHAP authentication is to be converted to one-way CHAP authentication. Outbound CHAP parameters must not be specified when remove-outbound is true. The default value is false.
  • user-name => string, optional

    • Inbound CHAP user name. If Inbound CHAP parameters are specified they will replace the existing Inbound CHAP parameters. If they are not specified, the existing Inbound CHAP parameters will continue to be used.

Outputs

  • None

iscsi_initiator_set_default_auth

[Family: ontap-classic, vfiler]

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

  • auth-type => string

    • Possible values: "CHAP", "none", "deny".
  • outbound-password => string, optional, encrypted

    • Outbound CHAP user password. Outbound authentication is optional. If Outbound authentication is not specified, then the initiator can only do inbound traffic.
  • outbound-user-name => string, optional

    • Outbound CHAP user name. Outbound authentication is optional. If Outbound authentication is not specified, then the initiator can only do inbound traffic.
  • password => string, optional, encrypted

    • Inbound CHAP user password, required for auth-type equals to CHAP.
  • radius => boolean, optional

    • "true" if RADIUS is the only forced CHAP authentication policy, Default is "false".
  • user-name => string, optional

    • Inbound CHAP user name, required for auth-type equals to CHAP.

Outputs

  • None

iscsi_interface_disable

[Family: ontap-classic, vfiler]

Disables an interface for use by iSCSI

Inputs

  • interface-name => string

    • Name of interface to disable. In Data ONTAP 7-Mode, this is the name of a physical ethernet interface, for example: "e0c". In Data ONTAP Cluster-Mode, this is the name of an iSCSI data LIF in the Vserver.

Outputs

  • None

iscsi_interface_enable

[Family: ontap-classic, vfiler]

Enables an interface for use by iSCSI

Inputs

  • interface-name => string

    • Name of interface to enable. In Data ONTAP 7-Mode, this is the name of a physical ethernet interface, for example: "e0c". In Data ONTAP Cluster-Mode, this is the name of an iSCSI data LIF in the Vserver.

Outputs

  • None

iscsi_interface_list_info

[Family: ontap-classic, vfiler]

Gives status of interface for iSCSI

Inputs

Outputs

iscsi_iptpgroup_create

[Family: vfiler]

Create a new IP-based tpgroup

Inputs

  • iptpgroup-name => string

    • User-defined name of new target portal group; must be <= 60 bytes, and cannot end with "default" as this might conflict with names of default system portal groups (for example, "192.168.11.12_default" is not allowed)

Outputs

iscsi_iptpgroup_destroy

[Family: vfiler]

Destroy a IP-based tpgroup

Inputs

  • iptpgroup-tag => integer

    • tag of portal group to destroy

Outputs

  • None

iscsi_iptpgroup_ipaddr_add

[Family: vfiler]

Add an IP Address to an IP-based target portal group

Inputs

  • ip-addr => ip-address

    • The ip address, in dotted-decimal format, with which to add. (for example, "192.168.11.12").
  • iptpgroup-tag => integer

    • portal group tag

Outputs

  • None

iscsi_iptpgroup_ipaddr_delete

[Family: vfiler]

Delete an IP Address from an IP-based target portal group

Inputs

  • ip-addr => ip-address

    • The ip address, in dotted-decimal format, with which to add. (for example, "192.168.11.12").
  • iptpgroup-tag => integer

    • portal group

Outputs

  • None

iscsi_iptpgroup_list_info

[Family: vfiler]

List information about IP-based target portal groups

Inputs

  • iptpgroup-tag => integer, optional

    • Portal group being queried; if not supplied, information on all portal groups is returned

Outputs

iscsi_isns_config

[Family: ontap-classic, vfiler]

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

  • isns-ip-addr => ip-address

    • The ip address, in dotted-decimal format, of the iSNS server with which to register. (for example, "192.168.11.12").

Outputs

  • None

iscsi_isns_get_info

[Family: ontap-classic, vfiler]

Gets iSNS service configuration.

Inputs

  • None

Outputs

  • isns-ip-addr => ip-address

    • The ip address of the iSNS server in which we register.

iscsi_isns_start

[Family: ontap-classic, vfiler]

Start iSNS service. Service will be avaliable once the call returns with success.

Inputs

  • None

Outputs

  • None

iscsi_isns_stop

[Family: ontap-classic, vfiler]

Stops iSNS service. Service will not be available once the call returns with success.

Inputs

  • None

Outputs

  • None

iscsi_isns_update

[Family: ontap-classic, vfiler]

Forces iSNS service to update server.

Inputs

  • None

Outputs

  • None

iscsi_node_get_name

[Family: ontap-classic, vfiler]

Return the current iscsi node name.

Inputs

  • None

Outputs

  • node-name => string

    • Current iscsi node name.

iscsi_node_set_name

[Family: ontap-classic, vfiler]

Set the current iscsi node name.

Inputs

  • node-name => string

    • New iscsi node name; must be <= 128 chars, and conform to iSCSI rules

Outputs

  • None

iscsi_portal_list_info

[Family: ontap-classic, vfiler]

list iscsi portals

Inputs

  • None

Outputs

iscsi_reset_stats

zero filer iscsi counters

Inputs

  • None

Outputs

  • None

iscsi_service_start

[Family: ontap-classic, vfiler]

Start iSCSI service. Service will be avaliable once the call returns with success.

Inputs

  • None

Outputs

  • None

iscsi_service_status

[Family: ontap-classic, vfiler]

Get status of the iSCSI service, whether or not it is running.

Inputs

  • None

Outputs

  • is-available => boolean

    • "true" if iSCSI service is running, "false" otherwise.

iscsi_service_stop

[Family: ontap-classic, vfiler]

Stops iSCSI service. Service will be not be available once the call returns with success.

Inputs

  • None

Outputs

  • None

iscsi_session_list_info

[Family: ontap-classic, vfiler]

Gives list of active sessions

Inputs

Outputs

iscsi_stats_list_info

[Family: ontap-classic, vfiler]

return current filer iscsi statistics

Inputs

  • None

Outputs

iscsi_target_alias_clear_alias

[Family: ontap-classic, vfiler]

Clear the current iscsi target alias

Inputs

  • None

Outputs

  • None

iscsi_target_alias_get_alias

[Family: ontap-classic, vfiler]

Return the current iscsi target alias

Inputs

  • None

Outputs

iscsi_target_alias_set_alias

[Family: ontap-classic, vfiler]

Set the current iscsi target alias

Inputs

  • alias-name => string

    • New iscsi target alias to set; must be 128 bytes or less. Free form format otherwise, although a string of all blanks will be rejected

Outputs

  • None

iscsi_tpgroup_alua_set

Change the ALUA parameters on a tpgroup Asymmetric Logical Unit Access (ALUA) management Data ONTAP supports SCSI ALUA functionality for managing multi-pathed SCSI devices. ALUA provides a standardized mechanism for path discovery and prioritization. Devices are identified by target port IDs, which are then grouped into target port groups. Each group has a state which, when configured, enables the host multipathing software to select the appropriate path priorities when accessing a LUN. For iSCSI, ALUA settings are controlled at the target portal group level using the "iscsi-tpgroup-alua-set" ZAPI. A target portal group can be configured to be either "optimized" or "non-optimized"; a host typically uses all the optimized paths before using any non-optimized paths it may find. All target portal groups are optimized by default. There is also an optional "preferred" setting that may be used on a target portal group. Check your host's multi-pathing software documentation to see if it supports ALUA and the preferred setting. ALUA is enabled on Initiator Groups using the "igroup-set-attribute" ZAPI. All LUNs mapped to an ALUA enabled Initiator Group will support the ALUA functionality.

Inputs

Outputs

  • None

iscsi_tpgroup_create

[Family: ontap-classic, vfiler]

Create a new user defined target portal group.

Inputs

  • tpgroup-name => string

    • Name of new user defined target portal group. Name must be <= 32 characters. In Data ONTAP 7-Mode, user defined target portal group names cannot end with "default" as this would conflict with names of default target portal groups. In Data ONTAP Cluster-Mode, user defined target portal groups cannot use the name of any defined logical interfaces (LIFs) in the vserver as this would conflict with names of default target portal groups.

Outputs

  • tpgroup-tag => integer

    • New target portal group tag.

iscsi_tpgroup_destroy

[Family: ontap-classic, vfiler]

Destroy a tpgroup. Only user defined target portal groups may be destroyed.

Inputs

  • tpgroup-tag => integer

    • Tag of portal group to destroy.

Outputs

  • None

iscsi_tpgroup_interface_add

[Family: ontap-classic, vfiler]

Add an interface to a target portal group. Interfaces may only be added to a user defined target portal group.

Inputs

  • interface-name => string

    • Name of network interface to add. In Data ONTAP 7-Mode, this is the name of a physical or virtual ethernet interface, for example: "e0c" or "vif1". In Data ONTAP Cluster-Mode, this is the name of an iSCSI data LIF in the Vserver.
  • tpgroup-tag => integer

    • Target portal group tag.

Outputs

  • None

iscsi_tpgroup_interface_delete

[Family: ontap-classic, vfiler]

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

  • interface-name => string

    • Name of network interface to remove. In Data ONTAP 7-Mode, this is the name of a physical or virtual ethernet interface, for example: "e0c" or "vif1" In Data ONTAP Cluster-Mode, this is the name of an iSCSI data LIF in the Vserver.
  • tpgroup-tag => integer

    • Target portal group tag.

Outputs

  • None

iscsi_tpgroup_list_info

[Family: ontap-classic, vfiler]

List information about target portal groups

Inputs

  • tpgroup-tag => integer, optional

    • Portal group being queried; if not supplied, information on all portal groups is returned

Outputs

license_add

[Family: ontap-classic]

Enable license for a Data ONTAP service. This API is deprecated in Data ONTAP 7-Mode 8.2 and later, and will return EAPINOTIMPLEMENTED. Use license-v2-add instead.

Inputs

Outputs

  • None

license_delete

[Family: ontap-classic]

Disable license for a Data ONTAP service. This API is deprecated in Data ONTAP 7-Mode 8.2 and later, and will return EAPINOTIMPLEMENTED. Use license-v2-delete instead.

Inputs

Outputs

  • None

license_list_info

[Family: ontap-classic, vfiler]

Returns information about the current list of licensed Data ONTAP services, their codes, the type of license, and, if it is a time limited license, the expiration date. It also tells the services that are not licensed for your appliance, or if a time limited licensed service has expired. This API is deprecated in Data ONTAP 7-Mode 8.2 and later, and will return EAPINOTIMPLEMENTED. Use license-v2-list-info instead.

Inputs

Outputs

license_v2_add

[Family: ontap-classic]

Add license for a Data ONTAP service.

Inputs

Outputs

license_v2_delete

[Family: ontap-classic]

Removes license for a Data ONTAP service.

Inputs

  • package => licensed-package

    • Package Possible values:
    • "base" - Cluster Base License,
    • "nfs" - NFS License,
    • "cifs" - CIFS License,
    • "iscsi" - iSCSI License,
    • "fcp" - FCP License,
    • "cdmi" - CDMI License,
    • "snaprestore" - SnapRestore License,
    • "snapmirror" - SnapMirror License,
    • "flexclone" - FlexClone License,
    • "snapvault" - SnapVault License,
    • "snaplock" - SnapLock License,
    • "snapmanagersuite" - SnapManagerSuite License,
    • "snapprotectapps" - SnapProtectApp License,
    • "v_storageattach" - Virtual Attached Storage License

Outputs

  • None

license_v2_list_info

[Family: ontap-classic, vfiler]

Returns infomation for DATA ONTAP licenses.

Inputs

  • None

Outputs

lock_break

[Family: ontap-classic, vfiler]

Breaks all specified locks. At least one input argument needs to be specified.

Inputs

  • file-name => string, optional

    • File name prefixed by "/vol/volX" style path. Input syntax of file-name is the same for all protocols. NOTE: Currently, breaking all locks of a file is not encouraged, as NFSv4 does not yet implement breaking of locks. If attempted, will lead to an inconsistent NFSv4 lock state. Specifying a protocol will prevent this by limiting the breaking of locks to that particular protocol. Also, breaking locks for proto "nfsv4" is explicitly disallowed.
  • host => string, optional

    • Identity of a host. It is the NetBIOS name or IP address of a CIFS cient, FQDN of a PFS client, IP address or FQDN of NLM (Nfsv2/Nfsv3) client, and IP address of NFSv4 client. If specified, then locks are printed for that host only. If not specified, then locks across all hosts are printed.

    NOTE: Currently, only CIFS protocol filters lock output by host name.
  • owner => string, optional

    • Name of the lock owner, viz., a username prefixed by an optional domain (and a backslash) for CIFS protocol ([domain\]username), IP address of caching filer suffixed by a colon and a filesystem ID of origin filer (IP:fsid) for PFS, and process-ID for NLM(Nfsv2/Nfsv3). The concept of an owner for NFSv4 is yet to be defined. If specified, then locks are printed for that owner only. If owner is not specified, locks across all owners are printed.

    NOTE: Currently, only CIFS protocol filters lock output by owner name.
  • protocol => string, optional

    • Name of the protocol (case-insensitive): "cifs" (CIFS), "nlm" (Nfsv2/Nfsv3), "nfsv4" (NFSv4), and "pfs"(PFS). If not specified, then all protocols are scanned for locks. If in that case, a host and/or owner were specified, then expect input syntax errors in "error" output field for protocols that define syntax of host or owner differently. However, scanning of locks is not aborted due to these syntax errors and instead all protocols are still scanned to completion.

Outputs

  • errors => break-error[], optional

    • If a specific protocol encounters an error, e.g., a syntax error, this element is included in the output to indicate it because the error might be for specific protocols but not for other protocols and hence should not fail the entire API. This structure includes the same information (status, reason, errno) that is normally included in the "results" attribute of the API itself.

lock_status_iter_end

[Family: ontap-classic, vfiler]

Terminate a list iteration and clean up any saved info.

Inputs

  • tag => string

    • Tag from a previous cifs-share-list-iter-start.

Outputs

  • None

lock_status_iter_next

[Family: ontap-classic, vfiler]

Returns items from a previous call to cifs-lock-status-iter-start. This API actually prints out the required locks.

Inputs

  • maximum => integer

    • The maximum number of lock entries to retrieve.
  • tag => string

    • Tag from a previous cifs-lock-status-iter-start.

Outputs

  • records => integer

    • This tells you how many locks are being returned from this particular call to lock-status-iter-next. When this value is 0, you have retrieved everything.

lock_status_iter_start

[Family: ontap-classic, vfiler]

Gives information about one or more locks, the results of which are retrieved by using lock-status-iter-next. One or more of the defined inputs can be specified in tandem to get locks for specific cases. If none of the inputs are specified, then all the locks in the system are printed. If no protocol is specified but one or more of the other inputs are specified, then locks across all protocols, viz., CIFS, PFS, NLM (Nfsv2/Nfsv3), and NFSv4, are printed. In this case, it is possible for protocols that define syntax of specified input differently to generate input syntax errors. However, these errors do not stop scanning of locks for other protocols.

Inputs

  • file-name => string, optional

    • File name prefixed by "/vol/volX" style path. If not specified, then locks across all files are printed. Input syntax of file-name is the same for all protocols.
  • host => string, optional

    • Identity of a host. It is the NetBIOS name or IP address of a CIFS client, FQDN of a PFS client, IP address or FQDN of NLM (Nfsv2/Nfsv3) client, and IP address of NFSv4 client. If specified, then locks are printed for that host only. If not specified, then locks across all hosts are printed.

    NOTE: Currently, only CIFS protocol filters lock output by host name.
  • owner => string, optional

    • Name of the lock owner, viz., a username prefixed by an optional domain (and a backslash) for CIFS protocol ([domain\]username), IP address suffixed by a colon and a filesystem ID of caching filer (IP:fsid) for PFS, and process-ID for NLM(Nfsv2/Nfsv3). The concept of an owner for NFSv4 is yet to be defined. If specified, then locks are printed for that owner only. If owner is not specified, locks across all owners are printed.

    NOTE: Currently, only CIFS protocol filters lock output by owner name.
  • protocol => string, optional

    • Name of the protocol (case-insensitive): "cifs" (CIFS), "nlm" (Nfsv2/Nfsv3), "nfsv4" (NFSv4), and "pfs"(PFS). If not specified, then all protocols are scanned for locks. If in that case, a host and/or owner were specified, then expect input syntax errors in "error" output field for protocols that define syntax of host or owner differently. However, scanning of locks is not aborted due to these syntax errors and instead all protocols are still scanned to completion.

Outputs

  • records => integer

    • Number which tells you how many items have been saved for future retrieval with lock-status-iter-next.
  • tag => string

    • Tag to be used in subsequent calls to lock-status-iter-next.

lun_clear_persistent_reservation_info

[Family: ontap-classic, vfiler]

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

  • path => string

    • Path of the lun. The path should start with '/vol/'.

Outputs

  • None

lun_clone_list_info

[Family: ontap-classic, vfiler]

Lists all LUN clones with valid backing snapshots in the given snapshot.

Inputs

  • snapshot => string

    • Name of the snapshot.

Outputs

lun_clone_split_start

[Family: ontap-classic, vfiler]

Start the cloning of the given LUN.

Inputs

  • path => string

    • Path of the clone to split from the underlying parent.

Outputs

  • None

lun_clone_split_status_list_info

[Family: ontap-classic, vfiler]

Get the cloning status of LUN(s).

Inputs

  • path => string

    • Path of the LUN.

Outputs

lun_clone_split_stop

[Family: ontap-classic, vfiler]

Stop the cloning of the given LUN.

Inputs

  • path => string

    • Path of the LUN to stop cloning.

Outputs

  • None

lun_clone_start

[Family: ontap-classic, vfiler]

Start the cloning of the given LUN.

Inputs

  • path => string

    • Path of the LUN to clone.

Outputs

  • None

lun_clone_status_list_info

[Family: ontap-classic, vfiler]

Get the cloning status of LUN(s).

Inputs

  • path => string, optional

    • Path of the LUN. If path is specified, only the status of that clone is retuned. If path is not specified, then all cloning status are returned.

Outputs

lun_clone_stop

[Family: ontap-classic, vfiler]

Stop the cloning of the given LUN.

Inputs

  • path => string

    • Path of the LUN to stop cloning.

Outputs

  • None

lun_config_check_alua_conflicts_info

Returns a list of luns that have both FCP and ISCSI maps at the same time when ALUA is enabled on atleast one of such FCP or ISCSI igroups. These conflicts must be resolved before any further maps (to those luns) can can take place.

Inputs

  • None

Outputs

  • conflicting-luns => conflicting-luns-list[], optional

    • If a lun is mapped to both FCP and iSCSI igroups at at the same time with ALUA enabled on atleast one of those igroups, it leads to a conflict. These conflicts need to be resolved before any further maps can take place to the conflicting lun. Conflicts can either be resolved by unmapping one or more mappings or by disabling ALUA on FCP or iSCSI or both the igroups whichever is applicable.

lun_config_check_cfmode_info

Returns a list of configuration warnings related to initiator groups and the fcp cfmode setting

Inputs

  • None

Outputs

lun_config_check_info

Returns a list of lun/fcp configuration warnings. These warnings are not related to filer cluster configuration.

Inputs

  • None

Outputs

  • alua-setting-mismatch-info => alua-setting-mismatch-initiator-group[], optional

    • list of initiator groups for which the ALUA (Asymmetric Logical Unit Access) settings do not match between local and partner filers. ALUA is a T10 standard that specifies the access characteristics (in terms of performance and supported SCSI commands) of a Logical Unit that can be accessed through more than one target port. ALUA is typically used by host multi-path software to recognize primary and secondary paths to a Logical Unit when more than one path are available to the Logical Unit. If the ALUA setting does not match between the local and partner filers, it would affect the host multi-path software's ability to distingush primary and secondary paths. This could lead to incorrect system behaviour.
  • mixed-vsa-initiators => mixed-vsa-initiator-info[], optional

    • List of initiators which are members of initiator groups with differing Volume Set Addressing (VSA) settings. An initiator can only be a member of initiator groups which have the same VSA setting across all the initiator groups it is a member of.

lun_config_check_single_image_info

Returns a list of configuration warnings that pertain to problems specific to the 'single_image' fcp cfmode. These errors must befixed prior to upgrading any filer cluster to run in 'single_image' mode.

Inputs

  • None

Outputs

  • conflicting-maps => conflicting-map-info[], optional

    • Only one lun in the cluster can be mapped to an initiator at a given lun-id. If a lun on each filer is mapped to the same initiator at the same lun-id there will be a conflict. These conflicts need to be resolved before a filer can be upgraded to run in the 'single_image' fcp cfmode. A conflict can be resolved by unmapping one lun and remapping it to an unused lun-id.
  • invalid-nodename-settings => invalid-nodename-setting-info, optional

    • When running in the the single_image cfmode the fcp nodename needs to be same on each filer in the cluster. If the nodenames are different the nodenames will be returned. If the cfmode is not set to single_image, then the nodenames will not be checked

lun_config_check_wwpn_conflicts_info

[Family: ontap-classic]

Determine if duplicate World Wide Port Names (WWPNs) are present on a cluster pair.

Inputs

  • None

Outputs

  • conflicting-wwpns => conflict-wwpn[], optional

    • If duplicate World Wide Port Names (WWPNs) are present on the HA pair, it leads to a conflict. This causes incorrect Asymmetric Logical Unit Access (ALUA) states to be advertised for all LUNs. To resolve the conflict use 'lun config set' command to set local.single_image.key and partner.single_image.key on both the nodes of the HA pair.

lun_create_by_size

[Family: ontap-classic, vfiler]

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

  • ostype => lun-os-type, optional

    • The os type for the LUN. The default type if not specified is "image". It is strongly recommended for the caller of this API to avoid using the "image" type because it could result in misconfigured LUNs. For example, a lun with ostype "image" could suffer major performance penalties when a Windows host is trying to access it.
  • path => string

    • Path of the LUN.
  • prefix-size => integer, optional

    • The size of the prefix stream for this lun in bytes. Certain OS types store a small portion of the data corresponding to partition tables (or similar structures) in the prefix stream. This is part of the lun data and is transparent to hosts that access the LUN via block protocols. The default size is based on the ostype. Giving a value here overrides the default, but, it is strongly recommended to avoid changing this default size. The value in this field must be a multiple of 512 bytes. Note that this value has no effect when the lun-os-type is "image". This option is available in Data ONTAP 8.1 and later.

Outputs

lun_create_clone

[Family: ontap-classic, vfiler]

Create a LUN clone.

Inputs

  • path => string

    • Path of the LUN clone.
  • space-reservation-enabled => boolean, optional

    • By default, the lun is space-reserved. If it is desired to manage space usage manually instead, this can be set to "false" which will create a LUN without any space being reserved.

Outputs

  • None

lun_create_from_file

[Family: ontap-classic, vfiler]

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

  • file-name => string

    • A fully qualified filer path to the file to create the LUN from. This must be in the same qtree as the LUN being created. The file must also be in the root of the volume or in a qtree/regular directory in the root of the volume or in a regular directory in a qtree.
  • ostype => lun-os-type, optional

    • The os type for the LUN. The default type if not specified is "image". It is strongly recommended for the caller of this API to avoid using the "image" type because it could result in misconfigured LUNs. For example, a lun with ostype "image" could suffer major performance penalties when a Windows host is trying to access it.
  • path => string

    • Would be Path of the newly created LUN if successful. This Path must not exist already (i.e a file or dir with this same path).
  • space-reservation-enabled => boolean, optional

    • By default, the lun is space-reserved. If it is desired to manage space usage manually instead, this can be set to "false" which will create a LUN without any space being reserved.

Outputs

  • actual-size => integer

    • The actual size of the LUN that was created, in bytes.

lun_create_from_snapshot

[Family: ontap-classic, vfiler]

Creates a LUN in the active file system. The lun has the same initial contents as the referenced snapshot copy of an existing lun. (Note that no copy of the data is made.) Future writes go into the new lun. Reads of unmodified data are satisfied from the snapshot location. Reads of modified data are satisfied by first attempting to find the required buffer in the new lun. If a buffer is not found (buffer corresponds to a hole), it is looked for in the snapshot copy instead.

Inputs

  • path => string

    • Path of the LUN.
  • space-reservation-enabled => boolean, optional

    • By default, the lun is space-reserved. If it is desired to manage space usage manually instead, this can be set to "false" which will create a LUN without any space being reserved.
  • type => lun-os-type, optional

    • The os type for the LUN. The default type if not specified is "image". It is strongly recommended for the caller of this API to avoid using the "image" type because it could result in misconfigured LUNs. For example, a lun with ostype "image" could suffer major performance penalties when a Windows host is trying to access it.

Outputs

  • actual-size => integer

    • The actual size of the LUN that was created, in bytes.

lun_destroy

[Family: ontap-classic, vfiler]

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

  • force => boolean, optional

    • If "true", override checks that prevent a LUN from being destroyed if it is online and mapped. If "false", destroying an online and mapped LUN will fail. The default if not specified is "false".
  • path => string

    • Path of the LUN.

Outputs

  • None

lun_get_attribute

[Family: ontap-classic, vfiler]

Get a named attribute for a given LUN.

Inputs

  • path => string

    • Path of the LUN.

Outputs

  • value => string

    • Value of the attribute.

lun_get_comment

[Family: ontap-classic, vfiler]

Get the optional descriptive comment for a LUN.

Inputs

  • path => string

    • Path of the LUN.

Outputs

lun_get_geometry

[Family: ontap-classic, vfiler]

Get SCSI disk geometry for a given LUN.

Inputs

  • path => string

    • Path of the LUN.

Outputs

  • cylinders => integer

    • Number of cylinders in the LUN The size of the LUN can be calculated like this: cylinders tracks-per-cylinder sectors-per-track X bytes-per-sector --------------------- size
  • max-resize-size => integer

    • The maximum size this LUN can be resized to in bytes. LUN resize is limited by the lun cylinder size which can not be increased beyond 65535. This number is calculated using a cylinder count of 65535, in place of the LUNs actual cylinder size.
  • size => integer

    • LUN size in bytes.

lun_get_inquiry_info

[Family: ontap-classic, vfiler]

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

  • initiator-group-name => string

    • The initiator group for which the vid/pid/rev information is to be returned.

Outputs

lun_get_maxsize

[Family: ontap-classic, vfiler]

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

  • path => string

    • Path of the volume or qtree.

Outputs

lun_get_minsize

[Family: ontap-classic]

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

  • type => lun-os-type

    • OS type of the LUN.

Outputs

lun_get_occupied_size

[Family: ontap-classic, vfiler]

Get the size occupied by the LUN in the active FS.

Inputs

  • path => string

    • Path of the LUN.

Outputs

lun_get_persistent_reservation_info

[Family: ontap-classic, vfiler]

Get the persistent reservation information for a given LUN.

Inputs

  • path => string

    • Path of the lun. The path should start with '/vol/'.

Outputs

  • persistent-reservation => persistent-reservation-info[], optional

    • This is the persistent reservation information for a given I_T nexus if any exist for the given lun. The communication path and state between an initiator and a target is called an Initiator_Target Nexus, or I_T Nexus. The I_T Nexus is the owner of the persistent reservation information. There can be several I_T Nexus that have registered per lun. Each I_T Nexus can only register one time per lun.

lun_get_select_attribute

[Family: ontap-classic, vfiler]

Get the select attribute for the specified LUN.

Inputs

  • path => string

    • Path of the LUN.

Outputs

  • creation-time => string

    • The time this lun was created, in human readable format. This field is deprecated in Data ONTAP 8.1. Instead, use creation-timestamp.
  • creation-timestamp => integer

    • The time this lun was created, in seconds since January 1, 1970. This field is available in Data ONTAP 8.1 and later.
  • select-attribute => string

    • The select attribute for the lun. Possible values:
    • "active" - this is an active lun,
    • "copy" - this is a clone or copy of an active lun,
    • "mirror" - this is a mirror of an active lun.

lun_get_serial_number

[Family: ontap-classic, vfiler]

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

  • path => string

    • Path of the LUN.

Outputs

lun_get_space_reservation_info

[Family: ontap-classic, vfiler]

Queries the space reservation settings for the named LUN.

Inputs

  • path => string

    • Name of the LUN to be queried.

Outputs

  • is-enabled => boolean

    • Whether or not the LUN has space reservation enabled.

lun_get_target_device_id

[Family: ontap-classic, vfiler]

Returns the SCSI Target Device Id.

Inputs

Outputs

  • target-device-id => string

    • SCSI Target Device Id. This is defined by Network Appliance. Currently a string of numbers preceded by "naa.600A098".

lun_get_vdisk_attributes

[Family: ontap-classic, vfiler]

Lookup a LUN path and storage system by serial number.

Inputs

  • serial-number => string

    • Serial number for the LUN.

Outputs

  • filer-name => string

    • In Data ONTAP 7-Mode, this is the name of the storage system or vfiler containing the LUN. In Data ONTAP Cluster-Mode, this is the name of the Vserver containing the LUN.
  • path => string

    • Path for the specified LUN, for example: "/vol/vol0/lun1".
  • vdisk-snapshot-name => string

    • Path to the backing snapshot file for the LUN, for example: "/vol/vol1/.snapshot/snapshot/lun". This field will be empty if the LUN is not backed by a snapshot file.

lun_has_scsi_reservations

[Family: ontap-classic, vfiler]

Queries for all types of scsi reservations covering both iSCSI and FCP.

Inputs

  • path => string

    • Path of the lun. The path should start with '/vol/'.

Outputs

lun_initiator_list_map_info

[Family: ontap-classic, vfiler]

List all the luns mapped to an initiator

Inputs

  • initiator => string

    • initiator to check

Outputs

lun_initiator_logged_in

[Family: ontap-classic, vfiler]

Determine if an initiator is logged in via FCP or iSCSI.

Inputs

  • initiator => string

    • Name of FCP or iSCSI initiator to check.

Outputs

lun_list_info

[Family: ontap-classic, vfiler]

Get the status (size, online/offline state, shared state, comment string, serial number, LUN mapping) of the given LUN, or all LUNs.

Inputs

  • path => string, optional

    • Path of LUN. If specified, only the information of that LUN is returned. This option can only be used if volume-name is not used.
  • volume-name => string, optional

    • Name of a volume. If specified, only the information of the LUNs in that volume is returned. This option can only be used if path is not specified.

Outputs

  • are-vols-busy => boolean

    • Indicates whether any volumes are moving. If true, the output of this command cannot be considered authoritative. Users needing authoritative data should retry until this output parameter is false.
  • are-vols-onlining => boolean

    • Indicates whether any volumes are still in the process of onlining. If true, the output of this command cannot be considered authoritative. Users needing authoritative data should retry until this output parameter is false.

lun_map

[Family: ontap-classic, vfiler]

Maps the LUN to all the initiators in the specified initiator group.

Inputs

  • force => boolean, optional

    • Forcibly map the lun, disabling mapping conflict checks with the high-availability partner. If not specified all conflict checks are performed. In Data ONTAP Cluster-Mode, this field is accepted for backwards compatibilty and is ignored.
  • lun-id => integer, optional

    • If the lun-id is not specified, the smallest number that can be used for the various initiators in the group is automatically picked.
  • path => string

    • Path of the LUN.

Outputs

  • lun-id-assigned => integer

    • LUN ID assigned for this map. If lun-id is not supplied, this will be an auto-assigned LUN ID, otherwise it will be the same as the supplied LUN ID if map is successful.

lun_map_list_info

[Family: ontap-classic, vfiler]

Returns a list of initiator groups and their members (the initiators) mapped to the given LUN.

Inputs

  • path => string

    • LUN for which the initiator group list is requested.

Outputs

  • initiator-groups => initiator-group-info[], optional

    • List of initiator groups that are mapped to the given LUN.

lun_move

[Family: ontap-classic, vfiler]

Move (rename) a LUN.

Inputs

  • path => string

    • Path of the LUN to be moved.

Outputs

  • None

lun_offline

[Family: ontap-classic, vfiler]

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

  • path => string

    • Path of the LUN.

Outputs

  • None

lun_online

[Family: ontap-classic, vfiler]

Re-enables block-protocol accesses to the lun.

Inputs

  • force => boolean, optional

    • Forcibly online the lun, disabling mapping onflict checks with the high-availability partner. If not specified all conflict checks are performed. In Data ONTAP Cluster-Mode, this field is accepted for backwards compatibility and is ignored.
  • path => string

    • Path of the LUN.

Outputs

  • None

lun_port_has_scsi_reservations

[Family: ontap-classic, vfiler]

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

  • path => string

    • Path of the lun. The path should start with '/vol/'.

Outputs

  • is-reservation-held => boolean

    • 'true' if given LUN has a scsi-2 or scsi-3 style reservation held, 'false' otherwise.

lun_reset_stats

[Family: ontap-classic, vfiler]

Resets (zeroes) block-protocol access statistics for LUN(s).

Inputs

  • path => string, optional

    • Path of the LUN. If path is specified, the stats of that LUN will be reset. If path is not specified, stats of all LUNs are reset.

Outputs

  • None

lun_resize

[Family: ontap-classic, vfiler]

Changes the size of the lun. Note that client-side operations may be needed to ensure that client software recognizes the changed size.

Inputs

  • force => boolean, optional

    • Forcibly reduce the size. This is required for reducing the size of the LUN to avoid accidentally reducing the LUN size.
  • path => string

    • Path of the LUN.
  • size => integer

    • New size for the LUN.

Outputs

  • actual-size => integer

    • Actual new size. This may be different from the specified size due to the requested size not fitting on a cylinder boundary.

lun_restore_status

[Family: ontap-classic, vfiler]

Get state of LUN restore.

Inputs

  • path => string

    • Path of the LUN.

Outputs

lun_set_attribute

[Family: ontap-classic, vfiler]

Set a named attribute for a given LUN. Attributes are arbitrary key/value pairs for application-defined use.

Inputs

  • name => string

    • Application-defined attribute to set. In order to prevent conflicts between separate applications, it is recommended that applications prefix attribute names with their registered Internet domain name reversed component by component, and an application identifier. For example: "com.example.widgetapp.attribute". The following attributes are reserved by the system and may not be set: "custom", "cylinder_size", "dev_id", "enabled", "extent_size", "host_stamp", "path_last", "pserial", "pSerial", "serial", "snapshot", "snapshot_path_last", "type". In older versions of Data ONTAP, attempting to set a system-reserved attribute may adversely affect data integrity and availability of the storage system. Clients of this API must therefore take special care to not use any system-reserved attribute names.
  • path => string

    • Path of the LUN.
  • value => string

    • Value to set the attribute to. In Data ONTAP Cluster-mode, the combined size of "name" and "value" must not exceed 4092 bytes.

Outputs

  • None

lun_set_comment

[Family: ontap-classic, vfiler]

Set the optional descriptive comment for a LUN.

Inputs

  • comment => string

    • Comment to set for given LUN.
  • path => string

    • Path of the LUN.

Outputs

  • None

lun_set_device_id

[Family: ontap-classic, vfiler]

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:
  • 0000000b - Peripheral Device Identifying Information, a binary string 1 to 64 bytes long. In addition, if the Peripheral Device Identifying Information is between 00000001h (1d) and 0000270Fh (9999d), it will be returned in response to the vendor unique SCSI command GET DEV ID.
  • 0000010b - Peripheral Device Text Identifying Information, a UTF-8 string 1 to 255 bytes long.
Either or both peripheral device identifying information values may be set or cleared independently.

Inputs

  • device-id => string

    • SCSI Peripheral Device Identifying Information. In Data ONTAP 7-Mode or if device-id-type is "legacy", the value must be an integer in the range [1..9999]. If device-id-type is "binary", the value must be a 1 to 64 byte value encoded as a hexadecimal string, for example "0000270F". If device-id-type is "text", the value is a free-form UTF-8 string between 1 and 255 bytes in length.
  • path => string

    • Path of the LUN.

Outputs

  • None

lun_set_select_attribute

[Family: ontap-classic, vfiler]

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

  • path => string

    • Path of the LUN.
  • select-value => string

    • Sets the select attribute for the lun. Possible values:
    • "active" - this is an active lun,
    • "copy" - this is a clone or copy of an active lun,
    • "mirror" - this is a mirror of an active lun.

Outputs

  • None

lun_set_serial_number

[Family: ontap-classic, vfiler]

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

  • path => string

    • Path of the LUN.
  • serial-number => string

    • Serial number for the LUN.

Outputs

  • None

lun_set_share

[Family: ontap-classic, vfiler]

Enables file system protocol-based access to a lun. By default, all accesses are disallowed. Note that file permissions and ACL entries still apply.

Inputs

  • path => string

    • Path of the LUN.

Outputs

  • None

lun_set_space_reservation_info

[Family: ontap-classic, vfiler]

Sets the space reservation settings for the named LUN.

Inputs

  • path => string

    • Path to the LUN for which the space reservations need to be set.

Outputs

  • None

lun_snap_usage_list_info

[Family: ontap-classic, vfiler]

Lists all LUNs backed by data in the specified snapshot. It also lists the corresponding snapshots in which these LUNs exist.

Inputs

  • snapshot => string

    • Name of the snapshot.
  • volume => string

    • Name of the volume.

Outputs

lun_start

[Family: ontap-classic, vfiler]

Starts block-protocol accesses to the lun.

Inputs

  • path => string

    • Path of the LUN. The path should start with '/vol/' (for example, "/vol/vol0/lun1").

Outputs

  • None

lun_stats_list_info

[Family: ontap-classic, vfiler]

Get block-protocol access statistics (in bytes) for LUN(s).

Inputs

  • path => string, optional

    • Path of the LUN. If path is specified, only the stats of that LUN is returned. If path is not specified, stats of all LUNs are returned.

Outputs

lun_unmap

[Family: ontap-classic, vfiler]

Reverses the effect of lun-map on the specified LUN for the specified group.

Inputs

  • initiator-group => string

    • Initiator group to unmap from.
  • path => string

    • Path of the LUN.

Outputs

  • None

lun_unset_attribute

[Family: ontap-classic, vfiler]

Clear a named attribute for a given LUN.

Inputs

  • name => string

    • Name of attribute to unset. The following attributes are reserved by the system and may not be unset: "custom", "cylinder_size", "dev_id", "enabled", "extent_size", "host_stamp", "path_last", "pserial", "pSerial", "serial", "snapshot", "snapshot_path_last", "type". In older versions of Data ONTAP, attempting to unset a system-reserved attribute may adversely affect data integrity and availability of the storage system. Clients of this API must therefore take special care to not use any system-reserved attribute names.
  • path => string

    • Path of the LUN.

Outputs

  • None

lun_unset_device_id

[Family: ontap-classic, vfiler]

Remove a SCSI peripheral device identifying information value from a LUN.

Inputs

  • path => string

    • Path of the LUN.

Outputs

  • None

nameservice_map_gid_to_group_name

[Family: ontap-classic, vfiler]

Obtain a group name from a Unix GID, using whatever mechanism the filer nameservice is currently using.

Inputs

Outputs

nameservice_map_group_name_to_gid

[Family: ontap-classic, vfiler]

Obtain the Unix GID for a given group name, using whatever mechanism the filer nameservice is currently using.

Inputs

  • group => string

    • Name of an NFS group.

Outputs

  • gid => integer

    • Unix GID corresponding to that group.

nameservice_map_sid_to_uid

[Family: ontap-classic, vfiler]

Obtain a Unix UID from a Windows SID.

Inputs

Outputs

nameservice_map_uid_to_user_name

[Family: ontap-classic, vfiler]

Obtain a user name from a Unix UID, using whatever mechanism the filer nameservice is currently using.

Inputs

  • uid => integer

    • A Unix UID.

Outputs

nameservice_map_unix_to_windows

[Family: ontap-classic, vfiler]

Obtain windows user information for a given unix user name.

Inputs

  • user => string

    • A Unix user name.

Outputs

  • user => string

    • Windows username in that domain.

nameservice_map_user_name_to_uid

[Family: ontap-classic, vfiler]

Obtain the Unix UID for a given user name, using whatever mechanism the filer nameservice is currently using.

Inputs

  • user => string

    • Name of user.

Outputs

  • uid => integer

    • Unix UID corresponding to that user.

nameservice_map_windows_to_unix

[Family: ontap-classic, vfiler]

Obtain a unix user name from windows user information.

Inputs

  • domain => string

    • Windows domain of the user.
  • user => string

    • A Windows user name.

Outputs

  • user => string

    • Unix name corresponding to that user.

net_config_get_active

[Family: ontap-classic]

Output the current network config Output includes vlans, ifgrps and static routes with information from vlan, ifgrp, route & ifconfig commands

Inputs

  • None

Outputs

net_config_get_persistent

[Family: ontap-classic]

Reads filer's /etc/rc and outputs contents.

Inputs

  • None

Outputs

  • net-config-info => net-config-info

    • Persistent network configuration (/etc/rc).

net_config_set_persistent

[Family: ontap-classic]

Writes filer's persistent network config.

Inputs

  • net-config-info => net-config-info

    • Persistent network configuration (/etc/rc).

Outputs

  • None

net_dcb_list_info

[Family: ontap-classic]

Returns the current Data Center Bridging (DCB) configuration for a specified network interface or all network interfaces indexed by the priority group id.

Inputs

  • interface-name => string, optional

    • The network interface name. If not specified, the priority group associated DCB configuration for all DCB-capable network interfaces will be displayed.

Outputs

net_dcb_priority_list_info

[Family: ontap-classic]

Returns the current Data Center Bridging (DCB) configuration for a specified network interface or all network interfaces indexed by the DCB priority.

Inputs

  • interface-name => string, optional

    • The interface name. If not specified, the priority associated DCB configuration for all DCB-capable network interfaces will be displayed.
  • priority => integer, optional

    • The priority. Range: [0..7] If not specified, the priority associated DCB configuration for all DCB priorities will be displayed.

Outputs

net_get_address_info

[Family: ontap-classic, vfiler]

Resolves a host name to one or more IPv4 or IPv6 addresses. Returns appropriate errorcode if the host name cannot be resolved.

Inputs

  • host-info => host-info

    • Contains name of the host to be resolved, hints will be provided in order to return the appropriate type of addresses, service name for which the address will be used.

Outputs

net_ifconfig_get

[Family: ontap-classic]

Output the current configuration for one interface.

Inputs

  • interface-name => string, optional

    • This is the name of the interface to display. If not provided, all interfaces will be displayed.

Outputs

net_ifconfig_set

[Family: ontap-classic]

Configure network interface. Does not modify persistent config.

Inputs

Outputs

  • None

net_ipspace_assign

[Family: ontap-classic]

Assign a list of interfaces to an ipspace. Modifies persistent config.

Inputs

Outputs

  • None

net_ipspace_create

[Family: ontap-classic]

Create a new ipspace. Modifies persistent config.

Inputs

Outputs

  • None

net_ipspace_destroy

[Family: ontap-classic]

Destroy an ipspace. Modifies persistent config.

Inputs

Outputs

  • None

net_ipspace_list

[Family: ontap-classic]

List ipspaces.

Inputs

  • None

Outputs

net_ping

[Family: ontap-classic, vfiler]

Ping a host. The API returns on the first successful ping of retry-count attempts. EHOSTNOTFOUND is returned if the host cannot be resolved. EONTAPI_EHOSTDOWN is returned if the host cannot be pinged. The interval between retries is 1 second. IPv6 is not supported at this time.

Inputs

Outputs

  • None

net_ping_info

[Family: ontap-classic, vfiler]

Ping a host. The API pings the host count times, and returns the number of successful pings and times. EHOSTNOTFOUND is returned if the host cannot be resolved. EHOSTNOCONTACT is returned if the host cannot be pinged. The interval between ping attempts is 1 second. IPv6 is not supported at this time.

Inputs

  • host-name-or-ip-address => string

    • The name or the IP address of the host to ping. The format is an IPv4 host name or IP address.
  • ping-count => integer, optional

    • The number of pings. Default is 3. Range: [1..16]

Outputs

  • round-trip-maximum-time => integer, optional

    • Maximum time in microseconds for a round trip between the filer and the host if packets-recieved is greater than zero. Range: [0..2^31-1]
  • round-trip-mean-time => integer, optional

    • Mean time in microseconds for a round trip between the filer and the host if packets-recieved is greater than zero. Range: [0..2^31-1]
  • round-trip-minimum-time => integer, optional

    • Mimumum time in microseconds for a round trip between the filer and the host if packets-recieved is greater than zero. Range: [0..2^31-1]

net_resolve

[Family: ontap-classic, vfiler]

Resolves a host name to one or more IP addresses. Returns an error code of gethostbyname_r if failed. Does not support IPv6 at this time.

Inputs

Outputs

net_reverse_resolve

[Family: ontap-classic, vfiler]

Resolves an IP address to one or more host names. Returns an error code of gethostbyaddr_r if failed. Does not support IPv6 at this time.

Inputs

  • ip-address => string

    • IP address of the host to be resolved in dotted notation (for example, 10.56.10.125).

Outputs

net_route_add

[Family: ontap-classic, vfiler]

Create a new kernel route. Does not modify persistent config.

Inputs

Outputs

  • None

net_route_delete

[Family: ontap-classic, vfiler]

Delete a kernel route. Does not modify persistent config.

Inputs

Outputs

  • None

net_vlan_create

[Family: ontap-classic]

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

  • None

net_vlan_delete

[Family: ontap-classic]

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

  • None

nfs_disable

[Family: ontap-classic, vfiler]

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

  • None

Outputs

  • None

nfs_enable

[Family: ontap-classic, vfiler]

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

  • None

Outputs

  • None

nfs_exportfs_append_rules

[Family: ontap-classic, vfiler]

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

  • persistent => boolean, optional

    • In Data ONTAP 7-Mode, default value is false. If true, modifies the etc/exports file to append the rule for a permanent change. (The new rule still takes effect immediately.) In Data ONTAP Cluster-Mode, the export entries are always persistent. Default value is true. If false, an error will be returned.
  • verbose => boolean, optional

    • If true, returns a list of directories which were appended. Errors during the append are recorded in the 'results' field error and 'loaded-pathnames' will contain which pathnames were successfully appended. Default value is false.

Outputs

  • exported-pathnames => pathname-info[], optional

    • In Data ONTAP 7-Mode, this will return verbose output of what pathnames were successfully saved in the etc/exports file. Only returned if verbose and persistent options are set. In Data ONTAP Cluster-Mode, this will return verbose output of what pathnames were successfully appended. Only returned if verbose option is set.

nfs_exportfs_append_rules_2

[Family: ontap-classic, vfiler]

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

  • persistent => boolean, optional

    • In Data ONTAP 7-Mode, default value is false. If true, modifies the etc/exports file to append the rule for a permanent change. (The new rule still takes effect immediately.) In Data ONTAP Cluster-Mode, the export entries are always persistent. Default value is true. If false, an error will be returned.
  • verbose => boolean, optional

    • If true, returns a list of directories which were appended. Errors during the append are recorded in the 'results' field error and 'loaded-pathnames' will contain which pathnames were successfully appended. Default value is false.

Outputs

  • exported-pathnames => pathname-info[], optional

    • In Data ONTAP 7-Mode, this will return verbose output of what pathnames were successfully saved in the etc/exports file. Only returned if verbose and persistent options are set. In Data ONTAP Cluster-Mode, this will return verbose output of what pathnames were successfully appended. Only returned if verbose option is set.
  • loaded-pathnames => pathname-info[], optional

    • Verbose output of what pathnames were successfully appended Only returned if verbose option is set.

nfs_exportfs_check_permission

[Family: ontap-classic, vfiler]

Returns true if the host IP has mount permissions for a specified path.

Inputs

  • host => string

    • IP address of the host to check in dotted decimal format: AAA.BBB.CCC.DDD

Outputs

nfs_exportfs_delete_rules

[Family: ontap-classic, vfiler]

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

  • pathnames => pathname-info[], optional

    • In the Data ONTAP 7-Mode, these must be the pathnames to be deleted from the exports table. In Data ONTAP Cluster-Mode, the junction paths of the volumes to be unexported must be provided.
  • persistent => boolean, optional

    • In Data ONTAP 7-Mode, default value is false. Modify the etc/exports file to delete the rules permanently. CAUTION: If 'all-pathnames' and 'persistent' are both true, all exports are removed permanently. In Data ONTAP Cluster-Mode, the export entries are always persistent. Default value is true. If false, an error will be returned.
  • verbose => boolean, optional

    • Return a verbose output of what occurred. If there is an error after deleting only a few rules, 'deleted-pathnames' will return which rules were deleted. Default value is false.

Outputs

  • deleted-pathnames => pathname-info[], optional

    • In Data ONTAP 7-Mode, this will return the list of pathnames deleted from the exports table in memory. Only returned if verbose option is set. In Data ONTAP Cluster-Mode, this will return the list of pathnames unexported.
  • unexported-pathnames => pathname-info[], optional

    • In Data ONTAP 7-Mode, this will return the list of pathnames deleted from the exports file. Only returned if verbose and persistent options are set. In Data ONTAP Cluster-Mode, this will return the list of pathnames unexported.

nfs_exportfs_fence_disable

[Family: ontap-classic, vfiler]

Disables fencing to the given exports for the given entry. This means that the entry will have write permission to the exports. The rule changes take effect immediately. Set the persistent option to true to save the rule in the /etc/exports file and keep the option persistent upon loading or reboot.

Inputs

  • all-pathnames => boolean, optional

    • Default value is false. Set to true to unfence all rules. 'fenced-paths' option must be left empty if this option is true.
  • persistent => boolean, optional

    • Default value is false. If true, modifies the etc/exports file to append the rule for a permanent change. (The new rule still takes effect immediately.) If false, only change the exports in memory.

Outputs

  • None

nfs_exportfs_fence_enable

[Family: ontap-classic, vfiler]

Enables fencing to the given exports for the given entry. This means that the entry will not have write permission to the exports. The rule changes take effect immediately. Set the persistent option to true to save the rule in the /etc/exports file and keep the option persistent upon loading or reboot.

Inputs

  • all-pathnames => boolean, optional

    • Default value is false. Set to true to fence all rules. 'fenced-paths' option must be left empty if this option is true.
  • fenced-paths => pathname-info[], optional

    • An array of paths which are to be fenced off.
  • persistent => boolean, optional

    • Default value is false. If true, modifies the etc/exports file to append the rule for a permanent change. (The new rule still takes effect immediately.) If false, only change the exports in memory.

Outputs

  • None

nfs_exportfs_flush_cache

[Family: ontap-classic, vfiler]

For the given path, renew or flush the access cache.

Inputs

Outputs

  • None

nfs_exportfs_list_rules

[Family: ontap-classic, vfiler]

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

  • pathname => string, optional

    • The pathname, for whose matching export, the client wants a listing of the associated rules. If this parameter is provided, the persistent parameter is ignored.
  • persistent => boolean, optional

    • In Data ONTAP 7-Mode, default value is false. If true, the export entries that are present in the /etc/exports file are returned; otherwise, those loaded in memory are returned. This parameter is ignored, if the pathname parameter is provided. In Data ONTAP Cluster-Mode, the export entries are always persistent. Default value is true. If false, an empty list will be returned.

Outputs

  • rules => exports-rule-info[]

    • Array of exports rules loaded in memory or found in the etc/exports file. If pathname parameter is provided, returns the corresponding rules that are loaded in memory.

nfs_exportfs_list_rules_2

[Family: ontap-classic, vfiler]

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

  • pathname => string, optional

    • The pathname, for whose matching export, the client wants a listing of the associated rules. If this parameter is provided, the persistent parameter is ignored.
  • persistent => boolean, optional

    • In Data ONTAP 7-Mode, default value is false. If true, the export entries that are present in the /etc/exports file are returned; otherwise, those loaded in memory are returned. This parameter is ignored, if the pathname parameter is provided. In Data ONTAP Cluster-Mode, the export entries are always persistent. Default value is true. If false, an empty list will be returned.

Outputs

  • rules => exports-rule-info-2[]

    • Array of exports rules loaded in memory or found in the etc/exports file. If pathname parameter is provided, returns the corresponding rules that are loaded in memory.

nfs_exportfs_load_exports

[Family: ontap-classic, vfiler]

Loads the etc/exports file into memory. Replaces exports rules already residing in memory.

Inputs

Outputs

  • None

nfs_exportfs_modify_rule

[Family: ontap-classic, vfiler]

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

  • persistent => boolean

    • In Data ONTAP 7-Mode, default value is false. If true, modifies the etc/exports file to append the rule for a permanent change. (The new rule still takes effect immediately.) In Data ONTAP Cluster-Mode, the export entries are always persistent. Default value is true. If false, an error will be returned.
  • rule => exports-rule-info

    • The rule to modify. Returns an error if a previous rule with the same pathname is not already loaded into memory.

Outputs

  • None

nfs_exportfs_modify_rule_2

[Family: ontap-classic, vfiler]

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

  • persistent => boolean

    • In Data ONTAP 7-Mode, default value is false. If true, modifies the etc/exports file to append the rule for a permanent change. (The new rule still takes effect immediately.) In Data ONTAP Cluster-Mode, the export entries are always persistent. Default value is true. If false, an error will be returned.
  • rule => exports-rule-info-2

    • The rule to modify. Returns an error if a previous rule with the same pathname is not already loaded into memory.

Outputs

  • None

nfs_exportfs_storage_path

[Family: ontap-classic, vfiler]

For the given path, determine the actual storage path. Returns an error if the path does not exist.

Inputs

  • pathname => string

    • Virtual pathname which has a rule associated with an actual pathname.

Outputs

nfs_get_supported_sec_flavors

[Family: ontap-classic, vfiler]

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

  • None

Outputs

nfs_monitor_add

[Family: ontap-classic, vfiler]

starts monitoring the specified hosts for NFS lock recovery purposes. The specified hosts are added to the list of of clients that will be notified of lock recovery in the event of an NFS server crash/reboot. For more information, see the sm_mon(1a) manual page.

Inputs

Outputs

  • None

nfs_monitor_list

[Family: ontap-classic, vfiler]

Lists the hosts that are currently being monitored by the NFS status monitor.

Inputs

  • None

Outputs

  • hosts => hostaddr[]

    • an array of hosts that are currently being monitored.

nfs_monitor_reclaim

[Family: ontap-classic, vfiler]

reclaims the NFS locks for the specified client hosts. If no hosts are specified, then all the clients locks are removed and are notified about lock recovery, as if an NFS server crash/reboot had happened. If any hosts are specified, then only those client hosts locks are reclaimed For more information, see the sm_mon(1a) manual page.

Inputs

Outputs

  • None

nfs_monitor_remove

[Family: ontap-classic, vfiler]

Starts unmonitoring the specified hosts for NFS lock recovery purposes. The specified hosts are removed from the list of clients that will be notified of lock recovery in the event of an NFS server crash/reboot. For more information, see the sm_mon(1a) manual page.

Inputs

  • hosts => hostaddr[]

    • an array of hosts that are to be unmonitored.

Outputs

  • None

nfs_monitor_remove_locks

[Family: ontap-classic, vfiler]

removes the NFS locks of a specfied process of a specified client host.

Inputs

Outputs

  • None

nfs_stats_get_client_stats

[Family: ontap-classic, vfiler]

Collects NFS statistics for a specified client

Inputs

  • host => string

    • Hostname or IP address of client

Outputs

nfs_stats_top_clients_list_iter_end

[Family: ontap-classic, vfiler]

Terminate NFS client statistics iteration and cleanup any saved info.

Inputs

  • tag => string

    • Tag from a previous nfs-stats-top-clients-list-iter-start

Outputs

  • None

nfs_stats_top_clients_list_iter_next

[Family: ontap-classic, vfiler]

Continues the nfs-stats-top-clients-list-iter-start iteration through the top NFS clients, ordered by total NFS operations.

Inputs

  • maximum => integer

    • The maximum number of entries to retrieve. Range : [0..2^32-1].
  • tag => string

    • Tag from a previous nfs-stats-top-iter-start

Outputs

  • records => integer

    • This tells you how many records are being returned from this particular call to nfs-stats-top-client-list-iter-next When this value is 0, you have retrieved everything. Range : [0..2^32-1].

nfs_stats_top_clients_list_iter_start

[Family: ontap-classic, vfiler]

Starts an iteration through the top NFS clients, ordered by total NFS operations.

Inputs

  • maxclients => integer, optional

    • Specifies the maximum number of top clients to retrieve (the default is 20) Range : [1..2^32-1].

Outputs

  • records => integer

    • Number which tells you how many items have been saved for future retrieval with nfs-stats-top-clients-list-iter-next Range : [0..2^32-1]
  • tag => string

    • Tag to be used in subsequent calls to nfs-stats-top-clients-list-iter-next

nfs_stats_zero_stats

[Family: ontap-classic, vfiler]

Set all NFS statistcs to zero

Inputs

  • None

Outputs

  • None

nfs_status

[Family: ontap-classic, vfiler]

Returns the status of the NFS server.

Inputs

  • None

Outputs

  • is-drained => boolean

    • If true, then the NFS server has been disabled and all NFS messages have been drained. In Data ONTAP Cluster-Mode, there is no way of finding out if the NFS messages have been drained. Hence this field will always be false.
  • is-enabled => boolean

    • True if NFS server is running.

options_get

[Family: ontap-classic, vfiler]

Get the value of a single option.

Inputs

  • name => string

    • Name of the option.

Outputs

  • cluster-constraint => string

    • Indicates the cluster-specific constraints of option.
    • "none" - no constraint.
    • "same_preferred" - same value should be used on both nodes of a HA pair.
    • "same_required" - same value must be used on both nodes of a HA pair.
    • "only_one" - value is used for both nodes of a HA pair, when in takeover mode.
    • "unknown" - value is not valid.
    In Data ONTAP Cluster-Mode, this field will always be "none".
  • value => string

    • Value of the option.

options_list_info

[Family: ontap-classic, vfiler]

Get a list of all options

Inputs

  • None

Outputs

options_set

[Family: ontap-classic, vfiler]

Set the value of a single option. For complete list of names and values of options, please refer to options man pages.

Inputs

  • name => string

    • Name of the option.
  • value => string

    • Value of the option.

Outputs

  • cluster-constraint => string

    • Cluster-specific constraint of the option.
    • "none" - no constraint.
    • "same_preferred" - same value should be used on both nodes of a HA pair.
    • "same_required" - same value must be used on both nodes of a HA pair.
    • "only_one" - value is used for both nodes of a HA pair, when in takeover mode.
    • "unknown" - value is not valid.
    In Data ONTAP Cluster-Mode, this field will always be "none".

perf_object_counter_list_info

[Family: ontap-classic]

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

perf_object_get_instances

[Family: ontap-classic]

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.

In Data ONTAP 7-Mode, 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

  • counters => counter[], optional

    • List of counters whose values will be retrieved. This element can be used to limit data collection to a specified subset of the counters of instances of the object. If this element is absent, values of all counters will be retrieved.
  • instances => instance[], optional

    • List of instance names for which to get counter values. This element can be used to limit data collection to a specified subset of the instances of the object.

    In Data ONTAP 7-Mode, counter values of all instances of the object will be retrieved when this element is absent.

    In Data ONTAP Cluster-Mode, either instances or instance-uuids input must be provided. The API errors out if both of these inputs are provided or neither of these inputs is provided, or if more than 500 instances are requested.

  • objectname => string

    • Name of the object to get counter values for.

Outputs

perf_object_get_instances_iter_end

[Family: ontap-classic]

Terminate a perf-object-get-instances iterator.

Inputs

  • tag => string

    • Tag from a pervious perf-object-get-instances-iter-start

Outputs

  • None

perf_object_get_instances_iter_next

[Family: ontap-classic]

Continue retrieving the values of counters of instances of an object. This call will return a partial list instance names, continued from the previous call with the same tag. When the 'records' output element is 0, all counter values of all instances have been retrieved and the perf-object-instance-list-info-iter-end API should be called.

Inputs

  • maximum => integer

    • Maximum number of entries to retrieve with this call.
    Range: [0..2^31-1]
  • tag => string

    • Tag from a previous perf-object-get-instances-iter-start

Outputs

  • instances => instance-data[]

    • Partial list of instances of the object. Each element of this list contains the counter values of a single instance of the object at the time perf-object-get-instances-iter-start was called.
  • records => integer

    • Number of records returned by this call to perf-object-instance-info-iter-next. A value of 0 indicates all counter values of all instances have been returned.
    Range: [0..2^31-1]

perf_object_get_instances_iter_start

[Family: ontap-classic]

Begin retrieving the counter values of instances of an object. This call should be followed with one or more calls to perf-object-get-instances-iter-next

Inputs

  • counters => counter[], optional

    • List of counters whose values will be retrieved. This element can be used to limit data collection to a specified subset of the counters of instances of the object. If this element is absent, values of all counters will be retrieved.
  • instances => instance[], optional

    • List of instances to get counter values for. This element can be used to limit data collection to a specified subset of the instances of the object. If this element is absent, counter values of all instances of the object will be retrieved.
  • objectname => string

    • Name of the object to get counter values for.

Outputs

  • records => integer

    • Number of items that have been saved for future retrieval with perf-object-instance-list-info-iter-next.
    Range: [0..2^31-1]
  • tag => string

    • Tag to be used in subsequent calls to perf-object-get-instances-iter-next
  • timestamp => string

    • Timestamp in seconds since January 1, 1970.

perf_object_instance_list_info

[Family: ontap-classic]

Get the list of names of current instances of an object. This will return the names of all current instances of the specified object with one call. If the object is expected to have a large number of instances, the iterator version of this API should be used.

Inputs

  • objectname => string

    • Name of the object to get instance information for.

Outputs

perf_object_instance_list_info_iter_end

[Family: ontap-classic]

Terminate a perf-object-instance-list-info iterator.

Inputs

  • tag => string

    • Tag from a previous perf-object-instance-list-info-iter-start

Outputs

  • None

perf_object_instance_list_info_iter_next

[Family: ontap-classic]

Continue retrieving the names of instances of an object. This call will return a partial list instance names, continued from the previous call with the same name. When the 'records' output element is 0, all instance names have been retrieved and the perf-object-instance-list-info-iter-end API should be called.

Inputs

  • maximum => integer

    • Maximum number of instance names to retrieve with this call.
    Range: [0..2^31-1]
  • tag => string

    • Tag from earlier call to perf-object-instance-list-info-iter-start

Outputs

  • instances => instance-info[]

    • Partial list of names of instances of the object at the time perf-object-instance-list-info-start was called.
  • records => integer

    • Number of records returned by this call to perf-object-instance-info-iter-next. A value of 0 indicates all instances have been returned.
    Range: [0..2^31-1]

perf_object_instance_list_info_iter_start

[Family: ontap-classic]

Begin retrieving the names of instances of an object. This call should be followed with one or more calls to perf-object-instance-list-info-iter-next

Inputs

  • objectname => string

    • Name of the object to get instance information for.

Outputs

  • records => integer

    • Number of items that have been saved for future retrieval with perf-object-instance-list-info-iter-next.
    Range: [0..2^31-1]
  • tag => string

    • Tag to be used in subsequent calls to perf-object-instance-list-info-iter-next

perf_object_list_info

[Family: ontap-classic]

Get list of performance objects in the system.

Inputs

  • None

Outputs

portset_add

[Family: ontap-classic]

Add a port to an existing port set

Inputs

  • portset-name => string

    • Name of port set.
  • portset-port-name => string

    • This is the name of the port that is to be added to the portset. In Data ONTAP 7-Mode, it can be input in two styles. The filername:slotletter format will add the port from a specific filer. For example: "buxton:4a" The slotletter format will add the port from both the local and partner filers. For example: "4a" In Data ONTAP Cluster-Mode, the port name is the name of either an FCP data lif or an iSCSI target portal group.

Outputs

  • None

portset_create

[Family: ontap-classic]

Create a port set

Inputs

  • portset-name => string

    • Name of the port set to create.
  • portset-type => string

    • Protocols accepted for this portset. Possible values: "fcp", "iscsi", "mixed". "iscsi" and "mixed" are available in Data ONTAP Cluster-Mode only.

Outputs

  • None

portset_destroy

[Family: ontap-classic]

Destroys an existing port set. By default a set cannot be destroyed if there are existing igroup associated with that portset.

Inputs

  • force => boolean, optional

    • If 'false' or not specified, the request will fail if there are any igroups bound to this portset. If 'true', forcibly destroy the portset, even if there are existing igroup bindings. Best practice is to unbind all the associated igroups before destroying the igroup.
  • portset-name => string

    • Name of the port set to destroy.

Outputs

  • None

portset_list_info

Get information for port set(s).

Inputs

  • portset-name => string, optional

    • Name of port set. If specified, only information for that set is returned. If not specified, information for all port sets are returned.

Outputs

portset_remove

[Family: ontap-classic]

Removes a port from a port set.

Inputs

  • portset-name => string

    • Name of the port set.
  • portset-port-name => string

    • This is the name of the port that is to be removed from the portset. In Data ONTAP 7-Mode, it can be input in two styles. The filername:slotletter format will remove the port from a specific filer. For example: "buxton:4a" The slotletter format will remove the port from both the local and partner filers. For example: "4a" In Data ONTAP Cluster-Mode, the port name is the name of either an FCP data lif or an iSCSI target portal group.

Outputs

  • None

priority_disable

[Family: ontap-classic]

Globally disable priority scheduling

Inputs

  • None

Outputs

  • None

priority_enable

[Family: ontap-classic]

Globally enable priority scheduling

Inputs

  • None

Outputs

  • None

priority_hybridcache_get

[Family: ontap-classic]

Sets caching policies for a volume

Inputs

  • volume => string

    • The volume for which the caching polcies are requested.

Outputs

  • read-cache => string

    • Current read caching policies on the volume. The possible values are -
    • "meta" - insert only volume metadata buffers into the SSD tier.
    • "random_read" - inserts randomly accessed buffers into the SSD SSD tier.
    • "random_read_write" - inserts buffers as defined by "random-read". In addition, buffers involved in random write operations are cached.
  • write-cache => string, optional

    • Current write caching policies on the volume. The possible values are -
    • "random_write" - randomly accessed buffers are write cached.
    • "none" - no buffers will be write cached.
    • "not_supported" - write caching cannot be configured on this volume.

priority_hybridcache_set

[Family: ontap-classic]

Sets caching policies for a volume

Inputs

  • read-cache => string, optional

    • Sets the volume policies for insertion into the SSD tier. The possible values are -
    • "meta" - insert only volume metadata buffers into the SSD tier.
    • "random_read" - inserts randomly accessed buffers into the SSD SSD tier.
    • "random_read_write" - inserts buffers as defined by "random-read". In addition, buffers involved in random write operations are cached.
    Note: either read-cache and/or write-cache must be provided as inputs
  • volume => string

    • The volume on which the hybrid caching policy is to be set.
  • write-cache => string, optional

    • Sets the volume policies for write caching into SSD tier. The possible values are -
    • "random_write" - randomly accessed buffers are write cached.
    • "none" - no buffers will be write cached.

Outputs

  • None

priority_list_info

[Family: ontap-classic]

Get status information for priority scheduler

Inputs

  • None

Outputs

  • nvlog-cp-completion => string

    • The method for consistency point (CP) completion when NVLOG limiting is being enforced, as described in priority-set.
  • status => string

    • Whether priority scheduling is enabled, possible values are 'on' or 'off'

priority_list_info_default

[Family: ontap-classic]

Get information for the default scheduling policy in the priority scheduler. The default scheduling policy is applied to volumes that do not have an explicit policy set.

Inputs

  • None

Outputs

  • nvlog-limit => integer

    • The limit on nvlog consumption during a consistency point. 0 means a system-created default is being applied.
  • system-read-limit => integer

    • The limit on system reads, as described in priority-set-default. A value of 0 means a system-created default is used.
  • user-read-limit => integer

    • The limit on user reads, as described in priority-set-default. A value of 0 means a system-created default is used.

priority_list_info_volume

[Family: ontap-classic]

Get volume-related priority schedule information.

Inputs

  • volume => string, optional

    • If specified, a specific volume whose priority schedule should be returned. If ommitted, all priority schedules for volumes are returned.

Outputs

priority_set

[Family: ontap-classic]

Sets priority options

Inputs

  • nvlog-cp-completion => string, optional

    • Sets the nvlog-cp-completion value for the appliance The nvlog-cp-completion defines the method of consistency point (CP) completion when one or more volumes are limited by NVLOG usage. Possible values are: "fast", "paced" or "default". A fast CP completion will finish the CP as soon as possible, so allowed resources blocked on NVLOG to be continue. A paced CP completion (the default when no NVLOG limiting occurs) controls the speed of the CP to reduce system impact overall, but may cause resources blocks on NVLOG to delay longer. The default mode is fast.
  • nvlog-cp-threshold => integer, optional

    • Sets the nvlog-cp-threshold value for the appliance as a percentage. The nvlog-cp-threshold defines the percentage of the system NVLOG that must be used before NVLOG limits are applied during a system consistency point (CP). The default value is 50%. Range: [1..100]

Outputs

  • None

priority_set_default

[Family: ontap-classic]

Sets priority options for default scheduling. Default scheduling is applied to all volumes that do not have a specific scheduling policy defined.

Inputs

  • level => integer, optional

    • Sets the priority schedule level for the volume. The possible values are 1 through 10, where 1 means lowest relative priority, and 10 means highest relative priority.
  • system => integer, optional

    • Sets the relative priority system/user scheduling for the volume. The possible value are 1 through 10, where 1 means heavily favor user operations and 10 means heavily favor system operations.

Outputs

  • None

priority_set_volume

[Family: ontap-classic]

Sets priority scheduling for a volume

Inputs

  • cache-policy => string, optional

    • The buffer cache policy to use for the volume. Possible values are: 'keep' - Try to keep data in the buffer cache. 'reuse' - Reuse blocks, do not try to cache. 'default' - Apply the default policy
  • level => integer, optional

    • Sets the priority schedule level for the volume. The possible values are 1 through 10, where 1 means lowest relative priority, and 10 means highest relative priority.
  • nvlog-limit => integer, optional

    • The maximum number percentage of system NVLOG resources that may be consumed. A value of 0 means restore the system-defined limit.
  • service => string, optional

    • Sets the priority service type for the volume. The possible values are 'on', 'off' or 'default'. 'off' temporarily disables specific priority scheduling for the volume, but preserves the priority schedule so that it can later be enabled. 'default' removes the specific priority scheduling for the volume, which will revert to using the default priority schedule.
  • system => integer, optional

    • Sets the relative priority system/user scheduling for the volume. The possible value are 1 through 10, where 1 means heavily favor user operations and 10 means heavily favor system operations.
  • system-read-limit => integer, optional

    • The maximum number of system read operations outstanding, before further operations are queued. A value of 0 means restore the system-defined limit.
  • user-read-limit => integer, optional

    • The maximum number of user read operations outstanding, before further operations are queued. A value of 0 means restore the system-defined limit.
  • volume => string

    • The volume whose priority scheduling is to be set.

Outputs

  • None

qtree_create

[Family: ontap-classic, vfiler]

Create a new qtree.

Inputs

  • mode => string, optional

    • The file permission bits of the qtree. Similar to UNIX permission bits: 0755 gives read/write/execute permissions to owner and read/execute 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 permissions 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.

    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.

  • volume => string

    • Name of the volume on which to create the qtree

Outputs

  • None

qtree_delete

[Family: ontap-classic, vfiler]

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

  • force => boolean, optional

    • Force the deletion of the qtree even if it not empty. On using "force" option, ZAPI may take a long time to complete because the contents of the entire qtree will have to be deleted before it returns. Default: false

    For clustered volumes, if the qtree has a large number of files, it is recommended that the qtree-delete-async API be used.

  • qtree => string

    • Path of an existing qtree. The path should be in this format: /vol/< volume name >/< qtree name >.

Outputs

  • None

qtree_list

[Family: ontap-classic, vfiler]

Return list of qtrees

Inputs

  • volume => string, optional

    • Name of the volume to be queried. Do not include a "/vol/" prefix.

Outputs

qtree_list_iter_end

[Family: ontap-classic, vfiler]

Terminate a list iteration and clean up any saved info.

Inputs

  • tag => string

    • Tag from a previous qtree-list-iter-start.

Outputs

  • None

qtree_list_iter_next

[Family: ontap-classic, vfiler]

Continues an iteration through the list of qtrees

Inputs

  • maximum => integer

    • The maximum number of qtrees to retrieve.
  • tag => string

    • Tag from a previous qtree-list-iter-start.

Outputs

  • qtrees => qtree-info[]

    • An array, one entry per qtree.
  • records => integer

    • This tells you how many records are being returned from this particular call to qtree-list-iter-next. When this value is 0, you have everything.

qtree_list_iter_start

[Family: ontap-classic, vfiler]

Starts an iteration through the list of qtrees.

Inputs

  • None

Outputs

  • records => integer

    • Number of items that have been saved for future retrieval with qtree-list-iter-next.
  • tag => string

    • Tag to be used in subsequent iterations.

qtree_rename

[Family: ontap-classic, vfiler]

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

  • new-qtree-name => string

    • Path of new qtree. The path should be in this format: /vol/< volume name >/< dst qtree name >.
  • qtree => string

    • Path of an existing qtree. The path should be in this format: /vol/< volume name >/< src qtree name >.

Outputs

  • None

quota_add_entry

[Family: ontap-classic, vfiler]

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

  • disk-limit => string, optional

    • This is the amount of disk space that is reserved for the the target. The value is expressed in kilobytes (1024). Set the value to "-" if the limit is to be unlimited. Default is unlimited.
  • file-limit => string, optional

    • This is the number of files that the target can have. Set the value to "-" if the limit is to be unlimited. Default is unlimited.
  • qtree => string

    • This is the qtree name that the quota resides on. For user or group rules, it can be the qtree name or "" if no qtree. For tree type rules, this field must be "".
  • quota-target => string

    • This is the quota target of the type specified. The target can be of the form: <name>, <number>, or <path name>. Multiple targets can be specified by a comma-separated list. Path should be entered in a format that starts with the following "/vol/< volume name >/". For explicit tree rules, the qtree should be specified as "/vol/< volume name >/ < qtree name >"
  • soft-disk-limit => string, optional

    • This is the amount of disk space the target would have to exceed before a message is logged and an SNMP trap is generated. The value is expressed in kilobytes (1024). Set the value to "-" if the limit is to be unlimited. Default is unlimited.
  • soft-file-limit => string, optional

    • This is the number of files the target would have to exceed before a message is logged and an SNMP trap is generated. Set the value to "-" if the limit is to be unlimited. Default is unlimited.
  • threshold => string, optional

    • This is the amount of disk space the target would have to exceed before a message is logged. The value is expressed in kilobytes (1024). Set the value to "-" if the limit is to be unlimited. Default is unlimited.
  • volume => string

    • This is the volume name that the quota resides on.

Outputs

  • None

quota_delete_entry

[Family: ontap-classic, vfiler]

Deletes a quota entry specified by type, target, volume, and tree.

Inputs

  • qtree => string

    • Name of the qtree for the quota. For user or group rules, it can be the qtree name or "" if no qtree. For tree type rules, this field must be "".
  • quota-target => string

    • The quota target of the type specified. Possible values are: <name>, <number>, or <path name>. Multiple targets can be specified by a comma-separated list. Path should be entered in a format that starts with the following "/vol/< volume name >/". For explicit tree rules, the qtree should be specified as "/vol/< volume name >/ < qtree name >"
  • quota-type => string

    • The type of quota rule. Possible values are "user", "group", or "tree".
  • volume => string

    • Name of the volume for the quota.

Outputs

  • None

quota_get_entry

[Family: ontap-classic, vfiler]

Obtains a quota entry specified by type, target, volume, and tree.

Inputs

  • qtree => string

    • Name of the qtree for the quota. For user or group rules, it can be the qtree name or "" if no qtree. For tree type rules, this field must be "".
  • quota-target => string

    • The quota target of the type specified. Possible values are: <name>, <number>, or <path name>. Multiple targets can be specified by a comma-separated list. Path should be entered in a format that starts with the following "/vol/< volume name >/". For explicit tree rules, the qtree should be specified as "/vol/< volume name >/ < qtree name >"
  • quota-type => string

    • The type of quota rule. Possible values are "user", "group", or "tree".
  • volume => string

    • Name of the volume for the quota.

Outputs

  • disk-limit => string

    • The amount of disk space that is reserved for the the target. The value is expressed in kilobytes (1024). The value is "-" if the limit is unlimited.
  • file-limit => string

    • The number of files that the target can have. The value is "-" if the limit is unlimited.
  • perform-user-mapping => boolean, optional

    • If the value is true, quota management will perform user mapping according to /etc/usermap.cfg for unclustered volumes. For clustered volumes, user mapping is performed according to the user mapping configured for the vserver to which the volume belongs.
  • quota-error => quota-error, optional

    • This value is only present if there is an error, and gives complete details on the error in a specific quota entry.
  • soft-disk-limit => string

    • The amount of disk space the target would have to exceed before a message is logged and an SNMP trap is generated. The value is expressed in kilobytes (1024). The value is "-" if the limit is unlimited.
  • soft-file-limit => string

    • The number of files the target would have to exceed before a message is logged and an SNMP trap is generated. The value is "-" if the limit is unlimited.
  • threshold => string

    • The amount of disk space the target would have to exceed before a message is logged. The value is expressed in kilobytes (1024). The value is "-" if the limit is unlimited.

quota_list_entries

[Family: ontap-classic, vfiler]

Returns quota entries from the /etc/quotas file.

Inputs

Outputs

quota_list_entries_iter_end

[Family: ontap-classic, vfiler]

Terminate a list iteration and clean up any saved info.

Inputs

  • tag => string

    • Tag from a previous quota-list-entries-iter-start.

Outputs

  • None

quota_list_entries_iter_next

[Family: ontap-classic, vfiler]

Continues an iteration through the list of quotas.

Inputs

  • maximum => integer

    • The maximum number of entries to retrieve.
  • tag => string

    • Tag from a previous quota-list-entries-iter-start.

Outputs

  • records => integer

    • This tells you how many records are being returned from this particular call to quota-list-entries-iter-next. When this value is 0, you have retrieved everything.

quota_list_entries_iter_start

[Family: ontap-classic, vfiler]

Starts an iteration through the list of quotas entries in /etc/quotas.

Inputs

  • include-output-entry => boolean, optional

    • If specified and true, the entire quota entry is placed in the ouput elements.

Outputs

  • records => integer

    • This tells you the number of items that have been saved for future retrieval with quota-list-entries-iter-next.
  • tag => string

    • Tag to be used in subsequent iterations.

quota_modify_entry

[Family: ontap-classic, vfiler]

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

  • disk-limit => string, optional

    • This is the amount of disk space that is reserved for the the target. The value is expressed in kilobytes (1024). Set the value to "-" if the limit is to be unlimited. Default is the current value.
  • file-limit => string, optional

    • This is the number of files that the target can have. Set the value to "-" if the limit is to be unlimited. Default is the current value.
  • qtree => string

    • This is the qtree name that the quota resides on. For user or group rules, it can be the qtree name or "" if no qtree. For tree type rules, this field must be "".
  • quota-target => string

    • This is the quota target of the type specified. The target can be of the form: <name>, <number>, or <path name>. Multiple targets can be specified by a comma-separated list. Path should be entered in a format that starts with the following "/vol/< volume name >/". For explicit tree rules, the qtree should be specified as "/vol/< volume name >/ < qtree name >"
  • quota-type => string

    • The type of quota rule. Possible values are "user", "group", or "tree".
  • soft-disk-limit => string, optional

    • This is the amount of disk space the target would have to exceed before a message is logged and an SNMP trap is generated. The value is expressed in kilobytes (1024). Set the value to "-" if the limit is to be unlimited. Default is the current value.
  • soft-file-limit => string, optional

    • This is the number of files the target would have to exceed before a message is logged and an SNMP trap is generated. Set the value to "-" if the limit is to be unlimited. Default is the current value.
  • threshold => string, optional

    • This is the amount of disk space the target would have to exceed before a message is logged. The value is expressed in kilobytes (1024). Set the value to "-" if the limit is to be unlimited. Default is the current value.
  • volume => string

    • This is the volume name that the quota resides on.

Outputs

  • None

quota_off

[Family: ontap-classic, vfiler]

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

  • volume => string

    • Name of the volume on which to turn quotas off.

Outputs

quota_on

[Family: ontap-classic, vfiler]

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

  • volume => string

    • Name of the volume on which to enable quotas.

Outputs

  • None

quota_report

[Family: ontap-classic, vfiler]

Returns a report on all quotas.

Inputs

  • path => string, optional

    • If specified, the report will contain only quotas that apply to the specified path name. The path should start with "/vol/", although paths without the "/vol" prefix will work and will be assumed to be in the root volume.
  • volume => string, optional

    • If provided, the report will contain only quotas on the specified volume name. The name should not contain a "/vol/" prefix.

Outputs

  • error => error, optional

    • If an error occurs in the midst of a report, this element is included in the output to indicate it (because it's too late at that point to include it in the main of the API. This structure includes the same information (status, reason, errno) that is normally included as attributes on the of the API itself. This error output element is also used to report the fact that quotas are off, if they are not currently turned on.

quota_report_iter_end

[Family: ontap-classic, vfiler]

Terminate a list iteration and clean up any saved info.

Inputs

  • tag => string

    • Tag from a previous quota-report-iter-start.

Outputs

  • None

quota_report_iter_next

[Family: ontap-classic, vfiler]

Returns items from a previous call to quota-report-iter-start

Inputs

  • maximum => integer

    • The maximum number of entries to retrieve.
  • tag => string

    • Tag from a previous quota-report-iter-start.

Outputs

  • records => integer

    • This tells you how many records are being returned from this particular call to quota-report-iter-next. When this value is 0, you have retrieved everything.

quota_report_iter_start

[Family: ontap-classic, vfiler]

Generates a report on quotas, the results of which are retrieved by using quota-report-iter-next.

Inputs

  • path => string, optional

    • A path (including a /vol/ prefix). If specified, the report will contain only quotas that apply to the specified path name.
  • volume => string, optional

    • Name of a volume. If specified, the report will contain only quotas on the specified volume.

Outputs

  • error => error, optional

    • If an error occurs in the midst of a report, this element is included to indicate it. It includes the same information that is normally included as attributes on the element.
  • records => integer

    • Number which tells you how many items have been saved for future retrieval with quota-report-iter-next.
  • tag => string

    • Tag to be used in subsequent calls to quota-report-iter-next.

quota_resize

[Family: ontap-classic, vfiler]

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

  • volume => string

    • Name of the volume on which to resize quotas.

Outputs

  • None

quota_set_entry

[Family: ontap-classic, vfiler]

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

  • disk-limit => string, optional

    • The amount of disk space that is reserved for the the target. The value is expressed in kilobytes (1024). Set the value to "-" if the limit is to be unlimited.
  • file-limit => string, optional

    • The number of files that the target can have. Set the value to "-" if the limit is to be unlimited.
  • qtree => string

    • Name of the qtree for the quota. For user or group rules, it can be the qtree name or "" if no qtree. For tree type rules, this field must be "".
  • quota-target => string

    • The quota target of the type specified. Possible values are <name>, <number>, or <path name>. Multiple targets can be specified by a comma-separated list. Path should be entered in a format that starts with the following "/vol/< volume name >/". For explicit tree rules, the qtree should be specified as "/vol/< volume name >/ < qtree name >"
  • quota-type => string

    • The type of quota rule. Possible values are "user", "group", or "tree".
  • soft-disk-limit => string, optional

    • The amount of disk space the target would have to exceed before a message is logged and an SNMP trap is generated. The value is expressed in kilobytes (1024). Set the value to "-" if the limit is to be unlimited.
  • soft-file-limit => string, optional

    • The number of files the target would have to exceed before a message is logged and an SNMP trap is generated. Set the value to "-" if the limit is to be unlimited.
  • threshold => string, optional

    • The amount of disk space the target would have to exceed before a message is logged. The value is expressed in kilobytes (1024). Set the value to "-" if the limit is to be unlimited.
  • volume => string

    • Name of the volume for the quota.

Outputs

  • None

quota_status

[Family: ontap-classic, vfiler]

Obtains the status of quotas

Inputs

  • volume => string

    • Name of the volume whose quota status should be obtained.

Outputs

  • quota-errors => string, optional

    • Collection of quota errors including the value of the reason tag above. Each error will be separated by a newline, '\n'. Since the quota parser does not stop when a parsing error occurs, this tag returns all the errors from the quota parser. If not present, there are no errors.
  • status => string

    • Primary status of quotas on the indicated volume; Possible values:
    • "corrupt"
    • "initializing"
    • "off"
    • "on"
    • "resizing"
    • "reverting"
    • "upgrading"
  • substatus => string

    • Minor quota status on the indicated volume. This status is only valid when primary status is "resizing" or "initializing". Possible values are:
    • "done"
    • "etc scanning"
    • "finishing"
    • "none"
    • "queue scan"
    • "scanning"
    • "setup"
    • "transferring rules"
    • "upgrading"

radius_reset_stats

[Family: ontap-classic, vfiler]

Zero radius client counters

Inputs

  • None

Outputs

  • None

radius_server_add

[Family: ontap-classic, vfiler]

Add a radius server to the radius client service

Inputs

  • port => integer, optional

    • The UDP port number of the radius server. The default port number is 1812 if not specified. Range: [1..2^16-1]
  • radius-ip-addr => string

    • The hostname or IP address (in dotted-decimal format) of the radius server to add. (for example, "192.168.11.12").

Outputs

  • None

radius_server_remove

[Family: ontap-classic, vfiler]

Remove a radius server from the radius client service

Inputs

  • port => integer, optional

    • The UDP port number of the radius server. The default port number is 1812 if not specified. Range: [1..2^16-1]
  • radius-ip-addr => string

    • The hostname or IP address (in dotted-decimal format) of the radius server to remove. (for example, "192.168.11.12").

Outputs

  • None

radius_service_start

[Family: ontap-classic, vfiler]

Start radius client service. Service will be avaliable once the call returns with success.

Inputs

  • None

Outputs

  • None

radius_service_status

[Family: ontap-classic, vfiler]

Get status of the radius client service, whether or not it is running.

Inputs

  • None

Outputs

  • is-available => boolean

    • "true" if radius client service is running, "false" otherwise.

radius_service_stop

[Family: ontap-classic, vfiler]

Stop radius client service. Service will no longer be available once the call returns with success.

Inputs

  • None

Outputs

  • None

radius_show_info

[Family: ontap-classic, vfiler]

Get the information about the radius client service.

Inputs

  • None

Outputs

  • is-available => boolean

    • "true" if radius client service is running, "false" otherwise.

radius_stats_list_info

[Family: ontap-classic, vfiler]

Return radius client statistics

Inputs

  • None

Outputs

reallocate_delete_schedule

[Family: ontap-classic]

Delete a schedule for a reallocation job

Inputs

  • path => string

    • Path to large file or LUN whose reallocation schedule should be deleted. The path must start with /vol/

Outputs

  • None

reallocate_list_info

[Family: ontap-classic]

Get status for WAFL reallocation jobs

Inputs

  • path => string, optional

    • Name of a path to get status on. If specified only status for that path is returned. If not specified, information for all reallocation jobs is returned. The path must start with /vol/.
  • verbose => boolean, optional

    • If true, verbose output is returned. Otherwise default output is returned.

Outputs

  • global-status => string

    • The system-wide status of the reallocation system on the filer. The status is of the format: "Reallocation scans are on" or "Reallocation scans are off".

reallocate_measure

[Family: ontap-classic]

Starts a new measurement-only reallocate job.

Inputs

  • interval => string, optional

    • The interval between repeated scans. The format is numX, where X is m, h or d, indicating minutes, hours or days.
  • measure-logfile => string, optional

    • Path to a full name on the appliance where information about the most recent measurement made will be logged, e.g. "/vol/logvol/measurelog.txt"
  • path => string

    • Path to large file, LUN or volume to measure optimization on, starting with /vol/.
  • threshold => integer, optional

    • The allocation threshold before path is regarded as needing optimization. A larger value indicates the file or LUN can be more fragmented. Range: [3..10]

Outputs

  • None

reallocate_off

[Family: ontap-classic]

Globally disables WAFL reallocation jobs

Inputs

  • None

Outputs

  • detail-status => string

    • Detailed result status. If reallocation scans are already off the detailed status is "Reallocation scans are off". If reallocation scans will be disabled the detailed status is "Reallocation scans will be disabled."

reallocate_on

[Family: ontap-classic]

Globally enables WAFL reallocation jobs

Inputs

  • None

Outputs

  • detail-status => string

    • Detailed result status. If reallocation scans are already on the detailed status is "Reallocation scans are on". If reallocation scans will be enabled the detailed status is "Reallocation scans will be enabled."

reallocate_quiesce

[Family: ontap-classic]

Quiesce a reallocation job. When a reallocation job is quiesced it will not be run until restarted, however information about the job is preserved.

Inputs

  • path => string

    • Path to large file or LUN to quiesce, starting with /vol/

Outputs

  • None

reallocate_restart

[Family: ontap-classic]

Restart a reallocation job that is quiesced or idle.

Inputs

  • ignore-checkpoint => boolean, optional

    • Some long-running reallocate functions will checkpoint their progress so that if they are stopped (e.g., via quiesce or a reboot), they will continue from their previous position. This option, if true, ignores the checkpoint and restarts at the beginning.
  • path => string

    • Path to large file or LUN to restart reallocation on, starting with /vol/

Outputs

  • None

reallocate_set_schedule

[Family: ontap-classic]

Set a schedule for a reallocation job.

Inputs

  • path => string

    • Path to large file or LUN to reallocate, starting with /vol/
  • schedule => string

    • Reallocation schedule, in format " ", where each field is either a number, a comma-separated range of numbers, or "*", indicating all values.

Outputs

  • None

reallocate_start

[Family: ontap-classic]

Starts a new reallocation job

Inputs

  • full => boolean, optional

    • If true, perform a once-only full reallocate of the indicated file, LUN or volume (specified as /vol/VOLNAME). This option implies run-once and no-check are true.
  • interval => string, optional

    • The interval between repeated scans. The format is numX, where X is m, h or d, indicating minutes, hours or days.
  • path => string

    • Path to large file or LUN to reallocate, starting with /vol/. If the full option is true then an entire volume may also be specified, as /vol/VOLNAME. If an aggregate, just the aggregate name must be specified.
  • preserve-logical-bno => boolean, optional

    • If true, reallocate the physical block location in the aggregate, but do not change the logical block number in the flexible volume. This option may only be selected for flexible volumes or files/LUNs within flexible volumes.
  • run-once => boolean, optional

    • If true, run the scan once then exit.
  • threshold => integer, optional

    • The allocation threshold before reallocation occurs. A larger value indicates the file or LUN can be more fragmented. Range: [3..10]
  • unshare => boolean, optional

    • If true, specifies that blocks that are shared by deduplication will be unshared. This may result in increased disk usage, especially for full reallocation.

Outputs

  • None

reallocate_stop

[Family: ontap-classic]

Stops a reallocation job.

Inputs

  • path => string

    • Path to large file or LUN to stop reallocation on. The path must start with /vol/

Outputs

  • None

rsh_get_stats

[Family: ontap-classic]

Obtain rsh statistics.

Inputs

  • None

Outputs

rsh_kill

[Family: ontap-classic]

Kill a rsh session.

Inputs

  • session-number => integer

    • rsh session to be killed. This can be obtained from session-id in rsh-session-info by running the 'rsh-get-stats' API. Range : [0..191]

Outputs

  • None

storage_shelf_bay_list_info

[Family: ontap-classic]

Returns information about storage shelf bays and ports for a selected number of shelves, or optionally all shelves connected to the storage controller.

Inputs

  • channel-name => string, optional

    • The adapter number or switch name and the port number (together, called the channel). If missing, then information for all shelves on all channels will be presented. If missing, then shelf-id input is not allowed. Examples: 8a, switch:5
  • shelf-id => integer, optional

    • shelf-id is the shelf number for which shelf data is requested. This input requires that channel-name input also be specified. If a channel-name and shelf-id are both specified then information for the specified shelf will be presented (a single shelf). If channel-name is specified, but shelf-id is missing, then information for all shelves on the channel will be presented. If channel-name is not specified then shelf-id is not supported and an error will be returned.

Outputs

storage_shelf_environment_list_info

[Family: ontap-classic]

Returns the environmental information for a selected number of shelves, or optionally all shelves connected to the storage controller.

Inputs

  • channel-name => string, optional

    • Get environment information for shelves on this channel. shelf-id parameter can be specified to request data on a single shelf. If a channel-name is not specified, then data on all shelves on all channels will be returned. If an invalid channel-name is specified, then error code ECHANNELNOTFOUND will be returned.
  • shelf-id => integer, optional

    • Get environment information for the specified shelf-id on the specified channel-name. This parameter requires channel-name parameter as well. If shelf-id is specified without channel-name then the error code EINVALIDINPUTERROR will be returned. If shelf-id is not specified and a channel-name is specified, then data for all shelves on the channel-name is returned. If an invalid shelf-id is specified, then error code ESHELFNOTFOUND will be returned.

Outputs

storage_shelf_get_shelf_info

[Family: ontap-classic]

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

  • channel-name => string

    • The adapter number or switch name and theport number (together, called the channel). Examples are 8a and switch:5
  • shelf-id => integer

    • The shelf id specifies the shelf for which a list of disk bays is desired. Range : [0..2^24-1]

Outputs

  • bay-count => integer

    • Disk bays are the slots into which disks are placed. The bays are numbered from 0 to bay-count-1. Bay 0 is the right most bay (when looking at the front of the shelf) and bay bay-count-1 is left most. These bay numbers can be used by other commands, including storage-shelf-set-led-state. Range : [0..255]
  • bay-list => bay-info[]

    • A list of shelf-bay numbers which have disk drives. The bay-list field is not optional, but it may contain zero bay-info elements.
  • firmware-revision => string

    • Shelf firmware revision.

storage_shelf_list_info

[Family: ontap-classic]

This interface returns information about one or more shelves.

Inputs

  • channel-name => string, optional

    • The adapter number or switch name and the port number (together, called the channel). If missing, then information for all shelves on all channels will be presented. If missing, then shelf-id input is not allowed. Examples are 8a and switch:5
  • shelf-id => integer, optional

    • shelf-id is the shelf number for which shelf data is requested. This input requires that channel-name input also be specified. If a channel-name and shelf-id are both specified then information for the specified shelf will be presented (a single shelf). If channel-name is specified, but shelf-id is missing, then information for all shelves on the channel will be presented. If channel-name is not specified then shelf-id is not supported. In such case information for all shelves on all channels will be presented.

Outputs

  • shelf-list => shelf-info[]

    • Each instance of shelf-list contains all available information on a shelf hub. This can be empty if there are no shelves attached or if shelves do not support hubs. Also a partner shelf can be reported.

storage_shelf_set_led_state

[Family: ontap-classic]

Set or clear the LED for a disk, shelf of disks or loop of shelves. LEDs to affect can be specified as: {channel-name}, {channel-name, shelf-id}, {channel-name, shelf-id, shelf-bay}, {channel-name, shelf-id, shelf-bay}, {channel-name, shelf-id, shelf-bay, lun}.

Inputs

  • action => string

    • This specifies the action to apply. Possible values are: on, and off. on: Turn the LED(s) on indefinitely. off: Turn the LED(s) off.
  • channel-name => string

    • The channel to which the shelf or drive LED to be affected is connected. A channel-name is the adapter number or switch name and the port number (together, called the channel). Examples are 8a and switch:5.
  • duration => integer, optional

    • This parameter allows the caller to specify the duration (in seconds) that the action will be applied. Note that the action 'on' is indefinite, while 'test' uses duration. 'blink' also uses duration.
  • identify => boolean, optional

    • This parameter allows the caller to specify the identify LED. The default is for the command to affect the fault LED. Not all disks have identify LEDs. In that case, the identify option is ignored and the fault LED is affected.
  • lun => integer, optional

    • Some targets have a logical unit number. In that case, the lun will be required to uniquely specify the LED to affect. Range : [0..255]
  • shelf-bay => integer, optional

    • If present, the shelf-bay indicates the specific drive where the LED affected resides. If shelf-id is supplied but shelf-bay is not, then the LEDs for all drives in the shelf will be affected. Range : [0..255]
  • shelf-id => integer

    • If present, the shelf-id indicates which shelf has the drive or drives where the LEDs to affect reside. Range : [0..2^24-1]

Outputs

  • None

storage_shelf_update_fw

[Family: ontap-classic]

Start shelf firmware download process to update firmware on disk shelves. This operation is asynchronous, and therefore returns no errors that might occur during the download process. This operation will only update firmware on shelves that do not have the latest firmware revision. The firmware revision on the shelves can be monitored via the storage-shelf-get-shelf-info API. NOT IMPLEMENTED YET.

Inputs

  • channel-name => string, optional

    • If present, will only update firmware on all shelves (or a single shlef depending on shelf-id) on the given channel. If not present, then all shelves on all channels are updated. Example: To update firmware on 2a.shelf1, channel should be 2a and shelf should be 1.
  • shelf-id => string, optional

    • If present, will only update firmware on the given shelf on specified channel. If not present, and a channel-name is specified, then all shelves on the channel will be updated. Example: To update firmware on 2a.shelf1, channel should be 2a and shelf should be 1.

Outputs

  • None

sis_disable

[Family: ontap-classic, vfiler]

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

  • path => string

    • The full path of the sis volume, /vol/<vol_name>. Only one path can be specified at a time.

Outputs

  • None

sis_enable

[Family: ontap-classic, vfiler]

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

  • path => string

    • The full path of the sis volume, /vol/<vol_name>. Only one path can be specified at a time. The volume must be online to enable sis on the volume.

Outputs

  • None

sis_set_config

[Family: ontap-classic, vfiler]

Setup or modify sis policy, schedule or options for a volume.

This API is not supported for Infinite Volumes.

Inputs

  • enable-compression => boolean, optional

    • Enable compression on the sis volume. If true, compression will be enabled on the sis volume. If false, compression will be disabled on the volume. If the value is not specified compression state will be unchanged.

    Enabling compression on a secondary volume is strongly discouraged. If compression is enabled on a secondary volume, storage efficiency present on the source will not be preserved during replication. The destination system needs to run offline storage efficiency scanner (compression and dedupe) to achieve storage savings. Additional compression savings on the destination comes at a cost of extra computation resources. In environments where there is a lot of shared data present on the source, (e.g., virtualized environments employing file clones), data inflation during transfer may lead to failed backups due to lack of space on the secondary volume.

  • enable-idd => boolean, optional

    • This enables file level incompressible data detection and quick check incompressible data detection for large files. This is per volume option. Once this set to true, inline compression will do a 4k compression quick check for large files before proceeding with full CG compression. If quick check finds a 4k within a CG as incompressible, inline compression won't attempt to compress the CG. And the blocks are written in uncompressed form to disk. Also once this is enabled, if inline compression encounters a incompressible CG within small files, it will mark the file with do not compress flag. As long as this flag is set on a small file, inline compression won't attempt further compression on the file. Default value is 'false'.
  • enable-inline-compression => boolean, optional

    • Enable inline compression on the sis volume. To enable inline compression, compression must be enabled either in this API call or by a previous call to sis-set-config. If true, inline-compression will be enabled on the sis volume. If false, inline-compression will be disabled on the volume. If the value is not specified, inline-compression state will be unchanged.
  • path => string

    • The full path of the sis volume, /vol/<vol_name>.
  • quick-check-fsize => integer, optional

    • Quick check file size for Incompressible Data Detection. If Incompressible data detection is enabled and if the file size is >= quick-check-fsize, inline compression will do a 4k quick check before doing full CG compression.
  • schedule => string, optional

    • The schedule string for the sis operation.

    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

  • None

sis_start

[Family: ontap-classic, vfiler]

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

  • build-metadata => boolean, optional

    • If this argument is "true", scanner will scan the entire volume and generate fingerprint database without attempting the sharing. This argument is valid only if scan argument is set to "true". Look at the documentation for scan parameter for more details. Default value: "false"
  • path => string

    • The full path of the sis volume, /vol/<vol_name>. The volume must be online in order to start the sis operation.
  • qos-policy => string, optional

    • QoS policy for the sis operation. Possible values are:
    • "background" - sis operation will run in background with minimal or no impact on data serving client operations,
    • "best-effort" - sis operations may have some impact on data serving client operations.
    Default value: "best-effort"
  • queue-operation => boolean, optional

    • If this is "true", the requested sis operation will be queued if a sis operation is already running on the volume, and the running operation is in the fingerprint verification phase. Default value: "false"
  • restart-checkpoint => boolean, optional

    • If this is "true", the sis operation will restart from previous checkpoint without checking for validity. This option should be used along with "scan" option. Default value: "false"
  • scan => boolean, optional

    • If this is "true", the sis operation will scan the file system to process all the existing data.

    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"

  • scan-all => boolean, optional

    • If this argument is "true", scanner will scan entire volume without applying shared block optimization. This argument is valid only if scan argument is set to "true". Look at the documentation for scan parameter for more details. Default value: "false"

Outputs

  • None

sis_status

[Family: ontap-classic, vfiler]

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

  • path => string, optional

    • The full path of the sis volume, /vol/<vol_name>. Only one path can be specified at a time. The volume must be online if not then an error will be returned. If path variable is not used then the status for all online sis volumes in the filer will be returned.
  • verbose => boolean, optional

    • If set to true the output is detailed. Default value: "false"

Outputs

sis_stop

[Family: ontap-classic, vfiler]

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

  • path => string

    • The full path of the sis volume, /vol/<vol_name>.

Outputs

  • None

file_get_snaplock_retention_time

[Family: ontap-classic, vfiler]

Get the SnapLock retention attributes of a file.

Inputs

  • path => string

    • Absolute path of the file to query. The value must be prefixed with "/vol/".

Outputs

  • retention-time => integer

    • Retention time in seconds since 01/01/1970 00:00:00. A zero value indicates that the file is not in WORM state. Range: [0..2^64-1]

file_get_snaplock_retention_time_list_info_max

[Family: ontap-classic, vfiler]

Get the maximum number of entries that can be processed and returned in one call to the zapi file-snaplock-retention-time-list-info.

Inputs

  • None

Outputs

  • max-list-entries => integer

    • The maximum number of pathnames that can be processed in one call to file-snaplock-retention-time-list-info. This limit is imposed to prevent taking up too much CPU/memory for a ZAPI call. If the number of input pathnames for file-snaplock-retention-time-list-info is more than this number, it returns the error EAPITOOMANYENTRIES. Range: [0..2^64-1]

file_set_snaplock_retention_time

[Family: ontap-classic, vfiler]

Set the SnapLock retention attributes of a file. In some cases, even if the call to file-set-snaplock-retention-time fails (that is the file could not be committed to worm successfully), it is possible that the atime of the file would be modified. One can specify either only retention-time or only set-infinite-retention for a given file path while calling this api. If neither the retention-time nor set-infinite-retention is specified, the file is committed to worm as read-only. If the expiry time of the file has been set explicitly, the expiry time is the atime of the file, otherwise the expiry time is calculated using the default retention of the volume as follows: Expiry time = current time + snaplock_default_period

Inputs

  • path => string

    • Absolute path of the file. The value must be prefixed with "/vol/<volume-name>".
  • retention-time => integer, optional

    • Expiry time in seconds since 01-Jan-1970 00:00:00 at which time the file will be eligible for deletion. If the expiry time specified does not comply with the snaplock_minimum_period and snaplock_maximum_period of the volume, the expiry time will be increased or decreased to do so.
  • set-infinite-retention => boolean, optional

    • Indicates if the retention period on the file needs to be set or extended to the infinite retention period. This field is available in Data ONTAP 8.1 and later. Default is false.

Outputs

  • None

file_snaplock_retention_time_list_info

[Family: ontap-classic, vfiler]

Get the Snaplock retention attributes for a list of files.

Inputs

  • pathnames => pathname-info[]

    • List of pathnames to query. The function returns the file-retention-information for each of these pathnames. If this ZAPI function is called without any input parameter, the error EAPIMISSINGARGUMENT is returned If number of input pathnames exceeds max-list-entries an error of EAPITOOMANYENTRIES is returned. The value of max-list-entries can be retrieved using the zapi call file-get-snaplock-retention-time-list-info-max.

Outputs

snaplock_get_compliance_clock

[Family: ontap-classic]

Older API to get the system complaince Clock time. Now depricated. Use snaplock-get-system-compliance-clock and snaplock-get-volume-compliance-clock.

Inputs

  • None

Outputs

  • None

snaplock_get_log_volume

Get the active WORM log volume configuration

Inputs

  • None

Outputs

  • log-volume => string, optional

    • When asking for the WORM log volume, the string value of the configured log-volume is returned. If the value is not set, a string is returned saying that no log volume is configured.

snaplock_get_options

gets the value of given snaplock option on a volume

Inputs

  • option => string

    • Specifies snaplock option. Presently, only the "privdel" snaplock option is supported. This option specifies the privileged delete capability state of the volume. For unsupported options, this zapi returns EONTAPI_EINVAL.
  • volume => string

    • Specifies the volume

Outputs

  • option-value => string

    • Value of the option parameter.

snaplock_get_system_compliance_clock

[Family: ontap-classic, vfiler]

Get the SnapLock System Compliance Clock date and time.

Inputs

  • None

Outputs

snaplock_get_volume_compliance_clock

[Family: ontap-classic, vfiler]

Get the SnapLock Volume Compliance Clock date and time.

Inputs

  • volume => string

    • Name of the volume whose ComplianceClock needs to be obtained.

Outputs

snaplock_log_archive

Archive the active worm log file. This will close the current log file for furthur updates and it will open a new log file to write future log updates.

Inputs

  • log-basename => string, optional

    • The basename of the worm log file to be archived. The logfile is of the format basename.-present. The date is in the format YYYYMMDD_HHMMSS_ZZZ If the log-basename is not specified, all the active WORM log files in the log-volume are archived. If the old log file was basename.-present, once the archive command is run, the file will be renamed to basename.- and closed. A new log file of the name basename.-present will be opened for future log updates. e.g. - The system log file was created on Jan 1st, 2007. The file would have the name system_log.20070101_000000_GMT-present. If this zapi is run on the file on Jun 1st, 2007 at 5 pm, the file would get renamed to system_log.20070101_000000_GMT-20070601_170000_GMT and will be closed to future updates. A new log file system_log.20070601_170000_GMT-present will be opened to capture future log updates.
  • log-volume => string, optional

    • The name of the volume that contains the WORM log files. This volume must be a SnapLock Compliance volume. If the log-volume is not specified, the log-volume is considered to be the volume configured by the snaplock zapi or command.

Outputs

  • None

snaplock_log_status_list_info

Status of the active worm log file/s

Inputs

  • log-basename => string, optional

    • The basename of the worm log file whos status is required. The logfile is of the format basename.-present If the log-basename is not specified, the status of all the active WORM log files in this volume are returned
  • log-volume => string, optional

    • The name of the volume that contains the WORM log files. This volume must be a SnapLock Compliance volume. If the log-volume is not specified, the log-volume is considered to be the volume configured by the snaplock zapi or command.

Outputs

  • log-volume => string

    • The name of the log volume. If log-volume is specified in the input, this value should be the same. If it isn't specified, this should be the same as the name configured by the snaplock zapi or command. The log-volume is a SnapLock compliance volume.

snaplock_privileged_delete_file

Executes a privileged delete on a SnapLock file

Inputs

  • do-it => boolean, optional

    • If set to true, it will enable privileged delete of the file specified by the path argument. If set to false, This zapi will not delete the file, instead it will return error EAPIERROR with message that user is trying to delete a file that is retained by Snaplock. Default value of this argument is 'false'.
  • path => string

    • Absolute path of the file to delete The value must be prefixed with "/vol/".

Outputs

  • None

snaplock_set_log_volume

Set the active WORM log volume configuration

Inputs

  • is-force => boolean, optional

    • If true it will enable the set log volume operation to ignore errors encountered during SnapLock log volume change. Useful when the log volume is inconsistent or have not enough disk space Default is false.
  • log-volume => string

    • The name of the volume that will contain the WORM log files. This volume must be a SnapLock Compliance volume. if log-volume is NULL, ENOENT is returned with a string saying no volume was specified. If the set fails, EONTAPI_EIO is returned with a string indicating the reason.

Outputs

  • None

snaplock_set_options

sets snaplock options on a volume

Inputs

  • do-it => boolean, optional

    • If set to true, it will allow setting of privileged delete snaplock option to "disallowed" state. if set to false it will not allow setting of privileged delete option to "disallowed" state. However setting of privileged delete option to "on" or "off" state can be done regardless of the value of this parameter. Default value of this parameter is false.
  • option => string

    • Specifies snaplock option. Presently, only the "privdel" snaplock option is supported. This option specifies the privileged delete capability state of the volume. For unsupported options, this zapi returns EONTAPI_EINVAL.
  • option-value => string

    • Specifies the new value of the option. Presently for the "privdel" snaplock option, three values "on"/"off"/"disallowed" are supported. To set new value to "disallowed" requires "do-it" parameter to be set to "true". For unsupported option-value string, this zapi returns EONTAPI_EINVAL.
  • volume => string

    • Specifies the volume

Outputs

  • None

snaplock_set_system_compliance_clock

[Family: ontap-classic]

Set the Compliance Clock of the system equal to the current system clock.

Inputs

  • None

Outputs

  • None

snapmirror_abort

[Family: ontap-classic, vfiler]

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 operating in 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 storage system on Data ONTAP operating in 7-Mode, from the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, from the destination Vserver or cluster on Data ONTAP 8.2 or later operating in Cluster-Mode.

This API is not supported if the destination end point is an Infinite Volume.

Inputs

  • destination-location => string, optional

    • Specifies the destination endpoint of the SnapMirror relationship in the following formats:
    • <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode.
    • [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode.
    • <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers.
    This format may change in the future. On Data ONTAP operating in Cluster-Mode, when specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume. This parameter is mandatory on Data ONTAP operating in 7-mode.

Outputs

  • None

snapmirror_break

[Family: ontap-classic, vfiler]

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 operating in 7-Mode, no check is done to determine whether the operation is legal or successful. 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 operating in 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 storage system on Data ONTAP operating in 7-Mode, and on the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, and on the destination cluster or Vserver on Data ONTAP 8.2 or later operating in Cluster-Mode.

This API is not supported if the destination end point is an Infinite Volume.

Inputs

  • destination-location => string, optional

    • Specifies the destination endpoint of the SnapMirror relationship in the following formats:
    • <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode.
    • [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode.
    • <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers.
    This format may change in the future. On Data ONTAP operating in Cluster-Mode, when specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume. On Data ONTAP operating in 7-Mode, If the destination endpoint is a qtree, it must be quiesced using snapmirror-quiesce. This parameter is mandatory on Data ONTAP 7-mode

Outputs

  • None

snapmirror_delete_connection

[Family: ontap-classic, vfiler]

Deletes a connection specified by connection. This API must be executed on the destination filer. Currently, the connections are in: /etc/snapmirror.conf.

Inputs

  • connection => string

    • Connection name to delete. The name is in ASCII and must begin with an alpha character.

Outputs

  • None

snapmirror_delete_schedule

[Family: ontap-classic, vfiler]

Delete the schedule for a given destination. This API must be executed on the destination filer.

Inputs

  • destination-location => string

    • The destination location of a schedule to delete. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.

Outputs

  • None

snapmirror_delete_sync_schedule

[Family: ontap-classic, vfiler]

Delete a synchronous schedule for a given destination. This API must be executed on the destination filer.

Inputs

  • destination-location => string

    • The destination location of a schedule to delete. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.

Outputs

  • None

snapmirror_get_status

[Family: ontap-classic, vfiler]

Return the SnapMirror status. This API can be issued on either the source or destination filer.

Inputs

  • location => string, optional

    • The source location or destination location of the SnapMirror pair. Possible types are volume or qtree only. If this input is provided, only the SnapMirror relationships with a matching source or destination will be reported. The argument is invalid if the named location doesn't exist. In this case, snapmirror-status-info output will not be present. The argument can also be invalid if it is a flexclone name. (Be aware that the snapmirror-list-destinations API can return flexclone names.) Then snapmirror-get-status API will return a snapmirror-status output value with a "state" of "unknown". If the argument is not specified, all source, destination SnapMirror pairs are returned.

Outputs

  • is-available => boolean

    • True if SnapMirror is available.
  • snapmirror-status => snapmirror-status-info[], optional

    • An array of SnapMirror pair status. If there are no transfers or schedules, then snapmirror-status is not returned. Any and all pairs whose source or destination location matches the input location will be in the output.

snapmirror_get_volume_status

[Family: ontap-classic, vfiler]

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 8.1 operating in Cluster-Mode, this API is provided for backward compatibility only. It will fail if the volume is the source or destination of a load-sharing SnapMirror relationship. It is recommended to use the snapmirror-get-iter API to get the same information. On Data ONTAP 8.1 operating in Cluster-Mode, this API must be issued on the cluster the volume belongs to. This API is not supported On Data ONTAP 8.2 or later operating in Cluster-Mode. You must use the snapmirror-get-iter and snapmirror-get-destination-iter APIs. If issued on Data ONTAP 8.2 or later operating in Cluster-Mode, this API will return EOPNOTSUPPORTED error.

Inputs

  • volume => string

    • Name of the volume to be queried. On Data ONTAP operating in Cluster-Mode, specifies the location of the volume the following formats: [<cluster>:][//<vserver>/]<volume>

Outputs

  • is-transfer-broken => boolean, optional

    • true if it was determined that the volume is a destination of a SnapMirror relationship that was broken off. The volume allows reads and writes. false otherwise

snapmirror_initialize

[Family: ontap-classic, vfiler]

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 storage system on Data ONTAP operating in 7-Mode, from the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, and from the destination Vserver on Data ONTAP 8.2 or later operating in Cluster-Mode.

On Data ONTAP operating in 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 operating in 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.

On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating Cluster-Mode (The relationship-control-plane field is set to 'v1'), 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.

On Data ONTAP 8.2 or later operating in Cluster-Mode, for vault relationships, a 32-bit volume cannot be the source or destination of the relationship.

On Data ONTAP 8.2 or later operating in Cluster-Mode, you can track the progress of the operation using the snapmirror-get API, except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode.

Inputs

  • destination-location => string, optional

    • Specifies the destination endpoint of the SnapMirror relationship in the following formats:
    • <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode.
    • [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode.
    • <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers.
    This format may change in the future. On Data ONTAP operating in Cluster-Mode, when specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume. On Data ONTAP operating in 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.

    This parameter is mandatory on Data ONTAP operating in 7-mode.

  • max-transfer-rate => integer, optional

    • Specifies the upper bound, in kilobytes per second, at which data is transferred. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. On Data ONTAP operating in Cluster-Mode, the max-transfer-rate option does not affect load-sharing transfers and transfers for other relationships with Relationship Capability of Pre 8.2 confined to a single cluster.
  • source-location => string, optional

    • Specifies the source endpoint of the SnapMirror relationship in the following formats:
    • <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode.
    • [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode.
    • <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers.
    This format may change in the future. On Data ONTAP operating in Cluster-Mode when specifying a source endpoint, you must use either the source location, or the source cluster, source Vserver, and source volume. On Data ONTAP operating in 7-Mode, If the source-location is not specified, then the source in /etc/snapmirror.conf for the destination path is used.
  • source-snapshot => string, optional

    • Designates the source snapshot to use for a qtree update on Data ONTAP operating in 7-mode, and the snapshot on the source volume to use for the baseline transfer on Data ONTAP 8.2 or later operating in Cluster-Mode. The default creates new snapshot on the source for the transfer.

    This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'.

Outputs

  • None

snapmirror_list_connections

[Family: ontap-classic, vfiler]

Returns connection information for a given connection or all connections. The API must be executed on the destination filer. Currently, the connections are in: /etc/snapmirror.conf.

Inputs

  • connection => string, optional

    • Connection name of the connection information to obtain. If the connections is not specified, then the connection information for all the connections is returned.

Outputs

snapmirror_list_destinations

[Family: ontap-classic, vfiler]

Returns a list of destination locations and information about SnapMirror relationships for given source locations, which can be a volume name or qtree path. This API must be issued on the source filer.

Inputs

  • source-location => string, optional

    • Source location of the SnapMirror pair. The source location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>. If the source-location is not specified, then all source, destination SnapMirror pairs are returned.

Outputs

snapmirror_list_schedule

[Family: ontap-classic, vfiler]

Returns the schedule for a given destination or all destinations. The API must be executed on the destination filer. Currently, the schedules is in /etc/snapmirror.conf.

Inputs

  • destination-location => string, optional

    • The destination location of a schedule to obtain. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>. The <filer> must match the destination filer. If the destination-location is not specified, then all the destination schedules are returned.

Outputs

snapmirror_list_sync_schedule

[Family: ontap-classic, vfiler]

Returns a synchronous schedule for a given destination or all destinations. The API must be executed on the destination filer. Currently, the schedules is in /etc/snapmirror.conf.

Inputs

  • destination-location => string, optional

    • The destination location of a schedule to obtain. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>. The <filer> must match the destination filer. If the destination-location is not specified, then all the destination schedules are returned.

Outputs

snapmirror_off

[Family: ontap-classic, vfiler]

Disables SnapMirror data transfers and turns off the SnapMirror scheduler. Check the SnapMirror status with the snapmirror-get-status API for results.

Inputs

  • None

Outputs

  • None

snapmirror_on

[Family: ontap-classic, vfiler]

Enables SnapMirror data transfers and turns on the SnapMirror scheduler. Check the SnapMirror status with the snapmirror-get-status API for results.

Inputs

  • None

Outputs

  • None

snapmirror_quiesce

[Family: ontap-classic, vfiler]

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 8.1 operating in 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 from the destination storage system on Data ONTAP operating in 7-Mode, on the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, and the destination Vserver on Data ONTAP 8.2 or later operating in Cluster-Mode.

Inputs

  • destination-location => string, optional

    • Specifies the destination endpoint of the SnapMirror relationship in the following formats:
    • <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode.
    • [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode.
    • <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers.
    This format may change in the future. On Data ONTAP operating in Cluster-Mode, when specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume. This parameter is mandatory on Data ONTAP 7-mode

Outputs

  • None

snapmirror_release

[Family: ontap-classic, vfiler]

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

  • destination-location => string, optional

    • Specifies the destination endpoint of the SnapMirror relationship in the following formats:
    • <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode.
    • [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode.
    • <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers.
    This format may change in the future. On Data ONTAP operating in Cluster-Mode, when specifying a destination endpoint, you must use either the destination location, or destination Vserver and destination volume. This parameter is mandatory on Data ONTAP operating in 7-mode
  • source-location => string, optional

    • Specifies the source endpoint of the SnapMirror relationship in the following formats:
    • <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode.
    • [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode.
    • <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode.
    This format may change in the future. On Data ONTAP operating in Cluster-Mode, When specifying a source endpoint, you must use either the source location, or the source Vserver, and source volume.

Outputs

  • None

snapmirror_resume

[Family: ontap-classic, vfiler]

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 storage system on Data ONTAP operating in 7-Mode, on the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, and on the destination Vserver on Data ONTAP 8.2 or later operating in Cluster-Mode.

Inputs

  • destination-location => string, optional

    • Specifies the destination endpoint of the SnapMirror relationship in the following formats:
    • <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode.
    • [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode.
    • <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers.
    This format may change in the future. On Data ONTAP operating in Cluster-Mode, when specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume. This parameter is mandatory on Data ONTAP operating in 7-mode.

Outputs

  • None

snapmirror_resync

[Family: ontap-classic, vfiler]

Re-establishes a mirroring relationship between a source volume and a destination volume, typically in the following cases:
  • The destination mirror is broken (that is, the destination volume is a read-write volume and no longer a data protection mirror). After the snapmirror-resync API completes, the destination volume is made a data protection mirror and the mirror can be manually updated or scheduled for updates.
  • A snapmirror-update API failed because the required common Snapshot copy was deleted on the source volume.
After the operation completes, the destination volume is made a data protection mirror and the mirror can be manually updated or scheduled for updates. Attention: The snapmirror-resync API can cause data loss on the destination volume because the API can remove the exported Snapshot copy on the destination volume.

The default behavior of the snapmirror-resync API is defined as follows:

  • Finds the most recent common Snapshot copy between the source and destination volumes, removes Snapshot copies on the destination volume that are newer than the common Snapshot copy and mounts the destination volume as a DP volume with the common Snapshot copy as the exported Snapshot copy.
  • For data protection relationships, takes a Snapshot copy of the source volume to capture the current image and transfers Snapshot copies that are newer than the common Snapshot copy from the source volume to the destination volume. For vault relationships, transfers Snapshot copies newer than the common Snapshot copy according to the relationship policy, i.e., Snapshot copies will match rules associated with the policy as defined by the snapmirror-policy API.
On Data ONTAP 8.2 or later operating in Cluster-Mode, the snapmirror-resync API supports an optional parameter 'preserve'. The parameter 'preserve' is only supported for vault relationships. When used, the parameter 'preserve' changes the behavior of the snapmirror-resync API. The changed behavior can be described as follows:
  • Finds the most recent common Snapshot copy between the source and destination volumes, preserves all Snapshot copies on the destination volume that are newer than the common Snapshot copy, and mounts the destination volume as a DP volume with the common Snapshot copy as the exported Snapshot copy.
  • Performs a local rollback transfer to make a copy of the common Snapshot copy on the destination volume and establish it as the latest Snapshot copy on the destination volume. The command then transfers all Snapshot copies that are newer than the common Snapshot copy, from the source volume to the destination volume. The command only transfers Snapshot copies that match the vault relationship's policy, i.e., Snapshot copies will match rules associated with the policy as defined by the snapmirror-policy APIs.
The snapmirror-resync API fails if the destination volume does not have a Snapshot copy in common with the source volume.

On Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode, a job is spawned to operate for the SnapMirror relationship and the job id is returned. The progress of the operation can be tracked using the job APIs.

On Data ONTAP 8.2 or later operating in Cluster-Mode, you can track the progress of the operation using the snapmirror-get API except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode.

On Data ONTAP operating in 7-Mode, the update is asynchronously handled, and there is no guarantee that it succeeds. This requires that a schedule in /etc/snapmirror.conf is set for the destination.

The API must be issued on the destination storage system on Data ONTAP operating in 7-Mode, on the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, and on the destination Vserver on Data ONTAP 8.2 or later operating in Cluster-Mode.

Inputs

  • destination-location => string, optional

    • Specifies the destination endpoint of the SnapMirror relationship in the following formats:
    • <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode.
    • [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode.
    • <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers.
    This format may change in the future. On Data ONTAP operating in Cluster-Mode, when specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume. This parameter is mandatory on Data ONTAP operating in 7-mode
  • destination-snapshot => string, optional

    • Creates the specified snapshot (in addition to the regular SnapMirror snapshot) on the destination after the qtree SnapMirror transfer is over.
  • max-transfer-rate => integer, optional

    • Specifies the upper bound, in kilobytes per second, at which data is transferred. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. On Data ONTAP operating in Cluster-Mode, the max-transfer-rate option does not affect load-sharing transfers and transfers for other relationships with Relationship Capability of Pre 8.2 confined to a single cluster.
  • source-location => string, optional

    • Specifies the source endpoint of the SnapMirror relationship in the following formats:
    • <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode.
    • [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode.
    • <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers.
    This format may change in the future. On Data ONTAP Cluster-Mode when specifying a source endpoint, you must use either the source location, or the source cluster, source Vserver, and source volume. On Data ONTAP operating in 7-Mode, If the source-location is not specified, then the source in /etc/snapmirror.conf for the destination path is used.
  • source-snapshot => string, optional

    • Designates the source snapshot to use for a qtree update on Data ONTAP operating in 7-Mode, and the snapshot on the source volume to use for the transfer on Data ONTAP 8.2 or later operating in Cluster-Mode.

    For data protection mirror relationships, Data ONTAP Cluster-Mode does not create a new Snapshot copy. It will use the specified Snapshot copy as if it were the most recent one; that is, all copies between the most recent common one and the specified one are transferred, but no copies newer than the specified one are transferred.

    For vault relationships, Data ONTAP Cluster-Mode transfers the specified Snapshot copy instead of the ones that match its policy's rules.

    This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'.

Outputs

  • None

snapmirror_set_connection

[Family: ontap-classic, vfiler]

Sets up a connection. snapmirror-set-connection will add a new connection or modify an existing one. This API must be executed on the destination filer. Currently, the connections are in: /etc/snapmirror.conf.

Inputs

  • address-pair1 => address-pair

    • The connection's first source and destination address pair. In multi mode, the first address pair provides a connection path; while in failover mode, the first address pair provides the prefer connection path.
  • address-pair2 => address-pair, optional

    • The connection's second source and destination address pair. In multi mode the second address pair provides another connection path, while in failover mode, the second address pair provides a connection path in case the first path fails.
  • connection => string

    • Name of the connection to add or modify. The name is in ASCII and must begin with an alpha character.
  • mode => string, optional

    • Possible mode values are "multi" or "failover". If not specified, the default is "multi".

Outputs

  • None

snapmirror_set_schedule

[Family: ontap-classic, vfiler]

Sets the schedule for a given destination. The API must be executed on the destination filer. Currently, the schedule is in /etc/snapmirror.conf.

Inputs

  • connection-mode => string, optional

    • This option specifies the mode to be used for establishing connection between source and destination. Possible values are "inet", "inet6" and "default". If this option is set to "inet6", connections between source and destination will be established using IPv6 addresses only. If there are no IPv6 addresses configured, then the connection will fail. If the option is set to "inet", connections between source and destination will be established using IPv4 addresses only. If there are no IPv4 addresses configured, then the connection will fail.

    If not specified, the previous value is retained. If nothing was mentioned previously, it is set as default, where connection will be tried using both "inet6" and "inet". "inet6" will have higher precedence than "inet". If connection request using "inet6" fails, SnapMirror will retry the connection using "inet".

    This argument is not effective when an IP address is specified instead of source hostname. If the IP address format and connection mode do not match, the operation will fail with proper error message.

  • days-of-month => string

    • Minutes in the hour for which the schedule is set. The form is crontab-like, with possible values of:
    • - := match nothing;
    • 1 := match day 1;
    • 1,3 := match day 1 and 3;
    • 2-5 := match day 2,3,4,5;
    • 1-30/7 := match day 1,8,15,22,29;
    • * := matches all possible legal values;
  • days-of-week => string

    • Days in the week for which the schedule is set. 0 represents Sunday, and 6 represents Saturday. The form is crontab-like, with possible values of:
    • - := match nothing;
    • 1 := match day 1 (Mon);
    • 1,3 := match day 1 and 3 (Mon and Wed);
    • 2-5 := match day 2,3,4,5 (Tue,Wed,Thu,Fri);
    • * := matches all possible legal values;
  • destination-location => string

    • The destination location of a schedule to set. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.
  • hours => string

    • Hours in the day for which the schedule is set. The form is crontab-like, with possible values of:
    • - := match nothing;
    • 1 := match hour 1;
    • 1,3 := match hour 1 and 3;
    • 2-5 := match hour 2,3,4,5;
    • 1-24/3 := match hour 1,4,7,10,13,16,19,22;
    • * := matches all possible legal values;
  • is-compressed => boolean, optional

    • If true SnapMirror will compress/decompress the data that is transferred between the source and destination storage system. If false, transferred data will not be compressed. Upon initial configuration, default is false. On subsequent requests, the current configured setting is retained if not provided. This argument can only be used when a connection definition is used for the relationship entry. Using this argument without a connection definition will throw an error message.
  • max-transfer-rate => integer, optional

    • Maximum transfer rate in kilobytes per second. If specified as 0, transfer happens as fast as the storage system can. If not specified, the previous value is retained. If nothing was mentioned previously, it is set to the default value.
  • minutes => string

    • Minutes in the hour for which the schedule is set. The form is crontab-like, with possible values of:
    • - := match nothing;
    • 1 := match minute 1;
    • 1,3 := match minute 1 and 3;
    • 2-5 := match minute 2,3,4,5;
    • 1-12/3 := match minute 1,4,7,10;
    • 0-55/5 := match minute 0,5,10,15,20,25,30,35,40,45,50,55;
    • * := matches all possible legal values;
  • restart => string, optional

    • restart mode when transfer is interrupted. Possible values are "always", "never" and "default". If value is set to "always", then an interrupted transfer will always restart, if it has a restart check point and the conditions are the same as before the transfer was interrupted. If value is set to "never", then an interrupted transfer will never restart, even if it has a restart checkpoint. If not specified, the previous value is retained. If nothing was mentioned previously, then it is set to default, where SnapMirror behaves like the "always" case, unless it has passed the next scheduled transfer time, in which case it will begin that scheduled transfer instead of restarting.
  • source-location => string

    • The source location of a schedule to set. The source location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.
  • tcp-window-size => integer, optional

    • TCP window size in bytes. If specified as 0, size is set to an internally determined default value. If not specified, the previous value is retained.

Outputs

  • None

snapmirror_set_sync_schedule

[Family: ontap-classic]

Establishes a synchronous or semi-synchronous schedule. Currently, the schedules are in: /etc/snapmirror.conf. Semi-synchronous mode is determined by specifying semi-sync.

Inputs

  • connection-mode => string, optional

    • This option specifies the mode to be used for establishing connection between source and destination. If this option is set to "inet6", connections between source and destination will be established using IPv6 addresses only. If there are no IPv6 addresses configured, then the connection will fail. If the option is set to "inet", connections between source and destination will be established using IPv4 addresses only. If there are no IPv4 addresses configured, then the connection will fail.

    If not specified, the previous value is retained. If nothing was mentioned previously, it is set as default, where connection will be tried using both "inet6" and "inet". "inet6" will have higher precedence than "inet". If connection request using "inet6" fails, SnapMirror will retry the connection using "inet".

    This argument is not effective when an IP address is specified instead of source hostname. If the IP address format and connection-mode do not match, the operation will fail with proper error message.

  • destination-location => string

    • The destination location of a schedule to set. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.
  • is-compressed => boolean, optional

    • If true SnapMirror will compress/decompress the data that is transferred between the source and destination storage system. If false, transferred data will not be compressed. Upon initial configuration, default is false. On subsequent requests, the current configured setting is retained if not provided. This argument can only be used when a connection definition is used for the relationship entry. Using this argument without a connection definition will throw an error message.
  • ops-throttle => string, optional

    • The number of outstanding operations allowed before blocking on the source. The format is a number followed by the one of the following units: "ops", "s", or "ms". If the specified value is less than 10s, the mirror is configured to run in a fully synchronous mode. If the specified value is greater than or equal to 10s, the mirror is configured to run in semi-synchronous mode. If not specified, the previous value is retained. This is a deprecated parameter. Use the sync-mode parameter instead to specify the sync mode.
  • source-location => string

    • The source location of a schedule to set. The source location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.
  • sync-mode => string, optional

    • This specifies whether the mirror should be configured in sync or in semi-sync mode. Possible values are: "full_sync" and "semi_sync". If the user wants to configure the mirror to run in fully synchronous mode, the user must specify "full_sync" as the value for this parameter. If the user wants to configure the mirror to run in semi-synchronous mode, the user must specify "semi_sync" as the value of this parameter. If not specified, the mirror will be configured to run in full synchronous mode. This parameter overrides the deprecated ops-throttle parameter.
  • tcp-window-size => integer, optional

    • TCP window size in bytes. If specified as 0, size is set to an internally determined default value. If not specified, the previous value is retained.
  • visibility-frequency => integer

    • Controls how often the source snapspot will be visible on the destination mirror. This input is used to control the value of visibility_interval in the snapmirror.conf file. The units are in seconds. A typical value to use for this input is 180.

Outputs

  • None

snapmirror_throttle

[Family: ontap-classic, vfiler]

Changes the max transfer rate of an active transfer. The API can be issued to either the source or the destination filer.

Inputs

  • destination-location => string

    • The destination location of the active transfer. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.
  • max-transfer-rate => integer

    • Maximum transfer rate in kilobytes per second. A value '0' disables the throttle, ie. the filer will transfer as fast as it can. Range: 0..2^32-1

Outputs

  • None

snapmirror_update

[Family: ontap-classic, vfiler]

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 operating in 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 storage system.

On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode and for relationships using a control plane compatible with Data 8.1 operating Cluster-Mode (relationship-control-plane set 'v1'), 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.

On Data ONTAP 8.2 or later operating in Cluster-Mode, you can track the progress of the operation using the snapmirror-get API, except for relationships using a control plane compatible with Data ONTAP 8.1 operating Cluster-Mode.

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 storage system on Data ONTAP 7-Mode, or from the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, and from the destination Vserver on Data ONTAP 8.2 or later operating in Cluster-Mode.

On Data ONTAP operating in 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.

For data protection relationships, the snapmirror-update API makes the destination volume an up-to-date mirror of the source volume with the following steps:

  • If the source volume is read-write, takes a Snapshot copy on the source volume to capture the current image of the source volume.
  • Finds the most recent Snapshot copy on the destination volume and validates that the corresponding Snapshot copy is on the source.
  • Incrementally transfers Snapshot copies that are newer than the corresponding Snapshot copy to the destination volume.

For vault relationships, the snapmirror-update API does not take a Snapshot copy on the source volume but transfers only selected Snapshot copies that are newer than the common Snapshot copy to the destination volume. Snapshot copies are selected by matching their 'snapmirror-label' with the 'snapmirror-label' of one of the rules from the corresponding SnapMirror policy associated to the SnapMirror relationship. All matching Snapshot copies are incrementally transferred to the destination volume.

For vault relationships, the snapmirror-update API also manages expiration of Snapshot copies on the destination volume. It does so by deleting Snapshot copies that have exceeded the value of 'keep' for the matching rule from the corresponding SnapMirror policy associated with the SnapMirror relationship. Snapshot copies that match the same 'snapmirror-label' will be deleted in oldest-first order.

For data protection relationships, the parameter 'source-snapshot' is optional and allows for the transfer of Snapshot copies newer than the common Snapshot copy up to the specified 'source-snapshot'.

For vault relationships, the parameter 'source-snapshot' is optional and allows transfer of a Snapshot copy that is older than the common Snapshot copy and/or may not be selected for transfer based on policy-based selection of a scheduled update transfer.

After the snapmirror-update API successfully completes, the last Snapshot copy transferred is made the new exported Snapshot copy on the destination volume. If an update to a vault relationship specifies a Snapshot copy using the 'source-snapshot' parameter that is older than the common snapshot, after the snapmirror-update API successfully completes, the exported Snapshot copy on the destination volume will remain unchanged.

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. For vault relationships, the next update will restart and continue the old transfer regardless of whether it is a matching Snapshot copy or not.

On Data ONTAP 8.1 operating in 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.

Inputs

  • destination-location => string, optional

    • Specifies the destination endpoint of the SnapMirror relationship in the following formats:
    • <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode.
    • [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode.
    • <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers.
    This format may change in the future. On Data ONTAP Cluster-Mode, when specifying a destination endpoint, you must use either the destination location, or the destination cluster, destination Vserver, and destination volume. 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. This parameter is mandatory on Data ONTAP 7-mode
  • destination-snapshot => string, optional

    • Creates the specified snapshot (in addition to the regular SnapMirror snapshot) on the destination after the qtree SnapMirror transfer is over.
  • max-transfer-rate => integer, optional

    • Specifies the upper bound, in kilobytes per second, at which data is transferred. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. On Data ONTAP operating in Cluster-Mode, the max-transfer-rate option does not affect load-sharing transfers and transfers for other relationships with Relationship Capability of Pre 8.2 confined to a single cluster.
  • source-location => string, optional

    • Specifies the source endpoint of the SnapMirror relationship in the following formats:
    • <system>:/vol/<volume>[/<qtree>] On Data ONTAP operating in 7-Mode.
    • [<cluster>:]//<vserver>/<volume> On Data ONTAP 8.1 operating in Cluster-Mode, and on Data ONTAP 8.2 operating in Cluster-Mode for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode.
    • <[vserver:]volume> On Data ONTAP 8.2 or later operating in Cluster-Mode except for relationships using a control plane compatible with Data ONTAP 8.1 operating in Cluster-Mode. This format depends on the Vserver peering setup between the source and destination Vservers.
    This format may change in the future. On Data ONTAP Cluster-Mode when specifying a source endpoint, you must use either the source location, or the source cluster, source Vserver, and source volume. On Data ONTAP 7-Mode, If the source-location is not specified, then the source in /etc/snapmirror.conf for the destination path is used.
  • source-snapshot => string, optional

    • Specifies the Snapshot copy on the source to use as the basis for the update. It is used for updates to Data ONTAP 7-mode qtree relationships and Data ONTAP Cluster-Mode relationships.

    For a qtree relationship, Data ONTAP 7-mode does not create a new Snapshot copy and transfers the specified Snapshot copy instead.

    For data protection mirror relationships, Data ONTAP Cluster-Mode does not create a new Snapshot copy. It will use the specified Snapshot copy as if it were the most recent one; that is, all copies between the most recent common one and the specified one are transferred, but no copies newer than the specified one are transferred.

    For vault relationships, Data ONTAP Cluster-Mode transfers the specified Snapshot copy instead of the ones that match its policy's rules.

Outputs

  • None

snapshot_autodelete_list_info

[Family: ontap-classic, vfiler]

Returns the current snapshot autodelete settings.

Inputs

  • volume => string

    • Name of the existing volume for which we want snapshot autodelete settings

Outputs

snapshot_autodelete_set_option

[Family: ontap-classic, vfiler]

Set the option named 'option-name' to the value specified by 'option-value' in the autodelete settings of the specified volume.

This API is not supported on Infinite Volume.

Inputs

  • option-name => string

    • Name of the option to be set. Possible values:
    "state" (value: "on" | "off")
    This option determines if the snapshot autodelete is currently enabled for the volume. Setting the option to "on" switches on the snapshot autodelete for the volume. Setting the option to "off" switches off the snapshot autodelete for the volume.

    "commitment" (value: "try" | "disrupt" | "destroy" )
    This option determines the snapshots which 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, LUN and File clones) to be deleted. Setting this option to "disrupt" only permits the snapshots which are not locked by data backing functionalities (volume, LUN and File clones) to be deleted. Setting this option to "destroy", will destroy the data backing functionality (volume, LUN and File clones) if the backing snapshot is deleted.

    "trigger" (value: "volume" | "snap_reserve" | "space_reserve")
    This option determines the condition which starts the automatic deletion of snapshots. Setting this option to "volume" triggers automatic deletion of snapshots when the volume reaches threshold capacity and the volume's snap reserve has been exceeded. Setting the option to "snap_reserve" triggers automatic deletion of snapshots when the snap reserve of the volume reaches threshold capacity. Setting the option to "space_reserve" triggers automatic deletion of snapshots when the space reserved the volume reaches threshold capacity and the volume's snap reserve has been exceeded. The threshold capacity is determined by the size of the volume as given below:
    • If the volume size is less than 20 GB, the autodelete threshold is 85%.
    • If the volume size is equal to or greater than 20 GB and less than 100 GB, the autodelete threshold is 90%.
    • If the volume size is equal to or greater than 100 GB and less than 500 GB, the autodelete threshold is 92%.
    • If the volume size is equal to or greater than 500 GB and less than 1 TB, the autodelete threshold is 95%.
    • If the volume size is equal to or greater than 1 TB, the autodelete threshold is 98%.

    "target_free_space" (value: < number >)
    This option determines when snapshot autodelete should stop deleting snapshot. Depending on the trigger, snapshots are deleted till we reach the target free space percentage.

    "delete_order" (value: newest_first | oldest_first)
    This option determines if the oldest or newest snapshot is deleted first.

    "defer_delete" (value: scheduled | user_created | prefix | none)
    This option determines which kind of snapshots to delete in the end. 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.

    "prefix" (value: < string >)
    This option can be set to provide the prefix string for the "prefix" value of the "defer_delete" option. The prefix string length can be 15 char long.

    "destroy_list" (value: < string >)
    A comma seperated list of services which can be destroyed if the snapshot backing that service is deleted. For 7-mode, the possible values for this option are a combination of "lun_clone", "vol_clone", "cifs_share", "file_clone" or "none". For cluster-mode, the possible values for this option are a combination of "lun_clone,file_clone" (for LUN clone and/or file clone), "lun_clone,sfsr" (for LUN clone and/or sfsr), "vol_clone", "cifs_share", or "none". Please note that "lun_clone", "file_clone" and "sfsr" individually are not valid values. Only pairs "lun_clone,file_clone" and "lun_clone,sfsr" are supported. The option "sfsr" is not supported for 7-mode. The default value is "none" for 7-mode and cluster-mode.

  • option-value => string

    • The value to set the named option
  • volume => string

    • Name of the volume for which we want to change autodelete settings.

Outputs

  • None

snapshot_create

[Family: ontap-classic, vfiler]

Create a new snapshot on a specified volume.

This API is not supported on Infinite Volume.

Inputs

  • is-valid-lun-clone-snapshot => boolean, optional

    • If true, the snapshot create has been requested by snapvault hence all backing snapshots for all the lun clones in this snapshot will be locked. This ensures the consistency of this snapshot. The default value is false.
  • snapshot => string

    • Name of the snapshot to be created. The maximum string length is 256 characters.
  • volume => string

    • Name of the volume on which the snapshot is to be created. The volume name can contain letters, numbers, and the underscore character (_), but the first character must be a letter or an underscore.

Outputs

  • None

snapshot_delete

[Family: ontap-classic, vfiler]

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

  • snapshot => string

    • Name of snapshot to be deleted on the specified volume.
  • snapshot-instance-uuid => uuid, optional

    • The 128 bit unique snapshot identifier expressed in the form of UUID. This field is optional and can appear together with 'snapshot' to uniquely identify a snapshot for deletion. If this field is provided, 'snapshot' is a required parameter.

    An example of an actual UUID is:

    73a010ec-3d28-11df-84e8-123478563412

  • volume => string

    • Name of the volume on which the snapshot is to be deleted.

Outputs

  • None

snapshot_delta_info

[Family: ontap-classic, vfiler]

Returns the amount of space consumed between two snapshots or a snapshot and active filesystem.

Inputs

  • snapshot1 => string

    • Name of snapshot to be compared with snapshot2 for space consumption calculations.
  • snapshot2 => string, optional

    • Name of snapshot to be compared with snapshot1 for space consumption calculations. If the snapshot is not specified, it is assumed to be Active File System.
  • volume => string

    • Name of the volume on which the snapshot delta is to be calculated.

Outputs

  • consumed-size => integer

    • Size in bytes of space changed between the 2 specified snapshots or snapshot and the active file system. Range : [0 - 2^63-1].
  • elapsed-time => integer

    • Time in seconds elapsed between the 2 specified snapshots or the snapshot and the active file system. Range : [0 - 2^31-1].

snapshot_get_reserve

[Family: ontap-classic, vfiler]

Obtain the current snapshot reserve on a specified volume. Error Returns: Invalid volume name.

Inputs

  • volume => string

    • Name of the volume that contains the snapshot reserve.

Outputs

snapshot_get_schedule

[Family: ontap-classic, vfiler]

Obtain the current snapshot schedule on a specified volume. Error Returns: Invalid volume name.

Inputs

  • volume => string

    • This the volume name where the snapshots are located.

Outputs

  • days => integer

    • The number of snapshots taken daily to keep on line. Range : [0..2^32-1].
  • hours => integer

    • The number of snapshots taken hourly to keep on line. Range : [0..2^32-1].
  • minutes => integer

    • The number of snapshots taken minutely to keep on line. Range : [0..2^32-1].
  • weeks => integer

    • The number of snapshots taken weekly to keep on line. Range : [0..2^32-1].

snapshot_list_info

[Family: ontap-classic, vfiler]

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

  • is-7-mode-snapshot => boolean, optional

    • If set to true, check if snapshot is a 7-mode snapshot. A 7-mode snapshot can appear in a cluster-mode volume as a result of the volume being transitioned from 7-mode to cluster-mode. A 7-mode snapshot cannot be used in a volume snapshot restore. The default value is false.
  • snapowners => boolean, optional

    • If set to true, owners of the busy snapshot are returned. If false, or if the option is omitted, the list of owners is not returned.
  • target-name => string, optional

    • Name of the object on which to list the snaplist information. Arguments "target-name" and "target-type" should be used together. Arguments "volume" and ("target-name", "target-type") pair are mutually exclusive. One and only one of them should be specified.
  • terse => boolean, optional

    • If set to true, the snapshot block ownership values, namely the "total" and "cumulative-total" outputs, will be omitted. If set to false, the block ownership calculation will be included in the output. The default value is false.
  • volume => string, optional

    • Name of the volume on which to list the snaplist information. It is for backward compatibility. The recommended usage is to use arguments ("target-name", "target-type") pair.

Outputs

snapshot_multicreate

[Family: ontap-classic, vfiler]

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.

This API is not supported on Infinite Volume.

Inputs

  • cleanup => boolean, optional

    • When the API fails, some snapshots may have been created for some volumes. When set to TRUE, the API will attempt to delete these snapshots. Note that newly created snapshots cannot be deleted right away until the snapshots are on-disk, which may take up to 10 secs. When set to FALSE, newly created snapshots are not deleted. Users can delete them later as needed. Default is TRUE.
  • snapshot => string

    • Name of the snapshot to be created. The maximum string length is 256 characters.
  • volume-names => volume-name[]

    • Names of the volumes across which the snapshot is to be created. The maximum number of volumes on a cluster system is 1200 (100 for traditional volumes and 500 for flexible volumes. The number is then doubled for a cluster system).

Outputs

snapshot_multicreate_validate

[Family: ontap-classic, vfiler]

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.

This API is not supported on Infinite Volume.

Inputs

  • snapshot => string

    • Name of the snapshot to be created. The maximum string length is 256 characters.
  • volume-names => volume-name[]

    • Names of the volumes across which the snapshot creation is to be validated.

Outputs

snapshot_multidelete

[Family: ontap-classic]

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

  • snapshot => string

    • Name of the snapshot to be deleted. The maximum string length is 256 characters.
  • volume-names => volume-name[]

    • Names of the volumes across which the snapshot is to be deleted.

Outputs

  • volume-errors => volume-error[], optional

    • Error code and reason due to which snapshot deletion failed on a volume. This output is only returned when the API returns SUCCESS but snapshot on some volumes could not be deleted.

snapshot_partial_restore_file

[Family: ontap-classic, vfiler]

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 may fail if the LUN being restored is a read-only LUN unless the force option is used.

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

  • byte-count => integer

    • The number of bytes to restore, beginning at start-byte. The byte count must be a multiple of 4096. Use snapshot-partial-restore-file-list-info to determine the maximum number of bytes that can be restored in a single request. Range : [0 - 2^64-1]
  • force => boolean, optional

    • If this field is set to "true", restore operation will proceed even if LUN being restored is read-only. The default value is false.
  • path => string

    • Path of the file to restore. Path syntax has two forms: /vol// / In the latter case (relative path), if volume was not specified, the root volume will be used.
  • snapshot => string

    • The simple name of the snapshot to restore from. The snapshot must be from same volume as the file to partially restore.
  • snapshot-instance-uuid => string, optional

    • A unique physical version identifier for a given snapshot within a volume or an aggregate. A typical snapshot instance UUID will look like: c0335624-21f3-450c-aea1-55884d0218b9
  • start-byte => integer

    • The starting byte offset in the file to partially restore. The first byte of the file is byte zero. The start byte must be a multiple of 4096. Range : [0 - 2^64-1]

Outputs

  • None

snapshot_partial_restore_file_list_info

[Family: ontap-classic, vfiler]

Returns partial file restore settings of the vserver.

This API is not supported on Infinite Volume.

Inputs

  • None

Outputs

  • max-byte-count => integer

    • The maximum number of bytes that can be restored in a single request. This limit ensures that requests are periodically interruptible and avoids overloading the filer. Range : [0 - 2^64-1]

snapshot_reclaimable_info

[Family: ontap-classic, vfiler]

Returns the amount of space that would be freed when a set of snapshots are deleted from a specified volume.

Inputs

  • volume => string

    • Name of the volume on which the snapshot reclaimable space info is to be collected.

Outputs

snapshot_rename

[Family: ontap-classic, vfiler]

Rename a specified snapshot to a new name on a specified volume. This API is not supported on Infinite Volume constituents.

Inputs

  • volume => string

    • Name of the volume where the current snapshot and the new snapshot are located.

Outputs

  • None

snapshot_reserve_list_info

[Family: ontap-classic, vfiler]

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. This API is deprecated in Data ONTAP Cluster-Mode 8.2 and later. Use volume-get-iter instead.

Inputs

  • volume => string, optional

    • Volume to get percentage of space reserved for snapshots.

Outputs

snapshot_restore_file

[Family: ontap-classic, vfiler]

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 in Data ONTAP 7-mode, 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. Exclusive oplocks and hard exclusive locks like the DOS compatibility lock will be invalidated.

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 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.

The following applies to Data ONTAP 7-mode only:

For normal files while the restore is proceeding, any operation which tries to change the file will be suspended until the restore is done. It could take up to several minutes for before the API invocation returns. Once the invocation returns, the file restore will proceed in the background. 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. 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 Data ONTAP 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. 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.

This operation will fail if the LUN being restored is a read-only LUN unless the force option is used.

Inputs

  • force => boolean, optional

    • If this field is set to "true", restore operation will proceed even if LUN being restored is read-only. The default value is false.
  • path => string

    • Path of the file to restore. Path syntax has two forms: /vol// / In the latter case (relative path), if volume was not specified, the root volume will be used.
  • restore-path => string, optional

    • Path to restore to. The path must be a full path to a filename, and must be in the same volume as the volume used for the restore. If not specified, restore-path is defaulted to the original path.
  • snapshot => string

    • Name of snapshot to restore from. Snapshot must be from same volume as the file to restore.
  • snapshot-instance-uuid => string, optional

    • A unique physical version identifier for a given snapshot within a volume or an aggregate. A typical snapshot instance UUID will look like: c0335624-21f3-450c-aea1-55884d0218b9
  • space-efficient-split-disabled => boolean, optional

    • By default 'false', space-efficient LUN clone split is allowed during restore. This parameter, if set to 'true', disables space-efficient splitting for this specific operation.

Outputs

  • None

snapshot_restore_file_info

[Family: ontap-classic, vfiler]

Get information about snapshot file restores on a given vserver. Returns maximum snapshot file restores limit and snapshot file restores in progress numbers.

Inputs

  • None

Outputs

snapshot_restore_volume

[Family: ontap-classic, vfiler]

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 operation will fail if the volume being restored contains a read-only LUN unless the force option is used.

This API is not supported on Infinite Volume.

Inputs

  • force => boolean, optional

    • If this field is set to "true", restore operation will proceed even if the volume being restored has a read-only LUN. This operation will restore the read-only LUN as well. The default value is false.
  • snapshot => string

    • Name of snapshot to restore from.
  • snapshot-instance-uuid => uuid, optional

    • The 128 bit unique snapshot identifier expressed in the form of UUID. This field is optional and can appear together with 'snapshot' to uniquely identify a snapshot to restore. If this field is provided, 'snapshot' is a required parameter.

    An example of an actual UUID is:

    84a010ec-3d28-11df-84e8-123478653412

  • volume => string

    • Name of volume to restore.

Outputs

  • None

snapshot_set_reserve

[Family: ontap-classic, vfiler]

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

  • volume => string

    • Name of volume on which to set the snapshot space reserve.

Outputs

  • None

snapshot_set_schedule

[Family: ontap-classic, vfiler]

Set the snapshot schedule on a specified volume. If number of snapshots requested is greater than ONTAP allows, then ESNAPTOOMANY will be returned with the maximum allow snapshots in the reason.

Inputs

  • days => integer, optional

    • Number of snapshots taken daily to keep on line. If not provided, the number of daily snapshots is left at the previous value.
  • hours => integer, optional

    • Number of snapshots taken hourly to keep on line. If not provided, the number of weekly snapshots is left at the previous value.
  • minutes => integer, optional

    • Number of snapshots taken minutely to keep on line. If not provided, the number of minutely snapshots is left at the previous value.
  • volume => string

    • Name of the volume name where the snapshots are located.
  • weeks => integer, optional

    • Number of snapshots taken weekly to keep on line. If not provided, the number of weekly snapshots is left at the previous value.
  • which-hours => string, optional

    • Comma-separated list of the hours at which the hourly snapshots are created. If hours is 0, which-hours is ignored and cleared.
  • which-minutes => string, optional

    • Comma-separated list of the minutes at which the minutely snapshots are created. If minutes is 0, which-minutes is ignored and cleared.

Outputs

  • None

snapshot_volume_info

[Family: ontap-classic, vfiler]

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

  • volume => string

    • Name of the volume on which the space needs to be checked.

Outputs

  • size-available => integer

    • Total bytes that when exhausted will disable us from taking snapshots. If this value is 0, snapshots cannot be taken. Any other value would allow us to take a reliable snapshot. This space may or may not get exhausted by taking a snapshot. Also it may get used by writes/allocations in the volume. This is not equal to the free space in the active file system or anyway related to the size of the next snapshot. Range : [0..2^64-1].

snapvault_add_softlock

[Family: ontap-classic]

Request the system to add softlock for the specified snapshot. Softlocks can be added to preserve the snapshots which user wants to retain down the cascade.

Inputs

  • snapshot => string

    • Name of the snapshot to be softlocked.
  • softlock-name => string, optional

    • Name of softlock which uniquely identifies the softlock for the snapshot. When not specified, softlock will be added with default name. Name of softlock can contain letters, numbers, and underscore character (_), and can be up to 64 characters long.
  • volume => string

    • Name of the volume where the snapshot exists.

Outputs

  • None

snapvault_get_all_softlocked_snapshots

[Family: ontap-classic]

List all snapshots which are softlocked for snapvault by external means.

Inputs

  • volume => string

    • Name of the volume for which softlocked snapshots to be listed.

Outputs

snapvault_get_softlocks

[Family: ontap-classic]

List all snapvault softlocks on the given snapshot which are locked by external means.

Inputs

  • snapshot => string

    • Name of the snapshot for which softlocks to be listed.
  • volume => string

    • Name of the volume where the snapshot exists.

Outputs

snapvault_primary_abort_snapshot_create

[Family: ontap-classic, vfiler]

Request the primary to abort a snapshot creation that is already in progress. The snapshot schedule for which the snapshot creation is in progress must be specified as input.

Inputs

  • volume-name => string

    • Primary volume in which snapshot create is in progress.

Outputs

  • None

snapvault_primary_abort_transfer

[Family: ontap-classic, vfiler]

Request the primary system to abort an active transfer. The abort can be hard abort, which means the transfer will not be restartable. Or it could be a soft abort, which will not clean the restart checkpoints. In that case the transfer may be restartable. An aborted transfer may be restarted by using the same API used to initiate the transfer in the previous attempt. If that request cannot restart the aborted transfer, then it will initiate a fresh new transfer.

Inputs

Outputs

  • None

snapvault_primary_delete_snapshot_schedule

[Family: ontap-classic, vfiler]

Request the primary system to delete the specified snapshot schedules. The snapshot schedules that match the volume name and if specified the schedule name, will be deleted.

Inputs

  • volume-name => string

    • The primary volume for which the schedules are to be deleted.

Outputs

  • None

snapvault_primary_destinations_list_info

[Family: ontap-classic, vfiler]

Request the primary to list all snapvault destinations that have been replicated from any source path on this primary system. If a source path is provided, then the primary will return destinations information only for that source path. When snapvault primary and secondary are licensed on the same filer, output of this API is identical to the output of snapvault-primary-destinations-list-info

Inputs

Outputs

snapvault_primary_get_relationship_status

[Family: ontap-classic, vfiler]

Request the primary to return the status entries for desired relationships. The relationships whose status is desired must be specified using the system path. When snapvault primary and secondary are licensed on the same filer, output of this API is identical to the output of snapvault-secondary-get-relationship-status

Inputs

  • system-path => string

    • System path for relationships whose status is desired.

Outputs

snapvault_primary_initiate_incremental_restore_transfer

[Family: ontap-classic, vfiler]

Request to initiate an incremental restore from a given secondary path to an existing primary path, using the specified secondary snapshot. The request will only initiate the restore and return. The actual restore operation will proceed asynchronously and there is no guarantee that it will succeed. The snapvault-primary-get-relationship- status API should be used to determine progress of the restore operation. If the dataset contains LUNs, the restore will attempt to prevent disruptions to clients using those LUNs. Upon success, the primary path will have the exact same contents as the specified secondary path in the specified secondary snapshot.

Inputs

  • connection-mode => string, optional

    • This option specifies the mode to be used for establising connection between primary and secondary. If this option is set to "inet6", connections between primary and secondary will be established using IPv6 addresses only. If there are no IPv6 addressess configured, then the connection will fail. If the option is set to "inet", connections between primary and secondary will be established using IPv4 addresses only. If there are no IPv4 addresses configured, then the connection will fail. When this option is not specified, Connection will be tried using both "inet6" and "inet". "inet6" will have higher precedence than "inet". If connection request using "inet6" fails, SnapMirror will retry the connection using "inet". This argument is not effective when an IP address is specified instead of secondary hostname. If the IP address format and connection mode do not match, the operation will fail with proper error message.
  • max-transfer-rate => integer

    • null
  • no-lun-clone-expansion => boolean, optional

    • This option dictates how a lun clone would be transferred from source to destination. If this option is "flase", a LUN clone would be transferred as a LUN and if it is "true", it will be transferred as a clone. By default the value of the option is "false".
  • secondary-system => string

    • The secondary system to restore from. This input will be used by the primary system to establish contact with the secondary. Therefore it is expected to be a hostname that the primary can resolve.

Outputs

  • None

snapvault_primary_initiate_restore_transfer

[Family: ontap-classic, vfiler]

Request the primary system to begin a baseline restore transfer from the given secondary path to the given primary path. If the primary path does not already exist, it will be created before starting the restore transfer. If it already exists, its contents will be overwritten by the restore transfer if overwrite-existing-content is set to true else an error is returned. If an existing primary path contains LUNs, then under certain conditions, restore will prevent disruptions to clients using those LUNs. The request will only start the restore transfer and return. The actual transfer will proceed asynchronously and there is no guarantee that it will succeed. The snapvault-primary-get-relationship-status API should be used to check the status of the restore.

Inputs

  • connection-mode => string, optional

    • This option specifies the mode to be used for establising connection between primary and secondary. If this option is set to "inet6", connections between primary and secondary will be established using IPv6 addresses only. If there are no IPv6 addressess configured, then the connection will fail. If the option is set to "inet", connections between primary and secondary will be established using IPv4 addresses only. If there are no IPv4 addresses configured, then the connection will fail. When this option is not specified, Connection will be tried using both "inet6" and "inet". "inet6" will have higher precedence than "inet". If connection request using "inet6" fails, SnapMirror will retry the connection using "inet". This argument is not effective when an IP address is specified instead of secondary hostname. If the IP address format and connection mode do not match, the operation will fail with proper error message.
  • max-transfer-rate => integer, optional

    • The maximum transfer rate in kilobytes (1024 bytes) per second to be applied only for this update transfer. If this option is not provided the default behavior will be to allow the transfer to proceed as fast as possible. Range:[1..2^31-2]
  • no-lun-clone-expansion => boolean, optional

    • This option dictates how a lun clone would be transferred from source to destination. If this option is "false", a LUN clone would be transferred as a LUN and if it is "true", it will be transferred as a clone. By default the value of the option is "false".
  • overwrite-existing-content => boolean, optional

    • This option specifies to overwrite an existing primary qtree or not. If specified primary qtree path already exists and the option is set to "true" the existing qtree will be overwritten and and previous data will be lost. If specified primary qtree path already exists and the option is set to "false" then an error is returned. The default value of the option is "true".
  • primary-path => string

    • The primary path to which data is being restored. The primary path will be created during the restore if it doesn't already exist.
  • secondary-path => string

    • The secondary path to restore from.
  • secondary-snapshot => string, optional

    • Name of the secondary snapshot to be used for this restore transfer. If this option is not provided, the secondary system will choose the snapshot that contains the most recent back-up for this secondary path.
  • secondary-system => string

    • The secondary system to restore from. This input will be used by the primary system to establish contact with the secondary. Therefore it is expected to be a hostname that the primary can resolve.

Outputs

  • None

snapvault_primary_initiate_snapshot_create

[Family: ontap-classic, vfiler]

Request the primary to force a snapshot creation for a specified snapshot schedule. The snapshot schedule must be identified by the volume name and the snapshot prefix. All the properties of the specified schedule will be applied to the snapshot creation. This API should be used when it is desirable to create snapshots right away, without having to wait for the pre-configured scheduled time. This API returns after only initiating the snapshot creation, and there is no guarantee that the snapshot creation will succeed. The snapvault-primary-snapshot-schedule-status-list-info API should be used to track progress of the snapshot creation.

Inputs

  • schedule-name => string

    • The name of the schedule to be used for this snapshot creation.
  • volume-name => string

    • The primary volume for which the snapshot schedule was configured.

Outputs

  • None

snapvault_primary_relationship_status_list_iter_end

[Family: ontap-classic, vfiler]

Terminate the status list iteration set up by the snapvault-primary-relationship-status-list-iter-start API. The primary will clean up any saved info for this iteration.

Inputs

  • tag => string

    • Tag from the previous primary-relationship-status-list-iter-start.

Outputs

  • None

snapvault_primary_relationship_status_list_iter_next

[Family: ontap-classic, vfiler]

Request the primary to continue the iteration set up with the snapvault-primary-relationship-status-list-iter-start API. A list consisting of a number of status entries, upto the specified maximum, will be returned. When snapvault primary and secondary are licensed on the same filer, output of this API is identical to the output of snapvault-secondary-relationship-status-list-iter-next

Inputs

  • maximum => integer

    • The maximum number of entries to retrieve. Range:[0..2^32-1]
  • tag => string

    • Tag from a previous primary-relationship-status-list-iter-start.

Outputs

  • records => integer

    • The number of records being returned by this particular request. When this value is 0, there are no more records to be returned. Range:[0..2^32-1]

snapvault_primary_relationship_status_list_iter_start

[Family: ontap-classic, vfiler]

Request the primary to start an iteration through the list of the status entries for all relationships.

Inputs

  • None

Outputs

  • records => integer

    • This tells you the number of items that have been saved for future retrieval with primary-relationship-status-list-iter-next. Range:[0..2^32-1]
  • tag => string

    • Tag to be used in subsequent iterations.

snapvault_primary_release_relationship

[Family: ontap-classic, vfiler]

Request the release of a snapvault relationship formed by a "create-relationship" or "resync-relationship" operation. This operation deletes the registry entry and the softlocks on the source snapshot.

Inputs

  • primary-path => string

    • The primary path for the relationship.
  • secondary-path => string

    • The secondary path for the relationship.
  • secondary-system => string

    • The secondary system for the relationship.

Outputs

  • None

snapvault_primary_set_snapshot_schedule

[Family: ontap-classic, vfiler]

Request the primary system to configure the specified snapshot schedule. It can also update existing snapshot schedules. If the optional input schedule is skipped, the days-of-week is set to "mon-sun" and hours-of-day set to 0, i.e. midnight.

Inputs

Outputs

  • None

snapvault_primary_snapshot_schedule_list_info

[Family: ontap-classic, vfiler]

Request the primary to return a list of configured snapshot schedules. Without any input arguments this request returns the list of all snapshot schedules configured on the primary. If a volume is specified then only the list of schedules configured for that volume will be returned. When snapvault primary and secondary are licensed on the same filer, snapvault-secondary-snapshot-schedule-list-info and this API return the same number of schedules.

Inputs

  • volume-name => string, optional

    • The primary volume for which the list of snapshot schedules are desired.

Outputs

snapvault_primary_snapshot_schedule_status_list_info

[Family: ontap-classic, vfiler]

Request the primary to return status for all configured snapshot schedules. If a specific volume is provided as input, this API will return only the status for schedules within that volume. When snapvault primary and secondary are licensed on the same filer, output of this API is identical to the output of snapvault-secondary-snapshot-schedule-status-list-info

Inputs

  • volume-name => string, optional

    • Primary volume for which snapshot schedule status is desired.

Outputs

snapvault_remove_softlock

[Family: ontap-classic]

request the system to remove softlock for the given snapshot.

Inputs

  • snapshot => string

    • Name of the snapshot for which softlock to be removed.
  • softlock-name => string, optional

    • Name of softlock which uniquely identifies the softlock for the snapshot. When not specified, softlock with default name will be removed. When softlock-name has value "-all", all softlocks on the snapshot will be removed. Name of softlock can contain letters, numbers, and underscore character (_), and can be up to 64 characters long.
  • volume => string

    • Name of the volume where the snapshot exists.

Outputs

  • None

snapvault_secondary_abort_snapshot_create

[Family: ontap-classic, vfiler]

Request the secondary to abort a snapshot creation that is already in progress. The snapshot schedule for which the snapshot creation is in progress must be specified as input.

Inputs

  • schedule-name => string

    • The name of the schedule used by the snapshot creation.
  • volume-name => string

    • The secondary volume in which snapshot create is in progress.

Outputs

  • None

snapvault_secondary_abort_transfer

[Family: ontap-classic, vfiler]

Request the secondary system to abort the current transfer. The abort can be hard abort, which means the transfer will not be restartable. By default, a soft abort is used, which means the transfer is restartable. An aborted transfer may be restarted by using the same API used to initiate the transfer in the previous attempt. If that request cannot restart the aborted transfer, then it will initiate a fresh new transfer.

Inputs

  • is-hard-abort => boolean, optional

    • When set to 'true' a hard abort is performed. In that case the restart checkpoints are cleared. Default value is 'false'.
  • system-path => string

    • The system path which is the target of update.
  • target-system => string, optional

    • The system filer which is the target of transfer.

Outputs

  • None

snapvault_secondary_configuration_list_info

[Family: ontap-classic, vfiler]

Request to return a list of all configuration entries found on the secondary system.

Inputs

  • None

Outputs

snapvault_secondary_create_relationship

[Family: ontap-classic, vfiler]

Request the secondary system to configure a new snapvault relationship with the given primary and secondary systems and paths. This API is equivalent to the 'snapvault start' Data ONTAP command. All the inputs provided with this request will be stored in the configuration entry maintained by the secondary system. These values will be used as default settings for further incremental update transfers for this relationship. The snapvault-secondary-modify-configuration API can be used to change these configured settings. A successful configuration will automatically be followed by a baseline transfer from the primary to the secondary. The secondary path will be created during the baseline transfer hence it is required that the secondary path must not exist when issuing this request. This request will only begin the baseline transfer and return. The transfer will proceed asynchronously and there is no guarantee that it will succeed. The snapvault-get-relationship-status API should be used to check the status of the transfer.

Inputs

  • no-lun-clone-expansion => boolean, optional

    • This option dictates how a lun clone would be transferred from source to destination. If this option is "false", a LUN clone would be transferred as a LUN and if it is "true", it will be transferred as a clone. By default the value of the option is "false".

Outputs

  • None

snapvault_secondary_delete_relationship

[Family: ontap-classic, vfiler]

Request the secondary system to unconfigure and delete the relationship permanently. The secondary path will be deleted. But none of the snapshots that capture this secondary path will be deleted. This API corresponds to the 'snapvault stop' Data ONTAP command.

Inputs

  • secondary-path => string

    • The secondary-path to be deleted. The path will be unconfigured and deleted.

Outputs

  • None

snapvault_secondary_delete_snapshot_schedule

[Family: ontap-classic, vfiler]

Request the secondary system to delete the specified snapshot schedules. The snapshot schedules that match the volume name and the snapshot prefix when specified, will be deleted.

Inputs

  • schedule-name => string, optional

    • The name of the schedule to be deleted.
  • volume-name => string

    • The secondary volume for which the schedule is to be deleted.

Outputs

  • None

snapvault_secondary_destinations_list_info

[Family: ontap-classic, vfiler]

Request the secondary to list all snapvault destinations that have been replicated from any source path on this secondary system. If a source path is provided, then the secondary will return destinations information only for that source path. When snapvault primary and secondary are licensed on the same filer, output of this API is identical to the output of snapvault-primary-destinations-list-info

Inputs

  • source-path => string, optional

    • Source path on this secondary for which the destination information is desired.

Outputs

snapvault_secondary_get_configuration

[Family: ontap-classic, vfiler]

Request the secondary to return the configuration entry for a relationship. The relationship must be specified by providing the secondary path as input.

Inputs

  • secondary-path => string

    • The secondary path for the relationship whose configuration entry is desired.

Outputs

snapvault_secondary_get_relationship_status

[Family: ontap-classic, vfiler]

Request the secondary to return the status entries for desired relationships. The relationships whose status is desired must be specified using the system path. When snapvault primary and secondary are licensed on the same filer, output of this API is identical to the output of snapvault-primary-get-relationship-status

Inputs

  • system-path => string

    • System path for the relationships whose status is desired.

Outputs

snapvault_secondary_initiate_incremental_transfer

[Family: ontap-classic, vfiler]

Request the snapvault secondary system to begin an incremental transfer to the given secondary path. This API is equivalent to the 'snapvault update' Data ONTAP command. It is required that this secondary path has already been configured as part of a snapvault relationship. The primary system and path configured in that relationship will be used as the source for this transfer. The request will only start the transfer and return. The actual transfer will proceed asynchronously and there is no guarantee that it will succeed. The snapvault-secondary-get-relationship-status API should be used to check the status of the update.

Inputs

  • max-transfer-rate => integer, optional

    • The maximum transfer rate in kilobytes (1024 bytes) per second to be applied only for this update transfer. If this option is not provided the default behavior will be to allow the transfer to proceed as fast as possible. Range:[1.. 2^31-2]
  • no-lun-clone-expansion => boolean, optional

    • This option dictates how a lun clone would be transferred from source to destination. If this option is "false", a LUN clone would be transferred as a LUN and if it is "true", it will be transferred as a clone. By default the value of the option is "false".
  • primary-snapshot => string, optional

    • Name of the primary snapshot to be used for this update transfer. This option is supported for only primary systems. If this option is not provided, the primary system will create a new source snapshot for this transfer.
  • secondary-path => string

    • The secondary path that will be used as the destination for this update transfer. It is required that this secondary path is already a part of some configured snapvault relationship.

Outputs

  • None

snapvault_secondary_initiate_snapshot_create

[Family: ontap-classic, vfiler]

Request the secondary to force a snapshot creation for a specified snapshot schedule. The snapshot schedule must be identified by the volume name and the schedule name. All the properties of the specified schedule will be applied to the snapshot creation. This API should be used when it is desirable to create snapshots right away, without having to wait for the pre-configured scheduled time. This API returns after only initiating the snapshot creation, and there is no guarantee that the snapshot creation will succeed. The snapvault-secondary-snapshot-schedule-status-list-info API should be used to track progress of the snapshot creation.

Inputs

  • lock-backing-snapshot => boolean, optional

    • When set to 'true' any snapshots backing the LUN clones present in the snapshot being created will be locked down. As a result, the locked backing snapshots can't be deleted as long as the snapshot that is locking them exists. The default value for this option is 'false', which doesn't lock any backing snapshots.
  • schedule-name => string

    • The name of the schedule to be used for creating the snapshot. The schedule-name will be used as a prefix in the name of each snapshot created by this schedule. If an empty string is provided, the snapshot creation process will be started, but a snapshot will not be created. This is useful to bring all the relationships of a secondary volume to a consistent state.
  • volume-name => string

    • The secondary volume in which the snapshot is to be created.

Outputs

  • None

snapvault_secondary_modify_configuration

[Family: ontap-classic, vfiler]

Request change in one or more configuration parameters of an existing snapvault relationship identified by the secondary path provided. Only the parameters that are specified as input will be changed for this configuration.

Inputs

Outputs

  • None

snapvault_secondary_relationship_status_list_iter_end

[Family: ontap-classic, vfiler]

Terminate the status list iteration set up by the snapvault-secondary-relationship-status-list-iter-start API. The secondary will clean up any saved info for this iteration.

Inputs

  • tag => string

    • Tag from the previous secondary-relationship-status-list-iter-start.

Outputs

  • None

snapvault_secondary_relationship_status_list_iter_next

[Family: ontap-classic, vfiler]

Request the secondary to continue the iteration set up with the snapvault-secondary-relationship-status-list-iter-start API. A list consisting of a number of status entries, upto the specified maximum, will be returned. When snapvault primary and secondary are licensed on the same filer, output of this API is identical to the output of snapvault-primary-relationship-status-list-iter-next

Inputs

  • maximum => integer

    • The maximum number of entries to retrieve. Range:[0..2^32-1]
  • tag => string

    • Tag from a previous secondary-relationship-status-list-iter-start.

Outputs

  • records => integer

    • The number of records being returned by this particular request. When this value is 0, there are no more records to be returned. Range:[0..2^32-1]
  • status-list => snapvault-status-info[], optional

    • List of entries, each representing status entry for a relationship.

snapvault_secondary_relationship_status_list_iter_start

[Family: ontap-classic, vfiler]

Request the secondary to start an iteration through the list of the status entries for all relationships. This list will also include entries for snapvault restores from this secondary.

Inputs

  • None

Outputs

  • records => integer

    • This tells you the number of items that have been saved for future retrieval with secondary-relationship-status-list-iter-next. Range:[0..2^32-1]
  • tag => string

    • Tag to be used in subsequent iterations.

snapvault_secondary_release_relationship

[Family: ontap-classic, vfiler]

Request the release of a snapvault relationship formed after a restore operation on the primary system. This operation deletes the registry entry and removes the softlock on the source base snapshot.

Inputs

  • primary-path => string

    • The primary path that had been used for the restore.
  • secondary-path => string

    • The secondary path that was used as source for restore.

Outputs

  • None

snapvault_secondary_resync_relationship

[Family: ontap-classic, vfiler]

Request to resynchronize the relationship for an existing secondary path. This API is equivalent to the 'snapvault start -r' Data ONTAP command. In addition the configuration entry for this relationship will be updated with any parameters that are provided as input. Finally an update transfer to this secondary path will be started. The resynchronization is commonly used when the primary dataset has been migrated to a different location for e.g. via snapvault restore. This functionality is also required if the secondary path was made writable for e.g. via wafl iron. This request will only start the resync process and return. The process will proceed asynchronously and there is no guarantee that it will succeed. The snapvault-secondary-get-relationship-status API should be used to check the status of this restore.

Inputs

  • no-lun-clone-expansion => boolean, optional

    • This option dictates how a lun clone would be transferred from source to destination. If this option is "false", a LUN clone would be transferred as a LUN and if it is "true", it will be transferred as a clone. By default the value of the option is "false".

Outputs

  • None

snapvault_secondary_set_snapshot_schedule

[Family: ontap-classic, vfiler]

Request the secondary system to configure the specified snapshot schedule. If this request is made for an existing snapshot schedule, then that snapshot schedule is updated with any new values specified. If the optional input schedule is skipped, the days-of-week is set to "mon-sun" and hours-of-day set to 0, i.e. midnight.

Inputs

Outputs

  • None

snapvault_secondary_snapshot_schedule_list_info

[Family: ontap-classic, vfiler]

Request the secondary to return a list of configured snapshot schedules. Without any input arguments this request returns the list of all snapshot schedules configured on the secondary. If a volume is specified then only the list of schedules configured for that volume will be returned. When snapvault primary and secondary are licensed on the same filer, snapvault-primary-snapshot-schedule-list-info and this API return the same number of schedules.

Inputs

  • volume-name => string, optional

    • The secondary volume for which the list of snapshot schedules are desired.

Outputs

snapvault_secondary_snapshot_schedule_status_list_info

[Family: ontap-classic, vfiler]

Request the secondary to return status for all configured snapshot schedules. If a specific volume is provided as input, this API will return only the status for schedules within that volume. This API corresponds to the 'snapvault status -s' Data ONTAP command. When snapvault primary and secondary are licensed on the same filer, output of this API is identical to the output of snapvault-primary-snapshot-schedule-status-list-info

Inputs

  • volume-name => string, optional

    • Secondary volume for which snapshot schedule status is desired.

Outputs

snmp_community_add

[Family: ontap-classic]

Adds a community to the list of communities.

Inputs

  • access-control => string

    • Access control for the community. Possible values are "ro" (read-only) and "rw" (read-write). But, only "ro" (read-only) communities are supported.

Outputs

  • None

snmp_community_delete

[Family: ontap-classic]

Deletes a community from the list of communities.

Inputs

  • access-control => string

    • Access control for the community. Possible values are "ro" (read-only) and "rw" (read-write). But, only "ro" (read-only) communities are supported.
  • community => string

    • Community name to be deleted.

Outputs

  • None

snmp_community_delete_all

[Family: ontap-classic]

Deletes all the communities.

Inputs

  • None

Outputs

  • None

snmp_disable

[Family: ontap-classic]

Disables snmp protocol.

Inputs

  • None

Outputs

  • None

snmp_enable

[Family: ontap-classic]

Enables snmp protocol.

Inputs

  • None

Outputs

  • None

snmp_get

[Family: ontap-classic]

Retrieves the value of a snmp object.

Inputs

  • object-id => string

    • Fully qualified object identifier of a snmp object. Only numeric OID's (ex: .1.3.6.1.4.1.789.1.1.1.0) are allowed.

Outputs

  • is-value-hexadecimal => boolean, optional

    • If true, the string returned in 'value' is the hexadecimal representation of the octet string returned by a snmp call to the object-id. This output is not present if 'value' is a normal string.
  • value => string

    • Value of the snmp object specified through the input argument "object-id".

snmp_get_next

[Family: ontap-classic]

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

  • object-id => string

    • Object Identifier of a snmp object. The OID can be a fully qualified OID or a partial OID. Only numeric OID's (ex: .1.3.6.1.4.1.789.1.1.1.0) are allowed.

Outputs

  • is-value-hexadecimal => boolean, optional

    • If true, the string returned in 'value' is the hexadecimal representation of the octet string returned by a snmp call to the object-id. This output is not present if 'value' is a normal string.
  • value => string

    • Value of the snmp object reported through the output argument "next-object-id".

snmp_status

[Family: ontap-classic]

Returns configuration information of the SNMP agent daemon.

Inputs

  • None

Outputs

  • traphosts => traphost-info[], optional

    • Returns a list of registered trap hosts followed by their IP addresses. Only resolvable trap hosts are returned. If a host name cannot be found in /etc/hosts for a previously registered IP address, its name defaults to a string representation of its IP address.

snmp_trap_delete

Delete a user defined trap.

Inputs

Outputs

  • None

snmp_trap_disable

[Family: ontap-classic]

Disables snmp traps.

Inputs

  • None

Outputs

  • None

snmp_trap_enable

[Family: ontap-classic]

Enables snmp traps.

Inputs

  • None

Outputs

  • None

snmp_trap_list

List all user defined traps and their attributes.

Inputs

  • None

Outputs

snmp_trap_load

Loads traps from a specified file.

Inputs

  • filename => string

    • Name, including full PATH, of the file specifying the user defined traps. Example: /etc/MyTraps.txt would open the MyTraps.txt file located on the filer's /etc directory.

Outputs

  • None

snmp_trap_reset

Reloads one or all user defined traps from registry.

Inputs

Outputs

  • None

snmp_trap_set

Set the named user defined trap and the enumerated attribute(s). The trap-name must be specified for this api.

Inputs

Outputs

  • None

snmp_traphost_add

[Family: ontap-classic]

Adds a host to the list of trap hosts.

Inputs

  • host => string

    • Specify the host to be added. Host may be specified in Domain Name format such as MyHost.MyNetwork.com, or as an IP address such as 10.20.30.40. If a Domain Name is used, the host must resolve to an IP address.

Outputs

  • None

snmp_traphost_delete

[Family: ontap-classic]

Deletes a host from the list of trap hosts.

Inputs

  • host => string

    • Specify the host to be added. Host may be specified in Domain Name format such as MyHost.MyNetwork.com, or as an IP address such as 10.20.30.40. If a Domain Name is used, the host must resolve to an IP address.

Outputs

  • None

software_extract_metadata

Retrieve metadata from the kernel image in the Compact Flash (CF), or from a specific package.

Older packages do not have metadata. If metadata is not found, an error code of ENPMNOMETA is returned.

There are two types of software packages: ONTAP and Service. Metadata content depends on package type.
Common section meta items are present in all packages.
Package type
Meta name : PKG_TYPE
Possible values : DataOntap, Service
Date and Timestamp
Meta name : PKG_DTS
Possible value : Day Mmm dd hh:mm:ss yyyy GMT
CPU architecture
Meta name : CPU_ARCH
Possible values : pc, mips
ONTAP section meta items are only in ONTAP packages.
Data ONTAP release
Meta name : ONTAP_RLS
Possible value : Release version: date & time stamp
File system version
Meta name : FILESYS_VER
Possible value : integer
NVLOG version
Meta name : NVLOG_VER
Possible value : integer
Diagnostics section meta items are only in Service packages.
Diagnostics version
Meta name : DIAG_VER
Possible value : Diagnostic Monitor v-version
Diagnostics release
Meta name : DIAG_RLS
Possible value : Release Diagnostic_version: date stamp
Firmware items are only in Service packages and are of two types, Common Firmware Environment (CFE) and Open Firmware (OFW).
CFE version
Meta name : CFE_VER
Possible value : CFE-p.q.r
OFW version
Meta name : OFW_VER
Possible value : m.n

Inputs

  • package-location => string

    • Location of the package to be scanned for metadata
    Possible values:
    repository
    package directory on Filer disk
    cf-pri-part
    Compact Flash primary partition

Outputs

storage_adapter_enable_adapter

[Family: ontap-classic]

Enables specified host adapter. I/O traffic can be issued on the adapter.

Inputs

  • adapter-name => string

    • The adapter name is either a slot number, or, if a port letter is also present, a slot number and port letter concatenated into a single name -- for example, "8a" or "11b". If adapter-name is not supplied, the command will return EAPIMISSINGARGUMENT.

Outputs

  • None

storage_adapter_get_adapter_info

[Family: ontap-classic]

Display the information about a specified host adapter. The information is displayed base on the controller interface type. ATA, Parallel SCSI, SAS, FC.

Inputs

  • adapter-name => string

    • The adapter name is either a slot number, or, if a port letter is also presented, a slot number and port letter concatenated into a single name -- for example, "8a" or "11b".

Outputs

storage_adapter_get_adapter_list

[Family: ontap-classic]

Get the list of adapters present on this system.

Inputs

  • None

Outputs

  • adapter-list => adapter-name-elem[]

    • The adapter-list is a list of the names of adapters on this system. These adapter names can be used by other commands, including storage-adapter-enable-adapter and storage-adapter-disable-adapter.

storage_adapter_modify

[Family: ontap-classic]

Modify the adapter state.

Inputs

  • adapter-state => string

    • The new requested state for the adapter, Possible values:
    • "online" - enable the specified port.
    • "offline" - disable the specified port.
  • force-offline => boolean, optional

    • When true, this allows disabling a port when the port is busy, i.e. has pending or active commands. Default is false. This field is allowed, only when the adapter-state is "offline".
  • port-name => string

    • The port name is a slot number and port letter concatenated into a single name -- for example, "8a" or "11b".

Outputs

  • None

storage_array_get_config_summary

[Family: ontap-classic]

Generates a high level summary of array LUN pathing (connectivity) information.

Inputs

  • ownership-type => string, optional

    • Option that allows the user to select which array LUNs are displayed. Valid values for ownership-type are 'assigned', 'unassigned' and 'all'. If ownership-type is set to 'assigned' only assigned array LUNs are displayed. If ownership-type is set to 'unassigned' only unassigned array LUNs are displayed. If ownership-type is set to 'all', all array LUNs are displayed. Default: 'all'.

Outputs

storage_array_list_info

[Family: ontap-classic]

Retrieves a list of all array profiles known to the controller.

Inputs

Outputs

storage_array_luns_list_info

[Family: ontap-classic]

Generate a list of array LUNs associated with the named array.

Inputs

  • ownership-type => string, optional

    • Option that allows the user to select which array LUNs are displayed. Valid values for ownership-type are 'assigned', 'unassigned' and 'all'. If ownership-type is set to 'assigned' only assigned array LUNs are displayed. If ownership-type is set to 'unassigned' only unassigned array LUNs are displayed. If ownership-type is set to 'all', all array LUNs are displayed. Default: 'all'.

Outputs

storage_array_ports_list_info

[Family: ontap-classic]

generate a list of online array ports and their associated arrays

Inputs

  • array-name => string, optional

    • When supplied, only port records for the named array are returned. (28 chars)

Outputs

storage_array_update

[Family: ontap-classic]

Update an array profile with new or changed information. Arguments passed in will be used to update the profile. Arguments not passed will keep their existing values.

Inputs

  • array-name => string

    • 28 character string, no spaces The name of the array profile to update.

Outputs

storage_disk_fw_status

[Family: ontap-classic]

Based on input, displays: The number of disks waiting for firmware update, Average firmware update duration per disk in seconds, Estimate for background firmware download completion in minutes, or Name of disk that cannot be updated.

Inputs

  • status-type => string

    • Possible values: 1. time-estimate 2. waiting-disks 3. average-time 4. pending-disks

Outputs

storage_disk_get_iter

[Family: ontap-classic, vfiler]

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

  • max-records => integer, optional

    • The maximum number of records to return to the caller per iteration. The default is 2000 for the Data ONTAP Cluster- Mode and 200 for other Data ONTAP 7-mode and D-blade calls. If the total number of records exceeds either the 'max-records' supplied, or the number the system is capable of returning at one time, then storage-disk-get-iter must be called multiple times to get all the records. The 'num-records' output field informs the caller how many records are returned by a single iterative call to storage-disk-get-iter.
  • tag => string, optional

    • This indicates where to continue iteration. A first invocation would normally omit this, to indicate to start iteration with the first disk. If multiple invocations are required to fetch all disk records, then each successive call would set 'tag' to the 'next-tag' value from the prior invocation. If an invalid value is specified, then EINVAIDINPUTERROR is returned.

Outputs

  • next-tag => string, optional

    • An opaque string indicating that there are more records to fetch. If this field is returned, then the API must be called again with the 'tag' parameter set to this 'next-tag' value, to continue fetching additional records from this point. Omitted if there are no more records to fetch.
  • num-records => integer

    • The number of records returned in this call. This is guaranteed to be less than or equal to the minimum of 'max-records' and 2000.

storage_initiator_balance

[Family: ontap-classic]

Balances primary/secondary array LUN paths across available initiator ports based on I/O load.

Inputs

  • None

Outputs

  • None

storage_initiator_disk_path_list_info

[Family: ontap-classic]

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 Device

Inputs

  • disk-name => string, optional

    • The name of the disk to list path information for. If not supplied all paths to all attached targets are returned.

Outputs

storage_initiator_errors_list_info

[Family: ontap-classic]

Lists all known disk/configuration errors associated with an array or shelves acting like array.

Inputs

  • array-name => string, optional

    • The name of the array to list error information for. (28 chars)
  • disk-name => string, optional

    • The name of the disk or array lun to list error information for. If not specified, all errors for all disks/array LUNs will be returned.

Outputs

storage_initiator_get_load

[Family: ontap-classic]

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

storage_initiator_path_list_info

[Family: ontap-classic]

Returns information and statistics on all known paths to back end storage.

Inputs

  • None

Outputs

storage_initiator_path_quiesce

[Family: ontap-classic]

Quiesces an array LUN on a path. A quiesced array LUN will not be sent I/O on the specified path.

Inputs

  • initiator => string

    • The initiator port of the path that I/O will be quiesced on.
  • target-wwpn => string

    • The array target port of the path that I/O will be quiesced on. World wide port number has to be specified without colons.

Outputs

  • None

storage_initiator_path_resume

[Family: ontap-classic]

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

  • initiator => string

    • The initiator port of the path that I/O will be resumed to.
  • lun-number => integer

    • LU number. Range: [0..65535]
  • target-wwpn => string

    • The array target port of the path that I/O will be resumed to. World wide port number has to be specified without colons.

Outputs

  • None

system_api_get_elements

[Family: ontap-classic, vfiler]

get elements for specified apis

Inputs

Outputs

system_api_list

[Family: ontap-classic, vfiler]

get list of apis. This returns the names only - to get the parameter info, use system-api-get-elements

Inputs

  • None

Outputs

system_api_list_types

[Family: ontap-classic, vfiler]

get list and description of typedefs

Inputs

  • None

Outputs

system_available_replication_transfers

[Family: ontap-classic, vfiler]

Provide a mechanism to calculate the number of replication operations that could be started. Returns the number of replication operations that could be started for each replication type. Another output is the maximum number of transfers for each replication type.

Inputs

  • None

Outputs

system_get_info

[Family: ontap-classic, vfiler]

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.

Inputs

  • None

Outputs

system_get_ontapi_version

[Family: ontap-classic, vfiler]

Obtain the current ONTAPI major and minor versions.

Inputs

  • None

Outputs

system_get_vendor_info

[Family: ontap-classic, vfiler]

Obtain the Data ONTAP vendor information.

Inputs

  • None

Outputs

  • ontap-oid-prefix => string

    • Vendor's starting SNMP OID prefix for Data ONTAP. The suffix that follows is the storage system MIB. For example, ".1.3.6.1.4.1.789". To obtain the filer's model name, one would concatenate the OID prefix and ".1.1.5.0" from the storage system MIB.

system_get_version

[Family: ontap-classic, vfiler]

Obtain the Data ONTAP version.

Inputs

  • None

Outputs

  • is-clustered => boolean

    • If true, indicates Data ONTAP Cluster-Mode, else Data ONTAP 7-Mode. This field is available in Data ONTAP 8.1 or later.
  • version => string

    • Current Data ONTAP version running on the appliance. If the cluster is currently operating with more than one version of Data ONTAP, then the lowest version of all is returned.

ucm_adapter_list_info

[Family: ontap-classic]

Report configuration for all available adapters under Unified Connect Management (UCM) framework.

Inputs

Outputs

ucm_adapter_modify

[Family: ontap-classic]

Modify configuration of an adapter under the Unified Connect Management (UCM) framework, including the mode and/or the FC-4 type.

Inputs

  • adapter-name => string

    • Slot name of adapter (e.g 0e)
  • fc4-type => ucm-type, optional

    • Modify the FC-4 type of the adapter. Possible values:
    • "initiator" - change FC-4 type to Initiator
    • "target" - change FC-4 type to Target
  • mode => ucm-mode, optional

    • Modify the mode of the adapter. Possible values:
    • "fc" - change mode to "Fibre Channel"
    • "cna" - change mode to "CNA"

Outputs

  • None

useradmin_domainuser_add

[Family: ontap-classic, vfiler]

Adds a nonlocal user into a group or groups. The user can be added as a SID or as domain\username. This API is only used in a windows environment.

Inputs

  • user-identifier => string

    • Name of the user in domain\username format. This can also be a SID (Windows security identifier) describing a user. A SID has the format S-1-5-21-int-int-int-rid.

Outputs

  • None

useradmin_domainuser_delete

[Family: ontap-classic, vfiler]

Removes a nonlocal user from a group or groups. The user can be removed as a SID or as domain\username. This API is only used in a windows environment.

Inputs

  • user-identifier => string

    • Name of the user in domain\username format. This can also be a SID (Windows security identifier) describing a user. A SID has the format S-1-5-21-int-int-int-rid.

Outputs

  • None

useradmin_domainuser_list

[Family: ontap-classic, vfiler]

List all of the SIDs in a given group. This API is only used in a windows environment.

Inputs

Outputs

useradmin_group_add

[Family: ontap-classic, vfiler]

Adds a group given the information provided.

Inputs

Outputs

  • None

useradmin_group_delete

[Family: ontap-classic, vfiler]

Deletes a group.

Inputs

  • group-name => string

    • The name of the group to be deleted.

Outputs

  • None

useradmin_group_list

[Family: ontap-classic, vfiler]

Lists full information for all groups on the system.

Inputs

  • verbose => boolean, optional

    • Default is false. If set to true, then the allowed capabilities are placed into the group-info structure. Depending on number of groups and roles, this operation may take a long time.

Outputs

useradmin_group_modify

[Family: ontap-classic, vfiler]

Modifies a group given the information provided.

Inputs

  • new-group-name => string, optional

    • New group name for this group. This is used to rename the group specified in useradmin-group. If this value is invalid, useradmin-group-modify fails without changing anything. The value is optional, and if not provided, the group name will be unchanged.
  • useradmin-group => useradmin-group-info

    • A group must have a name. If one or more roless and/or a comment is provided, the group is modified accordingly. All other fields are ignored.

Outputs

  • None

useradmin_role_add

[Family: ontap-classic, vfiler]

Adds a role given the information provided.

Inputs

  • useradmin-role => useradmin-role-info

    • New role information. A role must have a name and at least one allowed capability. A role-info comment is also allowed. All other fields are ignored.

Outputs

  • None

useradmin_role_delete

[Family: ontap-classic, vfiler]

Deletes a role.

Inputs

Outputs

  • None

useradmin_role_list

[Family: ontap-classic, vfiler]

Lists full information for all roles on the system.

Inputs

Outputs

useradmin_role_modify

[Family: ontap-classic, vfiler]

Modifies a role given the information provided.

Inputs

  • useradmin-role => useradmin-role-info

    • A role must have a name. If one or more capabilities and/or a comment is provided, the role is modified accordingly.

Outputs

  • None

useradmin_user_add

[Family: ontap-classic, vfiler]

Adds a user given the information provided.

Inputs

  • password => string

    • Password for the user. Please see documentation for constraints on the password.

Outputs

  • None

useradmin_user_delete

[Family: ontap-classic, vfiler]

Deletes a user.

Inputs

  • user-name => string

    • The name of the user to be deleted.

Outputs

  • None

useradmin_user_list

[Family: ontap-classic, vfiler]

Lists information for all administrative users on the system with the exception of root and snmp.

Inputs

  • group-name => string, optional

    • List only the users which are a part of this group. This option must be left empty if the option "user-name" contains a value.
  • user-name => string, optional

    • List only the information associated with this user. This option must be left empty if the option "group-name" contains a value.
  • verbose => boolean, optional

    • Default is false. If set to true, then the allowed capabilities are placed into the user-info structure. Depending on number of users, groups, and roles; this operation may take a long time.

Outputs

useradmin_user_modify

[Family: ontap-classic, vfiler]

Modifies a user given the information provided.

Inputs

  • useradmin-user => useradmin-user-info

    • A user must have a name. If one or more groups a comment and/or a full-name is provided, the user is modified accordingly. All other fields are ignored.

Outputs

  • None

useradmin_user_modify_password

[Family: ontap-classic, vfiler]

Changes the password of a specified user.

Inputs

  • old-password => string, optional

    • Current password for the user. A user with the capability 'security-passwd-change-others' and at least the same capabilities as the user being changed, does not need to enter the current password in order to change it to a new one.
  • user-name => string

    • The user who's password should be changed.

Outputs

  • None

vfiler_add_ipaddress

Add an ipaddress to a vfiler

Inputs

  • ipaddress => string

    • Ipaddress to be added, in dotted-decimal format (for example, "192.168.11.12"). If IPv6 address then, it should be in the format a:b:c:d:e:f:g:h (for example, fd20:81be:b255:4213:2a0:98ff:fe07:609b).

Outputs

  • None

vfiler_add_storage

Add a storage unit to a vfiler

Inputs

  • vfiler => string

    • Name of the vfiler.

Outputs

  • None

vfiler_allow_protocol

Allow a protocol on a specified vfiler

Inputs

  • protocol => string

    • Name of the protocol to be allowed. Possible values are: nfs, cifs, rsh.
  • vfiler => string

    • Name of the vfiler.

Outputs

  • None

vfiler_create

Create a new vfiler. The inputs specify a list of storage units, which are qtree or volume paths.

Inputs

  • ip-addresses => ip-address[]

    • null
  • ipspace => string, optional

    • Name of the ipspace.
  • vfiler => string

    • Name of the vfiler.

Outputs

  • None

vfiler_destroy

Destroy a vfiler

Inputs

  • vfiler => string

    • Name of the vfiler.

Outputs

  • None

vfiler_disallow_protocol

Disallow a protocol on a specified vfiler

Inputs

  • protocol => string

    • Name of the protocol to be disallowed. Possible values are: nfs, cifs, rsh.
  • vfiler => string

    • Name of the vfiler.

Outputs

  • None

vfiler_dr_activate

Stop the remote vfiler and activate the disaster recovery vfiler on the local machine.

Inputs

Outputs

  • None

vfiler_dr_configure

Create a new vfiler disaster recovery relationship. The inputs specify the information for the remote vfiler/filer to connect to and configuration information for the vfiler to use upon activation.

Inputs

  • ipaddrs => ipaddr-info[]

    • Contains a list of all the IP address (and associated information) which should be bound to the vfiler at the destination
  • remote-vfiler-location => vfiler-location

    • Name of the remote vfiler and the remote filer hosting it

Outputs

  • None

vfiler_dr_delete

delete the vfiler disaster recovery relationship on this machine.

Inputs

  • remote-vfiler-location => vfiler-location

    • Name of the remote vfiler and the remote filer hosting it
  • use-secure-command-channel => boolean, optional

    • Set true to use the secure command channel while communicating with remote filer. Default is false.

Outputs

  • None

vfiler_dr_get_status

Get the status of the disaster recovery relationship with the given remote vfiler and filer.

Inputs

  • remote-vfiler-location => vfiler-location

    • Name of the remote vfiler and the remote filer hosting it

Outputs

vfiler_dr_resync

move a vfiler which has been migrated by vfiler disaster recovery to back to its original filer

Inputs

  • alternate-src-dst => hostname-pair, optional

    • Alternate hostnames or IP addresses for redundancy
  • is-synchronous => boolean

    • Set true to use synchronous snapmirror
  • remote-authentication-info => authentication-info, optional

    • Login name and password to use on the remote filer. Either this or encrypted-authentication-info must be present.
  • remote-encrypted-authentication-info => encrypted-authentication-info, optional

    • Encrypted login name and password to be used on remote filer. Either this or authentication-info must be present.
  • remote-vfiler-location => vfiler-location

    • Name of the remote vfiler and the remote filer hosting it
  • use-secure-command-channel => boolean, optional

    • Set true to use the secure command channel while communicating with remote filer. Default is false.

Outputs

  • None

vfiler_get_allowed_protocols

Get the protocols allowed for a vfiler

Inputs

  • vfiler => string

    • Name of the vfiler.

Outputs

vfiler_get_disallowed_protocols

Get the protocols disallowed for a vfiler

Inputs

  • vfiler => string

    • Name of the vfiler.

Outputs

vfiler_get_status

Get the status of a vfiler

Inputs

  • vfiler => string

    • Name of the vfiler.

Outputs

  • status => string

    • Status of the vfiler. Possible values: running, stopped, inconsistent or defunct.

vfiler_list_info

[Family: ontap-classic, vfiler]

Retrieve information about all vfilers. An optional vfiler parameter lets you retrive information about a single vfiler.

Inputs

  • vfiler => string, optional

    • Name of the vfiler whose information you want to retrieve. If this parameter is not provided and this zapi is run on pfiler then, information about all vfilers will be retrieved. This parameter is not provided and if you are running zapi on vfiler then information about that vfiler only will be retrieved.

Outputs

vfiler_migrate

Migrate a vfiler on remote filer to this filer. The vfiler facility must be licensed on the remote filer and on the local filer. Other requirements are detailed in the migration-method parameter documentation below.

Migration may fail for a number of reasons. For example, the vfiler facility may not be licensed or the vfiler may not be in a state suitable for migration. In these cases EVFILEROPNOTALLOWED will be returned, along with a descriptive reason string.

Inputs

  • force => boolean, optional

    • If this value is true, the vfiler should be migrated even under various conditions which would normally prevent a migration are encountered. See na_vfiler(1) for details.
  • ipaddrs => ipaddr-info[]

    • Contains a list of all the IP address (and associated information) which should be bound to the vfiler at the destination
  • migration-method => string, optional

    • Name of the vfiler migration method. Possible values: snapmirror, nocopy. Defaults to "snapmirror".

    Snapmirror: SnapMirror must be licensed on the local and remote filer.

    Nocopy:If the force parameter is not set to true, the vfiler will not be migrated if data belonging to belonging to the source vfiler is part of a SnapMirror or SnapVault relationship, if the source filer file system version is not the same as the local file system version, if NFS, CIFS, DAFS, or iSCSI are allowed on the source vfiler but not licensed locally, or if clustering is licensed on the source filer but not licensed locally. The "force" parameter overrides these checks. However, even if the "force" parameter is supplied the vfiler will not be migrated if the source filer's file system version is greater than the local filer's file system version.

  • remote-filer => string

    • Name of the filer on which the vfiler resides. This may also take the form of an IP address.
  • use-secure-command-channel => boolean, optional

    • Set true to use the secure command channel while communicating with remote filer. Default is false.
  • vfiler => string

    • Name of the vfiler being migrated. There must not be a vfiler with the same name on the local filer. "vfiler0" is not allowed, as the default vfiler may not be migrated.

Outputs

  • None

vfiler_migrate_cancel

cancels the vfiler migration.

Inputs

  • force => boolean, optional

    • If this value is true, the vfiler migration should be canceled even under various conditions which would normally prevent it. Default is FALSE.
  • remote-vfiler-location => vfiler-location

    • Name of the remote vfiler and the remote filer hosting it
  • use-secure-command-channel => boolean, optional

    • Set true to use the secure command channel while communicating with remote filer. Default is false.

Outputs

  • None

vfiler_migrate_complete

Completes the migration by stopping the remote vfiler and activating the vfiler on the local machine. The source vfiler unit will be destroyed after migration is complete.

Inputs

  • migrate-transparent => boolean, optional

    • If this value is true, then the vfiler will migrate non-disruptively. This kind of migration will take place within 120 seconds using semi-sync VSM relationship. Default is false.
  • remote-authentication-info => authentication-info, optional

    • Login name and password to use on the remote filer. Use this option if the password has been changed at the remote filer after configuring migrate start.
  • remote-vfiler-location => vfiler-location

    • Name of the remote vfiler and the remote filer hosting it
  • use-secure-command-channel => boolean, optional

    • Set true to use the secure command channel while communicating with remote filer. Default is false.

Outputs

  • None

vfiler_migrate_start

Starts vfiler unit migration from remote filer to this filer. The data and remote vfiler configuration are migrated as a vfiler unit. It starts SnapMirror relationships between source vfiler volumes and destination vfiler volumes. The ZAPI vfiler-migrate-complete, when run completes the vfiler migration. The following are requirements for vfiler migration 1.The vfiler facility must be licensed on the remote filer and on the local filer. 2.There should not be a local vfiler with the same name as the source vfiler. 3.The local filer should have enough storage space to hold the source vFiler unit's volumes. 4.The volumes to be used by the destination vFiler unit should exist and should not be used by any other non defualt vFiler unit. 5.The destination vFiler unit must have the same path names to the volumes that remote vFiler unit is holding. 6.There should not be any qtrees in the destination volumes whose names match those of qtrees in the source volumes. 7.SnapMirror facility must be licensed on the remote filer and on the local filer. The destination vfiler will have same DNS, NIS and IPSpace configuration as the source vfiler after migration. If the destination vfiler is in different domain or in different subnet then user might need to run setup on destination vfiler.

Migration may fail for a number of reasons. For example, the vfiler facility may not be licensed or the vfiler may not be in a state suitable for migration. In these cases EVFILEROPNOTALLOWED will be returned, along with a descriptive reason string.

Inputs

  • ipaddrs => ipaddr-info[]

    • Contains a list of all the IP addresses (and associated information) which should be bound to the vfiler at the destination
  • remote-authentication-info => authentication-info

    • Login name and password to use on the remote filer
  • remote-vfiler-location => vfiler-location

    • Name of the vfiler being migrated.
  • snapmirror-not-initialize => boolean, optional

    • Set true avoid snapmirror initialization during migrate start Default is false.

Outputs

  • None

vfiler_migrate_status

Get the status of the vfiler migrate relationship with the given remote vfiler and filer.

Inputs

  • remote-vfiler-location => vfiler-location

    • Name of the remote vfiler and the remote filer hosting it

Outputs

vfiler_remove_ipaddress

Remove an ipaddress from a vfiler

Inputs

  • ipaddress => string

    • Ipaddress to be removed, in dotted-decimal format (for example, "192.168.11.12"). If IPv6 address then, it should be in the format a:b:c:d:e:f:g:h (for example, fd20:81be:b255:4213:2a0:98ff:fe07:609b).
  • vfiler => string

    • Name of the vfiler.

Outputs

  • None

vfiler_remove_storage

Remove a storage unit from a vfiler

Inputs

  • storage-path => string

    • Storage-path to be removed, in the form "/vol/<volume>/..."
  • vfiler => string

    • Name of the vfiler.

Outputs

  • None

vfiler_setup

Setup services for a vfiler that has been already created. At least one of the optional arguments must be specified. This ZAPI will rewrite the /etc/exports, /etc/hosts, /etc/hosts.equiv, /etc/nsswitch.conf and /etc/resolv.conf files, saving the original contents of these files in .bak files (e.g. /etc/exports.bak).

Inputs

  • vfiler => string

    • Name of the vfiler that you want to setup.

Outputs

  • None

vfiler_start

Start a stopped vfiler. This operation is synchronous.

Inputs

  • vfiler => string

    • Name of the vfiler.

Outputs

  • None

vfiler_stop

Stop a started vfiler

Inputs

  • vfiler => string

    • Name of the vfiler.

Outputs

  • None

vmservices_vsphere_credential_check

[Family: ontap-classic]

Check vSphere credentials by attempting to login to the vSphere server.

The error return values may be interpreted as follows: EOPNOTSUPPORTED This was invoked on a non-VSA platform. EINVALIDINPUTERROR Missing username or password. EAPIAUTHENTICATION vSphere server authentication failed. EHOSTNOTFOUND could not resolve server name with DNS EONTAPI_ECONNREFUSED could not connect to server EINTERNALERROR internal error in underlying implementation

Inputs

  • None

Outputs

  • None

vmservices_vsphere_credential_get

[Family: ontap-classic]

Reports the currently configured vSphere server and username.

The error return values may be interpreted as follows: EOPNOTSUPPORTED This was invoked on a non-VSA platform. EINTERNALERROR internal error in underlying implementation

Inputs

  • None

Outputs

  • server => string, optional

    • The currently configured vSphere server, if any. It can be a hostname if DNS is enabled, otherwise it must be an IP address.

vmservices_vsphere_credential_modify

[Family: ontap-classic]

Modify or set initial value for vSphere server, user, and/or password.

The error return values may be interpreted as follows: EOPNOTSUPPORTED This was invoked on a non-VSA platform. EINVALIDINPUTERROR argument(s) too large EINTERNALERROR internal error in underlying implementation

Inputs

  • password => string, optional, encrypted

    • Password for the vSphere user. If not specified, the configured password (if any) is not changed.
  • server => string, optional

    • vSphere server managing this VSA instance: either the ESX host itself or its managing vCenter server. It can be a hostname if DNS is enabled, otherwise it must be an IP address. If not specified, the configured server (if any) is not changed.
  • username => string, optional

    • A vSphere username (only "read-only" access required) to be used when connecting to the vSphere server. If not specified, the configured username (if any) is not changed.

Outputs

  • None

volume_add

Adds disks to the given traditional volume. Specify the disks to add in the same way as for 'volume-create'. Disks cannot be added to a mirrored traditional volume if one of its plexes is offline. Addition of the specified disk(s) may not have completed by the time the API returns. Use 'volume-list-info' to query the traditional volume's status, and thus determine when the disk addition is complete. It is not possible to add disks directly to a flexible volume; if that is the goal, then consider using 'volume-container' to find the flexible volume's containing aggregate, then use 'aggr-add' to add the desired disks there (which, of course, will make their storage available to all flexible volumes contained in that same aggregate).

Inputs

  • disk-count => integer, optional

    • Number of disks to add, including parity disks. The disks will come from the spare pool. The smallest disks in the spare pool join the volume first, unless "disk-size" is specified as an argument. Range : [0..2^31-1].
  • disk-size => integer, optional

    • The disk size in 4KB blocks. Disks that are within approximately 20% of the specified size are selected for use in the traditional volume. If neither the "disk-size" nor the "disk-size-with-unit" is specified, the smallest disks in the spare pool join the traditional volume first. This option is ignored if a specific list of disks to use is provided via the "disks" argument. Range : [0..2^31-1]. You must only use one of either "disk-size" or "disk-size-with-unit" parameters. If both appear, an error message will be returned.
  • disk-size-with-unit => string, optional

    • The disk size in specified unit. It is a positive integer number followed by unit of "T", "G", "M" or "K". This option is ignored if a specific list of disks to use is provided via the "disks" argument. You must only use one of either "disk-size" or "disk-size-with-unit" parameters. If both appear, an error message will be returned.
  • disks => disk-info[], optional

    • Specific list of disks to add to the traditional volume. If the traditional volume is mirrored and a specific disk list is supplied, another list ("mirror-disks") must also be supplied with the same number of disks.
  • force => boolean, optional

    • Disks in a plex are not permitted to span spare spare pools. This behavior is overridden with this option when it is set to "true".
  • mirror-disks => disk-info[], optional

    • Specific list of mirror disks needed to accompany the list in the "disks" argument. This list must contain the same number of disks specified in "disks".
  • raid-group => string, optional

    • Specifies the RAID group (for example, 'rg0') to which the indicated disks are to be added. When a RAID group other than the last RAID group is specified, the traditional volume can no longer be reverted to a version of ONTAP prior to 6.2. In such a case, the "force" option must be specified as well. By default, the filer fills up one RAID group with disks before starting another RAID group. Suppose a traditional volume currently has one RAID group of 12 disks and its RAID group size is 14. If you add 5 disks to this traditional volume, it will have one RAID group with 14 disks and another RAID group with 3 disks. The filer does not evenly distribute disks among RAID groups.
  • volume => string

    • Name of the traditional volume to which disks are to be added.

Outputs

  • bad-disks => disk-info[], optional

    • List of disks that were not added. This is only returned if there are bad disks.

volume_autosize_get

[Family: ontap-classic, vfiler]

Given the name of a flexible volume, get the autosize settings. This API is not supported for Infinite Volumes.

Inputs

  • volume => string

    • The name of the flexible volume for which we want to get autosize.

Outputs

  • is-enabled => boolean

    • This element is deprecated in Data ONTAP 8.2 and later. Please use autosize-mode instead. When this parameter is 'true', the 'grow' autosize mode is in effect, while 'false' means that the autosize mode to 'off'.
  • mode => string, optional

    • The operating mode of autosize. Valid values are "grow", "grow_shrink", and "off".

volume_autosize_set

[Family: ontap-classic]

Given the name of a flexible volume, set the autosize settings. This API is not supported for Infinite Volumes.

Inputs

  • grow-threshold-percent => integer, optional

    • Specifies the percentage of the flexible volume's capacity at which autogrow is initiated. The default grow threshold varies from 85% to 98%, depending on the volume size. It is an error for the grow threshold to be less than or equal to the shrink threshold. Range : [0..100]
  • increment-size => string, optional

    • Specify the flexible volume's increment size using the following format < number > [k|m|g|t] The amount is the absolute size to set. The optional trailing 'k', 'm', 'g', and 't' indicates the desired units, namely 'kilobytes', 'megabytes', 'gigabytes', and 'terabytes' (respectively). If the trailing unit character doesn't appear, then < number > is interpreted as the number of bytes desired. The default value of increment size is 5%.
  • is-enabled => boolean, optional

    • This element is deprecated in Data ONTAP 8.2 and later. Please use autosize-mode instead. Setting this parameter to 'true' enables the 'grow' mode, while setting it to 'false' disables autosize and sets the autosize mode to 'off'. The default value is 'false'.
  • maximum-size => string, optional

    • Specify the flexible volume's maximum allowed size using the following format < number > [k|m|g|t] The amount is the absolute size to set. The optional trailing 'k', 'm', 'g', and 't' indicates the desired units, namely 'kilobytes', 'megabytes', 'gigabytes', and 'terabytes' (respectively). If the trailing unit character doesn't appear, then < number > is interpreted as the number of bytes desired. The default value is 20% greater than the volume size at the time autosize was enabled. It is an error for the maximum volume size to be less than the current volume size. It is also an error for the maximum size to be less than or equal to the minimum size.
  • minimum-size => string, optional

    • Specify the flexible volume's minimum allowed size using the following format < number > [k|m|g|t] The amount is the absolute size to set. The optional trailing 'k', 'm', 'g', and 't' indicates the desired units, namely 'kilobytes', 'megabytes', 'gigabytes', and 'terabytes' (respectively). If the trailing unit character doesn't appear, then < number > is interpreted as the number of bytes desired. The default value is the size of the volume at the time the 'grow_shrink' mode was enabled. It is an error for the minimum size to be greater than or equal to the maximum size.
  • mode => string, optional

    • Specify the flexible volume's autosize mode of operation. Valid values are "grow", "grow_shrink", and "off". The default mode is "off".
  • reset => boolean, optional

    • Sets the values of is-enabled, maximum size, increment-size, minimum-size, grow-threshold-percent, shrink-threshold-percent and mode to their defaults.
  • shrink-threshold-percent => integer, optional

    • Specifies the percentage of the flexible volume's capacity at which autoshrink is initiated. The default shrink theshold is 50%. It is an error for the shrink threshold to be greater than or equal to the grow threshold. Range : [0..100]
  • volume => string

    • The name of the flexible volume for which we want to set autosize.

Outputs

  • None

volume_charmap_get

[Family: ontap-classic, vfiler]

Return charmap information for a specified volume.

Inputs

  • volume => string

    • Name of the volume on which to list the charmap information.

Outputs

volume_charmap_set

[Family: ontap-classic, vfiler]

Associate a charmap description with a specified volume.

Inputs

  • charmap => string, optional

    • Description of the character mapping to be done for this volume. This mapping is to allow CIFS clients to use NFS file names that would otherwise result in invalid CIFS names. The values are comma-separated pairs of hex character mappings. The A-F hex values can be in upper or lower case, and the values do not have to be padded. Example: "5c:f2e1,3c:b6,3e:ae,7C:394". If a value is not passed, any existing charmap will be removed.
  • volume => string

    • Name of the volume with which the charmap is to be associated.

Outputs

  • None

volume_clone_create

[Family: ontap-classic, vfiler]

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

  • force-worm-clone => boolean, optional

    • If set to 'true', forces the creation of clone on a worm volume. If set to 'false', clone creation on any worm volume will fail, because clones of worm volumes are not deletable until all the inherited worm files on newly created clone have expired. Default value is false.
  • parent-snapshot => string, optional

    • Name of the snapshot within 'parent-volume' that is to serve as the parent snapshot for the clone. If not provided, the filer will create a new snapshot named 'clone_parent_' (using a freshy-generated UUID) in 'parent-volume' for this purpose.
  • qos-policy-group-name => string, optional

    • The QoS Policy Group Name that is to be associated with this FlexClone volume in order to enforce Service Level Objectives (SLO). If you do not assign a QoS policy group to a volume, the system will not monitor and control the traffic to it. Note that "none" is a reserved keyword used to remove the association of a storage object to a QoS policy group. Specifying "none" as a QoS policy group in this command would have no effect.
  • space-reserve => string, optional

    • Specifies the type of volume guarantee for the clone. Possible values: none, file, volume. If this argument is not provided, then guarantee type is inherited from parent volume.
  • volume => string

    • Desired name of the clone.
  • volume-type => string, optional

    • The type of the volume to be created. Possible values:
    • "rw" - read-write volume (default setting),
    • "dp" - data-protection volume
    If not provided, the filer will assume the default value i.e. "rw" volume. Creation of data-protection volume clone is only allowed from parent-volume which is paloma logical DP volume.

Outputs

  • None

volume_clone_split_estimate

[Family: ontap-classic, vfiler]

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

  • volume => string

    • The name of the clone whose split usage is being estimated.

Outputs

volume_clone_split_start

[Family: ontap-classic, vfiler]

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

  • volume => string

    • Name of the clone that we want split off from its parent volume and snapshot.

Outputs

  • None

volume_clone_split_status

[Family: ontap-classic, vfiler]

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

  • volume => string, optional

    • The name of the clone being split off from its parent volume and snapshot for which we want status.

Outputs

volume_clone_split_stop

[Family: ontap-classic, vfiler]

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

  • volume => string

    • The name of the clone for which we want to stop the process of being split off from its parent volume and snapshot.

Outputs

  • None

volume_container

[Family: ontap-classic, vfiler]

Return the name of the containing aggregate for the named flexible volume.

Inputs

  • volume => string

    • The name of the flexible volume for which we want the containing aggregate.

Outputs

volume_create

[Family: ontap-classic]

Create a volume.

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

  • constituent-role => string, optional

    • This field specifies the role of a constituent within an Infinite Volume. This field is only supported for Infinite Volume constituents and this API will fail if no value is passed for an Infinite Volume constituent.

    Possible values:

    • 'namespace' ... namespace constituent,
    • 'data' ... data constituent,
    • 'ns_mirror' ... namespace mirror constituent
  • containing-aggr-name => string, optional

    • Flexible volumes only. The name of the aggregate in which to create the new flexible volume. If provided, this argument must be accompanied by the "size" parameter described below.

    This input is required for creating a Cluster-Mode volume.

  • disk-count => integer, optional

    • Traditional volumes only. Number of disks to place into the new traditional volume, including the parity disks. The disks in this newly-created traditional volume come from the spare disk pool. The smallest disks in this pool join the traditional volume first, unless the "disk-size" argument is specified. Either "disk-count" or "disks" must be supplied for traditional volumes. Range [0..2^31-1].
  • disk-size => integer, optional

    • Traditional volumes only. Disk size in 4KB blocks. Disks that are within 20% of the specified size will be selected for use in the traditional volume. If neither "disk-size" nor "disk-size-with-unit" is specified, existing groups are appended with disks that are the best match for the largest disk in the group. When starting new groups, the smallest disks are selected first. This option is ignored if a specific list of disks to use is specified through the "disks" parameter. Range [0..2^31-1]. You must only use one of either "disk-size" or "disk-size-with-unit" parameters. If both appear, an error message will be returned.
  • disk-size-with-unit => string, optional

    • Traditional volumes only. Disk size in the specified unit. It is a positive integer number followed by unit of "T", "G", "M" or "K". This option is ignored if a specific list of disks to use is specified through the "disks" parameter. You must only use one of either "disk-size" or "disk-size-with-unit" parameters. If both appear, an error message will be returned.
  • disks => disk-info[], optional

    • Traditional volumes only. Specific list of disks to use for the new volume. If "mirrored" is set to true and a specific list of disks is supplied, the "mirror-disks" list with the same number of disks must also be supplied. Either "disk-count" or "disks" must be supplied when creating traditional volumes.
  • force => boolean, optional

    • Traditional volumes only. Disks in a plex are not normally permitted to span spare pools. This behavior is overridden with this option when it is set to "true".
  • is-mirrored => boolean, optional

    • Traditional volumes only. Specifies that the new traditional volume be mirrored (have two plexes). If set to "true", then the indicated disks will be split across the two plexes. By default, the new volume will not be mirrored.
  • is-snaplock => boolean, optional

    • Specifies the creation of a SnapLock volume. By default, is-snaplock is not specified. When is-snaplock is "true" the type of snaplock volume is determined in the following way - 1> If snaplock-type is set, create the type specified in snaplock-type (see snaplock-type for more details) 2> Otherwise, create a Snaplock enterprise volume if a Snaplock enterprise license has been installed. 3> Otherwise, create a Snaplock compliance volume. ESERVICENOTLICENSED is returned if the required Snaplock Compliance or Enterprise license is not installed. EONTAPI_EWORMNOCLOCK is returned if SnapLock Compliance Clock is not running. If you need to create a snaplock volume, the suggested method is to specify snaplock-type as "compliance" or "enterprise" and not specify is-snaplock at all. If you want to create a non-snaplock volume, the suggested method is to specify neither snaplock-type nor is-snaplock.
  • language-code => string, optional

    • Specifies the language to use for the new volume via a language code. The default language is the one used by the filer's root volume. Available language codes are:
    • 'C' ... POSIX,
    • 'ar' ... Arabic,
    • 'cs' ... Czech,
    • 'da' ... Danish,
    • 'de' ... German,
    • 'en' ... English,
    • 'en_US' ... English (US),
    • 'es' ... Spanish,
    • 'fi' ... Finnish,
    • 'fr' ... French,
    • 'he' ... Hebrew,
    • 'hr' ... Croatian,
    • 'hu' ... Hungarian,
    • 'it' ... Italian,
    • 'ja' ... Japanese euc-j*,
    • 'ja_v1' ... Japanese euc-j,
    • 'ja_JP.PCK' ... Japanese PCK (sjis)*,
    • 'ja_JP.932' ... Japanese cp932*,
    • 'ja_JP.PCK_v2' ... Japanese PCK (sjis),
    • 'ko' ... Korean,
    • 'no' ... Norwegian,
    • 'nl' ... Dutch,
    • 'pl' ... Polish,
    • 'pt' ... Portuguese,
    • 'ro' ... Romanian,
    • 'ru' ... Russian,
    • 'sk' ... Slovak,
    • 'sl' ... Slovenian,
    • 'sv' ... Swedish,
    • 'tr' ... Turkish,
    • 'zh' ... Simplified Chinese,
    • 'zh.GBK' ... Simplified Chinese (GBK),
    • 'zh_TW' ... Traditional Chinese euc-tw,
    • 'zh_TW.BIG5' ... Traditional Chinese Big 5

    To use UTF-8 as the NFS character set, append '.UTF-8' to the language code.

  • mirror-disks => disk-info[], optional

    • Traditional volumes only. List of mirror disks to use. It must contain the same number of disks specified in "disks".
  • qos-policy-group-name => string, optional

    • The QoS Policy Group Name that is to be associated with this volume in order to enforce Service Level Objectives (SLO). If you do not assign a QoS policy group to a volume, the system will not monitor and control the traffic to it. NOTE: "none" is a reserved keyword for deleting the association of the volume with a QoS policy group. Specifying "none" as a the QoS policy group during volume creation will have no effect. This parameter is not supported on Infinite Volumes.
  • raid-size => integer, optional

    • Traditional volumes only. Specifies the maximum number of disks in each RAID group in the traditional volume. The maximum value for this parameter is of raidsize is 28. The default value is platform-dependent. The valid range of values is also platform-dependent, but never wider than [2..28].
  • remote-location => string, optional

    • Specifies the remote host and volume name for the origin of the FlexCache. A FlexCache license is necessary for this option to be utilized. The default action is not to create a FlexCache Volume. Format: : Create a sparse volume as a FlexCache for the given remote host and remote volume name. Remote Host: Should be formatted as either the DNS hostname or as an IP address. Remote Volume: Should be formatted the same as a volume name. ESERVICENOTLICENSED is returned if the FlexCache service is not licensed. EINVALIDINPUT is returned if the host, or source volume is found to be invalid.
  • size => string, optional

    • Flexible volumes only. The initial size of the new flexible volume. The format to use is: < number > k|m|g|t where "k" means kilobytes, "m" means megabytes, "g" means gigabytes, and "t" means terabytes. If the trailing unit character doesn't appear, then < number > is interpreted as the number of bytes desired. If provided, this argument must be accompanied by the "containing-aggr-name" parameter described above.
  • snaplock-type => string, optional

    • Specifies the type of Snaplock volume to be created. Possible values - "compliance" or "enterprise" ESERVICENOTLICENSED is returned if the necessary Snaplock compliance or enterprise license has not been installed. EINVALIDINPUT is returned if snaplock-type has an illegal value or if is-snaplock has been set to "false". EONTAPI_EWORMNOCLOCK is returned if SnapLock Compliance Clock is not running.
  • space-reserve => string, optional

    • Specifies the type of volume guarantee the new volume will use. Possible values: none, file, volume. If this argument is not provided, the default volume guarantee type is volume.

    If this argument is not specified for the creation of constituents of an Infinite Volume that does not support storage services, the default guarantee is the guarantee of the Infinite Volume.

  • storage-service => string, optional

    • Name of the storage service with which to associate the creation of a constituent of an Infinite Volume.

    This argument is required for the creation of constituents of an Infinite Volume that supports storage services. If the storage service does not exist before creating the constituent, it will be automatically created. Clients can query for the 'is-managed-by-service' field to determine if an Infinite Volume supports storage services.

    This argument is not supported for Flexible Volumes.

  • vm-align-sector => integer, optional

    • The Virtual Machine alignment 512 byte sector number. All files created with the suffix specified in the 'vm-align-suffix' input parameter will have zero-filled <512 * 'vm-align-sector'> bytes data at the beginning so that it's actual data starts at a different offset instead of zero. This is done so that the read & writes to such files are aligned to WAFL's 4k block boundary.
  • vm-align-suffix => string, optional

    • The Virtual Machine alignment suffix. The suffix such as '.xyz' is used to identify the files which needs to be aligned. This element can only be specified if the vm-align-sector input element is also specified. See the description for 'vm-align-sector' above for more information on this.
  • volume => string, optional

    • Name of the volume to create. The volume name can contain letters, numbers, and the underscore character (_), but the first character must be a letter or an underscore. In Data ONTAP Cluster-Mode, the volume names must be unique within a Vserver. In Data ONTAP 7-mode, the volume names must be unique on a controller. For an Infinite Volume constituent, the parameter is optional; if a name is not specified, DATA ONTAP will generate the correct name based on the constituent type.
  • volume-raid-type => string, optional

    • Traditional volumes only. Specifies the type of RAID groups to use in the new traditional volume. The default is "raid4" on most platforms. Possible values: raid4, raid_dp.

Outputs

  • bad-disks => disk-info[], optional

    • Traditional volumes only. List of disks that were not added. This is only returned if there are bad disks.

volume_decompress_abort

[Family: ontap-classic, vfiler]

Abort in-progress decompression scan of data in volume.

Inputs

  • volume => string

    • Name of the volume. Ex: flex1, vol0 etc.

Outputs

  • None

volume_decompress_start

[Family: ontap-classic, vfiler]

Start decompression of data in a volume. The volume should should have compressed data and it should not have compression option enabled.

Inputs

  • volume => string

    • Name of the volume. Ex: flex1, vol0 etc.

Outputs

  • None

volume_destroy

[Family: ontap-classic, vfiler]

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

  • force => boolean, optional

    • Force the destruction of the volume even if a non-default vfiler has storage on it. Normally, the system will not destroy such a volume and will instead return EVOLUME_HAS_VFILER_STORAGE.
  • name => string

    • Name of an existing volume or plex.

Outputs

  • None

volume_footprint_list_info

[Family: ontap-classic]

Return a list of volumes and a breakdown of their data and metadata footprints in their parent aggregates. The term footprint is used to refer to the portion of aggregate used space that will be freed when the relevant volume is destroyed. This can exceed the size of the volume due to metadata. If no volume is specified, footprints are displayed for all online volumes on the filer. Note that if space footprint information for more than 20 volumes is desired, the volume-footprint-list-info-iter-* ZAPIs will be more efficient and should be used instead.

Inputs

  • volume => string, optional

    • The name of the volume for which we want status information. If not supplied, then we want status for all volumes on the filer.

Outputs

volume_footprint_list_info_iter_end

[Family: ontap-classic]

Terminate a list iteration and clean up any saved info.

Inputs

  • tag => string

    • Tag from a previous volume-footprint-list-info-iter-start.

Outputs

  • None

volume_footprint_list_info_iter_next

[Family: ontap-classic]

Continues an iteration through the list of volumes.

Inputs

  • maximum => integer

    • The maximum number of entries to retrieve.
  • tag => string

    • Tag from a previous volume-footprint-list-info-iter-start.

Outputs

  • records => integer

    • This tells you how many records are being returned from this particular call to volume-footprint-list-info-iter- next. When this value is 0, you have retrieved everything.
  • vol-footprint-infos => vol-footprint-info[]

    • List of volumes and their footprint information. See volume- footprint-list-info for a description of type vol-footprint-info.

volume_footprint_list_info_iter_start

[Family: ontap-classic]

Starts an iteration through the list of volumes.

Inputs

  • volume => string, optional

    • The name of the volume for which we want space footprint information. If not supplied, then we display space footprint for all volumes on the filer.

Outputs

  • records => integer

    • This tells you the number of items that have been saved for future retrieval with volume-footprint-list-info-iter-next.
  • tag => string

    • Tag to be used in subsequent iterations.

volume_get_filer_info

Get information on what possibilities and parameters exist for volumes on a given filer.

Inputs

  • None

Outputs

  • allowed-raidtypes => raidtype-info[]

    • List of RAID types allowed for aggregates on this filer.
  • checksum-types => string

    • Checksum types supported by this filer. The possible values:
    • "zoned" - if all aggregates are Fixed VBN,
    • "block" - if all aggregates are Block Appended,
    • "mixed" - if aggregates are mixed (Fixed VBN and Block Appended and Advanced Zoned),
    • "none" - if no aggregates have zoned or block checksums or advanced_zoned checksum (azcs) or mixed,
    • "advanced_zoned" - if all aggregates have Advanced Zoned Checksum scheme.
  • default-raidtype => string

    • Default type of RAID used to protect against disk failure in aggregates on this filer. Possible values: raid0, raid4, raid_dp.
  • disk-types => string

    • Type of disks supported by this filer. Possible values: "512", "520", "4096", "mixed", "none". "512" if all disks are 512 BPS, "520" if all disks 520 BPS "4096" if all disks 4096 BPS, "mixed" if disks are mixed 512, 520 and 4096 BPS "none" if no disks have 512 or 520 or 4096 BPS.
  • raidgroup-size => raidgroup-size-info[]

    • List of the RAID group sizing parameters for each RAID type supported on this filer.
  • root-volume => string

    • Current root volume on the filer.
  • snapshots-max => integer

    • Maximum number of snapshots available per aggregate on the filer. Range : [0..2^31-1].

volume_get_language

[Family: ontap-classic, vfiler]

Get the given volume's language mapping.

Inputs

  • volume => string

    • Name of the volume for which we want the language mapping.

Outputs

  • language => string

    • Set to the volume's language mapping, in the form "LanguageCode (Full Name)" (e.g. "en_US (English (US))"). For more information on these values, see 'volume-create'.
  • language-code => string

    • Set to the volume's language code, suitable for use as an argument to other functions (e.g. "en_US"). For more information on these values, see 'volume-create'.
  • nfs-character-set => string

    • The NFS language mapping character set that is currently in effect for the volume.

    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"

  • oem-character-set => string

    • The OEM language mapping character set that is currently in effect for the volume.

    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"

volume_get_root_name

[Family: ontap-classic, vfiler]

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

  • None

Outputs

  • volume => string

    • Name of the root volume for the filer.

volume_get_supported_guarantees

[Family: ontap-classic, vfiler]

Returns the list of guarantee types that are supported on this volume. This just does semantic checks and so enabling supported guarantees can still fail because of space checks.

Inputs

  • volume => string

    • Name of the volume. Ex: flex1, vol0 etc.

Outputs

volume_list_info

[Family: ontap-classic, vfiler]

Get volume status. Note that all RAID-related status items (e.g., 'raid-size', 'raid-status', 'checksum-style') reported for a flexible volume actually describe the state of its containing aggregate.

Inputs

  • verbose => boolean, optional

    • If set to "true", more detailed volume information is returned. If not supplied or set to "false", this extra information is not returned.
  • volume => string, optional

    • The name of the volume for which we want status information. If not supplied, then we want status for all volumes on the filer. Note that if status information for more than 20 volumes is desired, the volume-list-info-iter-* zapis will be more efficient and should be used instead.

Outputs

volume_list_info_iter_end

[Family: ontap-classic, vfiler]

Terminate a list iteration and clean up any saved info.

Inputs

  • tag => string

    • Tag from a previous volume-list-info-iter-start.

Outputs

  • None

volume_list_info_iter_next

[Family: ontap-classic, vfiler]

Continues an iteration through the list of volumes.

Inputs

  • maximum => integer

    • The maximum number of entries to retrieve.
  • tag => string

    • Tag from a previous volume-list-info-iter-start.

Outputs

  • records => integer

    • This tells you how many records are being returned from this particular call to volume-list-info-iter-next. When this value is 0, you have retrieved everything.
  • volumes => volume-info[]

    • List of volumes and their status information. See volume-list-info for a description of type volume-info.

volume_list_info_iter_start

[Family: ontap-classic, vfiler]

Starts an iteration through the list of volumes.

Inputs

  • verbose => boolean, optional

    • If set to "true", more detailed volume information is returned. If not supplied or set to "false", this extra information is not returned.
  • volume => string, optional

    • The name of the volume for which we want status information. If not supplied, then we want status for all volumes on the filer.

Outputs

  • records => integer

    • This tells you the number of items that have been saved for future retrieval with volume-list-info-iter-next.
  • tag => string

    • Tag to be used in subsequent iterations.

volume_mediascrub_list_info

Get the RAID media scrubbing status on the named traditional volume, plex, or RAID group. If no name is given, then status is provided for all RAID groups currently undergoing media scrubbing.

Inputs

  • volume => string, optional

    • Name of traditional volume, plex or RAID group for which media scrub status is desired. If no name is given, then status is provided for all RAID groups currently undergoing media scrubbing.

Outputs

volume_mirror

Turns an unmirrored traditional volume into a mirrored traditional volume by adding a plex to it. The plex is either newly formed from disks chosen from a spare pool or, if the "victim-volume" option is specified, is taken from another existing unmirrored volume. The volume must currently be unmirrored. Disks may be specified explicitly using the "mirror-disks" argument list option in the same way as with the 'volume-create' and 'volume-add' APIs. The number of disks specified must exactly match the number present in the existing traditional volume. If the disks to use are not explicitly specified, then the appropriate disks are automatically selected to match those already in the traditional volume's existing plex. It is not possible to directly mirror a flexible volume; if that is the goal, then consider using 'volume-container' to find the flexible volume's containing aggregate, then use 'aggr-mirror' to mirror that aggregate (which, of course, will case all other volumes contained in the given aggregate to become mirrored as well).

Inputs

  • force => boolean, optional

    • Force the mirroring operation through, past the normal roadblocks that would otherwise cause it to be aborted. For example, disks in a plex are not normally permitted to span spare pools. This safety-drive behavior is overridden when the 'force' option is provided and set to 'true'.
  • mirror-disks => disk-info[], optional

    • Specific list of mirror disks to use. It must have the same number of disks as are present in the given traditional volume. The specified disks are not permitted to span disk pools; this behavior can be overridden with the "force" argument.
  • victim-volume => string, optional

    • The "victim" traditional volume to cannibalize in order to mirror the given traditional volume. The result is a mirrored traditional volume that is otherwise identical to the original volume before the operation. The "victim-volume" is effectively destroyed. "victim-volume" must have been previously mirrored with this volume, then separated via the "volume-split" command. "victim-volume" must be offline.
  • volume => string

    • Name of the traditional volume to be mirrored.

Outputs

  • bad-disks => disk-info[], optional

    • List of disks that were not added. This is only returned if there are bad disks.

volume_move_abort

[Family: ontap-classic]

Aborts the volume move operation of the specified source volume. This is a synchronous API.

Inputs

Outputs

  • None

volume_move_cutover

[Family: ontap-classic]

Initiates a manual cutover operation on the specified source volume. This is a synchronous API. Cutover is the final phase of volume move operation after which destination volume takes the identity of the source volume. If cutover cannot be initiated or completed, the API will return with an error. The move will pause and an EMS message will be printed. The volume-move-status API will show the state of the move as move(paused). The user can resume or abort the move.

Inputs

  • source-volume => string

    • Name of the volume, whose move is waiting for cutover to be initiated.

Outputs

  • None

volume_move_pause

[Family: ontap-classic]

Pauses the volume move operation of the specified source volume. This is a synchronous API.

Inputs

  • source-volume => string

    • Name of the volume whose move must be paused

Outputs

  • None

volume_move_resume

[Family: ontap-classic]

Resumes a previously paused volume move operation of a specified source volume. This is an asynchronous API. It will run a series of checks to determine if the volume move can be resumed. If there are no errors or warnings, the API will return successfully. The move will be resumed. The status of the move can be obtained from the volume-move-status API. If any of the checks result in an error or warning, the API will return with an error. If the checks result in no errors but one or more warnings and is-override-warnings is set to true, the API will return successfully and the move will be resumed.

Inputs

  • cutover-window => integer, optional

    • Time interval to complete cutover in seconds. If not specified, then the existing value is maintained.
  • is-override-warnings => boolean, optional

    • If warnings are encountered during the resume, the default behavior is to pause. If is-override-warnings is true, the move will continue and return these warnings in the errors-warnings element.
  • source-volume => string

    • Name of the volume whose move must be resumed

Outputs

volume_move_start

[Family: ontap-classic]

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

  • cutover-attempts => integer, optional

    • Number of cutover attempts. Default value is 3
  • cutover-window => integer, optional

    • Time interval to complete cutover in seconds. Default value for Data ONTAP Cluster-Mode volume move is 45 seconds. Default value for Data ONTAP 7-mode volume move is 60 seconds.
  • is-keep-source => boolean, optional

    • If specified, the source volume will not be destroyed after the move is complete. Default is false.
  • is-manual-cutover => boolean, optional

    • If specified, user has to initiate cutover. Default is false.
  • is-override-warnings => boolean, optional

    • If warnings are encountered during the move, the default behavior is to stop. If is-override-warnings is true, the move will continue and return these warnings in the errors-warnings element. Default is false.
  • perform-validation-only => boolean, optional

    • Run pre-checks for the move, return all the errors and warning messages encountered during the checks in the errors-warnings element and exit. The move will not be triggered. Default is false.
  • source-volume => string

    • Name of the volume that must be moved

Outputs

  • errors-warnings => errors-warnings-info[], optional

    • Errors and warnings if perform-validation-only is set to true

volume_move_status

[Family: ontap-classic]

Obtains the status of the volume move operation. This is a synchronous API.

Inputs

  • is-verbose => boolean, optional

    • If not supplied or set to "false", output shows source volume, destination aggregate, cutover window, cutover attempts and state of move. If set to "true", verbose output containing details about last and current snapmirror transfer in addition to above parameters is returned.
  • source-volume => string, optional

    • Name of the volume that is being moved. If source-volume is not provided, then the status of all active moves is listed. If it is provided the status of the move of source-volume is returned. Since this version will support only one move at a time, this input will not alter the output returned by this API.

Outputs

volume_offline

[Family: ontap-classic, vfiler]

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

  • cifs-delay => integer, optional

    • If a volume contains CIFS shares, users should be warned before taking the volume offline. This argument specifies the number of minutes to delay before taking the volume offline, during which time CIFS users are warned of the pending loss of service. A 'cifs-delay' time of 0 means that the volume is to be taken offline immediately without issuing any warnings. CIFS users can lose data if they are not given a chance to terminate applications gracefully. By default, the value of 'cifs-delay' is 0.
  • name => string

    • Name of an existing volume or plex. If a volume contains CIFS shares, users should be warned before taking the volume offline. Use "cifs-delay" to specify number of seconds to wait. If a plex is specified, the plex must be part of a mirrored volume, and both plexes must be online. Prior to offlining a plex, the system will flush all internally-buffered data associated with the plex and create a snapshot that is written out to both plexes. The snapshot allows for efficient resynchronization when the plex is subsequently brought back online.

Outputs

  • None

volume_online

[Family: ontap-classic, vfiler]

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

  • name => string

    • Name of an existing volume or plex. If a volume is specified, it must be currently offline, restricted, or foreign. If the volume is foreign, it will be made native before being brought online. A ``foreign'' volume is a traditional volume that consists of disks moved from another filer and that has never been brought online on the current filer. Traditional volumes that are not foreign are considered ``native.'' If the volume is inconsistent, but has not lost data, it is advisable to run WAFL_check or wafliron (or do a 'snapmirror initialize' in case of a replica volume) prior to bringing an inconsistent volume online. Bringing an inconsistent volume online increases the risk of further file system corruption. If the volume is inconsistent and has experienced possible loss of data, it cannot be brought online unless WAFL_check or wafliron (or 'snapmirror initialize') has been run on the volume. If a plex is specified, the plex must be part of an online mirrored traditional volume or aggregate. The system will initiate resynchronization of the plex as part of online processing.

Outputs

  • None

volume_options_list_info

[Family: ontap-classic, vfiler]

Get the options that have been set for the specified volume.

Inputs

  • volume => string

    • Name of the existing volume for which we want option information.

Outputs

volume_rename

[Family: ontap-classic, vfiler]

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

  • volume => string

    • Name of an existing volume.

Outputs

  • None

volume_restrict

[Family: ontap-classic, vfiler]

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

  • cifs-delay => integer, optional

    • If a volume contains CIFS shares, users should be warned before restricting the volume . This argument specifies the number of minutes to delay before restricting the volume, during which time CIFS users are warned of the pending loss of service. A 'cifs-delay' time of 0 means that the volume is to be restricted immediately without issuing any warnings. CIFS users can lose data if they are not given a chance to terminate applications gracefully. By default, the value of 'cifs-delay' is 0.
  • name => string

    • Name of the volume to restrict.

Outputs

  • None

volume_scrub_list_info

Get the status of RAID parity scrubbing on the named traditional volume, plex, or RAID group. If no name is given, then status is provided for all RAID groups currently undergoing scrubbing. Scrubbing status includes a percent-complete value and its suspended status (if any).

Inputs

  • name => string, optional

    • Name of an existing traditional volume, plex, or RAID group. If no name is given, then status is generated for all RAID groups currently being scrubbed.
  • verbose => boolean, optional

    • If set to "true", this operation will be verbose. If not supplied or set to 'false', normal output levels will be used.

Outputs

volume_scrub_resume

Resume RAID parity scrubbing on the named traditional volume, plex, or RAID group. If no name is given, then resume scrubbing on all RAID groups for which it is suspended.

Inputs

  • name => string, optional

    • Name of the existing traditional volume, plex, or RAID group for which the scrubbing is to resume.

Outputs

  • None

volume_scrub_start

Start RAID parity scrubbing on the named traditional volume, plex, or RAID group. RAID parity scrubbing compares the data disks to the parity disk in a RAID group, correcting the parity disk's contents as necessary. If a plex name is given, then scrubbing is started on all RAID groups contained in the plex. If a RAID group name is given, then scrubbing is started only in that RAID group. If no name is given, then scrubbing is started on the RAID groups within all online traditional volumes and aggregates. Use 'volume-scrub-list-info' to check scrub status.

Inputs

  • name => string, optional

    • Name of an existing traditional volume, plex, or RAID group.

Outputs

  • None

volume_scrub_stop

Stop RAID parity scrubbing on the named volume, plex, or group; if no name is given, on all RAID groups currently undergoing parity scrubbing.

Inputs

  • name => string, optional

    • Name of an existing volume, plex, or raid-group.

Outputs

  • None

volume_scrub_suspend

Suspend RAID parity scrubbing on the named traditional volume, plex, or RAID group. If no name is given, suspend scrubbing on all RAID groups currently being scrubbed.

Inputs

  • name => string, optional

    • Name of an existing traditional volume, plex, or RAID group.

Outputs

  • None

volume_set_language

[Family: ontap-classic, vfiler]

Set the given volume's language mapping.

Inputs

  • language-code => string

    • The new language mapping for the volume. For a list of legal language mapping values, see 'volume-create'.
  • volume => string

    • Name of the volume that is to have its language mapping changed.

Outputs

  • None

volume_set_option

[Family: ontap-classic, vfiler]

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

  • option-name => string

    • Name of the option to be set. Possible values:
    "convert_ucode" (value: "on" | "off")
    Setting this option to "on" forces conversion of all directories to UNICODE format when accessed from both NFS and CIFS. By default, it is set to "off", in which case access from CIFS causes conversion of pre-4.0 and 4.0- format directories. Access from NFS causes conversion of 4.0 format directories. This option cannot be set on a Cluster-Mode volume unless it was transitioned from 7-Mode.

    "snapshot_clone_dependency" (value: "on" | "off")
    Setting this option "on" will unlock all initial and intermediate backing snapshots for all inactive LUN clones. For active LUN clones, only the backing snapshot will be locked. If the option is "off" the backing snapshot will remain locked until all intermediate backing snapshots are deleted. This option is not valid for a Cluster-Mode volume.

    "create_reserved"
    This option is no longer supported.

    "create_ucode" (value: "on" | "off")
    Setting this option to "on" forces UNICODE format directories to be created by default, both from NFS and CIFS. The default value is "off", in which case all directories are created in pre-4.0 format and only converted to UNICODE format upon the first CIFS access. This option cannot be set on a Cluster-Mode volume.

    "extent" (value: "on" | "space_optimized" | "off")
    Setting this option to "on" enables extents in the volume. This causes application writes to be written in the volume as a write of a larger group of related data blocks called an extent. Using extents may help workloads that perform many small random writes followed by large sequential reads. However, using extents may increase the amount of disk operations performed on the filer, so this option should only be used where applicable. The default value is "off", in which case extents are not used. The value "space_optimized" indicates extent updates will not duplicate snapshot blocks into the active file system, thereby using space conservatively. The "space_optimized" value may result in degraded snapshot read performance; and may only be used for flexible volumes.

    "fractional_reserve" (value: < number >)
    This option decreases the amount of space reserved for overwrites of reserved objects (LUNs, files) in a volume. The option is set to 100 by default and indicates that 100% of the required reserved space will actually be reserved so the objects are fully protected for overwrites. The value can vary from 0 to 100. Using a value of less than 100 indicates what 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.

    "fs_size_fixed" (value: "on" | "off")
    Setting this option to "on" causes the file system to remain the same size (and not grow) when a SnapMirror relationship is broken, or when a "vol/aggr add" is performed on it. This option is automatically set to be "on" when a volume becomes a SnapMirrored. It remains "on" after the "snapmirror break" command is issued for the volume. This option allows a volume to be SnapMirrored back to the source without needing grow the source volume. If the volume size is larger than the file system size, turning off this option forces the file system to grow to the size of the volume.

    "guarantee" (value: "none" | "file" | "volume")
    Flexible volumes only. Setting this option controls the type of space reservation for the named flexible volume. There are three possible settings. The first, "none", provides no guarantee that there will be enough blocks in the containing aggregate to meet the flexible volume's needs. The second, "file", guarantees there will be enough blocks in the containing aggregate to meet the needs of the specified files in the flexible volume. The third, "volume", is the default setting and guarantees there will be enough blocks available in the containing aggregate to meet the entire flexible volume's needs. An error will be returned if an attempt is made to set this option on a traditional volume.

    "ignore_inconsistent" (value: "on" | "off")
    This option can only be set in maintenance mode. If set to "on", then the root volume may be brought online when booting even if it is marked as inconsistent. The user is cautioned that bringing it online prior to running WAFL_check or wafliron may result in further file system inconsistency.

    "maxdirsize" (value: < number >)
    Set the maximum size (in KBytes) to which any directory can grow. The default setting of 10240 limits directory size to 10 MBytes and allows it to hold up to approximately 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 option's setting. This option 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.

    "max_write_alloc_blocks" (value: < number >)
    Set the maximum number of blocks used for write allocation. The default setting, 0, uses the system-wide default number of blocks, which should be optimal for most users. Some sequential read workloads may benefit from increasing this value. On rare occasions, some multi-stream sequential write workloads may benefit from decreasing this value. Range: [0..2048].

    "minra" (value: "on" | "off")
    Setting this option to "on" causes the filer to perform minimal read-ahead on this volume. By default, this option is "off", causing the filer to perform very aggressive read-ahead on the volume.

    "no_atime_update" (value: "on" | "off")
    Setting this option to "on" prevents the update of inode access times when a file is read. This option 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. It should be used carefully. That is, use this option when you know in advance that the correct access time for inodes will not be needed for files on that volume.

    "no_i2p" (value: "on" | "off")
    Setting this option to "on" disables inode to parent pathname translations on the volume. The default setting is off.

    "nosnap" (value: "on" | "off")
    Setting this option to "on" disables automatic snapshots on the volume. This option is not supported for Cluster-Mode volumes.

    "nosnapdir" (value: "on" | "off")
    Setting this option to "on" disables the visible .snapshot directory that is normally present at system internal mount points. It also turns off access to all other .snapshot directories in the volume.

    "nvfail" (value : "on" | "off")
    If this option is on, the filer performs additional work at boot time if it finds that there has been any potential data loss due to an NVRAM failure. In such situations, 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 filer sends error messages to the console whenever such problems are found.

    "raid_cv" (value: "on" | "off")
    Traditional volumes only. Setting the option to "off" disables block checksum protection on the volume. The default is "on". The user is cautioned that turning off the option exposes the filesystem to inconsistency that could be caused by a misbehaving hardware component in the system.

    "raid_zoned" (value: "on" | "off")
    Traditional volumes only. Setting the option to "off" disables zoned checksum protection on the volume. The default is "on". The user is cautioned that turning off the option exposes the filesystem to inconsistency that could be caused by a misbehaving hardware component in the system.

    "raidsize" (value: < number >)
    Traditional volumes only. The maximum size of a RAID group within the traditional volume. Changing this option doesn't cause existing RAID groups to grow or shrink. Rather, it only affects whether more disks will be added to the last existing RAID group in the future, and how large new RAID groups will be.

    "raidtype" (value: "raid4" | "raid_dp")
    Traditional volumes only. The type of RAID group used for this traditional volume. The "raid4" setting provides one parity disk per RAID group, while "raid_dp" provides two. Changing this option immediately changes the RAID group type for all RAID groups in the traditional volume. When upgrading RAID groups from "raid4" to "raid_dp", each RAID group begins reconstruction onto a spare disk allocated for the second "dparity" parity disk.

    "read_realloc" (value: "on" | "space_optimized" | "off")
    Setting this option to "on" enables read-reallocation in the volume. This causes application reads to optimize the layout of parts of a file or LUN after the data has been read from disk and is in the appliance memory. The default value is "off", in which case read-reallocate is not used. The value "space_optimized" indicates read-reallocate updates will not duplicate blocks into the active file system, thereby using space conservatively. The "space_optimized" value may result in degraded snapshot read performance; and may only be used for flexible volumes.

    "resyncsnaptime" (value: < number >)
    Traditional volumes only. Sets the RAID mirror resynchronization snapshot frequency to be the given number of minutes. The default value is '60' (minutes).

    "root" (value: < none >)
    The specified volume is to become the root volume for the filer on the next reboot. This option can be used on only one volume at any given time. The existing root volume will become a non-root volume after the reboot. Until the system is rebooted, the current root volume will continue to show 'root' as one of its options, and the new root volume will show 'diskroot' as an option. In general, the volume that has the 'diskroot' option value is the one that becomes the root volume following the next reboot. The only way to remove the root status of a volume is to set it on another one.

    "schedsnapname" (value: "create_time" | "ordinal")
    Setting the option to "ordinal" causes scheduled snapshots to be named in the hourly.n name format. Setting the value to "create_time" causes snapshots to use a hourly.yyyy-mm-dd_hhmm name format instead. The default is "ordinal".

    "snapmirrored" (value : "off")
    If SnapMirror is enabled, the filer automatically sets this option to "on". Set this option to "off" if SnapMirror should no longer be used to update the mirror. After setting this option to "off", the mirror becomes a regular writable volume. This option can only be set to "off" with this interface. Only the filer can change this option's value from "off" to "on". This option is not settable in Data ONTAP Cluster-Mode. Use "snapmirror-break" API instead.

    "try_first" (value : "volume_grow" | "snap_delete")
    If the flexible volume is configured to automatically reclaim space if the volume is running out of space, then setting this option to "volume_grow" will cause the volume to increase in size before deleting snapshots. If the option was set to "snap_delete", snapshots will be deleted before the volume size is increased.

    "svo_enable" (value: "on" | "off")
    Setting this option to "on" enables SnapValidator functionality on this volume. This option only applies to non-root volumes. This option is unsupported in Data ONTAP Cluster-Mode.

    "svo_allow_rman" (value: "on" | "off")
    Setting this option to "on" enables SnapValidator functionality on this volume to allow this volume to contain Oracle RMAN backup data. This option only applies to non-root volumes. This option is unsupported in Data ONTAP Cluster-Mode.

    "svo_checksum" (value: "on" | "off")
    Setting this option to "on" enables SnapValidator checksumming of all writes to this volume. This option only applies to non-root volumes. This option is unsupported in Data ONTAP Cluster-Mode.

    "svo_reject_errors" (value: "on" | "off")
    Setting this option to "on" enables SnapValidator functionality to reject any write to the volume which fails the SnapValidator checks. This option only applies to non-root volumes. This option is unsupported in Data ONTAP Cluster-Mode.

    "thorough_scrub" (value: "on" | "off")
    Traditional volumes only. Setting the option to "on" enables thorough scrub on a block checksum volume. That means that a scrub will initialize any zeroed checksum entries that it finds. If there are any checksum entries to be initialized, scrub will run slower than normal.

    "snaplock_autocommit_period" (value: "none" | h|d|m|y)
    SnapLock volumes only. This option defines the criteria for committing files to WORM on a SnapLock volume by the autocommit scanner. h, d, m, y denote hours, days, months and years respectively. The default value of this option is "none" that corresponds to autocommit being disabled in the SnapLock volume. The minimum autocommit period on a SnapLock volume is 2h. Any valid value other than "none", specified in hours (h), days (d), months (m) or years (y) would trigger the autocommit scanner on the Snaplock volume.

    "snaplock_default_period" (value : min | max | infinite | s|h|d|m|y)
    This option can be set only for SnapLock volumes and specifies the default retention period that will be applied to files committed to WORM state without an associated retention period. If this option value is min then snaplock_minimum_period is used as the default retention period. If this option value is max then snaplock_maximum_period is used as the default retention period. If this option value is infinite then infinite retention period will be used as the default retention period. WORM files with infinite retention period are retained forever. The retention period can also be explicitly specified as a number followed by a suffix. The valid suffixes are s for seconds, h for hours, d for days, m for months and y for years. For example, a value of 6m represents a retention period of 6 months. The maximum valid retention period is 70 years. This option is not applicable while extending retention period of an already committed WORM file

    "snaplock_maximum_period" (value: infinite | s|h|d|m|y)
    This option can be set only for SnapLock volumes and specifies the maximum allowed retention period for files committed to WORM state on the volume. Any file committed with a retention period longer than snaplock_maximum_period will be assigned a retention period equal to snaplock_maximum_period. If this option value is infinite then files can be committed for infinite retention period in the volume. WORM files with infinite retention period are retained forever. The retention period can also be explicitly specified as a number followed by a suffix. The valid suffixes are s for seconds, h for hours, d for days, m for months and y for years. For example, a value of 6m represents a retention period of 6 months. The maximum valid retention period is 70 years. This option is not applicable while extending retention period of an already committed WORM file

    "snaplock_minimum_period" (value: infinite | s|h|d|m|y)
    This option can only be set for SnapLock volumes and specifies the minimum allowed retention period for files committed to WORM state on the volume. Any file committed with a retention period shorter than snaplock_minimum_period will be assigned a retention period equal to snaplock_minimum_period. If this option value is infinite then every file committed to the volume will have a infinite retention period. WORM files with infinite retention period are retained forever. The retention period can also be explicitly specified as a number followed by a suffix. The valid suffixes are s for seconds, h for hours, d for days, m for months and y for years. For example, a value of 6m represents a retention period of 6 months. The maximum valid retention period is 70 years. This option is not applicable while extending retention period of an already committed WORM file

  • option-value => string

    • The value to set the named option (except for option 'root', which has no associated value).
  • volume => string

    • Name of the volume for which we want to set an option.

Outputs

  • None

volume_set_total_files

[Family: ontap-classic, vfiler]

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

  • force => boolean, optional

    • Indicates whether the filer should reject a legal but "unreasonable" (seemingly too large) value for 'requested-total-files', or accept it without question. By default, legal but "unreasonable" values are rejected.
  • requested-total-files => integer

    • Specifies the new value for the volume's 'files-total' field. This value must be larger than the volume's current 'files-total' value, and can never be larger than the number of 4KB blocks in the volume. The filer may actually choose a smaller value so as to comply with certain internal accounting and alignment requirements. Once this value has been increased for a volume, it cannot be reduced below the value of 'inodefile-public-capacity' for that volume. Range : [0..2^31-1]
  • volume => string

    • The name of the volume whose 'files-total' field we wish to set. The chosen volume must be online and not read-only for this operation to succeed.

Outputs

  • resulting-total-files => integer

    • The quantity to which the given volume's 'files-total' field was actually set after all internal requirements and alignments were computed. This quantity will never be larger than 'requested-total-files', and never be smaller than the volume's 'inodefile-public-capacity' value before the request. Range : [0..2^31-1]

volume_size

[Family: ontap-classic, vfiler]

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

  • new-size => string, optional

    • Specify the flexible volume's new size using the following format: [+|-]< number > k|m|g|t] If a leading '+' or '-' appears, it indicates that the given flexible volume's size is to be increased or decreased (respectively) by the indicated amount, else the amount is the absolute size to set. The optional trailing 'k', 'm', 'g', and 't' indicates the desired units, namely 'kilobytes', 'megabytes', 'gigabytes', and 'terabytes' (respectively). If the trailing unit character doesn't appear, then < number > is interpreted as the number of bytes desired. The file system size of a readonly replica flexible volume, such as a snapmirror destination, is determined from the replica source. In such cases, the value set using "volume-size" is interpreted as an upper limit on the size. A flexible volume that's not a readonly replica which has the "fs_size_fixed" option set may have its size displayed, but not changed. Attempting to set the volume size in this case will result in failure and a EINTERNALERROR error code. Users must be able to adjust readonly replica flexible volume size in order to maintain enough capacity to accommodate transfers from the replica source. Attempting to set a readonly replica destination size to be less than that of its source will result in a failure indicated by the EONTAPI_ENOSPC error code. This option is not applicable from vFiler context. Attempting to set volume size from vfiler context will result in failure with EINTERNALERROR error code being returned.
  • volume => string

    • The name of the flexible volume for which we want to get or set its size.

Outputs

  • volume-size => string

    • Either the size we found the given volume to be or the size to which the volume was set (if we're setting its size via the 'new-size' argument above).

volume_space_list_info

[Family: ontap-classic]

Return a list of volumes and a breakdown of their space usage. This information is only available for online volumes. If no volume is specified, status is displayed for all online volumes on the filer. Note that if space status information for more than 20 volumes is desired, the volume-space-list-info-iter-* ZAPIs will be more efficient and should be used instead.

Inputs

  • volume => string, optional

    • The name of the volume for which we want status information. If not supplied, then we want status for all volumes on the filer.

Outputs

volume_space_list_info_iter_end

[Family: ontap-classic]

Terminate a list iteration and clean up any saved info.

Inputs

  • tag => string

    • Tag from a previous volume-space-list-info-iter-start.

Outputs

  • None

volume_space_list_info_iter_next

[Family: ontap-classic]

Continues an iteration through the list of volumes.

Inputs

  • maximum => integer

    • The maximum number of entries to retrieve.
  • tag => string

    • Tag from a previous volume-space-list-info-iter-start.

Outputs

  • records => integer

    • This tells you how many records are being returned from this particular call to volume-space-list-info-iter-next. When this value is 0, you have retrieved everything.
  • vol-space-infos => vol-space-info[]

    • List of volumes and their status information. See volume-space- list-info for a description of type vol-space-info.

volume_space_list_info_iter_start

[Family: ontap-classic]

Starts an iteration through the list of volumes.

Inputs

  • volume => string, optional

    • The name of the volume for which we want space status information. If not supplied, then we display space status for all volumes on the filer.

Outputs

  • records => integer

    • This tells you the number of items that have been saved for future retrieval with volume-space-list-info-iter-next.
  • tag => string

    • Tag to be used in subsequent iterations.

volume_split

Remove the specified plex from a mirrored traditional volume and create a new unmirrored traditional volume with the specified name that contains the split-off plex. The original mirrored traditional volume becomes unmirrored. The plex to be split from the original traditional volume must be functional (not partial), but it could be inactive, resyncing, or out-of-date. A 'volume-split' operation can therefore be used to gain access to a plex that is not up to date with respect to its partner plex if its partner plex is currently failed. If the plex is offline at the time of the split, the resulting traditional volume will also be offline. Otherwise, the resulting traditional volume will be in the same online/offline/restricted state as the original traditional volume. Note that a split mirror can be joined back together via the "victim-volume" option to "volume-mirror".

Inputs

  • new-volume-name => string

    • Name of the new traditional volume to create from the split plex.
  • plex => string

    • Name of the plex to split out of its traditional volume.

Outputs

  • None

volume_verify_list_info

Get the status of RAID mirror verification on the named traditional volume. Status includes percentage complete and whether it's currently suspended.

Inputs

  • volume => string, optional

    • Name of an existing mirrored traditional volume. If no name is given, then mirror verification status is generated for all aggregates currently being verified (including the ones embedded in traditional volumes).

Outputs

  • verify-details => verify-detail-info[]

    • List of aggregates (including the ones embedded in traditional volumes) and their RAID mirror verification status.

volume_verify_resume

Resume RAID mirror verification on the named traditional volume. If no name is given, then resume RAID mirror verification on all aggregates (including those embedded in traditional volumes) that have been suspended.

Inputs

  • volume => string, optional

    • Name of the existing traditional volume for which RAID mirror verification is to resume.

Outputs

  • None

volume_verify_start

Start RAID mirror verification on the named traditional volume. RAID mirror verification compares the data in both plexes of a mirrored aggregate (whether it's free-standing or embedded in a traditional volume). 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 RAID mirror verification is started on all online aggregates (including those embedded in traditional volumes). Use either the "aggr-verify-list-info" or "volume-verify-list-info" API to check RAID mirror verification status. If the fix-plex option is used, then a name must be specified.

Inputs

  • fix-plex => integer, optional

    • If provided, this specifies the plex to fix in case the two plexes do not match. The default is to log any discrepancies instead of fixing them.
  • log-only => boolean, optional

    • If provided, and if the value is "true", then simply log any discrepancies instead of fixing them. The default value is "true". If log-only is "false", then the fix-plex option must also be specified. If log-only is "true" and fix-plex is also specified, then the log-only option will be ignored.
  • volume => string, optional

    • Name of the mirrored traditional volume to verify.

Outputs

  • None

volume_verify_stop

Stop RAID mirror verification on the named traditional volume. If no name is given, stop RAID mirror verification on all aggregates (including those embedded in traditional volumes) currently being verified.

Inputs

  • volume => string, optional

    • Name of the traditional volume for which we are to stop RAID mirror verification.

Outputs

  • None

volume_verify_suspend

Suspend RAID mirror verification on the named traditional volume. If no name is given, suspend mirror verification on all aggregates (including those embedded in traditional volumes) currently being verified.

Inputs

  • volume => string, optional

    • Name of the traditional volume for which we are to suspend RAID mirror verification.

Outputs

  • None

volume_wafl_info

DEFINED HERE FOR BACKWARDS COMPATIBILITY ONLY. CHANGE OVER TO USING THE NEW 'volume-get-filer-info' AS SOON AS POSSIBLE. Get WAFL status information.

Inputs

  • None

Outputs

  • checksum-types => string

    • Checksum type. The possible values:
    • "zoned" - if all volumes are Fixed VBN,
    • "block" - if all volumes are Block Appended,
    • "mixed" - if volumes are mixed Fixed VBN and Block Appended and Advanced Zoned,
    • "none" - if no volumes have zoned or block or advanced_zoned checksum (azcs) or mixed,
    • "advanced_zoned" - if all volumes in the system have Advanced Zoned Checksum scheme.
  • disk-types => string

    • Type of disks. Possible values: 512, 520, 4096, mixed, none. "512" if all disks 512 BPS, "520" if all disks 520 BPS, "4096" if all disks 4096 BPS, "mixed" if disks are mixed 512 BPS, 520 BPS and 4096 BPS, "none" if no disks have 512 or 520 or 4096 BPS.
  • root-volume => string

    • Current root volume.
  • snapshots-max => integer

    • Maximum number of snapshots available. Range : [0..2^31-1].

wafl_sync

[Family: ontap-classic, vfiler]

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 are
  • to predict how fast a successive consistency group based operation will finish,
  • to improve performance of succeeding consistency group primitives.

Inputs

  • volumes => volume-name[], optional

    • A list of volume names to take a CP on. In Data ONTAP 7-Mode, the CP operation will be performed on all the volumes on the controller if no volumes are specified. In Data ONTAP Cluster-Mode, "volumes" is a required input and all specified volumes must belong to the same Vserver. If an error is encountered when processing the sync request for a volume, the operation is aborted and sync operation will not be performed on the rest of the volumes specified.

Outputs

  • None

TYPEDEFS

aggr-64bit-upgrade-check-info

Information returned when upgrade-64bit-mode in aggr-add or aggr-64bit-upgrade-start is "check".

Fields

  • added-space => integer, optional

    • The effective total space to be added (in bytes), not including blocks used by the 64-bit upgrade of the aggregate and its contained flexible volumes. Range: [0..2^64-1].
  • cookie => integer, optional

    • The opaque cookie to uniquely identify a 64-bit upgrade transaction previously triggered on the aggregate. Range: [0..2^64-1].
  • last-errno => integer, optional

    • The error code of the last attempt to check for space usage on the specific aggregate. This field is present only if a 64-bit upgrade check was previously attempted. Possible values: 0 - indicates success EVOLUME_64BIT_UPGRADE_KIREETI_NOT_AVAIL Per-volume upgrade check results may be out of date if last-errno is not 0.

aggr-64bit-upgrade-info

Information related to 64-bit upgrade.

Fields

aggr-64bit-upgrade-start-info

Information returned when upgrade-64bit-mode in aggr-add or aggr-64bit-upgrade-start is "grow_all", "grow_none", or "grow_reserved".

Fields

  • last-errno => integer, optional

    • The error code of the last attempt to start 64-bit upgrade on the specific aggregate. This field is present only if 64-bit upgrade was previously attempted. Possible values include: EAGGR_64BIT_UPGRADE_ENOSPC EOP_DISALLOWED_ON_AGGR_WITH_SPARSE_VOL EVOLUME_64BIT_UPGRADE_VVOL_ENOSPC EVOLUME_64BIT_UPGRADE_VVOL_ENOSPC_OVERWRITE EVOLUME_64BIT_UPGRADE_KIREETI_NOT_AVAIL EVOLUME_64BIT_UPGRADE_PREQUAL_NOT_AVAIL EVOLUME_IRON_NON_LOCAL_STATUS
  • min-space-for-upgrade => integer, optional

    • The minimum additional disk space (in bytes) required to trigger 64-bit upgrade. This field is present when the specified disks do not have sufficient space to upgrade the aggregate and its contained flexible volumes to 64-bit. Range: [0..2^64-1].

aggr-64bit-upgrade-status-info

Status information related to 64-bit upgrade. This information includes the block format of the aggregate and the progress of the 64-bit upgrade scanner.

Fields

aggr-info

Aggregate status information.

Fields

  • block-type => string

    • The indirect block format that the aggregate can have. It can be either 32_bit or 64_bit. A 64_bit value indicates that associated aggregates can be larger than 16TB. Possible values: 32_bit, 64_bit
  • cache-raid-group-size => integer

    • Current maximum cache RAID group size of hybrid aggregate. Range : [1..28]. RAID group size is the maximum number of disks that can be added to a RAID group. This information will only be returned for hybrid aggregate i.e. for the aggregates whose "is-hybrid" field is set to true.
  • checksum-status => string

    • Checksum status. Possible values: "active", "off", "reverting", "none", "unknown", "initializing", "reinitializing", "reinitialized", "upgrading_phase1", "upgrading_phase2"
  • checksum-style => string

    • Checksum style. The possible values:
    • "advanced_zoned" - advanced_zoned checksum (azcs),
    • "block" - block,
    • "mixed" - mixed,
    • "none" - none,
    • "unknown" - unknown
    • "wafl" - wafl,
    • "zoned" - zoned.
  • dr-home-id => integer, optional

    • NVRAM ID of the DR (disaster recovery) node to which this aggregate's disks have been administratively assigned. This information derived from sanown information of aggregate's disk. See 'disk-sanown-detail-info'
  • free-space-realloc => string, optional

    • Indicate if free space reallocation (continuous segment cleaning) is enabled on a specific aggregate. Possible values: on, off, no_redirect "on" (Free space reallocation enabled with automatically starting the redirect scanner) "off" (Free space reallocation disabled) "no_redirect" (Free space reallocation enabled without running the redirect scanner) The default value for this option is "off"
  • ha-policy => ha-policy-type, optional

    • Aggregate's HA policy. Possible return values: "cfo", "sfo", "none"
  • home-id => integer, optional

    • NVRAM ID of the node to which this aggregate's disks have been administratively assigned. This information derived from sanown information of aggregate's disk. See 'disk-sanown-detail-info' Range : [0..2^32-1].
  • inodefile-private-capacity => integer

    • Number of inodes that can currently be stored on disk for system (not user-visible) files. This number will dynamically increase as more system files are created. Range: [0..2^64-1].
  • inodefile-public-capacity => integer

    • Number of inodes that can currently be stored on disk for user-visible files. This number will dynamically increase as more user-visible files are created. Range: [0..2^64-1].
  • is-mirrored => boolean, optional

    • If true, aggregate is mirrored.
  • max-write-alloc-blocks => integer, optional

    • The maximum number of blocks used for write allocation. Some sequential read workloads may benefit from increasing this value. Default value is 0 which uses the controller-wide default value of 64. The default is optimal for most users. The controller-wide default can be adjusted with the bootarg "wafl-max-write-alloc-blocks"
  • mirror-status => string

    • Aggregate's mirror status. Possible values: invalid, uninitialized, needs CP count check, CP count check in progress, unmirrored, mirrored, mirror degraded, mirror resynchronizing, failed, limbo, and .
  • mount-state => string, optional

    • [not settable, always] This field shows the volume's mount state. Possible values: "unmounted", "online", "frozen", "destroying", "creating", "mounting", "unmounting", "inconsistent", "reverted", "quiescing", "quiesced", "iron_restricted"
  • name => string

    • Aggregate name.
  • owner-id => integer, optional

    • NVRAM ID of node which currently owns this aggregate's disks. Normally, home-id matches owner-id. But these may be changed by SFO takeover to match the takeover node, and restored by SFO giveback to match home-id. CFO takeover and giveback do not affect owner-id. This information derived from sanown information of aggregate's disk. See 'disk-sanown-detail-info' Range : [0..2^32-1].
  • owner-name => string, optional

    • Name of node which currently owns this aggregate's disks. Normally, home-name matches owner-name. But these may be changed by SFO takeover to match the takeover node, and restored by SFO giveback to match home-name. CFO takeover and giveback do not affect owner-name.
  • plex-count => integer

    • Number of plexes in the aggregate. This value tells us the size of the returned "plex" array. Range: [0..2^31-1].
  • raid-lost-write-state => string, optional

    • State of the RAID Lost Write feature for an aggregate. The possible values are:
    • "aborted" - The RAID Lost Write scrub is no longer running and was aborted on all RAID groups in this aggregate, possibly due to an error.
    • "illegal" - The aggregate contains RAID groups with RAID Lost Write disabled and other RAID groups with RAID Lost Write enabled. This is an invalid state.
    • "inoperative" - The RAID Lost Write scrub is allowed on the aggregate, but it cannot start because the system-wide RAID Lost Write option "raid.lost_write.enable" is set to "off".
    • "off" - RAID Lost Write protection and scrub are disabled on this aggregate.
    • "on" - The aggregate is RAID Lost Write protected and that the RAID Lost Write scrub completed successfully on all RAID groups in this aggregate.
    • "partial" - The RAID Lost Write scrub completed successfully on some of the RAID groups in this aggregate, but was aborted on at least one of the RAID groups.
    • "unknown" - The RAID Lost Write scrub status could not be determined.
    • "upgrade_partial" - The RAID Lost Write scrub is still in progress on some of the RAID groups in this aggregate and was aborted on at least one of the RAID groups.
    • "upgrading" - The RAID Lost Write scrub is still not completed or not yet started on at least one of the RAID groups in this aggregate.
  • raid-status => string

    • RAID status. Possible values: normal, verifying, SnapMirrored, copying, ironing, mirrored, resyncing, mirror degraded, invalid, needs check, initializing, growing, partial, noparity, degraded, reconstruct, out-of-date, foreign, raid4, raid0, raid_dp, mixed_raid_type. These values may appear by themselves or in combination separated by commas (e.g., "reconstruct,growing"). An aggregate could be of only one of the following RAID types:
    • "raid0" - All the raid groups in the aggregate are of type raid0,
    • "raid4" - All the raid groups in the aggregate are of type raid4,
    • "raid_dp" - All the raid groups in the aggregate are of type raid_dp,
    • "mixed_raid_type" - This aggregate contains RAID groups of different RAID types (raid0, raid4, raid_dp).
  • size-available => integer

    • Available bytes in the aggregate. Range: [0..2^64-1].
  • size-total => integer

    • Aggregate total usable size in bytes, not including WAFL reserve and aggregate snapshot reserve. If the aggregate is restricted or offline, a value of 0 is returned. Range : [0..2^64-1].
  • size-used => integer

    • Aggregate bytes used. This value is not returned if the aggregate is unusable (i.e., it's offline). Range: [0..2^64-1].
  • snaplock-type => string, optional

    • The type of the snaplock aggregate. It is present for snaplock aggrs only, i.e. aggrs for which is-snaplock is "true". Possible values - "compliance" or "enterprise"
  • state => string

    • Aggregate state. The possible values: "creating", "destroying", "failed", "frozen", "inconsistent", "iron_restricted", "mounting", "offline", "online", "partial", "quiesced", "quiescing", "restricted", "reverted", "unknown", "unmounted", "unmounting".
  • striping => striping-type, optional

    • Specifies the striping information about the aggregate. Possible values are "striped", "not_striped" and "unknown" In unclustered environments, all aggregates are not striped. In clustered environments, aggregates can be either striped or not striped. When striping information is not known, "unknown" will be returned.
  • type => string

    • The type of aggregate. Possible values: aggr, trad "aggr" (for aggregates that can contain flexible volumes) "trad" (for aggregates embedded in traditional volumes)
  • uuid => string

    • Aggregate's Universal Unique IDentifier. UUIDs are 16-byte quantities that are typically displayed as having five hexadecimal fields separated by hyphens. For example: d2da3566-da53-11d7-a841-000100000529
  • volume-count-striped => integer, optional

    • Number of striped volume constituents in the aggregate. These volumes are also reported in the full volume-count value. This field is for internal use only. Range: [0..2^31-1].
  • wafliron => aggr-wafliron-info, optional

    • Information related to wafliron, the online WAFL file system check/repair tool. This information is returned only when wafliron specific information is available.

aggr-option-info

Option key and value. The possible values are described in the "aggr-set-option" API below.

Fields

  • name => string

    • Option key.
  • value => string

    • Option value.

aggr-space-info

List of aggregates and their space usage information.

Fields

  • size-used => integer

    • The total used space in the aggregate except the space used by snapshots. Range : [0..2^64-1]
  • volume-count => integer

    • Count of online virtual volumes in the aggregate. Range : [0..2^64-1]

aggr-wafliron-info

Information related to wafliron, the online WAFL file system check/repair tool.

Fields

  • last-start-errno => integer, optional

    • The error code of the last attempt to start wafliron on the specific aggregate or the traditional volume. This field is present only if 'wafliron start' was previously attempted.
  • last-start-error-info => string, optional

    • The error information of the last attempt to start wafliron on the specific aggregate or the traditional volume. This field is present only if 'wafliron start' was previously attempted.
  • scan-percentage => integer, optional

    • When present, this field indicates the percentage of blocks that have been scanned in the specified aggregate. This field is present only when wafliron is running and its state is "starting" or "scanning".

    Range: [0..100]

  • state => string

    • When wafliron is run, it goes through different stages/states. This field indicates the current state of wafliron on the specified aggregate.

    Possible values are:

    "waiting_for_commit" - wafliron is finished on this volume but waiting for the changes to be committed or rejected.

    "not_running" - wafliron is not running on this aggregate.

    "starting" - wafliron is starting, allocating, and/or in the initial mounting phase.

    "scanning" - wafliron is scanning inodes, and/or fixing file system inconsistencies.

    "checking_lost_blocks" - wafliron is checking for lost blocks.

    "checking_lost_inodes" - wafliron is checking link counts.

    "finishing" - wafliron is cleaning up.

    "aborting" - wafliron is aborting.

    "unknown" - wafliron state could not be determined.

  • summary-scan-percentage => integer, optional

    • When present and the value is other than -1, this field indicates the percentage of summary blocks that have been scanned in the specified aggregate. This field is present only when wafliron is running and its state is "starting" or "scanning".

    Range: [-1..100]

aggregate-space-info

A set of two structures returning size-related information for a given aggregate and its set of snapshots.

Fields

contained-volume-info

Information about a volume contained in the aggregate.

Fields

  • name => string

    • Volume name.

disk-info

Information for each disk in the plex.

Fields

  • name => string

    • Name of a member disk.

filter-attrs-info

List of filters based on attributes of an aggregate.

Fields

  • all => boolean, optional

    • If true, returns all aggregates owned by the local node and also taken over by the local node. Default is false.
  • is-cfo => boolean, optional

    • If true, returns aggregates with 'cfo' HA policy which includes local and taken over aggregates. Default is false.
  • is-dr-auxiliary => boolean, optional

    • If true, returns aggregates taken over by the local node but owned by the partner of DR (disaster recovery) partner (i.e. auxiliary partner). Default is false.
  • is-local => boolean, optional

    • If true, returns aggregates owned by the local node. It includes taken over aggregates with 'sfo' policy. Default is false.
  • is-sfo => boolean, optional

    • If true, returns aggregates with 'sfo' HA policy which includes local and taken over aggregates. Default is false.

fs-space-info

A structure returning size-related information for a given aggregate.

Fields

  • fs-files-private-used => integer

    • [not settable, online-only] Number of system (not user-visible) files (inodes) used. If the referenced file system is restricted or offline, a value of 0 is returned. Range: [0 - 2^64-1]
  • fs-files-total => integer

    • [settable, online-only] Total user-visible file (inode) count, i.e., maximum number of user-visible files (inodes) that this referenced file system can currently hold. If the referenced file system is restricted or offline, a value of 0 is returned. Range: [0 - 2^64-1]
  • fs-files-used => integer

    • [not settable, online-only] Number of user-visible files (inodes) used in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned. Range: [0 - 2^64-1]
  • fs-hybrid-cache-size-total => integer, optional

    • [not settable, online-only] Total cache size (in bytes) in a hybrid aggregate. If the referenced aggregate is restricted or offline, or if it is not a hybrid aggregate, a value of 0 is returned. Range: [0 - 2^64-1]
  • fs-inodefile-private-capacity => integer

    • [not settable, online-only] Number of inodes that can currently be stored on disk for system (not user-visible) files. This number will dynamically increase as more system files are created. Range: [0 - 2^64-1]
  • fs-inodefile-public-capacity => integer

    • [not settable, online-only] Number of inodes that can currently be stored on disk for user-visible files. This number will dynamically increase as more user-visible files are created. Range: [0 - 2^64-1]
  • fs-maxfiles-available => integer

    • [not settable, always] The count of the maximum number of user-visible files currently allowable on the referenced file system. Range: [0 - 2^64-1]
  • fs-maxfiles-possible => integer

    • [not settable, always] The largest value to which the fs-maxfiles-available parameter can be increased by reconfiguration, on the referenced file system. Range: [0 - 2^64-1] Range: [0 - 2^64-1]
  • fs-maxfiles-used => integer

    • [not settable, online-only] The number of user-visible files currently in use on the referenced file system. Range: [0 - 2^64-1]
  • fs-percent-inode-used-capacity => integer

    • [not settable, online-only] The percentage of disk space currently in use based on user-visible file (inode) count on the referenced file system. Range: [0...100]
  • fs-sis-percent-saved => integer

    • [not settable, online-only] The percentage of disk space saved by eliminating the duplicated blocks on the referenced file system. Range: [0...100]
  • fs-sis-saved-space => integer

    • [not settable, online-only] The total disk space in bytes that is saved by storing only one copy of the duplicated blocks on the referenced file system. Range: [0 - 2^64-1]
  • fs-sis-shared-space => integer

    • [not settable, online-only] The amount of data in bytes that is shared by more than one instance on the referenced file system. Range: [0 - 2^64-1]
  • fs-size-available => integer, optional

    • [not settable, online-only] Number of bytes still available in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned. Range: [0 - 2^64-1]
  • fs-size-total => integer, optional

    • [not settable, online-only] Total size (in bytes) of the referenced file system . If the referenced file system is restricted or offline, a value 0 is returned. Range: [0 - 2^64-1]
  • fs-size-used => integer, optional

    • [not settable, online-only] Number of bytes used in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned. Range: [0 - 2^64-1]
  • fs-total-reserved-space => integer, optional

    • The total disk space in bytes that is reserved on the referenced file system. The reserved space is already counted in the used space, so this element can be used to see what portion of the used space represents space reserved for future use. Range: [0 - 2^64-1]

ha-policy-type

HA Policy of aggregate. It can be controller failover or storage failover or unspecified. Allowed values are:
  • "cfo": Controller FailOver
  • "sfo": Storage FailOver
  • "none": Unspecified

Fields

  • None

mirror-count-info

Various counts information for mirror volumes in the aggregate. This information is returned only when the aggregate contains mirror volumes. Currently, Vfiler owned mirror destination volumes are counted only if those volumes are online.

Fields

node-name

Name of the node.

Fields

  • None

plex-info

Information for a plex.

Fields

  • name => string

    • Plex name, e.g. /myvol/plex0
  • plex-status => string, optional

    • Plex status. Possible values: "normal", "failed", "empty", "invalid", "uninitialized", "failed assimilation", "limbo", "active", "inactive", "resyncing", These values may appear by themselves or in combination separated by commas (e.g., "normal,active")
  • pool => integer, optional

    • The pool to which the majority of disks in the plex belong.

raid-group-info

Information for a particular RAID group.

Fields

  • checksum-style => string

    • Checksum style. The possible values:
    • "advanced_zoned" - advanced_zoned checksum (azcs),
    • "block" - block,
    • "mixed" - mixed,
    • "none" - none,
    • "unknown" - unknown,
    • "wafl" - wafl,
    • "zoned" - zoned.
  • is-cache-tier => boolean

    • "true" if the RAID group is composed of SSDs and the owning aggregate is hybrid (group is not part of usable space).
  • last-scrub-timestamp => integer, optional

    • Time at which the last full scrub completed. If a scrub has never been performed, this value will not be returned. The time value is in seconds since January 1, 1970. Range : [0..2^31-1].
  • name => string

    • RAID group name.

snapshot-space-info

A structure returning consolidated size-related information for all snapshots of the given volume.

Fields

  • snapshot-files-total => integer

    • [settable, online-only] Total file (inode) count, i.e., current maximum number of files (inodes) that this referenced file system can currently hold. If the referenced file system is restricted or offline, a value of 0 is returned. Range: [0 - 2^64-1]
  • snapshot-files-used => integer

    • [not settable, online-only] Number of files (inodes) used in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned. Range: [0 - 2^64-1]
  • snapshot-maxfiles-possible => integer

    • [not settable, always] The largest value to which the maxfiles-available parameter can be increased by reconfiguration, on the referenced file system. Range: [0 - 2^64-1]
  • snapshot-sis-percent-saved => integer

    • [not settable, online-only] The percentage of disk space saved by eliminating the duplicated blocks on the referenced file system. Range: [0...100]
  • snapshot-sis-saved-space => integer

    • [not settable, online-only] The total disk space in bytes that is saved by storing only one copy of the duplicated blocks on the referenced file system. Range: [0 - 2^64-1]
  • snapshot-sis-shared-space => integer

    • [not settable, online-only] The amount of data in bytes that is shared by more than one instance on the referenced file system. Range: [0 - 2^64-1]
  • snapshot-size-available => integer, optional

    • [not settable, online-only] Number of bytes still available in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned. Range: [0 - 2^64-1]
  • snapshot-size-total => integer, optional

    • [not settable, online-only] Total size (in bytes) of the referenced file system. If the referenced file system is restricted or offline, a value 0 is returned. Range: [0 - 2^64-1]
  • snapshot-size-used => integer, optional

    • [not settable, online-only] Number of bytes used in the referenced file system. If the referenced file system is restricted or offline, a value of 0 is returned. Range: [0 - 2^64-1]

striping-type

Striping information of aggregate. Allowed values are:
  • "striped": Member of stripe.
  • "not_striped": Not member of stripe.
  • "unknown": Not known.

Fields

  • None

verify-detail-info

Information about mirror verification.

Fields

  • name => string

    • Name of the aggregate.

volume-space-info

List of flexible volumes in the aggregate and their space usage.

Fields

  • guarantee => string

    • Type of guarantee option set on this volume. Possible values: none, file, volume
  • volume-name => string

    • Name of the volume

warning-code

Warning codes for pre-check mode.

Fields

volume-name

The name of a volume. The maximum string length is 255 characters.

Fields

  • None

access-rights-info

Access rights of single user or single Unix group.

Fields

  • access-rights => string

    • User access rights. The format of the rights can be Unix-style combinations of r w x - or NT-style "No Access", "Read", "Change", and "Full Control".
  • unix-group-name => string, optional

    • Name of the Unix group.
  • user-name => string, optional

    • Name of the user.

address-info

Structure containing address information of servers.

Fields

cifs-functional-level

null

Fields

  • None

cifs-session-info

Information about a single cifs session.

Fields

  • host-name => string, optional

    • NetBios name of the CIFS client. This may be unavailable in certain situations. In such cases, the ONTAPI element 'host-ip' alone provides identity of the host.
  • user => string, optional

    • Name of the user.

cifs-setup-ou

The fully qualified name of a single joinable organizational unit.

Fields

  • None

cifs-setup-site

The fully qualified name of a single joinable organizational unit.

Fields

  • None

cifs-share-acl-info

Information about single share.

Fields

  • share-name => string

    • Name of the share.

cifs-share-info

Information about a single cifs share.

Fields

  • caching => string, optional

    • String specifying the type of caching: "no_caching", "auto_document_caching", "auto_program_caching" and "manual_caching".
  • dir-umask => integer, optional

    • File mode creation mask for a share in qtrees with Unix or mixed security styles. The mask restricts the initial permissions setting of a newly created directory. This mask overrides one set with "umask".
  • file-umask => integer, optional

    • File mode creation mask for a share in qtrees with Unix or mixed security styles. The mask restricts the initial permissions setting of a newly created file. This mask overrides one set with "umask".
  • forcegroup => string, optional

    • name of the group to which files to be created in the share belong to.
  • is-access-based-enum => boolean, optional

    • If true Access Based Enumeration (ABE) is enabled, else it is disabled. ABE filtered shared folders are visible to a user based on that individual user's access rights, preventing the display of folders or other shared resources that the user does not have rights to access. Its value is returned only if it is non-default value. Its default value is false.
  • is-browse => boolean, optional

    • if true, this share can be browsed. Its values is returned only if it is non-default value. Its default value is true.
  • is-namespace-caching-allowed => boolean, optional

    • If true, namespace caching is enabled on the share. If false or not specified, namespace caching is disabled. If namespace caching is enabled on a share, clients are allowed to cache the directory enumeration results for better performance.
  • is-symlink-strict-security => boolean, optional

    • If true or not specified, strict symlink security is enabled. If false, allows clients to follow symbolic links to destinations on this filer but outside of the current share. Its value is returned only if it is non-default value. Its default value is true.
  • is-vol-offline => boolean, optional

    • If true, volume is offline and the shares are not available. Its value is returned only if it is non-default value. Its default value is false.
  • is-vscan => boolean, optional

    • If true or not specified, virus scan is done when clients open files on this share. Its value is returned only if it is non-default value. Its default value is true.
  • is-vscanread => boolean, optional

    • If true or not specified, virus scan is done when clients open files on this share for read access. Its value is returned only if it is non-default value. Its defalut value is true.
  • is-widelink => boolean, optional

    • If true, allows clients to follow absolute symbolic links outside of this share, subject to NT security. Its value is returned only if it is non-default value. Its default value is false.
  • maxusers => integer, optional

    • max no. of simultaneous connections to the share.
  • share-name => string

    • name of the cifs share.
  • umask => integer, optional

    • File mode creation mask for a share in qtrees with Unix or mixed security styles. The mask restricts the initial permissions setting of newly created files and directories. This field is ignored when both dir-umask and file-umask are present.

cifs-top-info

Information about a single cifs top.

Fields

  • suspicious-per-sec => integer

    • The number of "suspicious" events per second due to the following conditions: ACCESS-DENIED returned for FindFirst ACCESS-DENIED returned for Open/CreateFile ACCESS-DENIED returned for DeleteFile SUCCESS returned for DeleteFile SUCCESS returned for TruncateFile

connection-info

Structure containing information on the connection.

Fields

homedir-path-info

path to user home directory paths Unix style path to user home directories, example: /vol/vol1/users1 The paths are listed in the same order that the filer will use to evaluate whether a user has a cifs home directory.

Fields

  • None

nbalias-name-info

NetBIOS alias for the filer

Fields

  • None

path-error-info

Error description

Fields

  • error-path => string

    • Homedir path, if any, which had the error. This value is set to NULL if there is no path associated with the error.

volumes-list-info

Information about a single volume.

Fields

  • volume => string

    • Name of the volume.

block-range

Structure containing source and destination block range for sub-file/sub-LUN cloning.

Fields

clone-id-info

Structure containing clone ID information.

Fields

  • volume-uuid => string

    • uuid of the volume.

ops-info

Structure containing information of a clone operation.

Fields

  • block-ranges => block-range[], optional

    • List of block ranges specified for sub-file/sub-LUN cloning. In case of complete file cloning there will be no output corresponding to this.
  • blocks-copied => integer, optional

    • Number of blocks that have been copied so far for running clone operation. The cloning operation shares destination blocks with source block. But if source block has already reached maximum number of sharing supported by WAFL, then block is copied for destination. It is recommended that if blocks are being copied, then user should change the source for next clone operation.
  • clone-id => clone-id-info, optional

    • Unique ID information of the clone operation.
  • clone-state => string

    • State of the clone operation. It could be 'running', 'failed' or 'completed'. For 'completed' state there will be no other field in ops-info output.
  • error => integer, optional

    • Error code corresponding to reason of failure. If error code is EDENSE_SHUTDOWN or EDENSE_FAILOVER, the clone operation will be restarted automatically after giveback/takeover or next reboot. If user has not aborted the clone operation using clone-stop, then for any other error code user should do clone-clear.
  • reason => string, optional

    • Reason of failure if clone operation could not complete successfully.

copyoffload-status-info

Copy offload status information

Fields

  • bytes-copied => integer

    • Number of bytes copied thus far.
  • copy-id => string

    • Unique identifier assigned to this copy operation.
  • copyoffload-error => integer, optional

    • Error code corresponding to reason for failure: error codes are listed in the copyoffload-copy-status description. This field is used when state is "failure".
  • copyoffload-state => string

    • State of the copy operation. Values may be "running", "failed", "completed", or "aborted".
  • destination-path => string

    • Full path of the destination file to where the data will be copied, in /vol// format.
  • length => integer

    • Requested number of bytes to copy from the source file to the destination file. A value of 0 is interpreted as "copy from source offset to end of file".
  • source-path => string

    • Full path of the source file from where the data will be copied, in /vol// format.

datetime

The number of seconds since January 1, 1970. Range : [0..2^31-1].

Fields

  • None

date

Date (in seconds since Jan. 1, 1970 12:00:00) Range : [0..2^31-1].

Fields

  • None

diagnosis-alert-definition-info

System Health Alert Definition 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

  • alert-type => hm-alert-type, optional

    • Type of alert (other,communications,quality-of-service,processing-error,device,environmental,model-change,security). Attributes: non-creatable, non-modifiable
  • monitor => hm-type, optional

    • Type of health monitor (e.g. node_connect, system_connect, system). Attributes: key, non-creatable, non-modifiable

diagnosis-alert-info

System Health Alert 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

  • acknowledge => boolean, optional

    • Acknowledge the alert condition. Attributes: non-creatable, modifiable
  • acknowledger => string, optional

    • Person who acknowledged this alert Attributes: non-creatable, modifiable
  • alert-id => string, optional

    • Alert identification. Attributes: key, non-creatable, non-modifiable
  • corrective-actions => string, optional

    • Recommended actions to correct the problem reported by alert. Attributes: non-creatable, non-modifiable
  • monitor => hm-type, optional

    • Type of health monitor (e.g. node_connect, system_connect, system). Attributes: key, non-creatable, non-modifiable
  • node => string, optional

    • Node hosting this health monitor. Attributes: key, non-creatable, non-modifiable
  • perceived-severity => hm-perceived-sev, optional

    • Severity of alert. Attributes: non-creatable, non-modifiable
  • possible-effect => string, optional

    • Possible effect seen due to this problem. Attributes: non-creatable, non-modifiable
  • probable-cause => hm-probable-cause, optional

    • Probable cause for alert generation. Attributes: non-creatable, non-modifiable
  • probable-cause-description => string, optional

    • Detailed description of probable cause for alert generation. Attributes: non-creatable, non-modifiable
  • subsystem => hm-subsystem, optional

    • Type of subsystem being monitored (e.g. sas_connect). Attributes: non-creatable, non-modifiable
  • suppress => boolean, optional

    • Suppress this alert. Attributes: non-creatable, modifiable
  • suppressor => string, optional

    • Person who suppressed this alert Attributes: non-creatable, modifiable

diagnosis-config-info

System Health Config 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

  • aggregator => hm-type, optional

    • Aggregating health monitor that aggregates status from this health monitor. Attributes: non-creatable, non-modifiable Possible values:
    • "node_connect" ... node scope health monitor ,
    • "system_connect" ... cluster scope health monitor ,
    • "system" ... aggregator of health monitor status ,
  • context => hm-scope, optional

    • Scope of health monitor (node-context, cluster-context). Attributes: non-creatable, non-modifiable Possible values:
    • "node_context" ,
    • "cluster_context"
  • health => hm-status, optional

    • Status of health monitor (ok, ok-with-suppressed, degraded). Attributes: non-creatable, non-modifiable Possible values:
    • "ok" ,
    • "ok_with_suppressed" ,
    • "degraded" ,
    • "unreachable" ,
    • "unknown"
  • init-state => hm-subsystem-discovery-state, optional

    • Subsystem initialization state of health monitor Attributes: non-creatable, non-modifiable Possible values:
    • "invalid" ,
    • "initializing" ,
    • "initialized" ,
    • "start_discovery" ,
    • "start_rediscovery" ,
    • "discovered_partially" ,
    • "discovery_done" ,
    • "discovery_max"
  • monitor => hm-type, optional

    • Type of health monitor. Attributes: key, non-creatable, non-modifiable Possible values:
    • "node_connect" ... node scope health monitor ,
    • "system_connect" ... cluster scope health monitor ,
    • "system" ... aggregator of health monitor status ,
  • node => string, optional

    • Node hosting this health monitor. Attributes: key, non-creatable, non-modifiable

diagnosis-policy-definition-info

System Health Policy Definition 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

  • alert-id => string, optional

    • Alert identifier for alert to be generated on policy rule match. Attributes: non-creatable, non-modifiable
  • enable => boolean, optional

    • Enable/disable this policy. Attributes: non-creatable, modifiable
  • monitor => hm-type, optional

    • Type of health monitor (e.g. node_connect, system_connect, system). Attributes: key, non-creatable, non-modifiable
  • node => string, optional

    • Node hosting this health monitor. Attributes: key, non-creatable, non-modifiable

diagnosis-status

System Health Status 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

  • status => hm-status, optional

    • Overall system health (ok,ok-with-suppressed,degraded,unreachable) as determined by the diagnosis framework. Attributes: non-creatable, non-modifiable

diagnosis-subscriptions-info

System Health Subscriptions 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

  • creation-time => datetime, optional

    • Time at which this subscription was created. Attributes: non-creatable, non-modifiable
  • fail-thresh => integer, optional

    • Failure threshold for notification. Attributes: optional-for-create, modifiable
  • instance-name => string, optional

    • Instance name of changed resource. Attributes: optional-for-create, modifiable
  • max-notify-period => integer, optional

    • Maximum expected time for Notification to complete. Attributes: optional-for-create, modifiable
  • monitor => hm-type, optional

    • Type of source health monitor (e.g. node_connect, system_connect, system). Attributes: key, required-for-create, non-modifiable
  • node => string, optional

    • Node hosting this health monitor and sends out notifications Attributes: key, non-creatable, non-modifiable
  • notify-table => string, optional

    • Table name for DSMF notification. Attributes: optional-for-create, modifiable
  • psc-option => boolean, optional

    • Enable/Disable periodic status confirmation. Attributes: optional-for-create, modifiable
  • time-gap-notify => integer, optional

    • Time Period between two notifications. Attributes: optional-for-create, modifiable

diagnosis-subsystem-config-info

System Health Subsystem Status 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

  • health => hm-status, optional

    • Health of Subsystem. Attributes: non-creatable, non-modifiable Possible values:
    • "ok" ,
    • "ok_with_suppressed" ,
    • "degraded" ,
    • "unreachable" ,
    • "unknown"
  • init-state => hm-subsystem-discovery-state, optional

    • Initialization State of Subsystem. Attributes: non-creatable, non-modifiable Possible values:
    • "invalid" ,
    • "initializing" ,
    • "initialized" ,
    • "start_discovery" ,
    • "start_rediscovery" ,
    • "discovered_partially" ,
    • "discovery_done" ,
    • "discovery_max"
  • subsystem => hm-subsystem, optional

    • Type of subsystem being monitored

    Possible values:

    • 'sas_connect',
    • 'ha_health',
    Attributes: key, non-creatable, non-modifiable

hm-alert-type

Type of alert

Fields

  • None

hm-event-type

Event type

Fields

  • None

hm-notify-type

Notify type

Fields

  • None

hm-perceived-sev

Alert severity

Fields

  • None

hm-probable-cause

Probable cause for alert generation

Fields

  • None

hm-scope

Node or Cluster context of Health Monitor Possible values:
  • "node_context" ,
  • "cluster_context"

Fields

  • None

hm-status

Health Monitor Status Possible values:
  • "ok" ,
  • "ok_with_suppressed" ,
  • "degraded" ,
  • "unreachable" ,
  • "unknown"

Fields

  • None

hm-subsystem

Health Monitor Subsystem

Fields

  • None

hm-subsystem-discovery-state

Health Monitor Subsystem State Possible values:
  • "invalid" ,
  • "initializing" ,
  • "initialized" ,
  • "start_discovery" ,
  • "start_rediscovery" ,
  • "discovered_partially" ,
  • "discovery_done" ,
  • "discovery_max"

Fields

  • None

hm-type

Type of Health Monitor

Fields

  • None

disk-detail-info

Disk status information.

Fields

  • aggregate => string, optional

    • Aggregate that the disk resides on. Returned for disks contained on a flexible volume. Not returned for traditional volumes.
  • bay => string

    • Disk bay. If disk bay can't be determined, value will be "?".
  • broken-details => string, optional

    • Reason for the disk failure, if raid-state is 'broken'. Possible values are 'unknown', 'failed', 'admin failed', 'labeled broken', 'init failed', 'admin removed', 'not responding', 'pulled', 'bad label', 'bypassed', 'SFO Disk' and 'not failed'. If raid-state is not 'broken', broken-details will be omitted in the ouput.
  • bytes-per-sector => integer

    • Bytes per sector. Range : [0..2^31-1].
  • checksum-compatibility => string

    • An indication of the checksum types that this disk is capable of supporting. Each possible return value represents one or more checksum types.

    Starting in Data ONTAP 8.1, "zoned/block" is no longer supported.

    Possible values are:

    • "advanced_zoned" - Supports advanced_zoned checksum.
    • "block" - Supports block checksum.
    • "none" - No checksum support.
    • "zoned/advanced_zoned" - Supports zoned and advanced_zoned checksum.
    • "zoned/block" - Supports zoned and block checksum.
  • copy-destination => string, optional

    • The name of the disk selected as the destination to copy this disk when it must be replaced (is-prefailed or is-replacing is true). This element is not returned if the destination is not selected. The destination might not be present even when is-prefailed or is-replacing is true, if there is no appropriate spare, or other disk copy is in progress, or the destination was not yet selected, including immediately after disk-replace-start.
  • copy-percent => integer, optional

    • Percent of disk copy done, if disk is involved in Rapid RAID Recovery, either as the source (is-prefailed or is-replacing is true) or as the destination (raid-state is 'copy') of disk copy. This element is not returned if the destination is not selected yet. Range : [0..100].
  • disk-type => string

    • Type of disk: ATA, BSAS, EATA, FCAL, FSAS, LUN, MSATA, SAS, SATA, SCSI, SSD, XATA, XSAS, or unknown.
  • effective-disk-type => string

    • Disks with same effective-disk-type are compatible, and they can be used in the same aggregate, even though their physical disk type, as reported by disk-type may be different. Possible values are the same as for disk-type: ATA, BSAS, EATA, FCAL, FSAS, LUN, MSATA, SAS, SATA, SCSI, SSD, XATA, XSAS, or unknown.
  • firmware-revision => string

    • Firmware revision of disk. The format of the firmware revision will vary depending on the type of disk and its vendor.
  • is-prefailed => boolean, optional

    • True if the disk is prefailed and undergoing disk copy (as the source) or waiting for such disk copy to be started, false otherwise.
  • is-replacing => boolean, optional

    • True if the disk is marked to be replaced with another disk and undergoing disk copy (as the source) or waiting for such disk copy to be started, false otherwise.
  • is-zeroed => boolean, optional

    • True if the disk is a spare and has already been zeroed, false otherwise. If disk is not a spare or if it is currently being zeroed, this element will not be included with the output.
  • name => string

    • Name of the disk, e.g. v1.1
  • node => string

    • Controller supplying this disk record.
  • port-name => string

    • The port name of the disk object, e.g. FC:A.
  • raid-group => string, optional

    • Raid group disk belongs. Not returned if disk doesn't belong to any raid group.
  • raid-state => string

    • Raid state. Possible values are : partner, broken, zeroing, spare, copy, pending, reconstructing, present and unknown.
  • raid-type => string

    • Raid type. Possible values are : pending, parity, dparity, data, and unowned.
  • reconstruction-percent => integer, optional

    • Percent of reconstruction done, if the disk is undergoing reconstruction (raid-state is 'reconstructing'). This element is not returned if the disk is not being reconstructed. Range : [0..100].
  • rpm => integer, optional

    • Rotational speed in revolutions per minute. Possible values are: 5400, 7200, 10000, and 15000. This element is not returned when the value is not known, or when it does not apply.
  • scrub-count => integer

    • Number of times the drive was scrubbed since the controller was powered on last. Range: [0..2^64-1]
  • serial-number => string

    • Disk serial number. Maximum length of 129 characters.
  • shelf => string

    • Disk shelf. If disk shelf can't be determined, value will be "?".
  • vendor-id => string

    • Vendor of this disk.
  • volume => string, optional

    • Volume the disks is used in. Not returned if disk isn't used in any volume or if the disk belongs to a partner or if the disk is in an aggregate.

disk-name

name of a disk.

Fields

  • None

disk-sanown-detail-info

Disk sanown information.

Fields

  • checksum => string, optional

    • Only returned on RAID array LUNs. The possible values:
    • "advanced_zoned" - advanced_zoned checksum (azcs),
    • "block" - block,
    • "zoned" - zoned.
  • home => string, optional

    • The home of the disk. On NG will be different than owner if the home node has been taken over. On Classic this will be the same as owner. If the disk has no owner, this will not be returned.
  • home-id => integer, optional

    • ID (NVRAM ID) of disk home. Range : [0..2^32-1].
  • name => string

    • Name of the disk, e.g. v1.1 Wildcarding for disk string is suuported, e.g. v1.*
  • owner => string, optional

    • Current owner of the disk. If disk has no owner, this will not be returned.
  • owner-id => integer, optional

    • ID (NVRAM ID) of owner if there is one. Range : [0..2^32-1].
  • pool => integer, optional

    • Pool the disk belongs to, if it has a owner.
  • reserved-by => integer

    • ID (NVRAM ID) of node with the reservation on this disk, 0 if there is none. Range : [0..2^32-1].
  • type => string, optional

    • Indicates the type of disk or device being being reported. Values are one of following: "SCSI", "FCAL", "D_ATA", "E_ATA", "LUN", "MSATA", "SSD", "UNKNOWN"

disk-sanown-filer-detail-info

Disk sanown filer information.

Fields

storage-ssd-info

Storage info block for solid-state storage devices.

Fields

  • percent-rated-life-used => integer, optional

    • An estimate of the percentage of device life that has been used, based on the actual device usage and the manufacturer's prediction of device life. A value greater than 99 indicates that the estimated endurance has been consumed, but may not indicate a device failure. Omitted if value is unknown.
  • percent-spares-consumed => integer, optional

    • Percentage of device spare blocks that have been used. Each device has a number of spare blocks that will be used when a data block can no longer be used to store data. This value reports what percentage of the spares have already been consumed. Omitted if value is unknown.

v-series-detail-info

LUN status from RAID array LUNs

Fields

  • alternate-array-node-wwn => string

    • The RAID array LUN alternate path is the path that can be used to communicate with the LUN, but not currently used. This is the WWNN (World Wide Node Name) of the array FC port used as the secondary path.
  • alternate-array-port-wwn => string

    • The RAID array LUN alternate path is the path that can be used to communicate with the LUN, but not currently used. This is the WWPN (World Wide Port Name) of the array FC port used as the secondary path.
  • alternate-array-switch-port-wwn => string, optional

    • The RAID array LUN alternate path is the path that can be used to communicate with the LUN, but not currently used. This is the WWN of the switch FC port connected to the array FC port used as primary path. This field is present in switch attached configrations only.
  • alternate-controller-port-wwn => string

    • The RAID array LUN alternate path is the path that can be used to communicate with the LUN, but not currently used. This is the WWN of the FC port controller used as secondary path.
  • primary-array-node-wwn => string

    • The RAID array LUN primary path is the path that is currently used to communicate with the LUN. This is the WWNN (World Wide Node Name) of the array FC port used as primary path.
  • primary-array-port-wwn => string

    • The RAID array LUN primary path is the path that is currently used to communicate with the LUN. This is the WWPN (World Wide Port Name) of the array FC port used as primary path.
  • primary-array-switch-port-wwn => string, optional

    • The RAID array LUN primary path is the path that is currently used to communicate with the LUN. This is the WWN of the switch FC port connected to the array FC port used as primary path. This field is present in switch attached configrations only.
  • primary-controller-port-wwn => string

    • The RAID array LUN primary path is the path that is currently used to communicate with the LUN. This is the WWN of the FC port controller used as primary path.
  • product-id => string

    • Product id string of the raid array lun resides on.

param

one parameter required by the event.

Fields

  • None

fc-config-info

null

Fields

  • adapter-name => string

    • FC adapter name (e.g. 0c)
  • adapter-state => string

    • Indicates what the adapter configuration state is. Possible values:
      "UNDEFINED" - The default state. The adapter has never been configured.
      "CONFIGURED" - The adapter port is configured and the adapter is operational.
      "UNCONFIGURED" - The adapter is unconfigured. The initiator driver is attached, but the adapter is not operational.
      "PENDING" - The adapter is waiting for a filer reboot to effect an fc-type change.
    While in the PENDING state the adapter can not be used
  • adapter-status => string

    • Possible values:
      "online" - adapter driver is enabled
      "offline" - adapter driver is disabled
  • adapter-type => string

    • Indicates which driver is attached to the adapter. Possible values:
      "initiator" - the storage Initiator driver (default)
      "vi" - the FC-VI cluster interconnect driver
      "target" - the FCP Target driver

aliases-info

A list of WWPNs and their aliases generated according to the input - alias, WWPN or nothing.

Fields

fcp-adapter-initiators-info

A list of initiators currently connected to the FC adapter or FCP data LIF.

Fields

  • adapter => string

    • In Data ONTAP 7-Mode, the name of the physical FC adapter. In Data ONTAP Cluser-Mode, the name of the FCP data LIF.

fcp-adapter-nameserver-object-info

Information about a nameserver object entry.

Fields

  • adapter => string

    • The adapter this nameserver object is visible through.
  • class-service => string, optional

    • Registered class of services as defined in the FC-FS standard. This element is omitted if the device has not registered a class of service. Comma separated possible values: "F", "1", "2", "3", "4", and "6".
  • fc4-type => string, optional

    • Registered FC4 Types. This element is omitted if the device has not registered an FC4 Type. Comma separated possible values: "llc/snap", "ipfc", "fcp", "gpp", "ipi-3m", "ipi-3s", "ipi-3p", "sbccs-ch", "sbccs-cu", "fc-sb-3_ch2cu", "fc-sb-3_cu2ch", "fc-gs", "fc-sw", "fc-al", "snmp", "hippi-fp", "mil-std-1553", "asm", "fc-vi", and "fc-av".
  • node-name => string, optional

    • World wide node name (WWNN) of this entry. This element is omitted if the device has not registered a WWNN.
  • port-type => string

    • Port type of this entry. Possible values: "n-port", "nl-port", "fnl-port", "nx-port", "f-port", "fl-port", "e-port", "b-port", "nv-port", "fv-port", "sd-port", "te-port", "tl-port", and "none".

fcp-adapter-stats-info

Statistics for one FC adapter.

Fields

  • adapter => string

    • Which FC adapter.
  • is-sfp-optical-transceiver-valid => boolean

    • Validity of the optical transceiver. Until Data ONTAP 8.0.0, this field was incorrectly named "is-spf-optical-transceiver-valid". While that field is also returned for backward compatibility, all new applications must use the current version.
  • lip-resets => integer

    • Number of times that a selective Reset LIP (Loop Initialization Primitive) occurred. LIP reset is used to preform a verndorspecific reset at the loop port specified by the AL-PA value.
  • lr-sent => integer

    • Number of LRs (Link Reset) sent from the target HBA. Range [0..2^31-1]
  • nos-received => integer

    • Number of NOSs (Not_Operational Primitive Sequence)received by the target HBA. Range [0..2^31-1]
  • total-logins => integer

    • Counts the times of initiators added. Each time a new initiator is added, the total logins is incremented by 1. Each time an initiator is removed, the total logouts is incremented by 1.
  • total-logouts => integer

    • Counts the times of initiators removed. Each time a new initiator is added, the total logins is incremented by 1. Each time an initiator is removed, the total logouts is incremented by 1.

fcp-adapter-topology-attached-port-info

Information about the attached device.

Fields

  • port-id => integer

    • Assigned port identifier of the attached device. A value of 0 indicates no value has been assigned. Range: [0..2^24-1]
  • port-name => string

    • World wide port name (WWPN) of the attached device. The format is: XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit.

fcp-adapter-topology-switch-info

Information about an FC switch connected to an FC adapter.

Fields

  • adapter => string

    • The name of the adapter this switch is visible through.
  • node-name => string

    • Node name of the FC switch. The format is: XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit.

fcp-adapter-topology-switch-port-info

Information about the FC switch port.

Fields

  • port-name => string

    • World wide port name (WWPN) of the port. The format is: XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit.
  • port-state => string

    • Port state. Possible values: "online", "offline", "testing", "fault", and "unknown".
  • port-type => string

    • Port type. Possible values: "n-port", "nl-port", "fnl-port", "nx-port", "f-port", "fl-port", "e-port", "b-port", "nv-port", "fv-port", "sd-port", "te-port", "tl-port", and "none".

fcp-adapter-zone-info

Information about a zone.

Fields

  • adapter => string

    • The adapter this zone is visible through.

fcp-adapter-zone-member-info

Information about a zone member.

Fields

  • domain-id => integer, optional

    • Domain identifier of the switch. This element is returned if the zone-member-type is "domain-id-port". Range: [0..2^32-1]
  • fabric-port-name => string, optional

    • World wide port name (WWPN) of the fabric port. This element is returned if the zone-member-type is "fabric-port-name". The format is: XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit.
  • node-name => string, optional

    • World wide node name (WWNN) of the N-port. This element is returned if the zone-member-type is "node-name". The format is: XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit.
  • port => integer, optional

    • Port number on the switch. This element is returned if the zone-member-type is "domain-id-port". Range: [0..2^32-1]
  • port-name => string, optional

    • World wide port name (WWPN) of the N-port. This element is returned if the zone-member-type is "port-name". The format is: XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit.
  • zone-member-type => string

    • The type of zone member. Possible values are: "port-name", "domain-id-port", "port-id", "node-name", "fabric-port-name", and "unknown".

fcp-config-adapter-info

Configuration information for one physical FC adapter.

Fields

  • adapter => string

    • The slot name of the FC adapter.
  • adapter-type => string, optional

    • Type of the adapter. Possible values are "physical", "local", "standby", "partner". If an error occured while retrieving info for this adapter, this will not be returned. Starting with Data ONTAP 8.0, only single_image cfmode is supported. Outputs related to other cfmodes are deprecated and no longer returned by this api.
  • error-msg => string, optional

    • Error message, if an error occured while retrieving info for this adapter. This will only be used if listing all adapters. If an error occurred while retrieving info for a specific adapter, the API will fail with error message.
  • loop-id => integer, optional

    • Loop address of adapter. If an error occured while retrieving info for this adapter, this will not be returned. This value lies between 0 and 255. Starting with Data ONTAP 8.0, only single_image cfmode is supported. Outputs related to other cfmodes are deprecated and no longer returned by this api.
  • media-type => string, optional

    • Media configured for this adapter, "ptp", "loop", or "auto". If an error occured while retrieving info for this adapter, this will not be returned.
  • node-name => string, optional

    • FCP World Wide Node Name (WWNN) of the adapter. If an error occured while retrieving info for this adapter, this will not be returned.
  • partner-adapter => string, optional

    • Name of partner adapter for takeover if configured. Value of "none" indicates no partner set for this adapter. If an error occured while retrieving info for this adapter, this will not be returned. Starting with Data ONTAP 8.0, only single_image cfmode is supported. Outputs related to other cfmodes are deprecated and no longer returned by this api.
  • port-id => integer, optional

    • Port address of adapter. If an error occured while retrieving info for this adapter, this will not be returned. Starting with Data ONTAP 8.0, only single_image cfmode is supported. Outputs related to other cfmodes are deprecated and no longer returned by this api.
  • port-name => string, optional

    • FCP World Wide Port Name (WWPN) of adapter. If an error occured while retrieving info for this adapter, this will not be returned.
  • speed => string, optional

    • Speed configured for this adapter. Possible values: "auto", "1Gb", "2Gb", "4Gb", "8Gb", "10Gb", "16Gb". If an error occured while retrieving info for this adapter, this will not be returned.
  • standby => boolean, optional

    • "true" if adapter is on standby, "false" otherwise. If an error occured while retrieving info for this adapter, this will not be returned. Starting with Data ONTAP 8.0, only single_image cfmode is supported. Outputs related to other cfmodes are deprecated and no longer returned by this api.
  • state => string, optional

    • Status of the adapter. Possible values are "startup", "uninitialized", "initializing firmware", "link not connected", "waiting for link up", "online", "link disconnected", "resetting", "offline", "offlined by user/system". If an error occured while retrieving info for this adapter, this will not be returned.
  • switch-port => string, optional

    • Switch and port this adapter is connected to. The string will be of the form X:Y where X is the name of the switch and Y is the port value. verbose only.

fcp-connected-initiator-info

Information about an initiator connected to an FC adapter.

Fields

  • node-name => string

    • World Wide Node Name (WWNN) of initiator.
  • port-name => string

    • World Wide Port Name (WWPN) of the initiator.

fcp-port-name-info

Information for one valid local port name.

Fields

  • fcp-adapter => string, optional

    • Only if this WWPN is being used by a Fibre Channel interface, the name of the interface is returned. In Data ONTAP 7-Mode, the name of a local adapter. In Data ONTAP Cluster-Mode, the name of an FCP data LIF.
  • is-used => boolean

    • This indicates whether this WWPN is being used by a Fibre Channel target interface.
  • port-name => string

    • A Fibre Channel WWPN in the form XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit.

portname-alias-name

Aliases for this WWPN

Fields

fc-ports

Information about the ports belonging to the fiber channel adapter

Fields

  • port-type => string

    • Type of port. Possible values: "l-port", loop port, node port used to connect a node to a Fibre Channel loop. "nl-port", network+loop port, node port which connects to both loops and switches. "n-port", network port, node port used to connect a node to a Fibre Channel switch.
  • switch-wwn => string, optional

    • This is the world wide name of the switch, if any, connected to the FC port. Field is not present when port-type is "l-port"

link-state-info

list link-state info of a specific adapter channel

Fields

  • adapter-name => string

    • The adapter name is either a slot number, or, if a port letter is also presented, a slot number and port letter concatenated into a single name.
  • link-state => string

    • Possible values: "initing", "down", "up", "offline-physical", "offline-logical", or "zombified", which the adapter has stopped sending I/O and is ignoring link events. This state may occur when shelf firmware is being updated.

managed-feature

A managed feature in ONTAP. Possible values:
  • "cifs"
  • "nfs"
  • "iscsi"
  • "fcp"
  • "dedupe"
  • "flexclone"
  • "compression"
  • "snaprestore"
  • "snaplock"
  • "snaplock_enterprise"
  • "snapvault_primary"
  • "snapvault_secondary"
  • "snapmirror"
  • "syncmirror"
  • "flexcache"
  • "ndmp"
  • "multistore"
  • "cdmi"
  • "snapdrive_windows"
  • "snapmanager_exchange"
  • "snapmanager_sql"
  • "snapmanager_sharepoint"
  • "snapmanager_hyperv"
  • "snapdrive_unix"
  • "snapmanager_oracle"
  • "snapmanager_sap"

Fields

  • None

managed-feature-status

Represents the status of a managed feature. Possible values:
  • "on" - feature is entitled and turned on,
  • "available" - feature is entitled and available to be turned on. Its current on/off status is unknown,
  • "on_not_configurable" - feature is no longer entitled but it was turned on before and remains to be on. Feature is not configurable at the moment,
  • "off" - feature is entitled but turned off,
  • "not_available" - feature is not entitled, licensing infrastructure is unavailable, or other configuration check prevents feature use. The field notes can provide additional information.

Fields

  • None

managed-feature-status-info

Status information about a managed feature. 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

  • notes => string, optional

    • Additional information about the managed feature status. Attributes: non-creatable, non-modifiable

digest-algorithm

Digest algorithm used for fingerprint computation. Possible values: "sha-256" or "md5".

Fields

  • None

file-fingerprint-info

Fingerprint information about single file.

Fields

  • access-time => integer, optional

    • Last access time of the file attributes in seconds in the standard UNIX format since January 1, 1970 00:00:00. The field is included for regular files and files on Non-Snaplock volumes. Time is taken out of system clock. Range : [0..2^64-1]
  • changed-time => integer

    • Last changed time of the file attributes in seconds in the standard UNIX format since January 1, 1970 00:00:00. For WORM files last change time for file attributes occurs when file is committed to WORM. Time is taken out of system clock for regular files and time is taken out of Compliance Clock when file is committed to worm. The changed-time can be in wraparound format for WORM files. The flag is-changed-time-wraparound indicates that changed time is in the wraparound format. The wraparound format indicates that dates after 01/19/2038 are mapped from 01/01/1970 - 12/31/2002 to 01/19/2038 - 01/19/2071 Range : [0..2^64-1]
  • creation-time => integer

    • Creation time of the file in seconds in the standard UNIX format since January 1, 1970 00:00:00. Time is taken out of system clock. Range : [0..2^64-1]
  • file-type => string

    • Type of the file. Possible values: "worm", "worm_appendable", "worm_log" and "regular".
  • fileid => integer

    • A unique number within filesystem identifying the file for fingerprint. Range : [0..2^31-1]
  • formatted-access-time => string

    • Last access time of the file formatted in a human-readable format :: in GMT timezone. The field is included for regular files and files on Non-Snaplock volumes.
  • formatted-retention-time => string, optional

    • Expiry date of the worm file formatted in a human-readable format. This takes care of wraparound dates and prints the expiry date of the file in the format :: in GMT timezone. A value of "infinite" indicates that this file has infinite retention time. This field is not included for regular files and files on Non-Snaplock volumes.
  • is-changed-time-wraparound => boolean, optional

    • This field is included for WORM files when changed-time is in wraparound format. This field is true if the date represented in changed-time is in wraparound format and false if changed-time is not is not in wraparound format. The wraparound format indicates that dates after 01/19/2038 are mapped from 01/01/1970 - 12/31/2002 to 01/19/2038 - 01/19/2071. This field is not included for regular files.
  • is-wraparound => boolean, optional

    • True if the date represented in retention-time is in wraparound format. The wraparound format indicates that dates after 01/19/2038 are mapped from 01/01/1970 - 12/31/2002 to 01/19/2038 - 01/19/2071. This field is not included if retention-time is not included.
  • metadata-fingerprint => string, optional

    • The digest value of metadata of the file The metadata fingerprint is calculated for file size, file ctime, file mtime, file crtime, file retention time, file uid, gid and file type. The fingerprint is base64 encoded. This field is not included if scope is 'data_only'.
  • modified-time => integer

    • Last modification time of the file in seconds in the standard UNIX format since January 1, 1970 00:00:00. Time is taken out of system clock. Range : [0..2^64-1]
  • owner-sid => string

    • The owner SID of the file. This field is included in the case when file has NTFS security style.
  • path => string

    • Full path of the file that is fingerprinted. The value begins with /vol/.
  • retention-time => integer, optional

    • Retention time of the file in seconds in the standard UNIX format since January 1, 1970 00:00:00. This field is not included for regular files, files on Non-Snaplock volumes and files with infinite retention. The flag is-wraparound indicates that retention is in the wraparound format. The wraparound format indicates that dates after 01/19/2038 are mapped from 01/01/1970 - 12/31/2002 to 01/19/2038 - 01/19/2071 The time is taken out of Compliance Clock. Range : [0..2^64-1]

file-info

Information about a single file.

Fields

  • acl-type => string

    • The type of access control list (acl) on the file. Possible values are: "no_acl", "nt_acl", "nfs_acl", and goddess forbid, "unknown".
  • creation-timestamp => integer

    • Creation time of the file. The value is in seconds since January 1, 1970.
  • file-size => integer

    • The size of the file in bytes.
  • file-type => string

    • Type of the file. Possible values: file, directory, blockdev, chardev, symlink, socket, fifo, stream, lun.
  • group-id => integer

    • The integer id of the group owner of the file.
  • inode-number => integer

    • The file node number.
  • is-empty => boolean, optional

    • This element tells whether directory is empty or not. Directory is considered empty if it only contains entries for "." and "..". This element is present if file is directory. In some special error cases like volume goes offline in between or directory is moved in the middle of getting this info, this field might not get set.
  • is-vm-aligned => boolean, optional

    • Returns true if the file is vm-aligned. A vm-aligned file is a file which is padded with zero-filled data at the beginning so that it's actual data starts at a different offset instead of zero. This is done in VM environments so that reads/writes to this file are aligned to WAFL's 4k block boundary. The amount by which the start offset is adjusted depends on the vm-align setting of the hosting volume. Use the volume-list-info or the volume-get-iter API to get this information.
  • name => string, optional

    • Name of the file.
  • owner-id => integer

    • The integer id of the owner of the file.
  • perm => string

    • File permission bits. It's similar to Unix style permission bits: 0755 gives read/write/execute permissions to owner and read/execute 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.

file-scope

Part of the file for which fingerprint is computed. Possible values: "metadata_only", "data_only", "data_and_metadata".

Fields

  • None

fingerprint-info

Fingerprint information.

Fields

  • filer-name => string, optional

    • Name of the filer. If the filer name has not been written to the disks, this will not be returned.
  • fingerprint-algorithm => digest-algorithm

    • null
  • fingerprint-end-time => integer

    • End time of fingerprint computation in seconds since January 1, 1970. Time is taken out of system clock. Range : [0..2^64-1].
  • fingerprint-scope => file-scope

    • null
  • formatted-volume-expiry-date => string, optional

    • Expiry date of the SnapLock volume in a human-readable format :: in GMT timezone. A value of "infinite" indicates that the volume has an infinite expiry date. A value of "scan_in_progress" indicates that expiry date is not displayed since worm scan on the volume is in progress. A value of "no_expiry_date" indicates that expiry date is not displayed since the SnapLock volume has no WORM files and WORM snapshots. This field is not included if the volume is offline or the volume is regular volume.
  • is-volume-expiry-date-wraparound => boolean, optional

    • True if the date represented in the field volume-expiry-date is a wraparound format. The wraparound format indicates that dates after 01/19/2038 are mapped from 01/01/1970 - 12/31/2002 to 01/19/2038 - 01/19/2071. The field is not included if volume-expiry-date is not included.
  • snaplock-license => string, optional

    • Type of SnapLock license installed. Possible values: "compliance" that applies to SnapLock compliance restrictions and "enterprise" that applies to SnapLock enterprise restrictions and value "compliance and enterprise" if there are both licenses installed. This field is not included if SnapLock license is not installed.
  • snaplock-volume-compliance-clock => integer, optional

    • Volume Compliance Clock time in seconds for the SnapLock volumes. The time is in the standard UNIX format (since 01/01/1970 00:00:00) in GMT timezone. This field is not included for Non-SnapLock volumes. Range:[0..2^64-1].
  • volume-expiry-date => integer, optional

    • Expiry date of the SnapLock volume in seconds in the standard UNIX format (since 01/01/1970 00:00:00). Range:[0..2^64-1]. This field is not included if 1. Volume is non Snaplock volume, or 2. Snaplock volume has an infinite expiry date, or 3. Snaplock volume has no worm files or snapshots, or 4. Snaplock volume has worm scanner in progress The volume expiry date can be in wraparound format. The wraparound format indicates that dates after 01/19/2038 are mapped from 01/01/1970 - 12/31/2002 to 01/19/2038 - 01/19/2071.
  • volume-name => string

    • Name of the volume.
  • volume-type => string

    • The type of volume. Possible values: "flexible" for flexible volumes, and "traditional" for traditional volumes.
  • volume-uuid => string

    • Universal unique identifier (UUID) for the volume.

hole-range-info

The hole start need not be an integral multiple of the block size. It will be rounded up to the start of the next block. The hole-size does not need to be the size of a block. It will be rounded down to the beginning of the block. It is possible that after the adjustments there is nothing to punch. That is ok and will be treated as success. Note that presently in WAFL small files are entirely within the inode. It is possible to "hole punch" those however nothing happens. The data is left alone. Considering the use case fot this ZAPI and the amount of effort to code the "correct" solution this is deemed an acceptable condition. If the file is vm-aligned then the range chosen to hole-punch could be rounded down by a block to ensure that we don't punch block containing valid user data.

Fields

  • hole-size => integer

    • Size of the hole in terms of bytes. If punching a hole WAFL presently limits this value to 4MB. Range : [0..2^63-1]

inode-parent-info

Inode's path and parent information.

Fields

  • inode-parent-cookie => integer, optional

    • The opaque readdir cookie to determine the index of the inode in the parent directory tree. Note that this value is used as a testing hook, we do not plan to support its semantics and those semantics might change over time.

flash-device-info

Flash device information.

Fields

  • firmware-revision => string

    • Firmware revision of FPGA on the flash device.
  • serial-number => string

    • 10-digit serial number of the flash device.
  • status => string

    • The current status of the device. Possible values: "online", "offline_failed", or "offline_threshold".

flash-threshold

A definition for a threshold element. Each threshold specifies what level of errors or failures the specified domain can sustain before the specified action is taken.

Fields

  • action => string

    • Action to be taken if this threshold is exceeded. Possible values: "log an EMS event", "log an EMS_event, and disable the 'domain'", "log an EMS event, and send an AutoSupport message", "log an EMS event, send an AutoSupport message, and disable the 'domain'"
  • domain => string

    • The type of domain. Possible values: "card", "bank", "chip" (in Data ONTAP 7.3.x to 8.1) or "lun" (from Data ONTAP 8.2 onwards).
  • time-slice => string

    • The time slice. Available if the 'threshold-unit' is "count". If not, output will say 'none'. Possible values: "none", "seconds", "minutes", or "hours".

flash-threshold-profile

A definition for a threshold element

Fields

extension-list-info

Structure containing extension information.

Fields

  • name-spec => string

    • Extension specification (including wild cards). Allowed are only DOS like, three character long extensions. The extensions are case insensitive. Supported wild card values: "???" to match any extension and "?" to match any character. Examples of allowed extension specifications: EXE ??? ?XT P??

fpolicy-volumes-list-info

Structure containing volumes information.

Fields

  • volume-spec => string

    • Volume specification (including wild cards). The volumes are case insensitive. If no volume-spec is provided, then the list will be reset to an empty list. Supported wild card values: "?" to match any character and "*" to match any number of characters. Example specifications: vol0 vol? users*

monitored-operation-info

Structure containing information pertaining to monitored operations.

Fields

  • operation => string

    • Supported values: "file-create", "file- delete", "file-open", "file-close", "file-rename", "directory-create", "directory-delete", "directory-rename", "getattr", "setattr", "lookup", "read", "write", "link", "symlink"

monitored-protocol-info

Structure containing information pertaining to monitored operations' protocols.

Fields

  • protocol => string

    • Supported values: "nfs", "cifs".

policy-info

Structure containing information pertaining to policy.

Fields

  • is-enabled => boolean

    • True if the policy is enabled. No matter whether the policy is enabled or disabled, values returned in other elements for the policy are always valid.
  • is-i2p-enabled => boolean

    • True if inode to pathname translation for NFS requests is supported and enabled.If enabled fpolicy requests to fpolicy server will carry full file path for NFS requests. The fields which will carry full file path are AccessPath and RenamePath for FP_ScreenRequest RPC call and sr_accesspath for FP_ScreenRequest2 RPC call.
  • name => string

    • Policy name.
  • number-of-screen-failures => integer

    • Number of failed (denied) screen requests. This value is reset each time the filer is rebooted or the policy is disabled. Range : [0..2^32-1].
  • number-of-screened-files => integer

    • Number of screened files since policy has been enabled. This value is reset each time the filer is rebooted or the policy is disabled. Range : [0..2^32-1].

secondary-server-info

Structure containing information pertaining to secondary servers.

Fields

  • server-ip => ip-address

    • The ip address, in dotted-decimal format, of the server.

server-info

Structure containing information pertaining to servers.

Fields

  • idl-version => integer

    • Version of the Interface Definition Language(IDL) used by the Fpolicy server. Range : [0..2^32-1].
  • is-version2 => boolean, optional

    • True if the server is registered with version2 support enabled. version2 refers to the version of the FP_ScreenRequest(). When version2 is true the FPolicy server is enabled to receive FP_ScreenRequest2() RPC.
  • number-of-screen-failures => integer

    • Number of failed (denied) screens since server registrations. Range : [0..2^32-1].
  • number-of-screened-files => integer

    • Number of screened files since server registration. Range : [0..2^32-1].
  • server-id => integer

    • The unique server ID assigned to the Fpolicy server at the time of Fpolicy server registration. Range : [0..2^32-1].
  • server-ip => ip-address

    • The ip address, in dotted-decimal format, of the server.
  • smb-req-pipe-name => string

    • The name of the FPolicy request pipe name on which FPolicy server is recieving the screen requests from the storage system. This name is sent by the FPolicy server at the time of the FPolicy server registration.

ic-config-details

Details on HA configuration

Fields

ic-counter

IC counters

Fields

ic-rlib-if-info

Interface information for each rlib interface.

Fields

  • interface-name => string

    • Name of the interface.

ic-system-id-info

Per node information.

Fields

  • node => string

    • Whether local or partner node.

nvram-per-port-counters-info

List of port counters for an nvram port

Fields

  • port-number => integer

    • Numerical Id of the port. Range : [0..2^32-1]

per-link-parameters-info

Per link parameters

Fields

  • link-state => string

    • State of the link Possible values: "up", "down"
  • port-state => string

    • Port state Possible values: "port down", "port initialize", "port armed", "port active"

queue-info

Information about the Descriptors on the Queue

Fields

  • id => integer

    • Id of the last descriptor posted on this Queue. Range : [0..2^64-1]

virtual-interface-socket-stat-info

Per channel Virtual Interface socket statistics

Fields

  • channel-number => integer

    • The channel for which the statistics are being reported Possible values: 0, 1. Range : [0..2^32-1]

initiator-group-info

Information about an initiator group.

Fields

  • initiator-group-name => string

    • Name of this initiator group.
  • initiator-group-type => string

    • Type of the initiators in this group. Possible values: "iscsi", "fcp", "mixed".
  • initiator-group-use-partner => boolean, optional

    • Boolean value to indicate if this initiator group is configured for its luns to require the use of host multi-pathing software for correct high-availability failover operation. In Data ONTAP 7-Mode, this value is optional and is only returned for FCP initiator groups on an storage system in an HA pair. In Data ONTAP Cluster-Mode, this field will always be 'true'.
  • initiator-group-uuid => string, optional

    • This value is Universally-unique identifier (UUID) of this initiator group.

    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:

    35d6ca90-c759-11df-8b6d-00a098132c6c

  • lun-id => integer, optional

    • LUN identifier to which the LUN is mapped at the host. This value is optional and is only returned for the lun-map-list-info api.

initiator-group-list-info

Initiator group this initiator belogs to.

Fields

  • initiator-group-name => string

    • Name of initiator group.

initiator-group-os-type

The operating system of the initiator group. This value modifies the finer details of SCSI protocol interaction for initiators in the group. Possible values:
  • "aix" The initiators belong to an AIX host,
  • "default" The initiators belong to an unknown host type,
  • "hpux" The initiators belong to an HP-UX host,
  • "hyper_v" The initiators belong to a Hyper-V parent host,
  • "linux" The initiators belong to a Linux host,
  • "netware" The initators belong to a NetWare host,
  • "openvms" The initiators belong to an OpenVMS host,
  • "solaris" The initiators belong to a Solaris host,
  • "vmware" The initiators belong to a VMware ESX host,
  • "windows" The initiators belong to a Windows host,
  • "xen" The initiators belong to a Xen hypervisor host.

Fields

  • None

initiator-info

Information about one initiator.

Fields

interface-info

Information about one interface

Fields

  • interface => string

    • Name of the interface that is recognizable by "ifconfig" command like "e0" or a VIF (virtual interface) name.

ipspace-info

This is information about one ipspace

Fields

  • name => string

    • Ipspace name.

interface-list-entry-info

Information about a single interface

Fields

  • interface-name => string

    • Name of network interface. In Data ONTAP 7-Mode, this is the name of a physical or virtual ethernet interface, for example: "e0c" or "vif0". In Data ONTAP Cluster-Mode, this is the name of an iSCSI data LIF in the Vserver.

ipaddress-list-entry-info

Information about a single IP Address

Fields

  • ip-address => string

    • IP address

iscsi-adapter-initiators-info

A list of initiators currently connected to the adapter.

Fields

  • name => string

    • The name this adapter is given.

iscsi-cdb-stats-info

Counts for Command Descriptor Blocks processed

Fields

iscsi-config-adapter-info

Configuration information about a single iscsi adapter.

Fields

  • name => string

    • The name this adapter is given.
  • state => string

    • State of the adapter, either "online", "offline", "local", "partner", "error". " online" and "offline" is used when the adapter is used for the current host. "local" if the adapter is operating on behalf of the local host, and "partner" if the adapter is operating on behalf of the partner host. "error" is used if some an internal error occurred when tring to load this adapter info.
  • status => string, optional

    • A short status message explaining the state. i.e. if the adapter is offline, the reason for it, or if its "error" what the error is. This will not be returned if the state of the adapter is "online".

iscsi-connected-initiator-info

Information about an initiator connected to an iSCSI adapter.

Fields

  • initiator-name => string

    • Name of initiator.

iscsi-connection-list-entry-info

Information about an iSCSI connection. In Data ONTAP 7-Mode, connections are uniquely identified by the combination of 'session-id' and 'connection-id'. In Data ONTAP Cluster-Mode, sessions are uniquely identified within a Vserver by the combination of 'tpgroup-name', 'session-id' and 'connection-id'.

Fields

  • connection-state => string

    • Current state of this connection. Possible values:
    • "New_Connection",
    • "Waiting_Tpgtag_Assignment",
    • "Login_Waiting_Req",
    • "Login_Req_Rcvd",
    • "Login_Waiting_Auth",
    • "Login_OK_New_Session_Requested",
    • "Login_New_Session_Waiting_Reinstatement",
    • "Login_OK_New_Conn_Requested",
    • "Login_New_Conn_Waiting_Reinstatement",
    • "Login_Send_Final_Resp",
    • "Full_Feature_Phase",
    • "Shutdown_Start",
    • "Shutdown_Waiting_Sockio_Shutdown",
    • "Shutdown_Sockio_Shutdown_Done",
    • "Shutdown_Waiting_ImmDeliv_FFPCmds_Done",
    • "Shutdown_ImmDeliv_FFPCmds_Done",
    • "Shutdown_Recovery_Waiting_FFPCmds_Ready",
    • "Shutdown_Recovery_Waiting_Logout_Rcvd",
    • "Shutdown_Recovery_Logout_Rcvd",
    • "Shutdown_Recovery_Waiting_FFPCmds_Reassigned",
    • "Shutdown_Terminate_Abort_Seq_FFPCmds",
    • "Shutdown_Terminate_Waiting_Seq_FFPCmds_Done",
    • "Shutdown_Terminate_Seq_FFPCmds_Done".
  • interface-name => string

    • Name of the network interface hosting this connection. In Data ONTAP 7-Mode, this is the name of a physical ethernet interface, for example: "e0c". In Data ONTAP Cluster-Mode, this is the name of an iSCSI data LIF in the Vserver.
  • session-id => integer

    • Session id for the associated session, or 0 if this connection is not yet associated to a session.
  • tpgroup-tag => integer

    • The tag of the target portal group associated with this session.

iscsi-error-stats-info

Counts for iSCSI errors.

Fields

  • total => integer

    • Total errors.

iscsi-initiator-list-entry-info

Information about a single initiator.

Fields

  • initiator-nodename => string

    • Name of initiator. The initiator name must conform to RFC 3720, for example: "iqn.1987-06.com.initvendor1:appsrv.sn.2346".
  • isid => string

    • ISID for this session selected by initiator represented as 6 hexadecimal octets separated by colons, for example: "40:01:37:00:00:00".
  • tpgroup-tag => integer

    • Tag of target portal group associated with this session.

iscsi-interface-list-entry-info

Information about a single interface

Fields

  • interface-name => string

    • Name of interface. In Data ONTAP 7-Mode, this is the name of a physical ethernet interface, for example: "e0c". In Data ONTAP Cluster-Mode, this is the name of an iSCSI data LIF in the Vserver.
  • tpgroup-name => string

    • Name of target portal group interface is associated with.
  • tpgroup-tag => integer

    • Id of target portal group interface is associated with.

iscsi-iptpgroup-list-entry-info

Information about a single portal group

Fields

  • tpgroup-name => string

    • Portal group name
  • tpgroup-tag => integer

    • Portal group tag

iscsi-portal-address-info

Configuration information about an inet-addres and port pair for a portal group.

Fields

  • id => integer

    • ID of this portal group.

iscsi-portal-list-entry-info

information about a single portal

Fields

  • interface-name => string

    • Name of network interface exporting this portal
  • ip-address => string

    • portal IP address
  • tpgroup-tag => integer

    • tag of portal group this portal is associated with

iscsi-received-stats-info

Counts for PDUs received.

Fields

  • total => integer

    • Total PDUs received.

iscsi-security-entry-info

Information about a single authentication entry.

Fields

  • auth-chap-policy => string, optional

    • CHAP authentication path. Possible values: "local", "radius".
  • auth-type => string

    • Authentication type. Possible values: "CHAP", "none", "deny".
  • initiator => string

    • Name of initiator. The initiator name must conform to RFC 3720, for example: "iqn.1987-06.com.initvendor1:appsrv.sn.2346", or "default" if this is a default auth entry.
  • outbound-user-name => string, optional

    • Outbound CHAP user name, returned only if auth-type is CHAP, and outbound authentication is set for initiator.
  • user-name => string, optional

    • Inbound CHAP user name, returned only if auth-type is CHAP.

iscsi-session-connection-list-entry-info

Information about a single tcp connection

Fields

  • connection-id => integer

    • Connection id within the session.
  • interface-name => string

    • Name of network interface hosting this connection. In Data ONTAP 7-Mode, this is the name of a physical ethernet interface, for example: "e0c". In Data ONTAP Cluster-Mode, this is the name of an iSCSI data LIF in the Vserver.
  • local-ip-address => string

    • Local storage system iSCSI target interface address.
  • local-ip-port => integer

    • Local storage system iSCSI target TCP port.
  • remote-ip-address => string

    • Remote initiator IP address.
  • remote-ip-port => integer

    • Remote initiator TCP port.

iscsi-session-list-entry-info

Information about a single iSCSI session. In Data ONTAP 7-Mode, sessions are uniquely identified by the 'target-session-id'. In Data ONTAP Cluster-Mode, sessions are uniquely identified within a Vserver by the combination of 'tpgroup-name' and 'target-session-id'.

Fields

  • initiator-aliasname => string, optional

    • The user-friendly name assigned to initiator. This field is only present if the initiator provided an alias during login.
  • initiator-nodename => string

    • Name of initiator. The initiator name must conform to RFC 3720, for example: "iqn.1987-06.com.initvendor1:appsrv.sn.2346".
  • isid => string

    • ISID for this session selected by initiator represented as 6 hexadecimal octets separated by colons, for example: "40:01:37:00:00:00".
  • target-session-id => integer

    • The iSCSI session identifier assigned by the storage system.
  • tpgroup-tag => integer

    • The tag of the target portal group associated with this session.

iscsi-sesssion-cmd-list-entry-info

information about a particular command

Fields

  • cmd-state => string

    • State of iSCSI command. Possible values:
    • "FREE" - Free,
    • "Logout_Begin" - Logout - Begin,
    • "Logout_Wait_For_Other_Conn" - Logout - Wait For Other Conn,
    • "Logout_Build_and_Send_Resp" - Logout - Build and Send Resp,
    • "Logout_Waiting_StatSN_ACK" - Logout - Waiting StatSN ACK,
    • "Logout_Done" - Logout - Done,
    • "Nopout_Begin" - Nopout - Begin,
    • "Nopout_Build_And_Send_Resp" - Nopout - Build And Send Resp,
    • "Nopout_Waiting_Resp_Sockio_Comp" - Nopout - Waiting Resp Sockio Comp,
    • "Nopout_Resp_Sockio_Comp" - Nopout - Resp Sockio Comp,
    • "Nopout_Waiting_StatSN_ACK" - Nopout - Waiting StatSN ACK,
    • "Nopout_Done" - Nopout - Done,
    • "Taskmgmt_Begin" - Taskmgmt - Begin,
    • "Taskmgmt_Waiting_FFPCmds_Rcvd" - Taskmgmt - Waiting FFPCmds Rcvd,
    • "Taskmgmt_FFPCmds_Rcvd" - Taskmgmt - FFPCmds Rcvd,
    • "Taskmgmt_Waiting_FFPCmds_Complete" - Taskmgmt - Waiting FFPCmds Complete,
    • "Taskmgmt_Build_And_Send_Resp" - Taskmgmt - Build And Send Resp,
    • "Taskmgmt_Waiting_StatSN_ACK" - Taskmgmt - Waiting StatSN ACK,
    • "Taskmgmt_Done" - Taskmgmt - Done,
    • "Text_Begin" - Text - Begin,
    • "Text_Waiting_Portal_List_Notify" - Text - Waiting Portal List Notify,
    • "Text_Build_And_Send_Resp" - Text - Build And Send Resp,
    • "Text_Waiting_Resp_Sockio_Comp" - Text - Waiting Resp Sockio Comp,
    • "Text_Resp_Sockio_Comp" - Text - Resp Sockio Comp,
    • "Text_Waiting_StatSN_ACK" - Text - Waiting StatSN ACK,
    • "Text_Done" - Text - Done,
    • "Scsicdb_Begin" - Scsicdb - Begin,
    • "Scsicdb_Claim_Early_Udata" - Scsicdb - Claim Early Udata,
    • "Scsicdb_Waiting_Udata_Rcvd" - Scsicdb - Waiting Udata Rcvd,
    • "Scsicdb_Udata_Rcvd" - Scsicdb - Udata Rcvd,
    • "Scsicdb_Ready_For_STSubmit" - Scsicdb - Ready For STSubmit,
    • "Scsicdb_Udata_Not_Rcvd" - Scsicdb - Udata Not Rcvd,
    • "Scsicdb_Udata_Waiting_Task_Reassignment" - Scsicdb - Udata Waiting Task Reassignment,
    • "Scsicdb_Udata_Task_Reassigned" - Scsicdb - Udata Task Reassigned,
    • "Scsicdb_Waiting_STLayer" - Scsicdb - Waiting STLayer,
    • "Scsicdb_RD_STLayer_Called" - Scsicdb - RD STLayer Called,
    • "Scsicdb_RD_Build_And_Send_R2T" - Scsicdb - RD Build And Send R2T,
    • "Scsicdb_RD_Waiting_Burst" - Scsicdb - RD Waiting Burst,
    • "Scsicdb_RD_Burst_Rcvd" - Scsicdb - RD Burst Rcvd,
    • "Scsicdb_RD_Done" - Scsicdb - RD Done,
    • "Scsicdb_RD_Burst_Not_Rcvd" - Scsicdb - RD Burst Not Rcvd,
    • "Scsicdb_RD_Waiting_Task_Reassignment" - Scsicdb - RD Waiting Task Reassignment,
    • "Scsicdb_RD_Task_Reassigned" - Scsicdb - RD Task Reassigned,
    • "Scsicdb_SD_STLayer_Called" - Scsicdb - SD STLayer Called,
    • "Scsicdb_SD_XDI_Done" - Scsicdb - SD XDI Done,
    • "Scsicdb_SD_Waiting_DataSN_ACK" - Scsicdb - SD Waiting DataSN ACK,
    • "Scsicdb_SD_Done" - Scsicdb - SD Done,
    • "Scsicdb_SD_SNACK_Rcvd" - Scsicdb - SD SNACK Rcvd,
    • "Scsicdb_SD_Task_Reassigned" - Scsicdb - SD Task Reassigned,
    • "Scsicdb_SR_STLayer_Called" - Scsicdb - SR STLayer Called,
    • "Scsicdb_SR_Build_And_Send_Resp" - Scsicdb - SR Build And Send Resp,
    • "Scsicdb_SR_Waiting_StatSN_ACK" - Scsicdb - SR Waiting StatSN ACK,
    • "Scsicdb_SR_Done" - Scsicdb - SR Done,
    • "Scsicdb_SR_SNACK_Rcvd" - Scsicdb - SR SNACK Rcvd,
    • "Scsicdb_SR_Task_Reassigned" - Scsicdb - SR Task Reassigned,
    • "Scsicdb_SR_XDI_Done" - Scsicdb - SR XDI Done,
    • "Scsicdb_SDR_STLayer_Called" - Scsicdb - SDR STLayer Called,
    • "Scsicdb_SDR_XDI_Done" - Scsicdb - SDR XDI Done,
    • "Scsicdb_SDR_Waiting_StatSN_ACK" - Scsicdb - SDR Waiting StatSN ACK,
    • "Scsicdb_SDR_Done" - Scsicdb - SDR Done,
    • "Scsicdb_SDR_SNACK_Rcvd" - Scsicdb - SDR SNACK Rcvd,
    • "Scsicdb_SDR_Task_Reassigned" - Scsicdb - SDR Task Reassigned,
    • "Scsicdb_Abort_Begin" - Scsicdb - Abort Begin,
    • "Scsicdb_Abort_Build_And_Send_Resp" - Scsicdb - Abort Build And Send Resp,
    • "Scsicdb_Abort_Waiting_StatSN_ACK" - Scsicdb - Abort Waiting StatSN ACK,
    • "Scsicdb_Abort_Done" - Scsicdb - Abort Done,
    • "Scsicdb_Abort_SNACK_Rcvd" - Scsicdb - Abort SNACK Rcvd,
    • "Scsicdb_Abort_Task_Reassigned" - Scsicdb - Abort Task Reassigned,
    • "Scsicdb_Abort_XDI_Done" - Scsicdb - Abort XDI Done,
    • "Scsicdb_QFull_Begin" - Scsicdb - QFull Begin,
    • "Scsicdb_QFull_Build_And_Send_Resp" - Scsicdb - QFull Build And Send Resp,
    • "Scsicdb_QFull_Waiting_StatSN_ACK" - Scsicdb - QFull Waiting StatSN ACK,
    • "Scsicdb_QFull_Done" - Scsicdb - QFull Done,
    • "Scsicdb_XDI_Start" - Scsicdb - XDI Start,
    • "Scsicdb_XDI_Waiting_Data_In_Sockio_Comp" - Scsicdb - XDI Waiting Data In Sockio Comp,
    • "Scsicdb_Waiting_Scsitgt_Abort" - Scsicdb - Waiting Scsitgt Abort,
    • "Done" - Done.
  • cmd-type => string

    • Type of command being executed. Possible values:
    • "Seq",
    • "ITM",
    • "Oth",
    • "UNK".

iscsi-stats-info

Statistics block

Fields

iscsi-tpgroup-list-entry-info

Information about a single portal group

Fields

  • tpgroup-name => string

    • Portal group name.
  • tpgroup-tag => integer

    • Portal group tag.

iscsi-transmitted-stats-info

Counts for PDUs transmitted.

Fields

  • total => integer

    • Total PDUs transmitted.

license-info

Information about a single licensable service.

Fields

  • code => string, optional

    • license code of the service. This information is returned only if "is-licensed" is true or "is-expired" is true. For features that are enabled automatically due to platform based business policies, the code value returned is "ENABLED". For more details see the description for the is-auto-enabled element below.
  • count => integer

    • number of times a promotional license code has been installed. 0 for non-promotional licenses.
  • installation-timestamp => integer, optional

    • installation timestamp of the service license code in seconds since January 1, 1970. A value of 0 is returned if there is no installation timestamp, but there is a valid code. This is probably an error, or corruption.
  • is-auto-enabled => boolean

    • "true" if is-licensed is true because this feature was automatically enabled based on the platform type and current business packaging policies. The code element will also return "ENABLED". In all other cases this will return false.
  • is-demo => boolean

    • "true" if the license is a promotional/time-expiring/demo license, "false" otherwise.
  • is-expired => boolean

    • "true" if the promotional/time-expiring/demo license has expired, "false" otherwise.
  • length => integer, optional

    • length of the promotional/time-expiring license in days. 0 for non-promotional licenses.
  • package-list => package-master[], optional

    • List of package master feature names for the the packages to which this feature belongs. Returned if this feature is a member of at least one package on the current platform.
  • platform => string, optional

    • indicates the type of the platform for which the license is valid. Possible values are : filer and netcache, gateway, nearstore, and simulator.
  • service => string

    • name of the service.

package-master

The license name of the feature that is considered to be the master of the package.

Fields

  • None

license-code-v2

License Code version 2

Fields

  • None

license-v2-added

A license entry that was successfully added to the controller or the cluster.

Fields

  • customer-id => string, optional

    • Customer Identification. This value is only present in site licenses. It is set to none for standard and demo licenses. Attributes: non-creatable, non-modifiable
  • expiration-time => datetime, optional

    • License expiration time. This value is only present in demo licenses. It is set to zero for permanent licenses such as standard and site licenses. Attributes: non-creatable, non-modifiable

license-v2-info

Information about a licensable package. 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

  • customer-id => string, optional

    • Customer Identification. This field is used to track site licenses issued to Enterprise Level Agreement customers. It will typical be set to "none" unless a unique customer id has been assigned. This value is reported in Auto Support, and can be used to correlate licensing information with backend business systems for tracking purposes. Attributes: non-creatable, non-modifiable
  • description => string, optional

    • Description of the licensed package. Attributes: non-creatable, non-modifiable
  • expiration-time => datetime, optional

    • License expiration time. Attributes: non-creatable, non-modifiable
  • grace-period-expiration => datetime, optional

    • The grace period expiration date/time. This is only provided if is-in-grace-period is returned. If is-in-grace-period is true, then this is the expiration date/time of the grace period. If is-in-grace-period is false then this value will be 0. Attributes: non-creatable, non-modifiable
  • is-in-grace-period => boolean, optional

    • The system serial number grace period. Returns true if a system serial number change was detected and the system is currently in the grace period. During this grace period serial number checking for currently installed licenses will be ignored. The serial-number element for various package licenses may differ while valid licenses are being installed. Attributes: non-creatable, non-modifiable
  • legacy => boolean, optional

    • Legacy License. A legacy license indicates that the license was previously installed prior to this release. Returns true if the license was installed prior to this release and false otherwise.
  • owner => string, optional

    • Controller or Cluster that owns the serial number. Attributes: non-creatable, non-modifiable
  • package => licensed-package, optional

    • Name of the licensed package. Attributes: key, required-for-create, non-modifiable Possible values:
    • "base" - Cluster Base License,
    • "nfs" - NFS License,
    • "cifs" - CIFS License,
    • "iscsi" - iSCSI License,
    • "fcp" - FCP License,
    • "cdmi" - CDMI License,
    • "snaprestore" - SnapRestore License,
    • "snapmirror" - SnapMirror License,
    • "flexclone" - FlexClone License,
    • "snapvault" - SnapVault License,
    • "snaplock" - SnapLock License,
    • "snapmanagersuite" - SnapManagerSuite License,
    • "snapprotectapps" - SnapProtectApp License,
    • "v_storageattach" - Virtual Attached Storage License
  • serial-number => node-serial-number, optional

    • Serial number of the controller or cluster. The license serial-number is reported in Auto Support also and can be used to correlate controller or cluster wide licensing information. Attributes: key, required-for-create, non-modifiable
  • type => license-v2-type, optional

    • License type. Attributes: non-creatable, non-modifiable Possible values:
    • "license" ,
    • "site" ,
    • "demo"

license-v2-op-status

License Operation Status Possible values:
  • "license_success" - Operation Completed Successfully,
  • "license_invalid" - Failed: Invalid License Key,
  • "license_expired" - Failed: License Expired,
  • "license_notallowed" - Failed: Operation Not Allowed,
  • "license_unavailable" - Failed: License NOT Available,
  • "license_internal" - Failed: Internal Error,
  • "license_err_unknown" - Failed: Unknown Error

Fields

  • None

license-v2-result

License operation result 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

  • description => string, optional

    • Additional information of the failure. Attributes: non-creatable, non-modifiable

license-v2-type

This field indicates the type of a license. A typical license will be of "license" type, which indicates that it's associated with a specific controller. A "site" license is a special license provided under Enterprise Level Agreements. A "demo" license is a temporary license with an expiration time. It is usually issued for trial purposes only. Possible values:
  • "license" ,
  • "site" ,
  • "demo"

Fields

  • None

licensed-package

Licensable Package Possible values:
  • "base" - Cluster Base License,
  • "nfs" - NFS License,
  • "cifs" - CIFS License,
  • "iscsi" - iSCSI License,
  • "fcp" - FCP License,
  • "cdmi" - CDMI License,
  • "snaprestore" - SnapRestore License,
  • "snapmirror" - SnapMirror License,
  • "flexclone" - FlexClone License,
  • "snapvault" - SnapVault License,
  • "snaplock" - SnapLock License,
  • "snapmanagersuite" - SnapManagerSuite License,
  • "snapprotectapps" - SnapProtectApp License,
  • "v_storageattach" - Virtual Attached Storage License

Fields

  • None

node-serial-number

Assigned Node serial-number

Fields

  • None

break-error

Information about a single error encountered by specific protocol(s).

Fields

cifs-lock

Information about a single CIFS lock.

Fields

  • absolute-path => string, optional

    • Name of the absolute ("/vol/volX" style) path corresponding to the CIFS path present in the ONTAPI output element, path.
    NOTE: In certain cases, the absolute path is unavailable (e.g., due to insufficient memory or if the lock is a Delete-on-close lock.)
  • dh-state => string, optional

    • Durable state of the lock, which can be "DH_GRANTED" (durability granted), "DH_ACTIVE" (lock is currently durable), "DH_PURGED" (lock has been purged), or "DH_NONE" (durability is not granted). For lease locks, dh-state is unavailable.
  • fsid => integer, optional

    • Filesystem ID.
  • host-ip => ip-address

    • IP address, in dotted-decimal format, of the CIFS client.
  • host-name => string, optional

    • NetBios name of the CIFS client. This may be unavailable in certain situations. In such cases, the ONTAPI element 'host-ip' alone provides identity of the host.
  • lock-error => string, optional

    • Error messages issued, e.g., low system memory or if the input syntax is not applicable to this protocol (but maybe applicable to other protocols), or else if this protocol is specified by the "protocol" input but the syntax of host, owner, or file parameters is wrong.
    NOTE: New error messages may be added in the future.
  • mode => string, optional

    • File access mode that can be one of the following:
    DelOnClose: Delete-on-close lock
    DelOnCloseWait: Waiting Delete-on-close lock
    SuperLock: Super lock, eg, used by antivirus scanner
    Oplock-Excl: Exclusive Oplock
    Oplock-Lvl2: Level-II Oplock
    or a string of form "AccessMode-ShareMode" with:
    AccessMode: RdWr(Read-Write), Read(Read-only) Writ(Write), None(No access)
    ShareMode: denyA(deny all), denyR(deny Read access) denyW(deny Write access), denyN(deny none)
  • oplock-level => string, optional

    • Oplock level (for non-Delete-on-close lock), which is "Excl" (Exclusive Oplock), "lvl2" (Level-II Oplock), "RWH" (Read-Write-Handle Lease), "RW" (Read-Write Lease), "RH" (Read-Handle Lease), "R" (Read Lease), or "None" (No oplock).
  • owner => string, optional

    • Name of the lock owner: a username prefixed by an optional domain (and a backslash) for CIFS protocol ([domain\]username).
  • path => string, optional

    • Name of the path for a file or directory or NT stream.
    NOTE: In certain cases, the path is unavailable (e.g., due to insufficient memory)
  • state => string

    • State of the lock, being one of:
    GRANTED: The lock is granted and is not being revoked. Locks in this state are on the share-grant or byte-grant lists, depending on the lock type.
    REVOKING: The lock has just begun revocation. Locks in this state are also on share-grant or byte-grant lists, depending on the lock type.
    REVOKED: The lock is undergoing revocation and the protocol has marked it to be released. This is a transient state whereby the protocol indicates the results of lock revocation to the generic lock manager code. Locks in this state are on the share-grant or byte-grants lists, but are removed immediately.
    GWAITING: The lock is waiting to be granted. Locks in this state are on the share-wait list or one of the wait lists associated with a granted byte lock. Locks enter this state when they can't be granted because of a conflict and the lock parameters indicate that the caller is prepared to wait.
    EWAITING: The lock is waiting either to be granted or denied. Locks in this state are on the share-wait list or one of the wait lists associated with a granted byte lock. Locks enter this state when they can't be granted because of a conflict with a soft lock and lock parameters indicate they the caller is not prepared to wait. Generally, in this situation, the protocol is prepared to wait for a limited time to allow the revocation to be resolved so that it can be determined whether the lock is to be granted or denied.
    ADJUSTED: The lock is undergoing revocation and the protocol has marked it to be replaced by a hard lock which is equal to it or weaker. This is a transient state whereby the protocol indicates the results of lock revocation to the generic lock manager code. Locks in this state are on the share-grant or byte-grant lists, but are transitioned back to the granted state once the changes in the lock have been dealt with.
    DENIED: The lock has been denied. This is a temporary state used to mark locks that have, after waiting, been denied. This is so that when the lock state is noticed by a WAFL operation, appropriate information about the state of the request, including the denial status, will be available. Locks in this state are not in any of the per-file lists.
    TIMEDOUT: The wait for the lock has timed out. This is a temporary state used to mark locks that have, after waiting, had the wait timed out. This is so that when the lock state is noticed by a WAFL operation, appropriate information about the state of the request, including the fact that it could not be granted due to a timeout, will be available. Locks in this state are not in any of the per-file lists.
    SUBSUMED: Kept in reserve by protocol while protected by an encompassing soft lock. This is a transient state used for locks which are one of a set of locks that will take the place of a lock being revoked. Locks in this state are in an internal list and not in any of the per-file lists. They are converted to the GRANTED state and put in the share-grant list as part of completing the revocation operation .
    GONE: About to be returned. This is a temporary state for lock objects that are to be freed as soon as any potential references to them are gone. Locks in this state are not on any of the per-file lists .
    UNUSED: The lock was just allocated. This is a temporary state for lock objects that have been allocated but have not yet been dealt with (i.e. granted, denied, set up to wait). Locks in this state are not on any of the per-file lists.

    NOTE: Future releases may have new lock states.
  • type => string, optional

    • Type of lock, either "share-level" or "byte-range".
    NOTE: Future releases might have new values.

lock-status-info

Information about a single lock.

Fields

nfsv4-lock

Information about a single NFSv4 lock.

Fields

  • bytelock-length => integer, optional

    • Number of bytes (from bytelock-offset) that are locked.
  • bytelock-offset => integer, optional

    • Starting offset in file that gets bytelocked.
  • fileid => integer, optional

    • A unique number (withing filesystem) identifying the file associated with the lock.
  • fsid => integer, optional

    • Filesystem ID.
  • is-bytelock-exclusive => boolean, optional

    • Is true for exclusive bytelock, else false.
  • lock-error => string, optional

    • Error messages issued, e.g., if the input syntax is not applicable to this protocol (but maybe applicable to other protocols), or else if this protocol is specified by the "protocol" input but the syntax of host, owner, or file is wrong.
  • mode => string, optional

    • File access mode that can be one of the following:
    Deleg-Read: Read delegation
    Deleg-Wrt: Write delegation
    or a string of form "AccessMode-ShareMode" with: AccessMode: RdWr(Read-Write), Read(Read-only) Writ(Write), None(No access)
    ShareMode: denyA(deny all), denyR(deny Read access) denyW(deny Write access), denyN(deny none)
  • owner => string, optional

    • Name of the owner.
  • path => string, optional

    • Name of the path for a file or directory.
  • pid => integer, optional

    • Process-ID of NFSv4 client.
  • state => string

    • State of the lock. See cifs-lock for description of all state values.
    NOTE: Future releases may have new lock states.
  • type => string, optional

    • Type of lock, either "share-level" or "byte-range".
    NOTE: Future releases might have new values.

nlm-lock

Information about a single NLM(Nfsv2/Nfsv3) lock.

Fields

  • bytelock-length => integer, optional

    • Number of bytes (from bytelock-offset) that are locked.
  • bytelock-offset => integer, optional

    • Starting offset in file that gets bytelocked.
  • fileid => integer, optional

    • A unique number (withing filesystem) identifying the file associated with the lock.
  • fsid => integer, optional

    • Filesystem ID.
  • host => string, optional

    • IP address (in dotted decimal format) or a fully qualified domain name.
  • is-bytelock-exclusive => boolean, optional

    • Is true for exclusive bytelock, else false.
  • lock-error => string, optional

    • Error messages issued, e.g., if the input syntax is not applicable to this protocol (but maybe applicable to other protocols), or else if this protocol is specified by the "protocol" input but the syntax of host, owner, or file parameters is wrong.
  • mode => string, optional

    • File access mode of form "AccessMode-denyN" with:
    Access mode: RdWr(Read-Write), Read(Read-only) Writ(Write), None(No access)
  • path => string, optional

    • Name of the path for a file or directory.
  • state => string

    • State of the lock. See cifs-lock for description of all state values.
    NOTE: Future releases may have new lock states.
  • type => string, optional

    • Type of lock, either "share-level" or "byte-range".
    NOTE: Future releases might have new values.

pfs-lock

Information about a single PFS lock.

Fields

  • fileid => integer, optional

    • A unique number (withing filesystem) identifying the file, associated with the lock, on the origin filer.
  • fsid => integer, optional

    • Filesystem ID of the filesystem on the origin filier holding the PFS lock.
  • host-ip => ip-address, optional

    • IP address, in dotted-decimal format, of the PFS host.
  • host-name => string, optional

    • Fully qualified domain name of PFS host holding the lock.
  • lock-error => string, optional

    • Error messages issued, e.g., if the input syntax is not applicable to this protocol (but maybe applicable to other protocols), or else if this protocol is specified by the "protocol" input but the syntax of host, owner, or file parameters is wrong.
  • mode => string, optional

    • File access mode that can be one of the following:
    Deleg-PfsRead: Read delegation
    or a string of form "AccessMode-ShareMode" with:
    AccessMode: RdWr(Read-Write), Read(Read-only) Writ(Write), None(No access)
    ShareMode: denyA(deny all), denyR(deny Read access) denyW(deny Write access), denyN(deny none)
  • owner => string, optional

    • Name of the lock owner: IP address (of the caching filer holding the PFS lock), suffixed by a colon, and filesystem ID (of the caching filesystem holding the PFS lock). Syntax is: "IP:fsid".
  • path => string, optional

    • Name of the path for a file or directory.
  • state => string

    • State of the lock. See cifs-lock for description of all state values.
    NOTE: Future releases may have new lock states.
  • type => string, optional

    • Type of lock, which can only be "share-level".
    NOTE: Future releases might have new values.

alua-setting-mismatch-initiator-group

Information about an initiator group that has an ALUA (Asymmetric Logical Unit Access) setting mismatch on local and partner filers.

Fields

  • initiator-group-name => string

    • name of the initiator group.

alua-setting-mismatch-initiator-info

Information about an initiator that is a member of igroups that have an alua setting mismatch. Also detectes partner alua mismatch issues.

Fields

  • initiator-group-name => string

    • name of the initiator group name that the initiator belongs to.
  • initiator-name => string

    • name of the initiator.

clone-status-info

Status of a cloning.

Fields

  • path => string

    • LUN path being cloned.

conflict-wwpn

WWPN that has the conflict.

Fields

  • None

conflicting-initiator-info

Fibre channel initiator that belongs to igroups on the local filer which have a different OS type than the initiator groups that this initiator belongs to on the partner filer. This conflict can produce unexpected host behavior and must be fixed.

Fields

  • initiator-name => string

    • Fibre channel initiator nodename that has a different OS type on the local filer than the partner filer.

conflicting-luns-list

List of the conflicting luns.

Fields

conflicting-map-info

lun mapping conflict.

Fields

  • initiator-name => string

    • Fibre channel initiator nodename that has a lun mapped from both filers in the cluster using the same LUN-id.
  • lun-id => integer

    • lun-id used in mappings to the initiator from both filers in the cluster.

fcp-down-hba-info

Information about a down FCP HBA

Fields

  • adapter => string

    • Which FC adapter.
  • state => string

    • Description of HBAs state. Possible values: STARTUP UNINITIALIZED INITIALIZING FIRMWARE LINK NOT CONNECTED WAITING FOR LINK UP ONLINE LINK DISCONNECTED RESETTING OFFLINE OFFLINED BY USER/SYSTEM Unknown state

fcp-pr-nexus

Information about fcp nexus owning the persistent reservation These two componients identify the relationship between the FCP initiator and the target.

Fields

invalid-cfmode-setting-info

local and partner cfmode settings

Fields

invalid-nodename-setting-info

Information about different fcp nodenames

Fields

invalid-ostype-cfmode-setting-info

Information about an invalid initiator group ostype and cfmode combination

Fields

  • initiator-group-name => string

    • Name of this initiator group.
  • initiator-group-os-type => initiator-group-os-type

    • OS type of the initiator group

invalid-use-partner-cfmode-setting-info

Information about an invalid initiator group use_partner and cfmode

Fields

  • initiator-group-name => string

    • Name of this initiator group.

invalid-use-partner-ostype-setting-info

Information about an invalid initiator group ostype and use_partner combination

Fields

  • initiator-group-name => string

    • Name of this initiator group.
  • initiator-group-os-type => initiator-group-os-type

    • OS type of the initiator group
  • is-use-partner-enabled => boolean

    • If true this initiator group's members are allowed to use the partner port.

invalid-vsa-setting-info

Information about an initiator group with an invalid Volume Set Addressing (VSA) setting for its ostype. Only 'hpux' initiator groups should have VSA enabled. All other initiator groups should have it disabled. Incorrect settings can cause hosts to not be able to access some or all of their luns.

Fields

  • initiator-group-name => string

    • Name of this initiator group.
  • initiator-group-os-type => initiator-group-os-type

    • OS type of the initiator group

iscsi-pr-nexus

Information about iscsi nexus owning the persistent reservation These three componients identify the relationship between the iSCSI initiator and the target.

Fields

  • initiator => string

    • Name of initiator holding the reservation i.e. iqn.1987-06.com.initvendor1:appsrv.sn.2346.
  • isid => string

    • The Initiator Session ID for the persistent reservation owner. The ISID is a numeric Initiator Session ID assigned by the initiator which acts as part of the initiators identity.
  • tpgtag => string, optional

    • The target portal group tag of the persistent reservation owner. For historical reasons, the value is represented as a 4-byte hexadecimal number in little-endian byte order.

lun-clone-lists-info

Details of the LUN clone in the specified snapshot.

Fields

  • path => string

    • Path of the LUN clone.

lun-info

Information of a LUN.

Fields

  • backing-snapshot => string, optional

    • Path to the backing snapshot file for a LUN, if there is one. Only returned if it has one. Note: This element is not returned for LUNs which are in snapshots.
  • device-id => integer, optional

    • SCSI Peripheral Device Identifying Information returned in response to the vendor unique SCSI command GET DEV ID. Only present if a Peripheral Device Identifying Information value appropriate for GET DEV ID has been set on the LUN.
  • mapped => boolean, optional

    • Whether or not the LUN is mapped to any initiators. "true" if mapped, "false" otherwise. This field is not applicable to LUNs where the class attribute is set to 'vvol'.
  • online => boolean

    • State of the LUN, ("online" or "offline"). "true" if online, "false" otherwise.
  • path => string

    • Path of the LUN.
  • prefix-size => integer, optional

    • Size of the prefix stream for this LUN in bytes. This is either the default value for the OS type of the LUN or value specified in lun-create-by-size API. This field is unavailable while the LUN is fenced for a restore operation. This field is available in Data ONTAP 8.1 and later.
  • read-only => boolean, optional

    • "true" if the LUN is read only, "false" if read/write. This field is unavailable while the LUN is fenced for a restore operation.
  • serial-number => string, optional

    • Serial number of the 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 /-#$%&*+<=>?[!]^~@ . This field is unavailable when the LUN is in a snapshot.
  • share-state => string

    • Share state of the LUN. Possible values: "all", "none", read", "unkown", "write". In the very rare case that the share state can not be determined, "unknown" is returned.
  • size => integer, optional

    • Size of this LUN in bytes in the active FS. This field is unavailable while the LUN is fenced for a restore operation.
  • suffix-size => integer, optional

    • Size of the suffix stream for this LUN in bytes. This value is determined by the OS type of the LUN at creation time. This field is unavailable while the LUN is fenced for a restore operation. This field is available in Data ONTAP 8.1 and later.
  • uuid => string, optional

    • Universal unique identifier (UUID) for the LUN. This field is unavailable when the LUN is in a snapshot.

lun-map-info

Information about a lun mapping

Fields

  • initiator-group => string

    • Initiator group used to map the lun to the requested initiator.
  • lun-id => integer

    • Logical Unit Number which the lun is mapped to for the requested initiator.
  • path => string

    • Path of the LUN which is mapped to the requested initiator.

lun-os-type

The image type of the lun. This value determines the proper alignment settings for the desired host filesystem layout. Possible values:
  • "aix" The LUN will be used to store an AIX filesystem,
  • "hpux" The LUN will be used to store an HP-UX filesystem,
  • "hyper_v" The LUN will be used to store Hyper-V VHDs (Virtual Hard Disks),
  • "image" The default type indicating no assumptions will be made about the data stored in the LUN,
  • "linux" The LUN will be used to store a Linux filesystem with no partition table,
  • "netware" The LUN will be used to store a Netware filesystem,
  • "openvms" The LUN will be used to store an OpenVMS filesystem,
  • "solaris" The LUN will be used to store a Solaris filesystem, in a single slice partition,
  • "solaris_efi" The LUN will be used to store a Solaris filesystem with an EFI partition table,
  • "vmware" The LUN will be used to store a VMware Virtual Machine File System (VMFS) containing Virtual Machine Disk Files (VMDKs),
  • "windows" The LUN will be used to store a Windows filesystem with a Master Boot Record (MBR) partition table.
  • "windows_2008" The LUN will be used to store a Windows filesystem with a Master Boot Record (MBR) partition table on Windows 2008 or later,
  • "windows_gpt" The LUN will be used to store a Windows filesystem with a GUID Partition Table (GPT).

Fields

  • None

lun-snap-usage-lun-info

Details of the LUN backed by specified snapshot.

Fields

  • path => string

    • Path of the LUN.
  • snapshot => string

    • Name of the snapshot in which the LUN exists.

lun-stats-info

Stats for a LUN.

Fields

  • block-size => integer, optional

    • Disk block size for this LUN in bytes. This attribute is unavailable when the LUN is fenced for a restore operation.
  • path => string

    • path of the LUN. (for example, "/vol/vol0/lun1")
  • read-ops => integer

    • Total number of SCSI read ops executed.
  • write-ops => integer

    • Total number of SCSI write ops executed.

mixed-ostype-initiator-info

Information about an initiator which is a member of initiator groups of differing ostypes. An initiator can only be a member of initiator groups which have the same ostype across all the initiator groups it is a member of.

Fields

  • initiator-name => string

    • Name of the initiator.

mixed-vsa-initiator-info

Information about an initiator which is a member of initiator groups with differing Volume Set Addressing (VSA) settings. This will cause unexpected problems with the initiator.

Fields

  • initiator-group-name-1 => string

    • Name of this initiator group.
  • initiator-group-name-2 => string

    • Name of this initiator group.
  • initiator-name => string

    • Name of the initiator.

persistent-reservation-info

Information about the persistent reservation

Fields

  • reservation-type-code => string, optional

    • Type of persistent reservation held by the I_T_Nexus, if any. Please refer to the SCSI Primary Command (SPC) specification for full details on reservation types. Possible values:
    • "read shared",
    • "write exclusive",
    • "exclusive access",
    • "write exclusive registrants only",
    • "exclusive access registrants only",
    • "write exclusive all registrants",
    • "exclusive access all registrants".

address-info-family

Denotes protocol family of the address. Possible values: { af_unspec | af_local | af_unix |af_inet | af_implink | af_pup | af_chaos | af_ns | af_iso | af_osi | af_ecma | af_datakit | af_ccitt | af_sna | af_decnet | af_dli |af_lat | af_hylink | af_appletalk | af_route | af_link | pseudo_af_xtp | af_coip | af_cnt | pseudo_af_rtip | af_ipx | af_sip | pseudo_af_pip | af_inet6 } "af_unspec" - ipv4 or ipv6 address family. "af_local" - local to host (pipes, portals). "af_unix" - same as af_local backward compatibility "af_inet" - internetwork: udp, tcp, etc. "af_implink" - arpanet imp addresses "af_pup" - pup protocols: e.g. bsp "af_chaos" - mit chaos protocols "af_ns" - xerox ns protocols "af_iso" - iso protocols "af_osi" - same as af_iso backward compatibility "af_ecma" - european computer manufacturers "af_datakit" - datakit protocols "af_ccitt" - ccitt protocols, x.25 etc/ "af_sna" - ibm sna "af_decnet" - decnet "af_dli" - dec direct data link interface "af_lat" - lat "af_hylink" - nsc hyperchannel "af_appletalk" - apple talk "af_route" - internal routing protocol "af_link" - link layer interface "pseudo_af_xtp" - express transfer protocol (no af) "af_coip" - connection-oriented ip "af_cnt" - computer network technology "pseudo_af_rtip" - help identify rtip packets "af_ipx" - novell internet protocol "af_sip" - simple internet protocol "pseudo_af_pip" - help identify pip packets "af_inet6" - ipv6 address family

Fields

  • None

address-info-flag

Each flag represents a filter criteria. For example if the "passive" flag is used then the returned address information shall be suitable for use in binding a socket for accepting incoming connections for the specified service. If the "canonical_name" flag is specified and the host-name argument is not null, the function shall attempt to determine the canonical name corresponding to host-name argument. Possible values are: { ai_passive | ai_canonname ai_numerichost | ai_all | ai_addrconfig | ai_vp4mapped | ai_addrconfig | ai_default }. "ai_passive" - get address to use bind(). "ai_canonname" - fill ai_canonname. "ai_numerichost" - prevent name resolution. "ai_all" - IPv6 and IPv4-mapped (with AI_V4MAPPED). "ai_vp4mapped_cfg" - accept IPv4-mapped if kernel supports. "ai_addrconfig" - only if any address is assigned. "ai_vp4mapped" - accept IPv4-mapped IPv6 address. "ai_default" - ( ai_vp4mapped_cfg | ai_addrconfig ). "numeric_host" can appear in any combination along with "all", "ip4_mapped_configuration", "address_configuration", and "ip4_mapped".

Fields

  • None

address-info-socket-type

Denotes the type of socket for which address will be used. For example: stream socket/datagram socket. Possible values are: { sock_stream | sock_dgram | sock_raw | sock_rdm | sock_seqpacket | sock_stream_nonblk } "sock_stream" - stream socket. "sock_dgram" - datagram socket. "sock_raw" - raw protocol interface. "sock_rdm" - reliably delivered message. "sock_seqpacket" - sequenced packet stream. "sock_stream_nonblk" - sequenced packet stream non block.

Fields

  • None

address-info-transport-protocol

Denotes the type of transport protocol for which address will be used. Possible values are: { ipproto_ip | iproto_hopopts | iproto_icmp | ipproto_igmp | ipproto_ggp | ipproto_ipv4 | ipproto_ipip | iproto_tcp | ipproto_egp | ipproto_pup | iprpoto_udp | ipproto_idp | ipproto_tp | ipproto_ipv6 | ipproto_routing | ipproto_fragment | ipproto_gre | iprpoto_esp | ipproto_ah | ipproto_icmpv6 | ipproto_none | ipproto_dstopts | ipproto_eon | ipproto_encap | ipproto_ssl | ipproto_ipcomp | ipproto_raw | ipproto_done } "ipproto_ip" - dummy for IP protocol type. "ipproto_hopopts" - IPv6 hop-by-hop options. "ipproto_icmp" - control message protocol. "ipproto_igmp" - group mgmt protocol "ipproto_ggp" - gateway protocol "ipproto_ipv4" - IPv4 encapsulation "ipproto_ipip" - for compatibility with IPV4 "ipproto_tcp" - transport control protocol "ipproto_egp" - Exterior gateway protocol "ipproto_pup" - pup "iprpoto_udp" - user datagram protocol "ipproto_idp" - xns idp "ipproto_tp" - tp-4 class negotiation "ipproto_ipv6" - IPv6 header "ipproto_routing" - IPv6 routing header "ipproto_fragment" - IPv6 fragmentation header "ipproto_gre" - Generic Routing Encapsulation "iprpoto_esp" - IPv6 Encap Sec. Payload "ipproto_ah" -IPv6 Auth Header "ipproto_icmpv6" ICMP6 "ipproto_none" - IPv6 no next header "ipproto_dstopts" - IPv6 destination option "ipproto_eon" - ISO cnlp "ipproto_encap" - encapsulation header "ipproto_ssl" ssl protocol "ipproto_ipcomp" - IP Payload Compression Protocol "ipproto_raw" - raw protocl "ipproto_done" - all job for this pkt is done

Fields

  • None

config-status-info

status of net-config-info object being returned used to return non-fatal errors encountered

Fields

  • operation => string

    • Operation where error was encountered.
  • status => string

    • Error status of config object.

host-info

Contains name of the host to be resolved, hints will be provided in order to return more appropriate types of addresses, service name.

Fields

  • hints => net-address-info, optional

    • Hints given to the name resolution server in order to return the right kind of socket that the caller supports or wishes to use.
  • host-name => string, optional

    • Name of the host that needs to be resolved.
  • service-port => integer, optional

    • This parameter is represents the port number of the service for which resolved address is intended to be used for. It can be a port number 80 for the service "http". Range:[0-65535]

host-name

Host name

Fields

  • None

ifgrp-info

ifgrp name, type, and components.

Fields

  • interface-name => string

    • The interface name.

interface-config-info

Configuration for one interface.

Fields

  • aliases => ip-address-info[], optional

    • List of interface IP aliases. Cannot include ipv4 addresses if v4-primary-address is empty, and cannot include ipv6 addresses if v6_primary-address is empty (except for autoconfigured ipv6 addresses).
  • flowcontrol => string, optional

    • Specifies the flow control type. Possible values: {none | receive | send | full} The meaning of these values is: "none" (no flow control), "receive" (only receive flow control frames), "send" (only send flow control frames), and "full" (send and receive flow control frames). If the flowcontrol option is not specified, the default value is interface-dependent. Fiber Interfaces: If the interface detects that the link partner auto-negotiates, then the operational flow control setting is negotiated (and the configured or default setting for flow control is ignored). Not all interfaces have a flowcontrol (e.g. loopback does not) Default is NIC-specific.
  • interface-name => string

    • Name of the interface.
  • ipspace-name => string

    • Name of ipspace that the interface belongs to.
  • is-enabled => boolean, optional

    • Administrative status. (true: interface is administratively up). Default is true.
  • mediatype => string, optional

    • Specifies the Ethernet media type used. Possible values: {tp | tp-fd | 100tx | 100tx-fd | 1000fx | 10g-sr | auto} 10/100, 100/1000, and 10/100/1000 Mbps Copper Interfaces: The acceptable types (which vary from card to card) are "tp" (Half-duplex 10BaseT RJ-45 twisted-pair), "tp-fd" (Full duplex 10Base-T RJ-45 twisted-pair), "100tx" (Half-duplex 100Base-T RJ-45 twisted-pair), "100tx-fd" (Full duplex 100Base-T RJ-45 twisted-pair), and "auto" (Auto RJ-45 twisted-pair). The default media type is set to "tp" or to "auto" where applicable. 1000 Mbps Fiber Interfaces: The Gigabit Ethernet Controllers only support the mediatype "auto". The Gigabit Ethernet Controllers only support full-duplex. 10G bps Fiber Interfaces: The 10G TOE/Ethernet Controllers support the mediatype "10g-sr" and "auto". The interface does not do auto-negotiatition, it only supports 10Gb speed, full duplex. Not all interfaces have a mediatype (e.g. loopback does not)

interface-dcb-entry-info

DCB configuration information about a priority group.

Fields

  • priority-group-id => integer

    • The Priority Group ID. A priority group is a group of priorities bound together by management for the purpose of bandwidth allocation. All priorities in a single group are expected to have similar traffic handling requirements (e.g. latency or frame loss). Range: [0..15]

interface-dcb-priority-entry-info

DCB configuration information about a priority.

Fields

  • application => string

    • Application assigned to a specified priority group.
  • priority-group-id => integer

    • The priority group ID. A priority group is a group of priorities bound together by management for the purpose of bandwidth allocation. All priorities in a single group are expected to have similar traffic handling requirements (e.g. latency or frame loss). Range: [0..15]

ip-address

One ip address, in dotted-decimal format (for example, "192.168.11.12").

Fields

  • None

ip-address-info

A configured IP Address

Fields

  • broadcast => ip-address, optional

    • broadcast address. Default if not specified is computed from IP address and netmask. Not used for IPV6. Must be consistent with netmask.
  • creator => string

    • Entity responsible for creation of address. "vfiler:" if created by d-blade for vfiler. "vserver:" if created by n-blade with cluster-wide scope.

ip-address-or-hostname

IP address string. For example, 198.18.100.12, or "`hostname`-e0c" (backquoted hostname is allowed) or "toaster" (assuming toaster resolves to an IP address) or fd20:8b1e:b255:104:230:48ff:fe8c:6326

Fields

  • None

ipspace-config-info

An IPSpace.

Fields

  • ipspace-name => string

    • IPSpace name.

link

ifgrp sub-interface name

Fields

  • None

net-address-info

Holds host address information.

Fields

  • canonical-name => string, optional

    • Canonical name for hostname.
  • ip-address => string

    • Resolved IP address string. May be IPv4 or IPv6. For example, 198.18.100.12 or fd20:8b1e:b255:104:230:48ff:fe8c:6326. No hostname resolution.

net-config-info

interface configurations and routes

Fields

  • config-status => config-status-info[], optional

    • status of net-config-info object, details of non-fatal errors Note: all the net zapis make a best effort and will return a successful result as long as they are partially successful. It is up to the client to inspect this status field and warn the user if problems were encountered.

net-dcb-entry-info

DCB configuration information about a single network interface.

Fields

  • interface-name => string

    • The network interface name.

net-dcb-priority-entry-info

DCB configuration information indexed by the priority about a single network interface.

Fields

  • interface-name => string

    • The network interface name.

netmask-or-prefix

netmask. Possible values: dotted decimal or hex integer (range: 0x1 .. 0xffffffff) or '/' followed by hex integer (range: 0x1 .. 0x40) Default if not specified is classful: Class A address - 255.0.0.0 or 0xff000000 or /8 Class B address - 255.255.0.0 or 0xffff0000 or /16 Class C address - 255.255.255.0 or 0xffffff00 or /24 IPV6 address prefix - /1 through /128

Fields

  • None

priority-entry-info

A priority associated to the specified priority group.

Fields

  • priority => integer

    • The priority associated with the specified priority group. Range: [0..7]

route-info

A kernel route.

Fields

  • addr-family => string

    • Address family. Possible values: {af-inet6 | af-inet}.
  • creator => string

    • Entity responsible for creation of route. Possible values: "filer" if created by d-blade for default vfiler. "vfiler: " if created by d-blade for vfiler. "vserver: " if created by n-blade with cluster-wide scope.
  • ipspace-name => string

    • IPSpace name. Must match the ipspace assigned to the creator.

vlan-info

vlan

Fields

  • gvrp-enabled => boolean, optional

    • true: GVRP is enabled. Default is false. GVRP is deprecated and this attribute is ignored in cluster mode. GVRP is a standard vlan trunking protocol that enables a port to advertise which vlans it trunks, thereby decreasing traffic over the trunk. This protocol eliminates the need to manually configure vlan information on each switch in the network.
  • interface-name => string, optional

    • Name of vlan interface. The name must be of the format <parent-inteface>-<vlanid>

exports-hostname-info

Structure containing information pertaining to a host.

Fields

  • all-hosts => boolean, optional

    • Default value is false. If true, enables all hosts to have this rule's access rights. A hostname of 'all-hosts' must exist as the only non-negated element in a hostname array.
  • name => string, optional

    • A hostname can be ONE of the following formats. If 'all-hosts' is true, 'name' must not have a value. machine-name: Alphanumeric string based on DNS. netgroup: Alphanumeric string describing a group of   machine names ip: An IP address in dotted decimal format AAA.BBB.CCC.DDD subnet: "[network] subnet [netmask] netmask" ip-subnet: IP/numbits. The IP is a subnet number and the   numbits specifies the size of the subnet by the   number of leading bits of the netmask. dns: A DNS domain. An Alphanumeric starting with a '.'
  • negate => boolean, optional

    • In Data ONTAP 7-Mode, default is false. If true, the rule applies to every host but this one. Used most commonly when adding a group minus a few hosts. In Data ONTAP Cluster-Mode, negations are not supported. An error will be returned if true.

exports-rule-info

Information necessary to create a new rule in the etc/exports file or for just adding a rule similar to the exportfs command. ORDER MATTERS for the hostnames in 'read-only' and 'read-write' privileges. Please see documentation for exportfs command or etc/exports file for complete details.

Fields

  • actual-pathname => string, optional

    • In Data ONTAP 7-Mode, it must be pathname inside of the filer which is being exported. The default for this is value in 'pathname'. In Data ONTAP Cluster-Mode, this value must be an empty string.
  • nosuid => boolean, optional

    • If true, causes the server file system to silently ignore any attempt to enable the setuid or setgid mode bits. Default value is false.
  • pathname => string

    • In Data ONTAP 7-Mode, it must be directory name or file to export. In Data ONTAP Cluster-Mode, it must be the path of the volume or qtree to be exported such as "vol/vol0" or "/vol/vol0/qtree0".
  • read-write => exports-hostname-info[], optional

    • An array of hostnames which have read and write privileges. Any hostname in read-only must not be in read-write also. By default, if no 'read-only' or 'read-write' hosts are given, then 'read-write' contains a hostname of 'all-hosts'.
  • sec-flavor => sec-flavor-info[], optional

    • List of possible security flavors this rule supports. Default security is "sys". In Data ONTAP Cluster-Mode, all the security flavors supported by 7-Mode are not supported. Hence the security flavors supported in both the ONTAP versions [for reference: 'none','sys','krb5'] will be considered valid.

exports-rule-info-2

Information necessary to create a new rule in the etc/exports file or for just adding a rule similar to the exportfs command.

Fields

  • actual-pathname => string, optional

    • In Data ONTAP 7-Mode, it must be pathname inside of the filer which is being exported. The default for this is value in 'pathname'. In Data ONTAP Cluster-Mode, this value must be an empty string.
  • pathname => string

    • In Data ONTAP 7-Mode, it must be directory name or file to export. In Data ONTAP Cluster-Mode, it must be the path of the volume or qtree to be exported such as "vol/vol0" or "/vol/vol0/qtree0".

hostaddr

the individual client hosts. could be a hostname or an IP address.

Fields

  • None

nfs-stats-info

structure containing statistics for each NFS version

Fields

nfs-top-info

Information about a single nfs top.

Fields

  • client-info => string

    • Client IP address
  • read-ops => integer

    • The number of nfs READ operations Range : [0..2^64-1].
  • write-ops => integer

    • The number of nfs WRITE operations Range : [0..2^64-1].

nfsv2-client-stats-info

structure containing statistics for NFSv2 operations

Fields

  • create-ops => integer

    • total 'create' NFSv2 operations Range : [0..2^64-1].
  • getattr-ops => integer

    • total 'getattr' NFSv2 operation Range : [0..2^64-1].
  • lookup-ops => integer

    • total 'lookup' NFSv2 operations Range : [0..2^64-1].
  • read-ops => integer

    • total 'read' NFSv2 operations Range : [0..2^64-1].
  • readdir-ops => integer

    • total 'readdir' NFSv2 operations Range : [0..2^64-1].
  • readlink-ops => integer

    • total 'readlink' NFSv2 operations Range : [0..2^64-1].
  • remove-ops => integer

    • total 'remove' NFSv2 operations Range : [0..2^64-1].
  • write-ops => integer

    • total 'write' NFSv2 operations Range : [0..2^64-1].

nfsv3-client-stats-info

structure containing statistics for NFSv3 operations

Fields

  • create-ops => integer

    • total 'create' NFSv3 operations Range : [0..2^64-1].
  • getattr-ops => integer

    • total 'getattr' NFSv3 operations Range : [0..2^64-1].
  • link-ops => integer

    • total 'link' NFSv3 operations Range : [0..2^64-1].
  • lookup-ops => integer

    • total 'lookup' NFSv3 operations Range : [0..2^64-1].
  • mkdir-ops => integer

    • total 'mkdir' NFSv3 operations Range : [0..2^64-1].
  • null-ops => integer

    • total 'null' NFSv3 operations Range : [0..2^64-1].
  • read-ops => integer

    • total 'read' NFSv3 operations Range : [0..2^64-1].
  • readdir-ops => integer

    • total 'readdir' NFSv3 operations Range : [0..2^64-1].
  • readlink-ops => integer

    • total 'readlink' NFSv3 operations Range : [0..2^64-1].
  • remove-ops => integer

    • total 'remove' NFSv3 operations Range : [0..2^64-1].
  • rename-ops => integer

    • total 'rename' NFSv3 operations Range : [0..2^64-1].
  • rmdir-ops => integer

    • total 'rmdir' NFSv3 operations Range : [0..2^64-1].
  • setattr-ops => integer

    • total 'setattr' NFSv3 operations Range : [0..2^64-1].
  • symlink-ops => integer

    • total 'symlink' NFSv3 operations Range : [0..2^64-1].
  • write-ops => integer

    • total 'write' NFSv3 operations Range : [0..2^64-1].

nfsv4-client-stats-info

structure containing statistics for NFSv4 operations

Fields

owner-info

Information about the client host and the owner process on the client host whose locks have to be removed.

Fields

pathname-info

Information about a pathname.

Fields

  • name => string

    • In Data ONTAP 7-Mode, it must be the name of the path, such as "/vol/vol0". In Data ONTAP Cluster-Mode, it must be the path of the volume or qtree to be exported such as "vol/vol0" or "/vol/vol0/qtree0".

rpc-data-info

structure containing statisticcs for RPC operations

Fields

  • badcalls-total => integer

    • total bad RPC calls Range : [0..2^32-1].
  • calls-total => integer

    • total RPC calls Range : [0..2^64-1].

rpc-stats-info

structure containing statistics for RPC operations

Fields

sec-flavor-info

Security flavor information for RPC. Only hosts connecting using the proper security can access the directory.

Fields

  • flavor => string

    • Current possible values can be found using the 'nfs-get-supported-sec-flavors' command. For reference: In Data ONTAP 7-Mode, 'none', 'sys', 'Krb5', 'Krb5i', 'Krb5p' are all supported. In Data ONTAP Cluster-Mode, 'none', 'sys', 'krb5', 'ntlm', 'any', 'never', 'spinauth' are supported.

security-rule-info

Information on hostnames and security availability for the hosts. ORDER MATTERS for the hostnames in 'read-only' and 'read-write' privileges. Please see documentation for exportfs command or etc/exports file for complete details.

Fields

  • anon => string, optional

    • All hosts with this user-id or username have root access to this directory.
  • nosuid => boolean, optional

    • If true, causes the server file system to silently ignore any attempt to enable the setuid or setgid mode bits. Default value is false.
  • read-only => exports-hostname-info[], optional

    • An array of hostnames which only have read privileges for all the security flavors found in the sec-flavor list.
  • read-write => exports-hostname-info[], optional

    • An array of hostnames which have read and write privileges for all the security flavors found in the 'sec-flavor list'. Any hostname in 'read-only' must not be in 'read-write' also. By default, if no 'read-only' or 'read-write' hosts are given, then 'read-write' contains a hostname of 'all-hosts'.
  • root => exports-hostname-info[], optional

    • Array of hostnames which have roots with 'read-write' or 'read-only' privileges.
  • sec-flavor => sec-flavor-info[], optional

    • List of possible security flavors this rule supports. Default security is "sys". In Data ONTAP Cluster-Mode, all the security flavors supported by 7-Mode are not supported. Hence the security flavors supported in both the ONTAP versions [for reference: 'none','sys','krb5'] will be considered valid.

tcp-flowcontrol-stats-info

structure containing statistics for tcp flowcontrol

Fields

option-info

null

Fields

  • cluster-constraint => string, optional

    • Indicates the cluster-specific constraints of option.
    • "none" - no constraint.
    • "same_preferred" - same value should be used on both nodes of a HA pair.
    • "same_required" - same value must be used on both nodes of a HA pair.
    • "only_one" - value is used for both nodes of a HA pair, when in takeover mode.
    • "unknown" - value is not valid.
    In Data ONTAP Cluster-Mode, this field will always be "none". This field is optional in Data ONTAP Cluster-Mode, but required in Data ONTAP 7-Mode.
  • name => string, optional

    • Name of the option. This field is optional in Data ONTAP Cluster-Mode, but required in Data ONTAP 7-Mode.
  • value => string, optional

    • Value of the option. This field is optional in Data ONTAP Cluster-Mode, but required in Data ONTAP 7-Mode.

counter

Counter name.

Fields

  • None

counter-data

Value of a single counter of an instance of an object at the time of the call.

Fields

  • name => string

    • Name of the counter
  • value => string

    • Value of the counter. If the counter type is array, this is a comma separated list of values. The counter properties and units must be known in order to interpret this value. Refer to the perf API discussion for details on how raw counter values are interpreted.

counter-info

Information about a single counter.

Fields

  • is-key => boolean, optional

    • True if the counter is a key counter. A set of key counters for an object can be used to uniquely identify instances of an object.
  • name => string

    • Name of the counter.
  • privilege-level => string

    • Privilege level of the counter. Any counter with a privilege level of "diag" is not guaranteed to work, to exist in future releases, or to remain unchanged.
    Possible values: basic, admin, advanced or diag.
  • properties => string, optional

    • Comma separated list of properties of the counter. The counter properties determine how raw counter values should be interpreted.
    Possible values: raw, rate, delta, percent, string, no-display and no-zero-values.
  • type => string, optional

    • Indicator for whether counter is a scalar or array. If this element is absent,the counter is a scalar.
    Possible values: array
  • unit => string, optional

    • Unit of the counter
    Possible values: per_sec, b_per_sec (bytes/s), kb_per_sec (Kbytes/s), mb_per_sec (Mbytes/s), percent, millisec, microsec, sec, or none

instance

Instance name.

Fields

  • None

instance-data

Instance name and counter values.

Fields

  • counters => counter-data[]

    • List of counter values of this instance. Each element of this list contains the value of a single counter.
  • name => string

    • Name of the instance

instance-info

Description of an instance of an object.

Fields

  • name => string, optional

    • Name of the instance

label-info

Comma separated list of labels of an array type counter.

Fields

  • None

object-info

Description of a performance object.

Fields

  • description => string, optional

    • Description of the object
  • get-instances-preferred-counter => string, optional

    • Name of the counter, either instance_name or instance_uuid, which should be used for perf-object-get-instances ZAPI for optimal performance. If this element is absent for an object, the value of this element defaults to instance_name counter. This element is a performance hint for getting optimal performance for the perf-object-get-instances ZAPI. If the value of this element is set to instance UUID counter of an object, using the instance UUID counter in the perf-object-get-instances query will return the counter information faster than using instance name counter. Otherwise, instance_name will yield faster results.
  • name => string

    • Name of the object
  • privilege-level => string

    • The object privilege level. Any object with a privilege level of "diag" is not guaranteed to work, to exist in future releases, or to remain unchanged.
    Possible values: basic, admin, advanced or diag.

initiator-group-name

The name of an initiator group

Fields

  • None

portset-info

Information about a port set.

Fields

  • portset-name => string

    • Name of this port set.
  • portset-type => string

    • Possible values: "fcp", "iscsi", "mixed".

portset-port-name

String representing a member of a portset. In Data ONTAP 7-Mode, the port name is of the format "filer:slotletter" or "slotletter". In Data ONTAP Cluster-Mode, the port name is the name of an FCP data lif or iSCSI target portal group.

Fields

  • None

priority-volume-info

Information about a priority schedule for a volume.

Fields

  • nvlog-limit => integer

    • The limit on nvlog consumption during a consistency point. 0 means a system-created default is being applied.
  • service => string

    • The priority service state for the volume, "on" or "off"
  • system => integer

    • The system/user priority, as described in priority-set-volume.
  • system-read-limit => integer

    • The limit on system reads, 0 means an automatic system default is being applied.
  • user-read-limit => integer

    • The limit on user reads, 0 means an automatic system default is being applied.
  • volume => string

    • Name of the volume.

qtree-info

Information about a single qtree.

Fields

  • id => integer

    • Id of the qtree (unique within the volume), which is 0 if qtree is the volume itself.
  • oplocks => string

    • Indicates whether opportunistic locks are enabled on the qtree. Possible values: "enabled", "disabled".
  • owning-vfiler => string, optional

    • Name of the vfiler which owns this qtree. This value will be returned only if the request is coming to vfiler0 and MultiStore is licensed.
  • qtree => string

    • Name of the qtree, blank if qtree is the volume itself
  • security-style => string

    • Security style of the qtree. Possible values are "unix", "ntfs", or "mixed".
  • status => string

    • Status of the qtree. Possible values include: "snapvaulted", "snapmirrored", "normal", and "readonly".
  • volume => string

    • Name of the volume containing the qtree

error

Information about a single error.

Fields

  • status => string

    • Either 'passed' or 'failed'.

quota

Information about a single quota.

Fields

  • disk-limit => string

    • Maximum amount of disk space, in kilobytes, allowed for the quota target (hard disk space limit). The value is "-" if the limit is unlimited.
  • file-limit => string

    • Maximum number of files allowed for the quota target (hard files limit). The value is "-" if the limit is unlimited.
  • quota-target => string

    • For an explicit quota, this value is a fully qualified quota target which is the quota target specified in the /etc/quotas file and the domain in the QUOTA_TARGET_DOMAIN directive is in effect. See na_quotas(5) for more information. Mulitple targets are comma separated. For a derived quota, the field is blank.
  • quota-type => string

    • The type of quota: user, group, or tree.
  • soft-disk-limit => string

    • Soft disk space limit, in kilobytes, for the quota target. The value is "-" if the limit is unlimited.
  • soft-file-limit => string

    • Soft file limit, in number of files, for the quota target. The value is "-" if the limit is unlimited.
  • threshold => string

    • Disk space threshold, in kilobytes, for the quota target. The value is "-" if the limit is unlimited.
  • vfiler => string, optional

    • Name of the vfiler to which the quota applies, if vfilers are in use.
  • volume => string

    • Name of the volume to which the quota is applied.

quota-entry

Information about a single quota rule.

Fields

  • line => string, optional

    • The raw line from /etc/quotas. This is only returned when the input element is set to true. It is returned whether there is an error or not.
  • qtree => string, optional

    • Name of the qtree for the quota. It can be the qtree name or "" if no qtree. If there is an error in the quota entry, this value might not present. For tree rules, this field will be "".
  • quota-error => quota-error, optional

    • This value is only present if there is an error, and gives complete details for an error for a specific quota entry.
  • quota-target => string, optional

    • The quota target of the type specified. The value will be one of: <name>, <number>, or <path name>. Mulitple targets can be specified by a comma-separated list. Quota directives in /etc/quotas are used to form the quota target. If there is an error in the quota entry, this value might not present. For explicit tree rules, this field will indicate the qtree name in the format "/vol/< volume name >/ < qtree name >".
  • quota-type => string, optional

    • The type of quota rule. Possible values are "user", "group", or "tree". If there is an error in the quota entry, this value might not present.
  • volume => string, optional

    • Name of the volume for the quota. If there is an error in the quota entry, this value might not present.

quota-error

Information about a single quota error.

Fields

  • errno => integer

    • The error number.
  • reason => string

    • A human-readable concise reason for the error.

quota-info

Information about a single quota.

Fields

  • disk-limit => string

    • Maximum amount of disk space, in kilobytes, allowed for the quota target (hard disk space limit). The value is "-" if the limit is unlimited.
  • disk-used => string

    • Current amount of disk space, in kilobytes, used by the quota target.
  • file-limit => string

    • Maximum number of files allowed for the quota target (hard files limit). The value is "-" if the limit is unlimited.
  • files-used => string

    • Current number of files used by the quota target.
  • qtree => string

    • Name of qtree to which the quota is applied.
  • quota-target => string

    • For an explicit quota, this value is a fully qualified quota target which is the quota target specified in the /etc/quotas file and the domain in the QUOTA_TARGET_DOMAIN directive is in effect. See na_quotas(5) for more information. Mulitple targets are comma separated. For a derived quota, the field is blank.
  • quota-type => string

    • Quota type, which can be user, group, or tree
  • soft-disk-limit => string

    • Soft disk space limit, in kilobytes, for the quota target. The value is "-" if the limit is unlimited.
  • soft-file-limit => string

    • Soft file limit, in number of files, for the quota target. The value is "-" if the limit is unlimited.
  • threshold => string

    • Disk space threshold, in kilobytes, for the quota target. The value is "-" if the limit is unlimited.
  • vfiler => string, optional

    • Name of the vfiler to which the quota applies.
  • volume => string

    • Name of volume to which the quota is applied.

quota-user

Information about a quota user or group.

Fields

  • quota-user-id => string

    • The id of the user. The quota-user-type determines the format. For uid and gid, the format is an integer. For sid, the format is the usual "S-*" style.
  • quota-user-type => string

    • The type of quota user. There are two possible values: sid (for Windows users), uid (for UNIX users), and gid (for UNIX groups).

radius-server-list-entry-info

Configuration information about a radius server.

Fields

radius-stats-info

Statistics block

Fields

reallocate-job-info

Information about a specific reallocation job.

Fields

  • interval => string

    • Interval between reallocation jobs The format for this value is as described in reallocate-start, above.
  • layout-factor => integer

    • Current allocation layout factor, if known. The range is from 1 (ideal layout) upwards. A value of -1 is returned if the current layout factor is unknown.
  • measure-logfile => string, optional

    • For a measure-only job the logfile, if any.
  • path => string

    • The path for the reallocation job.
  • scan-detail => string

    • If a reallocation job is running, detail on the current scan, including the progress when known.
  • schedule => string

    • Schedule for reallocation. The format for this value is as described in reallocate-schedule-set, above.
  • state => string

    • The current state of the reallocation job. The states are Idle, Checking, Reallocating, Deleting or Quiesce.
  • threshold => integer, optional

    • The reallocation threshold (verbose only), as described above in reallocate-start, above.

rsh-session-info

null

Fields

  • command => string

    • ONTAP command the rsh session is executing.
  • session-id => integer

    • rsh session identifier.
  • vfiler => string

    • Name of the vfiler on which the rsh session is active

alternate-control-path-info

Available information on the alternate control path (ACP) to the shelf.

Fields

  • module-ip-address => string, optional

    • IP address that is used by this ACP shelf module. This field will not be present if the IP address is unknown or not available, or if an ACP element is not installed.
  • module-mac-address => string, optional

    • MAC address that is used by this module's ACPP. This field will not be present if the MAC address is unknown or not available, or if an ACP element is not installed.
  • module-name => string, optional

    • Shelf module for this ACPP. Possible Values: "A", "B" This field will not be present if it is unknown or not available, or if an ACP element is not installed.
  • module-reset-count => integer, optional

    • Number of times the corresponding shelf I/O module has been reset using this ACPP. This field will not be present if it is unknown or not available, or if an ACP element is not installed.
  • module-status => string, optional

    • ACP status of this shelf module. This field will not be present if it is unknown or not available, or if an ACP element is not installed. Possible values: "active", "inactive_not_ready", "inactive_waiting_for_inband_info", "inactive_no_inband_connectivity", "inactive_not_responding", "inactive_updating_firmware", "inactive_initializing", "inactive_unknown".

ariodata-specific-info

Vendor specific enclosure system information for Ariodata shelf.

Fields

bay-info

A list of shelf bay numbers which have disks.

Fields

  • lun => integer, optional

    • The logical unit number within the target. This field will be present in some storage configurations. In some cases, devices with a logical unit number will have LEDs that can be affected. Range : [0..255]
  • shelf-bay => integer

    • A shelf-bay number indicates the presence of a drive in that bay. Shelf bays are numbered starting at 0 which is the right most drive bay in the shelf when viewing the shelf from the front. Range: [0..255]

connector-info

Information on cables and/or connectors connected to the shelf

Fields

cooling-element-info

Information on individual cooling elements (fans).

Fields

  • rpm => integer, optional

    • Current RPM (revolutions per minutes) of the fan. Will not be present if RPM is not available at the time API is executed or if RPM detection hardware is not supported by the shelf or if cooling element is not installed.

current-sensor-info

Presents the electrical current sensor information, if implemented on the system.

Fields

  • sensor-condition => string, optional

    • A Text string describing whether the sensor-reading field is within normal operating range. This field is present only if sensor-reading field is also present. Possible values are: "overcurrent_failure", "overcurrent_warning", "normal_operating_range".

dongle-info

dongle information

Fields

  • disable-reason => string, optional

    • If phy-state is "disabled", then this will give explanation as to the reason. Possible values: "manual", "no_drive", "brst_los", "los", "brst_rdd", "rdd", "brst_idd", "idd", "brst_prp", "prp", "brst_pcd", "pcd", "brst_crc", "crc", "osc", "mir", "rsrv", "man_smp", "clk_flt", "unknown".

enclosure-info

Information on the enclosure type. This information will be presented for ESH and SAS shelves only.

Fields

es-electronics-info

Information on the installed enclosure services (ES) electronics.

Fields

  • es-revision => string, optional

    • CPLD revision of the ES electronics, if applicable. This field will not be present if the information is not available, not implemented, or if the element is not installed.
  • es-swap-count => integer, optional

    • Number of times, since last boot, that this ES electronics elements has been swapped. Will not be present if the element is not installed.

esh-info

Information on individual ESH modules in the shelf.

Fields

eurologic-specific-info

Vendor specific enclosure system information for Eurologic shelf.

Fields

module-info

Shelf enclosure module info.

Fields

  • is-sas-expander-master-module => boolean, optional

    • When the value of enclosure-type field of enclosure-type-info is sas-expander-module, then this field indicates whether this module is the SAS expander master module. This field will only be present for sas-expander-module values.

phy-expander-info

Expander PHY (physical layer) information of an individual port.

Fields

  • bay-number => integer, optional

    • Bay port number. Unique bay-number for each type of phy-type. Present when multiple phy's for a phy-type exist in the shelf, such as phy-type "disk", "P0", "P1".
  • crc-error-count => integer

    • This field presents the number of CRC errors that have been seen in any address or data frames. The value will be the count kept by the expander since either power-on or since the counts have been reset.
  • dongle-data => dongle-info, optional

    • dongle information, if there's a dongle installed. Will be missing if not supported or not available. Present for drive phy only.
  • invalid-dword-count => integer

    • The number of invalid double words seen outside of the phy reset sequence. The value will be the count kept by the expander since either power-on or since the counts have been reset.
  • link-rate => string, optional

    • If port-state is "ok", then this is a floating number, representing SAS-1.1 defined negotiated link rate value for the phy in Gb/s. Example: 3.0. For all other port states, this field will not be available.
  • loss-dword-count => integer

    • This field presents the number of times the phy has lost double-word synchronization and restarted the link reset sequence of the phy reset sequence. The value will be the count kept by the expander since either power-on or since the counts have been reset.
  • phy-change-count => integer

    • This field the number of times this logical phy has changed state. This count increments when the logical phy transitions from disabled to enabled. This count also increments when the logical phys transitions from enabled to disabled. The value will be the count kept by the expander since either power-on or since the counts have been reset.
  • phy-reset-problem => integer

    • This field presents the number of times the phy reset sequence has failed. The value will be the count kept by the expander since either power-on or since the counts have been reset.
  • phy-state => string, optional

    • State of the phy. Possible values: "rate_unknown", "disabled", "speed_negotiation_failed", "sata_oob_failed", "1.5_gbps", "3.0_gbps", "6.0_gbps", "state_unknown",
  • port-id => string

    • Possible values are: port id in range [0..19] or "in0", "in1", "in2", "in3", "out0", "out1", "out2", "out3", representing one of the input or output ports.
  • port-state => string

    • Current port state. Possible values are: "ok", "unkwn_lnk", "unused", "unkwn", "empty", "dis_man", "dis_smp", "dis_loswd", "dis_dispa", "dis_invwd", "dis_reset", "dis_phchg", "dis_mir", "dis_crc", "dis_clk", "dis_resv", "dis_unusd", "unknown", "no_signal",
  • power-cycle-count => integer, optional

    • This field presents the number of times the driver has been power cycled via this phy. Will be missing if not supported or not available. Present for drive phy only.
  • release-count => integer, optional

    • This field presents the number of times the driver has been released (unreserved) via this phy. Will be missing if not supported or not available. Present for drive phy only.
  • reserve-count => integer, optional

    • This field presents the number of times the driver has been reserved via this phy. Will be missing if not supported or not available. Present for drive phy only.
  • running-disparity-count => integer

    • The number of Dwords with a running disparity error seen outside the phy reset sequence. The value will be the count kept by the expander since either power-on or since the counts have been reset.

port-hub-info

Hub information for an individual port.

Fields

  • disk-bay => integer, optional

    • If port-id is "in", "out", "aux1" or "aux2" then this is not populated, otherwise, it represents the shelf bay that the disk resides in.
  • lip-count => integer, optional

    • Lip count, number of times loop initialization primitive has been generated. This field is not available on all shelf modules.
  • port-id => string

    • Possible values are: port number in the range of 0 to 255 or "in", "out", "aux1" or "aux2" representing input, output or one of auxiliary ports. This is the same as FCAL ALPA for the port.
  • port-state => string

    • Current port state. Possible values are: "ok", "empty", "byp_init", "byp_gen", "byp_man", "byp_xmit", "byp_lipf8", "byp_dto", "byp_rlos", "byp_clos", "byp_tbi", "byp_rprt", "byp_stall", "byp_wrd", "byp_crc", "byp_lip", "byp_osc", "byp_clk", "byp_mir", "byp_lipf7", "byp_bzr", "byp_self", "byp_flt", "byp_pwr", "byp_pcycl", "warn_lip", "warn_wrdb", "warn_wrd", "warn_crc", "warn_clk", "unknown", "term-err", "term", "autoterm".

power-supply-info

Power supply information

Fields

  • power-supply-type => string, optional

    • Power supply type. This field will not be present if power supply type is unavailable or feature is not implemented, or if the power supply is missing.

processor-complex-info

Available information on the processor complex modules (PCMs) in the shelf.

Fields

sas-connector-info

Detailed information on SAS cables and connectors connected to the shelf. Only information on the connectors with cables attached will be presented.

Fields

  • attached-serial-no => string, optional

    • Serial number of the attached cable as assigned by the cable manufacturer. This field will not be present if the information is not available, or if a cable is not connected at this connector. Note that depending on the cable, the serial number at the two ends of the cable may or may not match. An example of this is SAS optical cables that do not have integrated QSFP's, which will show different attached serial numbers at the ends of cable. Cables with integrated QSFP's will have matching serial numbers at both ends.
  • cable-end-identifier => string, optional

    • Each cable has two ends. This field shows which end of the cable is connected to the shelf. This field will not be present if the information is not available or accessible, or if a cable is not connected at this connector. Possible values: "end_0", "end_1".
  • cable-length => string, optional

    • Cable length. This field will not be present if the information is not available or accessible, or if a cable is not connected at this connector.
  • cable-part-no => string, optional

    • Part number of the cable as assigned by the cable manufacturer. This field will not be present if the information is not available, or if a cable is not connected at this connector.
  • cable-serial-no => string, optional

    • This is actually not serial number, but rather cable identifier. For backwards compatibility this is reported as cable-serial-no. For the actual serial number see attached-serial-no. The connectors at both ends of the same cable will report the same value for this field. This field can be used to generate topology. This field will not be present if a cable is not connected to the connector or if the cable is not connected to a functioning device.
  • cable-technology => string, optional

    • Cable technology. This field will not be present if the information is not available or accessible, or if a cable is not connected at this connector. Possible values: "cupper", "optical".
  • cable-type => string, optional

    • Type of the cable being used. This field will not be present if the information is not available or accessible, or if a cable is not connected at this connector. Possible values: "qsfp".
  • connector-designator => string, optional

    • Connector desiagnator.
    • "sqr" - The port is marked with a square on the shelf connector panel,
    • "cir" - The port is marked with a circle on the shelf connector panel.
    Will be missing if unknown or not available.
  • is-cable-connected => boolean

    • Indicates whether a cable is connected at this connector location. No further information will be provided if a cable is not connected at this connector location. Note that a cable connection does not necessarily mean that the shelf is connected to a storage cointroller. This will also depend on the other end of the cable.

sas-specific-info

Vendor specific enclosure system information for SAS shelf.

Fields

  • serial-no => string

    • Shelf backplane serial number.

ses-generic-info

Generic SES (SCSI enclosure services) information.

Fields

  • ses-config-access => string, optional

    • The method shelf configuration was obtained. Possible values: "via_embedded_ses", "via_scsi_from_shelf", "via_loop_from_shelf", "remote_access_via_controller", "not_available".
  • ses-config-access-controller-name => string, optional

    • If the value of ses-config-access field is "remote_access_via_controller" then this field will return the name of storage controller the configuration was obtained from. This field will not be present if storage controller name is not available or if the value of ses-config-access field is not "remote_access_via_controller".
  • ses-contact-state => string

    • Enclosure contact state. Possible values are: "active", "initializing", "transitioning", "inactive", "reconfiguring", "non_existent".

shelf-bay-info

Shelf bay information.

Fields

  • bay-count => integer, optional

    • Disk bays are the slots into which disks are placed. The bays are numbered from 0 to bay-count-1. Bay 0 is the right most bay (when looking at the front of the shelf) and bay bay-count-1 is left most. These bay numbers can be used by other commands, including storage-shelf-set-led-state.
  • bay-list => bay-info[]

    • A list of shelf-bay numbers which have disk drives. The bay-list field is not optional, but it may contain zero bay-info elements.

shelf-bay-list-info

Bay and port information on a shelf module.

Fields

  • channel-name => string

    • The channel the shelf (hub) is attached to. Example: 0c.
  • module => string

    • The shelf module attachment. Possible values: "a", "b".
  • shelf-id => integer

    • The shelf id switch setting. This is the shelf id switch that is used to uniquely identify the shelf on the filer node.
  • shelf-name => string

    • Shelf name that the hub is attached to. This can also be considered as hub name. Example: 0c.shelf1.
  • shelf-state => string

    • Current state of the shelf. Possible values are: "no_status", "init_required", "online", "missing", "failed", "unknown".
  • shelf-type => string

    • Shelf module type. Possible values: "edm", "vem", "esp", "lrc", "esh", "esh2", "esh4", "eshfx", "eshtx", "emu", "efh", "at-fc", "at-fc2", "at-fcx", "at-fcx2", "sas", "esas", "sas-fc", "iom3", "iom6", "iom6e".
  • shelf-uid => string

    • Shelf unique identifier that distinguishes it from other shelves manufactured. Example: 50:05:0c:c0:02:10:64:26.

shelf-bay-port-info

Shelf bay port specific information.

Fields

  • bay-no => integer, optional

    • Disk bay number or port number, if applicable. In some instances bay numbers do apply and will not be present. An example is an ESH shelf with a single "in" and a single "out" port.
  • disk-name => string, optional

    • if port-designator is "disk_bay" and there is a disk installed in the bay, then this will be the disk name. Otherwise the field will be missing.
  • disk-uid => string, optional

    • if port-designator is "disk_bay" and there is a disk installed in the bay, then this will be UID of the disk. Otherwise the field will be missing.
  • port-state => string, optional

    • Current port state. Possible values are: "ok", "empty", "unkwn_lnk", "no_signal", "unused", "unkwn", "unknown", "dis_man", "dis_unusd", "dis_smp", "dis_loswd", "dis_dispa", "dis_invwd", "dis_reset", "dis_phchg", "dis_mir", "dis_crc", "dis_clk", "byp_init", "byp_gen", "byp_man", "byp_xmit", "byp_lipf8", "byp_dto", "byp_rlos", "byp_clos", "byp_tbi", "byp_rprt", "byp_stall", "byp_wrd", "byp_crc", "byp_lip", "byp_osc", "byp_clk", "byp_mir", "byp_lipf7", "byp_bzr", "byp_self", "byp_flt", "byp_pwr", "byp_pcycl", "warn_lip", "warn_wrdb", "warn_wrd", "warn_crc", "warn_clk", "term-err", "term", "autoterm".

shelf-environ-channel-address-map

A list of all the shelf assigned addresses assigned on this channel.

Fields

  • address-map => string

    • A comma separated list of addresses assigned on this channel by the shelf specified in shelf-no output above.
  • shelf-id => integer

    • Shelf number for presented address map.

shelf-environ-channel-info

Shelf environment information.

Fields

  • channel-name => string

    • Storage controller channel the shelf is connected to.

shelf-environ-shelf-info

Shelf environment information.

Fields

  • attached-shelf-bay-list => string

    • A list of bays numbers in this shelf that have disk devices installed. All bays with disks installed will be listed. This is a comma separated list from high to low. Example: "13, 11, 10, 4, 3, 2, 1".
  • connector-information => connector-info[], optional

    • Cable and connector information if available and supported by the hardware. Will not be present if the feature is not supported in the hardware.
  • power-control-failure-state => string, optional

    • Extension to the power-control-status to provide more information in case of shelf failures. Possible values: "dual_esh4_modules_not_present", "power_control_fault_detected", "incompatible_power_control_implementation", "power_control_function_not_available", "backplane_cpld_fault_detected".
  • power-control-status => string, optional

    • Power control element status. This is generalization of the ESH4 shelf power status. Currently available on ESH 4 shelves only. Possible values: "ok", "not_supported", "critical", "non_critical", "unknown".
  • shelf-id => integer

    • Shelf number.
  • shelf-status => string

    • Current shelf status. Possible values: "unrecoverable", "critical", "non_critical", "informational", "normal".
  • shelf-type => string

    • Shelf type. Possible values: "edm", "vem", "esp", "lrc", "lrc2", "esh", "esh2", "esh4", "eshfx", "emu", "efh", "eshtx", "sas", "esas", "sas_fc", "iom3", "at_fcx", "at_fcx2", "iom6", "iom6e".

shelf-info

Describes a shelf.

Fields

  • channel-name => string

    • The channel/port-number the shelf (hub) is attached to. If it is the partner node that is being reported, the value will be shown as "PARTNER". Examples: "0c" or "PARTNER".
  • firmware-rev-A => string, optional

    • Shelf Module A firmware revision. When the channel-name field is "PARTNER" this field will not be present.
  • firmware-rev-B => string, optional

    • Shelf Module B firmware revision. When the channel-name field is "PARTNER" this field will not be present.
  • module => string

    • The shelf module attachment. Possible values are: "a", "b".
  • module-state => string, optional

    • Current state of the IO module attached to the shelf port (if any). Possible values are: "no_status", "ok", "missing", "transport error", "critical", "unreachable", "unknown".
  • phy-expander-list => phy-expander-info[], optional

    • Each instance of phy-expander-list contains PHY (physical layer) expander information about each port. This applies to direct attached shelves with SAS modules only.
  • port-hub-list => port-hub-info[], optional

    • Each instance of port-hub-list contains hub information about each port. This applies to shelves with ESH modules only.
  • shelf-bay-info => shelf-bay-info, optional

    • Detailed information on populated shelf bays. When the channel-name field is "PARTNER" this field will not be present.
  • shelf-id => integer

    • The shelf id switch setting. This is the shelf id switch that is used to uniquely identify the shelf on the filer node.
  • shelf-name => string

    • Shelf name that the hub is attached to. This can also be considered as hub name. Example: 0c.shelf1.
  • shelf-state => string

    • Current state of the shelf. Possible values are: "no status", "init required", "online", "missing", "unknown".
  • shelf-type => string

    • Shelf module type. Some examples are: "esh2", and "at-fcx".
  • shelf-uid => string

    • Similar to serial number, this is the shelf unique identifier that distinguishes it from any other shelf manufactured. Example: 50:05:0c:c0:02:10:64:26.

temp-sensor-info

information on the temperature sensors installed in the shelf.

Fields

  • temp-sensor-current-condition => string, optional

    • Current temperature condition for this sensor. One of: "under_temperature_warning", "under_temperature_failure", "over_temperature_warning", "over_temperature_failure", "normal_temperature_range".

voltage-sensor-info

Presents the voltage sensor information, if implemented on the system.

Fields

  • is-sensor-error => boolean, optional

    • Indicates whether the sensor has encountered an error.
  • is-sensor-not-installed => boolean, optional

    • Indicates the voltage sensor elements is not installed. This will only be present if the element is missing, in such case no further data for this element will be presented.
  • sensor-condition => string, optional

    • A Text string describing whether the sensor-reading field is within normal operating range. This field is present only if sensor-reading field is also present. Possible values are: "overvoltage_failure", "overvoltage_warning", "undervoltage_warning", "undervoltage_failure", "normal_operating_range".
  • sensor-reading => string, optional

    • Voltage reading of the sensor. This field will be not be present if unable to read the sensor value properly.

xyratex-specific-info

Vendor specific enclosure system information for Xyratex shelf.

Fields

dense-status

null

Fields

  • blocks-skipped-sharing => integer, optional

    • Number of blocks not considered for sharing because contiguous duplicate blocks were less than the value set for minimum-blocks-shared. Returned only if verbose option is set. This parameter is not supported on Infinite Volumes.
  • checkpoint-op-type => string, optional

    • Checkpoint Operation Type. Possible values:
    • "-",
    • "Scan",
    • "Start",
    • "Check",
    • "Undo",
    • "Downgrade"
    Returned only if verbose option is set. This field is deprecated in Data ONTAP 8.1 and later. This parameter is not supported on Infinite Volumes.
  • checkpoint-progress => string, optional

    • Checkpoint Stage Progress with information as to which stage of sis is checkpointed and how much data is processed for that stage. For example: 25 MB Scanned, 20 MB Searched, 40 MB (20%) Done, 30 MB Verified. Returned only if verbose option is set. This field is deprecated in Data ONTAP 8.1 and later. This parameter is not supported on Infinite Volumes.
  • checkpoint-stage => string, optional

    • Checkpoint Stage information. Possible values:
    • "-",
    • "Gathering",
    • "Sorting",
    • "Saving_pass1",
    • "Saving_pass2",
    • "Checking",
    • "Checking_pass1",
    • "Checking_pass2",
    • "Compress_preproc",
    • "Compressing",
    • "Saving_sharing",
    • "Saving_end",
    • "Unknown_stage"
    Returned only if verbose option is set. This field is deprecated in Data ONTAP 8.1 and later. This parameter is not supported on Infinite Volumes.
  • checkpoint-sub-stage => string, optional

    • Checkpoint Sub Stage information. Possible values:
    • "-",
    • "Sort_pass1",
    • "Sort_p1merge",
    • "Sort_pass2",
    • "Bucket_sort_init",
    • "Bucket_sort",
    • "Bucket_sort_done"
    Returned only if verbose option is set. This field is deprecated in Data ONTAP 8.1 and later. This parameter is not supported on Infinite Volumes.
  • checkpoint-time => integer, optional

    • Checkpoint creation timestamp. The value is in seconds since January 1, 1970. Returned only if verbose option is set. This field is deprecated in Data ONTAP 8.1 and later. This parameter is not supported on Infinite Volumes.
  • is-idd-enabled => boolean, optional

    • Indicates incompressible data detection is enabled. Possible values:
    • "true",
    • "false"
    Once this set to 'true', inline compression will do a 4k compression quick check for large files before proceeding with full CG compression. If quick check finds a 4k within a CG as incompressible, inline compression won't attempt to compress the CG. Also indicates file level incompressible data detection is enabled for small files. Once this is enabled, when inline compression encounters a incompressible CG within a small file, it will mark the file with do not compress flag. As long as this flag is set on a small file, inline compression won't attempt to compress the file. This parameter is not supported on Infinite Volumes.
  • last-operation-error => string, optional

    • A human readable error message of the last sis operation. Present when there was an error. Returned only if verbose option is set. and when there is a valid error. This parameter is not supported on Infinite Volumes.
  • last-operation-size => string, optional

    • The size of the last sis operation in human readable format. This output element is deprecated in Data ONTAP 8.1. Please use the last-operation-size-bytes output element instead. Returned only if verbose option is set. This parameter is not supported on Infinite Volumes.
  • last-operation-state => string, optional

    • Completion status for the last operation. Possible values:
    • "success",
    • "failure"
    Returned only if verbose option is set and when there is last completed operation. This parameter is not supported on Infinite Volumes.
  • last-success-operation-begin-timestamp => integer, optional

    • Start timestamp of the last successful sis operation. The value is in seconds since January 1, 1970. Returned only if verbose option is set and when there is last successfully completed operation. This parameter is not supported on Infinite Volumes.
  • last-success-operation-end-timestamp => integer, optional

    • End timestamp of the last successful sis operation. The value is in seconds since January 1, 1970. Returned only if verbose option is set and when there is last successfully completed operation. This parameter is not supported on Infinite Volumes.
  • logical-data => sis-logical-data, optional

    • This contains logical size attributes of a volume. Returned only if verbose option is set. This parameter is not supported on Infinite Volumes.
  • minimum-blocks-shared => integer, optional

    • The minimum number of contiguous blocks in a file that will be considered for block sharing. If the number of contiguous duplicate blocks is less than this number, then they won't be considered for sharing. Returned only if verbose option is set.
  • path => string

    • Volume for which sis information is returned.
  • progress => string

    • The progress of the current sis operation with information as to which stage is currently in progress and how much data is processed for that stage. For example: 25 MB Scanned, 20 MB Searched, 40 MB (20%) Done, 30 MB Verified. This parameter is not supported on Infinite Volumes.
  • queued-job-type => string, optional

    • Type of sis operation that is queued for the volume. Possible values:
    • "-" - No sis operation is queued for the volume,
    • "Scan",
    • "Start",
    • "Check",
    • "Downgrade"
    Returned only if verbose option is set. This parameter is not supported on Infinite Volumes.
  • quick-check-fsize => integer, optional

    • Quick check file size for Incompressible Data Detection. If Incompressible data detection is enabled and if the file size is >= quick-check-fsize, inline compression will do a 4k quick check before doing full CG compression. This parameter is not supported on Infinite Volumes.
  • schedule => string, optional

    • The schedule for sis operation on the volume. See sis-set-config for the format of the schedule. Returned only if verbose option is set.
  • state => string

    • Possible values:
    • "Enabled",
    • "Disabled"
  • status => string

    • Possible values:
    • "Idle" - No sis operations are happening on this volume,
    • "Initializing" - sis operation is being initialized,
    • "Active" - sis operation is active on the volume,
    • "Undoing" - sis is being undone on the volume,
    • "Pending" - sis operations are scheduled for the volume,
    • "Downgrading" - The sis operation necessary to downgrade the volume is active,
    • "Disabled" - sis operation is disabled on the volume.
    This parameter is not supported on Infinite Volumes.
  • type => string, optional

    • Possible values:
    • "Regular",
    • "SnapVault"
    Any sis volume with Snapvault qtree in it would be marked as Snapvault and all others would be returned as type Regular. Returned only if verbose option is set.

sis-logical-data

This contains logical size attributes of a volume.

Fields

  • logical-data-size => integer

    • The size of logical data in the volume in bytes. This is calculated as [size-saved + size-used + compressed-data bytes]. This parameter is not supported on Infinite Volumes.

compliance-clock-info

Compliance Clock

Fields

file-retention-info

retention information for each file

Fields

  • formatted-retention-time => string, optional

    • expiry date of the worm file formatted in a human-readable format. This takes care of wrap-around dates and prints the expiry date of the file in the the format :: A value of "INFINITE" indicates that this file has infinite retention-time. This field is not included in non-worm files (when snaplock-type is NONE).
  • is-wraparound => boolean, optional

    • True if the date represented in retention-time is a wrap-around date. This field is not included in case the file is not a worm file or if it has infinite retention.
  • pathname => string

    • pathname of the file. This will always have the same format and values as the input pathname-info array.
  • retention-time => integer, optional

    • retention time in seconds in the standard UNIX format (since 01/01/1970 00:00:00). SnapLock wraps around the retention time to indicate dates after 01/19/2038. It remaps 01/01/1970 - 12/31/2002 to 01/19/2038 - 01/19/2071 This field is not included in case the file is not a worm file or if the file has infinite retention. The flag is-wraparound indicates if this date is in the normal format or is wrapped around. The field formatted-retention-time represents the date as understood by SnapLock for retention of the file. Range: [0..2^64-1]
  • snaplock-error => snaplock-error, optional

    • This value is only present if there is an error for a specific pathname entry. Error numbers returned EFILENOTFOUND, EINVALIDINPUTERROR, EVOLUMEOFFLINE, EVOLUMEDOESNOTEXIST, EVOLUMEQUIESCED, EINTERNALERROR
  • snaplock-type => string, optional

    • type of snaplock license applicable for this file Possible values "SLC" - indicates it is a worm file with snaplock compliance restrictions applying to it. "SLE" - indicates it is a worm file with snaplock enterprise restrictions applying to it. "NONE" - Not a worm file

log-file-info

Status information for each active WORM log file

Fields

  • formatted-retention-date => string, optional

    • Expiry date of the active WORM log file. This takes care of wraparound dates and prints the expiry date of the file in the format :: . The value of "INFINITE" indicates that the file has infinite retention and will never expire.
  • log-basename => string

    • The basename for the active WORM log file. If the caller of the ZAPI passed in the optional parameter log-basename, this should have the same value
  • snaplock-error => snaplock-error, optional

    • This value is only present if there is an error for a specific pathname entry. Error numbers returned EFILENOTFOUND, EINVALIDINPUTERROR, EVOLUMEOFFLINE, EVOLUMEDOESNOTEXIST, EVOLUMEQUIESCED, EINTERNALERROR

snaplock-error

Information about a single quota error.

Fields

  • errno => integer

    • The error number Range: [0..2^64-1]
  • reason => string

    • A human-readable concise reason for the error.

address-pair

Source and destination address pair.

Fields

destination-info

Source location, destination location, and source snapshot of a snapmirrored pair.

Fields

  • destination-location => string

    • Destination location of the snapmirrored pair. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree> or the clone form: <filer>:<volume>->[clone:<clone_name>].
  • source-location => string

    • The source location of the snapmirrored pair. The source location is of the volume form: <filer>:<volume>, or it is of the qtree form: <filer>:/vol/<volume>/<qtree>. In versions of ONTAP earlier than 7.0, there was a bug which omitted the filer name, so the volume form is: <volume>, and the qtree form is: /vol/<volume>/<qtree>.

snapmirror-connection-info

Information about one connection.

Fields

  • address-pair1 => address-pair

    • The first source and destination address pair.
  • address-pair2 => address-pair, optional

    • The second source and destination address pair.
  • mode => string

    • Connection mode. Possible values are: "multi" and "failover".
  • name => string

    • Name of the connection. The name is in ASCII and must begin with an alpha character.

snapmirror-error

Information about a single snapmirror schedule error.

Fields

  • errno => integer

    • The error number.
  • reason => string

    • A human-readable concise reason for the error.

snapmirror-schedule-info

Contains the SnapMirror schedule per destination. If the schedule contains an error, only destination-location and snapmirror-error will be present.

Fields

  • days-of-month => string, optional

    • Days in the month for which the schedule is set. The form is crontab-like, with possible values of:
    • - := match nothing;
    • 1 := match day 1;
    • 1,3 := match day 1 and 3;
    • 2-5 := match day 2,3,4,5;
    • 1-30/7 := match day 1,8,15,22,29;
    • * := matches all possible legal values;
    If there is an error, days-of-month will not be present and snapmirror-error will be present.
  • days-of-week => string, optional

    • Days in the week for which the schedule is set. 0 represents Sunday, and 6 represents Saturday. The form is crontab-like, with possible values of:
    • - := match nothing.
    • 1 := match day 1 (Mon);
    • 1,3 := match day 1 and 3 (Mon and Wed);
    • 2-5 := match day 2,3,4,5 (Tue,Wed,Thu,Fri);
    • * := matches all possible legal values;
    If there is an error, days-of-week will not be present and snapmirror-error will be present.
  • destination-location => string

    • The destination location of the schedule. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.
  • hours => string, optional

    • Hours in the day for which the schedule is set. The form is crontab-like, with possible values of:
    • - := match nothing;
    • 1 := match hour 1;
    • 1,3 := match hour 1 and 3;
    • 2-5 := match hour 2,3,4,5;
    • 1-24/3 := match hour 1,4,7,10,13,16,19,22;
    • * := matches all possible legal values;
    If there is an error, hours will not be present and snapmirror-error will be present.
  • is-compressed => boolean, optional

    • If true SnapMirror will compress/decompress the data that is transferred between the source and destination storage system. If false, transferred data will not be compressed. The default is false.
  • max-transfer-rate => integer, optional

    • Maximum transfer rate in kilobytes per second. If not present, then the transfer rate is as fast as the filer can transfer.
  • minutes => string, optional

    • Minutes in the hour for which the schedule is set. The form is crontab-like, with possible values of:
    • - := match nothing;
    • 1 := match minute 1;
    • 1,3 := match minute 1 and 3;
    • 2-5 := match minute 2,3,4,5;
    • 1-12/3 := match minute 1,4,7,10;
    • 0-55/5 := match minute 0,5,10,15,20,25,30,35,40, 45,50,55;
    • * := matches all possible legal values;
    If there is an error, minutes will not be present and snapmirror-error will be present.
  • snapmirror-error => snapmirror-error, optional

    • Present if there is an error for a snapmirror schedule.
  • source-location => string, optional

    • The source location of the schedule. The source location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>. If there is an error, source-location will not be present and snapmirror-error will be present.
  • tcp-window-size => integer, optional

    • TCP window size in bytes. If not present, then the TCP window size is set to an internally determined default value.

snapmirror-status-info

The SnapMirror pair status.

Fields

  • contents => string

    • State of the active file system of snapmirror destinations. Possible values are: "replica", "transitioning", and "original".
  • current-transfer-type => string, optional

    • Type of the current SnapMirror transfer. Possible values are: initialize, store, schedule, retry, retrieve, resync, and migrate. Only present when there is a transfer.
  • destination-location => string

    • The destination location of the SnapMirror pair. The form is <filer>:<volume> or <filer>:/vol/<volume>/<qtree>.
  • last-transfer-type => string, optional

    • Last SnapMirror transfer type. Possible values are: "initialize", "store", "schedule", "retry", "retrieve", "resync", and "migrate". Only present when there was a last transfer.
  • source-location => string

    • The source location of the SnapMirror pair. The form is <filer>:<volume> or <filer>:/vol/<volume>/<qtree>.
  • state => string

    • SnapMirror pair state. Possible values are: "uninitialized", "snapmirrored", "broken-off", "quiesced", "source", and "unknown".
  • status => string

    • SnapMirror pair transfer status. Possible values are: "Idle, "Transferring", "Pending", "Aborting", "Migrating", "Quiescing", "Resyncing", "Waiting", "Syncing", "In-sync" and "Paused". In case the previous transfer was failed/aborted and had a restart checkpoint set, the status could be "Idle with restart checkpoint" or "Pending with restart checkpoint". In addition the status could be "Checking", "Fixing" and "Transferring, Checking" when "snapmirror check" command is being run on the destination volume.

snapmirror-sync-schedule-info

Contains the synchronous SnapMirror schedule per destination. If the schedule contains an error, only destination-location and snapmirror-error will be present.

Fields

  • destination-location => string

    • The destination location of the schedule. The destination location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>.
  • is-compressed => boolean, optional

    • If true SnapMirror will compress/decompress the data that is transferred between the source and destination storage system. If false, transferred data will not be compressed. The default is false.
  • max-transfer-rate => integer, optional

    • Maximum transfer rate in kilobytes per second. If not present, then the transfer rate is as fast as the filer can transfer.
  • ops-throttle => string, optional

    • The number of outstanding operations allowed before blocking on the source. The format is a number followed by the one of the following units: "ops", "s", or "ms". If the specified value is less than 10s, the mirror is configured to run in a fully synchronous mode. If the specified value is greater than or equal to 10s, the mirror is configured to run in semi-synchronous mode.
  • snapmirror-error => snapmirror-error, optional

    • Present if there is an error for a snapmirror schedule.
  • source-location => string, optional

    • The source location of the schedule. The source location is of the volume form: <filer>:<volume> or the qtree form: <filer>:/vol/<volume>/<qtree>. If there is an error, source-location will not be present and snapmirror-error will be present.
  • sync-mode => string

    • This specifies whether the mirror is configured in sync or in semi-sync mode. Possible values are: "full_sync" and "semi_sync". "full_sync" means that the mirror is configured to run in a fully synchronous mode. "semi_sync" means that the mirror is configured to run in a semi synchronous mode.
  • tcp-window-size => integer, optional

    • TCP window size in bytes. If not present, then the TCP window size is set to an internally determined default value.

snapshot-autodelete-info

Option name and value.

Fields

  • option-name => string

    • Option key. Possible values: "state" (value: "on" | "off") "commitment" (value: "try" | "disrupt") "trigger" (value: "volume" | "snap_reserve" | "space_reserve") "target_free_space" (value: < number >) "delete_order" (value: newest_first | oldest_first) "defer_delete" (value: scheduled | user_created | prefix | none) "destroy_list" (value: < user-defined >) "prefix" (value: < string >)
  • option-value => string

    • Option value.

snapshot-info

One snapshot contained in the specified volume. This type is used by snapshot-get-iter, snapshot-modify-iter and snapshot-list-info ZAPIs. When using this type to modify snapshot information, every field except snapmirror-label is non-modifiable.

Fields

  • access-time => integer, optional

    • The volume access time when the snapshot was created in seconds since Jan 1, 1970. This value will not change even if the snapshot is accessed.
  • dependency => string, optional

    • Application(s) dependent on this snapshot. Possible values include "snapmirror", "snapvault", "dump", "vclone", "LUNs", "snaplock". Comma separated if more than one application depends on this snapshot.
  • is-7-mode-snapshot => boolean, optional

    • True if the snapshot is a 7-mode snapshot.
  • name => string, optional

    • Name of the snapshot to be listed.
  • snapmirror-label => string, optional

    • A human readable SnapMirror Label attached with the snapshot. Size of the label can be at most 31 characters. This label will be used by the vaulting system to identify a vaulting scheme.
  • snapshot-instance-uuid => uuid, optional

    • The 128 bit unique snapshot identifier expressed in the form of UUID. This field uniquely identifies the snapshot's physical data layout.
  • state => string, optional

    • The state of the snapshot. Possible values:
    • 'valid' ... The snapshot is complete and consistent
    • 'invalid' ... The namespace constituent snapshot is missing
    • 'partial' ... One or more data constituent snapshots are missing
    Only a snapshot on an Infinite Volume can have a state of partial or invalid.

    The default value is valid.

snapshot-name

Name of a snapshot.

Fields

  • None

snapshot-owner

owner of a busy snapshot

Fields

snapshot-reserve-detail-info

Information about a volume's snapshot space reservation configuration.

Fields

  • percentage => integer

    • Percentage of volume reserved for snapshots. Range : [0 - 100].
  • size => integer

    • Size in bytes of volume reserved for snapshots. Range : [0 - 2^64-1].
  • volume => string

    • Name of volume.

volume-error

The error code of a given volume.

Fields

  • errno => integer, optional

    • The error code of the snapshot operation for a given volume. It is returned only when an error is found.
  • reason => string, optional

    • Description of the error. It is returned only when an error is found.

volume-is-snapcreated

The status of the snapshot creation for a given volume.

Fields

  • name => volume-name

    • Name of a volume.

snapvault-chained-destination-info

Structure of each entry of destinations-chain.

Fields

  • destination-path => string

    • Destination path.

snapvault-configuration-info

Describes the elements of the snapvault configuration entry.

Fields

  • connection-mode => string, optional

    • This option specifies the mode to be used for establising connection between primary and secondary. If this option is set to "inet6", connections between primary and secondary will be established using IPv6 addresses only. If there are no IPv6 addressess configured, then the connection will fail. If the option is set to "inet", connections between primary and secondary will be established using IPv4 addresses only. If there are no IPv4 addresses configured, then the connection will fail. When this option is not specified, Connection will be tried using both "inet6" and "inet". "inet6" will have higher precedence than "inet". If connection request using "inet6" fails, SnapMirror will retry the connection using "inet". This argument is not effective when an IP address is specified instead of primary hostname. If the IP address format and connection mode do not match, the operation will fail with proper error message.
  • is-access-time-change-ignored => boolean, optional

    • Sets the ignore_atime option in snapvault configuration entry. When set to 'true', snapvault primary does not send files with only access time changes during incremental transfers. The default value is 'false'
  • is-open-file-backup-allowed => boolean, optional

    • Sets the back_up_open_files option in the snapvault configuration entry. This option is used to allow or disallow the inclusion of open files on the primary system at the time of the transfer. This option is currently applicable only for OSSV relationships. When set to 'false' the OSSV primary agents will exclude files that are open from the transfer. The default value for this parameter is 'true'.
  • is-primary-path-utf8-encoded => boolean, optional

    • Specifies encoding format for the primary pathname. A 'true' value indicates that the primary pathname is in UTF8 format. The default encoding format is ASCII/extended ASCII. The default value is 'false'.
  • max-transfer-rate => integer, optional

    • The maximum transfer rate in kilobytes (1024 bytes) per second that will be used for this relationship as well as baseline transfer. The default value for this parameter will allow transfers to proceed as fast as possible. Range:[1..2^31-2]
  • primary-path => string

    • The primary path that will be used as the source for this relationship as well as for baseline transfer. This can be either in UTF8 or ASCII/extended ASCII depending on whether or not 'is-primary-path-utf8-encoded' flag is set. If option 'is-primary-path-utf8-encoded' is not specified, then the primary-path considered as in ASCII/extended ASCII.
  • primary-system => string

    • The primary system for this relationship as well as for the baseline transfer. This input will be used by the secondary system to establish contact with the primary. Therefore this input is expected to be a hostname that the primary can resolve.
  • secondary-path => string

    • The secondary path that will be used as destination for this relationship as well as baseline transfer. The secondary path will be created during the baseline transfer and hence it must not exist when issuing this request.
  • tries-count => integer, optional

    • The maximum number of times a transfer will be tried. Transfers that are retried using this mechanism may be capable of restarting from where the previous attempt failed. If a transfer does not succeed even after those many attempts, then the secondary will give up. All the data that was transferred during previous tries for this transfer will be discarded. The default value for this parameter is 2. When set to 0, the relationship will become dormant. In other words no transfers will be allowed to this secondary path. The maximum value accepted for this input is 120. Range:[0..120]
  • use-compression => string, optional

    • Specifies whether to compress the network data stream. Possible values are 'on', 'off', and 'default'. When the value is set to 'on', stream compression will be enabled. When the value is set to 'off', stream compression will be disabled. When the value is set to 'default' then the default value will be used. In case of snapvault create relationship API, when this option is not specified, the default value will be used. In case of snapvault modify API, when this option is not specified, the last configured value for this relationship will be used. The default value for this option is the value of global compression option.

snapvault-destination-info

Structure of each entry of destinations list.

Fields

  • chained-destinations => snapvault-chained-destination-info[]

    • List of destinations that form a dependency chain starting from the source-path. This list will contain only one element for non-cascaded configurations. The last element of this list represents the destination for which the snapshot returned in source-snapshot has been preserved on the source system.
  • source-path => string

    • The source path for this destination.
  • source-snapshot => string

    • The source snapshot that has been preserved on the source system for the destination.

snapvault-primary-snapshot-schedule-info

Structure of each snapshot schedule.

Fields

  • is-auto-update => boolean, optional

    • Schedules that have is-auto-update set to 'true' will initiate update transfers for all relationships in that volume before creating a new snapshot. Default value is 'false'. This setting is honoured only for the secondary schedules. It is ignored for the SnapVault primary schedules.
  • preserve-snapshots => string, optional

    • Allowed values are on/off/default. It prevents SnapVault from auto-deleting older snapshots from this SnapVault snapshot schedule to create new snapshots when set to on. When unspecified, value is set to default. When set to default, the behaviour of preserving snapshots is guided by the global snapvault.preservesnap option. This setting is honoured only for the secondary schedules. It is ignored for the SnapVault primary schedules.
  • retention-count => integer

    • Denotes the maximum number of most recent snapshots that will be retained by this schedule. Range:[0..254]
  • schedule-name => string

    • Uniquely identifies this schedule within a primary volume. The schedule-name will be used as a prefix in the name of each snapshot created by this schedule.
  • volume-name => string

    • The primary volume for which this schedule has been configured.
  • warn-at-count => integer, optional

    • On SnapVault secondary, when preserve-snapshots is set, SnapVault sends a warning message when the number of remaining snapshots for this backup schedule is less than this input. Setting this to zero turns off the same warning. Default value is 0. This setting is honoured only for the secondary schedules. It is ignored for the SnapVault primary schedules. Range:[0..retention-count - 1]

snapvault-schedule-info

Representation of the scheduling information.

Fields

  • days-of-week => string, optional

    • Days of the week for which this schedule has been set. This is a comma separated list of days, where a day is specified by the first three letters of the day. Day ranges are also allowed. Here are the possible formats:
    • - := matches no day of the week
    • mon := matches Monday
    • tue,thu := matches Tuesday and Thursday
    • mon-fri := matches mon,tue,wed,thu,fri
    Default value is mon-sun, i.e. every day.
  • hours-of-day => string, optional

    • Hours of the day for which this schedule has been set. This is a comma separated list of the hours during the day where hours are specified as integers from 0 to 23. Hour ranges are also allowed. Step values are allowed in conjunction with ranges. Here are the possible formats:
    • 4 := matches 4 am.
    • 0,13 := matches midnight and 1pm.
    • 0-23 := matches all hours
    • 0-8/2 := matches 'every 2 hours' starting from midnight until 8am.
    Default value is 0, i.e. midnight.

snapvault-schedule-options

Describes snapvault schedule options.

Fields

  • retention-period => string, optional

    • This option is used to specify a retention period for snapshots, which are created by this schedule, for SnapLock volumes. The retention period is specified as a count followed by a suffix. the valid suffixes are d - for days m - for months y - for years For example a value of 6m represents a retention period of 6 months. THe maximum valid retention period is 30 years, or the maximum retention period set for the volume, whichever is shorter. The minimum valid retention period is 0 days, ir the minimum retention period set for the volume, whichever is longer. If the option value is default or the retention-period option is not specified, the snapshots will be created with retention period equal to the default retention period of the secondary SnapLock volume, or 30 years, whichever is shorter.
  • tries-count => integer, optional

    • Number of times SnapVault should try creating each scheduled snapshot before giving up. If the snapshot creation fails due to transient errors such as the volume being out of space, SnapVault will keep trying to create the snapshot every minute untill the request is fulfilled. The allowed range is from 0 to 120. The default value is unlimited. If tries-count is not use, then the value will remain unchanged and the already configured value will be used. The default value for this option is -1. Range:[-1..120]

snapvault-secondary-snapshot-schedule-info

Snapshot schedules for each volume.

Fields

  • is-auto-update => boolean

    • Schedules that have is-auto-update set to 'true' will initiate update transfers for all relationships in that volume before creating a new snapshot.
  • preserve-snapshots => string, optional

    • Allowed values are on/off/default. It prevents SnapVault from auto-deleting older snapshots from this SnapVault snapshot schedule to create new snapshots when set to on. When unspecified, value is set to default. When set to default, the behaviour of preserving snapshots is guided by the global snapvault.preservesnap option. This setting is honoured only for the secondary schedules. It is ignored for the SnapVault primary schedules.
  • retention-count => integer

    • Denotes the maximum number of most recent snapshots that will be retained by this schedule. Range:[0..254]
  • schedule-name => string

    • Uniquely identifies the schedule within a secondary volume. The schedule-name is used as a prefix in the name of each snapshot created by this schedule.
  • volume-name => string

    • The secondary volume for which these schedules have been configured.
  • warn-at-count => integer, optional

    • On SnapVault secondary, when preserve-snapshots is set, SnapVault sends a warning message when the number of remaining snapshots for this backup schedule is less than this input. Setting this to zero turns off the same warning. Default value is 0. Range:[0..retention-count - 1]

snapvault-snapcreate-options

Snap create options.

Fields

snapvault-snapshot-schedule-status-info

Structure of the snapshot schedule status entry.

Fields

  • schedule-name => string

    • Uniquely identifies schedule within a volume.
  • status => string

    • Status of this schedule. Possible values are: "Idle", "Active", "Aborting", "Queued", "Saving".
  • volume-name => string

    • Volume for which this schedule is configured.

snapvault-softlock-info

Structure of the snapvault softlock.

Fields

  • softlock-name => string

    • Name of the softlock. This field will be empty if softlock-name is not specified while adding softlock.
  • type => string

    • Type of snapvault softlock. This indicates whether the softlock added using zapi or command line interface. Possible types are "cli", "api"

snapvault-status-info

Format of each status entry.

Fields

  • base-snapshot => string, optional

    • Snapshot the relationship is currently based upon.
  • compressed-bytes => integer, optional

    • Number of compressed bytes transferred if QSM compression is being used. This field is absent if the transfer is not compressed. Range:[0..2^64-1]
  • contents => string, optional

    • State of the active file system of the snapvault path on this system. Possible values are: "replica", "transitioning" and "original". This field is present only on the destination.
  • current-transfer-error => string, optional

    • A human readable error string for the current transfer.
  • current-transfer-type => string, optional

    • Type of the current transfer. Possible values are: "initialize", "update", "retry", "resync". Only available for active transfers.
  • destination-path => string

    • Destination path.
  • inodes-replicated => integer, optional

    • Shows the number of inodes replicated. Present during directory processing phase.
  • lag-time => integer, optional

    • Amount of time in seconds since the beginning of the most recently successful transfer from source. This field is present only when there has been a successful baseline transfer. Range:[1..2^32-1]
  • last-transfer-type => string, optional

    • Last transfer type. Possible values are: "initialize", "update", "retry", "resync".
  • mirror-timestamp => integer, optional

    • Creation time of the snapshot used for the most recent successful transfer. Specified in seconds since Jan 1, 1970. This field is present only when there has been a successful baseline transfer. Range:[1..2^32-1]
  • replication-ops => integer, optional

    • Counter that is incremented for every replication operation. Present during directory processing phase.
  • source-path => string

    • Source path.
  • state => string

    • State of this relationship. Possible values are: "uninitialized","snapvaulted","broken-off","unknown", "source","restoring","quiesced".
  • status => string

    • Transfer status for this relationship. Possible values are: "idle", "transferring", "pending", "aborting", "quiescing", "resyncing", "restoring".
  • transfer-progress => integer, optional

    • Number of kilobytes (1024 bytes) transferred so far. This field is valid only for active transfers. If there is no active transfer in progress, this field is absent. Range:[0..2^32-1]

community-info

Information about a single community.

Fields

  • access-control => string

    • Access control of the community. Possible values are "ro" (read-only), and "rw" (read-write).
  • community => string

    • Community name.

trap-info

Information about a single user defined trap.

Fields

  • OID => string, optional

    • Specifies the OID of the MIB object that is queried to determine the trap's value. This attribute is set to "undefined" on output if not explicitly specified in trap definition. If absent on input, there is no default value, and trap definition is incomplete.
  • active => string, optional

    • Notification state of trap. Possible values are "on" indicating agent will deliver notification if triggered, "off" indicating trap is inactive, and "incomplete" indicating one or more of the required attributes have not been defined. The default value for a fully defined trap is "off".
  • backoff-calculator => string, optional

    • Specifies a method by which the frequency of trap evaluation may be modified. Possible values are "step-backoff", "exponential-backoff", and "no-backoff" This attribute may be absent on output if not explicitly specified in trap definition. If absent on input, the default is "no-backoff".
  • backoff-multiplier => integer, optional

    • Factor by which interval is multiplied when exponential-backoff method used. Used with "exponential-backoff" calculator. This attribute may be absent on output if not explicitly specified in trap definition. If absent on input, the default is 1. Range may be [0..2^31-1].
  • backoff-step => integer, optional

    • Time in seconds by which evaluation interval is increased when step-backoff method used. Used with "step-backoff" calculator. This attribute may be absent on output if not explicitly specified in trap definition. If absent on input, the default is 0. Range may be [0..2^31-1].
  • edge-1 => integer, optional

    • Threshold value at which trap is triggered. If not specified on input, the default value is 2^31-1. Range may be [-2^31..2^31-1].
  • edge-1-direction => string, optional

    • Sets the direction of travel across the edge-1 threshold beyond which the trap is triggered. Possible values are "up", and "down". If not specified on input, the default value is "up".
  • edge-2 => integer, optional

    • Threshold value at which trap is triggered. Used with double-edge-trigger condition. This attribute may be absent on output if not explicitly specified in trap definition. If absent on input, the default is 0. Range may be [-2^31..2^31-1].
  • edge-2-direction => string, optional

    • Sets the direction of travel across the edge-2 threshold beyond which the trap is triggered. Possible values are "up", and "down". Used with double-edge-trigger condition. This attribute may be absent on output if not explicitly specified in trap definition. If absent on input, the default is "down".
  • interval => integer, optional

    • Time in seconds between evaluations of the trap. A trap can send data only as often as it is evaluated. If not specified on input, the default value is 3600 seconds (1-hour). Range may be [0..31536000].
  • interval-offset => integer, optional

    • Time in seconds until the first trap evaluation. This attribute may be absent on output if not explicitly specified in trap definition. If absent on input, the default is 0. Range may be [0..31536000].
  • message => string, optional

    • Message associated with trap. May be either a literal string, or specifies an OID. This attribute is set to "undefined" on output if not explicitly specified in trap definition. If absent on input, there is no default value, and trap definition is incomplete.
  • priority => string, optional

    • Priority level of trap. Possible values (in descending order of severity) are "emergency", "alert", "critical", "error", "warning", "notification", "informational", or "debug". This attribute may be absent on output if not explicitly specified in trap definition. If absent on input, the default is "notification".
  • rate-interval => integer, optional

    • Time in seconds over which rate of change is calculated from sample data. This attribute may be absent on output if not explicitly specified in trap definition. If absent on input, the default is 0. Range may be [0..2^31-1].
  • trap-name => string

    • Name of the trap given by the user. Note that trap-name may not contain embedded periods.
  • trigger => string, optional

    • Sets the condition under which the trap will send a notification. Possible values are "single-edge-trigger", "double-edge-trigger", or "level-trigger". This attribute is set to "undefined" on output if not explicitly specified in trap definition. If absent on input, there is no default value, and trap definition is incomplete.

traphost-info

Information about a single registered trap host.

Fields

  • host-name => string

    • Name of the trap host given by the user. Can be one of the following: hostname, ip-address, or alias Hostname will be a fully qualified Domain Name.
  • ip-address => string

    • IP address of the trap host.

npm-meta-elem-info

Single metadata element with metadata information

Fields

adapter-bar-info

display base address information

Fields

  • bar-type => string

    • Type of base address information. Possible values are: "I/O", and "memory mapped I/O".

adapter-detail-info

Detailed information for specific adapter. Display different info base on the type of adapter.

Fields

  • adapter-name => string

    • Adapter port name, which is adapter slot number and, if presented, the port letter designator together. Examples are 8a, 11b. Note that a physical adapter may contain multiple ports.
  • adapter-type => string

    • Type of adapter present in the system. Possible values: "ADT_IF_ATA", "ADT_IF_PARALLEL_SCSI", "ADT_IF_SAS", "ADT_IF_FC".

adapter-fc-info

Detailed information for fc adapter.

Fields

  • adapter-sfp-info => adapter-sfp-info, optional

    • If the port has a small form factor pluggable transceiver/connector (also known as sfp), then this is the vendor information on the sfp.
  • is-enabled => boolean

    • Is the adapter enabled? true or false.
  • is-in-use => boolean

    • Is the adapter inuse? true or false
  • preload-table-rev => string, optional

    • Preload table revision of adapter.

adapter-name-elem

A list of adapter-names that can be used in other storage-adapter interface calls.

Fields

  • adapter-name => string

    • The adapter name is the slot number and, if present, the port letter designate. Examples are 8a, 11b

adapter-parallel-scsi-info

Detailed information for parallel SCSI adapter.

Fields

  • adapter-model => string

    • Model of the adapter.
  • firmware-rev => string

    • Firmware revision of adapter.
  • hardware-rev => string

    • Hardware revision of adapter.
  • is-enabled => boolean

    • Is the adapter enabled?

adapter-sas-info

Detailed information for sas (Serial Attached SCSI) adapter.

Fields

  • adapter-model => string

    • Model of the adapter. This is the same as adapter-vendor followed with adapter-family. Example: "Qlogic 2432"
  • adapter-state => string

    • Current state of the adapter. Possible values: "up", "down", "offline_soft", "offline_hard", "offline_loopback".
  • firmware-rev => string

    • Firmware revision of adapter
  • hardware-rev => string

    • This is the hardware chip revision of adapter.
  • is-enabled => boolean

    • Is the adapter enabled?
  • is-in-use => boolean

    • Is adapter in use? true or false.
  • is-redundant => boolean

    • Is adapter dual-attached? true or false.
  • sas-qsfp-cable => sas-qsfp-cable-info, optional

    • QSFP information of the cable. QSFP is acronym for Quad Small Form-factor Pluggable.. Will be missing if data not available or not or cable not present supported.

adapter-sff-info

Information on small form factor transceiver/connector (also known as sff).

Fields

  • part-number => string

    • Vendor's part number for the sff. If data not available, value will be "not_available".
  • serial-number => string

    • Serial number for sff. If data not available, value will be "not_available".
  • speed-capabilities => string

    • Comma separated list of speed capabilities of the sff. Example: "1, 2 Gbit/Sec". If data not available, value will be "not_available".
  • vendor => string

    • sff vendor name. If data not available, value will be "not_available".

adapter-sfp-info

Information on small form factor pluggable transceiver/connector (also known as sfp).

Fields

  • part-number => string

    • Vendor's part number for the sfp. If data not available, value will be "not_available".
  • serial-number => string

    • Serial number for sfp. If data not available, value will be "not_available".
  • vendor => string

    • sfp vendor name If data not available, value will be "not_available".

expander-phy-state-info

Expander PHY state information.

Fields

  • expander-phy => integer

    • A PHY is a transceiver; it is the object in a device that electrically interfaces to a physical link.
  • expander-phy-attached-device-type => string

    • Device type attached to an adapter PHY. Possible values:
    • "initiator" - A device type that can initiate a SAS communication,
    • "expander" - A device type that facilitates communication between multiple SAS devices,
    • "sas_end_device" - A SAS device that is not contained within an expander device,
    • "sata_end_device" - A SATA end device,
    • "unknown" - An unknown device type.
  • expander-phy-state => string

    • Expander PHY state info. Possible values:
    • "sas_phy_state_enabled_rate_unknown" - PHY is enabled but data transfer rate is unknown,
    • "sas_phy_state_disabled" - PHY is disabled,
    • "sas_phy_state_speed_neg_failed" - Data tranfer rate negotiation failed,
    • "sas_phy_state_sata_oob_failed" - SATA OOB(Out Of Band) signaling failed,
    • "sas_phy_state_enabled_15gbs" - 1.5 Gb/s data transfer rate,
    • "sas_phy_state_enabled_30gbs" - 3.0 Gb/s data transfer rate,
    • "sas_phy_state_enabled_60gbs" - 6.0 Gb/s data transfer rate,
    • "unknown" - Unknown PHY state.

phy-state-info

Adapter PHY state information.

Fields

  • phy => integer

    • A PHY is a transceiver; it is the object in a device that electrically interfaces to a physical link.
  • phy-state => string

    • Adapter PHY state info. Possible values: "sas_phy_state_enabled_rate_unknown", "sas_phy_state_disabled", "sas_phy_state_speed_neg_failed", "sas_phy_state_SATA_OOB_failed", "sas_phy_state_enabled_15gbs", "sas_phy_state_enabled_30gbs", "sas_phy_state_enabled_60gbs", "unknown".

sas-adapter-expander-phy-state-info

Adapter PHY and list of connected expander PHYs.

Fields

sas-qsfp-cable-info

QSPF Cable information.

Fields

  • attached-serial-number => string, optional

    • Serial number of the attached cable as assigned by the cable manufacturer. This field will not be present if the information is not available, or if a cable is not connected at this connector. Note that depending on the cable, the serial number at the two ends of the cable may or may not match. An example of this is SAS optical cables that do not have integrated QSFP's, which will show different attached serial numbers at the ends of cable. Cables with integrated QSFP's will have matching serial numbers at both ends.
  • cable-end-identifier => string, optional

    • Each cable has two ends. This field shows which end of the cable is connected to the shelf. This field will not be present if the information is not available or accessible, or if a cable is not connected at this connector. Possible values: "end_0", "end_1".
  • cable-length => string, optional

    • Length of the cable. Will be missing if data not available or not present.
  • cable-manufacturer => string, optional

    • Manufacturer of the cable. Will be missing if data not available or not present.
  • cable-serial-number => string, optional

    • This is actually not serial number, but rather cable identifier. For backwards compatibility this is reported as cable-serial-number. For the actual serial number see attached-serial-number. The connectors at both ends of the same cable will report the same value for this field. This field can be used to generate topology. This field will not be present if a cable is not connected to the connector or if the cable is not connected to a functioning device.
  • cable-technology => string, optional

    • Cable technology. This field will not be present if the information is not available or accessible, or if a cable is not connected at this connector. Possible values: "active_copper", "passive_copper", "copper", "optical".

storage-array-config-summary

A summary of array LUN connectivity for each attached array.

Fields

  • array-name => string

    • The name assigned to the array this group of array LUNs is exported from. 28 character string, no spaces.
  • device-type => string, optional

    • Type of LUN device. Describes the type of lun device or tape library. Possible Values are:
    • "array_lun" - Array LUN type
    • "tape_mc" - Tape Drive or Media Changer/library type
    • "unknown" - Unknown device type
  • group-number => integer

    • A unique number associated with a set of array LUNs that share the exact same pathing/connectivity information. Range: [0..65535]
  • initiator-port => string

    • Initiator port name, e.g. 0a.
  • switch-port => string

    • Name of switch port connected to the HBA (controller's initiator port), or UNKNOWN if direct attached.
  • target-wwpn => string

    • World wide port name of array's target port (64 chars).

storage-array-port

Maps array definition to target port

Fields

  • array-name => string

    • Name of the array in the array record. (28 char max)
  • wwnn => string

    • World wide node name of array's target port (64 chars).
  • wwpn => string

    • World wide port name of array's target port (64 chars).

storage-array-profile

data describing characteristics/parameters of/about a storage array

Fields

  • array-id => integer

    • primary key (system defined) for the array record. Range: [0..2^64-1]
  • name => string

    • A unique node-level user supplied name for the array. (28 char max)
  • options => string

    • A comma separated list of name value pairs of array specific settings. (128 chars max)
  • prefix => string

    • A unique user supplied 5 character code used to refer to this array and used in naming the array's LUNs.
  • serial-number => string

    • The serial number of the array. (17 char max)
  • vendor => string

    • The name of the array's vendor, e.g. NetApp. (8 chars max)

disk-aggregate-info

Details giving disk's basic disposition within its overlying aggregate or traditional volume. Information that is specific to a disk contained within an aggregate or traditional volume is returned here. Returned only if 'container-type' is "aggregate" or "volume".

Fields

  • checksum-type => string, optional

    • The checksum type that has been assigned to this disk. Omitted if information is unavailable, or if excluded by 'desired-attributes'.

    Possible values:

    • "advanced_zoned" - Advanced zoned checksum.
    • "block" - Block checksum.
    • "none" - No checksum type assigned.
    • "wafl" - WAFL checksum.
    • "zoned" - Zoned checksum.
  • copy-percent-complete => integer, optional

    • Percent completion of disk copy. Omitted if no copy operation involving this disk is in progress. So omitted if neither 'is-prefailed' nor 'is-replacing' is true, and if position is not "copy".
  • is-offline => boolean, optional

    • True if disk is offline. Omitted if excluded by 'desired-attributes'.
  • is-prefailed => boolean, optional

    • True if the admin issued a 'disk fail' or if the the system marked this disk for Rapid RAID Recovery. This flag is expected to remain set until the system has copied the contents of this disk to a system-selected replacement disk. At that point, this disk is expected to be removed from service and placed in in the broken pool. Omitted if excluded by 'desired-attributes'.
  • is-replacing => boolean, optional

    • True if the admin issued 'disk replace' to replace this disk with a specified replacement disk. This flag is expected to remain true until the system has copied the contents of this disk to the admin-specified replacement disk. At that point this disk is expected to be released to the spare pool. Omitted if excluded by 'desired-attributes'.
  • is-zeroed => boolean, optional

    • True if disk is in pre-zeroed state. Omitted if excluded by 'desired-attributes'.
  • is-zeroing => boolean, optional

    • True only if disk position is 'pending' and disk is in process of being zeroed. Omitted if excluded by 'desired-attributes'.
  • plex-name => string, optional

    • Name of plex with which this disk is associated. Omitted if disk is not associated with a plex, or if excluded by 'desired-attributes'.

disk-inventory-info

Disk inventory info.

Fields

  • bytes-per-sector => integer, optional

    • Number of bytes per disk sector. A sector count element, such as 'capacity-sectors' and 'right-size-sectors', may be multiplied by this value to convert to a byte count. Omitted if excluded by 'desired-attributes'.
  • carrier-id => string, optional

    • Unique identifier of the disk carrier. Maximum length of 34 characters. It is not returned if is-multidisk-carrier is set to false. Omitted if excluded by 'desired-attributes'.
  • carrier-serialno => string, optional

    • Unique serial number of the disk carrier. Maximum length of 17 characters. It is not returned if is-multidisk-carrier is set to false. Omitted if excluded by 'desired-attributes'.
  • checksum-compatibility => string, optional

    • An indication of the checksum types that this disk is capable of supporting. Each possible return value represents one or more checksum types. Omitted if not available or if excluded by 'desired-attributes'.

    Starting in Data ONTAP 8.1, "zoned/block" is no longer supported.

    Possible values:

    • "advanced_zoned" - Supports advanced zoned checksum.
    • "block" - Supports block checksum.
    • "none" - No checksum support.
    • "zoned/advanced_zoned" - Supports zoned and advanced zoned checksum.
  • disk-type => string, optional

    • Disk interface type. Omitted if excluded by 'desired-attributes'.

    Possible values:

    • "ATA"
    • "BSAS"
    • "EATA"
    • "FCAL"
    • "LUN"
    • "MSATA"
    • "SAS"
    • "SATA"
    • "SCSI"
    • "SSD"
    • "XATA"
    • "XSAS"
    • "FSAS"
    • "unknown"
  • disk-uid => string, optional

    • Disk unique identifier. Maximum length of 90 characters. Omitted if excluded by desired-attributes'.
  • firmware-revision => string, optional

    • Firmware revision of disk. The format of the firmware revision will vary depending on the type of disk and its vendor. Omitted if excluded by 'desired-attributes'.
  • is-foreign => boolean, optional

    • Indicates an array LUN has been designated as a foreign LUN and cannot be assigned. Omitted if excluded by 'desired-attributes'.
  • model => string, optional

    • Disk model string. Omitted if excluded by 'desired-attributes'.
  • right-size-sectors => integer, optional

    • Number of usable disk sectors that remain after subtracting the right-size adjustment for this disk. Given in units of 'bytes-per-sector'. Omitted if information is unavailable, or if excluded by 'desired-attributes'.
  • rpm => integer, optional

    • Rotational speed in revolutions per minute. Possible values are: 5400, 7200, 10000, and 15000. Omitted if information is unavailable, if rpm does not apply to this 'disk-type', or if excluded by 'desired-attributes'.
  • serial-number => string, optional

    • Disk serial number. Maximum length of 129 characters. Omitted if excluded by 'desired-attributes'.
  • shelf => string, optional

    • Disk shelf, if it can be determined. Omitted if Shelf Enclosure Service is not enabled for this device, information is unavailable, or excluded by 'desired-attributes'.
  • shelf-bay => string, optional

    • Disk shelf bay, if it can be determined. Omitted if Shelf Enclosure Service is not enabled for this device, information is unavailable, or excluded by 'desired-attributes'.
  • vendor => string, optional

    • Vendor of this disk. Omitted if excluded by 'desired-attributes'.

disk-outage-info

Information about a disk that is not in service.

Fields

  • reason => string

    • Reason disk is not in service. Omitted if excluded by 'desired-attributes'.

    Possible values:

    • "admin failed" - Admin has persistently failed disk.
    • "admin removed" - Admin requested spare disk to be removed from system.
    • "admin testing" - Admin isolated disk for maintenance testing.
    • "bad label" - Disk has bad RAID label.
    • "bypassed" - Disk has been bypassed.
    • "failed" - Disk is persistently failed.
    • "init failed" - Disk failed initialization.
    • "label version" - Disk has invalid RAID label version.
    • "labeled broken" - Disk was persistently failed in a prior Data ONTAP release.
    • "labelmaint" - Disk is isolated for online label maintenance.
    • "LUN resized" - Array LUN was inappropriately resized.
    • "missing" - Disk has gone missing.
    • "not responding" - Disk is non-responsive.
    • "predict failure" - Disk failure is predicted. capacity than previously.
    • "rawsize shrank" - Disk reporting smaller
    • "recovering" - Disk is underoing recovery.
    • "sanitizing" - Disk is in process of being sanitized.
    • "sanitized" - Disk sanitization complete, but admin has not yet released disk back to the spare pool. in this release.
    • "SFO Disk" - SFO disk, not supported on 7-mode systems.
    • "SnapLock Disk" - SnapLock disk, not supported.
    • "testing" - System isolated disk for maintenance testing.
    • "unassigned" - Disk ownership has not been assigned.
    • "unknown" - Don't know reason disk is not in service.

disk-ownership-info

Disk sanown information.

Fields

  • disk-uid => string, optional

    • Disk unique identifier. Maximum length of 90 characters. Example of output format is: 20000000:87A9652B:00000000:00000000:00000000:00000000:00000000:00000000:00000000:00000000 Omitted if excluded by 'desired-attributes'.
  • is-failed => boolean, optional

    • 'true' if the disk is failed such that its ownership cannot be determined. Omitted if excluded by 'desired-attributes'.
  • owner-node-id => integer, optional

    • ID (NVRAM ID) of node that currently owns this disk. Normally 'owner-node-id' matches 'home-node-id'. However, SFO style HA changes 'owner-node-id' when it localizes partner storage on takeover; and restores it to 'home-node-id' on giveback. Omitted if disk is unassigned, or if excluded by 'desired-attributes'.
  • owner-node-name => string, optional

    • Name of node that currently owns this disk. Normally 'owner-node-name' matches 'home-node-name'. However, SFO style HA changes 'owner-node-name' when it localizes partner storage on takeover; and restores it to 'home-node-name' on giveback. Omitted if disk is unassigned, or if excluded by 'desired-attributes'.
  • pool => integer, optional

    • Pool to which disk is assigned. Omitted if disk is unassigned, or if excluded by 'desired-attributes'.

disk-raid-info

RAID specific information about a disk, including RAID specific disk properties, and the disk's overlying container.

Fields

  • container-type => string, optional

    • Type of overlying disk container. Omitted if information is unavailable, or excluded by 'desired-attributes'.

    Possible vaules:

    • "aggregate" - Container is an aggregate.
    • "broken" - Container is broken pool.
    • "foreign" - Array LUN has been marked foreign.
    • "labelmaint" - Container is online label maintenance list.
    • "maintenance" - Container is disk maintenance center.
    • "spare" - Container is spare pool.
    • "unassigned" - Disk ownership has not been assigned.
    • "unknown" - Container is currently unknown. This is the default setting.
    • "volume" - Container is a traditional volume.
  • disk-aggregate-info => disk-aggregate-info, optional

    • Information giving disk's basic disposition within its overlying aggregate or traditional volume. Omitted if container-type is not "aggregate" or "volume", or if excluded by 'desired-attributes'.
  • disk-outage-info => disk-outage-info, optional

    • Information about a disk that is not in service. Omitted if container-type is not "broken", "maintenance", "labelmaint", or "unassigned", or if excluded by 'desired-attributes'.
  • disk-spare-info => disk-spare-info, optional

    • Information giving disk's basic disposition within its overlying spare pool. Omitted if container-type is not "spare", or if excluded by 'desired-attributes'.
  • disk-uid => string, optional

    • Disk unique identifier. Maximum length of 90 characters. Omitted if excluded by 'desired-attributes'.
  • effective-disk-type => string, optional

    • Effective disk interface type. Disks can report different physical 'disk-type', but the same 'effective-disk-type'. Disks with the same 'effective-disk-type' are compatible for use within the same aggregate or traditional volume. Omitted if information is unavailable, or excluded by 'desired-attributes'.

    Possible values:

    • "ATA"
    • "EATA"
    • "FCAL"
    • "LUN"
    • "MSATA"
    • "SAS"
    • "BSAS"
    • "SATA"
    • "SCSI"
    • "SSD"
    • "XATA"
    • "XSAS"
    • "FSAS"
    • "unknown"
  • effective-rpm => integer, optional

    • Effective rotational speed in revolutions per minute. Disks can report different actual 'rpm', but have the same 'effective-rpm'. Disks with the same 'effective- rpm' are compatible for use within the same aggregate or traditional volume. Omitted if information is unavailable, or excluded by 'desired-attributes'.
  • physical-blocks => integer, optional

    • RAID recorded disk capacity expressed in units of 4096-byte blocks. Typically this is the disk capacity reported by disk driver, but rounded down to the nearest 4096-byte block. Omitted if information is unavailable, or if excluded by 'desired-attributes'.
  • position => string, optional

    • Position of disk relative to its container-type. Omitted if excluded by 'desired-attributes'.

    Possible values:

    • "copy" - RAID group copy destination disk.
    • "data" - RAID group data disk.
    • "dparity" - RAID group diagonal parity disk.
    • "orphan" - Disk is orphan of an aggregate or traditional volume.
    • "parity" - RAID group parity disk.
    • "pending" - Disk is pending addition to an aggregate or traditional volume.
    • "present" - Disk is present in system. This is the default setting.
  • spare-pool => string, optional

    • Name of RAID managed spare pool with which this disk is associated. Omitted if unavailable. Generally determined both by whether ownership has been assigned for this disk, and whether SyncMirror feature is supported on the reporting node. This disk may not currently be contained within this spare-pool, such as if it's been allocated to an aggregate or removed from service. This is the spare pool with which disk would be contained if/when it is initialized or released as a spare. Omitted if excluded by 'desired-attributes'.

    Possible values:

    • "Pool0" - Disk is associated with spare Pool0.
    • "Pool1" - Disk is associated with spare Pool1.
    • "spare" - Disk is associated with the general spare pool.
    • "unknown" - Cannot determine spare pool associativity for this disk.
  • used-blocks => integer, optional

    • RAID recorded size of file system region on this disk, given in units of 4096-byte blocks. Typically based upon the disk's right-size capacity, but it may be smaller if RAID has downsized this disk, such as due to reconstruct replacing a smaller with a larger disk. This is distinct from WAFL usage of file system space. Omitted if information is unavailable, or if excluded by 'desired-attributes'.

disk-spare-info

Details giving disk's basic disposition within its overlying spare pool. Information that is specific to a disk that is contained within a spare pool belongs here.

Fields

  • is-media-scrubbing => boolean, optional

    • True if media scrub is currently active for this disk. Omitted if excluded by 'desired-attributes'.
  • is-offline => boolean, optional

    • True if disk is offline. Omitted if excluded by 'desired-attributes'.
  • is-zeroed => boolean, optional

    • True if disk has been pre-zeroed. Omitted if excluded by 'desired-attributes'.
  • is-zeroing => boolean, optional

    • True if disk is in process of being zeroed. Omitted if excluded by 'desired-attributes'.
  • zeroing-percent-complete => integer, optional

    • Percent completion of disk zeroing. Omitted if is-zeroing' is not true, or if excluded by 'desired-attributes'.

disk-stats-info

Contains disk statistics.

Fields

  • bytes-per-sector => integer, optional

    • Number of bytes per disk sector. A sector count element, such as 'sectors-read' and 'sectors-written', may be multipled by this value to convert to a byte count. Omitted if excluded by 'desired-attributes'.
  • disk-iops => integer, optional

    • Rolling average of I/O operations per second read and written to this disk. Omitted if excluded by 'desired-attributes'.
  • disk-uid => string, optional

    • Unique identifier of disk for this disk. Maximum length of 90 characters. Omitted if excluded by 'desired-attributes'.
  • sectors-read => integer, optional

    • Number of disk sectors read since system last booted, given in units of 'bytes-per-sector'. Omitted if excluded by 'desired-attributes'.

fw-update-status-info

List of disks that are pending updates, but not able to be updated.

Fields

storage-disk-info

Disk record.

Fields

  • disk-name => string, optional

    • Name of the disk, e.g. 0a.25. Omitted if excluded by 'desired-attributes'.
  • disk-paths => disk-path-info[], optional

    • List of all known paths associated with this disk. Omitted if no paths to report, or if excluded by 'desired-attributes'.
  • disk-raid-info => disk-raid-info, optional

    • RAID disk information. Omitted if disk is not visible to RAID, or if this information is excluded by 'desired-attributes'.
  • disk-uid => string, optional

    • Disk unique identifier. Maximum length of 90 characters. Example of output format is: 20000000:87A9652B:00000000:00000000:00000000:00000000:00000000:00000000:00000000:00000000 Omitted if excluded by 'desired-attributes'.

vmdisk-backing-info

Backing info block for virtual machine disks.

Fields

disk-path-info

Contains per path statistics, errors and other related data.

Fields

  • array-name => string

    • The name of the array providing the lun.
  • disk-port-name => string, optional

    • Disk port name associated with this path. This has the form <attachment-style>:<disk-port>, where <attachment-style> is either "FC" for FibreChannel, or "SA" for SAS, and <disk-port> is either "A" or "B". Omitted for non-disk target.

    Possible values:

    • "FC:A"
    • "FC:B"
    • "SA:A"
    • "SA:B"
  • disk-uid => string

    • Disk's UID, as supplied by the hardware, used to uniquely identify this disk.
  • initiator-iops => integer

    • Rolling average of I/O operations per second read and written over this initiator port. Range: [0..2^64-1]
  • initiator-port => string

    • Initiator port name, e.g. 0a.
  • lun-io-kbps => integer

    • Rolling average of kilobytes per second read and written to this LUN. Range: [0..2^64-1]
  • lun-iops => integer

    • Rolling average of I/O operations per second read and written to this LUN. Range: [0..2^64-1]
  • lun-number => integer

    • LU number. Range: [0..65535]
  • lun-path-use-state => string

    • ONTAP's use of this path INU - (In Use) This path is currently used for I/O. RDY - (Ready) This path is not being used for I/O currently, but might transition to INU if storge errors or load balancing cause it to transition to INU. ERR - (High Error) The weighted error total on this path is 20% or more of the error threshold. Load balancing will not use it, and the error handling code will only use it as a last resort. QED - (Quiesced) : The disk is quiesced on this path. MCF - (Misconfigured) : The disk is misconfigured on this path. The path is not available for I/O. Refer to storage_initiator_errors_list_info for details. FAL - (Failed) The connectivity to this path is lost.
  • node => string

    • Controller with the initiator port for this path.
  • path-iops => integer

    • Rolling average of I/O operations per second read and written to this path. Range: [0..2^64-1]
  • path-quality => integer

    • The percentage of the error threshold. 0% NO ERROR 1-20% LOW ERROR, available to load balancing and error retry code. 21-99% MEDIUM ERROR, load balancing and error retry code will not switch to this path. 100-? HIGH_ERROR, Excessive errors EMS event will be logged Range: [0..2^32-1]
  • preferred-target-port => boolean, optional

    • For a logical unit which reports asymmetric access, preferred-target-port indicates that a path, regardless of the current access state, routes to a preferred target port group. Possible values are:
    • true: This path routes to a preferred target port group for this array LUN.
    • false: This path does not route to a preferred target port group or the array LUN reports that there is no preferred target port group.
  • target-iops => integer

    • Rolling average of I/O operations per second read and written to this target port. Range: [0..2^64-1]
  • target-side-switch-port => string

    • Name of the switch port connected to the target array, or UNKNOWN if direct attached.
  • target-wwpn => string

    • World Wide Port Name of target port providing the disk.
  • tpgn => integer

    • The Target Port Group Number of the array's target port. Range: [0..2^64-1]

storage-error-info

Contains error messages associated with back end array/shelf/LUNs.

Fields

  • array-name => string

    • Name of the array/shelf with the configuration error.
  • disk-name => string

    • The name of the disk or array lun this error information is for.
  • disk-uid => string

    • Disk's UID, as supplied by the hardware, used to uniquely identify this disk.
  • error-id => integer

    • A unique ID for each error returned. ID is unique on a per API call basis only. Range: [0..2^32-1]
  • error-type => integer

    • Enum describing type of error. Range: [0..2^32-1] 1. Redundancy error, less than two paths to a disk. 2. Redundancy error, device is only accessible via a single fault domain, all paths go into the same target port group. 3. Device is a control LUN. 4. This LUN has non WAFL data on it, and is write protected. 5. LUN too large, A LUN has been detected that is larger than the maximum size supported. 6. LUN too small, A LUN has been detected that is smaller than the minimum size supported. 7. Invalid Block Size, A LUN has been detected that has an unsupported block size. 8. A target port is accessable via multiple HBAs but the device to LUN id mappings aren't the same. 9. A device is presented at different LUN ids on different ports. 10. Multiple failover mode policies detected 11. Unknown array LUN 12. Data ONTAP(R) LUN
  • node => string

    • The nodename reporting the disk or array lun with the error.

storage-initiator-load-info

Contains per port per disk load information.

Fields

  • initiator-port => string

    • Initiator port name, e.g. 0a. If port is not specified, data for all ports is returned.
  • lun-number => integer

    • Logical Unit Number. Range: [0..65535]
  • nodename => string

    • IP address of the node serving the port in dotted-decimal format (for example, "192.168.11.12").
  • serial-number => string

    • Disk/LUN serial number. Maximum length of 129 characters.
  • switch-name => string

    • The name of the switch connected to the controller's initiator port, or N/A when using direct attach.
  • target-side-switch-port => string

    • Name of the switch port connected to the target array, or UNKNOWN if direct attached.
  • target-wwpn => string

    • World Wide Port Name of array's target port.

storage-initiator-path-info

Contains per path statistics, errors and other related data.

Fields

  • array-name => string

    • The name of the array providing this path is connected to.
  • device-type => string, optional

    • Type of LUN device. Describes the type of lun device or tape library. Possible Values are:
    • "array_lun" - Array LUN type
    • "tape_mc" - Tape Drive or Media Changer/library type
    • "unknown" - Unknown device type
  • initiator-io-kbps => integer

    • Rolling average of kilobytes per second read and written over this initiator port Range: [0..2^64-1]
  • initiator-iops => integer

    • Rolling average of I/O operations per second over this initiator port Range: [0..2^64-1]
  • initiator-lun-in-use-count => integer

    • Number of LUNs in the IN-USE state on this initiator. Range: [0..2^64-1]
  • initiator-port => string

    • Initiator port name, e.g. 0a.
  • initiator-port-speed => string

    • The speed that the initiator port has negotiated with its connected switch port, or target port if direct attached.
  • initiator-side-switch-port => string

    • The name of the switch connected to the controller's initiator port, or N/A when using direct attach.
  • path-io-kbps => integer

    • Rolling average of kilobytes per second read and written to this path. Range: [0..2^64-1]
  • path-iops => integer

    • Rolling average of I/O operations per second read and written to this path. Range: [0..2^64-1]
  • path-link-errors => integer

    • Number link errors reported on the path. Range: [0..2^32-1]
  • path-lun-in-use-count => integer

    • Number of disks in the IN-USE state on this path. Range: [0..2^64-1]
  • path-quality => integer

    • The percentage of the error threshold. 0% NO ERROR 1-20% LOW ERROR, available to load balancing and error retry code. 21-99% MEDIUM ERROR, load balancing and error retry code will not switch to this path. 100-? HIGH_ERROR, Excessive errors EMS event will be logged Range: [0..2^32-1]
  • target-io-kbps => integer

    • Rolling average of kilobytes per second read and written to this target port. Range: [0..2^64-1]
  • target-iops => integer

    • Rolling average of I/O operations per second read and written to this target port. Range: [0..2^64-1]
  • target-lun-in-use-count => integer

    • Number of disks in the IN-USE state on this target port. Range: [0..2^64-1]
  • target-side-switch-port => string

    • Name of the switch port connected to the target array, or UNKNOWN if direct attached.
  • target-wwpn => string

    • World Wide Port Name of target port providing the disk.
  • tpgn => integer

    • The Target Port Group Number of the array's target port. Range: [0..2^64-1]
  • vmdisk-device-id => integer, optional

    • The device id used for the virtual device (also used by the hypervisor) Range: [0..2^32-1]

api-list-info

name of the API

Fields

  • None

replication-transfer-info

Structure of each entry in the transfer accounting table

Fields

  • replication-type => string

    • Type of replication operation. Qtree-snapmirror/SnapVault have two core data transfer mechanisms which they can utilize for data transfer. One is the legacy engine and the other is the newer engine. By default Data ONTAP enables the new engine. The user can choose to flip between the new engine and legacy engine. options-get api with an input of replication.logical.transfer_limits can be used to detect the type of engine. "current" implies a new engine while "previous" implies the legacy engine. Open Systems SnapVault (OSSV) always uses the legacy engine for transfers. Legacy volume-snapmirror limits are used when data resides on a traditional volume. Possible values of a replication operation are
    • "legacy_qtree_snapmirror_source";
    • "legacy_qtree_snapmirror_destination";
    • "qtree_snapmirror_source";
    • "qtree_snapmirror_destination";
    • "legacy_volume_snapmirror_source";
    • "legacy_volume_snapmirror_destination";
    • "volume_snapmirror_source";
    • "volume_snapmirror_destination";
    • "legacy_snapvault_source";
    • "legacy_snapvault_destination";
    • "snapvault_source";
    • "snapvault_destination";
    • "sync_snapmirror_source";
    • "sync_snapmirror_destination";
    • "volume_copy_source";
    • "volume_copy_destination";

system-api-element-info

api element description. This can be a simple type or a reference to another typedef (as defined in the 'type' element. Arrays are signified by having '[]' appended to the type name.

Fields

  • name => string

    • name of element
  • type => string

    • type of variable possible values: "string", "integer", "boolean", type-name

system-api-entry-info

list of api names and their elements

Fields

  • name => string

    • api name

system-api-info

api information

Fields

  • name => string

    • name of api

system-api-type-entry-info

list of type names and their elements

Fields

  • name => string

    • type name

system-info

Information about the system. Here system refers to a cluster node when running in cluster mode.

Fields

  • maximum-flexible-volume-count => integer, optional

    • The platform's maximum number of flexible volumes supported on this node. This does not include the number of volumes which can be supported when this node does a takeover of its partner node in a High Availability configuration.
  • system-id => string

    • System ID. This is defined by the vendor. Currently, it is a string of numbers
  • vendor-id => string

    • Hardware vendor identifier.

vm-system-disks

Storage info block for the hypervisor physical node on Data ONTAP-v (VSA)

Fields

vmhost-info

Storage info block for the hypervisor physical node on Data ONTAP-v (VSA)

Fields

uc-adapter-info

Information for one adapter.

Fields

  • adapter-name => string

    • The slot name of the adapter (e.g. 0e)
  • pending-fc4-type => ucm-type, optional

    • This is the pending change that has been made to the FC4-type on this adapter, but a controller reboot has not been performed for the change to take effect. A controller reboot is required for any pending changes to take effect. This will not be reported if there is no pending change on this adapter See fc4-type element for possible values.
  • pending-mode => ucm-mode, optional

    • This is the pending change that has been made to the mode on this adapter, but a controller reboot has not been performed for the change to take effect. A controller reboot is required for any pending changes to take effect. This will not be reported if there is no pending change on this adapter. See the mode element for possible values.
  • status => string

    • The status of this adapter. Possible values:
    • "online"
    • "offline"
    • "unsupported"

ucm-mode

The operational mode of the adapter. Possible values:
  • "fc" - Fibre Channel,
  • "cna" - Converged Network Adapter

Fields

  • None

ucm-type

The FC-4 type of the adapter. Possible values:
  • "initiator" - Initiator mode,
  • "target" - Target mode,

Fields

  • None

sid

Windows security identifier describing a user. A SID has the format S-1-5-21-int-int-int-rid.

Fields

  • None

useradmin-capability-info

Capability to run a command or commands on the filer.

Fields

  • name => string

    • Name of the capability Possible values include: "*", "login-*", "cli-*", "api-*", "security-*"... Instead of "*", commands and subcommands can be specified directly. Please see man page or other documentation for more details.

useradmin-group-info

Structure containing information pertaining to a group.

Fields

  • comment => string, optional

    • Comment for the group.
  • name => string

    • Name of the group.
  • useradmin-roles => useradmin-role-info[], optional

    • List of roles this group contains. The only included entry in this structure is the name field. For full role information user useradmin-role-list.

useradmin-role-info

Structure containing information pertaining to a role.

Fields

  • comment => string, optional

    • Comment for the role.
  • name => string

    • Name of the role.

useradmin-user-info

Structure containing information pertaining to a user.

Fields

  • comment => string, optional

    • Comment for the user. This is only set if the user has a comment.
  • name => string

    • Name of the user.
  • rid => string, optional

    • Unique relative identifier (per domain) for this user. (Used only for Windows.)
  • status => string, optional

    • Current status of the user account. This element cannot be used as an input. It is used as an output for useradmin-user-list. Possible values: "enabled", "disabled", or "expired".
  • useradmin-groups => useradmin-group-info[]

    • List of groups this user is part of. The only included entry in this structure is the name field. For full group information user useradmin-group-list.

adminhost

This is information about the administrative host

Fields

  • ipaddress => string

    • IP address of administrative host. IP address is either IPv4 address or IPv6 address.
  • name => string

    • name of administrative host, pass an empty string if this is not known

authentication-info

Login and password information

Fields

  • password => string, encrypted

    • password to use on remote filer
  • username => string

    • login name to use on remote filer

dns-info

Information about one vfiler DNS configuration.

Fields

dnsserver-info

This is information about one DNS server

Fields

  • ipaddress => string

    • DNS server IP address. IP address is either IPv4 address or IPv6 address.

encrypted-authentication-info

Encrypted Login and password information.

Fields

  • password => string, encrypted

    • encrypted password to use on remote filer

hostname-pair

Alternate hostnames or IP addresses for redundancy purposes

Fields

ipaddr-info

Information about one IP address that should be bound to the vfiler at the destination.

Fields

  • interface => string

    • Name of the network interface.
  • ip-address => string

    • One ip address, in dotted-decimal format (for example, "192.168.11.12") if IPv4 address. If IPv6 address then it should be in the format a:b:c:d:e:f:g:h (for example, fd20:81be:b255:4213:2a0:98ff:fe07:609b).
  • netmask => string

    • Netmask, in dotted-decimal format (for example, "255.255.255.0") if IPv4 address, else if IPv6 then the prefix length (for example, "64").

ipbinding-info

This is information about one IP address binding

Fields

  • interface => string

    • Name of interface to bind IP address to.
  • ipaddress => string

    • IP address to bind binding. IP address is either IPv4 address or IPv6 address.
  • netmask => string

    • Netmask of IP address binding for IPv4, the prefix length in case of IPv6 address

nis-info

Information about one vfiler NIS configuration.

Fields

nisserver-info

This is information about one NIS server

Fields

  • ipaddress => string

    • NIS server IP address, or "*". IP address is either IPv4 address or IPv6 address.

protocol-info

This is information about one protocol

Fields

  • protocol => string

    • Name of a allowed protocol

server-address

This is information about one Server.

Fields

  • ipaddress => string

    • Address of the Server.

storage-dr-status

disaster recovery status of storage entity

Fields

  • status => string

    • status of storage entity. Possible values are: initializing, snapmirrored, unknown.
  • storage-path => string

    • path of storage entity. Example: vol1.

storage-mr-status

vfiler migration status of each storage entity

Fields

  • error-msg => string, optional

    • In case of migration failure, this field displays the reason for failure.
  • status => string

    • status of storage entity. Possible values are: "initializing", "snapmirrored", "unknown".
  • storage-path => string

    • Name of storage entity. Example: vol1.

storage-unit

one storage unit

Fields

  • None

vfiler-info

Information about one vfiler.

Fields

  • name => string

    • Name of the vfiler.
  • uuid => string

    • The vfiler's uuid.

vfiler-location

Name of vfiler and the physical filer hosting it

Fields

  • vfiler => string

    • Name of the vfiler

vfnet-info

Information about one networking resource.

Fields

  • interface => string

    • Name of the interface, which should be something that the "ifconfig" command recognizes, like "e0a" or a vif name.
  • ipaddress => string

    • IP address of the networking resource
  • netmask => string

    • Netmask, in dotted decimal format for IPv4, else the prefix length incase of IPv6. (example, "255.255.192.0" for IPV4 "32" for IPV6).

vfstore-info

Information about one storage resource.

Fields

  • path => string

    • Path of the storage resource
  • status => string

    • Status of the storage resource. Possible values are: online, offline, inconsistent.

autosize-info

Autosize settings of the volume This appears only if the "verbose" parameter above is set to "true".

Fields

  • grow-threshold-percent => integer, optional

    • The trigger capacity percentage at which the volume automatiacally grows.
  • is-enabled => boolean, optional

    • This element is deprecated in Data ONTAP 8.2 and later. Please use autosize-mode instead. The value of 'true' means that autosize is enabled, while 'false' means that the autosize mode is 'off'.
  • mode => string, optional

    • Defines the current mode of volume autosize. Legal modes include "grow", "grow_shrink", and "off".
  • shrink-threshold-percent => integer, optional

    • The trigger capacity percentage at which the volume automatically shrinks.

clone-child-info

Information describing each of the clones that are children of the current flexible volume.

Fields

clone-parent-info

Information describing the parentage of a flexible volume clone.

Fields

clone-split-detail-info

Status information about an active clone split.

Fields

  • name => string

    • Name of the clone being split.

clone-split-estimate-info

Estimate information about a future clone split.

Fields

compression-info

Note that the use of this element is deprecated, refer to the 'dense-status' element for compression status instead.

Fields

  • is-compression-enabled => string

    • Note that the use of this field is deprecated, refer to the 'is-compression-enabled' field in the 'dense-status' element instead.

errors-warnings-info

The complete list of errors and warnings if perform-validation-only is true or all the warnings if is-override-warnings is true.

Fields

guarantee

Type of guarantee

Fields

  • type => string

    • guarantee that is supported on a given volume. Possible values are: "volume", "file", "partial", "none"

mediascrub-detail-info

Information about media scrubbing.

Fields

  • mediascrub-status => string

    • Possible values are "suspended", "disabled" and "enabled" "suspended": Media scrub is enabled but temporarily paused because another task is running or it is in the idle cycle of its periodic run. It will resume automatically when the task is done or the idle cycle ends. "disabled": Media scrub feature is turned off. "enabled": Media scrub feature is active.
  • percentage-complete => integer, optional

    • Media scrubbing percentage complete. Range: [0..100].

raidgroup-size-info

Default, minimum and maximum raidgroup size for each RAID type supported on this filer.

Fields

  • raidtype => string

    • Name of the RAID type allowed on this filer. Possible values: raid0, raid4, raid_dp.

raidtype-info

RAID types allowed on this filer.

Fields

  • raidtype => string

    • Name of an allowed RAID type. Possible values: raid0, raid4, raid_dp.

scrub-detail-info

Scrubbing information.

Fields

  • is-suspended => boolean

    • Suspended state of the scrub on that RAID group.
  • last-scrub-timestamp => integer, optional

    • Time at which the last full scrub completed. If a scrub has never been performed, this value will not be returned. The time value is in seconds since January 1, 1970. Range : [0..2^31-1].
  • percentage-complete => integer, optional

    • Scrubbing percentage complete. I scrubbing is not active, this value will not be returned. Range : [0..100].
  • raid-group => string

    • Name of the RAID group involved in the scrub.

sis-info

Status and statistics for the SIS volume.

Fields

  • compress-saved => integer

    • The total disk space saved due to compression in KB (1024 Bytes) on the referenced file system. Range: [0 - 2^64-1]
  • dedup-saved => integer

    • The total disk space saved due to deduplication in KB (1024 Bytes) on the referenced file system. Range: [0 - 2^64-1]
  • percentage-saved => integer

    • Percentage of space savings generated by the shared space. This is calculated as [size-saved / (size-saved + size-used)]. This field appears if the SIS volume is online. Range : [0..100].
  • progress => string

    • The progress of the current SIS operation.
  • schedule => string

    • The schedule for SIS operation on the volume. See sis-set-config for the format of the schedule.
  • size-saved => integer

    • The disk space savings generated by the shared space. The size is in bytes. The size-saved plus the size-used would be the total space usage, if no space is shared. This field appears if the SIS volume is online. Range : [0..2^64-1].
  • size-shared => integer

    • Number of bytes in the used space that is shared. This field appears if this SIS volume is online. Range : [0..2^64-1].
  • state => string

    • Possible values: "enabled", or "disabled".
  • status => string

    • Possible values: "idle", "active", "pending", or "undoing".
  • total-saved => integer

    • The total disk space saved by compression & deduplication in KB (1024 Bytes) on the referenced file system. Range: [0 - 2^64-1]
  • type => string

    • Possible values: "regular" or "snapvault".

snap-autodelete-info

Snapshot autodelete policy settings. This appears only if the "verbose" parameter above is set to "true".

Fields

  • commitment => string

    • Possible values: "try", "disrupt", or "destroy". This option determines the snapshots which 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" only permits the snapshots which are not locked by data backing functionalities (volume and LUN clones) to be deleted.
  • defer-delete => string

    • Possible values "scheduled", "user_created", "prefix", or "none". This option determines which kind of snapshots to delete in the end. 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.
  • delete-order => string

    • Possible values "oldest_first", "newest_first". This option determines if the oldest or newest snapshot is deleted first.
  • destroy-list => string

    • Possible values are the combination of "lun_clone", "vol_clone", "cifs_share", "file_clone" or "none". These options specify 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.
  • prefix => string

    • This option provides the prefix string for the "prefix" value of the "defer_delete" option.
  • state => string

    • Possible values: "on" or "off". This option determines if the snapshot autodelete is currently enabled for the volume.
  • target-free-space => integer

    • This option determines when snapshot autodelete should stop deleting snapshot. Depending on the trigger, snapshots are deleted till we reach the target free space percentage. Range: [1..100]
  • trigger => string

    • Possible values: "volume", "snap_reserve", or "space_reserve". This option determines the condition in which snapshots should be automatically deleted. Setting this option to "volume" triggers snapshot autodelete to run when the volume is near full. Setting this option to "snap_reseve" 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.

transition-info

Information relating to any transition jobs running or previously run on this volume.

Fields

vm-align-info

Information relating to Virtual Machine alignment settings on the volume.

Fields

  • vm-align-sector => integer, optional

    • The Virtual Machine alignment 512 byte sector number. All files created with the suffix specified in the 'vm-align-suffix' input parameter will have zero-filled <512 * 'vm-align-sector'> bytes data at the beginning so that it's actual data starts at a different offset instead of zero. This is done so that the read & writes to such files are aligned to WAFL's 4k block boundary
  • vm-align-suffix => string, optional

    • The Virtual Machine alignment suffix. The suffix such as '.xyz' is used to identify the files which needs to be aligned. See the description for 'vm-align-sector' above for more information on this.

vol-footprint-info

Details of space utilization footprint in the hosting aggregate.

Fields

  • delayed-free-footprint => integer

    • This field represents the delayed free footprint in bytes. This system is used to improve delete performance by batching delete requests.
  • total-footprint => integer

    • This field represents the total footprint in bytes. It is based on the sum of all of the components of the volume's footprint in its parent aggregate.
  • volume => string

    • Name of the volume.

vol-move-status-info

status of each move

Fields

  • last-transfer-duration => integer, optional

    • Time taken for the last completed transfer in seconds. Appears only in verbose mode. There is no upper limit on how long this can take.
  • last-transfer-size => integer, optional

    • The size in KB (1024) of the last completed transfer. Appears only in verbose mode. The maximum value is the size of the volume.
  • move-state => string

    • Status of the move. Possible values are "setup", "move", "cutover", "abort", "setup(paused)", "move(paused)".

vol-space-info

Space utilization details.

Fields

  • snapshot-reserve => integer

    • This field represents the size in bytes in the volume of space that has been set aside as a reserve for Snapshot usage.
  • snapshot-spill => integer

    • This field represents space used by Snapshot copies when it exceeds the size of the Snapshot reserve in bytes. It is computed as Snapshot used minus Snapshot reserve when Snapshot used exceeds Snapshot reserve.
  • total-used => integer

    • This field represents the total used space in the volume in bytes. This value is based on user data, metadata that resides in the volume, and Snapshot reserve.
  • user-data => integer

    • This field represents user data in bytes. If space is reserved to overwrite data in the volume, it is included in this value.
  • volume => string

    • Name of the volume

volume-64bit-upgrade-check-info

Information returned when upgrade-64bit-mode in aggr-add is "check". Upgrade check results such as "used-space", "available-space", "capacity", and "grow-space" are only updated after the space estimate is completed successfully.

Fields

  • last-errno => integer, optional

    • The error code of the last attempt to check for space usage on the specific volume. This field is present only if a 64-bit upgrade check was previously attempted. Possible values: 0 - indicates success EVOLUME_64BIT_UPGRADE_KIREETI_NOT_AVAIL Upgrade check results may be out of date if last-errno is not 0.

volume-64bit-upgrade-info

Information related to 64-bit upgrade.

Fields

volume-info

Volume status information.

Fields

  • block-type => string

    • The indirect block format of the volume. Possible values: 32_bit, 64_bit.
  • checksum-style => string

    • The style of RAID checksum used (for a traditional volume; for a flexible volume, the corresponding value of its containing aggregate). The possible values:
    • "advanced_zoned" - advanced_zoned checksum (azcs),
    • "block" - block,
    • "mixed" - mixed,
    • "none" - none,
    • "unknown" - unknown
    • "wafl" - wafl,
    • "zoned" - zoned.
  • clone-parent => clone-parent-info[], optional

    • Flexible volumes only. This field appears for a flexible volume if it is a clone of another flexible volume, describing the clone's parentage.
  • disk-count => integer

    • Total number of associated disks (for a traditional volume; for a flexible volume, the corresponding value of its containing aggregate). Range : [0..2^31-1]
  • expiry-date => integer, optional

    • Expiry date of the SnapLock volume in seconds in the standard UNIX format (since 01/01/1970 00:00:00) is displayed. Range:[0..2^64-1]. The flag is-wraparound indicates if this date is in the normal format or is wrapped around. This field is not included if 1. the volume has an infinite expiry-date 2. the volume is offline 3. the volume has scan in progress 4. the volume is regular volume 5. the volume has no expiry date. The volume is SnapLock volume (is-snaplock is "true") with no WORM files and no WORM snapshots.
  • files-private-used => integer

    • Number of system (not user-visible) files (inodes) used. If the volume is restricted or offline, a a value of 0 is returned. Range : [0..2^64-1].
  • files-total => integer

    • Total user-visible file (inode) count, i.e., current maximum number of user-visible files (inodes) that this volume can currently hold. If the volume is restricted or offline, a value of 0 is returned. Range : [0..2^64-1].
  • files-used => integer

    • Number of user-visible files (inodes) used. If the volume is restricted or offline, a value 0 returned. Range : [0..2^64-1].
  • filesystem-size => integer

    • Filesystem size (in bytes) of the volume. This is the total usable size of the volume, not including WAFL reserve. This value is the same as Size except for certain SnapMirror destination volumes. It is possible for destination volumes to have a different filesystem-size because the filesystem-size is sent across from the source volume. If the volume is restricted or offline, a value of 0 is returned. Range : [0..2^64-1].
  • formatted-expiry-date => string, optional

    • Expiry date of the SnapLock volume in a human-readable format :: is displayed. A value of "infinite" indicates that the volume has an infinite expiry date. A value of "scan_in_progress" indicates that expiry date is not displayed since worm scan on the volume is in progress. A value of "no_expiry_date" indicates that expiry date is not displayed since the SnapLock volume has no WORM files and WORM snapshots. This field is not included if the volume is offline or the volume is regular volume (is-snaplock is "false").
  • formatted-snaplock-volume-compliance-clock => string, optional

    • If Compliance Clock is initialized then human readable time :: is displayed. This field will be present only for SnapLock volumes.
  • hybrid-cache-eligibility => string

    • hybrid cache eligibility. Valid values are "read","read-write" and "none". Volumes which report "read" can support only read caching. Volumes which report "read-write" support both read and write caching. "none" means no hybrid caching support.
  • inodefile-private-capacity => integer

    • Number of inodes that can currently be stored on disk for system (not user-visible) files. This number will dynamically increase as more system files are created. If the volume is restricted or offline, a value of zero is returned. Range : [0..2^64-1].
  • inodefile-public-capacity => integer

    • Number of inodes that can currently be stored on disk for user-visible files. This number will dynamically increase as more user-visible files are created. If the volume is restricted or offline, a value of zero is returned. Range : [0..2^64-1].
  • is-checksum-enabled => boolean

    • Whether RAID checksums are enabled (for a traditional volume; for a flexible volume, the corresponding value of its containing aggregate).
  • is-inconsistent => boolean

    • Whether or not there is known inconsistency in the associated file system.
  • is-invalid => boolean, optional

    • Whether or not this volume is invalid. Volumes typically become invalid as a result of an aborted 'vol copy' or SnapMirror(R) initial transfer. In such a case a volume is in a half created state and cannot be recovered.

    By default, this field is FALSE.

  • is-snaplock => boolean

    • Whether or not this is a SnapLock volume.
  • is-unrecoverable => boolean, optional

    • Whether or not there is known inconsistency in the associated file system and it is not recoverable. This value is only present for flexible volumes.

    By default, this field is FALSE.

  • is-wraparound => boolean, optional

    • True if the date represented in expiry-date is a wrap around date. SnapLock wraps around the expiry date to indicate dates after 01/19/2038. It remaps 01/01/1970 - 12/31/2002 to 01/19/2038 - 01/19/2071. This field is not included if 1. the volume has an infinite expiry date 2. the volume is offline 3. the volume has scan in progress 4. the volume is regular volume (is-snaplock is "false") 5. the volume has no expiry date. The volume is SnapLock volume (is-snaplock is "true") with no WORM files and no WORM snapshots.
  • mirror-status => string

    • The RAID mirror status (for a traditional volume; for a flexible volume, the corresponding value of its containing aggregate). Possible values: CP count check in progress, failed, invalid, limbo, mirror degraded, mirror resynchronizing, mirrored, needs CP count check, uninitialized, <unknown mirror state>, and unmirrored.
  • name => string

    • Name of the volume.
  • owning-vfiler => string, optional

    • Name of the vfiler which owns this volume. This value will be returned only if the request is coming to vfiler0 and MultiStore is licensed.
  • plex-count => integer

    • Number of plexes (for a traditional volume; for a flexible volume, the corresponding value of its containing aggregate). This is also the size of the "plex" array that appears below. A plex is composed of one or more RAID groups that have been lashed together to serve as the unit for RAID mirroring. Range : [0..2^31-1]
  • plexes => plex-info[]

    • List of plexes for this volume (for a traditional volume; for a flexible volume, the corresponding value of its containing aggregate).
  • quota-init => integer

    • Quota state and percent initialized. 100% means that quotas are on, 0% means quotas are off, and anywhere inbetween means that quotas are initializing. Range : [0..100].
  • raid-size => integer

    • The current RAID group size (for a traditional volume; for a flexible volume, the corresponding value of its containing aggregate). Range : [0..2^31-1].
  • raid-status => string

    • The current RAID status (for a traditional volume; for a flexible volume, the corresponding value of its containing aggregate). Possible values: copying, degraded, foreign, growing, initializing, invalid, ironing, mirror degraded, mirrored, needs check, noparity, normal, out-of-date, partial, raid0, raid4, raid_dp, reconstruct, resyncing, snapmirrored, verifying, unrecoverable. This field can contain a combination of the above status values in a comma separated list; for example: "reconstruct,growing".
  • remote-location => string, optional

    • Displays the remote host and remote volume where the origin of the cache is located. Returned in format: : Present only if flex volume is a FlexCache. Remote Host: Should be formatted as either the DNS hostname or as an IP address. Remote Volume: Should be formatted the same as a volume name.
  • reserve => integer

    • Number of bytes reserved for overwriting snapshotted data in an otherwise full volume. This space is usable only by space-reserved LUNs and files, and then only when the volume is full. It is equal to reserve-required if the value of the fractional_reserve option is set to the default value of 100%, but otherwise may be less than reserve-required. If the volume is restricted or offline, a value of 0 is returned. Range : [0..2^64-1]
  • reserve-required => integer

    • The number of reserved bytes that are required to ensure that the reserved space is sufficient to allow all space reserved files and LUNs to be overwritten when the volume is full. If the volume is restricted or offline, a value of 0 is returned. Range : [0..2^64-1].
  • reserve-used => integer

    • Number of reserved bytes that is not available for new overwrites. The number includes both reserved bytes which have actually been used for overwrites as well as bytes which were never allocated in the first place. On a volume without free space, the "never allocated" component can become non-zero when reserve-required increases as holes are filled in. Because of this, the reserve-used value can exceed the number of snapshotted bytes. The reserve-used value can also exceed the value of reserve-required, as the filer maintains a small hidden reserve of last resort. If the volume is restricted or offline, a value of 0 is returned. Range : [0..2^64-1].
  • reserve-used-actual => integer

    • Number of reserved bytes that have been used. This value is computed as the smaller of: (1) snapshotted bytes not in the active filesystem, and (2) reserve-used. This formula comes from the observation that you cannot have used more overwrite reserved than have actually overwritten data. This value can exceed the value of reserve-required, as the filer maintains a small hidden reserve of last resort. If the volume is restricted or offline, a value of 0 is returned. Range : [0..2^64-1].
  • sis => sis-info, optional

    • Display the Single Instance Storage (SIS) related status and statistics if the volume is a SIS volume.
  • size-available => integer

    • Number of bytes still available in the volume. If the volume is restricted or offline, a value of 0 is returned. Range : [0..2^64-1].
  • size-total => integer

    • Total usable size (in bytes) of the volume, not including WAFL reserve or volume snapshot reserve. If the volume is restricted or offline, a value of 0 is returned. Range : [0..2^64-1].
  • size-used => integer

    • Number of bytes used in the volume. If the volume is restricted or offline, a value of 0 is returned. Range : [0..2^64-1].
  • snaplock-type => string, optional

    • The type of the snaplock volume. It is present for snaplock volumes only, i.e. volumes for which is-snaplock is "true". Possible values - "compliance" or "enterprise"
  • snaplock-volume-compliance-clock => integer, optional

    • If Compliance Clock is initialized then time in seconds in the standard UNIX format (since 01/01/1970 00:00:00) is displayed. This field will be present only for SnapLock volumes. Range:[0..2^64-1].
  • snapshot-blocks-reserved => integer

    • The number of 1024 byte blocks that has been set aside as reserve for snapshot usage. This is same as "blocks-reserved" in snapshot-get-reserve API output. Range : [0..2^64-1].
  • snapshot-percent-reserved => integer

    • The percentage of disk space that has been set aside as reserve for snapshot usage. This is same as "percent-reserved" in snapshot-get-reserve API output. Range : [0..100].
  • space-reserve => string, optional

    • Flexible volumes only. The storage guarantee associated with the flexible volume. Possible values: none, file, volume. This field does not appear if the flexible volume is restricted or offline.
  • space-reserve-enabled => boolean, optional

    • Flexible volumes only. Whether or not the storage guarantee associated with the flexible volume is currently in effect. This field does not appear if the flexible volume is restricted or offline.
  • state => string

    • State of the volume. Possible values: "offline", "online", "restricted" and "unknown" for both flexible and traditional volumes, and "creating", "failed", and "partial" specifically for traditional volumes.
  • type => string

    • The type of volume. Possible values: "flex" for flexible volumes, and "trad" for traditional volumes.
  • uuid => string

    • Universal unique identifier (UUID) for the volume.

volume-option-info

Option key and value.

Fields

  • name => string

    • Option key.
  • value => string

    • Option value.

uuid

The 128-bit universally-unique identifier (UUID). 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. An example UUID is 532ad684-c8ec-11d9-945f-00065b8c8a1e.

Fields

  • None

COPYRIGHT

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).