OntapClusterAPI - Contains the definitions and description of API Bindings for clustered Data ONTAP
my $s = NaServer->new($server, 1, 0); # create NaServer (server context)
$s->set_admin_user('admin', 'password'); # provide username and password
eval{
my $output = $s->system_get_version(); # use binding for system-get-version API
print "Data ONTAP version: $output->{version}\n"; # extract the required parameter from output
print "Clustered: $output->{is-clustered}\n";
my $tuple = $output->{'version-tuple'}->{'system-version-tuple'};
print "Generation: $tuple->{generation} Major: $tuple->{major} Minor: $tuple->{minor} \n";
$output = $s->quota_status_iter('query' => { 'quota-status-attributes' => {'volume' => 'vol0'}} ); # nested parameters as hashes of hashes
print "Quota Status: $output->{'attributes-list'}->{'quota-status-attributes'}->{'status'} \n";
};
if($@) { # check for any exception
my ($error_reason, $error_code) = $@ =~ /(.+)\s\((\d+)\)/; # parse out error reason and error code
print "Error Reason: $error_reason Code: $error_code\n"
}
NetApp Manageability SDK 5.2 provides support for Perl API bindings for both Data ONTAP APIs and OnCommand Unified Manager APIs.
The Perl API bindings libraries contain interfaces to establish a connection with either the Data ONTAP server or the OnCommand Unified Manager server.
By using these libraries, you can create Perl applications to access and manage the Data ONTAP server or OnCommand Unified Manager server.
NetApp Manageability SDK 5.2 Perl API bindings provide a runtime library NaServer.pm, which is available at <installation_folder>/lib/perl/NetApp.
This library file enables you to establish a server connection, send requests and receive responses, and interpret error messages.
Each binding can be called as a subroutine of NaServer module which in turn invokes the corresponding Data ONTAP or OnCommand Unified Manager API.
[Family: cluster]
Add disks to the specified aggregate, whether it is free-standing or embedded in a traditional volume. The disks to add are specified in the same way as for "aggr-create". Disks cannot be added to a mirrored aggregate if one or more of the plexes is offline. By the time the API returns, the disk(s) may not yet be completely added. Use 'aggr-list-info' to query the aggregate status to determine when it has finished growing due to the added disk(s). Same can be done using 'aggr-get-iter' when requested from Admin Vserver LIF. When the upgrade-64bit-mode input is provided to this API, the API produces a set of results in the background. These results are not available as output from aggr-add. Use the 'aggr-list-info' and 'volume-list-info' APIs to query the results of the 64-bit upgrade process on the aggregate and flexible volumes, respectively.Inputs
- aggregate => string
Name or UUID of the aggregate to which the disks will be added. See the synopsis for name/UUID format and restrictions.
- allow-mixed-rpm => boolean, optional
Disks in an aggregate are normally required to have the same RPM. This behavior is overridden with this option when it is set to true. Default value is false.
- 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. This option has an effect only when disks to be used are specified in 'disks'. This option is ignored when 'disk-count' is used.
- cache-raid-type => string, optional
Specifies the raid-type of the new RAID groups being created as part of the disk add operation. This option should be used while adding SSD disks for the first time to a hybrid-enabled aggregate. Possible values: raid4 and raid_dp only. If not specified, the default value is the raid-type of the aggregate.
- checksum-style => string, optional
Specifies the checksum style for the disks to be added to an aggregate. This input is not allowed if a list of disks to use is specified through the "disks" parameter. The possible values: - "advanced_zoned" - advanced_zoned checksum (azcs),
- "block" - block.
By default, disks with same checksum style as the aggregate are selected. Use this option to override that behavior and create a mixed checksum aggregate. "zoned" is not supported as one of the possible values as a mixed checksum aggregate can support only block and advanced_zoned checksum styles.
- disk-count => integer, optional
Number of disks to add, including the parity disks. The disks will come from the pool of spare disks. The smallest disks in this pool join the aggregate first, unless the "disk-size" argument is specified. Either the "disk-count" or "disks" argument must be specified. Range : [0..2^31-1].
- disk-size => integer, optional
The individual disk size in 4KB blocks. For example, a disk-size of 131072000 represents a 500GB drive (131072000 * 4 * 1024 = 500 * 1024 * 1024 * 1024). Disks that are within approximately 20% of the specified size will be selected. If neither the "disk-size" nor the "disk-size-with-unit" argument is specified, existing groups are appended with disks that are the best match by size for the largest disk in the group. When starting new groups, disks that are the best match by size for the largest disk in the last raidgroup are selected first, then smaller disks, and finally larger disks. This "disk-size" option is ignored if a specific list of disks 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
This parameter accepts a disk size in the specified unit. It is a positive integer number followed by unit of "T", "G", "M" or "K". For example, these are accepted: 72G, 36G, 1T and 32M. But "72" will not be accepted. This "disk-size-with-unit" option is ignored if a specific list of disks 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.
- disk-type => string, optional
Type of disks to use : ATA, BSAS, EATA, FCAL, FSAS, LUN, MSATA, SAS, SATA, SCSI, XATA, XSAS, or SSD. This option is required when converting an existing aggregate to a hybrid one, or when operating on a hybrid aggregate. Otherwise, the option is not required.
- disks => disk-info[], optional
Specific list of disks to add to the aggregate. If the aggregate is mirrored and a specific list of disks is supplied, another list ("mirror-disks") must also be supplied with the same number of disks. Either the "disks" or "disk-count" argument must be specified.
- force-cache-size => boolean, optional
When set to true this parameter forces the addition of SSD disks to hybrid enabled aggregate by skipping the check for total (local + partner) hybrid SSD capacity. This can be used when the partner's cache capacity cannot be retrieved. Default value is false. Warning: If force-cache-size is set to true, the administrator is responsible to ensure that the total limit will not be exceeded.
- force-spare-pool => boolean, optional
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. This is a deprecated parameter. Use the allow-mixed-rpm and ignore-pool-checks parameters instead.
- group-selection-mode => string, optional
Specifies how DATA ONTAP adds the specified disks to raidgroups. Legitimate values are "last", "one", "new" or "all". group-selection-mode is an optional argument, and the behavior when it is not used is selected by value of raid-group. If raid-group is used, the behavior is the same as for group-selection-mode "one". If raid-group is not used, the behavior is the same as for group-selection-mode "last". The raid-group option must be used with group-selection-mode value "one", and it cannnot be used with others. If the string value is "last", Data ONTAP adds the specified disks to the existing last RAID group first. After the last RAID group is full, it creates one or more new RAID groups and adds the remaining disks to the new groups. If the string value is "one", Data ONTAP adds the specified disks to the existing RAID group specified by raid-group option until this specified RAID group is full. If the string value is "new", Data ONTAP creates one or more new RAID groups and adds the specified disks to the new groups, even if they would fit into an existing RAID group. The name of new RAID groups are selected automatically. It is not possible to specify the name for the new RAID groups. If the string value is "all", Data ONTAP adds the specified disks to existing RAID groups first. Only after all existing RAID groups are full, it creates one or more new RAID groups and adds the remaining disks to the new groups.
- ignore-pool-checks => boolean, optional
Disks in a plex are normally required to come from the same spare pool. Similarly, disks in different plexes of a mirrored aggregate are required to come from different spare pools. This behavior is overridden with this option when it is set to true. Default value is false.
- pre-check => boolean, optional
Only check for the warnings without actually adding the disks. This option cannot be used when "simulate" is specified or "upgrade-64bit-mode" is set to "check". Default value is false.
- 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 aggregate can no longer be reverted to a version of Data ONTAP prior to 6.2. In such a case, the "force-spare-pool" option must be specified as well. By default, the filer fills up one RAID group with disks before starting another RAID group. Suppose an aggregate currently has one RAID group of 12 disks and its RAID group size is 14. If you add 5 disks to this aggregate, 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.
- upgrade-64bit-mode => string, optional
Allows the aggregate to grow past 16 TB and begin 64-bit upgrade. If not supplied, adding disks past 16 TB to a 32-bit aggregate will fail. Legitimate values are "check", "grow_all", "grow_none", and "grow_reserved". If the "check" value is specified, aggr-add produces a summary of the space impact which would result from upgrading the aggregate to 64-bit. This summary includes the space usage of each contained volume after the volume is upgraded to 64-bit and the amount of space that must be added to the volume to successfully complete the 64-bit upgrade. The summary can be obtained by querying the 'aggr-list-info' and 'volume-list-info' APIs. The aggregate's summary is made available in the 'check' element that is part of the 'aggr-64bit-upgrade-info' typedef. The flexible volumes' summary is made available in the 'check' element that is part of the 'volume-64bit-upgrade-info' typedef. This option does not result in an upgrade to 64-bit or addition of disks. If the "grow_all" value is specified, "aggr-add" upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option allows "aggr-add" to automatically grow volumes as needed if they run out of space due to the 64-bit upgrade. The volumes will be grown to accommodate all the files within these volumes. This option does not affect volumes which have autosize enabled. If the "grow_none" value is specified, "aggr-add" upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option does not allow "aggr-add" to automatically grow volumes if they run out of space due to the 64-bit upgrade. If the "grow_reserved" value is specified, "aggr-add" upgrades the aggregate to 64-bit if the total aggregate size after adding the specified disks exceeds 16TB. This option allows "aggr-add" to automatically grow volumes if they run out of space due to the 64-bit upgrade, but only to accommodate the space reserved files within these volumes. This option does not affect volumes which have autosize enabled.
Outputs
- upgrade-64bit-cookie => integer, optional
The opaque cookie to uniquely identify this 64-bit upgrade transaction. This cookie can be compared against the cookie returned by aggr-list-info to ensure that the output produced by aggr-list-info corresponds to this 64-bit upgrade transaction. Range: [0..2^64-1].
[Family: cluster]
Return true if there is no suitable spare disk available for any filesystem (parity or data) disk.Inputs
- node-name => string, optional
Low spare condition checked on the requested node. When requested from Admin Vserver LIF and node name not specified, status for the cluster is returned.
Outputs
- is-spare-low => boolean
"true", if system has insufficient spare disk, "false" otherwise. When requested from Admin Vserver LIF, "true" is returned if one or more nodes in the cluster have spare low condition, "false" otherwise.
[Family: cluster]
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
- aggregate => string
Name of the aggregate to create. The aggregate name can contain letters, numbers, and the underscore character(_), but the first character must be a letter or underscore. The maximum length of the aggregate name is 255.
- allow-mixed-rpm => boolean, optional
Disks in an aggregate are normally required to have the same RPM. This behavior is overridden with this option when it is set to true. Default value is false.
- 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. This option has an effect only when disks to be used are specified in 'disks'. This option is ignored when 'disk-count' is used.
- block-type => string, optional
The indirect block format that the aggregate can have. It can be either 32_bit or 64_bit. Specifying 64_bit allows creation of aggregates that can be larger than 16TB. The default is 64_bit. Possible values: 32_bit, 64_bit
- checksum-style => string, optional
Specifies the checksum style for the aggregate. This input is not allowed if a list of disks to use is specified through the "disks" parameter. The possible values: - "advanced_zoned" - advanced_zoned checksum (azcs),
- "block" - block,
- disk-count => integer, optional
Number of disks to place into the aggregate, including parity disks. The disks in this newly- created aggregate come from the spare disk pool. The smallest disks in this pool join the aggregate first, unless the "disk-size" argument is provided. Either "disk-count" or "disks" must be supplied. Range [0..2^31-1].
- disk-size => integer, optional
Disk size in 4KB blocks. Disks that are within 10% of the specified size will be selected for use in the aggregate. 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
Disk size in the specified unit. It is a positive integer number followed by unit of "T", "G", "M" or "K". This "disk-size-with-unit" option is ignored if a specific list of disks 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.
- disk-type => string, optional
Type of disks to use: ATA, BSAS, EATA, FCAL, FSAS, LUN, MSATA, SAS, SATA, SCSI, SSD, XATA, or XSAS. This option is needed only when disks of different types are connected to the filer. It is not allowed if a list of disks to use is specified through the "disks" parameter. The ability to mix compatible disk types in one aggregate is controlled by the system option 'raid.disktype.enable'.
- disks => disk-info[], optional
Specific list of disks to use for the new aggregate. 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.
- force-spare-pool => boolean, optional
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. This is a deprecated parameter. Use the allow-mixed-rpm and ignore-pool-checks parameters instead.
- ignore-pool-checks => boolean, optional
Disks in a plex are normally required to come from the same spare pool. Similarly, disks in different plexes of a mirrored aggregate are required to come from different spare pools. This behavior is overridden with this option when it is set to true. Default value is false.
- is-mirrored => boolean, optional
Specifies that the new aggregate be mirrored (have two plexes). If set to true, then the indicated disks will be split across the two plexes. By default, the new aggregate will not be mirrored.
- mirror-disks => disk-info[], optional
List of mirror disks to use. It must contain the same number of disks specified in "disks".
- nodes => node-name[], optional
Target node to create aggregate. If no node name is provided, aggregate will be created on the local node. If one node name is provided, aggregate(striped or not_striped based on the striping input) will be created on that node.When multiple nodes are specified, striped aggregate will be created across multiple nodes.
- pre-check => boolean, optional
Only check for the warnings without actually creating the aggregate. This option cannot be used when "simulate" is specified. Default value is false.
- raid-size => integer, optional
Specifies the maximum number of disks in each RAID group in the aggregate. The maximum value for this parameter is 28. The default value is platform- dependent. The valid range of values is also platform-dependent, but never wider than [2..28].
- raid-type => string, optional
Specifies the type of RAID groups to use in the new aggregate. Possible values: raid4, raid_dp. The default value is raid4 on most platforms.
- rpm => integer, optional
Rotational speed of disks in revolutions per minute. Possible values are: 5400, 7200, 10000, and 15000. This option is needed only when disks with different rotational speeds are connected to the filer. It is not allowed if a list of disks to use is specified through the "disks" parameter.
- striping => striping-type, optional
Specifies the striping information about new aggregate. The only allowed values are "striped" and "not_striped". Default value is "not_striped". "striped" value creates striped aggregate on node. This attribute is not allowed in unclustered environments. EINVALIDINPUTERROR is returned if value is other than "striped" and "not_striped". EOP_CLUSTER_ATTR_DISALLOWED is returned if this attribute is used in unclustered environments. EOP_DISALLOWED_ON_CFO_AGGR is returned if this attribute is set to "striped" when aggregate being created with 'cfo' HA policy.
Outputs
- bad-disks => disk-info[], optional
List of disks that were not added. This is only returned if there are bad disks.
- pre-check-results => warning-code[], optional
Result of the pre-check for possible warnings. Possible warning codes are: - E_WARN_EXCEEDS_HALF_CLUSTER_SIZE
- E_WARN_DISK_DOWNSIZE
- E_WARN_LOW_SPARE
[Family: cluster]
Destroys the specified aggregate or plex. If an aggregate is specified, all plexes in the aggregate are destroyed. If the aggregate is embedded in a traditional volume, then the entire traditional volume is destroyed. If a plex is specified, only that plex is destroyed, leaving an unmirrored aggregate containing the remaining plex. The disks in the destroyed object become spare disks. Only offline aggregates and plexes can be destroyed. Note: Offline aggregates will be destroyed even if they contain one or more flexible volumes, which should not typically be the case. From cluster interface only aggregates are supported and plexes are not supported.Inputs
- aggregate => string
Name of the existing aggregate or plex to be destroyed, using the following format: [/vol/][] UUID can be specified instead of aggregate name. See the synopsis for name/UUID format and restrictions.
Outputs
[Family: cluster]
Get information on what possibilities and parameters exist for aggregates on a given filer.Inputs
Outputs
- 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, Block Appended and Advanced Zoned),
- "none" - if no aggregates have zoned or advanced_zoned checksum (azcs) or block checksums,
- "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", "mixed_raid_type".
- 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 are 520 BPS, "4096" if all disks are 4096 BPS, "mixed" if disks are mixed 512, 520 and 4096 BPS, "none" if no disks have 512 or 520 or 4096 BPS.
- max-named-disks-per-request => integer
The maximum number of named disks which can be specified to 'aggr add', 'aggr create', or 'agg mirror' operation. Disk addition process may fail if the specified number of named disk is more than this limit. This value is the maximum number of disk entries which can be specified in 'disks' or 'mirror-disks' argument of 'aggr-create' and 'aggr-add' api. Range : [0..2^31-1].
[Family: cluster]
Iterate over a list of aggrgate objects.Inputs
- 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
[Family: cluster]
Turns an unmirrored aggregate into a mirrored aggregate by adding a plex to it. The plex is either newly formed from disks chosen from a spare pool or, if the "victim-aggregate" option is specified, taken from another existing unmirrored aggregate. The named aggregate must currently be unmirrored. Disks may be specified explicitly using the "mirror-disks" list option in the same way as with the "aggr-create" and "aggr-add" commands. The number of disks indicated must match the number present in the existing aggregate. If disks are not specified explicitly, then disks are automatically selected to match those in the aggregate's existing plex.Inputs
- aggregate => string
Name of the existing aggregate to be mirrored. UUID can be specified instead of aggregate name. See the synopsis for name/UUID format and restrictions.
- allow-mixed-rpm => boolean, optional
Disks in an aggregate are normally required to have the same RPM. This behavior is overridden with this option when it is set to true. Default value is false.
- 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. This option has an effect only when disks to be used are specified in 'disks'. This option is ignored when 'disk-count' is used.
- 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. Also, the victim cannot normally be accepted when it is owned by one or more vfilers. All these safety-driven behaviors are overridden when this option is set to true. This is a deprecated parameter. Use the allow-mixed-rpm and ignore-pool-checks parameters instead.
- ignore-pool-checks => boolean, optional
Disks in a plex are normally required to come from the same spare pool. Similarly, disks in different plexes of a mirrored aggregate are required to come from different spare pools. This behavior is overridden with this option when it is set to true. Default value is false.
- mirror-disks => disk-info[], optional
Specific list of mirror disks to add. This list must match the number of disks present on the existing aggregate. The specified disks are not permitted to span disk pools unless overridden with the "force-spare-pool" option.
- override-vfiler-ownership => boolean, optional
The victim aggregate cannot normally be accepted when it is owned by one or more vfilers. This option may be set to true in order to override that restriction. The option is ignored if 'victim-aggregate' is not specified.
- pre-check => boolean, optional
Only check for the warnings without actually mirroring the aggregate. Default value is false.
Outputs
- bad-disks => disk-info[], optional
List of disks that were not added. This is only returned if there are bad disks.
- pre-check-results => warning-code[], optional
Result of the pre-check for possible warnings. - E_WARN_DISK_DOWNSIZE
- E_WARN_LOW_SPARE
[Family: cluster]
Modify the RAID type for the given aggregate to the specified "raid-type". This API can also selectively change the RAID type of specific raid groups in the aggregate based on the specified "disk-type". The change remains effective even if the filer is rebooted. This API does not support modifying options of a striped aggregate.Inputs
- aggregate => string
Name or UUID of the aggregate whose option is to be set. See the synopsis for name/UUID format and restrictions.
- disk-type => string, optional
Type of disks to use : ATA, BSAS, FCAL, FSAS, LUN, SAS, SATA, or SSD. This option is required if we want to change the raid type of raid groups created out of the specified disks only. Otherwise, if this is not specified then the raid type for all raid groups in the aggregate would change.
- raid-type => string
possible values: "raid4","raid_dp" The type of RAID group used for this aggregate. 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 the RAID groups in the aggregate. When upgrading RAID groups from "raid4" to "raid_dp", each RAID group begins a reconstruction onto a spare disk allocated for the second "dparity" parity disk.
Outputs
[Family: cluster]
Take the specified aggregate or plex offline. The operation takes effect before the API returns. Except in maintenance mode, the current root aggregate may not be taken offline. An aggregate marked to become the root aggregate cannot be taken offline. An aggregate containing one or more flexible volumes cannot be taken offline; its contained volumes must first be destroyed. A number of operations being performed on the given aggregate can prevent this operation from succeeding, either at all or for various lengths of time. If such operations are found, the system waits up to one second for them to finish. If they don't, the command is aborted. A check is also made for files in the aggregate opened by internal Data ONTAP processes. The command is aborted if any are found.Inputs
- aggregate => string
Name of the existing aggregate or plex to offline, using the following format: [[/vol]/][] UUID can be specified instead of aggregate name. See the synopsis for name/UUID format and restrictions. If the aggregate hosts any online volumes, then the offline request will fail unless the optional "unmount-volumes" argument (see below) appears and is set to TRUE. If we've been cleared to unmount any such online volumes hosted by the aggregate, the caller may also specify the number of seconds to wait should any of those volumes have active CIFS shares through the optional "cifs-delay-seconds" argument (see below). If a plex name is specified, the plex must be part of a mirrored aggregate, 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. For ontap-cluster, plexinfo is being deprecated in lieu of the plex parameter.
- plex => string, optional
Name of a particular plex to offline. If no plex is specified, then the aggregate will be taken offline. If a plex is specified, the plex must be part of a mirrored aggregate, 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.
- unmount-volumes => boolean, optional
If set to "TRUE", this option specifies that all of the volumes hosted by the given aggregate are to be unmounted before the offline operation is executed. By default, the system will reject any attempt to offline an aggregate that hosts one or more online volumes.
Outputs
[Family: cluster]
Bring the specified aggregate or plex online. This command takes effect immediately. All volumes on the aggregate are brought to whatever state they were in before the aggregate was restricted or taken offline. If there are CIFS shares associated with the any of the aggregate's volumes that were also onlined, they are enabled.Inputs
- aggregate => string
Name of the existing aggregate or plex to online, using the following format: [/vol/][] UUID can be specified instead of aggregate name. See the synopsis for name/UUID format and restrictions. If an aggregate is specified, it must currently be offline, restricted, or foreign (consisting of disks moved from another filer, and never having been brought online on the current filer). If the aggregate is foreign, it will be made native before being brought online on the current filer. Aggregates that aren't foreign are termed "native". If the aggregate 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 aggregate) prior to bringing it online. Bringing an inconsistent aggregate online increases the risk of further file system corruption. If the aggregate is inconsistent and has experienced possible loss of data, it can't be brought online unless WAFL_check or wafliron (or snapmirror initialize) is run on it. If a plex is specified, it must be part of an online mirrored aggregate. The system initiates resynchro- nization of the plex as part of online processing. For ontap-cluster, plexinfo is being deprecated in lieu of the plex parameter.
- force-online => boolean, optional
An aggregate can not normally be brought online under the following conditions: 1. It has only 1 plex that is offline and not up-to-date. 2. It is an unmirrored or CFO aggregate that has been switched over to its DR partner as part of an MCC configuration. This behavior is overridden when this option is set "true". By default, "force-online" is "false".
- plex => string, optional
Name of a particular plex to online. If no plex is specified, then the aggregate will be onlined. If a plex is specified, it must be part of an online mirrored aggregate. The system initiates resynchro- nization of the plex as part of online processing.
Outputs
[Family: cluster]
Get the options that have been set for the specified aggregate. This API does not support listing options of striped aggregate.Inputs
- aggregate => string
Name or UUID of the aggregate whose options to retrieve. See the synopsis for name/UUID format and restrictions.
Outputs
[Family: cluster]
Aggregate RelocationInputs
- is-override-destination-checks => boolean, optional
Override checks done on destination node. This option could be used to force a relocation of aggregates even if the destination has outstanding issues. Note that this could make the relocation dangerous or disruptive. Default: false
- is-override-vetoes => boolean, optional
Override veto checks for relocating an aggregate. Initiating aggregate relocation with vetoes overridden will result in relocation proceeding even if the node detects outstanding issues that would make aggregate relocation dangerous or disruptive. Default: false
- is-relocate-to-higher-version => boolean, optional
Relocate to a node running higher major Data ONTAP version. If an aggregate is relocated to this destination then that aggregate cannot be relocated back to the source node till the source is also upgraded to the same or higher Data ONTAP version. This option is not required if the destination is running on higher minor version but the same major version. Default: false
Outputs
[Family: cluster]
Iterate over the list of aggregate relocation statusInputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 aggr objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Rename the specified aggregate.Inputs
- aggregate => string
Name or UUID of the aggregate to rename. See the synopsis for name/UUID format and restrictions.
Outputs
[Family: cluster]
Restrict the specified aggregate. If the aggregate is embedded in a traditional volume, the entire traditional volume will be restricted. An aggregate with one or more flexible volumes cannot be restricted; all of its contained volumes must first be destroyed.Inputs
- aggregate => string
Name or UUID of the aggregate to restrict. See the synopsis for name/UUID format and restrictions.
- unmount-volumes => boolean, optional
If set to "TRUE", this option specifies that all of the volumes hosted by the given aggregate are to be unmounted before the restrict operation is executed. By default, the system will reject any attempt to restrict an aggregate that hosts one or more online volumes.
Outputs
[Family: cluster]
Get the status of parity scrubbing on the named aggregate. Status includes percentage complete and the scrub's suspended status (if appropriate). If no name is given, then status is generated for all RAID groups.Inputs
- 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
[Family: cluster]
Resume parity scrubbing on the named aggregate, plex, or RAID group. If no name is given, then resume parity scrubbing on all RAID groups for which it has been suspended. Use "aggr-scrub-list-info" to check scrubbing status.Inputs
- aggregate => string, optional
Name or UUID of the entity for which scrubbing is to resume. See the synopsis for name/UUID format and restrictions.
- plex => string, optional
If provided, this specifies the plex name. ex. plex0 Must be used in conjunction with aggregate input.
Outputs
[Family: cluster]
Start parity scrubbing on the named aggregate, plex, or RAID group. Parity scrubbing compares the data disks to the parity disk in a RAID group, correcting the parity disk's contents as necessary. If no name is given, then parity scrubbing is started on all online aggregates. If an aggregate name is given, scrubbing is started on all RAID groups in the aggregate. If a plex name is given, scrubbing is started on all RAID groups contained in the plex. If a RAID group name is given, scrubbing is started only on that group. Use "aggr-scrub-list-info" to check scrubbing status.Inputs
- aggregate => string, optional
Name or UUID of the entity for which scrubbing is to start. See the synopsis for name/UUID format and restrictions.
- plex => string, optional
If provided, this specifies the plex name. ex. plex0 Must be used in conjunction with aggregate input.
- raidgroup => string, optional
If provided, this specifies the RAID group. ex. rg2 Must be used in conjunction with aggregate and plex inputs.
Outputs
[Family: cluster]
Stop parity scrubbing on the named aggregate, plex, or RAID group. If no name is given, scrubbing will stop on all RAID groups currently being scrubbed. Use "aggr-scrub-list-info" to check scrubbing status.Inputs
- aggregate => string, optional
Name or UUID of the entity for which scrubbing is to stop. See the synopsis for name/UUID format and restrictions.
- plex => string, optional
If provided, this specifies the plex name. ex. plex0 Must be used in conjunction with aggregate input.
- raidgroup => string, optional
If provided, this specifies the RAID group. ex. rg2 Must be used in conjunction with aggregate and plex inputs.
Outputs
[Family: cluster]
Suspend parity scrubbing on the named aggregate, plex, or RAID group. If no name is given, suspend scrubbing on all RAID groups currently being scrubbed. Use "aggr-scrub-list-info" to check scrubbing status.Inputs
- aggregate => string, optional
Name or UUID of the entity for which scrubbing is to suspend. See the synopsis for name/UUID format and restrictions.
- plex => string, optional
If provided, this specifies the plex name. ex. plex0 Must be used in conjunction with aggregate input.
- raidgroup => string, optional
If provided, this specifies the RAID group. ex. rg2 Must be used in conjunction with aggregate and plex inputs.
Outputs
[Family: cluster]
Set the specified option for the given aggregate to "option-value". The change remains effective even if the filer is rebooted. Some options have values that are numbers, and some have values that are "on" (also expressible as "yes", "true", or "1" ) or "off" (also expressible as "no", "false", or "0"). A mixture of uppercase and lowercase characters may be used when typing an option's value. Note that the "root" option is special in that it doesn't have a corresponding value. This API does not support modifying options of striped aggregate.Inputs
- aggregate => string
Name or UUID of the aggregate whose option to be set. See the synopsis for name/UUID format and restrictions.
- option-name => string
Option name. Possible values: - "free_space_realloc" (value: "on" | "off" | "no_redirect")
- Setting this option to "on" enables free space reallocation (continuous segment cleaning) on a block checksum aggregate. Possible values : on, off, no_redirect "on" : Free space reallocation enabled with automatically starting the redirect scanner "off": Free space reallocate disabled "no_redirect": Free space reallocation enabled without running the redirect scanner The default value for this option is "off"
- "fs_size_fixed" (value: "on" | "off")
- Setting this option to "on" causes the file system to remain the same size (and not grow) when the mirror is broken on a SnapMirrored aggregate (which MUST be embedded in a traditional volume), or when an "aggr add" is performed on it. This option is automatically set to be "on" when an aggregate becomes SnapMirrored. It remains "on" after the "snapmirror break" command is issued for an aggregate embedded in a traditional volume. This option allows an embedded aggregate to be SnapMirrored back to the source without needing to add disks to the source aggregate. If the aggregate size is larger than the file system size, turning off this option forces the file system to grow to the size of the aggregate. This option is not supported when the request is sent to the Admin Vserver LIF.
- "ha_policy" (value: "cfo" | "sfo")
- This option is used to change the HA policy of given aggregate and restricted to clustered environments. It is not allowed in unclustered environments. Also this option does not apply to traditional volume. Changing the HA policy of an aggregate from SFO to CFO is allowed only in Maintenance mode. HA policy can not be changed if: 1. aggregate is striped. 2. aggregate contains node volumes. 3. aggregate is root. 4. aggregate is partner aggregate during takeover i.e. when it is not home to local node. EOP_CLUSTER_ATTR_DISALLOWED is returned if this option is used in unclustered environments. EOP_DISALLOWED_ON_STRIPED_AGGR is returned if this option is used with striped aggregate. EOP_DISALLOWED_ON_AGGR_WITH_NODE_VOLS is returned if this option is used on aggregate which contains node volumes. EOP_DISALLOWED_ON_ROOT_AGGR is returned if this option is used on root aggregate. EOP_DISALLOWED_ON_NOT_HOME_AGGR is returned if this option is used on partner aggregate during takeover.
- "ignore_inconsistent" (value: "on" | "off")
- This command can only be used in maintenance mode. If this option is set to "on", then the root aggregate 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. This option is not supported when the request is sent to the Admin Vserver LIF.
- "lost_write_protect" (value: "on" | "off")
- Setting this option to "off" disables lost write protection on the aggregate. The default is "on". The user is cautioned that turning off this option may expose the filesystem(s) contained in the aggregate to data loss and data corruption. This option should not be disabled, unless directed to do so by support personnel.
- "max_write_alloc_blocks" (value: value: < number >)
- 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"
- "striping" (value: "striped" | "not_striped")
- This option sets the striping information of given aggregate. It is restricted to clustered environments and not allowed in unclustered environments. When set to true, it marks given aggregate as member of stripe. This option is not allowed if given aggregate is of 'cfo' HA policy. Also this option does not apply to traditional volume. EOP_CLUSTER_ATTR_DISALLOWED is returned if this option is used in unclustered environments. EOP_DISALLOWED_ON_CFO_AGGR is returned if given aggregate is of 'cfo' HA policy. This option is not supported when the request is sent to the Admin Vserver LIF.
- "nosnap" (value: "on" | "off")
- Setting this option to "on" disables automatic snapshots on the aggregate.
- "raid_cv" (value: "on" | "off")
- Setting this option to "off" disables block or advanced_zoned checksum (azcs) protection on the aggregate. The default is "on". The user is cautioned that turning off this option exposes the filesystems contained in the aggregate to inconsistency that could be caused by a misbehaving hardware component in the system.
- "raid_lost_write" (value: "on" | "off")
- Setting this option to "off" disables RAID Lost Write protection on the aggregate. The default is "on". The user is cautioned that turning off this option may expose the filesystem(s) contained in the aggregate to data loss and data corruption. The option should not be disabled, unless directed to do so by support personnel.
- "raid_zoned" (value: "on" | "off")
- Setting this option to "off" disables zoned checksum protection on the aggregate. The default is "on". The user is cautioned that turning off this option exposes the filesystems contained in the aggregate to inconsistency that could be caused by a misbehaving hardware component in the system.
- "raidsize" (value: < number >>)
- The maximum size of a RAID group within the aggregate. 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.
- "cache_raid_group_size" (value: < number >>)
- The current maximum size of a SSD RAID group within the hybrid aggregate. This option can only be modified for hybrid aggregate. 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 existing SSD RAID group in the future, and how large new SSD RAID groups will be.
- "raidtype" (value: "raid4" | "raid_dp" | "raid0")
- The type of RAID group used for this aggregate. 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 aggregate. When upgrading RAID groups from "raid4" to "raid_dp", each RAID group begins a reconstruction onto a spare disk allocated for the second "dparity" parity disk.
- "resyncsnaptime" (value: < number >)
- Sets the mirror resynchronization snapshot frequency to be the given number of minutes. The default value is 60 (minutes).
- "root" (value: < none >)
- The specified aggregate is to become the root aggregate for the filer on the next reboot. This option can be used only in maintenance mode and on only one aggregate at any given time. The existing root aggregate will become a non-root aggregate after the reboot. Until the system is rebooted, the original aggregate will continue to show root as an option, and the new root aggregate will show diskroot as an option. In general, the aggregate that has the diskroot option is the one that becomes the root aggregate following the next reboot. The only way to remove the root status of an aggregate is to set it on another aggregate. In clustered environments, this option is not allowed with aggregates with 'sfo' HA policy as root has to be an aggregate with 'cfo' HA policy. EOP_DISALLOWED_ON_SFO_AGGR is returned if given aggregate is of 'sfo' HA policy.
- "snapmirrored" (value : "off")
- If SnapMirror is enabled, the filer auto- matically sets this option to "on". Set this option to "off" with the "snapmirror" command if SnapMirror should no longer be used to update the mirror. After setting this option to "off", the mirror becomes a regular writable aggregate, and all its volumes are restored to whatever state they were last in. Note that it is not possible to set this option directly through this interface. Rather, it is automatically changed as a side effect of running the appropriate "snapmirror" commands. This option is not supported when the request is sent to the Admin Vserver LIF.
- "snapshot_autodelete" (value: "on" | "off")
- Setting this option to "off" disables automatic snapshot deletion on the aggregate.
- "thorough_scrub" (value: "on" | "off")
- Setting this option to "on" enables thorough scrub on a block checksum aggregate. 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.
- "percent_snapshot_space" (value: < number >)
- Percentage of total blocks in the aggregate reserved for snapshots.
- "hybrid_enabled" (value: "true" | "false")
- Setting this option to "true" would mark the aggregate as hybrid_enabled. That means the aggregate can contain a mix of SSDs and HDDs(Hard Disk Drives, e.g., SAS, SATA, and/or FC). The operation can be forced by using the hybrid_enabled_force option for the aggregates having flexvols which cannot be write cached. EAGGR_CANT_UNDO_HYBRID is returned when we are trying to set the option hybrid_enabled to false on an aggregate that already contains a mix of HDDs and SSDs. EAGGR_HYBRID is returned when we are trying to set option hybrid_enabled to true on an aggregate which is already hybrid. EOP_DISALLOWED_WORM_HYBRID_AGGR is returned when we are trying to set option hybrid_enabled to true on an snaplock aggregate. ERAID_HYA_SUPPORT_DISABLED is returned when the partner node in HA pair is running a version of Data ONTAP which does not support hybrid aggregates. EOP_DISALLOWED_ON_SSD_AGGR is returned if this option is used on aggregates created out of SSD disks. EOP_DISALLOWED_HYA_ON_RAID0_AGGR is returned if this option is used on raid0 aggregates. EOP_DISALLOWED_HYA_ON_ZONED_AGGR is returned if this option is used on aggregates with zoned checksums. EOP_DISALLOWED_HYA_ON_LUNS_AGGR is returned if this option used on aggregates created out of LUNs.
- "hybrid_enabled_force" (value: "true" | "false")
- Setting this option to "true" would mark the aggregate as hybrid_enabled. That means the aggregate can contain a mix of SSDs and HDDs(Hard Disk Drives, e.g., SAS, SATA, and/or FC). This option is used for force marking of aggregates having flexvols which cannot be write cached as hybrid enabled. FlexVols in the aggregate marked as hybrid enabled using this option which cannot participate in write-caching only have read-caching enabled. All other flexvols in the aggregate can participate in both read and write caching. EAGGR_CANT_UNDO_HYBRID is returned when we are trying to set the option hybrid_enabled_force to false on an aggregate that already contains a mix of HDDs and SSDs. EAGGR_HYBRID is returned when we are trying to set option hybrid_enabled_force to true on an aggregate which is already hybrid. EOP_DISALLOWED_WORM_HYBRID_AGGR is returned when we are trying to set option hybrid_enabled_force to true on an snaplock aggregate. ERAID_HYA_SUPPORT_DISABLED is returned when the partner node in HA pair is running a version of Data ONTAP which does not support hybrid aggregates. EOP_DISALLOWED_ON_SSD_AGGR is returned if this option is used on aggregates created out of SSD disks. EOP_DISALLOWED_HYA_ON_RAID0_AGGR is returned if this option is used on raid0 aggregates. EOP_DISALLOWED_HYA_ON_ZONED_AGGR is returned if this option is used on aggregates with zoned checksums.
- option-value => string
The value to set the named option. It may be the NULL/empty value only in the case of the "root" option.
Outputs
[Family: cluster]
Get the status of RAID mirror verification on the named aggregate. Status includes percentage complete and whether it's currently suspended.Inputs
- aggregate => string, optional
Name of an existing aggregate. If no name is given, then mirror verification status is generated for all aggregates currently being verified. UUID can be specified instead of aggregate name. See the synopsis for name/UUID format and restrictions.
Outputs
[Family: cluster]
Resume RAID mirror verification on the named aggregate. If no name is given, then resume mirror verification on all aggregates that have been suspended.Inputs
- aggregate => string, optional
Name of the existing aggregate for which mirror verification is to resume. UUID can be specified instead of aggregate name. See the synopsis for name/UUID format and restrictions.
Outputs
[Family: cluster]
Start RAID mirror verification on the named aggregate. Verification compares the data in both plexes of a mirrored aggregate. In the default case, any blocks that differ are logged and no changes are made. The fix-plex option is used to fix any mismatches. It specifies which plex to fix. If no name is given, then mirror verification is started on all online aggregates. Use the "aggr-verify-list-info" API to check mirror verification status. If the fix-plex option is used, then a name must be specified.Inputs
- aggregate => string, optional
Name of the mirrored aggregate to verify. UUID can be specified instead of aggregate name. See the synopsis for name/UUID format and restrictions.
- 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.
Outputs
[Family: cluster]
Stop RAID mirror verification on the named aggregate. If no name is given, stop mirror verification on all aggregates currently being verified.Inputs
- aggregate => string, optional
Name of the aggregate for which we are to stop mirror verification. UUID can be specified instead of aggregate name. See the synopsis for name/UUID format and restrictions.
Outputs
[Family: cluster]
Suspend RAID mirror verification on the named aggregate. If no name is given, suspend mirror verification on all aggregates currently being verified.Inputs
- aggregate => string, optional
Name of the aggregate for which we are to suspend mirror verification. UUID can be specified instead of aggregate name. See the synopsis for name/UUID format and restrictions.
Outputs
[Family: cluster]
This gets the attributes of the Anti-Virus engine installed.Inputs
Outputs
- license-type => string
Vendor-specific license type. Possible values: - "full" - full license
- "eval" - evaluation license
- "none" - no license
- seats => integer
Number of nodes that can run an instance of the AV software Range : [0..2^32-1]
[Family: cluster]
Get the attributes of the antivirus.Inputs
Outputs
[Family: cluster]
Get the attributes of the antivirus.Inputs
- datetime => integer
When the event is logged. The time value is in seconds since January 1, 1970.
Outputs
[Family: cluster]
This gets the remedy information of the Anti-Virus engine installed. i.e. what to do when a virus is found.Inputs
Outputs
- action => string
The remedy action desired. Possible values: - "none" - no action will be taken
- "repair" - file will be reparied
- "delete" - file will be deleted
- "quarantine" - file will be quarantined
- option => string
The option of the remedy action desired. Possible values: - "move" - file will be moved
- "add_extension" - an extencion will be added to the file
- repair => string
The failed repair option to try. Possible values: - "none" - no action will be taken
- "delete" - file will be deleted
- "quarantine" - file will be quarantined
[Family: cluster]
This gets the version information of the Anti-Virus engine installed.Inputs
Outputs
[Family: cluster]
Iterate over a list of antivirus objects.Inputs
- desired-attributes => av-event-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 => av-event-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the antivirus object. All antivirus 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 antivirus objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
This sets the attributes of the Anti-Virus engine installed. If an optional attribute is not specified, the current value is left unchanged.Inputs
Outputs
[Family: cluster]
Modify the attributes of antivirus object.Inputs
Outputs
[Family: cluster]
Create a new antivirus.Inputs
- datetime => integer
When the event is logged. The time value is in seconds since January 1, 1970.
Outputs
[Family: cluster]
This sets the quarantine information of the Anti-Virus engine installed. If an optional attribute is not specified, the current value is left unchanged.Inputs
- action => string, optional
The remedy action desired. Possible values: - "none" - no action will be taken
- "repair" - file will be reparied
- "delete" - file will be deleted
- "quarantine" - file will be quarantined
- option => string, optional
The option of the remedy action desired. Possible values: - "move" - file will be moved
- "add_extension" - an extencion will be added to the file
- repair => string, optional
The failed repair option to try. Possible values: - "none" - no action will be taken
- "delete" - file will be deleted
- "quarantine" - file will be quarantined
Outputs
[Family: cluster]
This sets the version information of the Anti-Virus engine installed. If an optional attribute is not specified, the current value is left unchanged.Inputs
- cluster-version => string
The current cluster version of the engine. If this does not correspond to the current cluster version of the engine, then the ZAPI fails.
- component-updated => string, optional
The component that was updated. Possible values: - "engine" - only antivirus engine was updated
- "vde" - only virus definition files were updated
- "both" - both antivirus engine and virus definition files were updated
Outputs
[Family: cluster]
Run an Anti-Virus Update job immediatelyInputs
Outputs
[Family: cluster]
Get the cluster administrative audit settingsInputs
- desired-attributes => audit-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
[Family: cluster]
Modify the cluster administrative audit settingsInputs
Outputs
[Family: cluster]
Get AutoSupport time and size limits for the given node and subsystem.Inputs
- node-name => string
The name of a filer on which the AutoSupport tool is running.
- subsystem => asup-subsystems
The name of a subsystem from which AutoSupport collects data. Possible values: - "platform" - Hardware information about the node,
- "mhost" - User Space application information for a node,
- "log_files" - Log files for a node,
- "performance" - This subsystem gathers the .cm_stats_hourly_done file and user space counters,
- "performance_asup" - Performance specific information for a node,
- "nht" - This subsystem gathers the /mroot/etc/log/nht_info content,
- "san" - SAN specific information for a node,
- "snapvault" - SNAPVAULT specific information for a node,
- "snapmirror" - Snapmirror specific information for a node,
- "dedupe" - Dedupe specific information for a node,
- "nfs" - NFS specific information for a node,
- "wafl" - WAFL specific information for a node,
- "mot" - MOT specific information for a node,
- "ha" - HA specific information for a node,
- "networking" - Networking specific information for a node,
- "cifs" - CIFS specific information for a node,
- "fpolicy" - Fpolicy specific information for a node,
- "multistore" - Multistore specific information for a node,
- "raid" - RAID specific information for a node,
- "storage" - Storage specific information for a node,
- "asup_ems" - ASUP EMS specific information for a node,
- "tape" - Tape specific information for a node,
- "kernel" - kernel specific information for a node,
- "secd" - SECD specific information for a node,
- "metrocluster" - Metrocluster specific information for a node,
- "mandatory" - Mandatory Basic information for a node,
- "repository" - Repository specific information for a node,
- "splog_downcontroller" - SPLOG saved when ontap is abnormal down,
- "splog_latest" - Up-to-date SPLOG from Service Processor FW ,
- "splog_before_spreboot" - Up-to-date SPLOG from Service Processor FW before SP reboot,
- "hm" - Health Monitor Alerts specific information,
- "kcs" - Kernel Cluster Services information for a node,
- "av" - Antivirus specific information for a node,
- "san_ffdc" - SAN specific trace dumps for a node,
- "nwd" - Node Watchdog specific information for a node
Outputs
[Family: cluster]
Get AutoSupport time and size limits per subsystem for all nodes.Inputs
- desired-attributes => autosupport-budget-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
- 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 autosupport-budget objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Return the total number of records.Inputs
Outputs
[Family: cluster]
Modify AutoSupport time and size limits per subsystem.Inputs
- node-name => string
The name of a filer on which the AutoSupport tool is running.
- subsystem => asup-subsystems
The name of a subsystem from which AutoSupport collects data. Possible values: - "platform" - Hardware information about the node,
- "mhost" - User Space application information for a node,
- "log_files" - Log files for a node,
- "performance" - This subsystem gathers the .cm_stats_hourly_done file and user space counters,
- "performance_asup" - Performance specific information for a node,
- "nht" - This subsystem gathers the /mroot/etc/log/nht_info content,
- "san" - SAN specific information for a node,
- "snapvault" - SNAPVAULT specific information for a node,
- "snapmirror" - Snapmirror specific information for a node,
- "dedupe" - Dedupe specific information for a node,
- "nfs" - NFS specific information for a node,
- "wafl" - WAFL specific information for a node,
- "mot" - MOT specific information for a node,
- "ha" - HA specific information for a node,
- "networking" - Networking specific information for a node,
- "cifs" - CIFS specific information for a node,
- "fpolicy" - Fpolicy specific information for a node,
- "multistore" - Multistore specific information for a node,
- "raid" - RAID specific information for a node,
- "storage" - Storage specific information for a node,
- "asup_ems" - ASUP EMS specific information for a node,
- "tape" - Tape specific information for a node,
- "kernel" - kernel specific information for a node,
- "secd" - SECD specific information for a node,
- "metrocluster" - Metrocluster specific information for a node,
- "mandatory" - Mandatory Basic information for a node,
- "repository" - Repository specific information for a node,
- "splog_downcontroller" - SPLOG saved when ontap is abnormal down,
- "splog_latest" - Up-to-date SPLOG from Service Processor FW ,
- "splog_before_spreboot" - Up-to-date SPLOG from Service Processor FW before SP reboot,
- "hm" - Health Monitor Alerts specific information,
- "kcs" - Kernel Cluster Services information for a node,
- "av" - Antivirus specific information for a node,
- "san_ffdc" - SAN specific trace dumps for a node,
- "nwd" - Node Watchdog specific information for a node
Outputs
[Family: cluster]
Get AutoSupport compliance hash mappingInputs
Outputs
[Family: cluster]
Get AutoSupport compliance hash mappingInputs
- desired-attributes => autosupport-compliant-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
- 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 autosupport-compliant objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Return the total number of records.Inputs
Outputs
- count => integer
The total number of autosupport-compliant objects.
[Family: cluster]
Get AutoSupport configuration settings for the given node.Inputs
- node-name => string
The name of the filer that owns the AutoSupport configuration.
Outputs
[Family: cluster]
Get AutoSupport configuration settings for all nodes.Inputs
- desired-attributes => autosupport-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
- 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 autosupport-config objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Return the total number of records.Inputs
Outputs
- count => integer
The total number of autosupport-config objects.
[Family: cluster]
Modify AutoSupport configuration settings for the given node.Inputs
- is-enabled => boolean, optional
Specifies whether the AutoSupport daemon is enabled. When this setting is disabled, delivery of all AutoSupport messages is turned off.
- is-local-collection-enabled => boolean, optional
Used to enable / disable collection of AutoSupport data when the AutoSupport daemon is disabled. When this setting is true, collection of AutoSupport data will still be done if is-enabled is false.
- mail-hosts => string[], optional
The name of the mail server(s) used to deliver AutoSupport messages via SMTP. Both host names and IP addresses may be used as valid input. One can optionally specify a username/password for authentication with the mailserver(rfc4954).
- node-name => string
The name of the filer that owns the AutoSupport configuration.
Outputs
[Family: cluster]
Get the list of AutoSupport destinations for the given node.Inputs
- node-name => string
The name of the filer that owns this destination configuration.
Outputs
[Family: cluster]
Get the list of AutoSupport destinations for all nodes.Inputs
- desired-attributes => autosupport-destinations-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
- 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 autosupport-destinations objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Return the total number of records. This sould be equal to the number of nodes in the cluster.Inputs
Outputs
- count => integer
The total number of autosupport-destinations objects.
[Family: cluster]
Get a history record for the given AutoSupport.Inputs
- destination => asup-destination
The transport protocol for this AutoSupport message's destination. Possible values: - "smtp" ,
- "http" ,
- "noteto" ,
- "retransmit"
- node-name => string
The name of the filer where the AutoSupport message was previously generated.
Outputs
[Family: cluster]
Get the history records for the last 50 AutoSupport messages.Inputs
- desired-attributes => autosupport-history-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
- 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 autosupport-history objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Return the total number of records.Inputs
Outputs
- count => integer
The total number of autosupport-history objects.
[Family: cluster]
Selectively retransmit a previously collected AutoSupport message.Inputs
- seq-num => integer
AutoSupport Sequence Number
- size-limit => integer, optional
Transmit Size Limit for this AutoSupport.
Outputs
[Family: cluster]
Generate a new AutoSupport messageInputs
- force => boolean, optional
Force generation, even if AutoSupport is disabled in the system. The default value is false.
- node-name => string
The name of the filer on which the AutoSupport message will be generated.
- type => asup-invoke-style
The type of AutoSupport to generate. Possible values: - "test" - Test AutoSupport send and receive only,
- "performance" - Generate a Performance AutoSupport as requested by technical support,
- "all" - Send all AutoSupport data without time or size limit, as requested by technical support
- uri => string, optional
Alternate destination for the AutoSupport. If this field is omitted, the AutoSupport will be delivered to the currently configured destinations.
Outputs
[Family: cluster]
Get a detailed manifest for the contents of an AutoSupport.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 autosupport-manifest objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Return the total number of records.Inputs
Outputs
- count => integer
The total number of autosupport-manifest objects.
[Family: cluster]
Get the AutoSupport trigger data for the given node and EMS message.Inputs
Outputs
[Family: cluster]
Get a list of the AutoSupport trigger data for all nodes.Inputs
- desired-attributes => autosupport-trigger-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
- 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 autosupport-trigger objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Return the total number of records.Inputs
Outputs
- count => integer
The total number of autosupport-trigger objects.
[Family: cluster]
Modify the AutoSupport trigger data for the given node and EMS message.Inputs
- basic-additional => asup-subsystems[], optional
Additional Subsystems Reporting Basic Info Possible values: - "platform" - Hardware information about the node,
- "mhost" - User Space application information for a node,
- "log_files" - Log files for a node,
- "performance" - This subsystem gathers the .cm_stats_hourly_done file and user space counters,
- "performance_asup" - Performance specific information for a node,
- "nht" - This subsystem gathers the /mroot/etc/log/nht_info content,
- "san" - SAN specific information for a node,
- "snapvault" - SNAPVAULT specific information for a node,
- "snapmirror" - Snapmirror specific information for a node,
- "dedupe" - Dedupe specific information for a node,
- "nfs" - NFS specific information for a node,
- "wafl" - WAFL specific information for a node,
- "mot" - MOT specific information for a node,
- "ha" - HA specific information for a node,
- "networking" - Networking specific information for a node,
- "cifs" - CIFS specific information for a node,
- "fpolicy" - Fpolicy specific information for a node,
- "multistore" - Multistore specific information for a node,
- "raid" - RAID specific information for a node,
- "storage" - Storage specific information for a node,
- "asup_ems" - ASUP EMS specific information for a node,
- "tape" - Tape specific information for a node,
- "kernel" - kernel specific information for a node,
- "secd" - SECD specific information for a node,
- "metrocluster" - Metrocluster specific information for a node,
- "mandatory" - Mandatory Basic information for a node,
- "repository" - Repository specific information for a node,
- "splog_downcontroller" - SPLOG saved when ontap is abnormal down,
- "splog_latest" - Up-to-date SPLOG from Service Processor FW ,
- "splog_before_spreboot" - Up-to-date SPLOG from Service Processor FW before SP reboot,
- "hm" - Health Monitor Alerts specific information,
- "kcs" - Kernel Cluster Services information for a node,
- "av" - Antivirus specific information for a node,
- "san_ffdc" - SAN specific trace dumps for a node,
- "nwd" - Node Watchdog specific information for a node
- time-limit => string, optional
The data collection time budget for this trigger (in seconds). Content not collected will be marked as collection-truncated-time-limit in the manifest.
- trigger => string
EMS Message
- troubleshooting-additional => asup-subsystems[], optional
Additional Subsystems Reporting Troubleshooting Info Possible values: - "platform" - Hardware information about the node,
- "mhost" - User Space application information for a node,
- "log_files" - Log files for a node,
- "performance" - This subsystem gathers the .cm_stats_hourly_done file and user space counters,
- "performance_asup" - Performance specific information for a node,
- "nht" - This subsystem gathers the /mroot/etc/log/nht_info content,
- "san" - SAN specific information for a node,
- "snapvault" - SNAPVAULT specific information for a node,
- "snapmirror" - Snapmirror specific information for a node,
- "dedupe" - Dedupe specific information for a node,
- "nfs" - NFS specific information for a node,
- "wafl" - WAFL specific information for a node,
- "mot" - MOT specific information for a node,
- "ha" - HA specific information for a node,
- "networking" - Networking specific information for a node,
- "cifs" - CIFS specific information for a node,
- "fpolicy" - Fpolicy specific information for a node,
- "multistore" - Multistore specific information for a node,
- "raid" - RAID specific information for a node,
- "storage" - Storage specific information for a node,
- "asup_ems" - ASUP EMS specific information for a node,
- "tape" - Tape specific information for a node,
- "kernel" - kernel specific information for a node,
- "secd" - SECD specific information for a node,
- "metrocluster" - Metrocluster specific information for a node,
- "mandatory" - Mandatory Basic information for a node,
- "repository" - Repository specific information for a node,
- "splog_downcontroller" - SPLOG saved when ontap is abnormal down,
- "splog_latest" - Up-to-date SPLOG from Service Processor FW ,
- "splog_before_spreboot" - Up-to-date SPLOG from Service Processor FW before SP reboot,
- "hm" - Health Monitor Alerts specific information,
- "kcs" - Kernel Cluster Services information for a node,
- "av" - Antivirus specific information for a node,
- "san_ffdc" - SAN specific trace dumps for a node,
- "nwd" - Node Watchdog specific information for a node
Outputs
[Family: cluster]
Returns giveback status of all the aggregates in the cluster which are taken over or were given back.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 cf objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Forces one filer to take over its partner even though the filer detects an error that would otherwise prevent a takeover. For example, normally, if a detached or faulty interconnect cable between the filers causes the filers' NVRAM contents to be unsynchronized, takeover is disabled. However, this will allow the filer to take over its partner despite the unsynchronized NVRAM contents. cf-force-takeover is dangerous and can lead to data corruption; in almost all cases, use cf-takeover instead.Inputs
- node => string
This parameter is the name of the node which is doing a takeover of its partner.
Outputs
[Family: cluster]
Iterate over a list of cf objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 cf objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Get the host name of the partner. If the name is unknown, It will return partner-unknown.Inputs
- node => string
The node name is passed as an argument
Outputs
- partner => string
Host name of the partner or partner-unknown, if the host name is not known.
[Family: cluster]
Initiates a giveback of partner resources. Once the giveback is complete, the automatic takeover capability is disabled until the partner is rebooted. A giveback fails if outstanding CIFS sessions, active system dump processes, or other filer operations makes a giveback dangerous or disruptive.Inputs
- force => boolean, optional
When set to true, this allows a giveback to proceed even if there are outstanding CIFS sessions, active system dump processes, or other filer operations which makes a giveback dangerous or disruptive as long as it would not result in data corruption or filer error. When set to false, this does not allow a giveback to proceed if there are outstanding CIFS sessions, active system dump processes, or other filer operations which makes a giveback dangerous or disruptive. The default value is false.
- node => string
This parameter is the name of the node which performs giveback to its partner.
- only-cfo-aggregates => boolean, optional
When set to true, only the CFO HA-style aggregates (which includes the root aggregate) will be given back. This may be needed in the case when the partner node's VLDB and other such management applications are not properly working (they are required to be online for the SFO HA-style aggregates to start serving data), so it might not be possible to giveback SFO HA-style aggregates. When set to false, all the aggregates (CFO HA-style aggregates + SFO HA-style aggregates) will be given back. The default value is false.
- override-vetoes => boolean, optional
Some conditions cause attempts to giveback aggregates to be vetoed. When set to true, this allows the process of giveback of the aggregates to be initiated even in the face of such vetoes. When set to false, this does not allow the process of giveback of the aggregates to proceed if there are any vetoes. The default value is false.
- require-partner-waiting => boolean, optional
When set to true, this ensures that the process of giveback of the aggregates is not initiated if the partner is not up and waiting to receive them. When set to false, this allows the process of giveback of the aggregates to proceed even if the partner is not up and waiting to receive them. The default value is true.
Outputs
[Family: cluster]
Get useful information about statistics of hardware assisted takeover functionality.Inputs
- node => string
Node name of the filer for which the API is requested.
Outputs
[Family: cluster]
Get useful information about stats of hw_assist functionality.Inputs
- node => string
Node name of the filer for which the API is requested.
Outputs
[Family: cluster]
Get useful information about the status of hw_assist functionality.Inputs
- node => string
Node name of the filer for which the API is requested.
Outputs
[Family: cluster]
Validates the hardware-assisted takeover configuration. functionality.Inputs
- node => string
Node name of the filer for which the API is requested.
Outputs
- hwassist-test-result => string
This string corresponds to the result of the test. The possible outcomes are: Hwassist is not initialized No hw_assist hardware found. Partner is throttling alerts. Resource busy. Try again after some time. Hwassist hardware returned error. No response from partner. Timed out. Unexpected abort. Partner has taken over. Interconnect is down between nodes. Make sure partner is booted up.Run 'storage failover hwassist show' for details.
[Family: cluster]
Disables the takeover capability of this filer in the cluster.Inputs
- node => string
This parameter is the name of the node on which service is to be disabled
Outputs
[Family: cluster]
Enables the takeover capability of this filer in the cluster. This spawns a process to enable the serviceInputs
- node => string
This parameter is the name of the node on which service is to be enabled
Outputs
[Family: cluster]
Get useful information about the status of the high availability service. If the monitor is not initialized, this returns an error.Inputs
- node => string
This parameter is the name of the node for which High Availability service status is being requested
Outputs
- giveback-state => string, optional
Giveback state of the node. Possible values are: - nothing_to_gb - No partner aggregates owned by local node
- not_attempted_yet - Local node owns partner aggregates and a giveback has not been attempted yet
- giveback_in_progress - Giveback is in progress. Refer to current-giveback-module field to get the current module, the giveback process is in.
- giveback_failed_autogiveback_disabled - Previous giveback failed and auto giveback is disabled. Refer to current-giveback-module to get the module in which giveback process failed.
- giveback_failed_autogiveback_scheduled - Previous giveback failed and an auto giveback is scheduled. Refer to current-giveback-module to get the module in which giveback process failed. Refer time-until-autogiveback field to check time remaining before an auto giveback is initiated.
- previous_giveback_failed - Previous giveback failed. Refer to current-giveback-module to get the module in which giveback process failed.
- giveback_vetoed_no_di - Normal giveback not possible as disk inventory from partner has not yet been received
- giveback_vetoed_missing_disks - Normal giveback not possible as the partner is missing some of its files system disks
- autogiveback_scheduled - An auto giveback is scheduled Refer time-until-autogiveback field to check time remaining before an auto giveback is initiated.
- autogiveback_deferred - Auto giveback is deferred because the partner node was not ready to receive aggregates when the auto giveback timer expired. An auto giveback will be initiated as soon as the partner node is up and ready to receive aggregates.
- node_upgrade_in_progress - Local node owns partner's aggregates as part of node upgrade process
- sfo_aggr_giveback_failed - Giveback of SFO aggregates failed. Call cf-aggregate-giveback-status API for more information regarding giveback failure.
- sfo_aggr_giveback_in_progress - Giveback of SFO aggregates is in progress. Call cf-aggregate-giveback-status API for more information regarding giveback status.
- partial_giveback - Local node owns partner SFO aggregates
- partner_spare_disks_giveback_pending - Local node owns partner's spare disks
- interconnect-links => string, optional
States of the individual interconnect links e.g. VIA Interconnect is down (link 0 down, link 1 down) VIA Interconnect is up (link 0 down, link 1 up) VIA Interconnect is up (link 0 up, link 1 down)
- is-enabled => boolean
True, if the storage failover facility is enabled, false otherwise. Note that the facility can be enabled but takeover may not be possible due to various reason.
- local-firmware-state => string, optional
Local firmware state that will be communicated through interconnect to the partner - SF_OPERATOR_EXIT - operator completed
- SF_DEBUG_EXIT - debugger completed
- SF_PROGRESS - progress counter
- SF_IOERROR - I/O error
- SF_BADCKSUM - bad checksum
- SF_RESERVED - reserved
- SF_UNKNOWN - unknown
- SF_OPEN - initializing
- SF_POST - in power-on self test
- SF_BOOTING - booting
- SF_FAIL - boot failed
- SF_WAITING - waiting
- SF_OS_BOOTED - kernel loaded
- SF_UP - up
- SF_DEBUG - in debugger
- SF_OPERATOR - waiting for operator input
- SF_DUMPCORE - dumping core
- SF_HALT - halted
- SF_REBOOT - rebooting
- SF_GIVEWAIT - waiting for giveback
- SF_MBWAIT - waiting for cluster mailbox release
- SF_SPARECORE - dumping sparecore and ready to be taken-over
- SF_MDP - multi-disk panic
- SF_TO - in takeover
- SF_NOTO - takeover disabled
- SF_CLUSTERWAIT - waiting for cluster apps
- node-state => string, optional
State of the storage failover of the node. Possible values are: - connected - Partner is available for takeover
- takeover_scheduled - Partner is down and takeover is scheduled
- takeover_started - Takeover process has begun
- takeover - Currently controlling partner's resources.
- takeover_failed - Failed to takeover the partner
- giveback_partial_waiting - This node controls partner aggregates even though the node is not in takeover. And we're waiting for a connection to the partner.
- giveback_partial_connected - This node controls partner aggregates even though the node is not in takeover. The partner is available to receive the aggregates.
- waiting_for_root_aggr - Partner is controlling dblade's root aggregate If we're in this state, many other optional fields are not returned.
- waiting - Waiting for a connection to partner. Generally happens while partner is rebooting.
- in_maintenance_mode - node is in maintenance mode. In the mode it is not possible to determine more detailed information (e.g. cluster or not; takeover or not, etc).
- pending_shutdown - starting a takeover/giveback is inhibited due to a pending system shutdown.
- relocating_aggrs_before_takeover - node is relocating its SFO aggregates to its partner prior to a negotiated takeover.
- sfo_takeover_phase_done - Node is done with the SFO phase of takeover.
- sfo_takenover_phase_done - This node has relocated its SFO aggregates to its partner during an optimized negotiated takeover by its partner.
- sfo_takeover_phase_aborted - The SFO phase of takeover has been aborted. Refer to takeover-failure-reason field to check the reason.
- sfo_takenover_phase_aborted - This node has aborted the relocation of its SFO aggregates to its partner, during an optimized negotiated takeover by its partner.
- in_non_HA_mode - Node is not in HA mode
- cfo_takeover_failed - CFO phase of takeover failed
- sfo_takeover_in_progress - SFO phase of takeover of partner is in progress
- relocated_aggrs_before_takeover - node has relocated its SFO aggregates to its partner prior to a negotiated takeover.
- giveback_in_progress - Giveback is in progress. Refer to current-giveback-module field to get the current module, the giveback process is in.
- giveback_failed_autogiveback_disabled - Previous giveback failed and auto giveback is disabled. Refer to current-giveback-module to get the module in which giveback process failed.
- giveback_failed_autogiveback_scheduled - Previous giveback failed and an auto giveback is scheduled. Refer to current-giveback-module to get the module in which giveback process failed.
Refer to time-until-autogiveback field to check time remaining before an auto giveback is initiated. - previous_giveback_failed - Previous giveback failed. Refer to current-giveback-module to get the module in which giveback process failed.
- takeover_no_di - Local node is in takeover. A normal giveback is not possible as disk inventory from partner has not yet been received.
- takeover_partner_missing_disks - Local node is in takeover. A normal giveback is not possible as the patner is missing some of its file system disks.
- takeover_autogiveback_scheduled - Local node in takeover. An auto giveback is scheduled. Refer time-until-autogiveback field to check time remaining before an auto giveback is initiated.
- takeover_network_failure - Local node in takeover. The partner was taken over due to network failure.
- takeover_autogiveback_deferred - Local node in takeover. Auto giveback is deferred because the partner node was not ready to receive aggregates when the auto giveback timer expired. An auto giveback will be initiated as soon as the partner node is up and ready to receive aggregates.
- automatic_takeover_disabled_connected - Automatic takeover is disabled. Local node is connected to partner via HA interconnect. This happens only in debug builds when raid.panic.missing.disks is turned on from node CLI.
- automatic_takeover_disabled_waiting - Automatic takeover is disabled. Local node is waiting for partner node on HA interconnect. This happens only in debug builds when raid.panic.missing.disks is turned on from node CLI.
- ndo_upgrade_in_progress - Local node owns partner's aggregates as part of node upgrade process.
- own_aggr_non_local_connected - Local node owns aggregates of some other node in the cluster. Local node is connected to partner via HA interconnect. This is possible only during NDO double hop head upgrade.
- own_aggr_non_local_waiting - Local node owns aggregates of some other node in the cluster. Local node is waiting for partner on HA interconnect. This is possible only during NDO double hop head upgrade.
- clusterwait_connected - Connected to partner via HA interconnect. Local node waiting for cluster applications to come online.
- clusterwait_waiting - Waiting for partner on HA interconnect. Local node waiting for cluster applications to come online.
- error - There is an error with the system
User have to compare the return values case-insensitively.
- partner => string
Hostname of the partner. If the partner is unknown, returns an empty string. This is for 7G like output compatibility.
- partner-firmware-state => string, optional
Partner firmware state as communicated by the partner through interconnect - SF_OPERATOR_EXIT - operator completed
- SF_DEBUG_EXIT - debugger completed
- SF_PROGRESS - progress counter
- SF_IOERROR - I/O error
- SF_BADCKSUM - bad checksum
- SF_RESERVED - reserved
- SF_UNKNOWN - unknown
- SF_OPEN - initializing
- SF_POST - in power-on self test
- SF_BOOTING - booting
- SF_FAIL - boot failed
- SF_WAITING - waiting
- SF_OS_BOOTED - kernel loaded
- SF_UP - up
- SF_DEBUG - in debugger
- SF_OPERATOR - waiting for operator input
- SF_DUMPCORE - dumping core
- SF_HALT - halted
- SF_REBOOT - rebooting
- SF_GIVEWAIT - waiting for giveback
- SF_MBWAIT - waiting for cluster mailbox release
- SF_SPARECORE - dumping sparecore and ready to be taken-over
- SF_MDP - multi-disk panic
- SF_TO - in takeover
- SF_NOTO - takeover disabled
- SF_CLUSTERWAIT - waiting for cluster apps
- state => string, optional
connected - Partner is available for takeover takeover_scheduled - Partner is down and takeover is scheduled takeover_started - Takeover process has begun takeover - Currently controlling partner's resources. taken over - Partner is controlling filer's resources takeover_failed - Failed to takeover the partner sfo_takeover_phase - This node has asked its partner to relocate its SFO aggregates in preparation for takeover. This occurs when a user has initiated an optimized negotiated takeover. relocating_aggrs_before_takeover - This node is relocating its SFO aggregates to its partner during an optimized negotiated takeover by its partner. sfo_takeover_phase_done - This node is done with the SFO phase of an optimized negotiated takeover. sfo_takenover_phase_done - This node has relocated its SFO aggregates to its partner during an optimized negotiated takeover by its partner. sfo_takeover_phase_aborted - The SFO phase of takeover is aborted on this node during an optimized negotiated takeover of its partner. sfo_takenover_phase_aborted - This node has aborted the relocation of its SFO aggregates to its partner, during an optimized negotiated takeover by its partner. giving_back - Sendhome process in progress giveback_partial_waiting - This node controls partner aggregates even though the node is not in takeover. And we're waiting for a connection to the partner. giveback_partial_connected - This node controls partner aggregates even though the node is not in takeover. The partner is available to receive the aggregates. waiting_for_root_aggr - Partner is controlling dblade's root aggregate If we're in this state, many other optional fields are not returned. waiting - Waiting for a connection to partner. Generally happens while partner is rebooting. in_maintenance_mode - node is in maintenance mode. In the mode it is not possible to determine more detailed information (e.g. cluster or not; takeover or not, etc). pending_shutdown - starting a takeover/sendhome is inhibited due to a pending system shutdown. error - There is an error with the system User have to compare the return values case-insensitively.
- takeover-state => string, optional
Takeover state of the node. Possible values are: - takeover_failed - Takeover Failed
- sfo_takeover_in_progress - SFO phase of takeover of partner is in progress
- relocating_aggrs_before_takeover - Relocating aggregates to partner as a takeover was initiated by partner
- cfo_takeover_scheduled - CFO phase of takeover is scheduled
- relocated_aggrs_before_takeover - Relocated aggregates to partner after a takeover was initiated by partner
- takeover_by_partner_failed - A takeover attempt by partner failed. Refer to takeover-failure-reason field to check the reason for takeover failure.
- in_takeover - Node is in takeover
- takeover_started - A takeover is in progress
- takeover_scheduled - A takeover of partner is scheduled. Refer to time-until-takeover field to check time remaining till takeover.
- not_in_takeover - Local node is not in takeover
- time-until-auto-giveback => integer, optional
If state == takeover this is the countdown time in seconds until auto-giveback is started. The range of possible values is [0..2^31-1]. This attribute will be absent on output when the value is 0.
[Family: cluster]
Initiates a takeover of the storage partner. Takeover is done asynchronously; status may be monitored by calling the cf-status API and examining the state field. If automatic giveback is enabled then control will be returned to storage partner once it boots up.Inputs
- allow-disk-inventory-mismatch => boolean, optional
This allows takeover if disk inventory information is mismatched for non root volume disks. If mismatched, local node performance could degrade as what appears to be missing disks are rebuilt. NOTE:: When using this option and if some of partner's file system disks are not visible to local node, then after giveback those missing disks can create new failed aggregate with same name. So, if any aggregate is offline after giveback with same name then using "zapi_aggr_destroy", you have to destroy that offline aggregate.
- bypass-optimization => boolean, optional
The bypass-optimization option determines whether or not an optimized negotiated takeover is run. Optimized negotiated takeover refers to the serial relocation of SFO aggregates to the taking over node, prior to a negotiated takeover. This is an optimization because it reduces per-aggregate client outage times. If the bypass-optimization option is set to true, then the takeover optimization is bypassed, and the normal takeover code path is executed. The default value for this option is false.
- force => boolean, optional
In Classic mode: This causes takeover to be immediately initiated. The taken over node, if up, does not get to shut things down in an orderly manner so the takeover of the resources takes longer. This is the type of takeover that is done during normal cluster operation when one of the nodes goes away (dies). In Cluster mode: It forces a node to take over its storage partner even though the node detects an error that would otherwise prevent a takeover. For example, normally, if a detached or faulty interconnect cable between the nodes(ha pair) causes the nodes NVRAM contents to be unsynchronized, takeover is disabled. However, this will allow the node to take over its storage 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.
- immediate => boolean, optional
This causes takeover to be initiated immediately. The taken over node, if up, does not get to shut things down in an orderly manner so the takeover of the resources takes longer.
- node => string
This parameter is the name of the node which is doing a takeover of its partner.
- skip-lif-migration => boolean, optional
This option results in migration of LIFs to be skipped prior to a takeover. The default value is `false` and hence the default behavior is to synchronously migrate data and cluster management LIFs away from the node prior to its takeover.
- version-mismatch-ok => boolean, optional
This allows takeover if the partner was running an incompatible operating system version and was cleanly halted. This option is used for non-disruptive upgrade(NDU).
Outputs
[Family: cluster]
Get the takeover status of a node and the takeover status of all its partner aggregates, for all nodes in a cluster.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 aggr objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Commits the snapshots that were started during the preceeding cg-start call that returned the cg-id key, and unfences the volumes that were fenced. If cg-commit API times out, then it means that either too many volumes were specified to the cg-start api or the timeout value for the cg-start api was very small. In this situation, the caller should try to perform the cg-start operation by specifying lesser volumes or by specifying higher timeout value.Inputs
Outputs
[Family: vserver]
Starts the checkpoint cycle for externally synchronized checkpoints in the filer. This operation fences the specified volumes and returns "success" (if successful). If the API returns "success", the call starts a snapshot create operation in these volumes. If the API returns "success", this operation SHOULD be followed by a call to cg-commit (below). This API is not supported on Infinite Volume.
Inputs
- snapshot => string
The provided name of the snapshot that is created in each volume. This name is the unique identifier by which the calling agent identifies the snapshots that constitute a checkpoint. The maximum length is 255 characters. (= MAXNAMLEN)
- timeout => string, optional
Timeout selector. Possible vaules are "urgent", "medium" or "relaxed". If no value is specified, the default value is "medium". Following are the timeout values:
- "urgent" : 5 seconds
- "medium" : 7 seconds
- "relaxed" : 20 seconds
- user-timeout => integer, optional
User specified timeout value in seconds. This option can be set if the user wants to specify timeout value other than the default timeouts. The API will return failure if both 'timeout' and 'user-timeout' are specified. The minimum value for this field is equal to the "urgent" timeout. The maximum timeout which can be specified is 120 seconds.
Outputs
- cg-id => integer
Identifier of the started cg-start operation. This identifier is used in the succeeding cg-commit call to identify the operation to be commited.
[Family: vserver]
Create and setup the BranchCache service.Inputs
- return-record => boolean, optional
If set to true, returns the cifs-branchcache on successful creation. Default: false
Outputs
[Family: vserver]
Flush (delete) all the BranchCache hashes that have been generated for a Vserver.Inputs
Outputs
[Family: vserver]
Retrieve information about the BranchCache service.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the per-Vserver BranchCache configurations for the cluster.Inputs
- desired-attributes => cifs-branchcache, 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 => cifs-branchcache, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-branchcache object. All cifs-branchcache 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 cifs-branchcache objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Force the generation of BranchCache hashes for a file or path.Inputs
Outputs
[Family: vserver]
Modify the CIFS BranchCache service settingsInputs
- hash-store-max-size => size, optional
Maximum Size of the Hash Store
- operating-mode => string, optional
CIFS BranchCache Operating Modes
- server-key => string, optional
Encryption Key Used to Secure the Hashes
- versions => cifs-bc-version-control[], optional
Supported BranchCache Versions
Outputs
[Family: vserver]
Remove the BranchCache serviceInputs
Outputs
[Family: cluster, vserver]
Retrieve the list of servers discovered by the cluster.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 cifs-domain-discovered-servers objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Command to trigger re-discovery of servers.Inputs
Outputs
[Family: vserver]
Add to a list of preferred domain controllersInputs
- domain => string
The fully qualified domain name of the Active Directory domain to which the domain controllers in the list belong.
Outputs
[Family: cluster, vserver]
Retrieve the list of preferred domain controllers associated with Active Directory domains.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 cifs-domain-preferred-dc objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Remove from a list of preferred domain controllersInputs
- domain => string
The fully qualified domain name of the Active Directory domain to which the domain controllers in the list belong.
Outputs
[Family: vserver]
Add a path to the list of paths that will be searched to find a CIFS user's home directory.Inputs
- path => string
The file system path that will be searched for finding a CIFS user's home directory.
Outputs
[Family: vserver]
Delete a home directory search path. This API is deprecated in Data ONTAP 8.2 and later but retained for backwards compatibility. Use cifs-home-directory-search-path-remove instead of cifs-home-directory-search-path-delete.Inputs
- path => string
The file system path that will be searched for finding a CIFS user's home directory.
Outputs
[Family: cluster, vserver]
Iterate over a list of cifs-home-directory-search-path objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 cifs-home-directory-search-path objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Remove a home directory search path.Inputs
- path => string
The file system path that will be searched for finding a CIFS user's home directory.
Outputs
[Family: vserver]
Change the position of this path in the list of paths that will be searched to find a CIFS user's home directory.Inputs
- path => string
The file system path that will be searched for finding a CIFS user's home directory.
- to-position => integer
The target position this entry should be moved to, in the list of CIFS home directory search paths.
Outputs
[Family: vserver]
Create a single local groupInputs
- return-record => boolean, optional
If set to true, returns the cifs-local-group on successful creation. Default: false
Outputs
[Family: vserver]
Delete a single local groupInputs
- group-name => cifs-name
The name of the local group
Outputs
[Family: cluster, vserver]
Retrieve the list of local groupsInputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => cifs-local-group, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-local-group object. All cifs-local-group 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 cifs-local-group objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Add local users or Active Directory users or groups to a local groupInputs
- group-name => cifs-name
The name of the local group
Outputs
[Family: cluster, vserver]
Retrieve the list of local group membersInputs
- desired-attributes => cifs-local-group-members, 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
- 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 cifs-local-group-members objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Remove local users or Active Directory users or groups from a local groupInputs
- group-name => cifs-name
The name of the local group
- member-names => cifs-name[]
Names of Users or Active Directory Groups to be Removed
Outputs
[Family: vserver]
Modify a description of a single local groupInputs
- description => string, optional
The description of the local group
- group-name => cifs-name
The name of the local group
Outputs
[Family: vserver]
Rename a local groupInputs
- group-name => cifs-name
The name of the local group
Outputs
[Family: vserver]
Configure and create a local user, associated with a VserverInputs
- description => string, optional
The description of the local user
Outputs
[Family: vserver]
Delete a single local userInputs
- user-name => cifs-name
The name of the local user
Outputs
[Family: cluster, vserver]
Retrieve the list of local usersInputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => cifs-local-user, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-local-user object. All cifs-local-user 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 cifs-local-user objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster, vserver]
Retrieve local users' membership informationInputs
- desired-attributes => cifs-local-user-membership, 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
- 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 cifs-local-user-membership objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify a single local userInputs
- description => string, optional
The description of the local user
- full-name => string, optional
Full name of the local user
- is-account-disabled => boolean, optional
The user account is disabled
- user-name => cifs-name
The name of the local user
Outputs
[Family: vserver]
Rename a local userInputs
- user-name => cifs-name
The name of the local user
Outputs
[Family: vserver]
Set password for a local userInputs
- user-name => cifs-name
The name of the local user
- user-password => string
The Password for a Local User
Outputs
[Family: cluster, vserver]
Retrieve the NetBIOS Name Service statistics for Vservers in cluster.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => cifs-nbtstat, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the NetBIOS statistics object. All NetBIOS statistics 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 NetBIOS statistics objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster, vserver]
Iterate over a list of cifs-options objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => cifs-options, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-options object. All cifs-options 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 cifs-options objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify the attributes of cifs-options object.Inputs
- is-referral-enabled => boolean, optional
This optional parameter specifies whether the CIFS server refers clients to more optimal data access paths (LIFs). The default value for this parameter is false.
- is-smb2-enabled => boolean, optional
This optional parameter specifies whether the CIFS server negotiates the SMB2 versions of the CIFS protocol. The default value for this parameter is true.
- is-smb3-enabled => boolean, optional
This optional parameter specifies whether the CIFS server negotiates the SMB3 version of the CIFS protocol. The default value for this parameter is true.
- max-mpx => integer, optional
This option controls maximum simultaneous operations the CIFS server reports it can process per TCP connection. The default value for this option is 255.
- read-grants-execute => enable, optional
On a file with UNIX Style security effective on it, if the file has read permission on it, a CIFS user would be allowed to execute permissions if this option is enabled.
Outputs
[Family: vserver]
Generate a new password for the CIFS server's machine account and change it in the Windows Active Directory domain.Inputs
Outputs
[Family: vserver]
Reset the CIFS server's machine account password in the Windows Active Directory domain. This may be required if the password stored along with the machine account in the Windows Active Directory domain is changed or reset without the Vserver's knowledge. This operation requires the credentials for a user with permission to reset the password in the organizational unit (OU) that the machine account is a member of.Inputs
- admin-username => string
Username of a user with permission to reset the password in the organizational unit (OU) that the machine account is a member of. This user is expected to be part of the same Windows Active Directory domain as the CIFS server. If the specified username is not part of the same domain but part of a domain that has a trust relationship with the CIFS server's domain, the username can be specified as ' @ ' where FQDN is the fully qualified domain name of the domain of which the user is a member.
Outputs
[Family: vserver]
Add privileges to a local or Active Directory user or groupInputs
Outputs
[Family: cluster, vserver]
Retrieve the list of local groupsInputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => cifs-privilege, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-privilege object. All cifs-privilege 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 cifs-privilege objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Remove privileges from a local or Active Directory user or groupInputs
- privileges => cifs-privilege-entries[]
Privileges
- user-or-group-name => cifs-name
User or Group Name
Outputs
[Family: vserver]
Reset privileges for a local or Active Directory user or groupInputs
- user-or-group-name => cifs-name
User or Group Name
Outputs
[Family: cluster, vserver]
Iterate over a list of cifs-security objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => cifs-security, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-security object. All cifs-security 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 cifs-security objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify the attributes of cifs-security object.Inputs
Outputs
[Family: vserver]
Configure and setup CIFS services on a Vserver.Inputs
- admin-password => string
The password for the account used to add this CIFS server to the Active Directory.
- admin-username => string
The username of the account used to add this CIFS server to the Active Directory.
- domain => string
The fully qualified domain name of the Windows Active Directory this CIFS server belongs to.
- force-account-overwrite => boolean, optional
If this is set and a machine account with the same name as specified in 'cifs-server' exists in the Active Directory, it will be overwritten and reused. The default value for this field is false.
Outputs
[Family: vserver]
Delete a CIFS server. If the admin-username and admin-password are not specified, the CIFS server's machine account will not be deleted from the Windows Active Directory domain. The deletion of the CIFS server will also delete the CIFS shares associated with it.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of CIFS servers on the cluster and their basic configurations.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 cifs-server objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify the basic configurations of a CIFS server.Inputs
- admin-password => string, optional
The password for the account used to add this CIFS server to the Active Directory. This part of the credential only needs to be supplied if the domain is being modified.
- admin-username => string, optional
The username of the account used to add this CIFS server to the Active Directory. This part of the credential only needs to be supplied if the domain is being modified.
- administrative-status => service-state, optional
CIFS Server Administrative Status. Possible values:
- default-site => string, optional
The default site used by LIFs that do not have a site membership.
- domain => string, optional
The fully qualified domain name of the Windows Active Directory this CIFS server belongs to. If this input is not specified, it is not modified.
- force-account-overwrite => boolean, optional
If this is set and the domain is being modified, and a machine account with the same name as the current Vserver's CIFS server name exists in the Active Directory, it will be overwritten and reused. The default value for this field is false.
Outputs
[Family: vserver]
Start a CIFS server on the specified Vserver. The CIFS server must already exist. To create a CIFS server, use cifs-server-create.Inputs
Outputs
[Family: vserver]
Stop a CIFS server on the specified Vserver. Note that established sessions will be terminated and their open files closed. Workstations with cached data will not be able to save those changes, which could result in data loss.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of the opened CIFS files.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 cifs-session-file objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster, vserver]
Retrieve the list of the established CIFS sessions.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => cifs-session, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-session object. All cifs-session 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 cifs-session objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Add permissions for a user or group for a defined CIFS share.Inputs
- permission => cifs-access-perms
The access rights that the user or group has on the defined CIFS share. Possible values: - "no_access" - No access,
- "read" - Read,
- "change" - Change,
- "full_control" - Full Control
- return-record => boolean, optional
If set to true, returns the cifs-share-access-control on successful creation. Default: false
Outputs
[Family: vserver]
Remove permissions for a user or group on a defined CIFS share.Inputs
- share => string
The CIFS share for which the permissions are defined.
- user-or-group => string
The user or group name for which the permissions are listed.
Outputs
[Family: cluster, vserver]
Retrieve the list of permissions on defined CIFS shares.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 cifs-share-access-control objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify the permissions for a user or group on a defined CIFS share.Inputs
- permission => cifs-access-perms, optional
The access rights that the user or group has on the defined CIFS share. Possible values: - "no_access" - No access,
- "read" - Read,
- "change" - Change,
- "full_control" - Full Control
- share => string
The CIFS share for which the permissions are defined.
- user-or-group => string
The user or group name for which the permissions are listed.
Outputs
[Family: vserver]
Creates a new CIFS share rooted at the specified path.Inputs
- attribute-cache-ttl => integer, optional
The lifetime of an entry in the file attribute cache, in seconds. This value is used if the share has the 'attributecache' property set, which improves the performance of certain metadata operations in common workloads. The default is 10 seconds. Raising this value may improve performance, but the likelihood that stale metadata will be served increases as well. The value of this field must be in the range of 1 to 86400.
- comment => string, optional
This string gives a description of the CIFS share. CIFS clients see this description when browsing the Vserver's CIFS shares.
- dir-umask => integer, optional
The value of this field controls the file mode creation mask for the CIFS share in qtrees with UNIX or Mixed security styles. The mask restricts the initial permissions setting of a newly created directory. The input value is a numeric mode comprising of one to three octal digits (0-7), derived by adding up the bits with values 4, 2, and 1. The first digit selects permissions for the user who owns the file: read (4), write (2), and execute (1); the second selects permissions for other users in the file's group, with the same values; and the third for other users not in the file's group, with the same values.
- file-umask => integer, optional
The value of this field controls the file mode creation mask for the CIFS share in qtrees with UNIX or Mixed security styles. The mask restricts the initial permissions setting of a newly created file. The input value is a numeric mode comprising of one to three octal digits (0-7), derived by adding up the bits with values 4, 2, and 1. The first digit selects permissions for the user who owns the file: read (4), write (2), and execute (1); the second selects permissions for other users in the file's group, with the same values; and the third for other users not in the file's group, with the same values.
- offline-files-mode => string, optional
Mode of the offline file for the CIFS share. The default value is manual. Possible values: - "none" - Clients are not permitted to cache files for offline access.,
- "manual" - Clients may cache files that are explicitly selected by the user for offline use.,
- "documents" - Clients may automatically cache files that are used by the user for offline access.,
- "programs" - Clients may automatically cache files that are used by the user for offline access and may use those files in an offline mode even if the share is available.
- path => string
The file system path that is shared through this CIFS share.
- return-record => boolean, optional
If set to true, returns the cifs-share on successful creation. Default: false
- 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 \/[]:|<>+=;,?"*
- share-properties => cifs-share-properties[], optional
The list of properties for this CIFS share. Possible values: - "oplocks" - This specifies that opportunistic locks (client-side caching) are enabled on this share.,
- "browsable" - This specifies that the share can be browsed by Windows clients.,
- "showsnapshot" - This specifies that Snapshots can be viewed and traversed by clients.,
- "changenotify" - This specifies that CIFS clients can request for change notifications for directories on this share.,
- "homedirectory" - This specifies that the share is added and enabled as part of the CIFS home directory feature. The configuration of this share should be done using CIFS home directory feature interface. This property can only be set during the create process and cannot be altered later.
- "attributecache" - This specifies that connections through this share are caching attributes for a short time to improve performance.
- "branchcache" - This specifies that 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.
- "continuously_available" - This specifies that clients connecting to this share can open files in a persistent manner. Files opened this way are protected from disruptive events, such as failover and giveback.
- "shadowcopy" - This specifies that the share is pointing to a shadow copy. This attribute cannot be added nor removed from a share.
- "access_based_enumeration" - This specifies that Access Based Enumeration is enabled on this share. 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.
- symlink-properties => cifs-share-symlink-properties[], optional
This flag controls whether the symlinks under this shared directory are hidden (option 'hide'), accessible (option 'enable') or are accessible as read-only (option 'read-only' along with option 'enable'). Possible values: - "enable" ,
- "hide" ,
- "read_only"
Outputs
[Family: vserver]
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
[Family: cluster, vserver]
Gives information about one or more CIFS shares.Inputs
- desired-attributes => cifs-share, 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 => cifs-share, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-share object. All cifs-share 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 cifs-share objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modifies settings of a CIFS share, even if the shares are in use.Inputs
- attribute-cache-ttl => integer, optional
The lifetime of an entry in the file attribute cache, in seconds. This value is used if the share has the 'attributecache' property set, which improves the performance of certain metadata operations in common workloads. The default is 10 seconds. Raising this value may improve performance, but the likelihood that stale metadata will be served increases as well. The value of this field must be in the range of 1 to 86400.
- comment => string, optional
This string gives a description of the CIFS share. CIFS clients see this description when browsing the Vserver's CIFS shares.
- dir-umask => integer, optional
The value of this field controls the file mode creation mask for the CIFS share in qtrees with UNIX or Mixed security styles. The mask restricts the initial permissions setting of a newly created directory. The input value is a numeric mode comprising of one to three octal digits (0-7), derived by adding up the bits with values 4, 2, and 1. The first digit selects permissions for the user who owns the file: read (4), write (2), and execute (1); the second selects permissions for other users in the file's group, with the same values; and the third for other users not in the file's group, with the same values.
- file-umask => integer, optional
The value of this field controls the file mode creation mask for the CIFS share in qtrees with UNIX or Mixed security styles. The mask restricts the initial permissions setting of a newly created file. The input value is a numeric mode comprising of one to three octal digits (0-7), derived by adding up the bits with values 4, 2, and 1. The first digit selects permissions for the user who owns the file: read (4), write (2), and execute (1); the second selects permissions for other users in the file's group, with the same values; and the third for other users not in the file's group, with the same values.
- offline-files-mode => string, optional
Mode of the offline file for the CIFS share. The default value is manual. Possible values: - "none" - Clients are not permitted to cache files for offline access.,
- "manual" - Clients may cache files that are explicitly selected by the user for offline use.,
- "documents" - Clients may automatically cache files that are used by the user for offline access.,
- "programs" - Clients may automatically cache files that are used by the user for offline access and may use those files in an offline mode even if the share is available.
- 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 \/[]:|<>+=;,?"*
- share-properties => cifs-share-properties[], optional
The list of properties for this CIFS share. Possible values: - "oplocks" - This specifies that opportunistic locks (client-side caching) are enabled on this share.,
- "browsable" - This specifies that the share can be browsed by Windows clients.,
- "showsnapshot" - This specifies that Snapshots can be viewed and traversed by clients.,
- "changenotify" - This specifies that CIFS clients can request for change notifications for directories on this share.,
- "homedirectory" - This specifies that the share is added and enabled as part of the CIFS home directory feature. The configuration of this share should be done using CIFS home directory feature interface. This property cannot be added or removed from existing share.
- "attributecache" - This specifies that connections through this share are caching attributes for a short time to improve performance.
- "branchcache" - This specifies that 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.
- "continuously_available" - This specifies that clients connecting to this share can open files in a persistent manner. Files opened this way are protected from disruptive events, such as failover and giveback.
- "shadowcopy" - This specifies that the share is pointing to a shadow copy. This attribute cannot be added nor removed from a share.
- "access_based_enumeration" - This specifies that Access Based Enumeration is enabled on this share. 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.
- symlink-properties => cifs-share-symlink-properties[], optional
This flag controls whether the symlinks under this shared directory are hidden (option 'hide'), accessible (option 'enable') or are accessible as read-only (option 'read-only' along with option 'enable'). Possible values: - "enable" ,
- "hide" ,
- "read_only"
Outputs
[Family: vserver]
Create a new CIFS symbolic link path mapping from a UNIX symlink to a target CIFS path. This symbolic link path mapping will be effective on symbolic links that have a prefix match with the value of 'unix-path'. e.g.: if the value of 'unix-path' is '/usr/local/' and there exists a symbolic link on the file system at '/home/user/link' which points to '/usr/local/share/dest'. If a CIFS client accesses the symbolic link 'link', this entry of path mapping would have a prefix match '/usr/local/'. The CIFS client would be redirected to the location pointed to by this path mapping's 'cifs-server', 'share-name' and 'cifs-path' fields.Inputs
- cifs-path => string
This field specifies the CIFS path on the destination to which the symbolic link maps. The final path is generated by concatenating the CIFS server name, the share name, the cifs-path and the remaining path in the symbolic link left after the prefix match. This value is specified by using a UNIX-style path name. The trailing forward slash is required for the full path name to be properly interpreted. This is a UTF-8 string and supports localization.
- cifs-server => string, optional
This field specifies the destination CIFS server name for the mapping to which the symbolic link is mapped. The default is the local CIFS server. The field needs to be specified if the locality of the symbolic link is 'widelink'. This can be either a DNS name, NetBIOS name or an IP address. If a DNS name or a NetBIOS name are specified, the CIFS client configuration should be such that it is capable of resolving the CIFS server name to the correct IP address.
- locality => cifs-symlink-locality, optional
This field specifies whether the CIFS symbolic link is a local link or wide link. A local symbolic link maps to the local CIFS share, whereas a wide symbolic link maps to any CIFS share on the network. If the CIFS server matches the VServer's NetBIOS name then the default value is local otherwise widelink. Possible values: - "local" - Share On This VServer,
- "widelink" - Share On Another CIFS Server
- return-record => boolean, optional
If set to true, returns the cifs-symlink on successful creation. Default: false
- share-name => string
This field specifies the CIFS share name on the destination CIFS server to which the symbolic link is mapped. This is a UTF-8 string and supports localization.
- unix-path => string
This field specifies the UNIX path prefix to be matched for the mapping. If the prefix of the target path in the symbolic link matches against this field, this entry of symbolic link path mapping would be used. The path is a UTF-8 string and supports localization. The path must start and end with a forward slash ('/'). For example '/usr/local/'.
Outputs
[Family: vserver]
Delete a CIFS symbolic link path mapping.Inputs
- unix-path => string
This field specifies the UNIX path prefix to be matched for the mapping. If the prefix of the target path in the symbolic link matches against this field, this entry of symbolic link path mapping would be used. The path is a UTF-8 string and supports localization. The path must start and end with a forward slash ('/'). For example '/usr/local/'.
Outputs
[Family: cluster, vserver]
Retrieve the list of CIFS symbolic link path mappings.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => cifs-symlink, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the cifs-symlink object. All cifs-symlink 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 cifs-symlink objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify a CIFS symbolic link path mapping parameters.Inputs
- cifs-path => string, optional
This field specifies the CIFS path on the destination to which the symbolic link maps. The final path is generated by concatenating the CIFS server name, the share name, the cifs-path and the remaining path in the symbolic link left after the prefix match. This value is specified by using a UNIX-style path name. The trailing forward slash is required for the full path name to be properly interpreted. This is a UTF-8 string and supports localization.
- cifs-server => string, optional
This field specifies the destination CIFS server name for the mapping to which the symbolic link is mapped. The default is the local CIFS server. The field needs to be specified if the locality of the symbolic link is 'widelink'. This can be either a DNS name, NetBIOS name or an IP address. If a DNS name or a NetBIOS name are specified, the CIFS client configuration should be such that it is capable of resolving the CIFS server name to the correct IP address.
- locality => cifs-symlink-locality, optional
This field specifies whether the CIFS symbolic link is a local link or wide link. A local symbolic link maps to the local CIFS share, whereas a wide symbolic link maps to any CIFS share on the network. If the CIFS server matches the VServer's NetBIOS name then the default value is local otherwise widelink. Possible values: - "local" - Share On This VServer,
- "widelink" - Share On Another CIFS Server
- share-name => string, optional
This field specifies the CIFS share name on the destination CIFS server to which the symbolic link is mapped. This is a UTF-8 string and supports localization.
- unix-path => string
This field specifies the UNIX path prefix to be matched for the mapping. If the prefix of the target path in the symbolic link matches against this field, this entry of symbolic link path mapping would be used. The path is a UTF-8 string and supports localization. The path must start and end with a forward slash ('/'). For example '/usr/local/'.
Outputs
[Family: cluster, vserver]
Gets current timezone and timezone file version.Inputs
Outputs
- timezone => string
Current timezone name where the storage system is operating. A timezone can have one of the two formats: - "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.";
- "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".
[Family: vserver]
Set autodelete on a lun clone.Inputs
- clone-path => string
Path of the file or the LUN inside the volume. It's relative if the volume name is specified otherwise it's absolute.
- enable => boolean
If this field is true, autodelete will be allowed to delete the clone in try/disrupt mode. and if it is false, autodelete will not be allowed to delete the clone in try/disrupt mode.
Outputs
[Family: vserver]
Create a file/sub file or LUN/sub LUN clone.Inputs
- block-ranges => block-range[], optional
List of block ranges for sub-file/sub-LUN cloning. 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.
- destination-path => string, optional
Full path of the Destination file or destination LUN relative to the volume. The destination file must be in same 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.
- qos-policy-group-name => string, optional
QoS policy group defines measurable Service Level Objectives (SLOs) that apply to the storage objects with which the policy group is associated. If you do not assign a policy group to a flexclone file, the system will not monitor and control the traffic to it. This field is available in Data ONTAP 8.2 and 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.
- volume => string
Name of the volume where the source and destination files or LUNs reside.
Outputs
[Family: cluster]
Returns the cluster identity information.Inputs
Outputs
[Family: cluster]
Modifies the cluster identity information.Inputs
Outputs
[Family: cluster]
Returns information about a node in a cluster.Inputs
Outputs
[Family: cluster]
Returns information about nodes in a cluster.Inputs
- desired-attributes => cluster-node-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
- 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 cluster objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modifies state of a node in a cluster.Inputs
- is-node-epsilon => boolean, optional
You can designate a node as epsilon to add weight to its voting in a cluster with an even number of nodes. In a cluster, only one node can be designated as epsilon at any given time. A boolean value of true means the node is epsilon.
- node-name => node-name
The textual name of a node.
Outputs
[Family: cluster]
Create a cluster peer relationshipInputs
- password => string, optional
The password required to authenticate with the peer cluster. This value is only used at peer creation time and not stored.
- user-name => string, optional
The user name required to authenticate with the peer cluster. This value is only used at peer creation time and not stored.
Outputs
[Family: cluster]
Delete a cluster peer relationshipInputs
Outputs
[Family: cluster]
Return the specified peer cluster relationship informationInputs
- cluster-name => string
The name of the peer cluster.
Outputs
[Family: cluster]
Returns a list of cluster peer relationshipsInputs
- desired-attributes => cluster-peer-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
- 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 cluster-peer objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Get the health of the specified peer nodeInputs
Outputs
[Family: cluster]
Get the health of all local and peer nodes sequentiallyInputs
- desired-attributes => cluster-peer-health-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
- 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 cluster-peer objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modifies a cluster peer relationshipInputs
- cluster-name => string
The name of the peer cluster to modify.
- peer-addresses => remote-inet-address[], optional
The Remote IP address or host name of the peer cluster. If not specified, the peer-addresses are not modified.
- timeout => integer, optional
The timeout for operations in the peer cluster in seconds. If not specified, the timeout is not modified.
Outputs
[Family: cluster]
Ping the specified peer nodes. Ping operations take place between a node in a cluster and a node in a remote cluster. The originating node is the node which initiates the ping operation and the destination cluster and node specify the remote node which is the target of the ping.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 cluster-peer-ping objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Copy a configuration backup. A job will be queued to copy the configuration backup. A job will be spawned to operate on the config-backup and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
- from-node => string
The source node to copy the configuration backup from. This is the node that has the backup file on its root volume.
Outputs
[Family: cluster]
Create a configuration backup. A job will be queued to create the configuration backup in the background. Creation of configuration backup may take several minutes. This ZAPI creates an on demand backup. A job will be spawned to operate on the config-backup and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
- backup-name => string, optional
The name of the configuration backup. It must be a valid file name. An extension of .7z will be added if the given backup-name doesn't have that extension. If backup-name is not provided, software will generate the name for configuration backup.
- backup-type => backup-type, optional
Indicates if the backup is a node or a cluster backup. A node backup contains only node-specific configuration of a particular node in the cluster. A cluster backup contains cluster-wide replicas in addition to node backup of each node in the cluster. Possible values: - "node" - Node Backup,
- "cluster" - Cluster Backup
- node => string
The node to own the configuration backup. This is the node that will have the backup file on its root volume.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
[Family: cluster]
Delete a configuration backup.Inputs
- backup-name => string
The name of the configuration backup.
- node => string
The node that owns the configuration backup. This is the node that has the backup file on its root volume.
Outputs
[Family: cluster]
Download a configuration backup from a URL.Inputs
- backup-name => string, optional
The name of the configuration backup. It must be a valid file name. An extension of .7z will be added if the given backup-name doesn't have that extension. If backup-name is not provided, software will generate a name for configuration backup.
- node => string
The node to own the configuration backup. The backup file will be downloaded to the root volume of this node.
- source-url => string
The source URL. URL is specified following the syntax described in RFC 3986. Only 'ftp', 'http' and 'https' protocols are supported.
Outputs
[Family: cluster]
Return information about a specified configuration backup.Inputs
- backup-name => string
The name of the configuration backup.
- node => string
The node that owns the configuration backup. This is the node that has the backup file on its root volume.
Outputs
[Family: cluster]
Return a list of configuration backups in the cluster.Inputs
- desired-attributes => config-backup-info-type, 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
- 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 config-backup-info objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Rename a configuration backup. Renamed backup stays on the same node.Inputs
- backup-name => string
The name of the configuration backup.
- new-backup-name => string
The new name for the configuration backup. It must be a valid file name. An extension of .7z will be added if the given new-name doesn't have that extension.
- node => string
The node that owns the configuration backup. This is the node that has the backup file on its root volume.
Outputs
[Family: cluster]
Return information about the configuration backup settings.Inputs
Outputs
[Family: cluster]
Modify the settings for configuration backup operations.Inputs
- destination-url => string, optional
The destination URL for uploading the configuration backups. URL is specified following the syntax described in RFC 3986. Only 'ftp', 'http' and 'https' protocols are supported.
Outputs
[Family: cluster]
Modify the password for destination URL.Inputs
Outputs
[Family: cluster]
Upload a configuration backup to a URL.Inputs
- backup-name => string
The name of the configuration backup.
- destination-url => string
The destination URL. URL is specified following the syntax described in RFC 3986. Only 'ftp', 'http' and 'https' protocols are supported.
- node => string
The node that owns the configuration backup. This is the node that has the backup file on its root volume.
Outputs
[Family: cluster]
Get alarm monitoring data for the given node object.Inputs
- dashboard-metric-type => dashboard-metric-type
The type of metric being monitored. Possible values: - "cpu_busy" - CPU Utilization,
- "port_util" - Port Utilization,
- "op_latency" - Average Client Latency of NFS and CIFS operations,
- "aggregate_used" - Storage Aggregate Utilization,
- "port_problems" - Packet Error Ratio
- node => string
Name of the node associated with the alarm metrics.
- object-name => string
Name associated with the object being monitored. For example, the object-name is the name of the node if the dashboard-metric-type is cpu-busy.
Outputs
[Family: cluster]
Get alarm monitoring data for all objects in the cluster.Inputs
- desired-attributes => dashboard-alarm-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
- 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 dashboard-alarm objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Return the total number of records.Inputs
Outputs
- count => integer
The total number of dashboard-alarm objects.
[Family: cluster]
Get alarm threshold settings for the given metric group.Inputs
- dashboard-metric-type => dashboard-metric-type
The type of metric being monitored. Possible values: - "cpu_busy" - CPU Utilization,
- "port_util" - Port Utilization,
- "op_latency" - Average Client Latency of NFS and CIFS operations,
- "aggregate_used" - Storage Aggregate Utilization,
- "port_problems" - Packet Error Ratio
- desired-attributes => dashboard-alarm-threshold-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
[Family: cluster]
Get alarm threshold settings for all metric groups.Inputs
- desired-attributes => dashboard-alarm-threshold-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
- 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 dashboard-alarm-threshold objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Return the total number of records.Inputs
Outputs
- count => integer
The total number of dashboard-alarm-threshold objects.
[Family: cluster]
Modify alarm threshold settings for the given metric group.Inputs
- critical-threshold => string, optional
The threshold value that must be reached to generate a critical alarm for this type of metric. Get request is returned with % sign for percent values and ms for milliseconds value. Example : 95%, 500ms
- dashboard-metric-type => dashboard-metric-type
The type of metric being monitored. Possible values: - "cpu_busy" - CPU Utilization,
- "port_util" - Port Utilization,
- "op_latency" - Average Client Latency of NFS and CIFS operations,
- "aggregate_used" - Storage Aggregate Utilization,
- "port_problems" - Packet Error Ratio
- warning-threshold => string, optional
The threshold value that must be reached to generate a warning alarm for this type of metric. Get request is returned with % sign for percent values and ms for milliseconds value. Example : 85%, 200ms
Outputs
[Family: cluster]
Return alert definitionInputs
- node => string
Node hosting this health monitor.
Outputs
[Family: cluster]
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.
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 Definition objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Return a subsystem alertInputs
- 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
[Family: cluster]
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
- 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.
[Family: cluster]
Acknowledge/suppress an alertInputs
- 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
[Family: cluster]
Return the system health framework configurationInputs
- monitor => hm-type
Type of health monitor (e.g. node_connect, system_connect, system).
- node => string
Node hosting this health monitor.
Outputs
[Family: cluster]
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
- 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.
[Family: cluster]
Delete subsystem alertInputs
- 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
[Family: cluster]
Return policy definitionInputs
- monitor => hm-type
Type of health monitor (e.g. node_connect, system_connect, system).
- node => string
Node hosting this health monitor.
Outputs
[Family: cluster]
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
- 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.
[Family: cluster]
Enable/disable policyInputs
- 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
[Family: cluster]
Return the overall system healthInputs
Outputs
[Family: cluster]
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
- return-record => boolean, optional
If set to true, returns the Subscriptions for Notifications on successful creation. Default: false
Outputs
[Family: cluster]
Return system health subscriptionInputs
- 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.
- 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
[Family: cluster]
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
- 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.
[Family: cluster]
Modify system health subscriptionInputs
- 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
[Family: cluster]
Get the attributes of the Health Monitor Subsystem Status.Inputs
Outputs
[Family: cluster]
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
- 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.
[Family: cluster]
Fail a file system disk. Removes the specified file system disk from the RAID configuration, spinning the disk down when removal is complete. disk fail is used to remove a file system disk that may be logging excessive errors and requires replacement. Note that if optional input parameter 'is-immediate' is true, the specified disk will be immediately failed out, and the RAID group to which the disk belongs will enter degraded mode (meaning a disk is missing from the RAID group). If a spare disk at least as large as the disk being removed is available, the contents of the disk being removed will be reconstructed onto that spare disk. If 'is-immediate' options is false or not specified, system will prefail the disk and its content will be copied to a replacement disk if a suitable spare disk is available, and afterwards the prefailed disk will be failed out. This process can be observed by polling disk-list-info for this disk and tracking values of elements copy-destination and copy-percent. Same can be done using 'storage-disk-get-iter' when requested from Admin Vserver LIF. The disk being failed is marked as ``broken'', so that if it remains in the disk shelf, it will not be used by the filer as a spare disk. If the disk is moved to another filer, that filer will use it as a spare. This is not a recommended course of action, as the reason that the disk was failed may have been because it needed to be replaced. NOTE: Data ONTAP 7.0 and earlier releases don't indicate failure code properly.Inputs
- 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
[Family: cluster]
Remove a spare disk. Removes the specified spare disk from the RAID configuration, spinning the disk down when removal is complete. You can use disk remove to remove a spare disk so that it can be used by another filer (as a replacement for a failed disk or to expand file system space). NOTE: Data ONTAP 7.0 and earlier releases don't indicate failure code properly.Inputs
- 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
[Family: cluster]
Assigns ownership of a disk. The normal usage is when the disk is unowned, or to assign a disk to a pool.Inputs
- 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
[Family: cluster]
Get sanown filer information.Inputs
- node => string
Node name for which info is requested
Outputs
[Family: cluster]
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
[Family: cluster]
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
[Family: cluster]
Removes ownership information on a disk. Default usage is to remove ownership information for all disks owned by the local node, in maintenance mode.Inputs
- 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
[Family: cluster]
Unfail a disk in the broken pool, by clearing its FDR (Failed Disk Registry) entry and unfailing it at the Storage Layer, as necessary. If the "make-spare" option is set to B_TRUE, the disk is returned to the spare pool. Otherwise, label assimilation will bring the disk back according to its on-disk labels, with one of four possible outcomes. 1. Disk becomes a spare. This is the common case. The disk becomes a spare upon unfail, because its parent volume is complete and online. 2. Disk is assimilated into former volume. This is a recovery scenario. The disk is brought back into an existing volume, which may result in this volume coming back online. 3. Disk is assimilated into a new partial volume. This may occur in the rare case that the disk's former volume was destroyed or moved. 4. Disk returned to broken pool. This is the case if a fatal error occurs in process of unfailing the disk.Inputs
- 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
[Family: cluster]
Start disk firmware download process to update firmware on disks. This operation is asynchronous, and therefore returns no errors that might occur during the download process. This operation will only update firmware on disks that do not have the latest firmware revision. The firmware revision on the disk can be monitored via the disk-list-info API.Inputs
- 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
- node-name => string
This field is only valid when the request is sent to the Admin Vserver LIF. This is the storage system name the command will be executed on.
Outputs
[Family: cluster]
Set up all non-zeroed spares owned by the filer to start zeroing. This operation is asynchronous, and therefore returns no errors that might occur when the zeroing operation actually starts, which could be several seconds after this API operation completes. Zeroing progress can be monitored via the disk-list-info API. Same can be done using 'storage-disk-get-iter' when requested from Admin Vserver LIF. The "zeroing-percent" element of disk-detail-info is returned if disk zeroing has started, and "is-zeroed" returns TRUE once the zeroing has completed (or, if zeroing wasn't necessary in the first place).Inputs
- node-name => string, optional
Name of the node on which spare disks to be zeroed When requested from Admin Vserver LIF and node name is not specified, spare disks from all nodes in the cluster will be zeroed.
Outputs
[Family: vserver]
This API is used by SnapDrive to log SnapDrive specific events occurring on a host system to the the appliance and optionally use the appliance to generate an autosupport message. This event information will be encapsulated in an app.log.x EMS event based on error level. If auto-support is true, an autosupport message will be sent from the filer.Inputs
- 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
[Family: cluster]
Return the EMS Configuration.Inputs
Outputs
[Family: cluster]
Modify the EMS Configuration.Inputs
- console-log-level => emsseverity, optional
Console logging level. Possible values: - "node_fault" - A data corruption has been detected or the node is unable to provide client service,
- "svc_fault" - A temporary loss of service has been detected, typically a transient software fault,
- "node_error" - A hardware error has been detected which is not immediately fatal,
- "svc_error" - A software error has been detected which is not immediately fatal,
- "warning" - A high-priority message, does not indicate a fault,
- "notice" - A normal-priority message, does not indicate a fault,
- "info" - A low-priority message, does not indicate a fault,
- "debug" - A debugging message, typically suppressed from customer,
- "var" - Message has variable severity, selected at runtime
Outputs
[Family: cluster]
Creates an EMS destination.Inputs
- name => string
The name of the EMS destination.
- return-record => boolean, optional
If set to true, returns the ems-destination on successful creation. Default: false
Outputs
[Family: cluster]
Deletes the specified EMS destination.Inputs
- name => string
The name of the EMS destination.
Outputs
[Family: cluster]
Deletes several EMS destinations.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple ems-destination objects match a given query. If set to true, the API will continue deleting the next matching ems-destination even when the deletion of a previous ems-destination fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching ems-destination even when the deletion of a previous matching ems-destination fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of ems-destination objects to delete in this call. Default: 20
- return-failure-list => boolean, optional
If set to true, the API will return the list of ems-destination objects (just keys) that were not deleted due to some error. If set to false, the list of ems-destination objects not deleted will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of ems-destination objects (just keys) that were successfully deleted. If set to false, the list of ems-destination objects deleted will not be returned. Default: true
- 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 matching ems-destination objects to be deleted.
[Family: cluster]
Return the specified EMS destination information.Inputs
- name => string
The name of the EMS destination.
Outputs
[Family: cluster]
Return information on EMS destinations.Inputs
- desired-attributes => ems-destination-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
- 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 ems-destination objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modifies the specified EMS destination.Inputs
- hide-parameters => boolean, optional
Hide parameter values?
- mail => mail-address[], optional
The e-mail address to which events are sent.
- name => string
The name of the EMS destination.
- snmp => remote-ip[], optional
The SNMP addresses to which traps are sent.
- snmp-community => string, optional
The SNMP community name.
- syslog => remote-ip[], optional
The remote syslog servers to which messages are sent.
- syslog-facility => syslog-facility, optional
The syslog logging facility.
Outputs
[Family: cluster]
Modifies several EMS destinations.Inputs
- attributes => ems-destination-info
Specify at least one modifiable element. Do not specify any other element.
- continue-on-failure => boolean, optional
This input element is useful when multiple ems-destination objects match a given query. If set to true, the API will continue modifying the next matching ems-destination even when modification of a previous ems-destination fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching ems-destination even when the modification of a previous matching ems-destination fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of objects to be modified in this call. Default: 20
- query => ems-destination-info
If modifying a specific ems-destination, this input element must specify all keys. If modifying ems-destination objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of ems-destination objects (just keys) that were not modified due to some error. If set to false, the list of ems-destination objects not modified will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of ems-destination objects (just keys) that were successfully updated. If set to false, the list of ems-destination objects modified will not be returned. Default: true
- 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 matching ems-destination objects to be modified.
- num-failed => integer, optional
Number of ems-destination objects that matched the query, but were not modified due to some error.
- num-succeeded => integer, optional
The number of ems-destination objects that matched the query and were successfully updated.
[Family: cluster]
Delete an individual mail history entry.Inputs
- node => node-name
Node emitting the EMS message.
Outputs
[Family: cluster]
Delete mail history entries.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple ems-mail-history objects match a given query. If set to true, the API will continue deleting the next matching ems-mail-history even when the deletion of a previous ems-mail-history fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching ems-mail-history even when the deletion of a previous matching ems-mail-history fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of ems-mail-history objects to delete in this call. Default: 20
- return-failure-list => boolean, optional
If set to true, the API will return the list of ems-mail-history objects (just keys) that were not deleted due to some error. If set to false, the list of ems-mail-history objects not deleted will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of ems-mail-history objects (just keys) that were successfully deleted. If set to false, the list of ems-mail-history objects deleted will not be returned. Default: true
- 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 matching ems-mail-history objects to be deleted.
- num-failed => integer, optional
Number of ems-mail-history objects that matched the query, but were not deleted due to some error.
- num-succeeded => integer, optional
The number of ems-mail-history objects that matched the query and were successfully deleted.
[Family: cluster]
Return an individual mail history entry.Inputs
- node => node-name
Node emitting the EMS message.
- seq-num => seqnum
The message sequence number.
Outputs
[Family: cluster]
Return information mail history.Inputs
- desired-attributes => ems-mail-history-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
- 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 ems-mail-history objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Return an EMS message.Inputs
- node => node-name
Node emitting the EMS message.
- seq-num => seqnum
The message sequence number.
Outputs
[Family: cluster]
Return EMS messages.Inputs
- desired-attributes => ems-message-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
- 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 ems-message objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Add EMS Destinations.Inputs
Outputs
[Family: cluster]
Return the specified EMS route information.Inputs
- message-name => ems-id
The name of the EMS message.
Outputs
[Family: cluster]
Return information on several EMS routes.Inputs
- desired-attributes => ems-routing-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
- 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 ems-routing objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modifies the specified EMS route.Inputs
- message-name => ems-id
The name of the EMS message.
Outputs
[Family: cluster]
Modifies several EMS route.Inputs
- attributes => ems-routing-info
Specify at least one modifiable element. Do not specify any other element.
- continue-on-failure => boolean, optional
This input element is useful when multiple ems-routing objects match a given query. If set to true, the API will continue modifying the next matching ems-routing even when modification of a previous ems-routing fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching ems-routing even when the modification of a previous matching ems-routing fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of objects to be modified in this call. Default: 20
- return-failure-list => boolean, optional
If set to true, the API will return the list of ems-routing objects (just keys) that were not modified due to some error. If set to false, the list of ems-routing objects not modified will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of ems-routing objects (just keys) that were successfully updated. If set to false, the list of ems-routing objects modified will not be returned. Default: true
- 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 matching ems-routing objects to be modified.
- num-failed => integer, optional
Number of ems-routing objects that matched the query, but were not modified due to some error.
- num-succeeded => integer, optional
The number of ems-routing objects that matched the query and were successfully updated.
[Family: cluster]
Remote EMS Destinations.Inputs
- destinations => ems-destination[]
Destinations
- message-name => ems-id
The name of the EMS message.
Outputs
[Family: cluster]
Delete an individual SNMP history entry.Inputs
- node => node-name
Node emitting the EMS message.
- seq-num => seqnum
The message sequence number.
Outputs
[Family: cluster]
Delete SNMP history entries.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple ems-snmp-history objects match a given query. If set to true, the API will continue deleting the next matching ems-snmp-history even when the deletion of a previous ems-snmp-history fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching ems-snmp-history even when the deletion of a previous matching ems-snmp-history fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of ems-snmp-history objects to delete in this call. Default: 20
- return-failure-list => boolean, optional
If set to true, the API will return the list of ems-snmp-history objects (just keys) that were not deleted due to some error. If set to false, the list of ems-snmp-history objects not deleted will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of ems-snmp-history objects (just keys) that were successfully deleted. If set to false, the list of ems-snmp-history objects deleted will not be returned. Default: true
- 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 matching ems-snmp-history objects to be deleted.
- num-failed => integer, optional
Number of ems-snmp-history objects that matched the query, but were not deleted due to some error.
- num-succeeded => integer, optional
The number of ems-snmp-history objects that matched the query and were successfully deleted.
[Family: cluster]
Return an individual SNMP history entry.Inputs
- node => node-name
Node emitting the EMS message.
- seq-num => seqnum
The message sequence number.
Outputs
[Family: cluster]
Return information SNMP history.Inputs
- desired-attributes => ems-snmp-history-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
- 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 ems-snmp-history objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Return information an EMS message.Inputs
- message-name => ems-id
The message name.
- node => node-name
Node emitting the EMS message.
Outputs
[Family: cluster]
Return information on EMS messages.Inputs
- desired-attributes => ems-status-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
- 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 ems-status objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Create an Export policy configuration.Inputs
- return-record => boolean, optional
If set to true, returns the Export policy configuration. on successful creation. Default: false
Outputs
[Family: vserver]
Delete an Export policy configuration.Inputs
- policy-name => string
Export policy name.
Outputs
[Family: vserver]
Get an Export policy configuration.Inputs
- policy-name => string
Export policy name.
Outputs
[Family: cluster, vserver]
Get a group of Export policy configurations.Inputs
- desired-attributes => export-policy-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 => export-policy-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the Export policy configuration. object. All Export policy 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 Export policy configuration. objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Rename an Export policyInputs
- policy-name => string
Export policy name.
Outputs
[Family: vserver]
Create an Export rule configuration.Inputs
- client-match => string
Client match specification for Export rule. The clients specified are enforced with this Export rule. The rule with the higher rule index value takes precedence.
- policy-name => string
Export policy name.
- rule-index => integer, optional
Export rule index. A next available value is assigned if no value is provided during create else the rule is inserted at the given rule index position in the export-rule table.
Outputs
[Family: vserver]
Delete an Export rule configuration.Inputs
- policy-name => string
Export policy name.
Outputs
[Family: vserver]
Get an Export rule configuration.Inputs
- policy-name => string
Export policy name.
- rule-index => integer
Export rule index.
Outputs
[Family: cluster, vserver]
Obtain the default values for Export rule configurationInputs
Outputs
[Family: cluster, vserver]
Get a group of Export rule configurations.Inputs
- desired-attributes => export-rule-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 => export-rule-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the Export rule configuration. object. All Export rule 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 Export rule configuration. objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify an Export rule configuration.Inputs
- anonymous-user-id => string, optional
User name or ID to which anonymous users are mapped. Default value is '65534'.
- client-match => string, optional
Client match specification for Export rule. The clients specified are enforced with this Export rule. The rule with the higher rule index value takes precedence.
- export-chown-mode => exportchownmode, optional
Change ownership mode. Possible values are 'restricted', 'unrestricted'. Default value is 'restricted'.
- export-ntfs-unix-security-ops => exportntfsunixsecops, optional
Ignore/Fail unix security operations on NTFS volumes. Possible values are 'ignore', 'fail'. Default value is 'fail'.
- is-allow-dev-is-enabled => boolean, optional
If 'true', the NFS server will allow creation of devices. Default value is 'true'.
- is-allow-set-uid-enabled => boolean, optional
If 'true', NFS server will honor SetUID bits in SETATTR operation. Default value is 'true'.
- policy-name => string
Export policy name.
- protocol => access-protocol[], optional
Client access protocol. Default value is 'any'.
- rule-index => integer
Export rule index.
- super-user-security => security-flavor[], optional
Security flavors for the superuser. Default value is 'none'.
Outputs
[Family: vserver]
Move a rule to the specified indexInputs
- new-rule-index => integer
New ruleindex value for the Export rule. The rule will be inserted into the rule-index position in the export-rule table.
- policy-name => string
Export policy name.
- rule-index => integer
Export policy rule index.
Outputs
[Family: cluster]
Call the corresponding adapter driver disable function to bring the adapter offline. Under some circumstances an adapter can not be put offline. (e.g. when the adapter is being used by the RAID sub-system to provide disks in a volume). In some cases, manual intervention is required. When this happens, an appropriate error messages is returned.Inputs
- node-name => string
This field is only valid when the request is sent to the Admin Vserver LIF. This is the storage system name the command will be executed on.
Outputs
[Family: cluster]
Call the corresponding adapter driver enable function to bring the adapter online. Under some circumstances an adapter can not be brought online. (e.g. when that adapter is in the UNCONFIGURED state, or when there is no cable attached to the adapter port). When this happens, an appropriate error messages is returned.Inputs
- adapter-name => string
FC adapter name (e.g 0a)
- node-name => string
This field is only valid when the request is sent to the Admin Vserver LIF. This is the storage system name the command will be executed on.
Outputs
[Family: cluster]
Iterate over a list of fc objects.Inputs
- desired-attributes => fc-config, 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 => fc-config, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the fc object. All fc 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 fc objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
fc-config-set-adapter-fc-type changes the adapter driver and/or configuration state. Each configurable adapter has an adapter-type and adapter-state. The adapter-type indicates which driver is attached to the adapter, the adapter-state indicates what the configuration state of the adapter is. The fc-type is used to modify both the adapter-type and the adapter-state. After setting the adapter fc-type a filer reboot is sometimes needed to make the change effective. Use fc-config-list-info to determine if a filer reboot is needed.Inputs
- 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
- node-name => string, optional
This field is only valid when the request is sent to the Admin Vserver LIF. This is the storage system name the command will be executed on.
Outputs
[Family: cluster]
Bring a Fibre Channel target adapter offline. The adapter may not be offline immediately after the call returns, it may take up to a few seconds for the adapter to change state. In Data ONTAP 7-Mode, if the FCP service is not running then all adapters are automatically offlined. They cannot be brought online again until FCP service is started. adapter to change state. In Data ONTAP Cluster-Mode, offlining an adapter will operationally disable all FCP logical interfaces (LIFs) hosted by the adapter.Inputs
- node => string
The name of the storage system node where the adapter is installed.
Outputs
[Family: cluster]
Bring a Fibre Channel target adapter online. The adapter may not be online immediately after the call returns, it may take up to a few seconds for the adapter to initialize. In Data ONTAP 7-Mode, if the FCP service is not running then all adapters are automatically offlined. They cannot be brought online again until FCP service is started. In Data ONTAP Cluster-Mode, offlining an adapter will operationally disable all FCP logical interfaces (LIFs) hosted by the adapter.Inputs
- fcp-adapter => string
FC adapter to bring online.
- node => string
The name of the storage system node where the adapter is installed.
Outputs
[Family: cluster]
Iterate over the list of physical FC adapters.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 FC Adapter objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Sets the speed on the Fibre Channel target adapter. It can be configured to run at 1Gb, 2Gb, 4Gb, or to autonegotiate. Note only 4Gb adapters support the 4Gb speed. If the adapter is online it must be brought offline before setting the speed, and then online in order for a new speed to take effect. This may temporarily disrupt fcp service on the target adapter.Inputs
- fcp-adapter => string
FC Target adapter
- node => string
The name of the storage system node where the adapter is installed.
- speed => string
Link speed (in Gb). Possible values: "1", "2", "4", or "auto" (autonegotiate speed).
Outputs
[Family: cluster]
Iterate over a list of fcp objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 fcp objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster, vserver]
List all initiators connected to FCP target LIFs.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 connected FCP initiator objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster, vserver]
Iterate over a list of FCP Target Logical Interfaces (LIF).Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 FCP data LIF objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Get the current FCP World Wide Node Name (WWNN). This WWNN name is in the form XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit. In Data ONTAP 7-Mode, this is the WWNN of the individual storage system. In "single_image" cfmode, the WWNN of the system and its high availability partner will be the same. In Data ONTAP Cluster-Mode, this is the WWNN of the Vserver FCP Service.Inputs
Outputs
- node-name => string
Current FCP World Wide Node Name (WWNN).
[Family: vserver]
Set the current FCP World Wide Node Name (WWNN). This WWNN is in the form XX:XX:XX:XX:XX:XX:XX:XX where X is a hexadecimal digit. The supplied WWNN must also match the vendor's registered namespace unless the force argument is also supplied. In Data ONTAP 7-Mode, the registered namespace is "50:0a:80:8X:XX:XX:XX" and all Fibre Channel adapters must be offline. Changes will take place when the adapters are brought online. In Data ONTAP Cluster-Mode, the registered namespace is "2X:XX:00:a0:98:XX:XX:XX" and the FCP service must be offline. Changes will take place when the service is brought online.Inputs
- 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
[Family: cluster, vserver]
Iterate over the list of valid Fibre Channel target port names on a Vserver's FCP LIFs.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => fcp-port-name-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the Fibre Channel target port name object. All Fibre Channel target port name 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 Fibre Channel target port name objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
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
[Family: vserver]
Create an FCP Service in a Vserver. Each Vserver requires an online FCP Service in order to serve data via the Fibre Channel protocol.Inputs
- force-node-name => boolean, optional
If true, allow setting the WWNN to a value outside the vendor's registered namespace. If false, the node-name must match the namespace 2X:XX:00:a0:98:XX:XX:XX. The default is false.
- node-name => string, optional
The FCP World Wide Node Name (WWNN) for the FCP service. If not provided, one will be auto-generated.
- start => boolean, optional
Determine the initial state of the FCP Service. If true, the service will be automatically started after creation completes. If false, the service will be left in the stopped state and the caller must subsequently call fcp-service-start to start the service. The default is true.
Outputs
- node-name => string
The world-wide node name (WWNN) of the FCP target in the Vserver.
[Family: vserver]
Destroy the FCP Service in a Vserver.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the list of FCP Services.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 FCP Service objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Starts FCP service. When FCP service is started, the adapters are brought online. Service will be avaliable once the call returns with success. The adapters however, may not be available immediately after the call, it may take up to a few seconds for the adapters to initialize.Inputs
Outputs
[Family: vserver]
Get status of the FCP service, whether or not it is running.Inputs
Outputs
[Family: vserver]
Stops FCP service. When FCP service is stopped, the adapters are brought offline. Service will be unavaliable once the call returns with success.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the list of assigned World Wide Port Name (WWPN) aliases.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => aliases-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the WWPN aliases object. All WWPN aliases 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 WWPN aliases objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Remove an alias for a World Wide Port Name of an initiator. Either the alias or the wwpn argument must be provided.Inputs
- wwpn => string, optional
WWPN for which all aliases are to be removed. Either the wwpn or the alias argument must be provided.
Outputs
[Family: vserver]
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
[Family: cluster]
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.
- node-name => string
This field is only valid when the request is sent to the Admin Vserver LIF. This is the storage system name the command will be executed on.
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.
[Family: cluster, vserver]
Returns status information for managed features.Inputs
Outputs
[Family: cluster]
Manage the association of QoS policy group to a specified file. QoS Policy groups define measurable Service Level Objectives (SLOs) that apply to the storage object with which the policy group is associated. In Data ONTAP 8.2 hierarchical QoS is not supported i.e. QoS policy groups cannot be assigned to multiple objects in the file's storage hierarchy - such as the parent LUN, volume or Vserver.Inputs
- file => string
Complete file path of the file without a trailing slash.
- qos-policy-group-name => string
The QoS Policy Group Name that is to be associated with this file in order to enforce Service Level Objectives (SLO). NOTE: none is a reserved keyword for deleting the association of the file with a QoS policy group.
Outputs
[Family: vserver]
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
[Family: vserver]
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
[Family: vserver]
Delete a file.Inputs
- path => string
Path of the file or symlink to delete. The value is expected to begin with /vol/.
Outputs
[Family: vserver]
Obtains the file information or properties.Inputs
- path => string
Pathname of the directory to list. The value is expected to begin with /vol/.
Outputs
[Family: vserver]
Queries the space reservation settings for the named file.Inputs
- path => string
File to be queried.
Outputs
[Family: vserver]
Return ranges of holes in a fileInputs
- length => integer
The number of bytes to scan. If this is zero scan until end of file. If the length is not an integral multiple of the block size it will be rounded up to the end of the block. Range : [0..2^63-1]
- max-records => integer, optional
The maximum number of records to return in this call. Default: 64
- offset => integer
The starting offset of the file from where the scan for holes should begin. If the offset is not an integral multiple of the block size it will be rounded down to the start of the block. Range : [0..2^63-1]
- path => string
The full path of the file for which hole information is to be queried. Format must be of the following: /vol/my_vol/my_file
- 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 file objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
list of files in a given directory.Inputs
- max-records => integer, optional
Maximum number of directory entries to retrieve.
- path => string
Pathname of the directory to list. The value is expected to begin with /vol/.
- tag => string, optional
Should be empty for first call. For subsequent calls should be the value returned by next-tag below.
Outputs
- next-tag => string, optional
Tag to be used in the next call to continue iteration. Will not be returned if there are no more entries.
- num-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.
[Family: vserver]
Punch hole in the file. Hole punching involves reclaiming of blocks in a file by unallocating them and then direct or indirect blocks can be made to point to 0.Inputs
- attributes-list => hole-range-info[]
This is the array containing the ranges that need to be hole punched.
- path => string
Path of the file. Format must be of the following: /vol/my_vol/path-to-file
- tag => string, optional
Do not set on first iteration. Use value of next-tag on subseguent iterations.
Outputs
- next-tag => string, optional
Returned if not all ranges have been punched
[Family: vserver]
Read data from a named file. API will fail if length exceeds 1 MB. This API should only be used on normal files or streams associated with files. The results for other file types such as LUNs is undefined.Inputs
- length => integer
Number of bytes to read from the file.
- 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>".
- stream-name => string, optional
A stream is an on disk structure which contains a sequence of bytes, analogous to a file. A stream is always associated with exactly one file. Characters that are valid for a file name are also valid for the stream-name. e.g., "meta", "resource1". Use this option if the data should be read from the named stream associated with file specified by <path> Default is empty stream name, in which case the data is read from file specified by <path> This field is available in Data ONTAP 8.2 or later.
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.
[Family: vserver]
Rename a file or directory. Note that this API cannot be used to rename to a different volume.Inputs
- to-path => string
Final path of the file. The value must begin with /vol/. All path components except the final file name must already exist.
Outputs
[Family: vserver]
Sets the space reservation settings for the named file. is-overwrite-enabled and is-fill-enabled both must be the same value.Inputs
- path => string
File to be queried.
Outputs
[Family: vserver]
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
[Family: vserver]
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
[Family: vserver]
Used to poll and retrieve results for a previous file-usage-start call. EINPROGRESS indicates that the background job has not finished yet.Inputs
Outputs
- 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].
[Family: vserver]
Starts a background job to compute unique bytes held in a file. The result can be obtained by passing the cookie to file-usage-result-get call.Inputs
- 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.
[Family: vserver]
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>".
- stream-name => string, optional
A stream is an on disk structure which contains a sequence of bytes, analogous to a file. A stream is always associated with exactly one file. Characters that are valid for a file name are also valid for the stream-name. e.g., "meta", "resource1". Use this option if the data should be written to the named stream associated with file specified by <path> Default is empty stream name, in which case the data is written to file specified by <path> This field is available in Data ONTAP 8.2 or later.
Outputs
- length => integer
Number of bytes actually written.
[Family: vserver]
Returns security information of a file/folderInputs
- path => string
Specifies the file or folder path whose security information needs to be read. If volume-name or cifs-share-name is not specified, path name lookup starts from the root path of the vserver
Outputs
- effective-style => security-style-enum, optional
Effective security style of the file/folder. The 'unified' security style, which applies only to Infinite Volumes, cannot be applied to file/folder security. Possible values: - "unix" - NFS,
- "ntfs" - CIFS,
- "mixed" - Mixed,
- "unified" - Unified
- expanded-dos-attr => string, optional
Bitwise expanded DOS Attributes of the specified file/folder path. This field returns value if expand mask is true. Example follows,
DOS Attributes:
...0 .... .... .... = Offline
.... ..0. .... .... = Sparse
.... .... 0... .... = Normal
.... .... ..0. .... = Archive
.... .... ...1 .... = Directory
.... .... .... .0.. = System
.... .... .... ..0. = Hidden
.... .... .... ...0 = Read Only
- security-style => security-style-enum, optional
Security style of the file/folder. The 'unified' security style, which applies only to Infinite Volumes, cannot be applied to file/folder security. Possible values: - "unix" - NFS,
- "ntfs" - CIFS,
- "mixed" - Mixed,
- "unified" - Unified
[Family: vserver]
Creates a new NTFS security descriptorInputs
- control-flags-raw => integer, optional
Specifies the security descriptor control flags in hexa decimal. The following are the bit fields of control flags.
1... .... .... .... = Self Relative
.0.. .... .... .... = RM Control Valid
..0. .... .... .... = SACL Protected
...0 .... .... .... = DACL Protected
.... 0... .... .... = SACL Inherited
.... .0.. .... .... = DACL Inherited
.... ..0. .... .... = SACL Inherit Required
.... ...0 .... .... = DACL Inherit Required
.... .... ..0. .... = SACL Defaulted
.... .... ...0 .... = SACL Present
.... .... .... 0... = DACL Defaulted
.... .... .... .1.. = DACL Present
.... .... .... ..0. = Group Defaulted
.... .... .... ...0 = Owner Defaulted
At present only the following flags are honored. Others are ignored.
..0. .... .... .... = SACL Protected
...0 .... .... .... = DACL Protected
.... .... ..0. .... = SACL Defaulted
.... .... .... 0... = DACL Defaulted
.... .... .... ..0. = Group Defaulted
.... .... .... ...0 = Owner Defaulted
- return-record => boolean, optional
If set to true, returns the file-directory-security-ntfs on successful creation. Default: false
Outputs
[Family: vserver]
Add a discretionary access control entry to NTFS security descriptor.Inputs
- advanced-rights => advanced-access-rights[], optional
Specifies DACL ACE's Advanced access rights. Mutually exclusive with rights and rights-raw fields. Possible values: - "read_data" ,
- "write_data" ,
- "append_data" ,
- "read_ea" ,
- "write_ea" ,
- "execute_file" ,
- "delete_child" ,
- "read_attr" ,
- "write_attr" ,
- "delete" ,
- "read_perm" ,
- "write_perm" ,
- "write_owner" ,
- "full_control"
- ntfs-sd => fsecurity-ntfs-sd
Specifies NTFS security descriptor identifier.
- rights => access-rights, optional
Specifies DACL ACE's access rights. Mutually exclusive with advanced-rights and rights-raw fields. Possible values: - "no_access" ,
- "full_control" ,
- "modify" ,
- "read_and_execute" ,
- "read" ,
- "write"
- rights-raw => integer, optional
Specifies DACL ACE's access rights in raw. This field is similar to advanced-rights fields. 'advanced-rights' specifies the value in enum but rights-raw specifies the access rights in integer format. Mutually exclusive with rights and advanced-rights fields.
Outputs
[Family: cluster, vserver]
Returns information about one or more discretionary access control entriesInputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 file-directory-security-ntfs-dacl objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify an discretionary access control entry of a file security descriptorInputs
- access-type => access-type
Specifies DACL ACE's access type. Possible values:
- account => name-or-sid
Specifies DACL ACE's SID or domain account name of NTFS security descriptor.
- advanced-rights => advanced-access-rights[], optional
Specifies DACL ACE's Advanced access rights. Mutually exclusive with rights and rights-raw fields. Possible values: - "read_data" ,
- "write_data" ,
- "append_data" ,
- "read_ea" ,
- "write_ea" ,
- "execute_file" ,
- "delete_child" ,
- "read_attr" ,
- "write_attr" ,
- "delete" ,
- "read_perm" ,
- "write_perm" ,
- "write_owner" ,
- "full_control"
- apply-to => inheritance-level[], optional
Specifies this ACE has to be applied on. Possible values: - "this_folder" ,
- "sub_folders" ,
- "files"
- ntfs-sd => fsecurity-ntfs-sd
Specifies NTFS security descriptor identifier.
- rights => access-rights, optional
Specifies DACL ACE's access rights. Mutually exclusive with advanced-rights and rights-raw fields. Possible values: - "no_access" ,
- "full_control" ,
- "modify" ,
- "read_and_execute" ,
- "read" ,
- "write"
- rights-raw => integer, optional
Specifies DACL ACE's access rights in raw. This field is similar to advanced-rights fields. 'advanced-rights' specifies the value in enum but rights-raw specifies the access rights in integer format. Mutually exclusive with rights and advanced-rights fields.
Outputs
[Family: vserver]
Remove a discretionary access control entry from NTFS security descriptor.Inputs
- access-type => access-type
Specifies DACL ACE's access type. Possible values:
- account => name-or-sid
Specifies DACL ACE's SID or domain account name of NTFS security descriptor.
- ntfs-sd => fsecurity-ntfs-sd
Specifies NTFS security descriptor identifier.
Outputs
[Family: vserver]
Deletes an NTFS security descriptor informationInputs
- ntfs-sd => fsecurity-ntfs-sd
Specifies NTFS security descriptor identifier.
Outputs
[Family: cluster, vserver]
Returns information about one or more NTFS security descriptorInputs
- desired-attributes => file-directory-security-ntfs, 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 => file-directory-security-ntfs, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the file-directory-security-ntfs object. All file-directory-security-ntfs 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 file-directory-security-ntfs objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modifies an NTFS security descriptorInputs
- control-flags-raw => integer, optional
Specifies the security descriptor control flags in hexa decimal. The following are the bit fields of control flags.
1... .... .... .... = Self Relative
.0.. .... .... .... = RM Control Valid
..0. .... .... .... = SACL Protected
...0 .... .... .... = DACL Protected
.... 0... .... .... = SACL Inherited
.... .0.. .... .... = DACL Inherited
.... ..0. .... .... = SACL Inherit Required
.... ...0 .... .... = DACL Inherit Required
.... .... ..0. .... = SACL Defaulted
.... .... ...0 .... = SACL Present
.... .... .... 0... = DACL Defaulted
.... .... .... .1.. = DACL Present
.... .... .... ..0. = Group Defaulted
.... .... .... ...0 = Owner Defaulted
At present only the following flags are honored. Others are ignored.
..0. .... .... .... = SACL Protected
...0 .... .... .... = DACL Protected
.... .... ..0. .... = SACL Defaulted
.... .... .... 0... = DACL Defaulted
.... .... .... ..0. = Group Defaulted
.... .... .... ...0 = Owner Defaulted
- group => name-or-sid, optional
Specifies group's SID or domain account name of NTFS security descriptor.
- ntfs-sd => fsecurity-ntfs-sd
Specifies NTFS security descriptor identifier.
- owner => name-or-sid, optional
Specifies owner's SID or domain account name of NTFS security descriptor.
Outputs
[Family: vserver]
Add a system/audit access control entry to NTFS security descriptor.Inputs
- account => name-or-sid
Specifies SACL ACE's SID or domain account name of NTFS security descriptor.
- advanced-rights => advanced-access-rights[], optional
Specifies SACL ACE's access rights. Mutually exclusive with rights-raw field. Possible values: - "read_data" ,
- "write_data" ,
- "append_data" ,
- "read_ea" ,
- "write_ea" ,
- "execute_file" ,
- "delete_child" ,
- "read_attr" ,
- "write_attr" ,
- "delete" ,
- "read_perm" ,
- "write_perm" ,
- "write_owner" ,
- "full_control"
- apply-to => inheritance-level[], optional
Specifies how this ACE has to be applied on this folder and it's subfolders and files. This field is ignored if the security is mapped with a path which is not a folder. Possible values: - "this_folder" ,
- "sub_folders" ,
- "files"
- ntfs-sd => fsecurity-ntfs-sd
Specifies NTFS security descriptor identifier.
- rights => access-rights, optional
Specifies SACL ACE's access rights. Possible values: - "no_access" ,
- "full_control" ,
- "modify" ,
- "read_and_execute" ,
- "read" ,
- "write"
- rights-raw => integer, optional
Specifies SACL ACE's access rights in raw. This field is similar to advanced-rights fields. 'advanced-rights' specifies the value in enum but rights-raw specifies the access rights in integer format. Mutually exclusive with rights and advanced-rights fields.
Outputs
[Family: cluster, vserver]
Returns information about one or more system/audit access control entriesInputs
- desired-attributes => file-directory-security-ntfs-sacl, 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 => file-directory-security-ntfs-sacl, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the file-directory-security-ntfs-sacl object. All file-directory-security-ntfs-sacl 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 file-directory-security-ntfs-sacl objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify an system/audit access control entry of a file security descriptorInputs
- account => name-or-sid
Specifies SACL ACE's SID or domain account name of NTFS security descriptor.
- advanced-rights => advanced-access-rights[], optional
Specifies SACL ACE's access rights. Mutually exclusive with rights-raw field. Possible values: - "read_data" ,
- "write_data" ,
- "append_data" ,
- "read_ea" ,
- "write_ea" ,
- "execute_file" ,
- "delete_child" ,
- "read_attr" ,
- "write_attr" ,
- "delete" ,
- "read_perm" ,
- "write_perm" ,
- "write_owner" ,
- "full_control"
- apply-to => inheritance-level[], optional
Specifies how this ACE has to be applied on this folder and it's subfolders and files. This field is ignored if the security is mapped with a path which is not a folder. Possible values: - "this_folder" ,
- "sub_folders" ,
- "files"
- audit-access-type => audit-access-type
Specifies SACL ACE's access type. Possible values:
- ntfs-sd => fsecurity-ntfs-sd
Specifies NTFS security descriptor identifier.
- rights => access-rights, optional
Specifies SACL ACE's access rights. Possible values: - "no_access" ,
- "full_control" ,
- "modify" ,
- "read_and_execute" ,
- "read" ,
- "write"
- rights-raw => integer, optional
Specifies SACL ACE's access rights in raw. This field is similar to advanced-rights fields. 'advanced-rights' specifies the value in enum but rights-raw specifies the access rights in integer format. Mutually exclusive with rights and advanced-rights fields.
Outputs
[Family: vserver]
Remove an system/audit access control entry from NTFS security descriptor.Inputs
- account => name-or-sid
Specifies SACL ACE's SID or domain account name of NTFS security descriptor.
- audit-access-type => audit-access-type
Specifies SACL ACE's access type. Possible values:
- ntfs-sd => fsecurity-ntfs-sd
Specifies NTFS security descriptor identifier.
Outputs
[Family: vserver]
Creates a new file/folder security policy configuration. To preserve the security configuration of a file(or, folder) or set of files(or, folders) security policy has been defined. Policy is a container for tasks and a task associates a file/folder path name and the security descriptor that needs to be set on the file/folder. Every task in a policy is uniquely identified by the file/folder path. Policy can't have duplicate task entries and there is only one task per path.Inputs
- policy-name => fsecurity-policy-name
Specifies the name of the policy. To preserve the security configuration of a file(or, folder) or set of files(or, folders) security policy has been defined. Policy is a container for tasks and a task associates a file/folder path name and the security descriptor that needs to be set on the file/folder. Every task in a policy is uniquely identified by the file/folder path. Policy can't have duplicate task entries and there is only one task per path.
- return-record => boolean, optional
If set to true, returns the file-directory-security-policy on successful creation. Default: false
Outputs
[Family: vserver]
Deletes a file/folder security policy. To preserve the security configuration of a file(or, folder) or set of files(or, folders) security policy has been defined. Policy is a container for tasks and a task associates a file/folder path name and the security descriptor that needs to be set on the file/folder. Every task in a policy is uniquely identified by the file/folder path. Policy can't have duplicate task entries and there is only one task per path.Inputs
- policy-name => fsecurity-policy-name
Specifies the name of the policy. To preserve the security configuration of a file(or, folder) or set of files(or, folders) security policy has been defined. Policy is a container for tasks and a task associates a file/folder path name and the security descriptor that needs to be set on the file/folder. Every task in a policy is uniquely identified by the file/folder path. Policy can't have duplicate task entries and there is only one task per path.
Outputs
[Family: cluster, vserver]
Returns information about one or more security policies. To preserve the security configuration of a file(or, folder) or set of files(or, folders) security policy has been defined. Policy is a container for tasks and a task associates a file/folder path name and the security descriptor that needs to be set on the file/folder. Every task in a policy is uniquely identified by the file/folder path. Policy can't have duplicate task entries and there is only one task per path.Inputs
- desired-attributes => file-directory-security-policy, 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
- 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 file-directory-security-policy objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Add a file security policy task. A task maps security descriptor with a file or folder.Inputs
- path => string
Specifies the file or folder path of the task.
- policy-name => fsecurity-policy-name
Specifies the name of the policy to which the task needs to be added.
- task-index-number => integer, optional
Specifies the target index/position of this task in the policy. If a policy has already 5 tasks and this is the 6th task you are adding and you want to add this task as 2nd task, you can specifiy the index 2. By default the task gets added as last task. If the index number exceeds the number of positions, it will go at the end.
Outputs
[Family: cluster, vserver]
Returns information about one or more policy tasks. Policy is a container for tasks and a task associates a file/folder path name and the security descriptor that needs to be set on the file/folder. Every task in a policy is uniquely identified by the file/folder path. Policy can't have duplicate task entries and there is only one task per path.Inputs
- desired-attributes => file-directory-security-policy-task, 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 => file-directory-security-policy-task, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the file-directory-security-policy-task object. All file-directory-security-policy-task 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 file-directory-security-policy-task objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify a file security policy taskInputs
- ntfs-mode => ntfs-propagation-mode, optional
Specifies the NTFS propagation mode. Possible values: - "propagate" ,
- "ignore" ,
- "replace"
- ntfs-sd => fsecurity-ntfs-sd, optional
Specifies the NTFS security descriptor identifier.
- path => string
Specifies the file or folder path of a task.
- policy-name => fsecurity-policy-name
Specifies the name of the policy who has the task.
- security-type => security-type, optional
Specifies the type of security. Possible values:
- task-index-number => integer, optional
Specifies the target index/position of this task in the policy. If the task is currently placed in 5th position in a policy and you want to reorder this task as 2nd task, you can set the index-num to 2. If the index number exceeds the number of positions, it will go at the end.
Outputs
[Family: vserver]
Remove a task from the policy of a vserver.Inputs
- path => string
Specifies the file or folder path of the task.
- policy-name => fsecurity-policy-name
Specifies the name of the policy from which the task has been removed.
Outputs
[Family: vserver]
Apply security descriptors on files and directories defined in a policy to a VserverInputs
- policy-name => fsecurity-policy-name
Specifies the name of the policy whose security settings have to be applied.
Outputs
[Family: vserver]
Create audit configuration for a VserverInputs
- destination => string
Audit log destination path. The path where consolidated audit logs are stored. If the path is not valid, the api returns error
- return-record => boolean, optional
If set to true, returns the fileservice-audit-config on successful creation. Default: false
- rotate-schedule-hour => cron-hour[], optional
Audit log rotation schedule: Hour. By Default rotation is done based on size. This field is mutually exclusive with rotate-size. Do not use this field along with rotate-size field
- rotate-size => psize, optional
Audit log file size limit. By default rotation is done based on size. This field is mutually exclusive with time related rotate fields. If time based rotation is needed use the time based rotation fields(rotate-schedule-month, rotate-schedule-dayofweek, rotate-schedule-day... etc). Default: 100MB
Outputs
[Family: vserver]
Show Audit configuration details for a VserverInputs
Outputs
[Family: cluster, vserver]
Show Audit configuration details for all VserversInputs
- desired-attributes => fileservice-audit-config, 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
- 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 fileservice-audit-config objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Return the total number of recordsInputs
Outputs
- count => integer
The total number of fileservice-audit-config objects.
[Family: vserver]
Modify audit configuration for a VserverInputs
- audit-guarantee => boolean, optional
Strict guarantee of auditing for a Vserver. If this is true, file access is denied if audit record can not be generated and if this is false, auditing is done on a best effort basis. Default: true
- destination => string, optional
Audit log destination path. The path where consolidated audit logs are stored. If the path is not valid, the api returns error
- rotate-limit => integer, optional
Audit log files rotation Limit. A value of 0 indicates that all the files will be retained. Default: 0
- rotate-schedule-day => cron-day-of-month[], optional
Audit log rotation schedule: Day. By Default rotation is done based on size. This field is mutually exclusive with rotate-size. Do not use this field along with rotate-size field
- rotate-schedule-dayofweek => cron-day-of-week[], optional
Audit log rotation schedule: Day of Week. By Default rotation is done based on size. This field is mutually exclusive with rotate-size. Do not use this field along with rotate-size field
- rotate-schedule-hour => cron-hour[], optional
Audit log rotation schedule: Hour. By Default rotation is done based on size. This field is mutually exclusive with rotate-size. Do not use this field along with rotate-size field
- rotate-schedule-minute => cron-minute[], optional
Audit Log rotation schedule: Minute. By Default rotation is done based on size. This field is mutually exclusive with rotate-size. Do not use this field along with rotate-size field
- rotate-schedule-month => cron-month[], optional
Audit log rotation schedule: Month. By Default rotation is done based on size. This field is mutually exclusive with rotate-size. Do not use this field along with rotate-size field
- rotate-size => psize, optional
Audit log file size limit. By default rotation is done based on size. This field is mutually exclusive with time related rotate fields. If time based rotation is needed use the time based rotation fields(rotate-schedule-month, rotate-schedule-dayofweek, rotate-schedule-day... etc). Default: 100MB
Outputs
[Family: vserver]
Disable Auditing for specified VserverInputs
Outputs
[Family: vserver]
Enable Auditing for specified VserverInputs
Outputs
[Family: vserver]
Disable Audit Configuration for specified vserverInputs
- force => boolean
Force Delete
Outputs
[Family: cluster]
Iterate over a list of Flash Cache device info objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => flash-device-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the Flash Cache device info object. All Flash Cache device info 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 Flash Cache device info objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
This API is used to retrieve information about the flash devices in the controller registered with Flash Management Module (FMM).Inputs
- node => string
The name of the system where the flash device is installed.
Outputs
[Family: cluster]
Get threshold profiles available in Flash Management Module.Inputs
- node => string
The name of the system to which the flash thresholds apply.
Outputs
[Family: cluster]
Iterate over a list of Flash Cache threshold profiles objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 Flash Cache threshold profiles objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Create a new flexcache-cache-policy.Inputs
- cache-policy-name => string
The name of the FlexCache Cache Policy being created, modified or deleted. The maximum length is 255 characters.
- deleg-lru-timeout => integer, optional
The Timeout for the Delegations LRU represents the time in seconds since the last use of the delegation, after which a Cache considers it unused and returns it to Origin.
- return-record => boolean, optional
If set to true, returns the flexcache-cache-policy on successful creation. Default: false
- time-to-live-directories => integer
The Time To Live (TTL) for Directories represents the time, in seconds, that attributes and data of a Directory are served from the Cache volume before they are verified with the Origin volume.
- time-to-live-files => integer
The Time To Live (TTL) for files represents the time, in seconds, that attributes and data of a file are served from the Cache volume before they are verified with the Origin volume.
- time-to-live-metafiles => integer, optional
The Time To Live (TTL) for ONTAP Metafiles represents the time, in seconds, that attributes and data of an ONTAP Metafile are served from the Cache volume before they are verified with the Origin volume.
- time-to-live-other => integer, optional
The Time To Live (TTL) for any file that doesn't fall into the other TTL categories represents the time, in seconds, that attributes and data of that file are served from the Cache volume before they are verified with the Origin volume.
- time-to-live-symbolic => integer, optional
The Time To Live (TTL) for Symbolic Links represents the time, in seconds, that attributes and data of a Symbolic Link are served from the Cache volume before they are verified with the Origin volume.
- vserver => string
The name of the managing Vserver. Maximum length is 255 characters.
Outputs
[Family: cluster]
Delete an existing flexcache-cache-policy object.Inputs
- cache-policy-name => string
The name of the FlexCache Cache Policy being created, modified or deleted. The maximum length is 255 characters.
- vserver => string
The name of the managing Vserver. Maximum length is 255 characters.
Outputs
[Family: cluster]
Get the attributes of the flexcache-cache-policy.Inputs
- cache-policy-name => string
The name of the FlexCache Cache Policy being created, modified or deleted. The maximum length is 255 characters.
- vserver => string
The name of the managing Vserver. Maximum length is 255 characters.
Outputs
[Family: cluster]
Iterate over a list of flexcache-cache-policy objects.Inputs
- desired-attributes => flexcache-cache-policy-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
- 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 flexcache-cache-policy objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modify the attributes of flexcache-cache-policy object.Inputs
- cache-policy-name => string
The name of the FlexCache Cache Policy being created, modified or deleted. The maximum length is 255 characters.
- deleg-lru-timeout => integer, optional
The Timeout for the Delegations LRU represents the time in seconds since the last use of the delegation, after which a Cache considers it unused and returns it to Origin.
- prefer-local-cache => boolean, optional
If set to true, data is served from the local cache, otherwise from the local origin.
- time-to-live-directories => integer, optional
The Time To Live (TTL) for Directories represents the time, in seconds, that attributes and data of a Directory are served from the Cache volume before they are verified with the Origin volume.
- time-to-live-files => integer, optional
The Time To Live (TTL) for files represents the time, in seconds, that attributes and data of a file are served from the Cache volume before they are verified with the Origin volume.
- time-to-live-metafiles => integer, optional
The Time To Live (TTL) for ONTAP Metafiles represents the time, in seconds, that attributes and data of an ONTAP Metafile are served from the Cache volume before they are verified with the Origin volume.
- time-to-live-other => integer, optional
The Time To Live (TTL) for any file that doesn't fall into the other TTL categories represents the time, in seconds, that attributes and data of that file are served from the Cache volume before they are verified with the Origin volume.
- time-to-live-symbolic => integer, optional
The Time To Live (TTL) for Symbolic Links represents the time, in seconds, that attributes and data of a Symbolic Link are served from the Cache volume before they are verified with the Origin volume.
- vserver => string
The name of the managing Vserver. Maximum length is 255 characters.
Outputs
[Family: cluster, vserver]
Create cluster-wide caching for a given volume.Inputs
- vserver => string
Vserver
Outputs
[Family: cluster, vserver]
Delete cluster-wide caching for a given volume.Inputs
- origin-volume => string
Origin Volume Name
- vserver => string
Vserver Name
Outputs
[Family: vserver]
Get the attributes of the flexcache.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of flexcache objects.Inputs
- desired-attributes => flexcache-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 => flexcache-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the flexcache object. All flexcache 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 flexcache objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Get the cluster-wide attributes of FlexCache.Inputs
Outputs
[Family: cluster]
Modify the cluster-wide attributes of FlexCache.Inputs
Outputs
[Family: vserver]
Disables a specific named policy.Inputs
- policy-name => string
Name of the policy.
Outputs
[Family: vserver]
Enables a specific named policy. The operation will fail if the policy doesn't exist.Inputs
- policy-name => string
Name of the policy.
Outputs
[Family: vserver]
Create a policy.Inputs
- is-mandatory => boolean, optional
Indicator if the screening with this policy is required, i.e. it will fail if no servers are able process the notification registered as a part of external engine. 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 value is true.
- return-record => boolean, optional
If set to true, returns the fpolicy-policy on successful creation. Default: false
Outputs
[Family: vserver]
Delete a policy.Inputs
- policy-name => policy-name
Name of the policy.
Outputs
[Family: vserver]
Create FPolicy Event.Inputs
- file-operations => fpolicy-operation[], optional
Name of file operations. By default no operations are monitored. Possible values: - "close" - File close operation,
- "create" - File create operation,
- "create_dir" - File create directory operation,
- "delete" - File delete operation,
- "delete_dir" - Directory delete operation,
- "getattr" - Get attribute operation,
- "link" - Link operation,
- "lookup" - Lookup operation,
- "open" - File open operation,
- "read" - File read operation,
- "write" - File write operation,
- "rename" - File rename operation,
- "rename_dir" - Directory rename operation,
- "setattr" - Set attribute operation,
- "symlink" - Symbolic link operation
- filter-string => fpolicy-filter[], optional
Name of filters. It is notification filtering parameters. By default no filters are selected. Possible values: - "monitor_ads" - Monitor alternate data stream,
- "close_with_modification" - Filter close with modification,
- "close_without_modification" - Filter close without modification,
- "first_read" - Filter first read,
- "first_write" - Filter first write,
- "offline_bit" - Filter offline bit set,
- "open_with_delete_intent" - Filter open with delete intent,
- "open_with_write_intent" - Filter open with write intent,
- "write_with_size_change" - Filter write with size change
- protocol => fpolicy-proto, optional
Name of protocol for which event is created. By default no protocol is selected. Possible values: - "cifs" - CIFS protocol,
- "nfsv3" - NFSv3 protocol,
- "nfsv4" - NFSv4 protocol
- return-record => boolean, optional
If set to true, returns the fpolicy-policy-event on successful creation. Default: false
Outputs
[Family: vserver]
Delete FPolicy event.Inputs
- event-name => event-name
Name of the Event.
Outputs
[Family: cluster, vserver]
Get a list of rows for FPolicy event options. FPolicy event is consist of protocol, file operations, vo lume operation and filters.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 fpolicy-policy-event objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Set FPolicy event options. FPolicy event is consist of protocol, file operation, volume operation and f ilters.Inputs
- event-name => event-name
Name of the Event.
- file-operations => fpolicy-operation[], optional
Name of file operations. By default no operations are monitored. Possible values: - "close" - File close operation,
- "create" - File create operation,
- "create_dir" - File create directory operation,
- "delete" - File delete operation,
- "delete_dir" - Directory delete operation,
- "getattr" - Get attribute operation,
- "link" - Link operation,
- "lookup" - Lookup operation,
- "open" - File open operation,
- "read" - File read operation,
- "write" - File write operation,
- "rename" - File rename operation,
- "rename_dir" - Directory rename operation,
- "setattr" - Set attribute operation,
- "symlink" - Symbolic link operation
- filter-string => fpolicy-filter[], optional
Name of filters. It is notification filtering parameters. By default no filters are selected. Possible values: - "monitor_ads" - Monitor alternate data stream,
- "close_with_modification" - Filter close with modification,
- "close_without_modification" - Filter close without modification,
- "first_read" - Filter first read,
- "first_write" - Filter first write,
- "offline_bit" - Filter offline bit set,
- "open_with_delete_intent" - Filter open with delete intent,
- "open_with_write_intent" - Filter open with write intent,
- "write_with_size_change" - Filter write with size change
- protocol => fpolicy-proto, optional
Name of protocol for which event is created. By default no protocol is selected. Possible values: - "cifs" - CIFS protocol,
- "nfsv3" - NFSv3 protocol,
- "nfsv4" - NFSv4 protocol
- volume-operation => boolean, optional
Indicator if the volume operation required for the event.Default Value is false.
Outputs
[Family: vserver]
Create an external engine.Inputs
- engine-name => engine-name
Name of the external engine.
- extern-engine-type => external-engine-type, optional
External engine type. If the engine is asynchronous, no reply is sent from FPolicy servers. Default value set for this field is synchronous. Possible values: - "synchronous" - Synchronous External Engine,
- "asynchronous" - Asynchronous External Engine
- return-record => boolean, optional
If set to true, returns the fpolicy-policy-external-engine on successful creation. Default: false
- server-progress-timeout => integer, optional
Timeout in seconds in which a throttled FPolicy server must complete at least one screen request. If no request is processed within the timeout, connection to FPolicy server is terminated. Default value set for this field is 60 seconds.
- ssl-option => fpolicy-ssl-opts
SSL option for external communication. No default value is set for this field. Possible values: - "no_auth" - Communication over TCP,
- "server_auth" - Authentication of FPolicy server only,
- "mutual_auth" - Mutual authentication of storage system and FPolicy server
Outputs
[Family: vserver]
Delete an external engine.Inputs
- engine-name => engine-name
Name of the external engine.
Outputs
[Family: cluster, vserver]
Returns information on external engines.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 fpolicy-policy-external-engine objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify an engine.Inputs
- certificate-ca => string, optional
Certificate authority name. No default value is set for this field.
- certificate-common-name => common-name, optional
FQDN or custom common name of certificate. No default value is set for this field.
- certificate-serial => string, optional
Serial number of certificate. No default value is set for this field.
- engine-name => engine-name
Name of the external engine.
- extern-engine-type => external-engine-type, optional
External engine type. If the engine is asynchronous, no reply is sent from FPolicy servers. Default value set for this field is synchronous. Possible values: - "synchronous" - Synchronous External Engine,
- "asynchronous" - Asynchronous External Engine
- keep-alive-interval => integer, optional
Interval time in seconds for storage appliance to send keep-alive message to FPolicy server. Default value set for this field is 10 seconds.
- max-connection-retries => integer, optional
Number of times storage appliance will attempt to establish a broken connection to FPolicy server. Default value set for this field is 5.
- max-server-requests => integer, optional
Maximum number of outstanding screen requests that will be queued for an FPolicy Server. Default value set for this field is 50.
- request-abort-timeout => integer, optional
Timeout in seconds for a screen request to be aborted by storage appliance. Default value set for this field is 40 seconds.
- request-cancel-timeout => integer, optional
Timeout in seconds for a screen request to be processed by an FPolicy server. Default value set for this field is 20 seconds.
- secondary-servers => ip-address[], optional
Secondary FPolicy servers. No default value is set for this field.
- server-progress-timeout => integer, optional
Timeout in seconds in which a throttled FPolicy server must complete at least one screen request. If no request is processed within the timeout, connection to FPolicy server is terminated. Default value set for this field is 60 seconds.
- ssl-option => fpolicy-ssl-opts, optional
SSL option for external communication. No default value is set for this field. Possible values: - "no_auth" - Communication over TCP,
- "server_auth" - Authentication of FPolicy server only,
- "mutual_auth" - Mutual authentication of storage system and FPolicy server
- status-request-interval => integer, optional
Interval time in seconds for storage appliance to query status request from FPolicy server. Default value set for this field is 10 seconds.
Outputs
[Family: cluster, vserver]
Returns information about policies.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 fpolicy-policy objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify a policy.Inputs
- allow-privileged-access => boolean, optional
Indicator if privileged access should be given to FPolicy servers registered for the policy. Default Value is no.
- is-mandatory => boolean, optional
Indicator if the screening with this policy is required, i.e. it will fail if no servers are able process the notification registered as a part of external engine. 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 value is true.
- policy-name => policy-name
Name of the policy.
- privileged-user-name => string, optional
User name for privileged access. No default value is set for this attribute.
Outputs
[Family: vserver]
Set FPolicy scope options. FPolicy Scope is consist of share, volume, export policy, volume, file extention.Inputs
- policy-name => policy-name
Name of the policy.
- return-record => boolean, optional
If set to true, returns the fpolicy-policy-scope on successful creation. Default: false
- volumes-to-exclude => string[], optional
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. By default no volume is selected.
- volumes-to-include => string[], optional
Volumes that are active for the file policy. The list can include items which are regular expressions, such as 'vol*' or 'user?'. By default no volume is selected.
Outputs
[Family: vserver]
Delete a scope.Inputs
- policy-name => policy-name
Name of the policy.
Outputs
[Family: cluster, vserver]
Get a list of rows for FPolicy scope options. FPolicy Scope consists of share, volume, export policy, volume, file extention.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 fpolicy-policy-scope objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Set FPolicy scope options. FPolicy Scope is consist of share, volume, export policy, volume, file extention.Inputs
- check-extensions-on-directories => boolean, optional
Indicates whether directory names are also subjected to extensions check, similar to file names. By default, the value is false.
- export-policies-to-exclude => string[], optional
Export Policies to exclude for file access monitoring. By default no export policy is selected.
- export-policies-to-include => string[], optional
Export policies to include for file access monitoring. By default no export policy is selected.
- file-extensions-to-exclude => string[], optional
File extensions excluded for screening. By default no file extension is selected.
- file-extensions-to-include => string[], optional
File extensions included for screening. By default no file extension is selected.
- policy-name => policy-name
Name of the policy.
- shares-to-exclude => string[], optional
Shares to exclude for file access monitoring. By default no share is selected.
- shares-to-include => string[], optional
Shares to include for file access monitoring. By default no share is selected.
- volumes-to-exclude => string[], optional
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. By default no volume is selected.
- volumes-to-include => string[], optional
Volumes that are active for the file policy. The list can include items which are regular expressions, such as 'vol*' or 'user?'. By default no volume is selected.
Outputs
[Family: cluster, vserver]
Returns FPolicy policy status information.Inputs
- desired-attributes => fpolicy-policy-status-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
- 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 fpolicy-policy-status objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Make a connection to FPolicy serverInputs
- node => string
Cluster node name.
- policy-name => policy-name
Name of the policy.
Outputs
[Family: vserver]
Terminate connection to FPolicy serverInputs
- node => string
Cluster node name.
- policy-name => policy-name
Name of the policy.
- server => ip-address
FPolicy server.
Outputs
[Family: cluster, vserver]
Returns FPolicy server status information.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 fpolicy-server-status objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster, vserver]
Get the list of entries of the applied GPO rules, organized on a per-Vserver basis.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 gpo objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster, vserver]
Retrieve the Vserver's group policy configuration.Inputs
- desired-attributes => gpo-config, 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 => gpo-config, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the gpo object. All gpo 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 gpo objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster, vserver]
Get a list of entries of the GPO RSoP(Resultant Set of Policy) data, organized on a per-Vserver basis.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 gpo objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Change the Vserver's group policy configuration.Inputs
Outputs
[Family: vserver]
Download and apply the latest version of the group policy defined in Active Directory.Inputs
Outputs
[Family: vserver]
Create a new group mapping for a Vserver.Inputs
- direction => name-mapping-direction
Direction in which the group mapping is applied. Possible values: - "krb_unix" - Kerberos principal name to UNIX user name mapping,
- "win_unix" - Windows user name to UNIX user name mapping,
- "unix_win" - UNIX user name to Windows user name mapping
- pattern => string
Pattern to use to match the group while searching for a group that can be used as a replacement. The pattern is a UNIX-style regular expression. Regular expressions are case-insensitive when mapping from Windows to UNIX, and they are case-sensitive for mappings from Kerberos to UNIX and UNIX to Windows.
- position => integer
Position of an existing group mapping in the list of group mappings for this Vserver.
- replacement => string
The group that is to be used as a replacement if the pattern associated with this entry matches. The replacement is a string containing escape sequences representing subexpressions from the pattern, as in the UNIX 'sed' program.
- return-record => boolean, optional
If set to true, returns the group-mapping on successful creation. Default: false
Outputs
[Family: vserver]
Delete an existing group mapping entry.Inputs
- direction => name-mapping-direction
Direction in which the group mapping is applied. Possible values: - "krb_unix" - Kerberos principal name to UNIX user name mapping,
- "win_unix" - Windows user name to UNIX user name mapping,
- "unix_win" - UNIX user name to Windows user name mapping
- position => integer
Position of an existing group mapping in the list of group mappings for this Vserver.
Outputs
[Family: cluster, vserver]
Retrieve the list of group mappings in the cluster.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 group-mapping objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Insert a group mapping into the table at a specified position.Inputs
- direction => name-mapping-direction
Direction of the group mapping to be inserted. Possible values: - "krb_unix" - Kerberos principal name to UNIX user name mapping,
- "win_unix" - Windows user name to UNIX user name mapping,
- "unix_win" - UNIX user name to Windows user name mapping
- pattern => string
Pattern to use to match the name while searching for a name that can be used as a replacement. The pattern is a UNIX-style regular expression. Regular expressions are case-insensitive when mapping from Windows to UNIX, and they are case-sensitive for mappings from Kerberos to UNIX and UNIX to Windows.
- position => integer
Position within the set of group mappings that this new mapping will take. If a mapping already exists at this position, it will be moved to the next position in the list.
- replacement => string
The name that is to be used as a replacement if the pattern associated with this entry matches. The replacement may be a string containing escape sequences representing subexpressions from the pattern, as in the UNIX 'sed' program.
Outputs
[Family: vserver]
Modify an existing group mapping entry.Inputs
- direction => name-mapping-direction
Direction in which the group mapping is applied. Possible values: - "krb_unix" - Kerberos principal name to UNIX user name mapping,
- "win_unix" - Windows user name to UNIX user name mapping,
- "unix_win" - UNIX user name to Windows user name mapping
- pattern => string, optional
Pattern to use to match the group while searching for a group that can be used as a replacement. The pattern is a UNIX-style regular expression. Regular expressions are case-insensitive when mapping from Windows to UNIX, and they are case-sensitive for mappings from Kerberos to UNIX and UNIX to Windows.
- position => integer
Position of an existing group mapping in the list of group mappings for this Vserver.
- replacement => string, optional
The group that is to be used as a replacement if the pattern associated with this entry matches. The replacement is a string containing escape sequences representing subexpressions from the pattern, as in the UNIX 'sed' program.
Outputs
[Family: vserver]
Swap the position of one group mapping with another. The position is the place in the sequence of group mappings in which the mappings are applied.Inputs
- position => integer
Position of an existing group mapping in the list of group mappings for this Vserver.
- with-position => integer
Position of an existing group mapping entry in the list of group mappings for this Vserver. This entry will be swapped with the entry at 'position'.
Outputs
[Family: vserver]
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
[Family: vserver]
Bind an existing igroup to a given portset.Inputs
- initiator-group-name => string
Name of initiator group to bind the portset to.
Outputs
[Family: vserver]
Creates a new initiator group. In Data ONTAP 7.3 and upto ONTAP 8.0, the ALUA (Asymmetiric Logical Unit Access) attribute will be enabled by default if initiator-group-type is "fcp" and os-type is "aix", "hpux", or "linux. In Data ONTAP 7-mode 8.1 and later, the ALUA attribute is enabled by default for all os-type if initiator-group-type is "fcp". In Data ONTAP Cluster-Mode 8.1 and later, the ALUA attribute is enabled by default on all initiator groups.Inputs
- 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
[Family: vserver]
Destroys an existing initiator group. By default a group cannot be destroyed if there are existing lun maps defined for that group. This behaviour can be overridden with the use of force option set to "true" which will destroy the initiator group and any associated lun maps.Inputs
- 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
[Family: cluster, vserver]
Iterate over a list of igroup objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 igroup objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
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.
[Family: vserver]
Removes node(s) from an initiator group. The operation is prohibited if there are existing lun maps defined for that group. The force option set to "true" can be used to forcibly remove the node regardless of mappings.Inputs
- 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
[Family: vserver]
Rename an existing initiator group. The rename operation is non-disruptive.Inputs
- initiator-group-name => string
Name of initiator group to be renamed.
Outputs
[Family: vserver]
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
[Family: vserver]
Unbind an existing igroup from a portset.Inputs
- initiator-group-name => string
Name of initiator group to unbind from the portset.
Outputs
[Family: vserver]
Generate a 128 bit random password that can be used as a CHAP secret.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of iSCSI Connection objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 iSCSI Connection objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Add initiator to 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".
- 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
[Family: cluster, vserver]
Iterate over a list of iSCSI initiator authentication configuration objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 iSCSI initiator authentication configuration objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Delete initiator from the authentication listInputs
- initiator => string
Name of initiator. The initiator name must conform to RFC 3720, for example: "iqn.1987-06.com.initvendor1:appsrv.sn.2346".
Outputs
[Family: vserver]
Get the authentication info for an initiator, if auth type is CHAP, only the user-name is returned, password is not returned for security purposes.Inputs
- 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.
[Family: vserver]
Get the default auth info for iscsi. If the auth type is CHAP, only the username is retuned, and not the password, for security purposes.Inputs
Outputs
- 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.
[Family: cluster, vserver]
Iterate over a list of remote iSCSI initiator objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 remote iSCSI initiator objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
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
[Family: vserver]
Configure the default authentication method. If an initiator is not configured with a specific authentication method using iscsi-initiator-add-auth the default authentication method will be applied to it.Inputs
- 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
[Family: vserver]
Add the iSCSI LIFs to the accesslist of the specified initiatorInputs
- initiator => string
Initiator that can access the iSCSI LIFs
Outputs
[Family: cluster, vserver]
Iterate over a list of iSCSI Interface Accesslist objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 iSCSI Interface Accesslist objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Remove the iSCSI LIFs from the accesslist of the specified initiatorInputs
- initiator => string
Initiator that can access the iSCSI LIFs
- interface-name => string
iSCSI LIF Name
Outputs
[Family: vserver]
Disables an interface for use by iSCSIInputs
- 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
[Family: vserver]
Enables an interface for use by iSCSIInputs
- 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
[Family: cluster, vserver]
Iterate over a list of iSCSI target interface objects.Inputs
- desired-attributes => iscsi-interface-list-entry-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
- 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 iSCSI target interface objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Configures the iSNS service. In Data ONTAP Cluster-Mode, this this API can only modify the configuration of a Vserver where an iSNS service has already been created. To create an iSNS service in a Vserver where one does not exist, use the iscsi-isns-create API.Inputs
- force => boolean, optional
iSNS config fails if vserver management LIF is not configured for the vserver. This behavior is overridden with this option when it is set to "true".
- 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
[Family: vserver]
Create iSNS Service in a Vserver.Inputs
- force => boolean, optional
iSNS create fails if vserver management LIF is not configured for the vserver. This behavior is overridden with this option when it is set to true.
- isns-ip-addr => ip-address
iSNS server IP address.
- start => boolean, optional
Determine the initial state of the iSNS Client Service. If true, the service will be automatically started after creation completes. If false, the service will be left in the stopped state and the caller must subsequently call iscsi-isns-start to start the service. The default is true.
Outputs
[Family: vserver]
Destroy the iSNS Service in a Vserver.Inputs
Outputs
[Family: vserver]
Gets iSNS service configuration.Inputs
Outputs
- isns-ip-addr => ip-address
The ip address of the iSNS server in which we register.
[Family: cluster, vserver]
Gets iSNS service configuration.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => iscsi-isns-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the iSCSI iSNS Service object. All iSCSI iSNS Service 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 iSCSI iSNS Service objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Start iSNS service. Service will be avaliable once the call returns with success.Inputs
Outputs
[Family: vserver]
Stops iSNS service. Service will not be available once the call returns with success.Inputs
Outputs
[Family: vserver]
Forces iSNS service to update server.Inputs
Outputs
[Family: vserver]
Return the current iscsi node name.Inputs
Outputs
- node-name => string
Current iscsi node name.
[Family: vserver]
Set the current iscsi node name.Inputs
- node-name => string
New iscsi node name; must be <= 128 chars, and conform to iSCSI rules
Outputs
[Family: vserver]
Create an iSCSI Service in a Vserver. Each Vserver requires an online iSCSI Service in order to serve data via the iSCSI protocol.Inputs
- node-name => string, optional
The iSCSI target name for the Vserver. The target-name must conform to RFC 3720. If not provided, one will be auto-generated.
- start => boolean, optional
Determine the initial state of the iSCSI Service. If true, the service will be automatically started after creation completes. If false, the service will be left in the stopped state and the caller must subsequently call iscsi-service-start to start the service. The default is true.
Outputs
- node-name => string
The new iSCSI target name for the Vserver.
[Family: vserver]
Destroy the iSCSI Service in a Vserver.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the list of iSCSI Services.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 iSCSI Service objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Start iSCSI service. Service will be avaliable once the call returns with success.Inputs
Outputs
[Family: vserver]
Get status of the iSCSI service, whether or not it is running.Inputs
Outputs
- is-available => boolean
"true" if iSCSI service is running, "false" otherwise.
[Family: vserver]
Stops iSCSI service. Service will be not be available once the call returns with success.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of iSCSI session objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 iSCSI session objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster, vserver]
Iterate over a list of iscsi objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 iscsi objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Clear the current iscsi target aliasInputs
Outputs
[Family: vserver]
Return the current iscsi target aliasInputs
Outputs
- alias-name => string, optional
Current iscsi target alias if alias-assigned is true.
[Family: vserver]
Set the current iscsi target aliasInputs
- 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
[Family: vserver]
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
[Family: vserver]
Destroy a tpgroup. Only user defined target portal groups may be destroyed.Inputs
- tpgroup-tag => integer
Tag of portal group to destroy.
Outputs
[Family: cluster, vserver]
Iterate over a list of iSCSI Target Portal Group objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 iSCSI Target Portal Group objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
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
[Family: vserver]
Remove an interface from a target portal group. Interfaces may only be removed from a user defined target portal group. Removing an interface will return it to the system defined default group for the interface.Inputs
- 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
[Family: vserver]
Get a single job entry. This is just a performance optimization for job-get that only searches for the job among the ones currently owned by the given node.Inputs
- desired-attributes => job-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
[Family: cluster, vserver]
Get multiple job records organized by node. This is just a performance optimization for job-get-iter that only searches for the job among the ones currently owned by the given node.Inputs
- desired-attributes => job-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 => job-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the job-by-node entry object. All job-by-node entry 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 job-by-node entry objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Get a single completed job entry. This is just a performance optimization for job-get.Inputs
- desired-attributes => job-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
- attributes => job-info
The attributes of the job completed.
[Family: cluster, vserver]
Get multiple completed job records. This is just a performance optimization for job-get-iter.Inputs
- desired-attributes => job-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 => job-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the job completed object. All job completed 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
- attributes-list => job-info[], optional
The list of attributes of job completed objects.
- next-tag => string, optional
Tag for the next call. Not present when there are no more job completed objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Get a single job entry.Inputs
- desired-attributes => job-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.
- job-id => integer
The job id.
Outputs
- attributes => job-info
The attributes of the job.
[Family: cluster, vserver]
Get multiple job records.Inputs
- desired-attributes => job-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 => job-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the job object. All job 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
- attributes-list => job-info[], optional
The list of attributes of job objects.
- next-tag => string, optional
Tag for the next call. Not present when there are no more job objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Get a single job history event.Inputs
- job-node => node-name
The name of the node where the job ran, or the node that changed the job's state.
Outputs
[Family: cluster, vserver]
Get multiple job history records.Inputs
- desired-attributes => job-history-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: 100
- query => job-history-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the job history event object. All job history event 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 job history event objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Pause a job. A job must be of a type that has job-type-is-pausible set to true before it may be paused. Once notified of a pause request, a job should stop performing work until it is subsequently resumed.Inputs
- job-id => integer
The job id.
Outputs
[Family: cluster, vserver]
Pause a collection of jobs.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple job objects match a given query. If set to true, the API will continue with the next matching job even when the operation fails for the job. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching job even when the operation on a previous matching job fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of job objects to be operated in this call. Default: 20
- query => job-info
If operating on a specific job, this input element must specify all keys. If operating on job objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of job objects (just keys) that were not operated on due to some error. If set to false, the list of job objects not operated on will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of job objects (just keys) that were successfully operated on. If set to false, the list of job objects operated on will not be returned. Default: true
- 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 matching job objects to be operated on.
- num-failed => integer, optional
The number of job objects that matched the query, but were not operated on due some error.
- num-succeeded => integer, optional
The number of job objects that matched the query and were successfully processed.
[Family: vserver]
Get a single completed, private job entry. This is just a performance optimization for job-private-get.Inputs
- desired-attributes => job-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.
- job-node => node-name
Node
Outputs
- attributes => job-info
The attributes of the private job completion entry.
[Family: cluster, vserver]
Get multiple completed, private job records. This is just a performance optimization for job-private-get-iter.Inputs
- desired-attributes => job-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 => job-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the private job completion entry object. All private job completion entry 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
- attributes-list => job-info[], optional
The list of attributes of private job completion entry objects.
- next-tag => string, optional
Tag for the next call. Not present when there are no more private job completion entry objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Get a single private job entry.Inputs
- desired-attributes => job-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.
- job-node => node-name
Node
Outputs
- attributes => job-info
The attributes of the private job.
[Family: cluster, vserver]
Get multiple private job records.Inputs
- desired-attributes => job-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 => job-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the private job object. All private job 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
- attributes-list => job-info[], optional
The list of attributes of private job objects.
- next-tag => string, optional
Tag for the next call. Not present when there are no more private job objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Pause a private job.Inputs
- job-node => node-name
Node
Outputs
[Family: cluster, vserver]
Pause a collection of private jobs.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple private job objects match a given query. If set to true, the API will continue with the next matching private job even when the operation fails for the private job. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching private job even when the operation on a previous matching private job fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of private job objects to be operated in this call. Default: 20
- query => job-info
If operating on a specific private job, this input element must specify all keys. If operating on private job objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of private job objects (just keys) that were not operated on due to some error. If set to false, the list of private job objects not operated on will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of private job objects (just keys) that were successfully operated on. If set to false, the list of private job objects operated on will not be returned. Default: true
- 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 matching private job objects to be operated on.
- num-failed => integer, optional
The number of private job objects that matched the query, but were not operated on due some error.
- num-succeeded => integer, optional
The number of private job objects that matched the query and were successfully processed.
[Family: vserver]
Resume a job.Inputs
- job-node => node-name
Node
Outputs
[Family: cluster, vserver]
Resume a collection of jobs.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple private job objects match a given query. If set to true, the API will continue with the next matching private job even when the operation fails for the private job. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching private job even when the operation on a previous matching private job fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of private job objects to be operated in this call. Default: 20
- query => job-info
If operating on a specific private job, this input element must specify all keys. If operating on private job objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of private job objects (just keys) that were not operated on due to some error. If set to false, the list of private job objects not operated on will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of private job objects (just keys) that were successfully operated on. If set to false, the list of private job objects operated on will not be returned. Default: true
- 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 matching private job objects to be operated on.
- num-failed => integer, optional
The number of private job objects that matched the query, but were not operated on due some error.
- num-succeeded => integer, optional
The number of private job objects that matched the query and were successfully processed.
[Family: vserver]
Soft pause a private job.Inputs
- job-node => node-name
Node
Outputs
[Family: cluster, vserver]
Soft pause a collection of private jobs.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple private job objects match a given query. If set to true, the API will continue with the next matching private job even when the operation fails for the private job. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching private job even when the operation on a previous matching private job fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of private job objects to be operated in this call. Default: 20
- query => job-info
If operating on a specific private job, this input element must specify all keys. If operating on private job objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of private job objects (just keys) that were not operated on due to some error. If set to false, the list of private job objects not operated on will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of private job objects (just keys) that were successfully operated on. If set to false, the list of private job objects operated on will not be returned. Default: true
- 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 matching private job objects to be operated on.
- num-failed => integer, optional
The number of private job objects that matched the query, but were not operated on due some error.
- num-succeeded => integer, optional
The number of private job objects that matched the query and were successfully processed.
[Family: vserver]
Stop a job.Inputs
- job-node => node-name
Node
Outputs
[Family: cluster, vserver]
Stop a collection of jobs.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple private job objects match a given query. If set to true, the API will continue with the next matching private job even when the operation fails for the private job. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching private job even when the operation on a previous matching private job fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of private job objects to be operated in this call. Default: 20
- query => job-info
If operating on a specific private job, this input element must specify all keys. If operating on private job objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of private job objects (just keys) that were not operated on due to some error. If set to false, the list of private job objects not operated on will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of private job objects (just keys) that were successfully operated on. If set to false, the list of private job objects operated on will not be returned. Default: true
- 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 matching private job objects to be operated on.
- num-failed => integer, optional
The number of private job objects that matched the query, but were not operated on due some error.
- num-succeeded => integer, optional
The number of private job objects that matched the query and were successfully processed.
[Family: vserver]
Resume a job from the paused state.Inputs
- job-id => integer
The job id.
Outputs
[Family: cluster, vserver]
Resume a collection of jobs.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple job objects match a given query. If set to true, the API will continue with the next matching job even when the operation fails for the job. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching job even when the operation on a previous matching job fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of job objects to be operated in this call. Default: 20
- query => job-info
If operating on a specific job, this input element must specify all keys. If operating on job objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of job objects (just keys) that were not operated on due to some error. If set to false, the list of job objects not operated on will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of job objects (just keys) that were successfully operated on. If set to false, the list of job objects operated on will not be returned. Default: true
- 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 matching job objects to be operated on.
- num-failed => integer, optional
The number of job objects that matched the query, but were not operated on due some error.
- num-succeeded => integer, optional
The number of job objects that matched the query and were successfully processed.
[Family: cluster]
Create a new cron job schedule entry.Inputs
- return-record => boolean, optional
If set to true, returns the job-schedule-cron on successful creation. Default: false
Outputs
[Family: cluster]
Delete a single cron job schedule entry. The entry must not be in use.Inputs
- job-schedule-name => string
The name of the job schedule.
Outputs
[Family: cluster]
Delete multiple cron job schedule entries. The entries must not be in use.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple job-schedule-cron objects match a given query. If set to true, the API will continue deleting the next matching job-schedule-cron even when the deletion of a previous job-schedule-cron fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching job-schedule-cron even when the deletion of a previous matching job-schedule-cron fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of job-schedule-cron objects to delete in this call. Default: 100
- return-failure-list => boolean, optional
If set to true, the API will return the list of job-schedule-cron objects (just keys) that were not deleted due to some error. If set to false, the list of job-schedule-cron objects not deleted will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of job-schedule-cron objects (just keys) that were successfully deleted. If set to false, the list of job-schedule-cron objects deleted will not be returned. Default: true
- 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 matching job-schedule-cron objects to be deleted.
- num-failed => integer, optional
Number of job-schedule-cron objects that matched the query, but were not deleted due to some error.
- num-succeeded => integer, optional
The number of job-schedule-cron objects that matched the query and were successfully deleted.
[Family: cluster, vserver]
Get a single cron job schedule entry.Inputs
- job-schedule-name => string
The name of the job schedule.
Outputs
[Family: cluster, vserver]
Get multiple cron job schedule entries.Inputs
- desired-attributes => job-schedule-cron-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: 100
- 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 job-schedule-cron objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modify an existing cron job schedule entry.Inputs
- job-schedule-cron-day => cron-day-of-month[], optional
The day(s) of the month when the job should be run.
- job-schedule-cron-day-of-week => cron-day-of-week[], optional
The day(s) in the week when the job should be run.
- job-schedule-cron-hour => cron-hour[], optional
The hour(s) of the day when the job should be run.
- job-schedule-cron-minute => cron-minute[], optional
The minute(s) of each hour when the job should be run.
- job-schedule-cron-month => cron-month[], optional
The month(s) when the job should be run.
- job-schedule-name => string
The name of the job schedule.
Outputs
[Family: cluster, vserver]
Get a single job schedule entry.Inputs
- job-schedule-name => string
The name of the job schedule.
Outputs
[Family: cluster, vserver]
Get multiple job schedule entries.Inputs
- desired-attributes => job-schedule-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
- 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 job-schedule objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Create a new interval job schedule entry.Inputs
- job-schedule-name => string
The name of the job schedule.
- return-record => boolean, optional
If set to true, returns the job-schedule-interval on successful creation. Default: false
Outputs
[Family: cluster]
Delete a single interval job schedule entry. The entry must not be in use.Inputs
- job-schedule-name => string
The name of the job schedule.
Outputs
[Family: cluster]
Delete multiple interval job schedule entries. The entries must not be in use.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple job-schedule-interval objects match a given query. If set to true, the API will continue deleting the next matching job-schedule-interval even when the deletion of a previous job-schedule-interval fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching job-schedule-interval even when the deletion of a previous matching job-schedule-interval fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of job-schedule-interval objects to delete in this call. Default: 100
- return-failure-list => boolean, optional
If set to true, the API will return the list of job-schedule-interval objects (just keys) that were not deleted due to some error. If set to false, the list of job-schedule-interval objects not deleted will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of job-schedule-interval objects (just keys) that were successfully deleted. If set to false, the list of job-schedule-interval objects deleted will not be returned. Default: true
- 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 matching job-schedule-interval objects to be deleted.
- num-failed => integer, optional
Number of job-schedule-interval objects that matched the query, but were not deleted due to some error.
- num-succeeded => integer, optional
The number of job-schedule-interval objects that matched the query and were successfully deleted.
[Family: cluster, vserver]
Get a single interval job schedule entry.Inputs
- desired-attributes => job-schedule-interval-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.
- job-schedule-name => string
The name of the job schedule.
Outputs
[Family: cluster, vserver]
Get multiple interval job schedule entries.Inputs
- desired-attributes => job-schedule-interval-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: 100
- query => job-schedule-interval-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the job-schedule-interval object. All job-schedule-interval 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 job-schedule-interval objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modify an existing interval job schedule entry.Inputs
- job-schedule-interval-days => integer, optional
The number of days between jobs.
- job-schedule-interval-hours => integer, optional
The number of hours between jobs.
- job-schedule-interval-minutes => integer, optional
The number of minutes between jobs.
- job-schedule-interval-seconds => integer, optional
The number of seconds between jobs.
- job-schedule-name => string
The name of the job schedule.
Outputs
[Family: vserver]
Soft pause a job. Indicates to the job that a soft pause has been initiated. It is up to the job to do what it needs to do for a soft pause. As a result of this command the job may request to be moved into the runnnable queue to perform further processing of the soft pause.Inputs
- job-id => integer
The job id.
Outputs
[Family: cluster, vserver]
Soft pause a collection of jobs.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple job objects match a given query. If set to true, the API will continue with the next matching job even when the operation fails for the job. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching job even when the operation on a previous matching job fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of job objects to be operated in this call. Default: 20
- query => job-info
If operating on a specific job, this input element must specify all keys. If operating on job objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of job objects (just keys) that were not operated on due to some error. If set to false, the list of job objects not operated on will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of job objects (just keys) that were successfully operated on. If set to false, the list of job objects operated on will not be returned. Default: true
- 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 matching job objects to be operated on.
- num-failed => integer, optional
The number of job objects that matched the query, but were not operated on due some error.
- num-succeeded => integer, optional
The number of job objects that matched the query and were successfully processed.
[Family: vserver]
Stop a job. A job must be of a type that has job-type-is-quittable set to true before it may be stopped. job-stop attempts to stop a job that's currently running. If the job allows itself to stop it completes its current run. If the job has a recurring schedule it will transition to the Queued state; otherwise it will transition into either the Success or Failure state.Inputs
- job-id => integer
The job id.
Outputs
[Family: cluster, vserver]
Stop a collection of jobs.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple job objects match a given query. If set to true, the API will continue with the next matching job even when the operation fails for the job. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching job even when the operation on a previous matching job fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of job objects to be operated in this call. Default: 20
- query => job-info
If operating on a specific job, this input element must specify all keys. If operating on job objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of job objects (just keys) that were not operated on due to some error. If set to false, the list of job objects not operated on will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of job objects (just keys) that were successfully operated on. If set to false, the list of job objects operated on will not be returned. Default: true
- 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 matching job objects to be operated on.
- num-failed => integer, optional
The number of job objects that matched the query, but were not operated on due some error.
- num-succeeded => integer, optional
The number of job objects that matched the query and were successfully processed.
[Family: vserver]
Get Kerberos configuration information for a LIF.Inputs
- interface-name => string
Logical interface.
Outputs
[Family: cluster, vserver]
Get Kerberos configuration information for a group of LIFs.Inputs
- desired-attributes => kerberos-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: 50
- 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 kerberos-config objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify Kerberos configuration informaiton for a LIFInputs
- admin-password => string, optional
Administrator password.
- interface-name => string
Logical interface.
Outputs
[Family: cluster]
Create a new Kerberos realm configuration.Inputs
- admin-server-ip => ip-address, optional
IP address of the host where the Kerberos administration daemon is running. This is usually the master KDC. If this parameter is omitted, the IP address specified in kdc-ip is used. If specified, this should be the same as the kdc-ip if the kdc-vendor is 'microsoft'.
- clock-skew => integer, optional
The clock skew in minutes is the tolerance for accepting tickets with time stamps that do not exactly match the host's system clock. The default for this parameter is 5 minutes.
- comment => string, optional
Comment
- kdc-ip => ip-address
IP address of the Key Distribution Centre (KDC) server for this Kerberos realm.
- kdc-vendor => kdc-vendor
The vendor of the Key Distribution Centre (KDC) server. If the configuration uses a Microsoft Active Directory (AD) domain for authentication, this field should be 'microsoft'. Possible values:
- password-server-ip => ip-address, optional
IP address of the host where the Kerberos password-changing server is running. Typically, this is the same as the host indicated in the adminserver-ip. If this parameter is omitted, the IP address in kdc-ip is used.
- return-record => boolean, optional
If set to true, returns the kerberos-realm on successful creation. Default: false
Outputs
[Family: cluster]
Delete the Kerberos realm configuration.Inputs
- config-name => string
Kerberos configuration name.
Outputs
[Family: cluster]
Retrieve the list of Kerberos realm configurations.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => kerberos-realm, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the kerberos-realm object. All kerberos-realm 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 kerberos-realm objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modify the Kerberos realm configuration.Inputs
- ad-server-ip => ip-address, optional
IP Address of the Active Directory Domain Controller (DC). This is a mandatory parameter if the kdc-vendor is 'microsoft'.
- ad-server-name => string, optional
Host name of the Active Directory Domain Controller (DC). This is a mandatory parameter if the kdc-vendor is 'microsoft'
- admin-server-ip => ip-address, optional
IP address of the host where the Kerberos administration daemon is running. This is usually the master KDC. If this parameter is omitted, the IP address specified in kdc-ip is used. If specified, this should be the same as the kdc-ip if the kdc-vendor is 'microsoft'.
- admin-server-port => integer, optional
The TCP port on the Kerberos administration server where the Kerberos administration service is running. The default for this parmater is 749.
- clock-skew => integer, optional
The clock skew in minutes is the tolerance for accepting tickets with time stamps that do not exactly match the host's system clock. The default for this parameter is 5 minutes.
- comment => string, optional
Comment
- config-name => string
Kerberos configuration name.
- kdc-port => integer, optional
TCP port on the KDC to be used for Kerberos communication. The default for this parameter is 88.
- kdc-vendor => kdc-vendor, optional
The vendor of the Key Distribution Centre (KDC) server. If the configuration uses a Microsoft Active Directory (AD) domain for authentication, this field should be 'microsoft'. Possible values:
- password-server-ip => ip-address, optional
IP address of the host where the Kerberos password-changing server is running. Typically, this is the same as the host indicated in the adminserver-ip. If this parameter is omitted, the IP address in kdc-ip is used.
- password-server-port => integer, optional
The TCP port on the Kerberos password-changing server where the Kerberos password-changing service is running. The default for this parameter is 464.
Outputs
[Family: vserver]
Create a new Lightweight Directory Access Protocol (LDAP) client configuration for the cluster.Inputs
- ad-domain => string, optional
The Active Directory Domain Name for this LDAP configuration. The option is ONLY applicable for configurations using Active Directory LDAP servers.
- base-dn => ldap-dn, optional
Indicates the starting point for searches within the LDAP directory tree. If omitted, searches will start at the root of the directory tree.
- base-scope => ldap-search-scope, optional
This indicates the scope for LDAP search. If omitted, this parameter defaults to 'subtree'. Possible values: - "base" - Search only the base directory entry,
- "onelevel" - Search the base directory entry and the children of the base entry,
- "subtree" - Search the base directory entry and all its decendants
- bind-as-cifs-server => boolean, optional
If set, the cluster will use the CIFS server's credentials to bind to the LDAP server. If omitted, this parameter defaults to 'true' if the configuration uses Active Directory LDAP and defaults to 'false' otherwise.
- bind-dn => ldap-dn, optional
The Bind Distinguished Name (DN) is the LDAP identity used during the authentication process by the clients. This is required if the LDAP server does not support anonymous binds. This field is not used if 'bind-as-cfs-server' is set to 'true'. Example : cn=username,cn=Users,dc=example,dc=com
- group-dn => ldap-dn, optional
The Group Distinguished Name (DN), if specified, is used as the starting point in the LDAP directory tree for group lookups. If not specified, group lookups will start at the base-dn.
- group-scope => ldap-search-scope, optional
This indicates the scope for LDAP search when doing group lookups. Possible values: - "base" - Search only the base directory entry,
- "onelevel" - Search the base directory entry and the children of the base entry,
- "subtree" - Search the base directory entry and all its decendants
- min-bind-level => ldap-auth-method, optional
The minimum authentication level that can be used to authenticate with the LDAP server. If omitted, this parameter defaults to 'sasl' if the configuration uses Active Directory LDAP. For configurations that use LDAP servers from other vendors, this parameter defaults to 'simple' if a 'bind-dn' is specified and 'anonymous' otherwise. Possible values: - "anonymous" - Anonymous bind,
- "simple" - Simple bind,
- "sasl" - Simple Authentication and Security Layer (SASL) bind
- netgroup-dn => ldap-dn, optional
The Netgoup Distinguished Name (DN), if specified, is used as the starting point in the LDAP directory tree for netgroup lookups. If not specified, netgroup lookups will start at the base-dn.
- netgroup-scope => ldap-search-scope, optional
This indicates the scope for LDAP search when doing netgroup lookups. Possible values: - "base" - Search only the base directory entry,
- "onelevel" - Search the base directory entry and the children of the base entry,
- "subtree" - Search the base directory entry and all its decendants
- return-record => boolean, optional
If set to true, returns the ldap-client on successful creation. Default: false
- schema => string
LDAP schema to use for this configuration. The list of possible schemas can be obtained using the ldap-client-schema-get-iter API.
- servers => ip-address[], optional
List of LDAP Server IP addresses to use for this configuration. The option is NOT applicable for configurations using Active Directory LDAP servers.
- user-dn => ldap-dn, optional
The User Distinguished Name (DN), if specified, is used as the starting point in the LDAP directory tree for user lookups. If this parameter is omitted, user lookups will start at the base-dn.
- user-scope => ldap-search-scope, optional
This indicates the scope for LDAP search when doing user lookups. Possible values: - "base" - Search only the base directory entry,
- "onelevel" - Search the base directory entry and the children of the base entry,
- "subtree" - Search the base directory entry and all its decendants
Outputs
[Family: vserver]
Delete an existing Lightweight Directory Access Protocol (LDAP) client configuration from the cluster.Inputs
- ldap-client-config => string
The name of the LDAP client configuration.
Outputs
[Family: cluster, vserver]
Retrieve the list of Lightweight Directory Access Protocol (LDAP) client configurations for the cluster.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => ldap-client, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the ldap-client object. All ldap-client 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 ldap-client objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify an existing Lightweight Directory Access Protocol (LDAP) client configuration.Inputs
- ad-domain => string, optional
The Active Directory Domain Name for this LDAP configuration. The option is ONLY applicable for configurations using Active Directory LDAP servers.
- base-dn => ldap-dn, optional
Indicates the starting point for searches within the LDAP directory tree. If omitted, searches will start at the root of the directory tree.
- base-scope => ldap-search-scope, optional
This indicates the scope for LDAP search. If omitted, this parameter defaults to 'subtree'. Possible values: - "base" - Search only the base directory entry,
- "onelevel" - Search the base directory entry and the children of the base entry,
- "subtree" - Search the base directory entry and all its decendants
- bind-as-cifs-server => boolean, optional
If set, the cluster will use the CIFS server's credentials to bind to the LDAP server. If omitted, this parameter defaults to 'true' if the configuration uses Active Directory LDAP and defaults to 'false' otherwise.
- bind-dn => ldap-dn, optional
The Bind Distinguished Name (DN) is the LDAP identity used during the authentication process by the clients. This is required if the LDAP server does not support anonymous binds. This field is not used if 'bind-as-cfs-server' is set to 'true'. Example : cn=username,cn=Users,dc=example,dc=com
- bind-password => string, optional
The password to be used with the bind-dn.
- group-dn => ldap-dn, optional
The Group Distinguished Name (DN), if specified, is used as the starting point in the LDAP directory tree for group lookups. If not specified, group lookups will start at the base-dn.
- group-scope => ldap-search-scope, optional
This indicates the scope for LDAP search when doing group lookups. Possible values: - "base" - Search only the base directory entry,
- "onelevel" - Search the base directory entry and the children of the base entry,
- "subtree" - Search the base directory entry and all its decendants
- ldap-client-config => string
The name of the LDAP client configuration.
- min-bind-level => ldap-auth-method, optional
The minimum authentication level that can be used to authenticate with the LDAP server. If omitted, this parameter defaults to 'sasl' if the configuration uses Active Directory LDAP. For configurations that use LDAP servers from other vendors, this parameter defaults to 'simple' if a 'bind-dn' is specified and 'anonymous' otherwise. Possible values: - "anonymous" - Anonymous bind,
- "simple" - Simple bind,
- "sasl" - Simple Authentication and Security Layer (SASL) bind
- netgroup-dn => ldap-dn, optional
The Netgoup Distinguished Name (DN), if specified, is used as the starting point in the LDAP directory tree for netgroup lookups. If not specified, netgroup lookups will start at the base-dn.
- netgroup-scope => ldap-search-scope, optional
This indicates the scope for LDAP search when doing netgroup lookups. Possible values: - "base" - Search only the base directory entry,
- "onelevel" - Search the base directory entry and the children of the base entry,
- "subtree" - Search the base directory entry and all its decendants
- preferred-ad-servers => ip-address[], optional
Preferred Active Directory (AD) Domain controllers to use for this configuration. This option is ONLY applicable for configurations using Active Directory LDAP servers
- query-timeout => integer, optional
Maximum time in seconds to wait for a query response from the LDAP server. The default for this parameter is 3 seconds.
- schema => string, optional
LDAP schema to use for this configuration. The list of possible schemas can be obtained using the ldap-client-schema-get-iter API.
- servers => ip-address[], optional
List of LDAP Server IP addresses to use for this configuration. The option is NOT applicable for configurations using Active Directory LDAP servers.
- tcp-port => integer, optional
The TCP port on the LDAP server to use for this configuration. If omitted, this parameter defaults to 389.
- user-dn => ldap-dn, optional
The User Distinguished Name (DN), if specified, is used as the starting point in the LDAP directory tree for user lookups. If this parameter is omitted, user lookups will start at the base-dn.
- user-scope => ldap-search-scope, optional
This indicates the scope for LDAP search when doing user lookups. Possible values: - "base" - Search only the base directory entry,
- "onelevel" - Search the base directory entry and the children of the base entry,
- "subtree" - Search the base directory entry and all its decendants
Outputs
[Family: vserver]
Copy an existing LDAP schema. If the LDAP server that the storage system needs to query does not support any of the default read-only schemas, this API can be used to create an editable copy of an existing read-only schema. After copying the schema, the copy can be modified using the ldap-client-schema-modify API.Inputs
- schema => string
A name for the schema.
Outputs
[Family: vserver]
Delete an existing Lightweight Directory Access Protocol (LDAP) schema configuration. Only the schemas that are defined using the ldap-client-schema-copy API can be deleted using this API.Inputs
- schema => string
A name for the schema.
Outputs
[Family: cluster, vserver]
Retrieve the list of Lightweight Directory Access Protocol (LDAP) client schema configurations that are defined for the cluster.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 ldap-client-schema objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify an existing Lightweight Directory Access Protocol (LDAP) schema configuration. If the LDAP server that the storage system needs to query does not support any of the default read-only schemas, the ldap-client-schema-copy API can be used to create a editable copy of an existing read-only schema. After copying the schema, the copy can be modified using this API to support the target schema.Inputs
- comment => string, optional
A comment that can be associated with the schema.
- schema => string
A name for the schema.
Outputs
[Family: vserver]
Create a new association between a Lightweight Directory Access Protocol (LDAP) client configuration and a Vserver. A Vserver can have only one client configuration associated with it.Inputs
- client-config => string
The name of an existing Lightweight Directory Access Protocol (LDAP) client configuration. The LDAP client configuration can be created using the ldap-client-create API. The ldap-client-get-iter API can be used to retrieve the list of available LDAP client configurations for the cluster.
- client-enabled => boolean
If true, the corresponding Lightweight Directory Access Protocol (LDAP) configuration is enabled for this Vserver.
- return-record => boolean, optional
If set to true, returns the ldap-config on successful creation. Default: false
Outputs
[Family: vserver]
Delete a Vserver's association with a Lightweight Directory Access Protocol (LDAP) configuration.Inputs
Outputs
[Family: cluster, vserver]
Retrieve the list of Lightweight Directory Access Protocol (LDAP) configurations in the cluster.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => ldap-config, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the ldap-config object. All ldap-config 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 ldap-config objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify the Lightweight Directory Access Protocol (LDAP) configuration for a Vserver.Inputs
- client-config => string, optional
The name of an existing Lightweight Directory Access Protocol (LDAP) client configuration. The LDAP client configuration can be created using the ldap-client-create API. The ldap-client-get-iter API can be used to retrieve the list of available LDAP client configurations for the cluster.
Outputs
[Family: cluster]
Add license for a Data ONTAP service.Inputs
Outputs
[Family: cluster]
Returns licenses that can be cleaned up. A license can be cleaned up if it's a demo license and its expiration time has passed (expired), or if it is a license for a controller that is no longer part of a cluster (unused). One can use the cleanup apis to remove these licenses together, or alternatively, they can use the standard license-remove api to remove them one at a time.Inputs
Outputs
[Family: cluster]
Removes license for a Data ONTAP service.Inputs
- 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
[Family: cluster]
Remove licenses that have expired in the cluster.Inputs
Outputs
[Family: cluster]
Remove licenses that have no controller affiliation in the cluster.Inputs
Outputs
[Family: cluster]
Returns infomation for DATA ONTAP licenses.Inputs
Outputs
[Family: cluster]
Returns license status information for cluster mode packages.Inputs
Outputs
[Family: cluster, vserver]
Iterate over a list of lun objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 lun objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Clear the SCSI-2 reservation or SCSI-3 persistent reservation information for a given LUN. Note: In Data ONTAP Cluster-Mode, the LUN must either be offline or not mapped to clear the persistent reservation information.Inputs
- path => string
Path of the lun. The path should start with '/vol/'.
Outputs
[Family: vserver]
Create a new lun of given size, with initially zero contents. The lun is created at the path given. No file should already exist at the given path. The directory specified in the path must be a qtree root directory. The size of the created lun could be larger than the size specified, in order to get an integral number of cylinders while reporting the geometry using SAN protocols.Inputs
- class => string, optional
The class of the LUN. Possible values: - "regular" - The LUN is for normal blocks access,
- "protocol_endpoint" - The LUN is a vvol protocol endpoint,
- "vvol" - The LUN is a vvol data LUN.
The default value is "regular".
- 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.
- qos-policy-group => string, optional
QoS policy group defines measurable Service Level Objectives (SLOs) that apply to the storage objects with which the policy group is associated. If you do not assign a policy group to a lun, the system will not monitor and control the traffic to it. This field is available in Data ONTAP 8.2 and later
Outputs
[Family: vserver]
Create a lun from an existing file. A new lun is created, at the given lun path (which must be at a qtree root). A hard link is created to the existing file. The file contents are not copied or changed. The file can be resized to a larger size, rounding up to a cylinder boundary.Inputs
- class => string, optional
The class of the LUN. Possible values: - "regular" - The LUN is for normal blocks access,
- "protocol_endpoint" - The LUN is a vvol protocol endpoint,
- "vvol" - The LUN is a vvol data LUN.
The default value is "regular".
- 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).
- qos-policy-group => string, optional
QoS policy group defines measurable Service Level Objectives (SLOs) that apply to the storage objects with which the policy group is associated. If you do not assign a policy group to a lun, the system will not monitor and control the traffic to it. This field is available in Data ONTAP 8.2 and later
- 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.
[Family: vserver]
Destroy the specified LUN. This operation will fail if the LUN is currently mapped and is online. The force option can be used to destroy it regardless of being online or mapped.Inputs
- destroy-fenced-lun => boolean, optional
If "true", override checks that prevent a LUN from being destroyed while it is fenced. If "false", attempting to destroy a fenced LUN will fail. The default if not specified is "false". This field is available in Data ONTAP 8.2 and later.
- 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
[Family: vserver]
Get a named attribute for a given LUN.Inputs
- name => string
Attribute to get.
- path => string
Path of the LUN.
Outputs
- value => string
Value of the attribute.
[Family: vserver]
Get named attributes for a given LUN.Inputs
- name => string, optional
Filter for the requested attribute names. SMF wildcards are allowed. If not specified, all available attributes on the LUN will be returned.
- path => string
Path of the LUN.
Outputs
[Family: vserver]
Get the optional descriptive comment for a LUN.Inputs
- path => string
Path of the LUN.
Outputs
[Family: vserver]
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.
[Family: vserver]
Get the SCSI INQUIRY response data for vendor id (vid), product id (pid), and firmware revision (rev) based on the igroup that the lun in question is mapped to.Inputs
- initiator-group-name => string
The initiator group for which the vid/pid/rev information is to be returned.
Outputs
[Family: cluster, vserver]
Iterate over a list of lun objects.Inputs
- desired-attributes => lun-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 => lun-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the lun object. All lun 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 lun objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Returns the maximum possible size in bytes of a lun on a given volume or qtree. The user can pass the path to a volume or qtree in which the lun is to be created. This returns the maximum size for different types of luns and the possible maximum size with or without snapshot reserves.Inputs
- path => string
Path of the volume or qtree.
Outputs
[Family: vserver]
Returns the minimum possible size in bytes. This returns the minimum size for different types of luns (based on the specified OS type). Space reservation does not affect the minimum lun size, thus only a single minimum size is returned.Inputs
- type => lun-os-type
OS type of the LUN.
Outputs
[Family: vserver]
Get the size occupied by the LUN in the active FS.Inputs
- path => string
Path of the LUN.
Outputs
[Family: vserver]
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.
[Family: vserver]
Get the select attribute for the specified LUN.Inputs
- path => string
Path of the LUN.
Outputs
- 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.
[Family: vserver]
Get the serial number for the specified LUN. Prior to Data ONTAP 8.1 release, the serial number is a 12-character string formed of upper and lower-case letters, numbers, and slash (/) and hyphen (-) characters. Starting Data ONTAP 8.1 release, the serial number is a 12-character string formed of upper and lower-case letters, numbers, and the characters /-#$%&*+<=>?[!]^~@ .Inputs
- path => string
Path of the LUN.
Outputs
[Family: vserver]
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.
[Family: cluster, vserver]
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".
[Family: vserver]
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
[Family: cluster, vserver]
List all the luns mapped to an initiatorInputs
- initiator => string
initiator to check
Outputs
[Family: vserver]
Determine if an initiator is logged in via FCP or iSCSI.Inputs
- initiator => string
Name of FCP or iSCSI initiator to check.
Outputs
[Family: vserver]
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.
[Family: cluster, vserver]
Iterate over a list of LUN map detail objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => lun-map-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the LUN map detail object. All LUN map detail 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 LUN map detail objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
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
[Family: vserver]
Move (rename) a LUN.Inputs
- path => string
Path of the LUN to be moved.
Outputs
[Family: vserver]
Disables block-protocol accesses to the LUN. Mappings, if any, configured for the lun are not altered. Note that unless explicitly offlined, a lun is online.Inputs
- path => string
Path of the LUN.
Outputs
[Family: vserver]
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
[Family: vserver]
Queries for all types of scsi reservations covering both iSCSI and FCP for a given initiator name. Initiator name can be FCP portname in case of FCP or ISCSI nodename for ISCSI.Inputs
- 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.
[Family: vserver]
Changes the size of the lun. Note that client-side operations may be needed to ensure that client software recognizes the changed size.Inputs
- 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.
[Family: vserver]
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
[Family: vserver]
Set the optional descriptive comment for a LUN.Inputs
- comment => string
Comment to set for given LUN.
- path => string
Path of the LUN.
Outputs
[Family: vserver]
Set a SCSI peripheral device identifying information value on a LUN. In Data ONTAP 7-Mode, the value set will be returned in response to the vendor unique SCSI command GET DEV ID. In Data ONTAP Cluster-Mode, the value set will be returned in response to the SCSI command REPORT IDENTIFYING INFORMATION for the appropriate INFORMATION TYPE: - 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.
- device-id-type => string, optional
Indicate which peripheral device identifying information value to change. Possible values: - "legacy" - Set the Peripheral Device Identifying Information for REPORT IDENTIFYING INFORMATION (INFORMATION TYPE 0000000b) appropriate for the the vendor unique SCSI command GET DEV ID and in the format compatible with Data ONTAP 7-Mode,
- "binary" - Set the Peripheral Device Identifying Information for REPORT IDENTIFYING INFORMATION (INFORMATION TYPE 0000000b). This format allows setting all 64 bytes of the identifying information,
- "text" - Set the Peripheral Device Text Identifying Information for REPORT IDENTIFYING INFORMATION (INFORMATION TYPE 0000010b).
The default value is "legacy".
- path => string
Path of the LUN.
Outputs
[Family: vserver]
nullInputs
- path => string
Path of the LUN
Outputs
[Family: vserver]
Set the select attribute for the specified LUN. The select attribute is used by mult-pathing software to discriminate between luns when mirrored or cloned copies of a vdisk are mapped to the same host.Inputs
- 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
[Family: vserver]
Set the serial number for the specified LUN. The lun must first be made offline before changing the serial number. Prior to Data ONTAP 8.1 release, the serial number is a 12-character string formed of upper and lower-case letters, numbers, and slash (/) and hyphen (-) characters. Starting Data ONTAP 8.1 release, the serial number is a 12-character string formed of upper and lower-case letters, numbers, and the characters /-#$%&*+<=>?[!]^~@ .Inputs
- path => string
Path of the LUN.
- serial-number => string
Serial number for the LUN.
Outputs
[Family: vserver]
Modify the attributes of lun object.Inputs
- enable => boolean
LUN space alloc setting
- path => string
Path of the LUN
Outputs
[Family: vserver]
Sets the space reservation settings for the named LUN.Inputs
- enable => boolean
Enable or disable space reservation on this LUN.
- path => string
Path to the LUN for which the space reservations need to be set.
Outputs
[Family: cluster, vserver]
Iterate over a list of lun objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 lun objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
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
[Family: vserver]
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
[Family: vserver]
Remove a SCSI peripheral device identifying information value from a LUN.Inputs
- device-id-type => string, optional
Indicate which peripheral device identifying information to remove. Possible values: - "binary" - Remove the Peripheral Device Identifying Information returned in response to the SCSI commands REPORT IDENTIFYING INFORMATION (INFORMATION TYPE 0000000b) and GET DEV ID,
- "text" - Remove the Peripheral Device Text Identifying Information returned in response to the SCSI command REPORT IDENTIFYING INFORMATION (INFORMATION TYPE 0000010b).
The default value is "binary".
- path => string
Path of the LUN.
Outputs
[Family: vserver]
Create a new name mapping for a Vserver.Inputs
- direction => name-mapping-direction
Direction in which the name mapping is applied. Possible values: - "krb_unix" - Kerberos principal name to UNIX user name mapping,
- "win_unix" - Windows user name to UNIX user name mapping,
- "unix_win" - UNIX user name to Windows user name mapping
- pattern => string
Pattern to use to match the name while searching for a name that can be used as a replacement. The pattern is a UNIX-style regular expression. Regular expressions are case-insensitive when mapping from Windows to UNIX, and they are case-sensitive for mappings from Kerberos to UNIX and UNIX to Windows.
- position => integer
Position of an existing name mapping in the list of name mappings for this Vserver.
- replacement => string
The name that is to be used as a replacement if the pattern associated with this entry matches. The replacement is a string containing escape sequences representing subexpressions from the pattern, as in the UNIX 'sed' program.
- return-record => boolean, optional
If set to true, returns the name-mapping on successful creation. Default: false
Outputs
[Family: vserver]
Delete an existing name mapping entry.Inputs
- direction => name-mapping-direction
Direction in which the name mapping is applied. Possible values: - "krb_unix" - Kerberos principal name to UNIX user name mapping,
- "win_unix" - Windows user name to UNIX user name mapping,
- "unix_win" - UNIX user name to Windows user name mapping
- position => integer
Position of an existing name mapping in the list of name mappings for this Vserver.
Outputs
[Family: cluster, vserver]
Retrieve the list of name mappings in the cluster.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 name-mapping objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Insert a name mapping into the table at a specified position.Inputs
- direction => name-mapping-direction
Direction of the name mapping to be inserted. Possible values: - "krb_unix" - Kerberos principal name to UNIX user name mapping,
- "win_unix" - Windows user name to UNIX user name mapping,
- "unix_win" - UNIX user name to Windows user name mapping
- pattern => string
Pattern to use to match the name while searching for a name that can be used as a replacement. The pattern is a UNIX-style regular expression. Regular expressions are case-insensitive when mapping from Windows to UNIX, and they are case-sensitive for mappings from Kerberos to UNIX and UNIX to Windows.
- position => integer
Position within the set of name mappings that this new mapping will take. If a mapping already exists at this position, it will be moved to the next position in the list.
- replacement => string
The name that is to be used as a replacement if the pattern associated with this entry matches. The replacement may be a string containing escape sequences representing subexpressions from the pattern, as in the UNIX 'sed' program.
Outputs
[Family: vserver]
Modify an existing name mapping entry.Inputs
- direction => name-mapping-direction
Direction in which the name mapping is applied. Possible values: - "krb_unix" - Kerberos principal name to UNIX user name mapping,
- "win_unix" - Windows user name to UNIX user name mapping,
- "unix_win" - UNIX user name to Windows user name mapping
- pattern => string, optional
Pattern to use to match the name while searching for a name that can be used as a replacement. The pattern is a UNIX-style regular expression. Regular expressions are case-insensitive when mapping from Windows to UNIX, and they are case-sensitive for mappings from Kerberos to UNIX and UNIX to Windows.
- position => integer
Position of an existing name mapping in the list of name mappings for this Vserver.
- replacement => string, optional
The name that is to be used as a replacement if the pattern associated with this entry matches. The replacement is a string containing escape sequences representing subexpressions from the pattern, as in the UNIX 'sed' program.
Outputs
[Family: vserver]
Swap the position of one name mapping with another. The position is the place in the sequence of name mappings in which the mappings are applied.Inputs
- direction => string
Direction in which the name mapping is applied.
- position => integer
Position of an existing name mapping in the list of name mappings for this Vserver.
- with-position => integer
Position of an existing name mapping entry in the list of name mappings for this Vserver. This entry will be swapped with the entry at 'position'.
Outputs
[Family: vserver]
Add a user to a UNIX groupInputs
Outputs
[Family: vserver]
Create a new UNIX group.Inputs
- group-name => string
Specifies UNIX group name.
- return-record => boolean, optional
If set to true, returns the UNIX group information on successful creation. Default: false
Outputs
[Family: vserver]
Delete a user from a UNIX groupInputs
- group-name => string
Specifies UNIX group name.
- user-name => string
Specifies user's UNIX account name.
Outputs
[Family: vserver]
Destroy an existing UNIX group.Inputs
- group-name => string
Specifies UNIX group name.
Outputs
[Family: vserver]
Get the attributes of a UNIX group.Inputs
- group-name => string
Specifies UNIX group name.
Outputs
[Family: cluster, vserver]
Iterate over a list of UNIX groups.Inputs
- desired-attributes => unix-group-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 => unix-group-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the UNIX group information object. All UNIX group 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 UNIX group information objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify the attributes of a UNIX group.Inputs
- group-name => string
Specifies UNIX group name.
Outputs
[Family: vserver]
Create a new UNIX user.Inputs
- full-name => string, optional
Specifies the full name of the UNIX user.
- group-id => integer
Specifies the primary group identification number for the UNIX user.
- return-record => boolean, optional
If set to true, returns the UNIX user information on successful creation. Default: false
- user-name => string
Specifies user's UNIX account name.
Outputs
[Family: vserver]
Destroy an existing UNIX user.Inputs
- user-name => string
Specifies user's UNIX account name.
Outputs
[Family: vserver]
Get the attributes of a UNIX user.Inputs
- user-name => string
Specifies user's UNIX account name.
Outputs
[Family: cluster, vserver]
Iterate over a list of UNIX users.Inputs
- desired-attributes => unix-user-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 => unix-user-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the UNIX user information object. All UNIX user 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 UNIX user information objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify the attributes of a UNIX user.Inputs
- full-name => string, optional
Specifies the full name of the UNIX user.
- group-id => integer, optional
Specifies the primary group identification number for the UNIX user.
- user-name => string
Specifies user's UNIX account name.
Outputs
[Family: vserver]
Generate NDMP password for the given user in a specific Vserver context. The generated NDMP password is based on the actual login password for the user; hence it should be regenerated whenever the actual user password is changed.Inputs
- user-name => string
The user for which the password is to be generated.
Outputs
[Family: cluster]
Ping an IP address to verify whether the interface is aliveInputs
- interface => string, optional
Specifies the LIF from which the ping request is to be sent. This element must be specified with <interface-owner>.
- interface-owner => string, optional
Specifies the name of logical interface (LIF) owner. It may be a node or Vserver name. Element <interface-owner> and <interface> are mutually exclusive with element <node>.
- node => string, optional
Specifies the node from which ping request is to be sent. Element <node> is mutually exclusive with <interface-owner> and <interface>. If neither <node> nor <interface-owner> and <interface> is specified, then the ping request will originate from the node receiving the API request.
- retry-count => integer, optional
Specifies the number of ECHO_REQUEST retries for the given destination address. Ping stops upon first successful reply from the destination. Default: 20
Outputs
[Family: cluster]
Get the receive buffer size properties of a serviceInputs
- service => stream-protocol-service
The stream protocol connection classification Possible values: - "mount" - Mount stream protocol,
- "nfs" - NFS stream protocol,
- "nfs_v2" - NFS version 2 stream protocol,
- "nfs_v3" - NFS version 3 stream protocol,
- "nlm_v4" - Network lock manager stream protocol,
- "sm" - Session Manager stream protocol,
- "ftp_ctrl" - FTP control stream protocol,
- "ftp_data" - FTP data stream protocol,
- "http_1_0" - HTTP version 1 stream protocol,
- "http_1_1" - HTTP version 1.1 stream protocol,
- "iscsi" - ISCSI stream protocol,
- "cifs_srv" - CIFS server stream protocol,
- "cifs_nam" - CIFS name server stream protocol,
- "loopback" - loopback stream protocol,
- "rf" - RC stream protocol,
- "rawscp" - Raw secure copy stream protocol,
- "discard" - Descard stream protocol,
- "port_map" - Port map stream protocol,
- "pass_thru" - Passthru stream protocol,
- "rclopcp" - Rc connection stream protocol,
- "nfs_v4" - NFS version 4 stream protocol,
- "fcache" - Flex cache stream protocol,
- "ctlopcp" - Ct connection stream protocol,
- "rquota" - Rquota stream protocol,
- "cifs_msrpc" - CIFS MsRpc stream protocol,
- "unknown" - unknown protocol
Outputs
[Family: cluster]
Iterate over connections returning receive buffer size propertiesInputs
- desired-attributes => receive-buffer, 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 => receive-buffer, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the net-connections-receive-window-size object. All net-connections-receive-window-size 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 net-connections-receive-window-size objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modify receive buffer size propertiesInputs
- network => network-type
The network topology classification Possible values: - "wan" ,
- "lan" ,
- "undefined"
- protocol => protocol-layer4
The network layer 4 protocol type Possible values: - "udp" - UDP,
- "tcp" - TCP,
- "na" - not_available
- receive-auto-tune => boolean, optional
If true, allow the system to automatically adjust the receive buffer size. The default value is false for the ctlopcp service using the LAN network type, and true in all other cases.
- receive-buffer => integer, optional
If receive-auto-tune is false, receive buffer size in kilobytes (1024). If receive-auto-tune flag is true, this value has no effect. The default value is 2048 for the ctlopcp service using the WAN network type, and 256 in other cases.
- service => stream-protocol-service
The stream protocol connection classification Possible values: - "mount" - Mount stream protocol,
- "nfs" - NFS stream protocol,
- "nfs_v2" - NFS version 2 stream protocol,
- "nfs_v3" - NFS version 3 stream protocol,
- "nlm_v4" - Network lock manager stream protocol,
- "sm" - Session Manager stream protocol,
- "ftp_ctrl" - FTP control stream protocol,
- "ftp_data" - FTP data stream protocol,
- "http_1_0" - HTTP version 1 stream protocol,
- "http_1_1" - HTTP version 1.1 stream protocol,
- "iscsi" - ISCSI stream protocol,
- "cifs_srv" - CIFS server stream protocol,
- "cifs_nam" - CIFS name server stream protocol,
- "loopback" - loopback stream protocol,
- "rf" - RC stream protocol,
- "rawscp" - Raw secure copy stream protocol,
- "discard" - Descard stream protocol,
- "port_map" - Port map stream protocol,
- "pass_thru" - Passthru stream protocol,
- "rclopcp" - Rc connection stream protocol,
- "nfs_v4" - NFS version 4 stream protocol,
- "fcache" - Flex cache stream protocol,
- "ctlopcp" - Ct connection stream protocol,
- "rquota" - Rquota stream protocol,
- "cifs_msrpc" - CIFS MsRpc stream protocol,
- "unknown" - unknown protocol
Outputs
[Family: vserver]
Creates DNS configuration for a VserverInputs
- domains => string[]
List of DNS domains such as 'sales.bar.com'. The first domain is the one that the Vserver belongs to.
- return-record => boolean, optional
If set to true, returns the dns on successful creation. Default: false
- timeout => integer, optional
Number of seconds to wait for a response from a name server before trying a different name server. Default is two seconds.
Outputs
[Family: vserver]
Get the DNS configuration of the VserverInputs
Outputs
[Family: cluster, vserver]
Iterate through DNS configurations of the clusterInputs
- desired-attributes => net-dns-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 => net-dns-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the dns object. All dns 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 dns objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify the DNS configuration of the specified Vserver. Omitted (optional) fields will not be changed.Inputs
- attempts => integer, optional
Max number of trials before giving up and returning error. Default is one.
- name-servers => ip-address[], optional
IPv4 addresses of name servers such as '123.123.123.123'.
- timeout => integer, optional
Number of seconds to wait for a response from a name server before trying a different name server. Default is two seconds.
Outputs
[Family: vserver]
Create a new IP to host names mappingInputs
- return-record => boolean, optional
If set to true, returns the hosts on successful creation. Default: false
Outputs
[Family: vserver]
Delete an existing hosts object.Inputs
- host-ip-address => ip-address
IPv4 address in dotted form as '123.123.123.123'.
Outputs
[Family: vserver]
Given an IP address, return the corresponding IP to host names mapping of the running Vserver contextInputs
- desired-attributes => hosts-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.
- host-ip-address => ip-address
IPv4 address in dotted form as '123.123.123.123'.
Outputs
[Family: cluster, vserver]
Iterate all IP to host name mappings (over all Vserver) of the clusterInputs
- desired-attributes => hosts-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 => hosts-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the hosts object. All hosts 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 hosts objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Given an IP address, modify the corresponding IP to host name mapping. Omitted (optional) fields will not be changed.Inputs
- aliases => string[], optional
The list of aliases such as 'host1.sales.foo.com'.
- host-ip-address => ip-address
IPv4 address in dotted form as '123.123.123.123'.
Outputs
[Family: cluster]
Create a new logical interface.Inputs
- administrative-status => string, optional
Specifies the administrative status of the LIF. The administrative status can differ from the operational status; for instance, if you specify the status as up but a network problem prevents the interface from functioning, the operational status remains as down. Possible values:
- comment => string, optional
Comment
- data-protocols => data-protocol[], optional
Specifies the list of data protocols configured on the LIF. By default, the values in this element are nfs, cifs and fcache. Other supported protocols are iscsi and fcp. A LIF can be configured to not support any data protocols by specifying 'none'. Protocol values of none, iscsi or fcp can't be combined with any other data protocol(s). Possible values: - "nfs" - Used for NFS connections,
- "cifs" - Used for CIFS connections,
- "iscsi" - Used for iSCSI connections,
- "fcp" - Used for Fibre Channel connections,
- "fcache" - Used for FlexCache connections,
- "none" - Used for management. Does not serve any file protocols.
- failover-policy => string, optional
Specifies the failover policy for the LIF. For FCP and iSCSI LIFs, the only failover policy is 'disabled'; for NFS, CIFs and fcache LIFs, the default policy is 'nextavail'. Possible values: - "nextavail" - Next failover target selected based on next port in failover targets list, preferring local ports first,
- "priority" - Next failover target selected based on first available port in failover targets list,
- "disabled" - Failover disabled
- firewall-policy => string, optional
Specifies the firewall policy for the LIF. Default firewall-policy is set as per the following table: - 'LIF Role Protocols Default policy',
- '------- --------- --------------',
- 'data none mgmt',
- 'data any data',
- 'node_mgmt any mgmt',
- 'cluster_mgmt any mgmt',
- 'cluster any cluster',
- 'intercluster any intercluster'
- interface-name => string
Specifies the logical interface (LIF) name.
- is-auto-revert => boolean, optional
If true, data LIF will revert to its home node under certain circumstances such as startup, and load balancing migration capability is disabled automatically. Default: false
- is-ipv4-link-local => boolean, optional
If true, automatically configure an interface with an IPv4 address. User can configure an interface by explicitly specifying <address> and <netmask> (or <netmask-length>); or by enabling is-ipv4-link-local to true.
- return-record => boolean, optional
If set to true, returns the given network interface on successful creation. Default: false
- role => string
Specifies the role of the LIF. Default: data Possible values: - "undef" - No defined role,
- "cluster" - Used for communication using the private cluster network,
- "data" - Used for communicating with file service clients,
- "node_mgmt" - Used by administrators to configure the node,
- "intercluster" - Used for communication with a different cluster,
- "cluster_mgmt" - Used by administrators to configure the cluster
- routing-group-name => routing-group, optional
Specifies the routing group, which enables multiple logical interfaces to share a set of routing table entries. For example: d192.168.1.0/24 ('d' stands for data LIF and 192.168.1.0/24 is subnet) c192.168.1.0/24 ('c' stands for cluster LIF and 192.168.1.0/24 is subnet) n192.168.1.0/24 ('n' stands for node management LIF and 192.168.1.0/24 is subnet) dfd20:13::0/50 ('d' stands for data LIF and fd20:13::0/50 is IPv6 subnet)
- use-failover-group => string, optional
Specifies whether failover rules are automatically created, manually created by the administrator, or disabled. For FCP and iSCSI LIFs, the default policy is 'disabled'; for NFS, CIFs and fcache LIFs, the default policy is 'system_defined'. Possible values: - "system_defined" - Failover targets generated automatically by the system,
- "disabled" - Failover targets generated manually by the admin,
- "enabled" - Failover targets defined by failover-group
- vserver => string
Specifies the Vserver name.
Outputs
[Family: cluster]
Destroy an existing network interface object.Inputs
- interface-name => string
Specifies the logical interface (LIF) name.
- vserver => string
Specifies the Vserver name.
Outputs
[Family: vserver]
Get the attributes of a network interface.Inputs
- interface-name => string
Specifies the logical interface (LIF) name.
Outputs
[Family: cluster, vserver]
Iterate over a list of network interface objects.Inputs
- desired-attributes => net-interface-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
- 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 given network interface objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modify the attributes of network interface object.Inputs
- address => ip-address, optional
Specifies the LIF's IP address. This element is valid for all data protocols except FCP.
- administrative-status => string, optional
Specifies the administrative status of the LIF. The administrative status can differ from the operational status; for instance, if you specify the status as up but a network problem prevents the interface from functioning, the operational status remains as down. Possible values:
- comment => string, optional
Comment
- dns-domain-name => dns-zone, optional
Specifies the unique, fully qualified domain name of the DNS zone of this LIF.
- failover-group => failover-group, optional
Specifies the failover group name.
- failover-policy => string, optional
Specifies the failover policy for the LIF. For FCP and iSCSI LIFs, the only failover policy is 'disabled'; for NFS, CIFs and fcache LIFs, the default policy is 'nextavail'. Possible values: - "nextavail" - Next failover target selected based on next port in failover targets list, preferring local ports first,
- "priority" - Next failover target selected based on first available port in failover targets list,
- "disabled" - Failover disabled
- firewall-policy => string, optional
Specifies the firewall policy for the LIF. Default firewall-policy is set as per the following table: - 'LIF Role Protocols Default policy',
- '------- --------- --------------',
- 'data none mgmt',
- 'data any data',
- 'node_mgmt any mgmt',
- 'cluster_mgmt any mgmt',
- 'cluster any cluster',
- 'intercluster any intercluster'
- interface-name => string
Specifies the logical interface (LIF) name.
- is-auto-revert => boolean, optional
If true, data LIF will revert to its home node under certain circumstances such as startup, and load balancing migration capability is disabled automatically. Default: false
- is-ipv4-link-local => boolean, optional
If true, automatically configure an interface with an IPv4 address. User can configure an interface by explicitly specifying <address> and <netmask> (or <netmask-length>); or by enabling is-ipv4-link-local to true.
- listen-for-dns-query => boolean, optional
If True, this IP address will listen for DNS queries for the dns-zone specified.
- netmask => ip-address, optional
Specifies the LIF's netmask. This element is valid for all data protocols except FCP.
- netmask-length => integer, optional
Specifies number of bits in the netmask.
- routing-group-name => routing-group, optional
Specifies the routing group, which enables multiple logical interfaces to share a set of routing table entries. For example: d192.168.1.0/24 ('d' stands for data LIF and 192.168.1.0/24 is subnet) c192.168.1.0/24 ('c' stands for cluster LIF and 192.168.1.0/24 is subnet) n192.168.1.0/24 ('n' stands for node management LIF and 192.168.1.0/24 is subnet) dfd20:13::0/50 ('d' stands for data LIF and fd20:13::0/50 is IPv6 subnet)
- use-failover-group => string, optional
Specifies whether failover rules are automatically created, manually created by the administrator, or disabled. For FCP and iSCSI LIFs, the default policy is 'disabled'; for NFS, CIFs and fcache LIFs, the default policy is 'system_defined'. Possible values: - "system_defined" - Failover targets generated automatically by the system,
- "disabled" - Failover targets generated manually by the admin,
- "enabled" - Failover targets defined by failover-group
- vserver => string
Specifies the Vserver name.
Outputs
[Family: cluster]
Modify the attributes of network interface or a group of network interface objects.Inputs
- attributes => net-interface-info
Specify at least one modifiable element. Do not specify any other element.
- continue-on-failure => boolean, optional
This input element is useful when multiple given network interface objects match a given query. If set to true, the API will continue modifying the next matching given network interface even when modification of a previous given network interface fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching given network interface even when the modification of a previous matching given network interface fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of objects to be modified in this call. Default: 20
- return-failure-list => boolean, optional
If set to true, the API will return the list of given network interface objects (just keys) that were not modified due to some error. If set to false, the list of given network interface objects not modified will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of given network interface objects (just keys) that were successfully updated. If set to false, the list of given network interface objects modified will not be returned. Default: true
- 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 matching given network interface objects to be modified.
- num-failed => integer, optional
Number of given network interface objects that matched the query, but were not modified due to some error.
- num-succeeded => integer, optional
The number of given network interface objects that matched the query and were successfully updated.
[Family: cluster]
Get the attributes of the net.Inputs
Outputs
[Family: cluster]
Modify the attributes of net object.Inputs
Outputs
[Family: cluster]
Delete LIF placement cached information.Inputs
- node => string
Specifies the name of the node.
- vserver => string
Vserver Name
Outputs
[Family: cluster]
Iterate over the LIF placement cached information.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 network interface placement objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Find the ports direcly connected to the IP addressInputs
- netmask-length => integer
Netmask Length
- vserver => string
Vserver Name
Outputs
[Family: cluster]
Get the attributes of a network port.Inputs
- node => string
Specifies the name of node.
- port => string
Specifies the name of port.
Outputs
[Family: cluster]
Iterate over a list of network port objects.Inputs
- desired-attributes => net-port-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 => net-port-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the given network port object. All given network port 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 given network port objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Add port to a network interface group.Inputs
- node => string
Specifies the name of node.
- port => string
Specifies the name of port.
Outputs
[Family: cluster]
Create a new network interface group.Inputs
- distribution-function => string
Specifies the traffic distribution function for the ifgrp. Possible values: - "mac" - Network traffic is distributed on the basis of MAC addresses,
- "ip" - Network traffic is distributed on the basis of IP addresses,
- "sequential" - Network traffic is distributed round-robin to each interface,
- "port" - Network traffic is distributed by transport layer address 4-tuple
- ifgrp-name => lif-bindable
Specifies the interface group name.
- mode => string
Specifies the link policy for the ifgrp. Possible values: - 'multimode - All links are simultaneously active',
- 'multimode_lacp - Link state is managed by the switch using link aggregation control protocol (LACP) (IEEE 802.3ad)',
- 'singlemode - Only one link is active at a time'
- node => string
Specifies the name of node.
- return-record => boolean, optional
If set to true, returns the network interface group on successful creation. Default: false
Outputs
[Family: cluster]
Destroy an existing network interface group.Inputs
- ifgrp-name => lif-bindable
Specifies the interface group name.
- node => string
Specifies the name of node.
Outputs
[Family: cluster]
Get the attributes of a network interface group (ifgrp).Inputs
- ifgrp-name => lif-bindable
Specifies the interface group name.
- node => string
Specifies the name of node.
Outputs
[Family: cluster]
Remove port from a network interface group.Inputs
- ifgrp-name => lif-bindable
Specifies the interface group name.
- node => string
Specifies the name of node.
- port => string
Specifies the name of port.
Outputs
[Family: cluster]
Modify the given attributes of network port and the rest remain unchanged.Inputs
- administrative-duplex => string, optional
Specifies the user preferred duplex setting of the port. Possible values: - "undef" - No defined duplex,
- "auto" - Auto-negotiate duplex setting for link,
- "half" - Half-duplex link usage,
- "full" - Full-duplex link usage
- administrative-speed => string, optional
Specifies the user preferred speed setting of the port. Possible values: - "undef" - No defined speed,
- "auto" - Auto-negotiate speed for link,
- "10" - 10 megabits per second,
- "100" - 100 megabits per second,
- "1000" - 1 gigabit per second,
- "10000" - 10 gigabits per second
- node => string
Specifies the name of node.
- port => string
Specifies the name of port.
- role => string, optional
Specifies the role associated with the port. Possible values: - 'undef - No defined role',
- 'cluster - Used for communication using the private cluster network',
- 'data - Used for communicating with file service clients',
- 'node_mgmt - Used by administrators to configure the node',
- 'intercluster - Used for communication with a different cluster'
Outputs
[Family: cluster]
Modify the attributes of network port or a group of network port objects.Inputs
- attributes => net-port-info
Specify at least one modifiable element. Do not specify any other element.
- continue-on-failure => boolean, optional
This input element is useful when multiple given network port objects match a given query. If set to true, the API will continue modifying the next matching given network port even when modification of a previous given network port fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching given network port even when the modification of a previous matching given network port fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of objects to be modified in this call. Default: 20
- query => net-port-info
If modifying a specific given network port, this input element must specify all keys. If modifying given network port objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of given network port objects (just keys) that were not modified due to some error. If set to false, the list of given network port objects not modified will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of given network port objects (just keys) that were successfully updated. If set to false, the list of given network port objects modified will not be returned. Default: true
- 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 matching given network port objects to be modified.
- num-failed => integer, optional
Number of given network port objects that matched the query, but were not modified due to some error.
- num-succeeded => integer, optional
The number of given network port objects that matched the query and were successfully updated.
[Family: cluster]
Create a new network routing group route.Inputs
- destination-address => string
Specifies the IP address and subnet mask of destination. For example: '198.18.10.0/24', 'fd20:13::0/64'
- metric => integer, optional
Specifies the metric (hop count) of the LIF. The default value is determined by the LIF role as follows: - If the LIF role is 'node_mgmt' or 'cluster_mgmt': 10,
- If the LIF role is 'data' or 'undef': 20,
- If the LIF role is 'cluster': 30,
- If the LIF role is 'intercluster': 40
- return-record => boolean, optional
If set to true, returns the network routing group route on successful creation. Default: false
- routing-group => string
Specifies the name of routing group. For example: - d192.168.1.0/24 ('d' stands for data LIF and 192.168.1.0/24 is subnet),
- c192.168.1.0/24 ('c' stands for cluster LIF and 192.168.1.0/24 is subnet),
- n192.168.1.0/24 ('n' stands for node management LIF and 192.168.1.0/24 is subnet)
- dfd20:13::0/64 ('d' stands for data LIF and fd20:13::0/64 is IPv6 subnet)
- vserver => string
Specifies the name of Vserver.
Outputs
[Family: cluster]
Destroy an existing network routing group route.Inputs
- destination-address => string
Specifies the IP address and subnet mask of destination. For example: '198.18.10.0/24', 'fd20:13::0/64'
- routing-group => string
Specifies the name of routing group. For example: - d192.168.1.0/24 ('d' stands for data LIF and 192.168.1.0/24 is subnet),
- c192.168.1.0/24 ('c' stands for cluster LIF and 192.168.1.0/24 is subnet),
- n192.168.1.0/24 ('n' stands for node management LIF and 192.168.1.0/24 is subnet)
- dfd20:13::0/64 ('d' stands for data LIF and fd20:13::0/64 is IPv6 subnet)
- vserver => string
Specifies the name of Vserver.
Outputs
[Family: vserver]
Get the attributes of a network routing group route.Inputs
- destination-address => string
Specifies the IP address and subnet mask of destination. For example: '198.18.10.0/24', 'fd20:13::0/64'
- routing-group => string
Specifies the name of routing group. For example: - d192.168.1.0/24 ('d' stands for data LIF and 192.168.1.0/24 is subnet),
- c192.168.1.0/24 ('c' stands for cluster LIF and 192.168.1.0/24 is subnet),
- n192.168.1.0/24 ('n' stands for node management LIF and 192.168.1.0/24 is subnet)
- dfd20:13::0/64 ('d' stands for data LIF and fd20:13::0/64 is IPv6 subnet)
Outputs
[Family: cluster, vserver]
Iterate over a list of network routing group route.Inputs
- desired-attributes => routing-group-route-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
- 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 network routing group route objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Get the attributes of the SAN LIF Placement.Inputs
Outputs
[Family: cluster]
Create a new vlan interface. In Data ONTAP 7-Mode, changes made by this API are not persisted across system reboots. In Data ONTAP Cluster-Mode, changes made by this API are persisted across system reboots.Inputs
Outputs
[Family: cluster]
Delete a vlan interface. In Data ONTAP 7-Mode, changes made by this API are not persisted across system reboots. In Data ONTAP Cluster-Mode, changes made by this API are persisted across system reboots.Inputs
Outputs
[Family: cluster]
Get the attributes of a VLAN.Inputs
- desired-attributes => vlan-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.
- interface-name => string
Name of vlan interface. The name must be of the format <parent-inteface>-<vlanid>
- node => string
Node name of vlan interface.
Outputs
[Family: cluster]
Iterate over a list of VLAN objects.Inputs
- desired-attributes => vlan-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 => vlan-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the net-vlan object. All net-vlan 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 net-vlan objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
In Data ONTAP 7-Mode, this API will disable NFS server access (effectively same as the CLI command "nfs off") In Data ONTAP Cluster-Mode, this will stop the Vserver's NFS service. If the NFS service was not explicitly created, this API does nothing.Inputs
Outputs
[Family: vserver]
In Data ONTAP 7-Mode, this API will enable NFS server access (effectively same as the CLI command "nfs on") In Data ONTAP Cluster-Mode, this will start the Vserver's NFS service. If the NFS service was not explicitly created, this API will create one with default options.Inputs
Outputs
[Family: vserver]
Enables pathnames for mounting according to the rules specified. New rules for the pathnames take effect immediately, ignoring previous rules for specified pathnames. In the Data ONTAP 7-Mode, set the persistent option to true to save the rule in the etc/exports file and keep the option persistent upon loading or reboot whereas it must be true in Data ONTAP Cluster-Mode as the export entries are always persistent.Inputs
- 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.
[Family: vserver]
Enables pathnames for mounting according to the rules specified. New rules for the pathnames take effect immediately, ignoring previous rules for specified pathnames. In the Data ONTAP 7-Mode, set the persistent option to true to save the rule in the etc/exports file and keep the option persistent upon loading or reboot whereas it must be true in Data ONTAP Cluster-Mode as the export entries are always persistent. The new security-rule-info structure contains finer grained information about security rules than exports-rule-info.Inputs
- 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.
[Family: vserver]
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
[Family: vserver]
Removes the rules for a set of pathnames. This returns an error if any of the pathnames don't have a rule. In the Data ONTAP 7-Mode, set the persistent option to modify the etc/exports file and keep this change persistent upon reboots whereas it must be true in Data ONTAP Cluster-Mode as the export entries are always persistent.Inputs
- 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
[Family: vserver]
Returns the rules associated with exports. If a pathname is specified, the rules associated with the export matching that pathname, are returned; otherwise, rules for all exports are returned.Inputs
- 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.
[Family: vserver]
Returns the rules associated with exports, using the new security info structure. If a pathname is specified, the rules associated with the export matching that pathname, are returned; otherwise, rules for all exports are returned.Inputs
- 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.
[Family: vserver]
Functionally similar to append with the following caveats. Returns an error if the rule does not exist. Only works for one rule at a time.Inputs
- 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.
Outputs
[Family: vserver]
Functionally similar to append-2 with the following caveats. Returns an error if the rule does not exist. Only works for one rule at a time.Inputs
- 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.
Outputs
[Family: vserver]
Returns a list of currently supported security flavors. Hosts with permmisions and connecting via the proper security flavor have access to directories on the filer. Default security flavor for all exports is "sys".Inputs
Outputs
[Family: vserver]
Create a new NFS configuration.Inputs
- chown-mode => nfschownmode, optional
Vserver Change Ownership Mode. Possible values are 'ignore', 'fail', 'use_export_policy'. If 'use_export_policy' is set, export policy option is used. Default value is 'use_export_policy'. Possible values: - "restricted" ,
- "unrestricted" ,
- "use_export_policy"
- ntfs-unix-security-ops => string, optional
Ignore/Fail unix security operations on NTFS volumes. Possible values are 'ignore', 'fail','use_export_policy'. If 'use_export_policy' is set, export policy option is used. Default value is 'use_export_policy'.
- return-record => boolean, optional
If set to true, returns the NFS Server on successful creation. Default: false
Outputs
[Family: vserver]
Delete an NFS configuration.Inputs
Outputs
[Family: vserver]
Get the NFS server configuration.Inputs
- desired-attributes => nfs-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
[Family: cluster, vserver]
Obtain the default values for NFS server configuration.Inputs
Outputs
[Family: cluster, vserver]
Iterate over the list of NFS servers.Inputs
- desired-attributes => nfs-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 => nfs-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the NFS Server object. All NFS Server 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 NFS Server objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify an NFS configuration. If no values are given, the NFS configuration is not modified.Inputs
- chown-mode => nfschownmode, optional
Vserver Change Ownership Mode. Possible values are 'ignore', 'fail', 'use_export_policy'. If 'use_export_policy' is set, export policy option is used. Default value is 'use_export_policy'. Possible values: - "restricted" ,
- "unrestricted" ,
- "use_export_policy"
- default-windows-group => string, optional
The default windows group for CIFS access.
- default-windows-user => string, optional
The default windows user for CIFS access.
- enable-ejukebox => boolean, optional
If 'true', then the NFS server will send EJUKEBOX error on server delays.
- is-mount-rootonly-enabled => boolean, optional
If 'true', then the vserver allows MOUNT protocol calls only from privileged ports (port numbers less than 1024). Default value is 'true'.
- is-nfs-access-enabled => boolean, optional
If 'true',then NFS server access is enabled. Default value is 'true'.
- is-nfs-rootonly-enabled => boolean, optional
If 'true', then the vserver allows NFS protocol calls only from privileged ports (port numbers less than 1024). Default value is 'false'.
- is-nfsv2-enabled => boolean, optional
Starting Data ONTAP 8.2, NFS v2 is no longer supported. Default value is 'false'.
- is-nfsv3-connection-drop-enabled => boolean, optional
If 'true', then connection is dropped when an NFSv3 request is dropped. Default value is 'true'.
- is-nfsv3-enabled => boolean, optional
If 'true', then NFS version 3 is enabled. Default value is 'true'.
- is-nfsv3-fsid-change-enabled => boolean, optional
If 'true', then NFSv3 clients see change in FSID as they traverse filesystems. Default value is 'true'.
- is-nfsv4-fsid-change-enabled => boolean, optional
If 'true', then clients see change in FSID as NFSv4 clients traverse filesystems. Default value is 'true'.
- is-nfsv4-numeric-ids-enabled => boolean, optional
If 'true', then NFSv4 support for Numeric Owner IDs is enabled. Default value is 'true'.
- is-nfsv40-acl-enabled => boolean, optional
If 'true', then NFSv4.0 ACL feature is enabled. Default value is 'false'.
- is-nfsv40-enabled => boolean, optional
If 'true', then NFS version 4.0 is enabled. Default value is 'false'.
- is-nfsv40-migration-enabled => boolean, optional
If 'true', then NFSv4.0 Migration feature is enabled. Default value is 'false'.
- is-nfsv40-read-delegation-enabled => boolean, optional
If 'true', NFSv4.0 read delegation feature is enabled. Default value is 'false'.
- is-nfsv40-referrals-enabled => boolean, optional
If 'true', then NFSv4.0 Referrals feature is enabled. Default value is 'false'.
- is-nfsv40-req-open-confirm-enabled => boolean, optional
If 'true', then the server will require an OPEN_CONFIRM operation for all NFSv4.0 clients. Default value is 'false'.
- is-nfsv40-write-delegation-enabled => boolean, optional
If 'true', NFSv4.0 write delegation feature is enabled. Default value is 'false'.
- is-nfsv41-acl-enabled => boolean, optional
If 'true', then NFSv4.1 ACL feature is enabled. Default value is 'false'.
- is-nfsv41-acl-preserve-enabled => boolean, optional
If 'true', the NFSv4 server will preserve and modify ACL when chmod is done. Default value is 'true'.
- is-nfsv41-enabled => boolean, optional
If 'true', then NFS version 4.1 is enabled. Default value is 'false'.
- is-nfsv41-migration-enabled => boolean, optional
If 'true', then NFSv4.1 Migration feature is enabled. Default value is 'false'.
- is-nfsv41-pnfs-enabled => boolean, optional
If 'true', then Parallel NFS support for NFS version 4.1 is enabled. Default value is 'true'.
- is-nfsv41-pnfs-striped-volumes-enabled => boolean, optional
If 'true', Striped volume support for Parallel NFS is enabled . Default value is 'false'.
- is-nfsv41-read-delegation-enabled => boolean, optional
If 'true', NFSv4.1 read delegation feature is enabled. Default value is 'false'.
- is-nfsv41-referrals-enabled => boolean, optional
If 'true', then NFSv4.1 Referrals feature is enabled. Default value is 'false'.
- is-nfsv41-state-protection-enabled => boolean, optional
If 'true', then NFSv4.1 State Protection is enabled. Default value is 'true'.
- is-nfsv41-write-delegation-enabled => boolean, optional
If 'true', NFSv4.1 write delegation feature is enabled. Default value is 'false'.
- is-vstorage-enabled => boolean, optional
If 'true', then enables the usage of vStorage protocol for server side copies, which is mostly used in hypervisors. Default value is 'false'.
- nfsv4-acl-max-aces => integer, optional
Maximum Number of ACEs allowed in an ACL. Range is 192 to 1024. Default value is 400.
- nfsv4-grace-seconds => integer, optional
NFSv4 Grace timeout value in seconds. Default value is 45 seconds.
- nfsv4-id-domain => string, optional
NFSv4 ID mapping domain. Default value is 'defaultv4iddomain.com'.
- nfsv4-lease-seconds => integer, optional
NFSv4 Lease timeout value in seconds. Default value is 30 seconds.
- nfsv41-implementation-id-domain => string, optional
NFSv4.1 Implementation id domain. Default value is 'defaultv41impliddomain.com'.
- nfsv41-implementation-id-name => string, optional
NFSv4.1 Implementation id name. Default value is 'defaultv41implidname'.
- nfsv41-implementation-id-time => date, optional
NFSv4.1 Implementation id time.The number of seconds since January 1, 1970.
- nfsv4x-session-num-slots => integer, optional
Number of Slots in the NFSv4.x Session Slot Tables. Default value is 180.
- nfsv4x-session-slot-reply-cache-size => integer, optional
Size of the Reply that will be Cached in Each NFSv4.x Session Slot (in bytes). Default value is 640.
- ntfs-unix-security-ops => string, optional
Ignore/Fail unix security operations on NTFS volumes. Possible values are 'ignore', 'fail','use_export_policy'. If 'use_export_policy' is set, export policy option is used. Default value is 'use_export_policy'.
- rpcsec-ctx-high => integer, optional
High water mark for the RPCSEC_GSS Context Cache. Default value is 0.
- rpcsec-ctx-idle => integer, optional
Time in seconds before an idle entry in RPCSEC_GSS context cache is deleted. Default value is 0.
Outputs
[Family: vserver]
Returns the status of the NFS server.Inputs
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.
[Family: vserver]
Create an NIS domain configuration. Multiple NIS domains can be configured on a single Vserver, but only one NIS domain can be active at any given time.Inputs
- return-record => boolean, optional
If set to true, returns the NIS domain configuration on successful creation. Default: false
Outputs
[Family: vserver]
Destroy an existing NIS configuration.Inputs
- nis-domain => string
Specifies the NIS domain. For example: 'example.com'
Outputs
[Family: vserver]
Get NIS domain configuration.Inputs
- nis-domain => string
Specifies the NIS domain. For example: 'example.com'
Outputs
[Family: cluster, vserver]
Iterate over a list of NIS configurations.Inputs
- desired-attributes => nis-domain-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
- 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 NIS domain configuration objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify the attributes of NIS configuration.Inputs
- nis-domain => string
Specifies the NIS domain. For example: 'example.com'
Outputs
[Family: vserver]
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.
[Family: cluster, vserver]
Iterate over a list of options objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => option-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the options object. All options 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 options objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Get a list of all optionsInputs
Outputs
[Family: cluster, vserver]
Modify the attributes of options or a group of options objects.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple options objects match a given query. If set to true, the API will continue modifying the next matching options even when modification of a previous options fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching options even when the modification of a previous matching options fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of objects to be modified in this call. Default: 20
- query => option-info
If modifying a specific options, this input element must specify all keys. If modifying options objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of options objects (just keys) that were not modified due to some error. If set to false, the list of options objects not modified will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of options objects (just keys) that were successfully updated. If set to false, the list of options objects modified will not be returned. Default: true
- 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 matching options objects to be modified.
- num-failed => integer, optional
Number of options objects that matched the query, but were not modified due to some error.
- num-succeeded => integer, optional
The number of options objects that matched the query and were successfully updated.
[Family: vserver]
Set the value of a single option. For complete list of names and values of options, please refer to options man pages.Inputs
- 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".
- message => string, optional
Informative message that was issued as a result of setting (or trying to set) the option.
[Family: cluster]
Display the current Performance Archive configurationInputs
Outputs
[Family: cluster]
Modify the current Performance Archive configurationInputs
- is-enabled => boolean, optional
Is the Performance Archive Enabled?
Outputs
[Family: cluster]
Save a new Performance ArchiveInputs
- comment => string, optional
Performance Archive Comment
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
The ID of the job that was spawned to create this perf-archive.
- result-status => string, optional
The operation status. Possible values: "succeeded" if creation completed successfully, "in_progress" if creation is in progress, "failed" if creation failed.
[Family: cluster]
Destroy a Performance ArchiveInputs
- archive => string
Performance Archive Name
Outputs
- result-error-code => integer, optional
Error code, if the deletion operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
[Family: cluster]
Iteratively get information about Performance ArchivesInputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 perf-archive objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modify properties of a Performance ArchiveInputs
- archive => string
Performance Archive Name
- case-number => string, optional
Support Case Number Associated with Archive
- comment => string, optional
Performance Archive Comment
Outputs
[Family: cluster, vserver]
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
- filter-data => filter-data, optional
Allows selecting counters from a particular node. An example filter is "node_name=hostname".
This element is deprecated in Data ONTAP 8.2 and later, as filtering by node is no longer necessary. Each node contains the same set of counter definitions, so filtering by node yields the same results as not filtering at all.
Outputs
[Family: cluster, vserver]
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.
- filter-data => filter-data, optional
Filter to apply to the performance data.
- instance-uuids => instance-uuid[], optional
List of instance UUIDs 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. 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.
- 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.
- privilege-level => string, optional
Name of the privilege level. Possible values: "basic", "admin", "advanced", "diag" If the element is absent, the default privilege of the object will be used.
Outputs
[Family: cluster, vserver]
Gets the list of names and UUIDs of current instances of an object. This iterative API will return names and UUIDs of the current instances of the specified object; the number of records returned is specified by the max-records input element. To retrieve all the instances of the specified object, the value of the next-tag output element should be passed in as the value of the tag input element on the subsequent API call.
Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 1000
- objectname => string
Name of the object for which to get instance information.
- query => instance-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the perf object. All perf 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 perf objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster, vserver]
Get list of performance objects in the system.Inputs
- filter-data => filter-data, optional
Allows selecting objects from a particular node. An example filter is "node_name=hostname".
This element is deprecated in Data ONTAP 8.2 and later as filtering by node is no longer necessary. Each node contains the same set of object definitions, so filtering by node yields the same results as not filtering at all.
Outputs
[Family: cluster]
Create a single Performance Preset configuration and all of its detailsInputs
- comment => string, optional
Preset Description
Outputs
[Family: cluster]
Delete a Performance Preset and all of its Preset DetailsInputs
- preset => string
Preset Name
Outputs
[Family: cluster]
Get detailed information about a single Performance Preset configurationInputs
- preset => string
Preset Name
Outputs
- comment => string, optional
Preset Description
- expiration-length => integer, optional
Default expiration length (in minutes) until the Performance Preset will be automatically disabled.
- preset => string
Preset Name
- preset-detail-infos => preset-detail-info[]
The details of the Performance Preset configuration
- privilege => string, optional
Preset Privilege Level
Possible Values: admin, advanced, diagnostic
[Family: cluster]
Iteratively get information about Performance PresetsInputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => preset-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the perf-preset object. All perf-preset 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 perf-preset objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modify a Performance PresetInputs
- comment => string, optional
Preset Description
- is-archive-enabled => boolean, optional
Is Preset Archive-Enabled?
- preset => string
Preset Name
Outputs
[Family: vserver]
Add a port to an existing port setInputs
- 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
[Family: vserver]
Create a port setInputs
- 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
[Family: vserver]
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
[Family: cluster, vserver]
Iterate over a list of portset objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => portset-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the portset object. All portset 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 portset objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
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
[Family: cluster]
Create a new policy. A unique name must be provided for the new policy, and a uuid will be returned. The policy will not affect any work until it is assigned to a workload. Therefore a workload referencing the policy should usually be created along with the policy.Inputs
- policy-name => string
User visible name of QoS policy.
Outputs
[Family: cluster]
Delete single policy. The policy may not be attached to any workloads. Only user defined policies may be deleted.Inputs
- policy-uuid => uuid
Universally unique identifier for the QoS policy.
Outputs
[Family: cluster]
Delete multiple policies. The policies may not be attached to any workloads. Only user defined policies may be deleted.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple qos-policy objects match a given query. If set to true, the API will continue deleting the next matching qos-policy even when the deletion of a previous qos-policy fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching qos-policy even when the deletion of a previous matching qos-policy fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of qos-policy objects to delete in this call. Default: 20
- query => qos-policy-info
If deleting a specific qos-policy, this input element must specify all keys. If deleting multiple qos-policy objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of qos-policy objects (just keys) that were not deleted due to some error. If set to false, the list of qos-policy objects not deleted will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of qos-policy objects (just keys) that were successfully deleted. If set to false, the list of qos-policy objects deleted will not be returned. Default: true
- 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 matching qos-policy objects to be deleted.
- num-failed => integer, optional
Number of qos-policy objects that matched the query, but were not deleted due to some error.
- num-succeeded => integer, optional
The number of qos-policy objects that matched the query and were successfully deleted.
[Family: cluster]
Get the attributes of a policy.Inputs
- policy-uuid => uuid
Universally unique identifier for the QoS policy.
Outputs
[Family: cluster]
Iterate over list of policies.Inputs
- desired-attributes => qos-policy-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
- 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 qos-policy objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Create a policy group. A unique name must be provided for the new policy group. A QoS Policy group defines measurable Service Level Objectives (SLOs) that apply to the storage object with which the policy group is associated.Inputs
- max-throughput => qos-tput, optional
Maximum throughput defined by this policy. It is specified in terms of IOPS or MB/s, and the range is zero to infinity. The values entered here are case-insensitive, and the units are base ten. There should be no space between the number and the units. The default value for max-throughput is infinity. The default unit is IOPS. Two reserved keywords, 'none' and 'INF', are available for the situation that requires removal of a value, and the situation that needs to specify the maximum available value. Examples of valid specifications are: 100B/s, 10KB/s, 1gb/s, 500MB/s, 1tb/s, and 100iops.
- policy-group => string
Name of the policy group. Policy group names must be unique and are restricted to 128 alphanumeric characters, '-', and '_', and must start with an alphanumeric character (a-z, A-Z, or 0-9).
- return-record => boolean, optional
If set to true, returns the qos-policy-group on successful creation. Default: false
- vserver => vserver-name
The Data Vserver to which the policy group belongs.
Outputs
[Family: cluster]
Delete single policy group. The default policy group may not be deleted. The policy group may not be attached to any workloads. Only user defined policy groups may be deleted.Inputs
- policy-group => string
Name of the policy group. Policy group names must be unique and are restricted to 128 alphanumeric characters, '-', and '_', and must start with an alphanumeric character (a-z, A-Z, or 0-9).
Outputs
[Family: cluster]
Delete multiple policy groups.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple qos-policy-group objects match a given query. If set to true, the API will continue deleting the next matching qos-policy-group even when the deletion of a previous qos-policy-group fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching qos-policy-group even when the deletion of a previous matching qos-policy-group fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of qos-policy-group objects to delete in this call. Default: 20
- return-failure-list => boolean, optional
If set to true, the API will return the list of qos-policy-group objects (just keys) that were not deleted due to some error. If set to false, the list of qos-policy-group objects not deleted will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of qos-policy-group objects (just keys) that were successfully deleted. If set to false, the list of qos-policy-group objects deleted will not be returned. Default: true
- 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 matching qos-policy-group objects to be deleted.
- num-failed => integer, optional
Number of qos-policy-group objects that matched the query, but were not deleted due to some error.
- num-succeeded => integer, optional
The number of qos-policy-group objects that matched the query and were successfully deleted.
[Family: cluster]
Get the attributes of a policy group.Inputs
- policy-group => string
Name of the policy group. Policy group names must be unique and are restricted to 128 alphanumeric characters, '-', and '_', and must start with an alphanumeric character (a-z, A-Z, or 0-9).
Outputs
[Family: cluster]
Iterate over list of policy groups.Inputs
- desired-attributes => qos-policy-group-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
- 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 qos-policy-group objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modify an existing policy group.Inputs
- max-throughput => qos-tput, optional
Maximum throughput defined by this policy. It is specified in terms of IOPS or MB/s, and the range is zero to infinity. The values entered here are case-insensitive, and the units are base ten. There should be no space between the number and the units. The default value for max-throughput is infinity. The default unit is IOPS. Two reserved keywords, 'none' and 'INF', are available for the situation that requires removal of a value, and the situation that needs to specify the maximum available value. Examples of valid specifications are: 100B/s, 10KB/s, 1gb/s, 500MB/s, 1tb/s, and 100iops.
- policy-group => string
Name of the policy group. Policy group names must be unique and are restricted to 128 alphanumeric characters, '-', and '_', and must start with an alphanumeric character (a-z, A-Z, or 0-9).
Outputs
[Family: cluster]
Modify multiple policy groupsInputs
- attributes => qos-policy-group-info
Specify at least one modifiable element. Do not specify any other element.
- continue-on-failure => boolean, optional
This input element is useful when multiple qos-policy-group objects match a given query. If set to true, the API will continue modifying the next matching qos-policy-group even when modification of a previous qos-policy-group fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching qos-policy-group even when the modification of a previous matching qos-policy-group fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of objects to be modified in this call. Default: 20
- query => qos-policy-group-info
If modifying a specific qos-policy-group, this input element must specify all keys. If modifying qos-policy-group objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of qos-policy-group objects (just keys) that were not modified due to some error. If set to false, the list of qos-policy-group objects not modified will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of qos-policy-group objects (just keys) that were successfully updated. If set to false, the list of qos-policy-group objects modified will not be returned. Default: true
- 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 matching qos-policy-group objects to be modified.
- num-failed => integer, optional
Number of qos-policy-group objects that matched the query, but were not modified due to some error.
- num-succeeded => integer, optional
The number of qos-policy-group objects that matched the query and were successfully updated.
[Family: cluster]
Rename a QoS Policy GroupInputs
- policy-group-name => string
Name of the policy group. Policy group names must be unique and are restricted to 128 alphanumeric characters, '-', and '_', and must start with an alphanumeric character (a-z, A-Z, or 0-9).
Outputs
[Family: cluster]
Modify an existing policy.Inputs
- cache-policy-name => string, optional
Name of an entry in the cache policy table. Identifies cache settings that will be used by workloads using this policy. If this field contains the special value 'default' then the default cache policies will be used. Modifying this field is not recommended.
- policy-uuid => uuid
Universally unique identifier for the QoS policy.
- read-ahead-policy-name => string, optional
Name of an entry in the read-ahead policy table. Identifies read-ahead settings that will be used by workloads using this policy. If this field contains the special value 'default' then the default read-ahead policies will be used. Modifying this field is not recommended.
Outputs
[Family: cluster]
Modify multiple policiesInputs
- attributes => qos-policy-info
Specify at least one modifiable element. Do not specify any other element.
- continue-on-failure => boolean, optional
This input element is useful when multiple qos-policy objects match a given query. If set to true, the API will continue modifying the next matching qos-policy even when modification of a previous qos-policy fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching qos-policy even when the modification of a previous matching qos-policy fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of objects to be modified in this call. Default: 20
- query => qos-policy-info
If modifying a specific qos-policy, this input element must specify all keys. If modifying qos-policy objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of qos-policy objects (just keys) that were not modified due to some error. If set to false, the list of qos-policy objects not modified will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of qos-policy objects (just keys) that were successfully updated. If set to false, the list of qos-policy objects modified will not be returned. Default: true
- 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 matching qos-policy objects to be modified.
- num-failed => integer, optional
Number of qos-policy objects that matched the query, but were not modified due to some error.
- num-succeeded => integer, optional
The number of qos-policy objects that matched the query and were successfully updated.
[Family: cluster]
Create a new read-ahead policy. A unique name must be provided for the new read-ahead policy. If the 'default' field is set to true, these become the default read-ahead settings for policies that don't otherwise name read-ahead settings. Unless creating a new default, creating read-ahead policies should usually be assigned to an existing QoS policy.Inputs
- return-record => boolean, optional
If set to true, returns the qos-policy-read-ahead on successful creation. Default: false
Outputs
[Family: cluster]
Delete single read-ahead policy. The default policy may not be deleted. The policy may not be attached to any workloads. Only user defined policies may be deleted.Inputs
- read-ahead-policy-name => string
Name of QoS Readahead Policy.
Outputs
[Family: cluster]
Delete multiple read-ahead policies.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple qos-policy-read-ahead objects match a given query. If set to true, the API will continue deleting the next matching qos-policy-read-ahead even when the deletion of a previous qos-policy-read-ahead fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching qos-policy-read-ahead even when the deletion of a previous matching qos-policy-read-ahead fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of qos-policy-read-ahead objects to delete in this call. Default: 20
- return-failure-list => boolean, optional
If set to true, the API will return the list of qos-policy-read-ahead objects (just keys) that were not deleted due to some error. If set to false, the list of qos-policy-read-ahead objects not deleted will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of qos-policy-read-ahead objects (just keys) that were successfully deleted. If set to false, the list of qos-policy-read-ahead objects deleted will not be returned. Default: true
- 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 matching qos-policy-read-ahead objects to be deleted.
- num-failed => integer, optional
Number of qos-policy-read-ahead objects that matched the query, but were not deleted due to some error.
- num-succeeded => integer, optional
The number of qos-policy-read-ahead objects that matched the query and were successfully deleted.
[Family: cluster]
Get the attributes of a read-ahead policy.Inputs
- read-ahead-policy-name => string
Name of QoS Readahead Policy.
Outputs
[Family: cluster]
Iterate over list of read-ahead policies.Inputs
- desired-attributes => qos-policy-read-ahead-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 => qos-policy-read-ahead-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the qos-policy-read-ahead object. All qos-policy-read-ahead 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 qos-policy-read-ahead objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modify an existing read-ahead policy.Inputs
- align-blocks => integer, optional
Block Alignment
- default => boolean, optional
Default
- disk-response-factor => integer, optional
Disk Response Time Factor
- disk-response-weight => integer, optional
Weight for Disk Response Time Aging (%)
- early-count => integer, optional
Number of IO Operations Cautiously Predicted
- force-dump => boolean, optional
Force DUMP-Style Readahead
- force-full => boolean, optional
Force Full-File Readahead
- force-none => boolean, optional
Disable Readahead
- interarrival-weight => integer, optional
Weight for Interarrival Time Aging (%)
- jitter => integer, optional
Threshold for Detecting Jitter (%)
- max-blocks => integer, optional
Maximum Blocks to Speculate
- max-deadline => integer, optional
Maximum Deadline Offset (us)
- max-disk-response-time => integer, optional
Maximum Disk Response Time (us)
- max-gap => integer, optional
Maximum Speculative Blocks Outstanding
- max-range => integer, optional
Maximum Range Used When Aging Streams (Blocks)
- max-retire-time => integer, optional
Maximum Time Before a Stream is Retired (us)
- metadata-blocks => integer, optional
Minimum Blocks for Which Metadata is Predicted
- min-blocks => integer, optional
Minimum Blocks to Speculate
- min-disk-response-time => integer, optional
Minimum Disk Response Time (us)
- min-range => integer, optional
Minimum Range Used When Aging Streams (Blocks)
- min-retire-time => integer, optional
Minimum Time Before a Stream is Retired (us)
- overshoot => integer, optional
Allowable Overshoot (%)
- read-ahead-policy-name => string
Name of QoS Readahead Policy.
- smallfile-blocks => integer, optional
Maximum Blocks for Small-File Handling
- use-async => boolean, optional
Use Asynchronous Speculation
- use-feedback => boolean, optional
Provide Cache-Miss Feedback
- use-timing => boolean, optional
Use Timing Algorithms
Outputs
[Family: cluster]
Modify multiple read-ahead policiesInputs
- continue-on-failure => boolean, optional
This input element is useful when multiple qos-policy-read-ahead objects match a given query. If set to true, the API will continue modifying the next matching qos-policy-read-ahead even when modification of a previous qos-policy-read-ahead fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching qos-policy-read-ahead even when the modification of a previous matching qos-policy-read-ahead fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of objects to be modified in this call. Default: 20
- query => qos-policy-read-ahead-info
If modifying a specific qos-policy-read-ahead, this input element must specify all keys. If modifying qos-policy-read-ahead objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of qos-policy-read-ahead objects (just keys) that were not modified due to some error. If set to false, the list of qos-policy-read-ahead objects not modified will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of qos-policy-read-ahead objects (just keys) that were successfully updated. If set to false, the list of qos-policy-read-ahead objects modified will not be returned. Default: true
- 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
- failure-list => qos-policy-read-ahead-modify-iter-info[], optional
Information about qos-policy-read-ahead objects that were not modified due to some error. This element will be returned only if input element 'return-failure-list' is true.
- next-tag => string, optional
Tag for the next call. Not present when there are no more matching qos-policy-read-ahead objects to be modified.
- num-failed => integer, optional
Number of qos-policy-read-ahead objects that matched the query, but were not modified due to some error.
- num-succeeded => integer, optional
The number of qos-policy-read-ahead objects that matched the query and were successfully updated.
- success-list => qos-policy-read-ahead-modify-iter-info[], optional
The qos-policy-read-ahead objects that were successfully updated. This element will be returned only if input element 'return-success-list' is true
[Family: cluster]
Get the cluster-wide QoS workload archival settings.Inputs
Outputs
[Family: cluster]
Modify the cluster-wide QoS workload archival settings.Inputs
Outputs
[Family: cluster]
Get the cluster-wide QoS control settings.Inputs
Outputs
[Family: cluster]
Modify the existing cluster-wide QoS control settings.Inputs
Outputs
[Family: cluster]
Create a new read-ahead setting. A unique name must be provided for the new read-ahead setting. If the 'default' field is set to true, these become the default read-ahead settings for settings that don't otherwise name read-ahead settings. Unless creating a new default, creating read-ahead settings should usually be assigned to an existing QoS setting.Inputs
- align-blocks => integer, optional
Block alignment
- default => boolean, optional
Specifies whether this is the default readahead setting
- disk-response-factor => integer, optional
Disk response time factor
- disk-response-weight => integer, optional
Weight for disk response time aging (%)
- early-count => integer, optional
Number of IO operations cautiously predicted
- force-dump => boolean, optional
Force DUMP-style readahead
- force-full => boolean, optional
Force full-file readahead
- force-none => boolean, optional
Disable readahead
- interarrival-weight => integer, optional
Weight for interarrival time aging (%)
- jitter => integer, optional
Threshold for detecting jitter (%)
- max-blocks => integer, optional
Maximum blocks to speculate
- max-deadline => integer, optional
Maximum deadline Offset (ms)
- max-disk-response-time => integer, optional
Maximum disk response time (ms)
- max-gap => integer, optional
Maximum speculative blocks outstanding
- max-range => integer, optional
Maximum range used when aging streams (Blocks)
- max-retire-time => integer, optional
Maximum Time Before a Stream is Retired (us)
- metadata-blocks => integer, optional
Minimum blocks for which metadata is predicted
- min-blocks => integer, optional
Minimum blocks to speculate
- min-disk-response-time => integer, optional
Minimum disk response time (ms)
- min-range => integer, optional
Minimum range used when aging streams (Blocks)
- min-retire-time => integer, optional
Minimum Time Before a Stream is Retired (us)
- overshoot => integer, optional
Allowable overshoot (%)
- read-ahead-class => qos-class, optional
Readahead setting class Possible values: - "preset" - Preset,
- "user_defined" - User Defined,
- "system_defined" - System Defined
- return-record => boolean, optional
If set to true, returns the qos-settings-read-ahead on successful creation. Default: false
- smallfile-blocks => integer, optional
Maximum blocks for small-file handling
- use-async => boolean, optional
Use asynchronous speculation
- use-feedback => boolean, optional
Provide cache-miss feedback
- use-timing => boolean, optional
Use timing algorithms
Outputs
[Family: cluster]
Destroy single read-ahead setting. The default setting may not be destroyed. The setting may not be attached to any workloads. Only user defined settings may be destroyed.Inputs
- read-ahead-setting-name => string
Name of QoS Readahead Setting.
Outputs
[Family: cluster]
Destroy multiple read-ahead settings.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple qos-settings-read-ahead objects match a given query. If set to true, the API will continue deleting the next matching qos-settings-read-ahead even when the deletion of a previous qos-settings-read-ahead fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching qos-settings-read-ahead even when the deletion of a previous matching qos-settings-read-ahead fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of qos-settings-read-ahead objects to delete in this call. Default: 20
- return-failure-list => boolean, optional
If set to true, the API will return the list of qos-settings-read-ahead objects (just keys) that were not deleted due to some error. If set to false, the list of qos-settings-read-ahead objects not deleted will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of qos-settings-read-ahead objects (just keys) that were successfully deleted. If set to false, the list of qos-settings-read-ahead objects deleted will not be returned. Default: true
- 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 matching qos-settings-read-ahead objects to be deleted.
- num-failed => integer, optional
Number of qos-settings-read-ahead objects that matched the query, but were not deleted due to some error.
- num-succeeded => integer, optional
The number of qos-settings-read-ahead objects that matched the query and were successfully deleted.
[Family: cluster]
Get the attributes of a read-ahead setting.Inputs
- read-ahead-setting-name => string
Name of QoS Readahead Setting.
Outputs
[Family: cluster]
Iterate over list of read-ahead settings.Inputs
- desired-attributes => qos-settings-read-ahead-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 => qos-settings-read-ahead-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the qos-settings-read-ahead object. All qos-settings-read-ahead 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 qos-settings-read-ahead objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modify an existing read-ahead setting.Inputs
- align-blocks => integer, optional
Block alignment
- default => boolean, optional
Specifies whether this is the default readahead setting
- disk-response-factor => integer, optional
Disk response time factor
- disk-response-weight => integer, optional
Weight for disk response time aging (%)
- early-count => integer, optional
Number of IO operations cautiously predicted
- force-dump => boolean, optional
Force DUMP-style readahead
- force-full => boolean, optional
Force full-file readahead
- force-none => boolean, optional
Disable readahead
- interarrival-weight => integer, optional
Weight for interarrival time aging (%)
- jitter => integer, optional
Threshold for detecting jitter (%)
- max-blocks => integer, optional
Maximum blocks to speculate
- max-deadline => integer, optional
Maximum deadline Offset (ms)
- max-disk-response-time => integer, optional
Maximum disk response time (ms)
- max-gap => integer, optional
Maximum speculative blocks outstanding
- max-range => integer, optional
Maximum range used when aging streams (Blocks)
- max-retire-time => integer, optional
Maximum Time Before a Stream is Retired (us)
- metadata-blocks => integer, optional
Minimum blocks for which metadata is predicted
- min-blocks => integer, optional
Minimum blocks to speculate
- min-disk-response-time => integer, optional
Minimum disk response time (ms)
- min-range => integer, optional
Minimum range used when aging streams (Blocks)
- min-retire-time => integer, optional
Minimum Time Before a Stream is Retired (us)
- overshoot => integer, optional
Allowable overshoot (%)
- read-ahead-setting-name => string
Name of QoS Readahead Setting.
- smallfile-blocks => integer, optional
Maximum blocks for small-file handling
- use-async => boolean, optional
Use asynchronous speculation
- use-feedback => boolean, optional
Provide cache-miss feedback
- use-histogram => boolean, optional
Use Histogram-based predictions
- use-timing => boolean, optional
Use timing algorithms
Outputs
[Family: cluster]
Modify multiple read-ahead settingsInputs
- continue-on-failure => boolean, optional
This input element is useful when multiple qos-settings-read-ahead objects match a given query. If set to true, the API will continue modifying the next matching qos-settings-read-ahead even when modification of a previous qos-settings-read-ahead fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching qos-settings-read-ahead even when the modification of a previous matching qos-settings-read-ahead fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of objects to be modified in this call. Default: 20
- query => qos-settings-read-ahead-info
If modifying a specific qos-settings-read-ahead, this input element must specify all keys. If modifying qos-settings-read-ahead objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of qos-settings-read-ahead objects (just keys) that were not modified due to some error. If set to false, the list of qos-settings-read-ahead objects not modified will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of qos-settings-read-ahead objects (just keys) that were successfully updated. If set to false, the list of qos-settings-read-ahead objects modified will not be returned. Default: true
- 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
- failure-list => qos-settings-read-ahead-modify-iter-info[], optional
Information about qos-settings-read-ahead objects that were not modified due to some error. This element will be returned only if input element 'return-failure-list' is true.
- next-tag => string, optional
Tag for the next call. Not present when there are no more matching qos-settings-read-ahead objects to be modified.
- num-failed => integer, optional
Number of qos-settings-read-ahead objects that matched the query, but were not modified due to some error.
- num-succeeded => integer, optional
The number of qos-settings-read-ahead objects that matched the query and were successfully updated.
- success-list => qos-settings-read-ahead-modify-iter-info[], optional
The qos-settings-read-ahead objects that were successfully updated. This element will be returned only if input element 'return-success-list' is true
[Family: cluster]
Create a new stream. A workload uuid and stream properties must be provided, and a new stream-id is returned.Inputs
Outputs
- stream-id => integer
Identifier for this stream. Together with the workload-uuid, uniquely identifies the stream.
[Family: cluster]
Delete single stream.Inputs
- stream-id => integer
Identifier for this stream. Together with the workload-uuid, uniquely identifies the stream.
- workload-uuid => uuid
Universally unique identifier for the workload to which the stream is attached.
Outputs
[Family: cluster]
Delete multiple streams.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple qos-stream objects match a given query. If set to true, the API will continue deleting the next matching qos-stream even when the deletion of a previous qos-stream fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching qos-stream even when the deletion of a previous matching qos-stream fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of qos-stream objects to delete in this call. Default: 20
- query => qos-stream-info
If deleting a specific qos-stream, this input element must specify all keys. If deleting multiple qos-stream objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of qos-stream objects (just keys) that were not deleted due to some error. If set to false, the list of qos-stream objects not deleted will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of qos-stream objects (just keys) that were successfully deleted. If set to false, the list of qos-stream objects deleted will not be returned. Default: true
- 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 matching qos-stream objects to be deleted.
- num-failed => integer, optional
Number of qos-stream objects that matched the query, but were not deleted due to some error.
- num-succeeded => integer, optional
The number of qos-stream objects that matched the query and were successfully deleted.
[Family: cluster]
Get the attributes of a stream.Inputs
- stream-id => integer
Identifier for this stream. Together with the workload-uuid, uniquely identifies the stream.
- workload-uuid => uuid
Universally unique identifier for the workload to which the stream is attached.
Outputs
[Family: cluster]
Iterate over list of streams.Inputs
- desired-attributes => qos-stream-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
- 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 qos-stream objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Returns SMF error with ZAPI error codesInputs
Outputs
[Family: cluster]
Create a new workload. A unique name must be provided for the new workload, and a uuid is returned. Subsequent management operations should index workloads by uuid as the name may be modified. No work will be classified to a workload unless the workload has at least one stream. Therefore at least one stream should usually be created along with a workload. If the performance of the workload is to be controlled by QoS, a policy must also be defined and attached to the workload.Inputs
Outputs
- workload-uuid => uuid
Universally unique identifier for the QoS workload.
[Family: cluster]
Delete a single workload. Only user defined workloads may be deleted.Inputs
- workload-name => string
User visible name of QoS workload.
Outputs
[Family: cluster]
Delete multiple workloads. Only user defined workloads may be deleted.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple qos-workload objects match a given query. If set to true, the API will continue deleting the next matching qos-workload even when the deletion of a previous qos-workload fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching qos-workload even when the deletion of a previous matching qos-workload fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of qos-workload objects to delete in this call. Default: 20
- return-failure-list => boolean, optional
If set to true, the API will return the list of qos-workload objects (just keys) that were not deleted due to some error. If set to false, the list of qos-workload objects not deleted will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of qos-workload objects (just keys) that were successfully deleted. If set to false, the list of qos-workload objects deleted will not be returned. Default: true
- 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 matching qos-workload objects to be deleted.
- num-failed => integer, optional
Number of qos-workload objects that matched the query, but were not deleted due to some error.
- num-succeeded => integer, optional
The number of qos-workload objects that matched the query and were successfully deleted.
[Family: cluster]
Delete single workload. This also deletes any streams attached to the workload. Only user defined workloads may be deleted.Inputs
- workload-uuid => uuid
Universally unique identifier for the QoS workload.
Outputs
[Family: cluster]
Delete multiple workloads. This also deletes any streams attached to the workloads. Only user defined workloads may be deleted.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple qos-workload objects match a given query. If set to true, the API will continue deleting the next matching qos-workload even when the deletion of a previous qos-workload fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching qos-workload even when the deletion of a previous matching qos-workload fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of qos-workload objects to delete in this call. Default: 20
- query => qos-workload-info
If deleting a specific qos-workload, this input element must specify all keys. If deleting multiple qos-workload objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of qos-workload objects (just keys) that were not deleted due to some error. If set to false, the list of qos-workload objects not deleted will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of qos-workload objects (just keys) that were successfully deleted. If set to false, the list of qos-workload objects deleted will not be returned. Default: true
- 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 matching qos-workload objects to be deleted.
- num-failed => integer, optional
Number of qos-workload objects that matched the query, but were not deleted due to some error.
- num-succeeded => integer, optional
The number of qos-workload objects that matched the query and were successfully deleted.
[Family: cluster]
Get the attributes of a workload.Inputs
- workload-name => string
User visible name of QoS workload.
Outputs
[Family: cluster]
Iterate over list of workloads.Inputs
- desired-attributes => qos-workload-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
- 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 qos-workload objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modify an existing workload. This may be used to rename the workload, modify the workload's ID, its class, or its category.Inputs
- workload-name => string
User visible name of QoS workload.
Outputs
[Family: cluster]
Modify multiple workloadsInputs
- attributes => qos-workload-info
Specify at least one modifiable element. Do not specify any other element.
- continue-on-failure => boolean, optional
This input element is useful when multiple qos-workload objects match a given query. If set to true, the API will continue modifying the next matching qos-workload even when modification of a previous qos-workload fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching qos-workload even when the modification of a previous matching qos-workload fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of objects to be modified in this call. Default: 20
- query => qos-workload-info
If modifying a specific qos-workload, this input element must specify all keys. If modifying qos-workload objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of qos-workload objects (just keys) that were not modified due to some error. If set to false, the list of qos-workload objects not modified will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of qos-workload objects (just keys) that were successfully updated. If set to false, the list of qos-workload objects modified will not be returned. Default: true
- 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 matching qos-workload objects to be modified.
- num-failed => integer, optional
Number of qos-workload objects that matched the query, but were not modified due to some error.
- num-succeeded => integer, optional
The number of qos-workload objects that matched the query and were successfully updated.
[Family: vserver]
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.
- oplocks => string, optional
Opportunistic locks mode of the qtree. Possible values: "enabled", "disabled". Default value is the oplock mode of the volume.
- volume => string
Name of the volume on which to create the qtree
Outputs
[Family: vserver]
Delete the specified qtree. For unclustered volumes, use the quota management APIs to delete the quota rules that reference this qtree in the /etc/quotas file.
For clustered volumes, all the quota rules that reference this qtree will be automatically deleted.
Inputs
- 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
[Family: vserver]
Delete the specified qtree by spawning a background job. The jobid will be returned. The progress of the job can be tracked using the job APIs. All the quota rules that reference this qtree will be automatically deleted.Inputs
- force => boolean, optional
Force the deletion of the qtree even if it not empty. Default: false
- qtree => string
Path of an existing qtree. The path should be in this format: /vol/< volume name >/< qtree name >.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-status => string
The operation status. Possible values: "succeeded", "in-progress", "failed".
[Family: cluster, vserver]
Iterate over the list of qtrees in the cluster.Inputs
- desired-attributes => qtree-info, optional
Specify the attributes that should be returned in the qtree-info object. 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 response.
- query => qtree-info, optional
A query that specifies which qtrees need to be returned. A query could be specified on any number of attributes in the qtree-info object. All qtree objects matching this query up to 'max-records' will be returned.
- tag => string, optional
Specify the tag from the previous iteration. It is usually not specified for the first iteration. For subsequent iterations, copy the value from the 'next-tag' obtained from the previous iteration.
Outputs
- next-tag => string, optional
Tag for the next iteration. Not present when there are no more qtree objects to return.
- num-records => integer
The number of records returned in this response.
[Family: vserver]
Modify the attributes of a qtree. If values are not provided for any of the fields, then that field will not be modified.Inputs
- 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.
- oplocks => string, optional
Opportunistic locks mode of the qtree. Possible values: "enabled", "disabled".
- qtree => string
Name of the qtree.
- security-style => string, optional
Security style of the qtree. Possible values: "unix", "ntfs", or "mixed". Changing the security style of a qtree will change the visibility of existing Windows security descriptors (i.e. ACLs). This may affect the disk space usage values in the quota database. Turn quotas off and then on to re-compute disk space usage.
- volume => string
Name of the volume containing the qtree to be modified.
Outputs
[Family: vserver]
Renames the specified qtree to a new name specified by "new-qtree-name". For unclustered volumes, if the qtree is referenced in the file /etc/exportfs, use NFS API nfs-exportfs-append-rules to modify the file so that the affected file system can be exported by the filer immediately. The "qtree-rename" command does not automatically update the /etc/exports file. Also, if the qtree is referenced in the file /etc/quotas, use the quota management APIs to delete and re-create the quota rule with the new qtree name.
For clustered volumes, the qtree name in the quota rules will be automatically updated with the new qtree name.
Inputs
- qtree => string
Path of an existing qtree. The path should be in this format: /vol/< volume name >/< src qtree name >.
Outputs
[Family: vserver]
Adds a quota entry. If the type, target, volume, and tree do not exist, a new entry is created. If the type, target, volume, and tree exist, then an error is returned.Inputs
- 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.
- perform-user-mapping => boolean, optional
If the value is true, quota management will perform user mapping for the user specified in quota-target. Only valid for user quotas when the quota-target refers to a Windows/UNIX user name. Not valid for multiple user targets. Default is false.
- policy => string, optional
Name of the quota policy in which the quota rule should be added. If this field is not provided, then the current policy that has been assigned to the vserver will be used.
- 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
[Family: vserver]
Deletes a quota entry specified by type, target, volume, and tree.Inputs
- policy => string, optional
Name of the quota policy in which the quota rule should be deleted. If this field is not provided, then the current policy that has been assigned to the vserver will be used.
- 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
[Family: vserver]
Obtains a quota entry specified by type, target, volume, and tree.Inputs
- policy => string, optional
Name of the quota policy from which the quota rule should be obtained. If this field is not provided, then the current policy that has been assigned to the vserver will be used.
- 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.
- 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.
[Family: cluster, vserver]
Iterate over the list of quota rules in the cluster.Inputs
- desired-attributes => quota-entry, optional
Specify the attributes that should be returned in the quota-entry object. 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 response.
- query => quota-entry, optional
A query that specifies which quota rules need to be returned. A query could be specified on any number of attributes in the quota-entry object. All quota entry objects matching this query up to 'max-records' will be returned.
- tag => string, optional
Specify the tag from the previous iteration. It is usually not specified for the first iteration. For subsequent iterations, copy the value from the 'next-tag' obtained from the previous iteration.
Outputs
- next-tag => string, optional
Tag for the next iteration. Not present when there are no more quota entry objects to return.
- num-records => integer
The number of records returned in this response.
[Family: vserver]
Modifys a quota entry. If the type, target, volume, and tree exist, the entry is modified. If the type, target, volume, and tree do not exist, then an error is returned.Inputs
- 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.
- perform-user-mapping => boolean, optional
If the value is true, quota management will perform user mapping for the user specified in quota-target. Only valid for user quotas when the quota-target refers to a Windows/UNIX user name. Not valid for multiple user targets. Default is the current value.
- policy => string, optional
Name of the quota policy in which the quota rule should be modified. If this field is not provided, then the current policy that has been assigned to the vserver will be used.
- 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
[Family: vserver]
Turns the quota subsystem off for a volume. For clustered volumes, a jobid will also be returned. The progress of the job can be tracked using the job APIs.
Inputs
- volume => string
Name of the volume on which to turn quotas off.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
The job id of the job that was queued to turn off quotas.
- result-status => string, optional
The operation status. Possible values: "succeeded", "in-progress", "failed".
[Family: vserver]
Starts to turn quotas on for a volume. A successful return from this API does not mean that quotas are on, merely that an attempt to start it has been triggered. Use the quota-status API to check the status. For clustered volumes, a jobid will also be returned. The progress of the job can be tracked using the job APIs.
Inputs
- volume => string
Name of the volume on which to enable quotas.
Outputs
- result-error-code => integer, optional
error code, if the operation caused an error.
- result-error-message => string, optional
error description, if the operation caused an error.
- result-jobid => integer, optional
The job id of the job that was queued to turn on quotas.
- result-status => string, optional
The operation status. Possible values: "succeeded", "in-progress", "failed".
[Family: cluster, vserver]
Iterate over the quota report in the cluster.Inputs
- desired-attributes => quota, optional
Specify the attributes that should be returned in the quota report object. 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 response.
- path => string, optional
A path (including a /vol/ prefix). If specified, the report will contain only quotas that apply to the specified path name.
- query => quota, optional
A query that specifies which quota report needs to be returned. A query could be specified on any number of attributes in the quota report object. All quota report objects matching this query up to 'max-records' will be returned.
- tag => string, optional
Specify the tag from the previous iteration. It is usually not specified for the first iteration. For subsequent iterations, copy the value from the 'next-tag' obtained from the previous iteration.
Outputs
- next-tag => string, optional
Tag for the next iteration. Not present when there are no more quota report objects to return.
- num-records => integer
The number of records returned in this response.
[Family: vserver]
Starts an ONTAP operation to resize quotas for a volume. A successful return from this API does not mean that the operation has finished, merely that an attempt to start it been triggered. Use the quota-status API to check the status. For clustered volumes, a jobid will also be returned. The progress of the job can be tracked using the job APIs.
Inputs
- volume => string
Name of the volume on which to resize quotas.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
The job id of the job that was queued to resize quotas.
- result-status => string, optional
The operation status. Possible values: "succeeded", "in-progress", "failed".
[Family: vserver]
Sets a quota entry. If the type, target, volume, and tree do not exist, a new entry is created. If the type, target, volume, and tree exist, then the entry is modified.Inputs
- 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.
- perform-user-mapping => boolean, optional
If the value is true, quota management will perform user mapping for the user specified in quota-target. Only valid for user quotas when the quota-target refers to a Windows/UNIX user name. Not valid for multiple user targets. Default is false.
- policy => string, optional
Name of the quota policy in which the quota rule should be set. If this field is not provided, then the current policy that has been assigned to the vserver will be used.
- 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
[Family: vserver]
Obtains the status of quotasInputs
- 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"
[Family: cluster, vserver]
Iterate over quota status for all volumes in the clusterInputs
- max-records => integer, optional
The maximum number of records to return in this response.
- tag => string, optional
Specify the tag from the previous iteration. It is usually not specified for the first iteration. For subsequent iterations, copy the value from the 'next-tag' obtained from the previous iteration.
Outputs
- next-tag => string, optional
Tag for the next iteration. Not present when there are no more quota status objects to return.
- num-records => integer
The number of records returned in this response.
[Family: vserver]
Creates a new Security trace entry.Inputs
- path => string, optional
Path to match.
- return-record => boolean, optional
If set to true, returns the security-trace-filter on successful creation. Default: false
Outputs
[Family: vserver]
Deletes the specified Security trace entry.Inputs
- index => integer
internally created index for the filter.
Outputs
[Family: cluster, vserver]
Gives information about one or more Security trace entries.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 security-trace-filter objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modifies settings of a Security trace entry, even if it is in use.Inputs
- client-ip => ip-address, optional
The IP address of the client.
- enabled => enable, optional
This is used to enable or disable the filter.
- index => integer
internally created index for the filter.
- path => string, optional
Path to match.
- time-enabled => integer, optional
The admin can specify a timeout for this filter after which it would be disabled.
- trace-allow => boolean, optional
The deny events are traced by default. This option is to record trace results for allow events as well.
- unix-name => string, optional
Unix user name to trace.
- windows-name => string, optional
Windows User Name to trace.
Outputs
[Family: vserver]
Delete the specified security tracing event record.Inputs
- node => node-name
The cluster node on which the permission tracing event occured.
Outputs
[Family: cluster, vserver]
Retrieve the list of permission tracing results for the cluster.Inputs
- desired-attributes => security-trace-results-logs, 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
- 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 security-trace-result objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Create a new user account associated the specified application and authentication method.Inputs
- application => string
Name of the application. Possible values: 'console', 'http', 'ontapi', 'rsh', 'snmp', 'sp', 'ssh', 'telnet'.
- authentication-method => string
Authentication method for the application. Possible values: 'community', 'password', 'publickey', 'domain', 'nsswitch' and 'usm'. Not all authentication methods are valid for an application. Valid authentication methods for each application are: 'password' for 'console' application. 'password', 'domain', 'nsswitch', 'cert' for 'http' application. 'password', 'domain', 'nsswitch', 'cert' for 'ontapi' application. 'community' for 'snmp' application (when creating SNMPv1 and SNMPv2 users). 'usm' and 'community' for 'snmp' application (when creating SNMPv3 users). 'password' for 'sp' application. 'password' for 'rsh' application. 'password' for 'telnet' application. 'password', 'publickey', 'domain', 'nsswitch' for 'ssh' application.
- comment => string, optional
Comments for the user account. The length of comment should be less than or equal to 128 charaters.
- password => string, optional
Password for the user account. This is ignored for creating snmp users. This is required for creating non-snmp users.
- user-name => string
Name of the user. When creating a SNMPv1 or SNMPv2 user with 'snmp' application and 'community' authentication-method, the user name is the community string.
- vserver => string
Name of the Vserver.
Outputs
[Family: cluster]
Delete an existing user account object.Inputs
- application => string
Name of the application. Possible values: 'console', 'http', 'ontapi', 'rsh', 'snmp', 'sp', 'ssh', 'telnet'.
- authentication-method => string
Authentication method for the application. Possible values: 'community', 'password', 'publickey', 'domain', 'nsswitch' and 'usm'. Not all authentication methods are valid for an application. Valid authentication methods for each application are: 'password' for 'console' application. 'password', 'domain', 'nsswitch', 'cert' for 'http' application. 'password', 'domain', 'nsswitch', 'cert' for 'ontapi' application. 'community' for 'snmp' application (when creating SNMPv1 and SNMPv2 users). 'usm' and 'community' for 'snmp' application (when creating SNMPv3 users). 'password' for 'sp' application. 'password' for 'rsh' application. 'password' for 'telnet' application. 'password', 'publickey', 'domain', 'nsswitch' for 'ssh' application.
- user-name => string
Name of the user. When creating a SNMPv1 or SNMPv2 user with 'snmp' application and 'community' authentication-method, the user name is the community string.
- vserver => string
Name of the Vserver.
Outputs
[Family: cluster]
Delete an existing user account or a group of user account objects.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple security login account objects match a given query. If set to true, the API will continue deleting the next matching security login account even when the deletion of a previous security login account fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching security login account even when the deletion of a previous matching security login account fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of security login account objects to delete in this call. Default: 20
- return-failure-list => boolean, optional
If set to true, the API will return the list of security login account objects (just keys) that were not deleted due to some error. If set to false, the list of security login account objects not deleted will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of security login account objects (just keys) that were successfully deleted. If set to false, the list of security login account objects deleted will not be returned. Default: true
- 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 matching security login account objects to be deleted.
- num-failed => integer, optional
Number of security login account objects that matched the query, but were not deleted due to some error.
- num-succeeded => integer, optional
The number of security login account objects that matched the query and were successfully deleted.
[Family: cluster]
Get the attributes of a user account.Inputs
- application => string
Name of the application. Possible values: 'console', 'http', 'ontapi', 'rsh', 'snmp', 'sp', 'ssh', 'telnet'.
- authentication-method => string
Authentication method for the application. Possible values: 'community', 'password', 'publickey', 'domain', 'nsswitch' and 'usm'. Not all authentication methods are valid for an application. Valid authentication methods for each application are: 'password' for 'console' application. 'password', 'domain', 'nsswitch', 'cert' for 'http' application. 'password', 'domain', 'nsswitch', 'cert' for 'ontapi' application. 'community' for 'snmp' application (when creating SNMPv1 and SNMPv2 users). 'usm' and 'community' for 'snmp' application (when creating SNMPv3 users). 'password' for 'sp' application. 'password' for 'rsh' application. 'password' for 'telnet' application. 'password', 'publickey', 'domain', 'nsswitch' for 'ssh' application.
- user-name => string
Name of the user. When creating a SNMPv1 or SNMPv2 user with 'snmp' application and 'community' authentication-method, the user name is the community string.
- vserver => string
Name of the Vserver.
Outputs
[Family: cluster]
Iterate over a list of user account objects.Inputs
- desired-attributes => security-login-account-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 => security-login-account-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the security login account object. All security login account 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 security login account objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Lock a user account that uses password as the authentication method. Returns an error if the user account does not use password authentication.Inputs
- user-name => string
Name of the user account to be locked.
- vserver => string
Name of the Vserver.
Outputs
[Family: cluster]
Modify the attributes of a user account object. Omitted (optional) fields will not be changed.Inputs
- application => string
Name of the application. Possible values: 'console', 'http', 'ontapi', 'rsh', 'snmp', 'sp', 'ssh', 'telnet'.
- authentication-method => string
Authentication method for the application. Possible values: 'community', 'password', 'publickey', 'domain', 'nsswitch' and 'usm'. Not all authentication methods are valid for an application. Valid authentication methods for each application are: 'password' for 'console' application. 'password', 'domain', 'nsswitch', 'cert' for 'http' application. 'password', 'domain', 'nsswitch', 'cert' for 'ontapi' application. 'community' for 'snmp' application (when creating SNMPv1 and SNMPv2 users). 'usm' and 'community' for 'snmp' application (when creating SNMPv3 users). 'password' for 'sp' application. 'password' for 'rsh' application. 'password' for 'telnet' application. 'password', 'publickey', 'domain', 'nsswitch' for 'ssh' application.
- comment => string, optional
Comments for the user account. The length of comment should be less than or equal to 128 charaters.
- role-name => string
Name of the role.
- user-name => string
Name of the user. When creating a SNMPv1 or SNMPv2 user with 'snmp' application and 'community' authentication-method, the user name is the community string.
- vserver => string
Name of the Vserver.
Outputs
[Family: cluster]
Modify the attributes of a user account or a group of user account objects.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple security login account objects match a given query. If set to true, the API will continue modifying the next matching security login account even when modification of a previous security login account fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching security login account even when the modification of a previous matching security login account fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of objects to be modified in this call. Default: 20
- query => security-login-account-info
If modifying a specific security login account, this input element must specify all keys. If modifying security login account objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of security login account objects (just keys) that were not modified due to some error. If set to false, the list of security login account objects not modified will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of security login account objects (just keys) that were successfully updated. If set to false, the list of security login account objects modified will not be returned. Default: true
- 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 matching security login account objects to be modified.
- num-failed => integer, optional
Number of security login account objects that matched the query, but were not modified due to some error.
- num-succeeded => integer, optional
The number of security login account objects that matched the query and were successfully updated.
[Family: vserver]
Changes the password of a specified user.Inputs
- user-name => string, optional
The user whose password should be changed. This is mandatory when a user with admin role is modifying the password of another user.
Outputs
[Family: cluster]
Get the attributes of a role configuration.Inputs
- desired-attributes => security-login-role-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.
- role-name => string
Name of the role.
- vserver => string
Name of the Vserver.
Outputs
[Family: cluster]
Iterate over a list of role objects.Inputs
- desired-attributes => security-login-role-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
- 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 security login roleconfig objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modify the specified attributes of role configuration object. Omitted (optional) fields will not be changed.Inputs
- role-name => string
Name of the role.
- vserver => string
Name of the Vserver.
Outputs
[Family: cluster]
Modify the attributes of role configuration or a group of role configuration objects.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple security login roleconfig objects match a given query. If set to true, the API will continue modifying the next matching security login roleconfig even when modification of a previous security login roleconfig fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching security login roleconfig even when the modification of a previous matching security login roleconfig fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of objects to be modified in this call. Default: 20
- query => security-login-role-config-info
If modifying a specific security login roleconfig, this input element must specify all keys. If modifying security login roleconfig objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of security login roleconfig objects (just keys) that were not modified due to some error. If set to false, the list of security login roleconfig objects not modified will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of security login roleconfig objects (just keys) that were successfully updated. If set to false, the list of security login roleconfig objects modified will not be returned. Default: true
- 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 matching security login roleconfig objects to be modified.
- num-failed => integer, optional
Number of security login roleconfig objects that matched the query, but were not modified due to some error.
- num-succeeded => integer, optional
The number of security login roleconfig objects that matched the query and were successfully updated.
[Family: cluster]
Create a new user role.Inputs
- return-record => boolean, optional
If set to true, returns the security login role on successful creation. Default: false
- role-name => string
Name of the role.
- role-query => string, optional
A query for the role. The query must apply to the specified command or directory name. Example: The command is 'volume show' and the query is '-volume vol1'. The query is applied to the command resulting in populating only the volumes with name vol1.
- vserver => string
Name of the Vserver.
Outputs
[Family: cluster]
Delete an existing user role object.Inputs
- command-directory-name => string
The command or command directory to which the role has an access.
- role-name => string
Name of the role.
- vserver => string
Name of the Vserver.
Outputs
[Family: cluster]
Delete an existing user role or a group of user role objects.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple security login role objects match a given query. If set to true, the API will continue deleting the next matching security login role even when the deletion of a previous security login role fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching security login role even when the deletion of a previous matching security login role fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of security login role objects to delete in this call. Default: 20
- return-failure-list => boolean, optional
If set to true, the API will return the list of security login role objects (just keys) that were not deleted due to some error. If set to false, the list of security login role objects not deleted will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of security login role objects (just keys) that were successfully deleted. If set to false, the list of security login role objects deleted will not be returned. Default: true
- 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
- failure-list => security-login-role-delete-iter-info[], optional
Information about security login role objects that were not deleted due to some error. This element will be returned only if input element 'return-failure-list' is true.
- next-tag => string, optional
Tag for the next call. Not present when there are no more matching security login role objects to be deleted.
- num-failed => integer, optional
Number of security login role objects that matched the query, but were not deleted due to some error.
- num-succeeded => integer, optional
The number of security login role objects that matched the query and were successfully deleted.
- success-list => security-login-role-delete-iter-info[], optional
The security login role objects that were successfully deleted. This element will be returned only if input element 'return-success-list' is true
[Family: cluster]
Get the attributes of a user role.Inputs
- command-directory-name => string
The command or command directory to which the role has an access.
- desired-attributes => security-login-role-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.
- role-name => string
Name of the role.
- vserver => string
Name of the Vserver.
Outputs
[Family: cluster]
Iterate over a list of user role objects.Inputs
- desired-attributes => security-login-role-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
- 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 security login role objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modify the attributes of user role object. Omitted (optional) fields will not be changed.Inputs
- access-level => string, optional
Access level for the role. Possible values: 'none', 'readonly', 'all'. The default value is 'all'.
- command-directory-name => string
The command or command directory to which the role has an access.
- role-name => string
Name of the role.
- role-query => string, optional
A query for the role. The query must apply to the specified command or directory name. Example: The command is 'volume show' and the query is '-volume vol1'. The query is applied to the command resulting in populating only the volumes with name vol1.
- vserver => string
Name of the Vserver.
Outputs
[Family: cluster]
Modify the attributes of user role or a group of user role objects.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple security login role objects match a given query. If set to true, the API will continue modifying the next matching security login role even when modification of a previous security login role fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching security login role even when the modification of a previous matching security login role fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of objects to be modified in this call. Default: 20
- query => security-login-role-info
If modifying a specific security login role, this input element must specify all keys. If modifying security login role objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of security login role objects (just keys) that were not modified due to some error. If set to false, the list of security login role objects not modified will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of security login role objects (just keys) that were successfully updated. If set to false, the list of security login role objects modified will not be returned. Default: true
- 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
- failure-list => security-login-role-modify-iter-info[], optional
Information about security login role objects that were not modified due to some error. This element will be returned only if input element 'return-failure-list' is true.
- next-tag => string, optional
Tag for the next call. Not present when there are no more matching security login role objects to be modified.
- num-failed => integer, optional
Number of security login role objects that matched the query, but were not modified due to some error.
- num-succeeded => integer, optional
The number of security login role objects that matched the query and were successfully updated.
- success-list => security-login-role-modify-iter-info[], optional
The security login role objects that were successfully updated. This element will be returned only if input element 'return-success-list' is true
[Family: cluster]
Unlock a user account that uses password as the authentication method. Returns an error if the user account does not use password authentication.Inputs
- user-name => string
Name of the user account to be unlocked.
- vserver => string
Name of the Vserver.
Outputs
[Family: vserver]
Get the attributes of the security-certificate-ca-issued.Inputs
- serial-number => string
Serial number of certificate.
Outputs
[Family: cluster, vserver]
Iterate over a list of security-certificate-ca-issued objects.Inputs
- desired-attributes => certificate-ca-issued-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
- 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 security-certificate-ca-issued objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster, vserver]
If a certificate is created with the existing Common Name then a new certificate is generated with a different serial numberInputs
- common-name => string
Represents the domain name in FQDN form that specifies its exact location in the tree hierarchy of the Domain Name System (DNS).
- size => string, optional
Size of requested certificate in bits. Default value is '2048'. Possible values:
- '512' - 512 bits private key,
- '1024' - 1024 bits private key,
- '1536' - 1536 bits private key,
- '2048' - 2048 bits private key
- state => string, optional
Name of the state. Default value is empty string.
- type => string
Type of certificate. Possible values:
- 'server' - Server certificate,
- 'root_ca' - Self-Signed Root CA,
- 'client_ca' - CA who signed user certificates',
- 'server_chain' - Intermediate certificate for server authentication
Outputs
[Family: cluster, vserver]
Delete an existing security-certificate object.Inputs
- certificate-authority => string
Certificate Authority
- common-name => string
Represents the domain name in FQDN form that specifies its exact location in the tree hierarchy of the Domain Name System (DNS).
- type => string
Type of certificate. Possible values:
- 'server' - Server certificate,
- 'root_ca' - Self-Signed Root CA,
- 'client_ca' - CA who signed user certificates',
- 'server_chain' - Intermediate certificate for server authentication
- vserver => string, optional
Name of vserver.
Outputs
[Family: cluster, vserver]
Delete an existing security-certificate or a group of security-certificate objects.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple security-certificate objects match a given query. If set to true, the API will continue deleting the next matching security-certificate even when the deletion of a previous security-certificate fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching security-certificate even when the deletion of a previous matching security-certificate fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of security-certificate objects to delete in this call. Default: 20
- query => certificate-info
If deleting a specific security-certificate, this input element must specify all keys. If deleting multiple security-certificate objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of security-certificate objects (just keys) that were not deleted due to some error. If set to false, the list of security-certificate objects not deleted will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of security-certificate objects (just keys) that were successfully deleted. If set to false, the list of security-certificate objects deleted will not be returned. Default: true
- 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 matching security-certificate objects to be deleted.
- num-failed => integer, optional
Number of security-certificate objects that matched the query, but were not deleted due to some error.
- num-succeeded => integer, optional
The number of security-certificate objects that matched the query and were successfully deleted.
[Family: cluster]
Iterate over a list of security-certificate-file objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 security-certificate-file objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster, vserver]
Generate a digital certificate signing request(CSR)Inputs
- common-name => string
Represents the domain name in FQDN form that specifies its exact location in the tree hierarchy of the Domain Name System (DNS).
- country => string, optional
Name of the country.
- email-address => string, optional
Email address of administrator.
- hash-function => string, optional
Hashing function used to sign the certificate. Default value is 'sha256'. Possible values:
- 'sha1' ,
- 'sha256' ,
- 'md5'
- locality => string, optional
Name of the locality.
- organization => string, optional
Name of the organization.
- organization-unit => string, optional
Name of the unit. Example: IT, Finance.
- size => string, optional
Size of requested certificate in bits. Default value is '2048'. Possible values:
- '512' - 512 bits private key,
- '1024' - 1024 bits private key,
- '1536' - 1536 bits private key,
- '2048' - 2048 bits private key
- state => string, optional
Name of the state.
Outputs
[Family: vserver]
Get the attributes of the security-certificate.Inputs
- certificate-authority => string
Certificate Authority
- common-name => string
Represents the domain name in FQDN form that specifies its exact location in the tree hierarchy of the Domain Name System (DNS).
- serial-number => string, optional
Serial number of certificate.
- type => string
Type of certificate. Possible values:
- 'server' - Server certificate,
- 'root_ca' - Self-Signed Root CA,
- 'client_ca' - CA who signed user certificates',
- 'server_chain' - Intermediate certificate for server authentication
Outputs
[Family: cluster, vserver]
Iterate over a list of security-certificate objects.Inputs
- desired-attributes => certificate-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 => certificate-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the security-certificate object. All security-certificate 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 security-certificate objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster, vserver]
Install a digital certificateInputs
- type => string
Type of certificate. Possible values:
- 'server' - Server certificate,
- 'root_ca' - Self-Signed Root CA,
- 'client_ca' - CA who signed user certificates',
- 'server_chain' - Intermediate certificate for server authentication
- vserver => string, optional
Name of vserver.
Outputs
[Family: cluster, vserver]
Revoke a digital certificateInputs
- ca-serial-number => string
Serial number of CA certificate.
- certificate-authority => string
Certificate Authority
- common-name => string, optional
Represents the domain name in FQDN form that specifies its exact location in the tree hierarchy of the Domain Name System (DNS).
- serial-number => string
Serial number of certificate.
- vserver => string, optional
Name of vserver.
Outputs
[Family: cluster, vserver]
Sign a certificate using self-signed root CAInputs
- ca-serial-number => string
Serial number of CA certificate.
- certificate-authority => string
Certificate Authority to Sign
- csr => string
Certificate signing request.
- expire-days => integer, optional
Number of days until expiration. Default value is '365'.
- hash-function => string, optional
Hashing function used to sign the certificate. Default value is 'sha256'. Possible values:
- 'sha1' ,
- 'sha256' ,
- 'md5'
- password => string, optional
Destination URI password
- private-key => string, optional
Private Key
- vserver => string, optional
Name of vserver.
Outputs
[Family: vserver]
Get the attributes of SSL securityInputs
Outputs
[Family: cluster, vserver]
Get the attributes of SSL securityInputs
- desired-attributes => vserver-ssl-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
- 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 SSL security objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster, vserver]
Modify SSL authentication for a Vserver. Only field(s) that are provided will be modified.Inputs
- certificate-serial-number => string, optional
Serial number of certificate in hexadecimal format. This field is required when you specify server-enabled as true, if you do not specify one it will use the serial number of the default certificate.
- common-name => string, optional
Represents the domain name in FQDN form that specifies its exact location in the tree hierarchy of the Domain Name System (DNS). This field is optional when you specify server-enabled as true.
- vserver => string, optional
Name of vserver.
Outputs
[Family: cluster]
Get basic information about the deviceInputs
- node => node-name
Node on which the device is located
Outputs
[Family: cluster]
Get information about installed firmware imagesInputs
- desired-attributes => service-processor-image, 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.
- firmware-image => sp-fw-type
Is this image primary or backup firmware for the device Possible values: - "primary" - Firmware which the device boots into by default,
- "backup" - Firmware which the device boots into if primary fails
- node => node-name
Node on which the device is located
Outputs
[Family: cluster]
Enable or disable automatic firmware updateInputs
- node => node-name
Node on which the device is located
Outputs
[Family: cluster]
Install new firmware imageInputs
- node => node-name
Node on which the device is located
Outputs
[Family: cluster]
Get firmware update progressInputs
- desired-attributes => service-processor-image-update-progress-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.
- node => node-name
Node on which the device is located
Outputs
[Family: cluster]
Get the network configurationInputs
- address-type => sp-ip-address-type
Network configuration that is being addressed i.e. IPv4 or IPv6 Possible values: - "ipv4" - Internet Protocol version 4,
- "ipv6" - Internet Protocol version 6
- desired-attributes => service-processor-network-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.
- node => node-name
Node on which the device is located
Outputs
[Family: cluster]
Modify the network configurationInputs
- address-type => sp-ip-address-type
Network configuration that is being addressed i.e. IPv4 or IPv6 Possible values: - "ipv4" - Internet Protocol version 4,
- "ipv6" - Internet Protocol version 6
- is-enabled => boolean, optional
Is this address configuration enabled
- netmask => ip-address, optional
Netmask for the device
- node => node-name
Node on which the device is located
Outputs
[Family: cluster]
Reboot the Service ProcessorInputs
- node => node-name
Node on which the device is located
Outputs
[Family: cluster]
Returns information about storage shelf bays and ports for a selected number of shelves, or optionally all shelves connected to the storage controller.Inputs
- 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
- node-name => string, optional
This field is only valid when the request is sent to the Admin Vserver LIF. If node-name is not specified when the request is sent to Admin VserverLIF, then all matching shelves in the cluster will be returned. This is the storage system name the command will be executed on.
- 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
[Family: cluster]
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.
- node-name => string
This field is only valid when the request is sent to the Admin Vserver LIF. This is the storage system name the command will be executed on.
- 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
[Family: cluster]
This returns information about an identified shelf. The information is the number of bays present (bay-count), and which shelf bays have drives (bay-list). Shelf bays are numbered from 0 to bay-count minus 1. Shelf bay 0 is always on the right when looking at the front of the shelf. Incidentally, the bay-list may be empty indicating the absence of any drives. However, there are some shelf designs which require a disk drive in bay 0 or 1 for any SES functionality to operate (e.g., DS14 and DS14-Mk2-FC). In these cases, shelves without drives in bay 0 or 1 will not be listed.Inputs
- channel-name => string
The adapter number or switch name and theport number (together, called the channel). Examples are 8a and switch:5
- node-name => string
This field is only valid when the request is sent to the Admin Vserver LIF. This is the storage system name name the command will be executed on.
- 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.
- node-name => string, optional
This field is only valid when the request is sent to the Admin Vserver LIF, in which case it is the storage system name.
[Family: cluster]
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
- node-name => string
This field is only valid when the request is sent to the Admin Vserver LIF. This is the storage system name the command will be executed on.
- 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.
[Family: vserver]
Disable sis on a volume. If the sis operation is active on the volume, it needs to be stopped by "sis-stop" API before disabling. This API is not supported for Infinite Volumes.
Inputs
- path => string
The full path of the sis volume, /vol/<vol_name>. Only one path can be specified at a time.
Outputs
[Family: vserver]
Disable sis on an Infinite Volume. If the sis operation is active on the Infinite Volume, it needs to be stopped by "sis-stop-async" API before disabling. This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents or Infinite Volumes that are managed by storage services.
Inputs
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: - "succeeded",
- "in_progress",
- "failed"
[Family: vserver]
Enable sis on a volume. On a non-SnapVault secondary volume, the sis operation will be started periodically according to a per-volume schedule. By default, this schedule is sun-sat@0. (Everyday at 0:00 hours) On a SnapVault secondary volume, the sis operation will be kicked off at the end of the SnapVault transfer. This API does not enable compression on the volume. See the "sis-set-config" API for options to enable compression and for modifying the default schedule set on the volume. A sis operation can also be manually started using the sis-start API.
This API is not supported for Infinite Volumes.
Inputs
- 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
[Family: vserver]
Enable sis on an Infinite Volume. This is similar to 'sis-enable' API except that it operates on an Infinite Volume. Read about 'sis-enable' API for specific details.
This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents or Infinite Volumes that are managed by storage services.
Inputs
- volume-name => string
Name of the Infinite Volume. The Infinite Volume must be online to enable sis.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: - "succeeded",
- "in_progress",
- "failed"
[Family: vserver]
Get status of a sis volume. This API is not supported on Infinite Volumes that are managed by storage services.
Inputs
- path => volume-path
Volume for which sis information is returned. Path is of the format /vol/<vol_name>.
Outputs
[Family: cluster, vserver]
Iterate over a list of sis volumes. This API is not supported on Infinite Volumes that are managed by storage services.
Inputs
- desired-attributes => sis-status-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.
- 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 sis objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Create a new sis policy.Inputs
- comment => string, optional
A brief description of the policy.
- duration => string, optional
The duration in hours for which the scheduled sis operation should run. After this time expires, the sis operation will be stopped even if the operation is incomplete. If '-' is specified as the duration, the sis operation will run till it completes. Otherwise, the duration has to be an integer greater than 0. By default, the operation runs till it completes.
- enabled => boolean, optional
If the value is true, the sis policy is active in this cluster. If the value is false this policy will not be activated by the schedulers and hence will be inactive. A policy can be assigned to managed objects although it is disabled. Default value: "true"
- policy-name => string
sis policy name.
- qos-policy => string, optional
QoS policy for the sis operation. Possible values: - "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"
- schedule => string, optional
Cron type job schedule name. When the associated policy is set on a volume, the sis operation will be triggered for the volume on this schedule. These schedules can be created using the job-schedule-cron-create API. Existing schedules can be queried using the job-schedule-cron-get-iter API.
Outputs
[Family: vserver]
Delete a sis policy.Inputs
- policy-name => string
sis policy name.
Outputs
[Family: vserver]
Get attributes of a sis policy.Inputs
- policy-name => string
sis policy name.
Outputs
[Family: cluster, vserver]
Iterate over a list of sis policy objects.Inputs
- desired-attributes => sis-policy-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.
- 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 sis policy objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify the attributes of a sis policy.Inputs
- comment => string, optional
A brief description of the policy. If a value is not provided the current settings are retained. An empty string can be used to clear the current settings.
- duration => string, optional
The duration in hours for which the scheduled sis operation should run. After this time expires, the sis operation will be stopped even if the operation is incomplete. If '-' is specified as the duration, the sis operation will run till it completes. If duration is not provided the current setting is not modified.
- enabled => boolean, optional
If the value is true, the sis policy is active in this cluster. If the value is false this policy will not be activated by the schedulers and hence will be inactive. A policy can be assigned to managed objects although it is disabled. If the value is not specified, the current settings are retained.
- policy-name => string
sis policy name. Attributes: key, non-modifiable
- qos-policy => string, optional
QoS policy for the sis operation. Possible values: - "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"
- schedule => string, optional
Cron type job schedule name. When the associated policy is set on a volume, the sis operation will be triggered for the volume on this schedule. If this field is not set, the existing value is not modified.
Outputs
[Family: vserver]
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>.
- policy-name => string, optional
The sis policy name to be attached to the volume. The policy name will determine which M-Host sis policy will trigger the scheduled sis operations. In Data ONTAP Cluster-Mode, policy-name and schedule must not be specified together in the same API call. If policy-name is passed, any previous schedule set on the volume is automatically reset.
- 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
[Family: vserver]
Setup or modify sis policy, schedule or options for an Infinite Volume. This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents or Infinite Volumes that are managed by storage services.
Inputs
- enable-compression => boolean, optional
Enable compression on the sis Infinite Volume. If true, compression will be enabled on the sis Infinite Volume. If false, compression will be disabled on the Infinite Volume. If the value is not specified compression state will be unchanged.
- 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 Infinite 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 Infinite Volume. If false, inline-compression will be disabled on the Infinite Volume. If the value is not specified, inline-compression state will be unchanged.
- policy-name => string, optional
The sis policy name to be attached to the Infinite Volume. The policy name will determine which M-Host sis policy will trigger the scheduled sis operations. The policy-name and schedule must not be specified together in the same API call. If policy-name is passed, any previous schedule set on the Infinite Volume is automatically reset.
- 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 Infinite Volume is automatically reset.
The "auto" schedule string means the sis operation will be triggered by the amount of new data written to the Infinite Volume. The criterion is subject to being changed later.
If "manual" is specified, sis operation will never be triggered automatically. Only the user can manually execute the sis operation.
- volume-name => string
Name of the Infinite Volume.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: - "succeeded",
- "in_progress",
- "failed"
[Family: vserver]
Start a sis operation on a volume. The volume must have sis enabled, before starting a sis operation. If the sis operation is already active on the volume, this API will fail. This API is not supported for Infinite Volumes.
Inputs
- 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
[Family: vserver]
Start a sis operation on an Infinite Volume. The Infinite Volume must have sis enabled, before starting a sis operation. If the sis operation is already active on the Infinite Volume, this API will fail. This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents or Infinite Volumes that are managed by storage services.
Inputs
- 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"
- delete-checkpoint => boolean, optional
If this is "true", the sis operation will delete existing checkpoint and start the sis operation from the beginning. Default value: "false"
- qos-policy => string, optional
QoS policy for the sis operation. Possible values: - "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 Infinite 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 Infinite Volume. For example: If compression is not enabled on the Infinite Volume, the scan will not include compression. This default behavior can be changed by using the run-dedupe-scan and run-compression-scan parameters.
If scan is false only data added since the last sis operation will be processed. Default value: "false"
- 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"
- volume-name => string
The name of the Infinite Volume. The Infinite Volume must be online in order to start the sis operation.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: - "succeeded",
- "in_progress",
- "failed"
[Family: cluster, vserver]
Get Status of a sis volume This API is not optimal for use in Data ONTAP Cluster-Mode systems, and is deprecated. Use sis-get and sis-get-iter APIs for Data ONTAP Cluster Mode systems. This API is still supported for Data ONTAP 7-Mode systems.Inputs
- 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
[Family: vserver]
Abort currently active sis operation on the volume. The sis operation will remain paused and the operation can be resumed by "sis-start", SnapVault transfer, or the scheduler. This API is not supported for Infinite Volumes.
Inputs
- path => string
The full path of the sis volume, /vol/<vol_name>.
Outputs
[Family: vserver]
Abort currently active sis operation on the Infinite Volume. The sis operation will remain paused and the operation can be resumed by "sis-start-async" or the scheduler. This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents or Infinite Volumes that are managed by storage services.
Inputs
- all-operations => boolean, optional
If this is "true", both active and queued sis operation will be stopped. Default value: "false"
- volume-name => string
The name of the Infinite Volume.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: - "succeeded",
- "in_progress",
- "failed"
[Family: cluster, vserver]
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-cluster => string, optional
Specifies the destination cluster of the SnapMirror relationship. The destination Vserver and destination volume must also be specified if using this parameter.
- 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-volume => string, optional
Specifies the destination volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the destination Vserver.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-vserver => string, optional
Specifies the destination Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the destination volume.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-cluster => string, optional
Specifies the source cluster of the SnapMirror relationship. The source Vserver and source volume must also be specified if using this parameter.
- 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.
- source-volume => string, optional
Specifies the source volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the source Vserver.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-vserver => string, optional
Specifies the source Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the source volume.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
Outputs
[Family: cluster, vserver]
The snapmirror-abort-async API stops ongoing transfer for a SnapMirror relationship on Infinite Volume. The relationship is identified by its destination endpoint. You must specify the destination endpoint when using the snapmirror-abort-async API. After the snapmirror-abort-async API successfully aborted the transfer, the volume on the receiving side of the transfer might contain a restart checkpoint. The restart checkpoint can be used by a subsequent transfer to restart and continue the aborted SnapMirror transfer. Snapmirror-abort-async API must be used from the destination cluster on Data ONTAP Cluster-Mode. This API is not supported if the destination end point is a flexible volume or an Infinite Volume constituent. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
- check-only => boolean, optional
If this option is specified true, only snapmirror-check operations active on the relationship will be aborted.
- clear-checkpoint => boolean, optional
If this option is specified true, the restart checkpoint is discarded and the destination volume is restored to the last Snapshot copy that was successfully transferred. You can use the clear-checkpoint option to discard the restart checkpoint of a previous transfer attempt which forces the subsequent transfer to start with a fresh Snapshot copy on the destination volume.
- destination-cluster => string, optional
Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-location => string, optional
Specifies the destination endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
- destination-volume => string, optional
Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the destination Vserver.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-vserver => string, optional
Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of destination volume.
- The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-cluster => string, optional
Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-location => string, optional
Specifies the source endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
- source-volume => string, optional
Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the source Vserver.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-vserver => string, optional
Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of source volume.
- The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
[Family: cluster, vserver]
The snapmirror-abort-iter API aborts SnapMirror transfers for one or more SnapMirror relationships. This API is not supported on Infinite Volume constituents.Inputs
- check-only => boolean, optional
If this option is specified true, only snapmirror-check operations active on the relationship will be aborted.
- clear-checkpoint => boolean, optional
If this option is specified true, the restart checkpoint is discarded and the destination volume is restored to the last Snapshot copy that was successfully transferred. You can use the clear-checkpoint option to discard the restart checkpoint of a previous transfer attempt which forces the subsequent transfer to start with a fresh Snapshot copy on the destination volume.
- continue-on-failure => boolean, optional
This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of snapmirror objects to be operated in this call. Default: 20
- query => snapmirror-info
If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
- 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 matching snapmirror objects to be operated on.
- num-failed => integer, optional
The number of snapmirror objects that matched the query, but were not operated on due some error.
- num-succeeded => integer, optional
The number of snapmirror objects that matched the query and were successfully processed.
[Family: cluster, vserver]
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-cluster => string, optional
Specifies the destination cluster of the SnapMirror relationship. The destination Vserver and destination volume must also be specified if using this parameter.
- 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
- destination-volume => string, optional
Specifies the destination volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the destination Vserver.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-vserver => string, optional
Specifies the destination Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the destination volume.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-cluster => string, optional
Specifies the source cluster of the SnapMirror relationship. The source Vserver and source volume must also be specified if using this parameter.
- source-location => string, optional
Specifies 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.
- source-volume => string, optional
Specifies the source volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the source Vserver.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-vserver => string, optional
Specifies the source Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the source volume.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
Outputs
[Family: cluster, vserver]
The snapmirror-break-async API breaks an Infinite Volume SnapMirror relationship between a source and destination volume of a data protection mirror. When Data ONTAP breaks the relationship, the destination volume is made a read-write volume and can diverge from the source volume, client redirection is turned off on the destination volume, the restart checkpoint is cleared, and the clients can see the latest Snapshot copy. You must specify the destination endpoint when using snapmirror-break-async. Subsequent manual or scheduled SnapMirror updates to the broken relationship will fail until the SnapMirror relationship is reestablished using the snapmirror-resync API. This API applies only to data protection mirrors for Infinite Volume. You must use the snapmirror-break-async API from the destination cluster. This API is not supported on Infinite Volume constituents. This API is not supported if the destination end point is a flexible volume. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
- destination-cluster => string, optional
Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-location => string, optional
Specifies the destination endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
- destination-volume => string, optional
Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the destination Vserver.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-vserver => string, optional
Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of destination volume.
- The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-cluster => string, optional
Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-location => string, optional
Specifies the source endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
- source-volume => string, optional
Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the source Vserver.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-vserver => string, optional
Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of source volume.
- The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
[Family: cluster, vserver]
The snapmirror-break-iter API breaks one or more SnapMirror relationships.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of snapmirror objects to be operated in this call. Default: 20
- query => snapmirror-info
If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
- 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 matching snapmirror objects to be operated on.
- num-failed => integer, optional
The number of snapmirror objects that matched the query, but were not operated on due some error.
- num-succeeded => integer, optional
The number of snapmirror objects that matched the query and were successfully processed.
[Family: cluster, vserver]
The snapmirror-check API starts an operation to compare the contents of a snapshot between the source volume and destination volume. You must specify the destination endpoint when using snapmirror-check. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
- destination-cluster => string, optional
Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-location => string, optional
Specifies the destination endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
- destination-volume => string, optional
Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the destination Vserver.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-vserver => string, optional
Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of destination volume.
- The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-cluster => string, optional
Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-location => string, optional
Specifies the source endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
- source-volume => string, optional
Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the source Vserver.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-vserver => string, optional
Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of source volume.
- The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
[Family: cluster, vserver]
The snapmirror-check-iter API checks one or more SnapMirror relationships. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of snapmirror objects to be operated in this call. Default: 20
- query => snapmirror-info
If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on or scheduled to be worked on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
- 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.
- target-snapshot => string, optional
Specifies the Snapshot copy on the destination endpoint to check.
Outputs
- next-tag => string, optional
Tag for the next call. Not present when there are no more matching snapmirror objects to be operated on.
- num-failed => integer, optional
The number of snapmirror objects that matched the query, but were not operated on due some error.
- num-succeeded => integer, optional
The number of snapmirror objects that matched the query and were successfully processed or scheduled to be processed.
[Family: cluster, vserver]
The snapmirror-create API creates a SnapMirror relationship between a source and destination volumes. The following types of relationships can be created: - 'data_protection' - For Disater Recovery (DR);
- 'load_sharing' - For load-sharing within the same Vserver;
- 'vault' - For Vault;
- 'transition_data_protection' - For 7-mode to Cluster-Mode transition;
- 'restore' - For restoring a data protection (DP) volume data;
On Data ONTAP 8.1 operating in Cluster-Mode, only 'data_protection' and 'load_sharing' type are supported. Relationships of type 'restore' are created temporary during a restore operation initiated using the snapmirror-restore API or the corresponding command. The source and destination endpoints must be specified when using the snapmirror-create API. This API will fail if the destination volume does not exist. On Data ONTAP 8.2 operating in Cluster-Mode, the API does not validate the attributes and the existence of the source volume. It will succeed even if the source volume does not exist. The validation will be done at the first transfer time. On Data ONTAP 8.1 operating in Cluster-Mode, the API will fail if the source volume is not in online state and read-write (RW) type, or the destination volume is not in online state and a DP (Data Protection) type. Note: The source volume might contain data and Snapshot copies prior to creating the Snapmirror relationship. If the destination volume is not empty, it must have a Snapshot copy in common with the source volume, that is, it must have once been a copy of the source volume. On Data ONTAP 8.1 operating in Cluster-Mode, the API will fail if there is no common Snapshot copy. On Data ONTAP 8.2 operating in Cluster-Mode the API will succeed, but all subsequent transfers will fail if there is no common snapshot copy. Load-sharing mirrors have the following restrictions: - They only use FlexVol volumes. - They are confined to a single Vserver; they are not allowed to span Vservers. A set of load-sharing mirrors can have one or more destination volumes. You create separate SnapMirror relationships between the common source volume and each destination volume to create the set of load-sharing mirrors. If the destination volume is empty, it must be initialized using the snapmirror-initialize API. Destination volumes in a set of load-sharing mirrors must be initialized using the snapmirror-initialize-ls-set API. The snapmirror-create API must be issued on the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, and on the destination Vserver on Data ONTAP 8.2 operating in Cluster-Mode.Inputs
- destination-cluster => string, optional
Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-location => string, optional
Specifies the destination endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
- destination-volume => string, optional
Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the destination Vserver.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-vserver => string, optional
Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of destination volume.
- The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- max-transfer-rate => integer, optional
Specifies the upper bound, in kilobytes per second, at which data is transferred between clusters. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. The max-transfer-rate option does not affect load-sharing mirrors and other SnapMirror relationships confined to a single cluster.
- policy => string, optional
Specifies the name of the snapmirror policy for the relationship. For SnapMirror relationships of type 'vault', the policy will also have rules to select snapshot copies that must be transferred. If no policy is specified, a default policy will be applied depending on the type of the SnapMirror relationship. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'.
- relationship-type => string, optional
Specifies the type of the SnapMirror relationship. Possible values: - "data_protection" ,
- "load_sharing" ,
- "vault" ,
- "restore" ,
- "transition_data_protection"
- return-record => boolean, optional
If set to true, returns the snapmirror on successful creation. Default: false
- schedule => string, optional
Specifies the name of the cron schedule, which is used to update the SnapMirror relationship.
- source-cluster => string, optional
Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-location => string, optional
Specifies the source endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
- source-volume => string, optional
Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the source Vserver.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-vserver => string, optional
Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of source volume.
- The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- tries => string, optional
Specifies the maximum number of times to attempt each manual or scheduled transfer for a SnapMirror relationship. The default is eight times. Note: You can set the tries option to zero (0) to disable manual and scheduled updates for the SnapMirror relationship. This parameter is only relevant on Data ONTAP 8.1 operating in Cluster-Mode. On Data ONTAP 8.2 operating in Cluster-Mode, the maximum number of times to attempt a transfer is an attribute of the SnapMirror policy. Therefore the value of this parameter is ignored.
- vserver => string, optional
If this optional parameter is specified, designates the managing Vserver. The managing Vserver is authorized to use snapmirror commands to manage the SnapMirror relationship. The vserver option is currently a reserved option and should not be used for queries. The destination-vserver parameter should be used to select the Vserver in a cluster context.
Outputs
[Family: cluster, vserver]
The snapmirror-destroy API removes only the SnapMirror relationship of a source volume and a destination volume, the volumes are not destroyed and Snapshot copies on the volumes are not removed. You must specify the destination endpoint when using snapmirror-destroy. On Data ONTAP 8.1 operating in Cluster-Mode, the snapmirror-destroy API fails if a SnapMirror transfer for the SnapMirror relationship is in progress. On Data ONTAP 8.2 operating in Cluster-Mode, the snapmirror-destroy API will attempt to abort any ongoing transfer. However, failure to abort the transfer will not cause the API to fail. A set of load-sharing mirrors might contain multiple destination volumes, each destination volume having a separate SnapMirror relationship with the common source volume. When used on one of the SnapMirror relationships from the set of load-sharing mirrors, the snapmirror-destroy API deletes the specified SnapMirror relationship from the set of load-sharing mirrors. The snapmirror-destroy API preserves the read-write or read-only attributes of the volumes of a SnapMirror relationship after the relationship is deleted. Therefore, a read-write volume that was the source of a SnapMirror relationship retains its read-write attributes, and a data protection volume or a load-sharing volume that was a destination of a SnapMirror relationship retains its read-only attributes. Note: When a SnapMirror relationship from a set of load-sharing mirrors is deleted, the destination volume becomes a data protection volume and retains the read-only attributes of a data protection volume. On Data ONTAP 8.2 operating in Cluster-Mode, this API can only be issued on the destination Vserver. The SnapMirror relationship information is deleted from destination Vserver, but no cleanup or deletion is performed on the source Vserver. The snapmirror-release API must be issued on the source Vserver to delete the relationship information on the source Vserver. On Data ONTAP 8.1 operating in Cluster-Mode, this API can be issued on the source or on the destination cluster. When issued on the destination cluster, the SnapMirror relationship information on the source and destination clusters is deleted. When issued on the source cluster, only the SnapMirror relationship information on the source cluster is deleted. Note: If the SnapMirror relationship identified by the destination endpoint does not exist, this API will return success. This API is not supported if the destination end point is a Infinite Volume.Inputs
- destination-cluster => string, optional
Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-location => string, optional
Specifies the destination endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
- destination-volume => string, optional
Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the destination Vserver.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-vserver => string, optional
Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of destination volume.
- The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-cluster => string, optional
Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-location => string, optional
Specifies the source endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
- source-volume => string, optional
Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the source Vserver.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-vserver => string, optional
Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of source volume.
- The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
Outputs
[Family: cluster, vserver]
The snapmirror-destroy-async API removes only the SnapMirror relationship of a source and a destination Infinite Volume, the volumes are not destroyed and Snapshot copies on the volumes are not removed. You must specify the destination endpoint when using snapmirror-destroy-async. The snapmirror-destroy-async API fails if a SnapMirror transfer for the SnapMirror relationship is in progress. The snapmirror-destroy-async API preserves the read-write or read-only attributes of the volumes of a SnapMirror relationship after the relationship is deleted. Therefore, a read-write volume that was the source of a SnapMirror relationship retains its read-write attributes, and a data protection volume that was a destination of a SnapMirror relationship retains its read-only attributes. The snapmirror-destroy-async API should be used from the destination cluster. When used in this fashion, the destination-side information will be cleaned up. The destination will also attempt to cleanup source-side information. If the source cluster is not available, the destination-side information will still be cleaned up. This API is not supported if the destination end point is a flexible volume or an Infinite Volume constituent. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
- destination-cluster => string, optional
Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-location => string, optional
Specifies the destination endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
- destination-volume => string, optional
Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the destination Vserver.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-vserver => string, optional
Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of destination volume.
- The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-cluster => string, optional
Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-location => string, optional
Specifies the source endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
- source-volume => string, optional
Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the source Vserver.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-vserver => string, optional
Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of source volume.
- The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
[Family: cluster, vserver]
Removes one or several SnapMirror relationships. This API is not supported on Infinite Volume constituents.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of snapmirror objects to be operated in this call. Default: 20
- query => snapmirror-info
If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
- 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 matching snapmirror objects to be operated on.
- num-failed => integer, optional
The number of snapmirror objects that matched the query, but were not operated on due some error.
- num-succeeded => integer, optional
The number of snapmirror objects that matched the query and were successfully processed.
[Family: cluster, vserver]
The snapmirror-get API returns information for a SnapMirror relationship. On Data ONTAP 8.1 operating in Cluster-Mode this API can be issued on the source cluster or destination cluster of the relatonship. On Data ONTAP 8.2 operating in Cluster-Mode, this API must be issued on the destination Vserver or the destination cluster of the relationship. The destination endpoint must be specified when using the snapmirror-get API.
Inputs
- destination-cluster => string, optional
Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-location => string, optional
Specifies the destination endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
- destination-volume => string, optional
Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the destination Vserver.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-vserver => string, optional
Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of destination volume.
- The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-cluster => string, optional
Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-location => string, optional
Specifies the source endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
- source-volume => string, optional
Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the source Vserver.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-vserver => string, optional
Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of source volume.
- The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
Outputs
[Family: cluster, vserver]
The snapmirror-get-destination API returns information about a SnapMirror relationship whose source endpoint is on the cluster or Vserver it is issued on. The destination endpoint must be specified when using this API. The source endpoint can also be specified. The cluster or Vserver may have several entries for the specified endpoints, but with different relationship IDs. In this case the API returns information about the first entry. To get information about all the SnapMirror relationships matching the specified endpoints, the snapmirror-get-destination-iter API must be used.
Note that the information for a SnapMirror relationship will not be available on its source Vserver or source cluster until at least one transfer is initiated.
The information returned can be stale. Stale information corresponds to a SnapMirror relationship that has been deleted on its destination cluster or Vserver.
This API is only supported on Data ONTAP 8.2 and above operating in Cluster-Mode.
This API must be issued on the source Vserver or the source cluster of the relationship.
Inputs
- destination-location => string, optional
Specifies the destination endpoint of the SnapMirror relationship in the format [vserver:]volume. This format may change in the future. The destination endpoint can be specified using the location format above, or by specifying the parameters for the name of the destination Vserver and the name of the destination volume.
- destination-volume => string, optional
Specifies the name of destination volume for the SnapMirror relationshp. The name of the destination Vserver must also be specified if using this parameter.
- destination-vserver => string, optional
Specifies the name of the destination Vserver for the relationship. The name of the destination volume must also be specified if using this parameter.
- source-location => string, optional
Specifies the source endpoint of the SnapMirror relationship in the format [vserver:]volume. This format may change in the future. The source endpoint can be specified using the location format above, or by specifying the parameters for the name of the source Vserver and the name of the source volume.
- source-volume => string, optional
Specifies the name of the source volume of the SnapMirror relationship. The name of the source Vserver must also be specified if using this parameter.
- source-vserver => string, optional
Specifies the name of the source Vserver for the SnapMirror relationship. The name of the source volume must also be specified if using this parameter.
Outputs
[Family: cluster, vserver]
The snapmirror-get-destination-iter API returns information about, one or more SnapMirror relationships whose source endpoints are in the Vserver or the cluster the API is issued on. The information returned can be stale. Stale information corresponds to a SnapMirror relationship that has been deleted on its destination cluster or Vserver. Stale information may result to several entries being returned with the same source and destination endpoints, but with different relationship IDs.
Note that the information for a SnapMirror relationship will not be available on its source Vserver or source cluster until at least one transfer is initiated.
This API is only supported on Data ONTAP 8.2 and above operating in Cluster-Mode. It can be issued on a Vserver or a Cluster.
Inputs
- desired-attributes => snapmirror-destination-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
- 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 snapmirror objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster, vserver]
The snapmirror-get-iter API returns information for one or several SnapMirror relationships. On Data ONTAP 8.1 operating in Cluster-Mode, this API can be issued on a cluster. It returns all SnapMirror relationships that have a source or destination endpoint in that cluster, and that match the parameters specified. On Data ONTAP 8.2 operating in Cluster-Mode, this API can be issued on a Vserver or a cluster. It returns all the SnapMirror relationships, which have a destination endpoint in that Vserver or cluster, and that match the parameters specified.
Inputs
- desired-attributes => snapmirror-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
- 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 snapmirror objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Obtain the total number of SnapMirror relationships. This is a point in time estimate and may be different on subsequent calls.Inputs
Outputs
- count => integer
The total number of snapmirror objects.
[Family: cluster]
Returns SnapMirror status values for a given volume. Including whether: the volume is a source of a SnapMirror relationship; the volume is a destination of a SnapMirror relationship; a transfer is in progress; the relationship is broken off. On Data ONTAP 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
[Family: cluster, vserver]
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-cluster => string, optional
Specifies the destination cluster of the SnapMirror relationship. The destination Vserver and destination volume must also be specified if using this parameter.
- destination-volume => string, optional
Specifies the destination volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the destination Vserver.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-vserver => string, optional
Specifies the destination Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the destination volume.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
- max-transfer-rate => integer, optional
Specifies the upper bound, in kilobytes per second, at which data is transferred between clusters on Data ONTAP Cluster-Mode, or between storage systems on ata ONTAP 7-Mode. 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 mirrors and other SnapMirror relationships confined to a single cluster.
- source-cluster => string, optional
Specifies the source cluster of the SnapMirror relationship. The source Vserver and source volume must also be specified if using this parameter.
- 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'.
- source-volume => string, optional
Specifies the source volume of the SnapMirror relationship. The If using this parameter, the following parameters must also be specified: - The name of the source Vserver.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-vserver => string, optional
Specifies the source Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the source volume.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- transfer-priority => string, optional
Specifies the priority at which the transfer runs. Possible values are: "normal", and "low". The default value is the value specified in the snapmirror policy which is associated with the relationship. This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error. This parameter is only returned by Data ONTAP 8.1 or above operating in Cluster-Mode.
- result-error-message => string, optional
Error description, if the operation caused an error. This parameter is only returned by Data ONTAP 8.1 or above operating in Cluster-Mode.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job. This parameter is only returned by Data ONTAP 8.1 operating in Cluster-Mode.
- result-status => string, optional
The operation status. Possible values: "succeeded", "in_progress", "failed". This parameter is only returned by Data ONTAP 8.1 or above operating in Cluster-Mode.
[Family: cluster, vserver]
The snapmirror-initialize-iter API initializes the destination volume of one or more SnapMirror relationships. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of snapmirror objects to be operated in this call. Default: 20
- max-transfer-rate => integer, optional
Specified the upper bound, in kilobytes per second, at which data is transferred between clusters. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. The max-transfer-rate option does not affect load-sharing mirrors and other SnapMirror relationships confined to a single cluster.
- query => snapmirror-info
If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on or scheduled to be worked on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
- source-snapshot => string, optional
Source Snapshot
- 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 matching snapmirror objects to be operated on.
- num-failed => integer, optional
The number of snapmirror objects that matched the query, but were not operated on due some error.
- num-succeeded => integer, optional
The number of snapmirror objects that matched the query and were successfully processed or scheduled to be processed.
[Family: cluster]
The snapmirror-initialize-ls-set API performs the initial manual update of a set of load-sharing mirrors. This API is usually used after the snapmirror-create API is used to create a SnapMirror relationship for each of the destination volumes in the set of load-sharing mirrors. You must specify the source endpoint when using snapmirror-initialize-ls-set. Data and Snapshot copies are transferred from the source volume to all up-to-date destination volumes in the set of load-sharing mirrors. Use the snapmirror-initialize API to add and initialize a new destination volume to an existing set of load-sharing mirrors. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
- source-cluster => string, optional
Specifies the source cluster of the SnapMirror relationship. The source Vserver and source volume must also be specified if using this parameter. This parameter is supported only in cluster context.
- source-location => string, optional
Specifies the source endpoint of the SnapMirror relationship. When specifying a source endpoint, you must use either the source location, or the source cluster, source Vserver, and source volume.
- source-volume => string, optional
Specifies the source volume of the SnapMirror relationship. The source cluster and source Vserver must also be specified if using this parameter. This parameter may be optional if executed outside cluster context.
- source-vserver => string, optional
Specifies the source Vserver of the SnapMirror relationship. The source cluster and source volume must also be specified if using this parameter.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
[Family: cluster, vserver]
The snapmirror-modify API changes one or more parameters of a SnapMirror relationship. The key parameter that identifies any SnapMirror relationship is the destination volume. You must specify the destination endpoint when using the snapmirror-modify API. For load-sharing mirrors, a change to a parameter affects all of the SnapMirror relationships in the set of load-sharing mirrors. Destination volumes in a set of load-sharing mirrors do not have individual parameter settings. Changes made by the snapmirror-modify API do not take effect until the next manual or scheduled update of the SnapMirror relationship. Changes do not affect updates that have started and have not finished yet. On Data ONTAP 8.1 operating in Cluster-Mode this API must be issued on the destination Cluster. On Data ONTAP 8.2 operating in Cluster-Mode, this API must be issued on the destination Vserver if operating in a Vserver context and on the destination cluster if operating in a cluster context. This API is not supported on Infinite Volume constituents.
Inputs
- destination-cluster => string, optional
Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-location => string, optional
Specifies the destination endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
- destination-volume => string, optional
Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the destination Vserver.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-vserver => string, optional
Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of destination volume.
- The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- max-transfer-rate => integer, optional
Specifies the upper bound, in kilobytes per second, at which data is transferred between clusters. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. The max-transfer-rate option does not affect load-sharing mirrors and other SnapMirror relationships confined to a single cluster.
- schedule => string, optional
Specifies the name of the cron schedule, used to update the SnapMirror relationship.
- source-cluster => string, optional
Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-location => string, optional
Specifies the source endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
- source-volume => string, optional
Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the source Vserver.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-vserver => string, optional
Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of source volume.
- The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- tries => string, optional
Specifies the maximum number of times to attempt each manual or scheduled transfer for a SnapMirror relationship. The default is eight times. Note: You can set the tries option to zero (0) to disable manual and scheduled updates for the SnapMirror relationship. This parameter is only relevant on Data ONTAP 8.1 operating in Cluster-Mode. On Data ONTAP 8.2 operating in Cluster-Mode, the maximum number of times to attempt a transfer is an attribute of the SnapMirror policy. Therefore the value of this parameter is ignored.
- vserver => vserver-name, optional
If this optional parameter is specified, designates the managing Vserver. The managing Vserver is authorized to use snapmirror commands to manage the SnapMirror relationship. The vserver option is currently a reserved option.
Outputs
[Family: cluster, vserver]
The snapmirror-modify-iter API allows to change one or more parameters of one or more SnapMirror relationships. This API is not supported on Infinite Volume constituents.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of snapmirror objects to be operated in this call. Default: 20
- max-transfer-rate => integer, optional
Specifies the upper bound, in kilobytes per second, at which data is transferred between clusters. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. The max-transfer-rate option does not affect load-sharing mirrors and other SnapMirror relationships confined to a single cluster.
- policy => sm-policy, optional
Specifies the name of the SnapMirror policy that applies to this relationship.
- query => snapmirror-info
If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
- schedule => string, optional
Specifies the name of the cron schedule, used to update the SnapMirror relationship.
- 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.
- tries => string, optional
Specifies the maximum number of times to attempt each manual or scheduled transfer for a SnapMirror relationship. The default is eight times. Note: You can set the tries option to zero (0) to disable manual and scheduled updates for the SnapMirror relationship. This parameter is only relevant on Data ONTAP 8.1 operating in Cluster-Mode. On Data ONTAP 8.2 operating in Cluster-Mode, the maximum number of times to attempt a transfer is an attribute of the SnapMirror policy. Therefore the value of this parameter is ignored.
- vserver => vserver-name, optional
If this optional parameter is specified, designates the managing Vserver. The managing Vserver is authorized to use snapmirror commands to manage the SnapMirror relationship. The vserver option is currently a reserved option.
Outputs
- next-tag => string, optional
Tag for the next call. Not present when there are no more matching snapmirror objects to be operated on.
- num-failed => integer, optional
The number of snapmirror objects that matched the query, but were not operated on due some error.
- num-succeeded => integer, optional
The number of snapmirror objects that matched the query and were successfully processed.
[Family: cluster]
The snapmirror-promote API performs a failover to the destination volume of a load-sharing SnapMirror relationship. This API changes the destination volume from a load-sharing volume to a read-write volume and makes the destination volume assume the identity of the source volume. The API then destroys the original source volume. The destination volume must be a load-sharing volume. However, you can still perform 'snapmirror-promote' on a destination load-sharing volume that has been left in read-write state by a previously failed promote operation. You must specify the destination endpoint when using snapmirror-promote. Note: The source volume and destination volume must be on the same Vserver for the promote to work. Client accesses are redirected from the original source volume to the promoted destination volume. The view clients see on the promoted destination volume is the latest transferred Snapshot copy, which might lag behind the view clients had of the original source volume before the promote. The SnapMirror relationship is usually deleted as part of the promotion process. This is not true for a set of load-sharing mirrors that contain more than one destination volume. In this case, the promoted destination volume becomes the new source volume to the set of load-sharing mirrors. It is possible that the original source volume is the source of multiple SnapMirror relationships. For such a configuration, the promoted destination volume becomes the new source volume of the other SnapMirror relationships. The snapmirror-promote API fails if a SnapMirror transfer is in progress for any SnapMirror relationship involving the original source volume.Inputs
- destination-cluster => string, optional
Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-location => string, optional
Specifies the destination endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
- destination-volume => string, optional
Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the destination Vserver.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-vserver => string, optional
Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of destination volume.
- The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-cluster => string, optional
Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-location => string, optional
Specifies the source endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
- source-volume => string, optional
Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the source Vserver.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-vserver => string, optional
Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of source volume.
- The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
Outputs
[Family: cluster]
The snapmirror-promote-iter API performs failover for one or more SnapMirror relationships.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of snapmirror objects to be operated in this call. Default: 20
- query => snapmirror-info
If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
- 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 matching snapmirror objects to be operated on.
- num-failed => integer, optional
The number of snapmirror objects that matched the query, but were not operated on due some error.
- num-succeeded => integer, optional
The number of snapmirror objects that matched the query and were successfully processed.
[Family: cluster, vserver]
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-cluster => string, optional
Specifies the destination cluster of the SnapMirror relationship. The destination Vserver and destination volume must also be specified if using this parameter.
- 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
- destination-volume => string, optional
Specifies the destination volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the destination Vserver.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-vserver => string, optional
Specifies the destination Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the destination volume.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-cluster => string, optional
Specifies the source cluster of the SnapMirror relationship. The source Vserver and source volume must also be specified if using this parameter.
- 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 cluster, source Vserver, and source volume.
- source-volume => string, optional
Specifies the source volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the source Vserver.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-vserver => string, optional
Specifies the source Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the source volume.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
Outputs
[Family: cluster, vserver]
Disables future transfers for one or more SnapMirror relationships.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of snapmirror objects to be operated in this call. Default: 20
- query => snapmirror-info
If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
- 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 matching snapmirror objects to be operated on.
- num-failed => integer, optional
The number of snapmirror objects that matched the query, but were not operated on due some error.
- num-succeeded => integer, optional
The number of snapmirror objects that matched the query and were successfully processed.
[Family: cluster, vserver]
The snapmirror-release API removes a SnapMirror relationship on the source endpoint. It unlocks and cleanups the snapshots pertaining to the relationship. It does not destroy any volume. You must specify the destination endpoint when using snapmirror-release. Unless relationship-info-only is specified, this operation will fail if it is unable to reach the source volume and clean up snapshots. On Data ONTAP 8.2 or later operating in Cluster-Mode, this API must be executed on the source Vserver or source cluster following the deletion of the relationship on the destination Vserver or destination cluster. It is possible to issue snapmirror-release on the source Vserver without deleting the relationship on the destination Vserver. However, the relationship will continue to exist because the destination is the authority. The relationship will reappear on the source on the next transfer. On Data ONTAP operating in 7-Mode, this API must be issued on the source storage system. On Data ONTAP 8.2 or later operating in Cluster-Mode, this API must be issued on the source Vserver if operating in Vserver context and on the source cluster if operating in a cluster context. This API is not supported on Data ONTAP 8.1 operating in Cluster-Mode, or Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.Inputs
- 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
- destination-volume => string, optional
Specifies the destination volume of the SnapMirror relationship. If using this parameter, the destination Vserver must also be specified.
- destination-vserver => string, optional
Specifies the destination Vserver of the SnapMirror relationship. If using this parameter, the destination volume must also be specified.
- 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.
- source-volume => string, optional
Specifies the source volume of the SnapMirror relationship. If using this parameter, the source Vserver must also be specified:
- source-vserver => string, optional
Specifies the source Vserver of the SnapMirror relationship. If using this parameter, the source volume must also be specified.
Outputs
[Family: cluster, vserver]
releases one or a group of SnapMirror relationships.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of snapmirror objects to be operated in this call. Default: 20
- query => snapmirror-destination-info
If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
- 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 matching snapmirror objects to be operated on.
- num-failed => integer, optional
The number of snapmirror objects that matched the query, but were not operated on due some error.
- num-succeeded => integer, optional
The number of snapmirror objects that matched the query and were successfully processed.
[Family: cluster, vserver]
The snapmirror-restore API restores the contents of a selected Snapshot copy from the source volume to the active file system of the destination volume. The destination volume is read write after the data is restored. The snapmirror-restore API creates a temporary SnapMirror relationship of the type RST. For this reason the destination volume cannot be the destination volume of another SnapMirror relationship. The temporary RST relationship is deleted after the operation completes successfully. If the destination volume is an empty data protection volume, the snapmirror-restore API performs a baseline restore. The baseline restore transfers the contents of the selected Snapshot copy from the source volume to the destination volume. If the destination volume is read-write and has at least one Snapshot which also appears on the source volume, an incremental restore is performed. The destination volume is made read only, if is not already read only. When the destination volume is made read only the latest snapshot on destination volume is made the exported snapshot. Note, that any data written to the destination volume since the last snapshot is lost during this operation. To save the contents of the active file system on the destination volume, stop all client access and take a snapshot before starting this operation. During an incremental restore a common Snapshot copy is selected. The snapshot chosen as the common snapshot must be on the source and destination volumes. The contents of the common Snapshot copy on the destination volume are copied to the active file system of the destination volume. Then the contents of the Snapshot copy to be restored are transferred from the source volume to the destination volume. Unless 'source-snapshot' is specified the most recent Snapshot copy on the source volume is restored. This API may be used to restart a failed snapmirror-restore operation. This API may be used to terminate an aborted or failed snapmirror-restore operation by specifying the 'clean-up-failure' parameter set to 'true'. Terminating an aborted or failed snapmirror-restore operation deletes any residual temporary RST relationship and converts the destination volume back to read-write if the destination volume was read-write prior to initial snapmirror-restore operation while removing any data transferred or copied during the snapmirror-restore operation. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
- clean-up-failure => boolean, optional
Use this parameter with the value of 'true' to recover from an aborted or failed restore operation. If the destination volume was read-write prior to the failed or aborted restore operation, it is converted back to read-write if necessary while removing all data transferred or copied during the restore operation. Any residual temporary RST relationship is also removed from the destination Vserver. An attempt is made to remove any residual temporary RST relationship from the source Vserver. The default value for this parameter is 'false'.
- destination-cluster => string, optional
Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-location => string, optional
Specifies the destination endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
- destination-volume => string, optional
Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the destination Vserver.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-vserver => string, optional
Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of destination volume.
- The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- disable-storage-efficiency => boolean, optional
The default behavior of restore is to preserve storage efficiency when possible. Use this parameter with a value of 'true' to turn off storage efficiency for data transferred over the wire and written to the destination volume. The default value for this parameter is false.
- max-transfer-rate => integer, optional
Specifies the upper bound, in kilobytes per second, at which data is transferred between clusters. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. The max-transfer-rate option does not affect load-sharing mirrors and other SnapMirror relationships confined to a single cluster.
- source-cluster => string, optional
Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-location => string, optional
Specifies the source endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode.
- source-snapshot => string, optional
Specifies the Snapshot from the source to be restored.
- source-volume => string, optional
Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the source Vserver.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-vserver => string, optional
Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of source volume.
- The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- transfer-priority => sm-transfer-priority-enum, optional
Specifies the priority at which the transfer runs. Possible values are: 'normal', and 'low'. The default value for this parameter is 'normal'. Possible values:
- tries => string, optional
Specifies the total number of attempts to transfer data. Valid input is a positive integer or 'unlimited'. The default is '8'.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
[Family: cluster, vserver]
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-cluster => string, optional
Specifies the destination cluster of the SnapMirror relationship. The destination Vserver and destination volume must also be specified if using this parameter.
- 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-volume => string, optional
Specifies the destination volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the destination Vserver.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-vserver => string, optional
Specifies the destination Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the destination volume.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-cluster => string, optional
Specifies the source cluster of the SnapMirror relationship. The source Vserver and source volume must also be specified if using this parameter.
- 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 cluster, source Vserver, and source volume.
- source-volume => string, optional
Specifies the source volume of the SnapMirror relationship. The If using this parameter, the following parameters must also be specified: - The name of the source Vserver.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-vserver => string, optional
Specifies the source Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the source volume.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
Outputs
[Family: cluster, vserver]
Enables future transfers for one or more SnapMirror relationships.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of snapmirror objects to be operated in this call. Default: 20
- query => snapmirror-info
If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
- 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 matching snapmirror objects to be operated on.
- num-failed => integer, optional
The number of snapmirror objects that matched the query, but were not operated on due some error.
- num-succeeded => integer, optional
The number of snapmirror objects that matched the query and were successfully processed.
[Family: cluster, vserver]
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-cluster => string, optional
Specifies the destination cluster of the SnapMirror relationship. The destination Vserver and destination volume must also be specified if using this parameter.
- 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-volume => string, optional
Specifies the destination volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the destination Vserver.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-vserver => string, optional
Specifies the destination Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the destination volume.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
- max-transfer-rate => integer, optional
Specified the upper bound, in kilobytes per second, at which data is transferred between clusters on Data ONTAP Cluster-Mode, or between storage systems on ata ONTAP 7-Mode. 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 mirrors and other SnapMirror relationships confined to a single cluster.
- preserve => boolean, optional
This parameter is only available for Vault relationships. The default value is false which means all snapshots on the destination that are newer than the latest common snapshot will be deleted. If preserve is specified, newer snapshots are retained. If preserve is specified for a non-Vault relationship the API will fail. This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode and for vault relationships.
- source-cluster => string, optional
Specifies the source cluster of the SnapMirror relationship. The source Vserver and source volume must also be specified if using this parameter.
- 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'.
- source-volume => string, optional
Specifies the source volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the source Vserver.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-vserver => string, optional
Specifies the source Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the source volume.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- transfer-priority => string, optional
Specifies the priority at which the transfer runs. Possible values are: "normal", and "low". The default value is the value specified in the snapmirror policy which is associated with the relationship. This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error. This parameter is only returned by Data ONTAP 8.1 or above operating in Cluster-Mode.
- result-error-message => string, optional
Error description, if the operation caused an error. This parameter is only returned by Data ONTAP 8.1 or above operating in Cluster-Mode.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job. This parameter is only returned by Data ONTAP 8.1 or above operating in Cluster-Mode. This parameter should be used to monitor the transfer progress. But, on Data ONTAP 8.2 operating in Cluster-Mode, it should be ignored if the relationship-control-plane is not 'v1'. The snapmirror-get API should be used to monitor the progress of the transfer.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed". This parameter is only returned by Data ONTAP 8.1 or above operating in Cluster-Mode.
[Family: cluster, vserver]
The snapmirror-resync-iter API reestablishes one or more previously broken SnapMirror relationships. This API is not supported on Infinite Volume constituents. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of snapmirror objects to be operated in this call. Default: 20
- max-transfer-rate => integer, optional
Specified the upper bound, in kilobytes per second, at which data is transferred between clusters. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. The max-transfer-rate option does not affect load-sharing mirrors and other SnapMirror relationships confined to a single cluster.
- preserve => boolean, optional
Preserve
- query => snapmirror-info
If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on or scheduled to be worked on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
- source-snapshot => string, optional
Source Snapshot
- 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.
- transfer-priority => sm-transfer-priority-enum, optional
Transfer Priority Possible values:
Outputs
- next-tag => string, optional
Tag for the next call. Not present when there are no more matching snapmirror objects to be operated on.
- num-failed => integer, optional
The number of snapmirror objects that matched the query, but were not operated on due some error.
- num-succeeded => integer, optional
The number of snapmirror objects that matched the query and were successfully processed or scheduled to be processed.
[Family: vserver]
Add an owner to preserve a Snapshot copy for a SnapMirror mirror-to-vault cascade configuration.Inputs
- snapshot-owner-name => snapshot-owner-name, optional
Specifies the name of the owner to preserve a Snapshot copy for a SnapMirror mirror-to-vault cascade configuration. An owner can contain letters, numbers, and the underscore character (_), and can be at most 32 characters long. If no owner is specified, the system will assign an internal default owner to preserve the Snapshot copy.
- volume => volume-name
Volume Name
- vserver => vserver-name
Vserver Name
Outputs
[Family: vserver]
Delete an owner used to preserve a Snapshot copy for a SnapMirror mirror-to-vault cascade configuration.Inputs
- snapshot => snapshot-id
Snapshot Copy Name
- snapshot-owner-name => snapshot-owner-name, optional
The specified owner is removed from the Snapshot copy. If no owner name is provided, the system will look for and remove the internal default name for the owner. A specified owner of '*' removes all owners from the Snapshot copy.
- volume => volume-name
Volume Name
- vserver => vserver-name
Vserver Name
Outputs
[Family: cluster, vserver]
List all owners used to preserve a Snapshot copy for a SnapMirror mirror-to-vault cascade configuration.Inputs
- snapshot => snapshot-id
Snapshot Copy Name
- volume => volume-name
Volume Name
- vserver => vserver-name
Vserver Name
Outputs
[Family: cluster, vserver]
List all Snapshot copies that are preserved for a SnapMirror mirror-to-vault cascade configuration.Inputs
- volume => volume-name
Volume Name
- vserver => vserver-name
Vserver Name
Outputs
- snapshots => snapshot-id[]
Returns the Snapshot copies that are preserved using owners for a SnapMirror mirror-to-vault cascade configuration.
[Family: cluster, vserver]
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-cluster => string, optional
Specifies the destination cluster of the SnapMirror relationship. The destination Vserver and destination volume must also be specified if using this parameter.
- 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-volume => string, optional
Specifies the destination volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the destination Vserver.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
- destination-vserver => string, optional
Specifies the destination Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the destination volume.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 operating in Cluster-Mode if the relationship control plane is 'v1'.
- max-transfer-rate => integer, optional
Specified the upper bound, in kilobytes per second, at which data is transferred between clusters on Data ONTAP Cluster-Mode, or between storage systems on Data ONTAP operating in 7-Mode. 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 mirrors and other SnapMirror relationships confined to a single cluster.
- source-cluster => string, optional
Specifies the source cluster of the SnapMirror relationship. The source Vserver and source volume must also be specified if using this parameter.
- 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.
- source-volume => string, optional
Specifies the source volume of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the source Vserver.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- source-vserver => string, optional
Specifies the source Vserver of the SnapMirror relationship. If using this parameter, the following parameters must also be specified: - The name of the source volume.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
- transfer-priority => string, optional
Specifies the priority at which the transfer runs. Possible values are: "normal", and "low". The default value is the value specified in the snapmirror policy which is associated with the relationship. This parameter only applies on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error. This parameter is only returned by Data ONTAP 8.1 or above operating in Cluster-Mode.
- result-error-message => string, optional
Error description, if the operation caused an error. This parameter is only returned by Data ONTAP 8.1 or above operating in Cluster-Mode.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job. This parameter is only returned by Data ONTAP 8.1 operating in Cluster-Mode.
- result-status => string, optional
The operation status. Possible values: "succeeded", "in_progress", "failed". This parameter is only returned by Data ONTAP 8.1 or above operating in Cluster-Mode.
[Family: cluster, vserver]
The snapmirror-update-iter API updates the destination volumes of one or more SnapMirror relationships. This API is not supported on Infinite Volume constituents. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple snapmirror objects match a given query. If set to true, the API will continue with the next matching snapmirror even when the operation fails for the snapmirror. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed operations before the server gives up and returns. If set, the API will continue with the next matching snapmirror even when the operation on a previous matching snapmirror fails, and do so until the total number of objects failed to be operated on reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of snapmirror objects to be operated in this call. Default: 20
- max-transfer-rate => integer, optional
Specified the upper bound, in kilobytes per second, at which data is transferred between clusters. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. The max-transfer-rate option does not affect load-sharing mirrors and other SnapMirror relationships confined to a single cluster.
- query => snapmirror-info
If operating on a specific snapmirror, this input element must specify all keys. If operating on snapmirror objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were not operated on due to some error. If set to false, the list of snapmirror objects not operated on will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of snapmirror objects (just keys) that were successfully operated on or scheduled to be worked on. If set to false, the list of snapmirror objects operated on will not be returned. Default: true
- source-snapshot => string, optional
Source Snapshot
- 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 matching snapmirror objects to be operated on.
- num-failed => integer, optional
The number of snapmirror objects that matched the query, but were not operated on due some error.
- num-succeeded => integer, optional
The number of snapmirror objects that matched the query and were successfully processed or scheduled to be processed.
[Family: cluster]
The snapmirror-update-ls-set API updates destination volumes of the set of load-sharing mirrors. The API makes destination volumes, in the group of load-sharing mirrors, up-to-date mirrors of the source volume. You must specify the source endpoint when using snapmirror-update-ls-set. Separate SnapMirror transfers are performed from the source volume to each of the up-to-date destination volumes in the set of load-sharing mirrors. Load-sharing mirrors that lag behind the up-to-date destination volumes might not be updated by the snapmirror-update-ls-set API. Use the snapmirror-update API to update a lagging load-sharing mirror. A job will be spawned to operate on the snapmirror and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
- source-cluster => string, optional
Specifies the source cluster of the SnapMirror relationship. The source Vserver and source volume must also be specified if using this parameter. This parameter is supported only in cluster context.
- source-location => string, optional
Specifies the source endpoint of the SnapMirror relationship. When specifying a source endpoint, you must use either the source location, or the source cluster, source Vserver, and source volume.
- source-volume => string, optional
Specifies the source volume of the SnapMirror relationship. The source cluster and source Vserver must also be specified if using this parameter.
- source-vserver => string, optional
Specifies the source Vserver of the SnapMirror relationship. The source cluster and source volume must also be specified if using this parameter.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
[Family: vserver]
Add a rule to SnapMirror policyInputs
- preserve => boolean, optional
Specifies whether Snapshot copy preserve is enabled.
Outputs
[Family: vserver]
Create the specified SnapMirror PolicyInputs
- comment => string, optional
A human readable description associated with the SnapMirror policy.
- ignore-atime => boolean, optional
Specifies whether incremental transfers will ignore files which have only their access time changed. Applies to SnapMirror vault relationships only.
- policy-name => sm-policy
The name of the SnapMirror policy.
- restart => sm-restart-enum, optional
Defines the behavior of SnapMirror if an interrupted transfer exists. Applies to SnapMirror data protection relationship only. Possible values: - "always" ,
- "never" ,
- "default"
- return-record => boolean, optional
If set to true, returns the snapmirror-policy on successful creation. Default: false
- transfer-priority => sm-transfer-priority-enum, optional
Specifies the priority at which a SnapMirror transfer runs. 'normal' : By default every transfer in the system has this priority. These transfers are scheduled before most 'low' priority transfers. 'low': These transfers have least priority and usually are scheduled after most 'normal' priority transfers. Possible values:
- tries => string, optional
Specifies the maximum number of times to attempt each manual or scheduled transfer for a SnapMirror relationship. Valid input is a positive integer or 'unlimited'. The default is '8'.
Outputs
[Family: vserver]
Delete the specified SnapMirror PolicyInputs
- policy-name => sm-policy
The name of the SnapMirror policy.
Outputs
[Family: vserver]
Get Information about a single SnapMirror PolicyInputs
- policy-name => sm-policy
The name of the SnapMirror policy.
Outputs
[Family: cluster, vserver]
Get Information about multiple SnapMirror PoliciesInputs
- desired-attributes => snapmirror-policy-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
- 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 snapmirror-policy objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Modify the specified SnapMirror PolicyInputs
- comment => string, optional
A human readable description associated with the SnapMirror policy.
- ignore-atime => boolean, optional
Specifies whether incremental transfers will ignore files which have only their access time changed. Applies to SnapMirror vault relationships only.
- policy-name => sm-policy
The name of the SnapMirror policy.
- restart => sm-restart-enum, optional
Defines the behavior of SnapMirror if an interrupted transfer exists. Applies to SnapMirror data protection relationship only. Possible values: - "always" ,
- "never" ,
- "default"
- transfer-priority => sm-transfer-priority-enum, optional
Specifies the priority at which a SnapMirror transfer runs. 'normal' : By default every transfer in the system has this priority. These transfers are scheduled before most 'low' priority transfers. 'low': These transfers have least priority and usually are scheduled after most 'normal' priority transfers. Possible values:
- tries => string, optional
Specifies the maximum number of times to attempt each manual or scheduled transfer for a SnapMirror relationship. Valid input is a positive integer or 'unlimited'. The default is '8'.
Outputs
[Family: vserver]
Modify a SnapMirror policy ruleInputs
- policy-name => sm-policy
The name of the SnapMirror policy.
- preserve => boolean, optional
Specifies whether Snapshot copy preserve is enabled.
- snapmirror-label => string
Specifies the Snapshot copy label.
- warn => integer, optional
Specifies the warning threshold count.
Outputs
[Family: vserver]
Remove a rule from SnapMirror policyInputs
- policy-name => sm-policy
The name of the SnapMirror policy.
- snapmirror-label => string
Specifies the Snapshot copy label.
Outputs
[Family: vserver]
Returns the current snapshot autodelete settings.Inputs
- volume => string
Name of the existing volume for which we want snapshot autodelete settings
Outputs
[Family: vserver]
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
[Family: vserver]
Create a new snapshot on a specified volume. This API is not supported on Infinite Volume.
Inputs
- comment => string, optional
A human readable comment attached with the snapshot. The size of the comment can be at most 255 characters.
- 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 applied as an attribute to the snapshot that is created and will be used by the vaulting system to identify a vaulting scheme.
- 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
[Family: vserver]
Create a new snapshot on a specified Infinite Volume. This API is not supported on flexible volumes and Infinite Volume constituents.
Inputs
- comment => string, optional
A human readable comment attached with the snapshot. The size of the comment can be at most 255 characters.
- snapshot => string
Name of the snapshot to be created. The maximum string length is 256 characters.
- volume => string
Name of the Infinite Volume on which the snapshot is to be created. The Infinite Volume name can contain letters, numbers, and the underscore character (_), but the first character must be a letter or an underscore.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
[Family: vserver]
Delete a snapshot on a specified volume. EBUSY is returned when the snapshot is in use. EROFS is returned when the volume is read-only. EAGAIN is returned when splitting a blockmap or reverting. This API is not supported on Infinite Volume.
Inputs
- 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
[Family: vserver]
Delete a snapshot on a specified Infinite Volume. EBUSY is returned when the snapshot is in use. EROFS is returned when the Infinite Volume is read-only. EAGAIN is returned when splitting a blockmap or reverting. This API is not supported on flexible volumes and Infinite Volume constituents.
Inputs
- ignore-owners => boolean, optional
If this field is true, snapshot will be deleted even if some other processes are accessing it. The default value is false.
- snapshot => string
Name of snapshot to be deleted on the specified Infinite 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 Infinite Volume on which the snapshot is to be deleted.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
[Family: vserver]
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].
[Family: cluster, vserver]
Iterate over a list of snapshot objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => snapshot-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the snapshot object. All snapshot 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 snapshot objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
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
[Family: vserver]
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].
[Family: vserver]
Return snapshot information for a specified volume. A list of snapshots and information about each snapshot is returned. In Data ONTAP Cluster-Mode, 'snapshot-get-iter' API is the preferred way of retrieving snapshot information.Inputs
- 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
[Family: cluster, vserver]
Modify the attributes of snapshot or a group of snapshot objects.Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple snapshot objects match a given query. If set to true, the API will continue modifying the next matching snapshot even when modification of a previous snapshot fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching snapshot even when the modification of a previous matching snapshot fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of objects to be modified in this call. Default: 20
- query => snapshot-info
If modifying a specific snapshot, this input element must specify all keys. If modifying snapshot objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of snapshot objects (just keys) that were not modified due to some error. If set to false, the list of snapshot objects not modified will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of snapshot objects (just keys) that were successfully updated. If set to false, the list of snapshot objects modified will not be returned. Default: true
- 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 matching snapshot objects to be modified.
- num-failed => integer, optional
Number of snapshot objects that matched the query, but were not modified due to some error.
- num-succeeded => integer, optional
The number of snapshot objects that matched the query and were successfully updated.
[Family: vserver]
Create a snapshot with the specific name, on each of the specified volumes. It is the caller's responsibility to ensure that the data in the snapshots across all volumes is consistent, by quiescing I/O to these volumes (or the LUNs of interest in these volumes), across the call to this API. The API returns SUCCESS when a snapshot is successfully created on each of the specified volumes. This API bails out and reports FAILURE when an error is found at creating a snapshot on a volume. It does not continue on to create snapshots on the remaining volumes. When the API fails, the returned error code is for the failed volume. For clustered systems, the output 'status' will be set to FALSE in case of failure. In such case the caller should look at the output 'volume-errors' to find out in which volume snapshot creation failed. When an error occurs, it is possible that some snapshots may have been created. If the option cleanup is set to TRUE (default), API will attempt to delete these snapshots (but snapshot deletion may fail). When set to FALSE, it is users' responsibility to delete them. The output array volume-snapcreated-list records for each volume, if a snapshot has been created or not. There are at least two expected use cases for this API. The first one is to call this API with the cleanup option set to TRUE (default). If the call fails, any successfully created snapshots will be deleted before the function returns. This is a simple use case, but has the downside that in case of a failure, the call may take a long time to return due to snapshot cleanup. Another use case would be to call this API in a time critical environment. In such a scenario, it would be good to reduce the impact due to a failure. Hence, it would be better to first call the snapshot-multicreate-validate ZAPI, which would reduce the likelihood of failure of the snapshot-multicreate API. In case a failure does occur, the caller could avoid the cleanup delay by setting the cleanup option to FALSE, and performing snapshot cleanup later, outside the time-critical window. 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
- status => boolean, optional
Set to 'FALSE' in case of failure of the API. The output 'volume-errors' will contain the error code and reason for the volume on which snapshot creation failed. This output is only returned for clustered systems.
- volume-errors => volume-error[], optional
Error code and reason due to which snapshot creation failed on a volume. This output is only returned for clustered systems.
[Family: vserver]
This is a companion API of snapshot-multicreate. It validates the snapshot creation operation on the specified volumes. But it does not actually create any snapshot. This API only does validations on all volumes and report all errors in the output array. This API is intended to be issued before the snapshot-multicreate API to find out all the errors that may be found during the snapshot create. Its main purpose is to enable snapshot-multicreate's caller to reduce the likelihood of snapshot-multicreate's failure, thereby attempting to avoid the cleanup overhead (of deleting any newly created snapshots) during failure processing. However, this validation API does not guarantee that snapshot-multicreate API will actually work. Something could change between the two calls to cause the actual snapshot creations to fail. 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
[Family: vserver]
Delete the snapshot from the given flexible volumes. This API will return failure if the volume could not be found or it is busy. All the volumes should be online when this API is invoked. It will only delete snapshots on Read-Write volumes. Once all the necessary information to delete snapshots is available, this API will start deleting snapshots on the volumes. If any of the snapshot delete failed, the API will remember the failed volume and continue deleting snapshot on the remaining volumes. In case of failure to delete the snapshots from all the given volumes, the API will return a SUCCESS and also return information about the failed snapshot deletes via the 'volume-errors' output. If the API returns SUCCESS, the applications should check if the 'volume-errors' output is returned or not to check for failed snapshot deletions. This API is not supported on Infinite Volume.
Inputs
- 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.
[Family: vserver]
Rename Snapshot copies with a specific name to a new name across multiple volumes. The API processes all the specified volumes even if rename fails on one or more volumes. The snapshot-multirename-errors field should be inspected for failures even if the API is successful.This API is not supported on Infinite Volume.Inputs
- volume-names => volume-name[]
Names of the volumes across which the snapshot is to be renamed.
Outputs
[Family: vserver]
Restores a particular range of bytes in a file from a specified snapshot. Partial file restores are used to restore particular pieces of LUNs and NFS or CIFS container files that are used by a host to store multiple sources of data. For example, a host may be storing multiple user databases in the same LUN. A partial file restore can be used to restore one of those databases in the LUN while not touching the other databases that are also stored in the LUN. Compressed files will not be restored, thought compression may be enabled on the volume.
Partial file restores require significant management by the caller. The caller must understand the metadata of the host LUN or container file so that they can know which bytes belong to the object being restored.
Before the restore operation beings, the caller must quiesce the object being restored. It must remain quiesced for the duration of the restore operation. No host I/O should be issued for the object while it is being restored because the snapshot-partial-restore-file commands will be incrementally restoring the LUN or file and the host will therefore see inconsistent content for the object until the restore operation is completed. Host I/O is permitted for the other objects stored in the LUN or container file because the partial file restore will not touch the bytes belonging to those other objects.
During the restore the caller must issue a snapshot-partial-restore-file command for each of the byte ranges that belong to the object being restored, based on the metadata of the LUN or container file. Once each command returns, that byte range is restored and the changes are persistent. If the filer should halt while processing a command, that byte range of the LUN or container file is inconsistent. Some of the bytes at the beginning of the range may have been restored while bytes at the end of the range have not been restored. Once the filer is rebooted the caller should re-issue the command to restore that byte range to complete the restore.
Once the restore is completed, the caller must purge any host operating system or application buffers that may hold data for the LUN or file that is now stale. For NFS or CIFS mounted volumes the easiest way to purge any host buffers is to unmount and remount the volume. Applications holding buffered data may need to be shut down and restarted.
Multiple partial file restore requests may be issued to the same LUN or file simultaneously. There is no requirement that the requests are all restoring from the same snapshot so that multiple restore operations for different objects may be concurrent on the same file. There is no checking to prevent overlapping byte ranges between requests. Preventing this condition is the responsibility of the caller.
Partial file restores are not intended for restoring parts of normal user-level files that are stored in an NFS or CIFS exported volume. Use snapshot-restore-file to restore normal files like these.
The volume where the LUN or container file to restore and where the snapshot to restore from live must be online and must not be a mirror volume.
The partial file restore request may fail if there is not sufficient free space to overwrite all of the blocks in the byte range to be restored.
The partial file restore request is synchronous, meaning that the command will not return until the entire byte range is restored. The snapshot being restored from cannot be deleted while a request is being executed, but it can be deleted between requests. If this happens the next request will notice that the snapshot has been deleted and will return an error.
The maximum number of bytes of data that can be restored in a single request is given by the max-byte-count value returned by the snapshot-partial-restore-file-list-info command. This limit ensures that requests are periodically interruptible and avoids overloading the filer.
If the system halts while a partial file restore request is being executed, the request will not be restarted upon reboot. Some of the bytes at the beginning of the range may have been restored while bytes at the end of the range have not been restored. The caller should reissue the partial file restore request for that byte range to complete the restore.
Inputs
- 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]
- 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]
- volume => string, optional
Volume to restore to/from. If this is passed in, the path argument should be relative to the volume.
Outputs
[Family: vserver]
Returns partial file restore settings of the vserver. This API is not supported on Infinite Volume.
Inputs
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]
[Family: cluster, vserver]
Add a new schedule to the Snapshot Policy. A schedule can be created by using 'job-schedule-cron-create' or 'job-schedule-interval-create' APIs.Inputs
- count => integer
The maximum number of snapshots to be retained for the schedule. The count of all the snapshots for to be retained for this policy cannot be more than 255.
- schedule => string
A human readable string describing the name of a new schedule to be added inside the snapshot policy. Maximum length of this field can be 255 characters. The schedule name can be any one of the reserved schedules like 'hourly', 'weekly' or 'daily' or it can be a user created schedule.
- snapmirror-label => string, optional
The SnapMirror Label for the schedule. This label will be used to define vaulting policies at a vault destination. Maximum length of this field is 31 characters
Outputs
[Family: cluster, vserver]
Create a new Snapshot Scheduling PolicyInputs
- comment => string, optional
A human readable description associated with the snapshot policy. The maximum length of this field can be 255 characters.
- count1 => integer
Retention count for the snapshots created by the first schedule. The count of all the snapshots to be retained for this policy cannot be more than 255.
- count2 => integer, optional
Retention count for the snapshots created by the second schedule. The count of all the snapshots to be retained for this policy cannot be more than 255.
- count3 => integer, optional
Retention count for the snapshots created by the third schedule. The count of all the snapshots to be retained for this policy cannot be more than 255.
- count4 => integer, optional
Retention count for the snapshots created by the fourth schedule. The count of all the snapshots to be retained for this policy cannot be more than 255.
- count5 => integer, optional
Retention count for the snapshots created by the fifth schedule. The count of all the snapshots to be retained for this policy cannot be more than 255.
- enabled => boolean
Status of the snapshot policy indicating whether the policy will be enabled or disabled. If set to true, the policy will be enabled.
- policy => string
The name of the snapshot scheduling policy which has to be created. This API creates a snapshot policy and adds the schedules to it. At the most 5 schedules can be added to the snapshot policy. Maximum length of this string can be 256 characters.
- schedule1 => string
First schedule to be added inside the policy. Atleast one schedule has to be added to create a policy.
Outputs
[Family: cluster, vserver]
Delete the specified Snapshot Scheduling PolicyInputs
- policy => snapshot-policy
A human readable string describing the name of the snapshot scheduling policy.
Outputs
[Family: cluster, vserver]
Get Information about a single Snapshot PolicyInputs
- policy => snapshot-policy
A human readable string describing the name of the snapshot scheduling policy.
Outputs
[Family: cluster, vserver]
Get Information about multiple Snapshot PoliciesInputs
- desired-attributes => snapshot-policy-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
- 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 snapshot objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster, vserver]
Enable or Disable the specified Snapshot Scheduling PolicyInputs
- enabled => boolean
The state of the snapshot policy. If true, the snapshot policy is enabled and scheduled snapshots will be created on the volume associated with this policy.
- policy => string
A human readable string describing the name of the snapshot scheduling policy.
Outputs
[Family: cluster, vserver]
Modify a snapshot policyInputs
- new-snapmirror-label => string, optional
The new SnapMirror Label for the schedule. This label will be used to define vaulting policies at a vault destination. If an empty label is specified, the existing label will be deleted. The maximum length of this field is 31 characters
- policy => snapshot-policy
A human readable string describing the name of the snapshot scheduling policy.
- schedule => string
A human readable string describing the name of a schedule whose retention count will be modified. Maximum length of this field can be 255 characters. The schedule name can be any one of the reserved schedules like 'hourly','weekly' or 'daily' or it can be user created schedule.
Outputs
[Family: cluster, vserver]
Remove a snapshot schedule from policyInputs
- policy => snapshot-policy
A human readable string describing the name of the snapshot scheduling policy.
- schedule => string
A human readable string describing the name of a schedule which will be removed from the snapshot policy. Maximum length of this field can be 255 characters. The schedule name can be any one of the reserved schedules like 'hourly','weekly' or 'daily' or it can be a user created schedule.
Outputs
[Family: vserver]
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
[Family: vserver]
Rename a specified snapshot to a new name on a specified volume. This API is not supported on Infinite Volume constituents.Inputs
- new-name => string
New name of snapshot as a result of the rename.
- volume => string
Name of the volume where the current snapshot and the new snapshot are located.
Outputs
[Family: cluster, vserver]
Gets the percentage of disk space that is reserved for snapshots in the indicated volume. If no volume is specified, this will return the percentage of disk space reserved for snapshots for each of the volumes in the system. Reserve space can be used only by snapshots and not by the active file system. 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
[Family: vserver]
Reverts a single file to a revision from a specified snapshot. The volume used for restoring the file must be online and must not be a mirror. Files other than normal files and LUNs are not restored. This includes directories (and their contents), and files with NT streams. Compressed files will not be restored 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.
Inputs
- 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
- volume => string, optional
Volume to restore to/from. If this is passed in, the path argument should be relative to the volume.
Outputs
[Family: vserver]
Get information about snapshot file restores on a given vserver. Returns maximum snapshot file restores limit and snapshot file restores in progress numbers.Inputs
Outputs
[Family: vserver]
Reverts a volume to a specified snapshot. The volume must be online and must not be a mirror. If reverting the root volume, the filer will be rebooted. Non-root volumes do not require a reboot. A volume cannot have both a volume snaprestore and a single-file snaprestore executing simultaneously. Multiple single-file snaprestores can be in progress simultaneously. After the reversion, the volume is in the same state as it was when the snapshot was taken. This API is not supported on Infinite Volume.
Inputs
- 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
[Family: vserver]
Reverts an Infinite Volume to a specified snapshot. The Infinite Volume must be online and unmounted and must not be a mirror. After the reversion, the Infinite Volume is in the same state as it was when the snapshot was taken. This API is not supported on flexible volumes and Infinite Volume constituents.
Inputs
- 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 Infinite Volume to restore.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
[Family: vserver]
Sets the size of the indicated volume's snapshot reserve to the specified percentage. Reserve space can be used only by snapshots and not by the active file system.Inputs
- volume => string
Name of volume on which to set the snapshot space reserve.
Outputs
[Family: vserver]
Returns snapshot related volume information. The information returned is valid at the time the API call reached the filer and maybe outdated soon after.Inputs
- 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].
[Family: cluster, vserver]
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
[Family: cluster, vserver]
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
[Family: cluster, vserver]
Deletes all the communities.Inputs
Outputs
[Family: cluster]
Disables snmp protocol.Inputs
Outputs
[Family: cluster]
Enables snmp protocol.Inputs
Outputs
[Family: cluster]
Retrieves the value of a snmp object.Inputs
- 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".
[Family: cluster]
This is used to retrieve the next OID in the mib tree of data. Instead of returning the data you requested, it returns the next OID in the tree and its value. Unlike the snmp-get api, this api does return data for a OID which is too short or is missing the index part of the OID.Inputs
- 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".
[Family: cluster]
Returns configuration information of the SNMP agent daemon.Inputs
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.
[Family: cluster]
Disables snmp traps.Inputs
Outputs
[Family: cluster]
Enables snmp traps.Inputs
Outputs
[Family: cluster]
Adds a host to the list of trap hosts.Inputs
- 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
[Family: cluster]
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
[Family: cluster]
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.
- node-name => string
This field is only valid when the request is sent to the Admin Vserver LIF. This is the storage system name the command will be executed on.
Outputs
[Family: cluster]
Display the information about a specified host adapter. The information is displayed base on the controller interface type. ATA, Paralell SCSI, SAS, FC.Inputs
- 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".
- node-name => string, optional
This field is only valid when the request is sent to the Admin Vserver LIF. If node-name is not specified when the request is sent to Admin VserverLIF, then all matching adapters in the cluster will be returned. This is the storage system name the command will be executed on.
Outputs
[Family: cluster]
Get the list of adapters present on this system.Inputs
- node-name => string, optional
This field is only valid when the request is sent to the Admin Vserver LIF. If node-name is not specified when the request is sent to Admin VserverLIF, then all matching adapters in the cluster will be returned. This is the storage system name the command will be executed on.
Outputs
[Family: cluster]
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".
- node-name => string
This field is only valid when the request is sent to the Admin Vserver LIF. This is the storage system name the command will be executed on.
- port-name => string
The port name is a slot number and port letter concatenated into a single name -- for example, "8a" or "11b".
Outputs
[Family: cluster]
Generates a high level summary of array LUN pathing (connectivity) information.Inputs
- node => string, optional
Obtain array LUN pathing information for a specified node.
- 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
[Family: cluster]
Retrieves a list of all array profiles known to the controller.Inputs
Outputs
[Family: cluster]
Update an array profile with new or changed information.Inputs
- prefix => string, optional
A unique user supplied 4 character code used to refer to this array and used in naming the array's LUNs.
- vendor => string, optional
The name of the array's manufacturer. (8 chars max)
Outputs
[Family: cluster]
Update an array port with new or changed information.Inputs
- array-name => string
The name of the array profile to update. (28 chars max)
- max-queue-depth => integer, optional
The target port queue depth for this target port.
- 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).
Outputs
[Family: cluster]
generate a list of online array ports and their associated arraysInputs
- array-name => string, optional
When supplied, only port records for the named array are returned. (28 chars)
Outputs
[Family: cluster]
Rename an array profileInputs
- array-name => string
The name of the array profile to update. (28 chars max)
- new-name => string
The new name to assign to this array profile. (28 chars max)
Outputs
[Family: cluster]
Disk enumeration ZAPI. Get disk information about one or more disks, from the Storage Subsystem. Currently only the Data ONTAP Cluster-Mode iterator APIs support filtering of output, to constrain the disks that are included in the return list, and/or what information is returned about each disk. The default is to return all information about all disks in the cluster. That list may be reduced using the 'query' input element. For example, the return list may include only (1) Disks visible to a particular cluster node "nodeA", e.g., "query.disk-paths.disk-name=nodeA:*" (2) A particular disk visible to a particular node, e.g., "query.disk-paths.node=nodeA:6a.01". (3) A disk with a particular unique id, e.g., "query.disk-uid=20000000:87A9652B:00000000:00000000:00000000:00000000:00000000:00000000:00000000:00000000" (4) Disks with a name that matches a certain wildcard pattern, e.g., "query.disk-paths.disk-name=*:6a*". (5) Disks assigned to a particular node. e.g., "query.disk-ownership-info.home-node-id=1252487" or "query.disk-ownership-info.home-node-name=nodeA". (6) Some subset of disks in the cluster or visible to a particular node in the cluster. If 'desired-attributes' is included, then only those data specified by in 'desired-attributes' are returned for each disk. For the Data ONTAP 7-Mode API, since filtering based upon 'query' and 'desired-attributes' is not yet supported, the behavior is currently to return all available information about all disks visible to the local node. If there is badly formed input or an invalid input value is specified, then EINVALIDINPUTERROR is returned. If there is some internal error which prevents processing of this request, then EINTERNALERROR is returned.Inputs
- 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.
- query => storage-disk-info, optional
May be used to express which disks to include in the return list. If omitted, then all disks are returned. If the input query is badly formed, then EINVALIDINPUTERROR is returned. If there are no disks which match the input query, then there is no error. However, no disk records are returned.
- 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.
[Family: cluster]
Balances primary/secondary array LUN paths across available initiator ports based on I/O load.Inputs
- node => string
node to balance initiator ports on
Outputs
[Family: cluster]
Returns path information and statistics for a given disk or all disks. We use the word disk to refer to an array lun, real disk, or Solid State DeviceInputs
Outputs
[Family: cluster]
Lists all known disk/configuration errors associated with an array or shelves acting like array.Inputs
- 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
[Family: cluster]
Gets disk I/O rates for a given fibre channel initiator port or for all initiator ports if no port is specified. The term disk refers to an array LUN, actual disk, or solid state device.Inputs
- node => string, optional
Obtain disk I/O rates for initiator ports on the specified node.
Outputs
[Family: cluster]
Returns information and statistics on all known paths to back end storage.Inputs
- node => string, optional
Obtain back end storage path statistics for this node.
Outputs
[Family: cluster]
Quiesces an array LUN on a path. A quiesced array LUN will not be sent I/O on the specified path.Inputs
- initiator => string
The initiator port of the path that I/O will be quiesced on.
- node => string
The node name on which the quiesce is issued
- 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
[Family: cluster]
Resumes I/O to array LUN on a path that was previously quiesced. Resuming I/O to a non-quiesced array LUN is a no-op and not an error.Inputs
- initiator => string
The initiator port of the path that I/O will be resumed to.
- lun-number => integer
LU number. Range: [0..65535]
- node => string
The node name on which the resume is issued
- 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
[Family: cluster, vserver]
get elements for specified apisInputs
Outputs
[Family: cluster, vserver]
get list of apis. This returns the names only - to get the parameter info, use system-api-get-elementsInputs
Outputs
[Family: cluster, vserver]
get list and description of typedefsInputs
Outputs
[Family: cluster]
Obtain appliance information which includes cpu and backplane information. The output contains the head information in a sysconfig -a command. I/O information is not included. System refers to a node in a cluster.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => system-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the system-info object. All system-info 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 system-info objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster, vserver]
Obtain the current ONTAPI major and minor versions.Inputs
Outputs
[Family: cluster]
Obtain the Data ONTAP vendor information.Inputs
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.
[Family: cluster, vserver]
Obtain the Data ONTAP version.Inputs
Outputs
- build-timestamp => integer, optional
Time of build creation, in seconds since January 1, 1970, of the image running on the appliance or of the build whose Data ONTAP version is lowest across the cluster. This field is available in Data ONTAP 8.1 or later.
- 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.
[Family: cluster]
Fetch a file from a URL. This API will return immediately. The progress can be monitored using the 'system-image-update-progress-get' API.Inputs
Outputs
[Family: cluster]
Display software image informationInputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 system objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Perform software image fresh installInputs
- package => string
Package URL
- rename-package => string, optional
Rename the File
- replace-package => boolean, optional
Replace the Local File
Outputs
[Family: cluster]
Modify software image configurationInputs
Outputs
[Family: cluster]
Delete a software packageInputs
- package => string
Package File Name
Outputs
[Family: cluster]
Display software information for all packagesInputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 system objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Perform software image upgrade/downgrade. This API will return immediately. The progress can be monitored using the 'system-image-update-progress-get' API.Inputs
- package => string
Package URL
- rename-package => string, optional
Rename the File
- replace-package => boolean, optional
Replace the Local File
Outputs
[Family: cluster]
Show progress information for current or previous updateInputs
Outputs
[Family: cluster]
Obtain the node information when the node is part of a cluster. Information returned includes details like location, serial-number, asset tag, uptime, vendor name etc.Inputs
- node => string
The textual name of a node.
Outputs
[Family: cluster]
Obtain the node information when the node is a part of the cluster in an iteration.Inputs
- desired-attributes => node-details-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
- 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 system-node objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Reboot the specified node. Only an admin can reboot the node. If attempted by a user with insufficient privileges EAPIPRIVILEGE is returned.Inputs
- node => string
The textual name of a node.
Outputs
[Family: cluster]
Rename the specified node to a new name specified by 'new-name'Inputs
- new-name => string
New Name
- node => string
The textual name of a node.
Outputs
[Family: cluster]
Shut down a node. Only an admin can initiate a node shutdown. If attempted by a user with insufficient privileges EAPIPRIVILEGE is returned.Inputs
- node => string
The textual name of a node.
Outputs
[Family: cluster, vserver]
Returns the objects and their operations which are permitted to user who called this API.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => capability-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the security login role object. All security login role 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 security login role objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
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".
[Family: vserver]
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
[Family: vserver]
Create a flexible volume that is a clone of a "backing" or "parent" flexible volume. A clone is a volume that is a writable snapshot of another volume. Initially, the clone and its parent share the same storage; more storage space is consumed only as one volume or the other changes. If a specific snapshot name within the parent volume is provided, it is chosen as the parent snapshot. Otherwise, the filer will create a new, distinctively- named snapshot in the parent volume for that purpose. The parent snapshot is locked in the parent volume, preventing its deletion until the clone is either destroyed or split from the parent using the 'volume-clone-split-start' command (see below). This command fails if the chosen parent volume is currently involved in a split operation. This command also fails if the chosen parent volume is a traditional volume. Cloning is a new capability that applies exclusively to flexible volumes.Inputs
- junction-active => boolean, optional
This field indicates whether the mounted volume is accessible. The default is true. If the mounted junction path is not accessible, the volume does not appear in the owning Vserver's namespace. This field applies only to Cluster-Mode volumes.
- junction-path => string, optional
The Junction Path at which this volume is to be mounted. The fully-qualified pathname in the owning Vserver's namespace at which a volume is mounted. Note that this pathname may itself contain junctions, one for each volume (other than the namespace root volume) that provides storage along the pathname's length. As with all fully-qualified pathnames , this string must begin with '/'. In addition, it must not end with '/'.
An example of a valid junction path is: '/user/my_volume'.
Only one volume can be mounted at any given junction path. If an incorrect junction path is specified, EINVALIDINPUTERROR is returned. If another volume is mounted at the specified junction path, EVOLALREADYMOUNTED is returned.
- 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
[Family: vserver]
Display details of a specific FlexClone volumeInputs
- volume => string
FlexClone Volume
Outputs
[Family: cluster, vserver]
Display a list of FlexClone volumesInputs
- desired-attributes => volume-clone-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: 10
- 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 volume objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Display an estimate of additional storage required in the underlying aggregate to perform a volume clone split operation. This command fails if applied to a traditional volume. Cloning is a new capability that applies exclusively to flexible volumes.Inputs
- volume => string
The name of the clone whose split usage is being estimated.
Outputs
[Family: vserver]
Begin the process by which the given clone is split off from its underlying parent volume and snapshot. New storage is allocated for the clone that is distinct from its parent. This process may take some time and proceeds in the background. Use the 'volume-clone-split-status' command to view the operation's progress. Both clone and parent volumes remain available during the process of splitting them apart. Upon completion, the snapshot on which the clone was based will be unlocked in the parent volume. Any snapshots in the clone are removed at the end of processing. Use the 'volume-clone-split-stop' command to stop this process. This command fails if applied to a traditional volume. Cloning is a new capability that applies exclusively to flexible volumes. In Data ONTAP Cluster-Mode, a job is created to perform the split operation. The job id of the job is returned in the API response. The progress of the job can be tracked using the job APIs.
Inputs
- volume => string
Name of the clone that we want split off from its parent volume and snapshot.
Outputs
- result-error-code => integer, optional
error code, if the operation caused an error.
- result-error-message => string, optional
error description, if the operation caused an error.
- result-jobid => integer, optional
The job id of the job that was queued to split the clone volume.
- result-status => string, optional
The operation status. Possible values: "succeeded", "in-progress", "failed".
[Family: vserver]
Display the progress in separating clones from their underlying parent volumes and snapshots. If a clone name is specified, then the split status for that clone is provided. If no clone name is provided, then status is provided for all clones currently being split. This command fails if applied to a traditional volume, and EONTAPI_EVOLNOTFLEX is thrown. Cloning is a capability that applies exclusively to flexible volumes. This command fails if the volume specified is not a clone, and EVOLNOTCLONE is thrown. This command fails if the volume specified is not being split, and EVOLOPNOTUNDERWAY is thrown.Inputs
- volume => string, optional
The name of the clone being split off from its parent volume and snapshot for which we want status.
Outputs
[Family: vserver]
Stop the process of splitting off a clone from its parent volume and snapshot. All of the blocks that were formerly shared between the given clone and its parent volume that have already been split off will remain that way. This command fails if applied to a traditional volume. Cloning is a new capability that applies exclusively to flexible volumes.Inputs
- 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
[Family: vserver]
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
[Family: cluster]
Copy a volume A job will be spawned to operate on the volume and the job id will be returned. The progress of the job can be tracked using the job APIs.Inputs
- vserver => string
The name of the Vserver which owns the volume.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
[Family: vserver]
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
- antivirus-on-access-policy => string, optional
The name of the Anti-Virus On-Access policy. The default policy name is 'default'. If not specified when creating a volume, the Anti-Virus On-Access Policy is inherited from the owning Vserver. Currently, this policy can only be managed using the 'antivirus' command line interfaces.
- 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
- flexcache-cache-policy => string, optional
The name of the FlexCache cache policy. The default policy name is 'default'.
This policy applies only to FlexCache volumes and can be created using the 'flexcache-cache-policy-create' API.
- flexcache-fill-policy => string, optional
The name of the FlexCache prefill policy. The default policy name is 'default'.
This policy applies only to FlexCache volumes and can be created using the 'flexcache-fill-policy-create' API.
- group-id => integer, optional
The UNIX group ID for the volume. The default value is 0 ('root').
- is-junction-active => boolean, optional
This field indicates whether the mounted volume is accessible. The default is true. If the mounted junction path is not accessible, the volume does not appear in the owning Vserver's namespace. This field applies only to Cluster-Mode volumes.
- is-nvfail-enabled => string, optional
If true, the controller performs additional work at boot and takeover times if it finds that there has been any potential data loss in this volume due to an NVRAM failure. For 7-Mode volumes, it causes the invalidation of all NFS file handles on all volumes affected by the problem so that client-side users are forced to remount the affected file system (and thus not continue to use potentially incorrect data).
It is also possible to specify a set of files per volume that are to be renamed out of the way in these cases. The controller sends error messages to the console whenever such problems are found.
For Cluster-Mode volumes, the volume would be put in a special state called 'in-nvfailed-state' such that protocol access is blocked. This will cause the client applications to crash and thus prevent access to stale data on the volume.
To get out of this situation, the admin needs to manually clear the 'in-nvfailed-state' on the volume.
By default, this value is false.
- is-vserver-root => boolean, optional
If true, this volume is the namespace root volume of the Vserver which owns this volume. The default value is false. When creating a volume, if this field is set to true, the new volume is to become the new namespace root volume of the Vserver. This field can be used in a recovery scenario in which the namespace root volume of the Vserver becomes unrecoverable.
- junction-path => string, optional
The Junction Path at which this volume is to be mounted. The fully-qualified pathname in the owning Vserver's namespace at which a volume is mounted. The pathname is case insensitive and must be unique within a Vserver's namespace. Note that this pathname may itself contain junctions, one for each volume (other than the namespace root volume) that provides storage along the pathname's length. As with all fully-qualified pathnames , this string must begin with '/'. In addition, it must not end with '/'.
An example of a valid junction path is: '/user/my_volume'.
Only one volume can be mounted at any given junction path. If an incorrect junction path is specified, EINVALIDINPUTERROR is returned. If another volume is mounted at the specified junction path, EVOLALREADYMOUNTED is returned.
- 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.
- max-dir-size => integer, optional
The maximum size (in bytes) to which any directory in this volume can grow. For 7-Mode volumes, the default setting of 10240 limits directory size to 10 MBytes and allows it to hold up to approximately 300,000 files. For Cluster-Mode volumes, the default setting is 100 MBytes and it allows the directory to hold up to approximately 3,000,000 files. The number of files that the directory actually can hold varies depending on such things as the length of the names and whether it needs to use double-byte UNICODE characters.
Most users should not need to change this field's default setting. It is useful for environments where system users may grow a directory to a size that starts impacting system performance. When a user tries to create a file in a directory that is at the limit, the system returns a ENOSPC error and fails the create.
- percentage-snapshot-reserve => integer, optional
The percentage of disk space that has to be set aside as reserve for snapshot usage. The default value is 5. Range : [0..90] If this argument is not specified for the creation of constituents of an Infinite Volume that does not support storage services, the default reserve is the reserve of the Infinite Volume.
- 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.
- 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.
- snapshot-policy => string, optional
The name of the snapshot policy. The default policy name is 'default'.
This policy can be created using the 'snapshot-policy-create' API. It can be managed using the 'snapshot-policy-*' APIs.
- 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.
- unix-permissions => string, optional
Unix permission bits in octal string format. It's similar to Unix style permission bits:
In Data ONTAP 7-mode, the default setting of '0755' gives read/write/execute permissions to owner and read/execute to group and other users.
In Data ONTAP Cluster-Mode, for security style "mixed" or "unix", the default setting of '0755' gives read/write/execute permissions to owner and read/execute permissions to group and other users. For security style "ntfs", the default setting of '0000' gives no permissions to owner, group and other users.
It consists of 4 octal digits derived by adding up bits 4, 2 and 1. Omitted digits are assumed to be zeros. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. The second digit selects permission for the owner of the file: read (4), write (2) and execute (1); the third selects permissions for other users in the same group; the fourth for other users not in the group.
- user-id => integer, optional
The UNIX user ID for the volume. The default value is 0 ('root').
- 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-security-style => string, optional
The security style associated with this volume. Possible values:
- 'mixed' ... Mixed-style security,
- 'ntfs' ... NTFS/Windows-style security,
- 'unified' .Unified-style security, Unified UNIX, NFS and CIFS permissions (default for Infinite Volume)
- 'unix' ... Unix-style security (default for Flexible Volume)
Security styles don't apply to GX-striped data volumes. Infinite Volumes can only use the 'unified' security style. All other volumes cannot use the 'unified' security style.
- volume-type => string, optional
The type of the volume to be created. Possible values: - "rw" - read-write volume (default setting),
- "ls" - load-sharing volume,
- "dp" - data-protection volume,
- "dc" - data-cache volume (FlexCache)
Outputs
[Family: vserver]
Create an Infinite Volume. This API will select one aggregate from the aggregates assigned to the VServer to create the namespace constituent. The remaining assigned aggregates will be used for data constituents. You must have the aggregates and the Vserver with Infinite Volume created, as well as assigned the aggregates to the Vserver. Infinite Volume creation and expansion operations may involve creation and initialization of Namespace Mirrors. The initialization is started during the creation or expansion operation, but can continue after the Infinite Volume operation has completed. When this happens, the Infinite Volume will be in a 'mixed' state, until the Namespace Mirror initialization is complete. While in a 'mixed' state, further operations of the Infinite Volume are not possible. This API is not supported for Flexible Volumes.Inputs
- data-aggr-list => aggr-name[], optional
Specifies an array of names of aggregates to be used for Infinite Volume data constituents. If this input is not specified all the aggregates assigned to the Vserver are used.
- export-policy => string, optional
The name of the Export Policy to be used by the NFS protocol. The default policy name for Infinite Volumes is 'repos_namespace_export_policy'.
- group-id => integer, optional
The UNIX group ID for the Infinite Volume. The default value for Infinite Volumes is 1.
- is-managed-by-service => boolean, optional
This argument is used to indicate that the Infinite Volume will be managed by storage services. If set to 'true', the client must also provide a name for the 'storage-service' argument.
- is-nvfail-enabled => boolean, optional
If true, the controller performs additional work at boot and takeover times if it finds that there has been any potential data loss in the Infinite Volume constituents due to an NVRAM failure. The Infinite Volume constituents would be put in a special state called 'in-nvfailed-state' such that protocol access is blocked. This will cause the client applications to crash and thus prevent access to stale data.
To get out of this situation, the admin needs to manually clear the 'in-nvfailed-state' on the Infinite Volume constituents.
By default, this value is true.
- junction-path => string, optional
The Junction Path at which the Infinite Volume is to be mounted. The fully-qualified pathname in the owning Vserver's namespace at which the Infinite Volume is mounted. The pathname is case insensitive. This string must begin with '/'. In addition, it must not end with '/', and may only have one element.
An example of a valid junction path is: '/My_InfiniteVolume'. The path '/My_InfiniteVolume/dir' is invalid, as it has two elements.
Only one Infinite Volume can be mounted at any given junction path. If an incorrect junction path is specified, EINVALIDINPUTERROR is returned. If another Infinite Volume is mounted at the specified junction path, EVOLALREADYMOUNTED is returned.
If the junction-path is not specified, the Infinite Volume is mounted at /NS.
- max-data-constituent-size => integer, optional
The maximum size of each data constituent in bytes. The default value is determined by checking the maximum FlexVol size setting on all nodes used by the Infinite Volume. The smallest value found is chosen as the default for the max-data-constituent-size for the Infinite Volume.
- max-dir-size => integer, optional
The maximum size (in bytes) to which any directory in the Infinite Volume namespace can grow. Most users should not need to change this field's default setting. It is useful for environments where system users may grow a directory to a size that starts impacting system performance. When a user tries to create a file in a directory that is at the limit, the system returns a ENOSPC error and fails the create.
- namespace-aggregate => string, optional
The name of the aggregate in which to create the namespace constituent. If not provided, ONTAP will pick the best available aggregate assigned to the Vserver.
- namespace-mirror-aggr-list => aggr-name[], optional
Specifies an array of names of aggregates to be used for Infinite Volume namespace mirror constituents. If this input is not specified all the aggregates assigned to the Vserver are used. If the arguments 'is-managed-by-service' and 'enable-snapdiff' are both set to 'true', a value must be provided.
- size => integer, optional
The initial size of the Infinite Volume in bytes. If size is not specified, then it will use the system default which is the number of constituents times the FlexVol default size.
- snapshot-policy => string, optional
The name of the snapshot policy. This policy can be created using the 'snapshot-policy-create' API. It can be managed using the 'snapshot-policy-*' APIs.
The default policy name is 'default-1weekly'.
- space-guarantee => string, optional
Specifies the type of space guarantee the new Infinite Volume will use. Possible values: none, file, volume. If this argument is not provided, the default guarantee is "volume".
- storage-service => string, optional
Name of the storage service with which to associate the creation of an Infinite Volume. If the client specifies this argument upon Infinite Volume creation, the argument will be used as the initial storage service for constituents of the Infinite Volume.
If the client does not specify this argument upon Infinite Volume creation, the Infinite Volume will be created without support for storage services. Support for storage services can be enabled at a later time using the volume-modify-iter-async API.
- unix-permissions => string, optional
Unix permission bits in octal string format. It's similar to Unix style permission bits:
The default setting of '0755' gives read/write/execute permissions to owner and read/execute permissions to group and other users.
It consists of 4 octal digits derived by adding up bits 4, 2 and 1. Omitted digits are assumed to be zeros. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. The second digit selects permission for the owner of the file: read (4), write (2) and execute (1); the third selects permissions for other users in the same group; the fourth for other users not in the group.
- user-id => integer, optional
The UNIX user ID for the Infinite Volume. The default value is 0.
- volume-name => string
Name of the Infinite Volume to create. The name can contain letters, numbers, and the underscore character (_), but the first character must be a letter or an underscore.
- volume-security-style => string, optional
The security style associated with this volume. Possible values:
- 'mixed' ... Mixed-style security,
- 'ntfs' ... NTFS/Windows-style security,
- 'unified' .Unified-style security, Unified UNIX, NFS and CIFS permissions (default for Infinite Volume)
- 'unix' ... Unix-style security (default for Flexible Volume)
Security styles don't apply to GX-striped data volumes. Infinite Volumes can only use the 'unified' security style. FlexVol volumes cannot use the 'unified' security style.
- volume-state => string, optional
Desired state of the Infinite Volume after it is created. Possible values:
- 'online' (default for Infinite Volumes),
- 'restricted',
- 'offline'
- volume-type => string, optional
The type of the Infinite Volume to be created. Possible values: - 'rw' - read-write Infinite Volume (default),
- 'dp' - data-protection Infinite Volume
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
[Family: vserver]
Destroy the specified volume or plex. If a flexible volume is specified, all of its blocks are freed and returned to its containing aggregate; no other flexible volumes in the same containing aggregate (if any) are affected. If a traditional volume is specified, all of its plexes are destroyed, and its disks are returned to the appropriate spare pool(s). If a plex is specified, it must be for a mirrored aggregate (which could potentially be embedded in a traditional volume), leaving it unmirrored. Only offline volumes and plexes can be destroyed. Plexes are not supported for Cluster-Mode volumes. This API is not supported for Infinite Volumes.
Inputs
- name => string
Name of an existing volume or plex.
Outputs
[Family: vserver]
Destroy an Infinite Volume. The Infinite Volume must be unmounted and must be offline before it can be destroyed. This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents.
Inputs
- volume-name => string
Name of an existing Infinite Volume.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
[Family: cluster, vserver]
Display a list of volumes and their data and metadata footprints in their parent aggregate. The term footprint is used to refer to space that is considered used in an aggregate due to data in a specific volume.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- query => footprint-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the volume-footprint object. All volume-footprint 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 volume-footprint objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster, vserver]
Iterate over a list of volume objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 volume objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
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"
[Family: vserver]
Return calculated volume limits, which are based on the current configuration of the Vserver. If an Infinite Volume already exists on the Vserver, the values returned are in relation to the existing volume. This API is not supported for Flexible Volumes.
Inputs
- data-aggr-list => aggr-name[], optional
Specifies an array of names of aggregates that would be used for Infinite Volume data constituents. If this input is not specified all the aggregates assigned to the Vserver are used. This input is not supported if an Infinite Volume already exists on the Vserver.
- enable-snapdiff => boolean, optional
Whether to enable Snapdiff. If enabled, the namespace mirrors will be calculated for Snapdiff use. The default value is false.
- max-data-constituent-size => integer, optional
The maximum size of each data constituent in bytes. The default value is determined by checking the maximum FlexVol size setting on all nodes used by the Infinite Volume. The smallest value found is chosen as the default for the max-data-constituent-size for the Infinite Volume.
- max-namespace-constituent-size => integer, optional
The maximum size of the namespace constituent in bytes. The default value is 10TB.
- namespace-aggregate => string, optional
The name of the aggregate in which the namespace constituent would be created. If not provided, ONTAP will pick the best available aggregate assigned to the Vserver. This input is not supported if an Infinite Volume already exists on the Vserver.
- namespace-mirror-aggr-list => aggr-name[], optional
Specifies an array of names of aggregates that would be used for Infinite Volume namespace mirror constituents. If this input is not specified all the aggregates assigned to the Vserver are used.
- space-guarantee => string, optional
Identifies the guarantee type for which the volume limits are calculated. If this argument is not provided, the default space guarantee option is 'volume'. Possible values:
- 'none',
- 'volume' (default)
Outputs
[Family: vserver]
Return the name of the "root" volume on the filer. If this request is executed in the context of a vfiler, the "root" volume of the vfiler will be returned. If this request is executed in the context of a Vserver the "namespace root" volume of the Vserver will be returned. If the "namespace root" volume of the Admin Vserver is requested, EVSERVER_OP_NOT_ALLOWED will be returned.Inputs
Outputs
- volume => string
Name of the root volume for the filer.
[Family: vserver]
Return the junction-path of the volume.Inputs
- volume => string
Volume Name
Outputs
[Family: cluster, vserver]
Modify the attributes of a volume or a group of volume objects. This API is not supported for Infinite Volumes.
Inputs
- continue-on-failure => boolean, optional
This input element is useful when multiple volume objects match a given query. If set to true, the API will continue modifying the next matching volume even when modification of a previous volume fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching volume even when the modification of a previous matching volume fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of objects to be modified in this call. Default: 20
- return-failure-list => boolean, optional
If set to true, the API will return the list of volume objects (just keys) that were not modified due to some error. If set to false, the list of volume objects not modified will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of volume objects (just keys) that were successfully updated. If set to false, the list of volume objects modified will not be returned. Default: true
- 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 matching volume objects to be modified.
- num-failed => integer, optional
Number of volume objects that matched the query, but were not modified due to some error.
- num-succeeded => integer, optional
The number of volume objects that matched the query and were successfully updated.
[Family: cluster, vserver]
Modify the attributes of an Infinite Volume or a group of repositories. Infinite Volume creation and expansion operations may involve creation and initialization of Namespace Mirrors. The initialization is started during the creation of expansion operation, but can continue after the Infinite Volume operation has completed. When this happens, the Infinite Volume will be in a 'mixed' state, until the Namespace Mirror initilization is complete. While in a 'mixed' state, further operations of the Infinite Volume are not possible.
This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents. This API does not require any license when operating on an Infinite Volume.
Inputs
- attributes => volume-attributes
Specify at least one modifiable element. Do not specify any other element.
- continue-on-failure => boolean, optional
This input element is useful when multiple volume objects match a given query. If set to true, the API will continue modifying the next matching volume even when modification of a previous volume fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching volume even when the modification of a previous matching volume fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of objects to be modified in this call. Default: 20
- query => volume-attributes
If modifying a specific volume, this input element must specify all keys. If modifying volume objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of volume objects (just keys) that were not modified due to some error. If set to false, the list of volume objects not modified will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of volume objects (just keys) that were successfully updated or scheduled for update. If set to false, the list of volume objects modified will not be returned. Default: true
- 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
- failure-list => volume-modify-iter-async-info[], optional
Information about volume objects that were not modified due to some error. This element will be returned only if input element 'return-failure-list' is true.
- next-tag => string, optional
Tag for the next call. Not present when there are no more matching volume objects to be modified.
- num-failed => integer, optional
Number of volume objects that matched the query, but were not modified due to some error.
- num-succeeded => integer, optional
The number of volume objects that matched the query and were successfully updated or scheduled for update.
- success-list => volume-modify-iter-async-info[], optional
The volume objects that were successfully updated or scheduled for update. This element will be returned only if input element 'return-success-list' is true
[Family: vserver]
Mount a volume on another volume (parent) with a junction-path. This API is not supported on Infinite Volume constituents.Inputs
- activate-junction => boolean, optional
This field optionally specifies whether the mounted volume is accessible. The default is true. If the mounted path is not accessible, it does not appear in the owning Vserver's namespace.
- junction-path => string
The Junction Path. The fully-qualified pathname in the owning Vserver's namespace at which a volume is mounted. The pathname is case insensitive and must be unique within a Vserver's context. Note that this pathname may itself contain junctions, one for each volume (other than the namespace root volume) that provides storage along the pathname's length. As with all fully-qualified pathnames , this string must begin with '/'. In addition, it must not end with '/'. An Infinite Volume has the additional restriction of allowing only one element.
An example of a valid FlexVol junction path is: '/user/my_volume'. An example of a valid Infinite Volume junction path is: '/repository'.
Only one volume can be mounted at any given junction path. If an incorrect junction path is specified, EINVALIDINPUTERROR is returned. If this volume is mounted at a different junction path, or if another volume is mounted at the specified junction path, EVOLALREADYMOUNTED is returned.
- volume-name => string
The name of the volume.
Outputs
[Family: cluster]
Get status of move operationInputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 volume objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
This API is applicable to Data ONTAP 7-Mode as well as Data ONTAP Cluster-Mode. If the API is sent to a Data ONTAP 7-Mode controller, Vol Move will move a single 7-mode flexvol between two aggregates on the same controller. If the API is sent to the Admin Vserver LIF, the flexvol can be moved to any eligible aggregate in the cluster. The list of eligible aggregates can be obtained using the "volume-move-target-aggr-get-iter" API. This API will start the move. It will run a series of checks to determine if the volume can be moved. If any of the checks results in an error or warning, the API will return with an error. The user has to take the necessary corrective action before restarting the move. If all the checks pass, the API will return a success. If "perform-validation-only" is not true, the destination volume will be created and the move will start. By default, the move will cutover automatically. If "perform-validation-only" is set to true, all the errors and warnings encountered from the checks will be returned in the errors-warnings output element. The API will return successfully. The move will not be initiated. When the API is sent to a Data ONTAP 7-Mode controller, if "is-override-warnings" is set to true and the checks return no errors but one or more warnings, the API will return successfully. The warnings will be in the errors-warnings output element. If the API is sent to a Data ONTAP 7-Mode controller, the status of the move can be obtained using the "volume-move-status" API. If the move fails an EMS message will be generated. The reason for the failure can be obtained from the volume-move-status API. After a successful move, the source volume will be destroyed unless the user has specified the "is-keep-source" option. If cutover cannot be completed in the default or user specified number of attempts, an EMS message will be printed and the move will pause. The reason for the pause will be available in the "volume-move-status" API. The user can either resume or abort the move. This is an asynchronous API. If the API is sent to the Admin Vserver LIF, a background job will be created and the API returns immediately with the job ID information. The status of the move job can be obtained by using "job-get" or "job-get-iter" API.Inputs
- cutover-action => string, optional
Specifies the action to be taken for cutover. Possible values are "abort_on_failure", "defer_on_failure", "force" and "wait". Default is "defer_on_failure". If "abort_on_failure" action is specified, the job will try cutover till the cutover-attempts are exhausted, and cleanup if it fails to cutover. If "defer_on_failure" action is specified, the job will try cutover till the cutover-attempts are exhausted and move into "cutover deferred" state if it fails to cutover. This is the default option. The volume move job waits for intervention to restart the cutover process again. If "force" action is specified, the job will try cutover till the cutover-attempts are exhausted and force the cutover at the expense of disrupting the clients. If "wait" action is specified, when the job hits the decision point, it will not go into cutover automatically, instead it will wait for the user to issue a "volume-move-trigger-cutover" command as the signal to try the cutover.
- 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.
- 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
- vserver => string, optional
Name of the Vserver in which the volume to be moved resides. This value is required for C-Mode volumes.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string, optional
The operation status. Possible values: "succeeded", "in_progress", "failed".
[Family: cluster]
Scans aggregates and returns a list of compatible target aggregates for the given volume move operation.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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.
- volume-name => string
Volume Name (Required field)
- vserver => string
Vserver Name (Required field)
Outputs
- next-tag => string, optional
Tag for the next call. Not present when there are no more volume objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Stop a running volume move operation. This is an asynchrous API call and it does not wait for the abort to finish before returning. volume-move-get-iter can be used to monitor the progress of the abort and get the status. Unlike 'job stop', this API makes it possible to stop a move job by the vserver and volume name. If the specified volume has completed the volume move operation, an error is returned.
Inputs
- source-volume => string
The volume that is part of a completed or running volume move operation.
- vserver => string
Vserver Name
Outputs
[Family: cluster]
Trigger cutover of a move jobInputs
- force => boolean, optional
Force cutover
- source-volume => string
The name of the volume.
- vserver => string, optional
Name of the Vserver in which the volume to be moved resides. This value is required for C-Mode volumes.
Outputs
[Family: vserver]
Take the specified volume or plex offline, making it unavailable for both user-level data access and RAID-level access (unless it's a flexible volume, at which time its containing aggregate is not affected in any way, and will remain fully online). The operation takes effect before the API returns except in maintenance mode, when the current root volume may not be taken offline. A volume marked to become the root cannot be taken offline. Taking a flexible volume offline does not affect its containing aggregate in any way. A number of operations being performed on the given volume (or its containing aggregate) can prevent this operation from succeeding, either at all or for various lengths of time. If such operations are found, the system waits up to one second for them to finish. If they don't, the command is aborted. A check is also made for files on the volume opened by internal ONTAP processes. The command is aborted if any are found. Plexes are not supported for Cluster-Mode volumes. This API is not supported for Infinite Volumes.
Inputs
- 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
[Family: vserver]
Take the specified Infinite Volume offline, thereby making it unavailable for data access. The Infinite Volume must be unmounted before it can be made offline. This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents.
Inputs
- volume-name => string
Name of an existing Infinite Volume.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
[Family: vserver]
Bring the specified volume or the plex online. This command takes effect immediately. If there are CIFS shares associated with the volume, they are enabled. Plexes are not supported for Cluster-Mode volumes. This API is not supported for Infinite Volumes.
Inputs
- 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
[Family: vserver]
Bring the specified Infinite Volume online. This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents.
Inputs
- volume-name => string
Name of an existing Infinite Volume.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
[Family: vserver]
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
[Family: vserver]
Renames the specified volume to a new name specified by "new-volume-name". If the volume is referenced in the /etc/exports file, remember to make the name change in /etc/exports also so that the affected file system can be exported by the filer after the filer reboots. The "volume-rename" command does not automatically update the /etc/exports file. This API is not supported for Infinite Volumes.
Inputs
- volume => string
Name of an existing volume.
Outputs
[Family: vserver]
Renames the specified Infinite Volume to a new name specified by "new-volume-name". This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents.
Inputs
- new-volume-name => string
New name of the Infinite Volume.
- volume-name => string
Name of an existing Infinite Volume.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
[Family: vserver]
Restrict the specified volume, making it unavailable for user-level data access but leaving it (or its containing aggregate, if it's a flexible volume) available to internal OnTAP RAID-level access. This API is not supported for Infinite Volumes. This API is not supported on Infinite Volume constituents.
Inputs
- name => string
Name of the volume to restrict.
Outputs
[Family: vserver]
Restrict the specified Infinite Volume making it unavailable for data access. This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents.
Inputs
- volume-name => string
Name of an existing Infinite Volume.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
[Family: vserver]
Set the option named 'option-name' to the value specified by 'option-value' in the specified volume. The change remains effective even after the filer is rebooted. Some options have values that are numbers or strings, and others have values that are 'on' (also expressible as 'yes', 'true', or '1' ) or "off" (also expressible as 'no', 'false', or '0'). A mixture of uppercase and lowercase characters may be used for an option's value. Note that the 'root' option is special in that it does not have an associated value. Also, note that some of these options can NOT be set for a flexible volume, as they relate only to aggregates (either free-standing ones or those embedded in traditional volumes). Other options may only apply for flexible volumes.Inputs
- 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
[Family: vserver]
Set a volume's 'files-total' value to the given quantity. This specifies the maximum number of user-visible files that the given volume can hold, as reported by the 'files-total' value within: - the 'volumes' output parameter of the Data ONTAP 7-Mode 'volume-list-info' API, and - the 'attributes-list' output parameter of the Data ONTAP Cluster-Mode 'volume-get-iter' API. Note that this interface corresponds to the following Data ONTAP 7-Mode 'maxfiles' console command and Data ONTAP Cluster-Mode 'volume modify' console command: 'maxfiles <vol-name> <requested_new_max>' 'volume modify -vserver <vserver-name> -volume <volume-name%gt -files <requested_new_max>'Inputs
- 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]
[Family: vserver]
Given the name of a flexible volume, either return its current size or set the volume's size to the stated amount. This API is not supported for Infinite Volumes. Also, this API does not allow to set the volume's size from vFiler context.
Inputs
- 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).
[Family: vserver]
Given the name of an Infinite Volume, either return its current size or set the Infinite Volume's size to the stated amount. This API is not supported for Flexible Volumes. This API is not supported on Infinite Volume constituents.
Inputs
- new-size => string, optional
Specify the Infinite Volume's new size using the following format: [+|-]< number > [k|m|g|t|p] If a leading '+' or '-' appears, it indicates that the given Infinite 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', 't', and 'p' indicates the desired units, namely 'kilobytes', 'megabytes', 'gigabytes', 'terabytes', and 'petabytes' (respectively). If the trailing unit character doesn't appear, then < number > is interpreted as the number of kilobytes desired. The file system size of a readonly Infinite Volume, such as a snapmirror destination, is determined from the snapmirror source. In such cases, the value set using this API is interpreted as an upper limit on the size. An Infinite Volume that's not a snapmirror destination 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 snapmirror destination Infinite Volume size in order to maintain enough capacity to accommodate transfers from the replica source. Attempting to set a readonly snapmirror destination size to be less than that of its source will result in a failure indicated by the EONTAPI_ENOSPC error code. If this input is specified, the size modification occurs asynchronously, and the 'volume-size' output is not returned to the caller. Infinite Volume creation and expansion operations may involve creation and initialization of Namespace Mirrors. The initialization is started during the creation or expansion operation, but can continue after the Infinite Volume operation has completed. When this happens, the Infinite Volume will be in a 'mixed' state, until the Namespace Mirror initialization is complete. While in a 'mixed' further operations of the Infinite Volume are not possible. This parameter is not supported on Infinite Volumes that are managed by storage services.
- volume-name => string
The name of the Infinite Volume.
Outputs
- result-error-code => integer, optional
Error code, if the operation caused an error.
- result-error-message => string, optional
Error description, if the operation caused an error.
- result-jobid => integer, optional
Job Id, if this operation was performed via a job.
- result-status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
- volume-size => string, optional
The size of the Infinite Volume. This output is returned only if the caller is querying the the size and is not modifying it by specifying the 'new-size' input parameter.
[Family: cluster, vserver]
Display a list of volumes and a breakup of their used space. This information is only available when the volume is onlineInputs
- desired-attributes => space-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 => space-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the volume-space object. All volume-space 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 volume-space objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster, vserver]
Iterate over a list of volume-storage-service objects.Inputs
- max-records => integer, optional
The maximum number of records to return in this call. Default: 20
- 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 volume-storage-service objects to return.
- num-records => integer
The number of records returned in this call.
[Family: vserver]
Volume Storage Service RenameInputs
- volume => string
Volume Name
Outputs
[Family: cluster]
Transition a volume between 7-Mode and Cluster-Mode. Currently the only supported operation type is transitioning a 7-Mode Flexible Volume that has been copied from a 7-Mode Filer for the purpose of transitioning it to a Cluster-Mode Flexible Volume. A job-id will be returned that can be used to query to progress of the transition job.Inputs
- non-disruptive => boolean, optional
A 'true' value indicates that only a non-disruptive transition will be accepted. This is not available for all volume configurations. If a value is not specified, this field will default to true - non-disruptive desired.
- operation-type => string, optional
The type of transition operation; Possible values are: "copy_based" (default) "in_place" "untransition" Copy Based Transition is currently the only supported mode for transition; "in_place" and "untransition" should only be used in testing scenarios.
- override-warnings => boolean, optional
A 'true' value indicates that all warnings will be ignored as a part of the transition process. The system will select default values as appropriate. If not specified, values will not be overridden.
Outputs
- job-id => integer
Job id which can be used to query the status of the process.
[Family: cluster]
Check to see if a desired volume transition can be performed from one volume type to another. Only 7-mode flexible volume to cluster-mode flexible volume and vice versa with limited options are supported at this time.Inputs
- destination-vserver-name => string, optional
The name of the vserver into which a volume is being transitioned.
- non-disruptive => boolean, optional
A 'true' value indicates that only a non-disruptive transition will be accepted. This is not available for all volume configurations. If a value is not specified, this field will default to true - non-disruptive desired.
- operation-type => string, optional
The type of transition operation; Possible values are: "copy_based" (default) "in_place" "untransition" Copy Based Transition is currently the only supported mode for transition; "in_place" and "untransition" should only be used in testing scenarios.
- override-warnings => boolean, optional
A 'true' value indicates that all warnings will be ignored as a part of the transition process. The system will select default values as appropriate. If not specified, values will not be overridden.
- source-node => string
The name of the node where the target volumes reside.
Outputs
[Family: cluster]
Transition a volume from one type to another. Delete the logged information about a transition operation.Inputs
- destination-vserver-name => string, optional
The name of the containing vserver for the volume, if applicable.
- operation-type => string, optional
The type of transition operation; Possible values are: "transition" (default) "untransition" Transition is currently the only supported mode; "untransition" should only be used in testing scenarios.
- volume-name => string
Volumes to delete the transition log from.
Outputs
[Family: cluster]
Retrieve the logged information about a transition operation.Inputs
- desired-features => string[], optional
The list of the specific features whose log records are desired by the caller. The caller can either specify a list of features or "all" to include all phases. If this argument is not provided, then it is equivalent to setting 'desired-features' to 'all'.
- desired-levels => string[], optional
The list of the specific level log records which are desired by the caller. The caller can either specify a list of levels or "all" to include all levels. Possible values:
- all
- error
- warning
- info
- debug
- trace
If this argument is not provided, then it is equivalent to setting 'desired-levels' to 'all'.
- desired-phases => string[], optional
The list of the specific phases whose log records are desired by the caller. To receive all phases, "all" can be specified. Possible values: - all
- check
- lock_config
- prepare
- pre_commit
- commit
- post_commit
- online
- rollback
- cleanup
- unlock_config
- complete
If this argument is not provided, the default is 'all'.
- destination-vserver-name => string, optional
The name of the containing vserver for the volume, if applicable.
- operation-type => string, optional
The type of transition operation; Possible values are: "transition" (default) "untransition" Transition is currently the only supported mode; "untransition" should only be used in testing scenarios.
- source-node => string, optional
Node owning the 7-Mode volumes being transitioned.
- tag => string, optional
Value to use to get next entry.
- volume-name => string
Volume to obtain transition log information from.
Outputs
- num-records => integer
Number of records being returned.
[Family: cluster, vserver]
Fence access to volume during Transition.Inputs
- is-enabled => boolean
Protection Enabled
- volume => string
The name of the volume.
- vserver => string
The name of the Vserver which owns the volume.
Outputs
[Family: vserver]
Unmount a volume from its parent volume and delete the junction path at which the volume is mounted. This API is not supported on Infinite Volume constituents.Inputs
- force => boolean, optional
This specifies whether the volume unmount operation is forced or not. The default value is false. Under certain circumstances, such as an unexpected reboot while in the middle of unmounting, the unmount operation might find that after the reboot, it is unable to delete the junction path at which the volume is mounted in the file system. In this situation, if the force option is set to false, the unmount operation is failed (EJUNCTIONDELETEFAILED), leaving the junction path information intact in the Volume Management Database. Instead, if the force option is set to true, the unmount operation proceeds to delete the junction path information in the Volume Management Database, irrespective of any failure to delete the junction path in the file system.
- volume-name => string
The name of the volume.
Outputs
[Family: cluster]
Create a new Vserver. Use a fully qualified domain name(FQDN) - for example, 'data.example.com' - for the Vserver name to reduce name collisions in cluster leagues.Inputs
- antivirus-on-access-policy => antivirus-policy, optional
Antivirus policy. When specified as part of vserver-create, this field represents the antivirus on access policy for the Vserver. When specified as part vserver-get-iter call, this will return the list of matching Vservers. default: default
- comment => string, optional
Comment. When specified as part of a vserver-create, this field represents the comment associated with the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers.
- is-repository-vserver => boolean, optional
Specifies if this Vserver is a Vserver with Infinite Volume. When part of vserver-get-iter call, this will return the list of matching Vservers. Default value is false. Prior to Data ONTAP 8.2.0, Vserver with Infinite Volume is called repository Vserver and once a repository Vserver is created in a cluster, additional Vservers cannot be created. Conversely, a repository Vserver cannot be created if non-repository Vservers already exist in a cluster.
- language => language-code, optional
Language to use for the Vserver. Default: C.UTF-8. 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'. When specified as part of vserver-create, this field represents the language used for the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers with the specified language. The values with the '*' suffixes are not supported by Clustered ONTAP.
- name-mapping-switch => nmswitch[], optional
Name Mapping switch configuration details for the Vserver. When specified as part of the vserver-create, this field represents the list of Name Mapping switch configurations to be used. When specified as part of the vserver-get-iter, this will return the list of Vservers which have any of the specified Name Mapping configurations as part of their nm-switch configuration. Possible values: 'file', 'ldap'. default: file Possible values:
- name-server-switch => nsswitch[]
Name Server switch configuration details for the Vserver. When specified as part of the vserver-create, this field represents the list of Name Server switch configurations to be used. When specified as part of the vserver-get-iter, this will return the list of Vservers which have any of the specified Name Server configurations as part of their ns-switch configuration. Possible values: 'nis', 'file', 'ldap'. Possible values:
- quota-policy => string, optional
Quota policy. When specified as part of vserver-create, this field represents the quota policy for the Vserver. When specified as part vserver-get-iter call, this will return the list of matching Vservers. default: default
- return-record => boolean, optional
If set to true, returns the vserver on successful creation. Default: false
- root-volume => volume-name
Root volume of the Vserver. When specified as part of a vserver-create, this field represents the name of the Vserver root volume. When part of vserver-get-iter call, this will return the list of matching Vservers.
- root-volume-aggregate => aggr-name
The aggregate on which the root volume will be created. When specified as part of a vserver-create, this field represents the aggregate on which the Vserver root volume will be created. When part of vserver-get-iter call, this will return the list of matching Vservers.
- root-volume-security-style => security-style-enum
Security Style of the root volume. When specified as part of the vserver-create, this field represents the security style for the Vserver root volume. When specified as part of vserver-get-iter call, this will return the list of matching Vservers. Possible values: 'unix', 'ntfs', 'mixed'. The 'unified' security style, which applies only to Infinite Volumes, cannot be applied to a Vserver's root volume. Possible values: - "unix" - NFS,
- "ntfs" - CIFS,
- "mixed" - Mixed,
- "unified" - Unified
- snapshot-policy => snapshot-policy, optional
Default snapshot policy setting for all volumes of the Vserver. This policy will be assigned to all volumes created in this Vserver unless the volume create request explicitly provides a snapshot policy or volume is modified later with a specific snapshot policy. A volume-level snapshot policy always overrides the default Vserver-wide snapshot policy. When specified as part vserver-get-iter call, this will return the list of matching Vservers. default: default
- vserver-name => string
Name of the Vserver. When specified as part of a vserver-create, this field represents the name of the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers.
Outputs
[Family: vserver]
Export a data policy for a Vserver with an Infinite Volume. The data policy is exported as a JSON string. For a description of the JSON format, please refer to the Data ONTAP System Administration Guide for Cluster-Mode.Inputs
Outputs
[Family: vserver]
Import a data policy for a Vserver with an Infinite Volume. The data policy is imported as a JSON string. For a description of the required JSON format, please refer to the Data ONTAP System Administration Guide for Cluster-Mode.Inputs
- data-policy-expression => string
Data-policy JSON expression. A JSON string with a maximum length of 50 MB. The string should be XML escaped and use the same encoding as the XML document of which it is a part (UTF8 for APIs).
Outputs
[Family: vserver]
Validate without importing a data policy for a Vserver with an Infinite Volume. The data policy needs to be specified as a JSON string. For a description of the required JSON format, please refer to the Data ONTAP System Administration Guide for Cluster-Mode.Inputs
- expression => string
Data-policy JSON expression. A JSON string with a maximum length of 50 MB. The string should be XML escaped and use the same encoding as the XML document of which it is a part (UTF8 for APIs).
Outputs
[Family: cluster]
Destroys the Vserver and its objects. All volumes and mirrors belonging to the Vserver must be deleted using other APIs before destroying the Vserver. EVOLEXISTS is returned if the Vserver is found to have any volumes or mirrors. This APIS removes all other objects of this Vserver including its network Interfaces, routes, configurations, admin login accounts and roles.Inputs
- vserver-name => string
Name of the Vserver. When specified as part of a vserver-create, this field represents the name of the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers.
Outputs
[Family: vserver]
Get the attributes of the vserver.Inputs
Outputs
[Family: cluster, vserver]
Display information about Vservers. Information about Admin Vserver, Node Vserver, and Data Vservers is displayed. If the ZAPI is issued to the Cluster LIF with no Vserver specified as input, then information about all Vservers is shown. If the request is sent to the Vserver LIF, then information about that Vserver is shown.Inputs
- desired-attributes => vserver-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 => vserver-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the vserver object. All vserver 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 vserver objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modify the attributes of vserver object.Inputs
- aggr-list => aggr-name[], optional
List of aggregates assigned for volume operations. These aggregates could be shared for use with other Vservers. When specified as part of a vserver-create, this field represents the list of aggregates that are assigned to the Vserver for volume operations. When part of vserver-get-iter call, this will return the list of Vservers which have any of the aggregates specified as part of the aggr-list.
- allowed-protocols => protocol[], optional
Allowed Protocols. If conflicting entries are provided as input to allowed-protocols and disallowed-protocols list, then those entries will become part of the disallowed-protocols list. When specified as part of a vserver-create, this field represent the list of protocols allowed on the Vserver. When part of vserver-get-iter call, this will return the list of Vservers which have any of the protocols specified as part of the allowed-protocols. Possible values: - "nfs" - NFS protocol,
- "cifs" - CIFS protocol,
- "fcp" - FCP protocol,
- "iscsi" - iSCSI protocol,
- "ndmp" - NDMP protocol
- antivirus-on-access-policy => antivirus-policy, optional
Antivirus policy. When specified as part of vserver-create, this field represents the antivirus on access policy for the Vserver. When specified as part vserver-get-iter call, this will return the list of matching Vservers. default: default
- comment => string, optional
Comment. When specified as part of a vserver-create, this field represents the comment associated with the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers.
- disallowed-protocols => protocol[], optional
Disallowed Protocols. If conflicting entries are provided as input to allowed-protocols and disallowed-protocols list, then those entries will become part of the disallowed-protocols list. When specified as part of a vserver-create, this field represent the list of protocols not allowed on the Vserver. When part of vserver-get-iter call, this will return the list of Vservers which have any of the protocols specified as part of the disallowed-protocols. Possible values: - "nfs" - NFS protocol,
- "cifs" - CIFS protocol,
- "fcp" - FCP protocol,
- "iscsi" - iSCSI protocol,
- "ndmp" - NDMP protocol
- language => language-code, optional
Language to use for the Vserver. Default: C.UTF-8. 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'. When specified as part of vserver-create, this field represents the language used for the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers with the specified language. The values with the '*' suffixes are not supported by Clustered ONTAP.
- max-volumes => string, optional
Maximum number of volumes that can be created on the Vserver. When specified as part of a vserver-create, this field represents the maximum number of volumes that can be created on the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers.
- name-mapping-switch => nmswitch[], optional
Name Mapping switch configuration details for the Vserver. When specified as part of the vserver-create, this field represents the list of Name Mapping switch configurations to be used. When specified as part of the vserver-get-iter, this will return the list of Vservers which have any of the specified Name Mapping configurations as part of their nm-switch configuration. Possible values: 'file', 'ldap'. default: file Possible values:
- name-server-switch => nsswitch[], optional
Name Server switch configuration details for the Vserver. When specified as part of the vserver-create, this field represents the list of Name Server switch configurations to be used. When specified as part of the vserver-get-iter, this will return the list of Vservers which have any of the specified Name Server configurations as part of their ns-switch configuration. Possible values: 'nis', 'file', 'ldap'. Possible values:
- qos-policy-group => string, optional
The QoS policy group associated with this volume. This optionally specifies which QoS policy group to apply to the Vserver. The policy group defines measurable service level objectives (SLOs) that apply to the storage objects with which the policy group is associated. If you do not assign a policy group to a Vserver, the system will not monitor and control traffic to it. This parameter is not supported on a Vserver with Infinite Volume.
- quota-policy => string, optional
Quota policy. When specified as part of vserver-create, this field represents the quota policy for the Vserver. When specified as part vserver-get-iter call, this will return the list of matching Vservers. default: default
- snapshot-policy => snapshot-policy, optional
Default snapshot policy setting for all volumes of the Vserver. This policy will be assigned to all volumes created in this Vserver unless the volume create request explicitly provides a snapshot policy or volume is modified later with a specific snapshot policy. A volume-level snapshot policy always overrides the default Vserver-wide snapshot policy. When specified as part vserver-get-iter call, this will return the list of matching Vservers. default: default
- state => vsadminstate, optional
State of the Vserver. This field represents the data serving ability of a Vserver, hence is applicable only for Data Vservers. Possible values: - "running" ,
- "stopped" ,
- "starting" ,
- "stopping" ,
- "initializing" ,
- "deleting"
- vserver-name => string
Name of the Vserver. When specified as part of a vserver-create, this field represents the name of the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers.
Outputs
[Family: cluster]
Modify the attributes of vserver or a group of vserver objects.Inputs
- attributes => vserver-info
Specify at least one modifiable element. Do not specify any other element.
- continue-on-failure => boolean, optional
This input element is useful when multiple vserver objects match a given query. If set to true, the API will continue modifying the next matching vserver even when modification of a previous vserver fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching vserver even when the modification of a previous matching vserver fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of objects to be modified in this call. Default: 20
- query => vserver-info
If modifying a specific vserver, this input element must specify all keys. If modifying vserver objects based on query, this input element must specify a query.
- return-failure-list => boolean, optional
If set to true, the API will return the list of vserver objects (just keys) that were not modified due to some error. If set to false, the list of vserver objects not modified will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of vserver objects (just keys) that were successfully updated. If set to false, the list of vserver objects modified will not be returned. Default: true
- 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 matching vserver objects to be modified.
- num-failed => integer, optional
Number of vserver objects that matched the query, but were not modified due to some error.
- num-succeeded => integer, optional
The number of vserver objects that matched the query and were successfully updated.
[Family: cluster]
Rename a Vserver. Use a fully qualified domain name(FQDN) - for example, 'data.example.com' - for the Vserver name to reduce name collisions in cluster leagues. This operation is not supported for a node Vserver. Use the 'system-node-rename' API to rename a node Vserver.Inputs
- new-name => string
New Vserver name (Use Fully Qualified Domain Name, For example: data.example.com)
- vserver-name => string
Vserver
Outputs
[Family: cluster]
Start a VserverInputs
- vserver-name => string
Name of the Vserver. When specified as part of a vserver-create, this field represents the name of the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers.
Outputs
[Family: cluster]
Stop a VserverInputs
- vserver-name => string
Name of the Vserver. When specified as part of a vserver-create, this field represents the name of the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers.
Outputs
[Family: cluster]
Accept a pending Vserver peer relationshipInputs
- vserver => string
Specifies name of the local Vserver in the relationship
Outputs
[Family: cluster]
Create a new Vserver peer relationship between two existing VserversInputs
- peer-vserver => string
Specifies name of the peer Vserver in the relationship
- vserver => string
Specifies name of the local Vserver in the relationship
Outputs
[Family: cluster]
Delete a Vserver peer relationshipInputs
- force => boolean, optional
Force Delete
- peer-vserver => string
Specifies name of the peer Vserver in the relationship
- vserver => string
Specifies name of the local Vserver in the relationship
Outputs
[Family: vserver]
Display information about Vserver peer relationships. Displays the local Vserver, peer Vserver and the state of the peering relationship.Inputs
- peer-vserver => string
Specifies name of the peer Vserver in the relationship
Outputs
[Family: cluster, vserver]
Display information about Vserver peer relationships. If the API is issued to the Cluster LIF, then information about all Vservers is shown. If the request is sent to the Vserver LIF, then information about that Vserver is shown.Inputs
- desired-attributes => vserver-peer-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
- 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 vserver-peer objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modify a Vserver peer relationshipInputs
- applications => vserver-peer-application[]
Applications which can make use of the peering relationship. Possible value: 'snapmirror'.
- peer-vserver => string
Specifies name of the peer Vserver in the relationship
- vserver => string
Specifies name of the local Vserver in the relationship
Outputs
[Family: cluster]
Reject a Vserver peer relationshipInputs
- peer-vserver => string
Specifies name of the peer Vserver in the relationship
- vserver => string
Specifies name of the local Vserver in the relationship
Outputs
[Family: cluster]
Resume a Vserver peer relationshipInputs
- force => boolean, optional
Force Resume
- peer-vserver => string
Specifies name of the peer Vserver in the relationship
- vserver => string
Specifies name of the local Vserver in the relationship
Outputs
[Family: cluster]
Suspend a Vserver peer relationshipInputs
- force => boolean, optional
Force Suspend
- peer-vserver => string
Specifies name of the peer Vserver in the relationship
- vserver => string
Specifies name of the local Vserver in the relationship
Outputs
[Family: cluster]
Create a new transition peer relationship between a Data ONTAP 7-Mode system and a Data ONTAP Cluster-Mode VserverInputs
- return-record => boolean, optional
If set to true, returns the vserver-peer-transition on successful creation. Default: false
Outputs
[Family: cluster]
Deletes a transition peer relationshipInputs
- local-vserver => vserver-name
Local Vserver name
- src-filer-name => string
Source 7-Mode system
Outputs
[Family: cluster]
Deletes multiple transition peer relationshipInputs
- continue-on-failure => boolean, optional
This input element is useful when multiple vserver-peer-transition objects match a given query. If set to true, the API will continue deleting the next matching vserver-peer-transition even when the deletion of a previous vserver-peer-transition fails. If set to false, the API will return on the first failure. Default: false
- max-failure-count => integer, optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching vserver-peer-transition even when the deletion of a previous matching vserver-peer-transition fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
- max-records => integer, optional
The maximum number of vserver-peer-transition objects to delete in this call. Default: 20
- return-failure-list => boolean, optional
If set to true, the API will return the list of vserver-peer-transition objects (just keys) that were not deleted due to some error. If set to false, the list of vserver-peer-transition objects not deleted will not be returned. Default: true
- return-success-list => boolean, optional
If set to true, the API will return the list of vserver-peer-transition objects (just keys) that were successfully deleted. If set to false, the list of vserver-peer-transition objects deleted will not be returned. Default: true
- 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 matching vserver-peer-transition objects to be deleted.
- num-failed => integer, optional
Number of vserver-peer-transition objects that matched the query, but were not deleted due to some error.
- num-succeeded => integer, optional
The number of vserver-peer-transition objects that matched the query and were successfully deleted.
[Family: cluster, vserver]
Gets a transition peer relationship.Inputs
- local-vserver => vserver-name
Local Vserver name
- src-filer-name => string
Source 7-Mode system
Outputs
[Family: cluster, vserver]
Gets list of transition peer relationship.Inputs
- desired-attributes => vserver-peer-transition-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 => vserver-peer-transition-info, optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the vserver-peer-transition object. All vserver-peer-transition 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 vserver-peer-transition objects to return.
- num-records => integer
The number of records returned in this call.
[Family: cluster]
Modifies a transition peer relationshipInputs
- local-vserver => vserver-name
Local Vserver name
- multi-path-address => string, optional
Additional address for source 7-Mode system
- src-filer-name => string
Source 7-Mode system
Outputs
[Family: vserver]
Returns the status of the previously issued asynchronous Consistency Point operations.Inputs
Outputs
- status => string, optional
Status information about the previous CP request on volume. Possible values: - "failed",
- "in_progress",
- "succeeded".
[Family: vserver]
Forces a WAFL consistency point (CP) in order to reduce the time for succeeding fence and snapshot related operations. In Data ONTAP 7-Mode this call is synchronous and will not return until the CP has completed. In Data ONTAP Cluster-Mode this API is asynchronous and will return immediately as soon as the CP is scheduled. The wafl-get-sync-status API can be used to check status of the previously scheduled CP. Two uses of this API 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
Information related to 64-bit upgrade.Fields
Attributes of an aggregate. 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
- aggregate-uuid => string, optional
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
- nodes => node-name[], optional
List of node names. If aggregate-name is also specified, then the matching aggregate on given nodes is returned. If not, all aggregates on specified nodes are returned. If this element is omitted when the request is sent to the Admin Vserver LIF, then all matching aggregates in the cluster are returned.
Information returned when upgrade-64bit-mode in aggr-add API is "check".Fields
- added-space => integer, optional
The effective total space that would be added (in bytes) to the aggregate. This would not include the blocks used by the 64-bit upgrade of the aggregate and its contained flexible volumes. Range: [0..2^64-1].
- check-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 previous 64-bit upgrade check failed. 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.
- cookie => integer, optional
The opaque cookie to uniquely identify a 64-bit upgrade transaction previously triggered on the aggregate using aggr-add API. Range: [0..2^64-1].
File system specific information about the aggregate.Fields
- block-type => string, optional
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"
- type => string, optional
The type of aggregate. Possible values: aggr, trad "aggr" (for aggregates that can contain flexible volumes) "trad" (for aggregates embedded in traditional volumes)
A structure returning inode-related information for a given aggregate's Active File System (AFS).Fields
- files-private-used => integer, optional
[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.
- files-total => integer, optional
[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.
- files-used => integer, optional
[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.
- inodefile-private-capacity => integer, optional
[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.
- inodefile-public-capacity => integer, optional
[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.
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.
Ownership information about the aggregate.Fields
- 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'
- owner-id => integer, optional
NVRAM ID of node to which the aggregate ownership has been assigned. 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.
- owner-name => string, optional
Name of node to which the aggregate ownership has been assigned. 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.
Performance specific attributes of the aggregateFields
- free-space-realloc => string, optional
Returns the free space reallocation state of the 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 is "off"
- 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"
RAID specific information of the aggregateFields
- cache-raid-group-size => integer, optional
Current maximum cache RAID group size of hybrid aggregate. RAID group size is the maximum number of disks that can be added to a RAID group. This information will only be returned for a hybrid aggregate i.e. whose "is-hybrid" field is set to true.
- checksum-status => string, optional
Checksum status. Possible values: "active", "initializing", "none", "off", "reinitialized", "reinitializing", "reverting", "unknown", "upgrading_phase1", "upgrading_phase2" This information will not be returned for a striped aggregate.
- checksum-style => string, optional
Checksum style. The possible values: - "advanced_zoned" - advanced_zoned checksum (azcs),
- "block" - block,
- "mixed" - mixed,
- "none" - none,
- "unknown" - unknown
- "wafl" - wafl,
- "zoned" - zoned.
- disk-count => integer, optional
Number of disks in the aggregate.
- has-local-root => boolean, optional
Whether the aggregate contains the local root volume. This information will not be returned for a striped aggregate. Default value is false.
- mirror-status => string, optional
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 . This information will not be returned for a striped aggregate.
- mount-state => string, optional
[not settable, always] This field shows the volume's mount state. Possible values: "creating", "destroying", "frozen", "inconsistent", "iron_restricted", "mounting", "online", "quiescing", "quiesced", "reverted", "unmounted", "unmounting" This information will not be returned for a striped aggregate.
- 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-size => integer, optional
Current RAID group size. This information will not be returned for a striped aggregate.
- raid-status => string, optional
RAID status. Possible values: "copying", "degraded", "foreign", "growing", "initializing", "invalid", "ironing", "mirror degraded", "mirrored", "needs check", "normal", "noparity", "out-of-date", "partial", "reconstruct", "raid0", "raid4", "raid_dp", "mixed_raid_type", "resyncing", "SnapMirrored", "verifying". These values may appear by themselves or in combination separated by commas (e.g., "reconstruct,growing"). For striped aggregate, additional possible value is "various". For details on raid-type, refer description of element 'raid-type' below
- raid-type => string, optional
Possible values: - "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).
- state => string, optional
Aggregate State Possible values: - "creating" ,
- "destroying" ,
- "failed" ,
- "frozen" ,
- "inconsistent" ,
- "iron_restricted" ,
- "mounting" ,
- "online" ,
- "offline" ,
- "partial" ,
- "quiesced" ,
- "quiescing" ,
- "restricted" ,
- "reverted" ,
- "unknown" ,
- "unmounted" ,
- "unmounting" ,
- "relocating"
Aggregate Information 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
- aggregate => string, optional
Aggregate Name Attributes: non-creatable, non-modifiable
- destination => string, optional
Destination for Relocation Attributes: non-creatable, non-modifiable
- relocation-status => string, optional
Aggregates Relocation Status Attributes: non-creatable, non-modifiable Possible values include: - Done
- Failed
- In progress
- Not attempted yet
- Failed: Migration of the aggregate failed
- Failed: Node is being shut down
- Failed: Aggregate does not have SFO HA policy
- Failed: Aggregate is in failed or limbo state.
- Failed to offline the aggregate
- Failed: Aggregate is being given back or relocated
- Failed: Operation was vetoed
- No aggregates to relocate
- Performing relocation veto checks
- check EMS logs
- Failed: Node cannot communicate with the destination node
- Failed: Destination node did not online the aggregate on time
- Failed: Destination node failed to online the aggregate. Check EMS logs on destination node
- Failed: Destination cannot receive the aggregate
- Failed: Aggregate is restricted
- Failed: Aggregate does not have disks
- Operation was aborted
- Failed: Aggregate is foreign
- Failed: Aggregate is offline
- Failed: Mirrored aggregate does not have both plexes online
- Aborted. Failed to disable background disk firmware updates on the source node.
- Aborted. Failed to disable background disk firmware updates on the destination node.
- Deferred. Background disk firmware update is in progress on source node.
- Deferred. Background disk firmware update is in progress on destination node.
- source-node => string, optional
Name of the source node in which aggregate resides Attributes: key, non-creatable, non-modifiable
Snaplock specific information of the aggregateFields
- 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"
SnapMirror specific information of the aggregateFields
A structure returning consolidated size-related information for all snapshots of the given aggregate.Fields
- files-total => integer, optional
[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.
- files-used => integer, optional
[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.
- maxfiles-available => integer, optional
[not settable, always] The count of the maximum number of files allowable on the referenced file system.
- maxfiles-possible => integer, optional
[not settable, always] The largest value to which the maxfiles-available parameter can be increased by reconfiguration, on the referenced file system.
- maxfiles-used => integer, optional
[not settable, online-only] The count of the number of files currently in use on the referenced file system.
- percent-inode-used-capacity => integer, optional
[not settable, online-only] The percentage of disk space currently in use based on file (inode) count on the referenced file system.
- 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.
- 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.
- 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.
A structure returning space-related information for a given aggregate's Active File System (AFS).Fields
- 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.
- percent-used-capacity => integer, optional
[not settable, online-only] The percentage of disk space currently in use on the referenced file system.
- 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.
- 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 of 0 is returned.
- 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.
- total-reserved-space => integer, optional
[not settable, online-only] 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.
Information returned when upgrade-64bit-mode in aggr-add API is "grow_all", "grow_none", or "grow_reserved".Fields
- 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].
- start-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 a previous 64-bit upgrade failed. Possible values include: EAGGR_64BIT_UPGRADE_ENOSPC EVOLUME_64BIT_UPGRADE_VVOL_ENOSPC EVOLUME_64BIT_UPGRADE_VVOL_ENOSPC_OVERWRITE EVOLUME_64BIT_UPGRADE_KIREETI_NOT_AVAIL EVOLUME_64BIT_UPGRADE_PREQUAL_NOT_AVAIL
Status information related to 64-bit upgrade. This information includes whether the 64-bit upgrade is in progress.Fields
Striping specific information of a striped aggregate This information will not be returned for the not-striped aggregate.Fields
WAFL volume count specific information of the aggregateFields
WAFL-iron specific information of the aggregateFields
- 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".
- state => string, optional
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:
"aborting" - wafliron is aborting.
"checking_lost_blocks" - wafliron is checking for lost blocks.
"checking_lost_inodes" - wafliron is checking link counts.
"finishing" - wafliron is cleaning up.
"not_running" - wafliron is not running on this aggregate.
"scanning" - wafliron is scanning inodes, and/or fixing file system inconsistencies.
"starting" - wafliron is starting, allocating, and/or in the initial mounting phase.
"unknown" - wafliron state could not be determined.
- 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".
Information for each disk in the plex.Fields
- name => string
Name of a member disk.
Name of the node.Fields
Information about a plex.Fields
- 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.
Information about a raidgroup.Fields
- checksum-style => string, optional
Checksum style for the RAID group. The possible values are: "none", "zoned", "block", "wafl", "unknown" or "advanced_zoned".
Striping information of aggregate. Allowed values are: - "striped": Member of stripe.
- "not_striped": Not member of stripe.
- "unknown": Not known.
Fields
Information about mirror verification.Fields
- name => string
Name of the aggregate.
Warning codes for pre-check mode.Fields
Antivirus policy nameFields
Antivirus engine options 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
- cache-size => integer, optional
Max Cache Size for Scanning Files (MB) Attributes: non-creatable, modifiable
- decompressed-file-count-limit => integer, optional
File count to decompress in archive Attributes: non-creatable, modifiable
- decompressed-file-size-limit => integer, optional
Max size of files in archive Attributes: non-creatable, modifiable
- decompression-layers-limit => integer, optional
Max layers to traverse in archive Attributes: non-creatable, modifiable
- decompression-size-factor => integer, optional
Max decompression size factor of files in archive Attributes: non-creatable, modifiable
- group-archive-unpack => boolean, optional
Scan archive file formats Attributes: non-creatable, modifiable
- heuristic-analysis => boolean, optional
Heuristic Virus Search Analysis Attributes: non-creatable, modifiable
- is-spyware-enabled => boolean, optional
Spyware enable/disable Attributes: non-creatable, modifiable
- macro-analysis => boolean, optional
Macro Virus Search Analysis Attributes: non-creatable, modifiable
- max-recursion-depth => integer, optional
Max recursion depth into archives Attributes: non-creatable, modifiable
- mime-lines-to-scan => integer, optional
Max Lines to Scan to Identify MIME file Attributes: non-creatable, modifiable
- proxy-host => string, optional
proxy server name e.g. http://proxy_server_name Attributes: non-creatable, modifiable
- proxy-login => string, optional
proxy server login Attributes: non-creatable, modifiable
- proxy-password => string, optional
proxy server password Attributes: non-creatable, modifiable
- proxy-port => integer, optional
proxy server port number Attributes: non-creatable, modifiable
- scan-mime => boolean, optional
Scan MIME-Encoded Files Attributes: non-creatable, modifiable
Log Entry Written by an Antivirus Agent 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
- datetime => integer, optional
When the event is logged. The time value is in seconds since January 1, 1970. Attributes: key, required-for-create, non-modifiable
Filer UUIDFields
Jobs execute as self-contained state machines. They follow a series of careful steps from creation to destruction. These steps are dictated by the states that they find themselves in as well as the allowable list of states they may transition into. The state can be an indicator of whether a job is executing and if not, why that is the case. Possible values: - "initial" - Initializing,
- "queued" - Queued,
- "running" - Running,
- "waiting" - Waiting For Another Job,
- "pausing" - Entering Paused State,
- "paused" - Paused,
- "quitting" - Entering Quit State,
- "success" - Succeeded,
- "failure" - Failed,
- "reschedule" - Forcing Reschedule,
- "error" - Internal Error,
- "quit" - Quit,
- "dead" - Died,
- "unknown" - Unknown,
- "restart" - Forcing Restart,
- "dormant" - Waiting For External Event
Fields
Available protocols to be scanned Possible values: Fields
Administrative audit settings of the cluster. 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
- cli-get => boolean, optional
Enable auditing of CLI get operations Attributes: non-creatable, modifiable
- cli-set => boolean, optional
Enable auditing of CLI set operations Attributes: non-creatable, modifiable
- http-get => boolean, optional
Enable auditing of HTTP get operations Attributes: non-creatable, modifiable
- http-set => boolean, optional
Enable auditing of HTTP set operations Attributes: non-creatable, modifiable
- ontapi-get => boolean, optional
Enable auditing of Data ONTAP API get operations Attributes: non-creatable, modifiable
- ontapi-set => boolean, optional
Enable auditing of Data ONTAP API set operations Attributes: non-creatable, modifiable
- snmp-get => boolean, optional
Enable auditing of SNMP get operations Attributes: non-creatable, modifiable
- snmp-set => boolean, optional
Enable auditing of SNMP set operations Attributes: non-creatable, modifiable
Type of AutoSupport content Possible values: - "basic" - ASUP will contain minimal set of data for this subsystem,
- "troubleshooting" - ASUP will contain detailed collection of data for this subsystem
Fields
smtp|http|noteto|retransmit Possible values: - "smtp" ,
- "http" ,
- "noteto" ,
- "retransmit"
Fields
test|performance|all Possible values: - "test" - Test AutoSupport send and receive only,
- "performance" - Generate a Performance AutoSupport as requested by technical support,
- "all" - Send all AutoSupport data without time or size limit, as requested by technical support
Fields
AutoSupport manifest collection status Possible values: - "requested" - ASUP request has been added to the queue and is waiting processing by the collector,
- "working" - ASUP Collector is actively gathering the needed data,
- "file_not_found" - ASUP collection failed, a needed file is missing,
- "no_such_table" - ASUP collection was unable to find the requested SMF table,
- "collection_truncated_size_limit" - ASUP collection truncated due to size limits and partial data is available,
- "collection_skipped_size_limit" - ASUP collection skipped due to size limits and no data is available,
- "collection_truncated_time_limit" - ASUP collection truncated due to time limits and partial data is available,
- "collection_skipped_time_limit" - ASUP collection skipped due to time limits and no data is available,
- "delivery_skipped_size_limit" - ASUP data was skipped at delivery time due to size limits,
- "general_error" - ASUP collection failed, additional information if any will be in the Error String field,
- "completed" - ASUP collection is complete, ready for delivery,
- "content_not_collected_mode" - ASUP content was not collected, incompatible operational mode,
- "content_not_collected_precheck" - ASUP content was not collected, pre-check function violation,
- "content_not_collected_privacy" - ASUP content was not collected, the operation is disabled in privacy mode,
- "content_empty" - ASUP content was collected successfully, but output was empty,
- "collection_aborted" - ASUP collection aborted,
- "collection_truncated_file_size_limit" - ASUP file truncated due to size limits and partial data is available
Fields
AutoSupport general status Possible values: - "initializing" - ASUP request is being processed,
- "collection_failed" - The AutoSupport Collection failed. See 'Last Error' for more information,
- "collection_in_progress" - The AutoSupport Collection is in progress,
- "queued" - ASUP is queued for delivery,
- "transmitting" - ASUP transmission is in progress,
- "sent_successful" - ASUP was successfully sent,
- "ignore" - ASUP was processed successfully but has no destinations configured,
- "re_queued" - ASUP transmission failed and has been re-queued,
- "transmission_failed" - ASUP transmission has failed and the retry limit has been exceeded,
- "ondemand_ignore" - ASUP was processed successfully but ASUP OnDemand has declined delivery
Fields
AutoSupport collection subsystems Possible values: - "platform" - Hardware information about the node,
- "mhost" - User Space application information for a node,
- "log_files" - Log files for a node,
- "performance" - This subsystem gathers the .cm_stats_hourly_done file and user space counters,
- "performance_asup" - Performance specific information for a node,
- "nht" - This subsystem gathers the /mroot/etc/log/nht_info content,
- "san" - SAN specific information for a node,
- "snapvault" - SNAPVAULT specific information for a node,
- "snapmirror" - Snapmirror specific information for a node,
- "dedupe" - Dedupe specific information for a node,
- "nfs" - NFS specific information for a node,
- "wafl" - WAFL specific information for a node,
- "mot" - MOT specific information for a node,
- "ha" - HA specific information for a node,
- "networking" - Networking specific information for a node,
- "cifs" - CIFS specific information for a node,
- "fpolicy" - Fpolicy specific information for a node,
- "multistore" - Multistore specific information for a node,
- "raid" - RAID specific information for a node,
- "storage" - Storage specific information for a node,
- "asup_ems" - ASUP EMS specific information for a node,
- "tape" - Tape specific information for a node,
- "kernel" - kernel specific information for a node,
- "secd" - SECD specific information for a node,
- "metrocluster" - Metrocluster specific information for a node,
- "mandatory" - Mandatory Basic information for a node,
- "repository" - Repository specific information for a node,
- "splog_downcontroller" - SPLOG saved when ontap is abnormal down,
- "splog_latest" - Up-to-date SPLOG from Service Processor FW ,
- "splog_before_spreboot" - Up-to-date SPLOG from Service Processor FW before SP reboot,
- "hm" - Health Monitor Alerts specific information,
- "kcs" - Kernel Cluster Services information for a node,
- "av" - Antivirus specific information for a node,
- "san_ffdc" - SAN specific trace dumps for a node,
- "nwd" - Node Watchdog specific information for a node
Fields
smtp|http|https Possible values: - "smtp" ,
- "http" ,
- "https"
Fields
AutoSupport budget data 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
- node-name => string, optional
The name of a filer on which the AutoSupport tool is running. Attributes: key, non-creatable, non-modifiable
- size-limit => integer, optional
The maximum allowable collection size (in bytes) for the subsystem. Attributes: non-creatable, modifiable
- subsystem => asup-subsystems, optional
The name of a subsystem from which AutoSupport collects data. Attributes: key, non-creatable, non-modifiable Possible values: - "platform" - Hardware information about the node,
- "mhost" - User Space application information for a node,
- "log_files" - Log files for a node,
- "performance" - This subsystem gathers the .cm_stats_hourly_done file and user space counters,
- "performance_asup" - Performance specific information for a node,
- "nht" - This subsystem gathers the /mroot/etc/log/nht_info content,
- "san" - SAN specific information for a node,
- "snapvault" - SNAPVAULT specific information for a node,
- "snapmirror" - Snapmirror specific information for a node,
- "dedupe" - Dedupe specific information for a node,
- "nfs" - NFS specific information for a node,
- "wafl" - WAFL specific information for a node,
- "mot" - MOT specific information for a node,
- "ha" - HA specific information for a node,
- "networking" - Networking specific information for a node,
- "cifs" - CIFS specific information for a node,
- "fpolicy" - Fpolicy specific information for a node,
- "multistore" - Multistore specific information for a node,
- "raid" - RAID specific information for a node,
- "storage" - Storage specific information for a node,
- "asup_ems" - ASUP EMS specific information for a node,
- "tape" - Tape specific information for a node,
- "kernel" - kernel specific information for a node,
- "secd" - SECD specific information for a node,
- "metrocluster" - Metrocluster specific information for a node,
- "mandatory" - Mandatory Basic information for a node,
- "repository" - Repository specific information for a node,
- "splog_downcontroller" - SPLOG saved when ontap is abnormal down,
- "splog_latest" - Up-to-date SPLOG from Service Processor FW ,
- "splog_before_spreboot" - Up-to-date SPLOG from Service Processor FW before SP reboot,
- "hm" - Health Monitor Alerts specific information,
- "kcs" - Kernel Cluster Services information for a node,
- "av" - Antivirus specific information for a node,
- "san_ffdc" - SAN specific trace dumps for a node,
- "nwd" - Node Watchdog specific information for a node
- time-limit => string, optional
The maximum allowable collection time (in seconds ) for the subsystem. Attributes: non-creatable, modifiable
Execution domain of AutoSupport content Possible values: - "bsd" - Command executed by BSD,
- "smf_table" - Command selects SMF table,
- "file" - Command indicates file to collect,
- "dblade" - Collect from dbladecli,
- "dblade_file" - Collect a file from dblade. Could be partner file,
- "zapi_xml" - Response in XML format,
- "custom_fx" - Collect custom function output file
Fields
Compliant AutoSupport has data 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
AutoSupport configuration data 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
- from => mail-address, optional
The e-mail address of the local administrator, used as the sender of the AutoSupport message. Attributes: non-creatable, modifiable
- is-enabled => boolean, optional
Specifies whether the AutoSupport daemon is enabled. When this setting is disabled, delivery of all AutoSupport messages is turned off. Attributes: non-creatable, modifiable
- is-local-collection-enabled => boolean, optional
Used to enable / disable collection of AutoSupport data when the AutoSupport daemon is disabled. When this setting is true, collection of AutoSupport data will still be done if is-enabled is false. Attributes: non-creatable, modifiable
- is-nht-data-enabled => boolean, optional
Used to enable / disable collection of disk health data. Attributes: non-creatable, modifiable
- is-node-in-subject => boolean, optional
Specifies whether the filer's hostname should be part of an AutoSupport message's subject field. Attributes: non-creatable, modifiable
- is-ondemand-enabled => boolean, optional
Specifies whether AutoSupport OnDemand is enabled. Default is true. Attributes: non-creatable, modifiable
- is-ondemand-remote-diag-enabled => boolean, optional
Specifies whether the AutoSupport OnDemand Remote Diagnostics feature is enabled. Default is true. Attributes: non-creatable, modifiable
- is-perf-data-enabled => boolean, optional
Used to enable / disable collection of Performance AutoSupport data. Attributes: non-creatable, modifiable
- is-private-data-removed => boolean, optional
Used to enable / disable removal of customer-supplied data. Attributes: non-creatable, modifiable
- is-reminder-enabled => boolean, optional
Specifies whether to enable / disable AutoSupport reminders. Attributes: non-creatable, modifiable
- is-support-enabled => boolean, optional
Specifies whether AutoSupport notification to technical support is enabled. Attributes: non-creatable, modifiable
- is-throttle-enabled => boolean, optional
Specifies whether to enable / disable throttling to prevent a potential avalanche of AutoSupport messages. Attributes: non-creatable, modifiable
- last-timestamp => integer, optional
The timestamp of the last generated AutoSupport message. The time value is in seconds since January 1, 1970 UTC. Attributes: non-creatable, non-modifiable
- mail-hosts => string[], optional
The name of the mail server(s) used to deliver AutoSupport messages via SMTP. Both host names and IP addresses may be used as valid input. One can optionally specify a username/password for authentication with the mailserver(rfc4954). Attributes: non-creatable, modifiable
- max-http-size => integer, optional
Delivery size limit for the HTTP transport protocol (in bytes). Attributes: non-creatable, modifiable
- max-smtp-size => integer, optional
Delivery size limit for the SMTP transport protocol (in bytes). Attributes: non-creatable, modifiable
- minimum-private-data-length => integer, optional
Minimum Length for Sensitive Data Attributes: non-creatable, modifiable
- node-name => string, optional
The name of the filer that owns the AutoSupport configuration. Attributes: key, non-creatable, non-modifiable
- noteto => mail-address[], optional
Specifies up to five recipients of short AutoSupport e-mail messages. Attributes: non-creatable, modifiable
- ondemand-polling-interval => integer, optional
The AutoSupport OnDemand Client polling rate in minutes. Attributes: non-creatable, modifiable
- ondemand-server-url => string, optional
The AutoSupport OnDemand Server URL. Attributes: non-creatable, modifiable
- partner-address => mail-address[], optional
Specifies up to five partner vendor recipients of full AutoSupport e-mail messages. Attributes: non-creatable, modifiable
- payload-format => compression-format, optional
The format used to compress the AutoSupport message payload. Attributes: non-creatable, modifiable Possible values: - "7z" - 7-Zip Archive,
- "tgz" - Zipped Tarball
- periodic-tx-window => string, optional
The transmission window (seconds). Attributes: non-creatable, modifiable
- post-url => string, optional
The URL used to deliver AutoSupport messages via HTTP POST. Attributes: non-creatable, modifiable
- proxy-url => string, optional
Optional proxy host for AutoSupport message delivery via HTTP. Attributes: non-creatable, modifiable
- put-url => string, optional
The URL used to deliver AutoSupport messages via HTTP PUT. Attributes: non-creatable, modifiable
- retry-count => integer, optional
The maximum number of delivery attempts for an AutoSupport message. Attributes: non-creatable, modifiable
- retry-interval => string, optional
The number of seconds to wait, after a failed delivery attempt, prior to re-transmitting an AutoSupport message. Attributes: non-creatable, modifiable
- support-address => mail-address[], optional
The e-mail address of Support. Attributes: non-creatable, modifiable
- to => mail-address[], optional
Specifies up to five recipients of full AutoSupport e-mail messages. Attributes: non-creatable, modifiable
- transport => asup-transport, optional
The name of the transport protocol used to deliver AutoSupport messages. Attributes: non-creatable, modifiable Possible values: - "smtp" ,
- "http" ,
- "https"
AutoSupport destination summary 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
- node-name => string, optional
The name of the filer that owns this destination configuration. Attributes: key, non-creatable, non-modifiable
AutoSupport history data 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
- destination => asup-destination, optional
The transport protocol for this AutoSupport message's destination. Attributes: key, non-creatable, non-modifiable Possible values: - "smtp" ,
- "http" ,
- "noteto" ,
- "retransmit"
- generation-timestamp => integer, optional
The timestamp of the original generation (collection) of this AutoSupport message. The time value is in seconds since January 1, 1970 UTC. Attributes: non-creatable, non-modifiable
- node-name => string, optional
The name of the filer where the AutoSupport message was previously generated. Attributes: key, non-creatable, non-modifiable
- status => asup-status, optional
The delivery status for this AutoSupport message. Attributes: non-creatable, non-modifiable Possible values: - "initializing" - ASUP request is being processed,
- "collection_failed" - The AutoSupport Collection failed. See 'Last Error' for more information,
- "collection_in_progress" - The AutoSupport Collection is in progress,
- "queued" - ASUP is queued for delivery,
- "transmitting" - ASUP transmission is in progress,
- "sent_successful" - ASUP was successfully sent,
- "ignore" - ASUP was processed successfully but has no destinations configured,
- "re_queued" - ASUP transmission failed and has been re-queued,
- "transmission_failed" - ASUP transmission has failed and the retry limit has been exceeded,
- "ondemand_ignore" - ASUP was processed successfully but ASUP OnDemand has declined delivery
- trigger => string, optional
The name of the EMS event that triggered this AutoSupport message. Attributes: non-creatable, non-modifiable
- uri => string, optional
The URI used to deliver this AutoSupport message. Attributes: non-creatable, non-modifiable
AutoSupport manifest data 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
- cmd-tgt => autosupport-cmd-tgt, optional
Execution Domain for Command Attributes: non-creatable, non-modifiable Possible values: - "bsd" - Command executed by BSD,
- "smf_table" - Command selects SMF table,
- "file" - Command indicates file to collect,
- "dblade" - Collect from dbladecli,
- "dblade_file" - Collect a file from dblade. Could be partner file,
- "zapi_xml" - Response in XML format,
- "custom_fx" - Collect custom function output file
- content-type => asup-content-type, optional
AutoSupport Content Type for this Data Attributes: non-creatable, non-modifiable Possible values: - "basic" - ASUP will contain minimal set of data for this subsystem,
- "troubleshooting" - ASUP will contain detailed collection of data for this subsystem
- node-name => string, optional
Node Attributes: key, non-creatable, non-modifiable
- seq-num => integer, optional
AutoSupport Sequence Number Attributes: key, non-creatable, non-modifiable
- status => asup-manifest-status, optional
Status of this Data Item Attributes: non-creatable, non-modifiable Possible values: - "requested" - ASUP request has been added to the queue and is waiting processing by the collector,
- "working" - ASUP Collector is actively gathering the needed data,
- "file_not_found" - ASUP collection failed, a needed file is missing,
- "no_such_table" - ASUP collection was unable to find the requested SMF table,
- "collection_truncated_size_limit" - ASUP collection truncated due to size limits and partial data is available,
- "collection_skipped_size_limit" - ASUP collection skipped due to size limits and no data is available,
- "collection_truncated_time_limit" - ASUP collection truncated due to time limits and partial data is available,
- "collection_skipped_time_limit" - ASUP collection skipped due to time limits and no data is available,
- "delivery_skipped_size_limit" - ASUP data was skipped at delivery time due to size limits,
- "general_error" - ASUP collection failed, additional information if any will be in the Error String field,
- "completed" - ASUP collection is complete, ready for delivery,
- "content_not_collected_mode" - ASUP content was not collected, incompatible operational mode,
- "content_not_collected_precheck" - ASUP content was not collected, pre-check function violation,
- "content_not_collected_privacy" - ASUP content was not collected, the operation is disabled in privacy mode,
- "content_empty" - ASUP content was collected successfully, but output was empty,
- "collection_aborted" - ASUP collection aborted,
- "collection_truncated_file_size_limit" - ASUP file truncated due to size limits and partial data is available
- subsystem => asup-subsystems, optional
Subsystem Attributes: non-creatable, non-modifiable Possible values: - "platform" - Hardware information about the node,
- "mhost" - User Space application information for a node,
- "log_files" - Log files for a node,
- "performance" - This subsystem gathers the .cm_stats_hourly_done file and user space counters,
- "performance_asup" - Performance specific information for a node,
- "nht" - This subsystem gathers the /mroot/etc/log/nht_info content,
- "san" - SAN specific information for a node,
- "snapvault" - SNAPVAULT specific information for a node,
- "snapmirror" - Snapmirror specific information for a node,
- "dedupe" - Dedupe specific information for a node,
- "nfs" - NFS specific information for a node,
- "wafl" - WAFL specific information for a node,
- "mot" - MOT specific information for a node,
- "ha" - HA specific information for a node,
- "networking" - Networking specific information for a node,
- "cifs" - CIFS specific information for a node,
- "fpolicy" - Fpolicy specific information for a node,
- "multistore" - Multistore specific information for a node,
- "raid" - RAID specific information for a node,
- "storage" - Storage specific information for a node,
- "asup_ems" - ASUP EMS specific information for a node,
- "tape" - Tape specific information for a node,
- "kernel" - kernel specific information for a node,
- "secd" - SECD specific information for a node,
- "metrocluster" - Metrocluster specific information for a node,
- "mandatory" - Mandatory Basic information for a node,
- "repository" - Repository specific information for a node,
- "splog_downcontroller" - SPLOG saved when ontap is abnormal down,
- "splog_latest" - Up-to-date SPLOG from Service Processor FW ,
- "splog_before_spreboot" - Up-to-date SPLOG from Service Processor FW before SP reboot,
- "hm" - Health Monitor Alerts specific information,
- "kcs" - Kernel Cluster Services information for a node,
- "av" - Antivirus specific information for a node,
- "san_ffdc" - SAN specific trace dumps for a node,
- "nwd" - Node Watchdog specific information for a node
AutoSupport trigger data 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
- additional-content => asup-content-type[], optional
Additional Content Flag Attributes: non-creatable, non-modifiable Possible values: - "basic" - ASUP will contain minimal set of data for this subsystem,
- "troubleshooting" - ASUP will contain detailed collection of data for this subsystem
- basic-additional => asup-subsystems[], optional
Additional Subsystems Reporting Basic Info Attributes: non-creatable, modifiable Possible values: - "platform" - Hardware information about the node,
- "mhost" - User Space application information for a node,
- "log_files" - Log files for a node,
- "performance" - This subsystem gathers the .cm_stats_hourly_done file and user space counters,
- "performance_asup" - Performance specific information for a node,
- "nht" - This subsystem gathers the /mroot/etc/log/nht_info content,
- "san" - SAN specific information for a node,
- "snapvault" - SNAPVAULT specific information for a node,
- "snapmirror" - Snapmirror specific information for a node,
- "dedupe" - Dedupe specific information for a node,
- "nfs" - NFS specific information for a node,
- "wafl" - WAFL specific information for a node,
- "mot" - MOT specific information for a node,
- "ha" - HA specific information for a node,
- "networking" - Networking specific information for a node,
- "cifs" - CIFS specific information for a node,
- "fpolicy" - Fpolicy specific information for a node,
- "multistore" - Multistore specific information for a node,
- "raid" - RAID specific information for a node,
- "storage" - Storage specific information for a node,
- "asup_ems" - ASUP EMS specific information for a node,
- "tape" - Tape specific information for a node,
- "kernel" - kernel specific information for a node,
- "secd" - SECD specific information for a node,
- "metrocluster" - Metrocluster specific information for a node,
- "mandatory" - Mandatory Basic information for a node,
- "repository" - Repository specific information for a node,
- "splog_downcontroller" - SPLOG saved when ontap is abnormal down,
- "splog_latest" - Up-to-date SPLOG from Service Processor FW ,
- "splog_before_spreboot" - Up-to-date SPLOG from Service Processor FW before SP reboot,
- "hm" - Health Monitor Alerts specific information,
- "kcs" - Kernel Cluster Services information for a node,
- "av" - Antivirus specific information for a node,
- "san_ffdc" - SAN specific trace dumps for a node,
- "nwd" - Node Watchdog specific information for a node
- basic-default => asup-subsystems[], optional
Default Subsystems Reporting Basic Info Attributes: non-creatable, non-modifiable Possible values: - "platform" - Hardware information about the node,
- "mhost" - User Space application information for a node,
- "log_files" - Log files for a node,
- "performance" - This subsystem gathers the .cm_stats_hourly_done file and user space counters,
- "performance_asup" - Performance specific information for a node,
- "nht" - This subsystem gathers the /mroot/etc/log/nht_info content,
- "san" - SAN specific information for a node,
- "snapvault" - SNAPVAULT specific information for a node,
- "snapmirror" - Snapmirror specific information for a node,
- "dedupe" - Dedupe specific information for a node,
- "nfs" - NFS specific information for a node,
- "wafl" - WAFL specific information for a node,
- "mot" - MOT specific information for a node,
- "ha" - HA specific information for a node,
- "networking" - Networking specific information for a node,
- "cifs" - CIFS specific information for a node,
- "fpolicy" - Fpolicy specific information for a node,
- "multistore" - Multistore specific information for a node,
- "raid" - RAID specific information for a node,
- "storage" - Storage specific information for a node,
- "asup_ems" - ASUP EMS specific information for a node,
- "tape" - Tape specific information for a node,
- "kernel" - kernel specific information for a node,
- "secd" - SECD specific information for a node,
- "metrocluster" - Metrocluster specific information for a node,
- "mandatory" - Mandatory Basic information for a node,
- "repository" - Repository specific information for a node,
- "splog_downcontroller" - SPLOG saved when ontap is abnormal down,
- "splog_latest" - Up-to-date SPLOG from Service Processor FW ,
- "splog_before_spreboot" - Up-to-date SPLOG from Service Processor FW before SP reboot,
- "hm" - Health Monitor Alerts specific information,
- "kcs" - Kernel Cluster Services information for a node,
- "av" - Antivirus specific information for a node,
- "san_ffdc" - SAN specific trace dumps for a node,
- "nwd" - Node Watchdog specific information for a node
- node-name => string, optional
Node Attributes: key, non-creatable, non-modifiable
- noteto-enabled => string, optional
Deliver to AutoSupport -noteto Addresses. Possible values are: enabled or disabled. Attributes: non-creatable, modifiable
- time-limit => string, optional
The data collection time budget for this trigger (in seconds). Content not collected will be marked as collection-truncated-time-limit in the manifest. Attributes: non-creatable, modifiable
- to-enabled => string, optional
Deliver to AutoSupport -to Addresses. Possible values are: enabled or disabled. Attributes: non-creatable, modifiable
- trigger => string, optional
EMS Message Attributes: key, non-creatable, non-modifiable
- troubleshooting-additional => asup-subsystems[], optional
Additional Subsystems Reporting Troubleshooting Info Attributes: non-creatable, modifiable Possible values: - "platform" - Hardware information about the node,
- "mhost" - User Space application information for a node,
- "log_files" - Log files for a node,
- "performance" - This subsystem gathers the .cm_stats_hourly_done file and user space counters,
- "performance_asup" - Performance specific information for a node,
- "nht" - This subsystem gathers the /mroot/etc/log/nht_info content,
- "san" - SAN specific information for a node,
- "snapvault" - SNAPVAULT specific information for a node,
- "snapmirror" - Snapmirror specific information for a node,
- "dedupe" - Dedupe specific information for a node,
- "nfs" - NFS specific information for a node,
- "wafl" - WAFL specific information for a node,
- "mot" - MOT specific information for a node,
- "ha" - HA specific information for a node,
- "networking" - Networking specific information for a node,
- "cifs" - CIFS specific information for a node,
- "fpolicy" - Fpolicy specific information for a node,
- "multistore" - Multistore specific information for a node,
- "raid" - RAID specific information for a node,
- "storage" - Storage specific information for a node,
- "asup_ems" - ASUP EMS specific information for a node,
- "tape" - Tape specific information for a node,
- "kernel" - kernel specific information for a node,
- "secd" - SECD specific information for a node,
- "metrocluster" - Metrocluster specific information for a node,
- "mandatory" - Mandatory Basic information for a node,
- "repository" - Repository specific information for a node,
- "splog_downcontroller" - SPLOG saved when ontap is abnormal down,
- "splog_latest" - Up-to-date SPLOG from Service Processor FW ,
- "splog_before_spreboot" - Up-to-date SPLOG from Service Processor FW before SP reboot,
- "hm" - Health Monitor Alerts specific information,
- "kcs" - Kernel Cluster Services information for a node,
- "av" - Antivirus specific information for a node,
- "san_ffdc" - SAN specific trace dumps for a node,
- "nwd" - Node Watchdog specific information for a node
- troubleshooting-default => asup-subsystems[], optional
Default Subsystems Reporting Troubleshooting Info Attributes: non-creatable, non-modifiable Possible values: - "platform" - Hardware information about the node,
- "mhost" - User Space application information for a node,
- "log_files" - Log files for a node,
- "performance" - This subsystem gathers the .cm_stats_hourly_done file and user space counters,
- "performance_asup" - Performance specific information for a node,
- "nht" - This subsystem gathers the /mroot/etc/log/nht_info content,
- "san" - SAN specific information for a node,
- "snapvault" - SNAPVAULT specific information for a node,
- "snapmirror" - Snapmirror specific information for a node,
- "dedupe" - Dedupe specific information for a node,
- "nfs" - NFS specific information for a node,
- "wafl" - WAFL specific information for a node,
- "mot" - MOT specific information for a node,
- "ha" - HA specific information for a node,
- "networking" - Networking specific information for a node,
- "cifs" - CIFS specific information for a node,
- "fpolicy" - Fpolicy specific information for a node,
- "multistore" - Multistore specific information for a node,
- "raid" - RAID specific information for a node,
- "storage" - Storage specific information for a node,
- "asup_ems" - ASUP EMS specific information for a node,
- "tape" - Tape specific information for a node,
- "kernel" - kernel specific information for a node,
- "secd" - SECD specific information for a node,
- "metrocluster" - Metrocluster specific information for a node,
- "mandatory" - Mandatory Basic information for a node,
- "repository" - Repository specific information for a node,
- "splog_downcontroller" - SPLOG saved when ontap is abnormal down,
- "splog_latest" - Up-to-date SPLOG from Service Processor FW ,
- "splog_before_spreboot" - Up-to-date SPLOG from Service Processor FW before SP reboot,
- "hm" - Health Monitor Alerts specific information,
- "kcs" - Kernel Cluster Services information for a node,
- "av" - Antivirus specific information for a node,
- "san_ffdc" - SAN specific trace dumps for a node,
- "nwd" - Node Watchdog specific information for a node
7z|tgz Possible values: - "7z" - 7-Zip Archive,
- "tgz" - Zipped Tarball
Fields
E-mail AddressFields
Reverse-ordered Integer Range : [0..2^64-1].Fields
Storage Capability Info Typedef 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
A description of the capability. Attributes: optional-for-create, modifiable
- enabled => boolean, optional
A reflection of whether some feature is using the capability or not. Attributes: required-for-create, modifiable
- node => string, optional
The name of the node in which the capability is installed. Attributes: key, required-for-create, non-modifiable
- obsolete => boolean, optional
A boolean indication as to whether the capability has become obsolete or not. Attributes: optional-for-create, modifiable
Giveback status of an aggregate 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
- aggr-giveback-error => string, optional
Failure reason, incase giveback of this aggregate failed. Possible values include: - "sfo_am_shutdown" - Node is being shutdown
- "sfo_am_not_homed_partner" - Aggregate not owned by partner
- "sfo_am_not_sfo" - Aggregate does not have SFO policy
- "sfo_am_failed_limbo" - Aggregate in failed or limbo state
- "sfo_am_offline_failed" - Aggregate could not be offlined during giveback
- "sfo_am_migrating" - Aggregate is being migrated
- "sfo_am_veto" - Giveback was vetoed.
- "sfo_am_communication_err" - Giveback failed because node cannot communicate with the partner
- "sfo_am_online_timeout" - Aggregate did not come online after giveback
- "sfo_am_online_failed" - Failed to online the aggregate after giveback
Attributes: non-creatable, non-modifiable
- aggr-giveback-module => string, optional
If giveback is in progress, then this is set to the module which is currently running. If giveback was failed or vetoed by a certain module then this is set to the first module which failed the giveback. Example: WAFL. Attributes: non-creatable, non-modifiable
- aggr-giveback-state => string, optional
Giveback status of the aggregate Possible values include: - "sfo_am_done" - Giveback done
- "sfo_am_failed" - Giveback failed
- "sfo_am_inprog" - Giveback in progress
- "sfo_am_not_started" - Giveback not started
- "sfo_am_nothing_to_gb" - No aggregates to giveback
- "sfo_disk_inventory_not_exchanged" - Auto giveback failed because disk inventory was not exchanged between HA partners
- "sfo_disk_inventory_mismatch" - Auto giveback failed because there was mismatch in disk inventory
- "sfo_am_failed_bdfu_source" - Giveback failed as failed to disable background disk firmware update on source node.
- "sfo_am_failed_bdfu_dest" - Giveback failed as failed to disable background disk firmware update on destination node.
- "sfo_am_delayed_bdfu_source" - Giveback delayed as disk firmware update is in progress on source node.
- "sfo_am_delayed_bdfu_dest" - Giveback delayed as disk firmware update is in progress on destination node.
- "sfo_am_running_checks" - Performing veto checks.
Attributes: non-creatable, non-modifiable
- aggregate => string, optional
Aggregate name Attributes: non-creatable, non-modifiable
- node => node-name, optional
Node performing the giveback of aggregate Attributes: key, non-creatable, non-modifiable
Disk Unique IdentifierFields
Giveback related InfoFields
- giveback-failure-reason => string, optional
This is the reason for the giveback failure. Attributes: non-creatable, non-modifiable
- giveback-state => string, optional
Giveback state of the node. Possible values are: - nothing_to_gb
- not_attempted_yet
- giveback_in_progress
- giveback_failed_autogiveback_disabled
- giveback_failed_autogiveback_scheduled
- previous_giveback_failed
- giveback_vetoed_no_di
- giveback_vetoed_missing_disks
- autogiveback_scheduled
- autogiveback_deferred
- node_upgrade_in_progress
- sfo_aggr_giveback_failed
- sfo_aggr_giveback_in_progress
- partial_giveback
- partner_spare_disks_giveback_pending
Attributes: non-creatable, non-modifiable
Interconnect InfoFields
- interconnect-links => string, optional
States of the individual interconnect links. Attributes: non-creatable, non-modifiable
- interconnect-type => string, optional
Type and Vendor of the interconnect. Attributes: non-creatable, non-modifiable
Mailbox IO timesFields
State of mailbox disks owned by the node. Possible values are: - mbx_status_nodisks
- mbx_status_uncertain
- mbx_status_stale
- mbx_status_conflicted
- mbx_status_old_version
- mbx_status_not_found
- mbx_status_wrong_state
- mbx_status_backup
Fields
Mailbox status info.Fields
- mailbox-status => string
representation of mailbox status bit. Possible values: mbx_status_nodisks mbx_status_uncertain mbx_status_stale mbx_status_conflicted mbx_status_old_version mbx_status_not_found mbx_status_wrong_state mbx_status_backup
Node InfoFields
- local-firmware-progress => integer, optional
A counter to indicate that the local node is progressing in the current firmware state. If the counter is not progressing the node may be unresponsive or down. Attributes: non-creatable, non-modifiable
- local-firmware-state => string, optional
Local firmware state that will be communicated through interconnect to the partner. Possible values are: - SF_OPERATOR_EXIT - operator completed
- SF_DEBUG_EXIT - debugger completed
- SF_PROGRESS - progress counter
- SF_IOERROR - I/O error
- SF_BADCKSUM - bad checksum
- SF_RESERVED - reserved
- SF_UNKNOWN - unknown
- SF_OPEN - initializing
- SF_POST - in power-on self test
- SF_BOOTING - booting
- SF_FAIL - boot failed
- SF_WAITING - waiting
- SF_OS_BOOTED - kernel loaded
- SF_UP - up
- SF_DEBUG - in debugger
- SF_OPERATOR - waiting for operator input
- SF_DUMPCORE - dumping core
- SF_HALT - halted
- SF_REBOOT - rebooting
- SF_GIVEWAIT - waiting for giveback
- SF_MBWAIT - waiting for cluster mailbox release
- SF_SPARECORE - dumping sparecore and ready to be taken-over
- SF_MDP - multi-disk panic
- SF_TO - in takeover
- SF_NOTO - takeover disabled
- SF_CLUSTERWAIT - waiting for cluster apps
Attributes: non-creatable, non-modifiable
- node => node-name, optional
Node name Attributes: key, non-creatable, non-modifiable
- node-state => string, optional
Storage failover status of the node. Possible values are: - connected
- takeover_scheduled
- takeover_started
- takeover
- takeover_failed
- giveback_partial_waiting
- giveback_partial_connected
- waiting_for_root_aggr
- waiting
- in_maintenance_mode
- pending_shutdown
- relocating_aggrs_before_takeover
- sfo_takeover_phase_done
- sfo_takenover_phase_done
- sfo_takeover_phase_aborted
- sfo_takenover_phase_aborted
- in_non_HA_mode
- cfo_takeover_failed
- sfo_takeover_in_progress
- relocated_aggrs_before_takeover
- giveback_in_progress
- giveback_failed_autogiveback_disabled
- giveback_failed_autogiveback_scheduled
- previous_giveback_failed
- takeover_no_di
- takeover_partner_missing_disks
- takeover_autogiveback_scheduled
- takeover_network_failure
- takeover_autogiveback_deferred
- automatic_takeover_disabled_connected
- automatic_takeover_disabled_waiting
- ndo_upgrade_in_progress
- own_aggr_non_local_connected
- own_aggr_non_local_waiting
- clusterwait_connected
- clusterwait_waiting
- error
Attributes: non-creatable, non-modifiable
- partner-firmware-progress => integer, optional
A counter to indicate that the partner node is progressing in the current firmware state. If the counter is not progressing the partner node may be unresponsive or down. Attributes: non-creatable, non-modifiable
- partner-firmware-state => string, optional
Partner firmware state as communicated by the partner through interconnect. Possible values are: - SF_OPERATOR_EXIT - operator completed
- SF_DEBUG_EXIT - debugger completed
- SF_PROGRESS - progress counter
- SF_IOERROR - I/O error
- SF_BADCKSUM - bad checksum
- SF_RESERVED - reserved
- SF_UNKNOWN - unknown
- SF_OPEN - initializing
- SF_POST - in power-on self test
- SF_BOOTING - booting
- SF_FAIL - boot failed
- SF_WAITING - waiting
- SF_OS_BOOTED - kernel loaded
- SF_UP - up
- SF_DEBUG - in debugger
- SF_OPERATOR - waiting for operator input
- SF_DUMPCORE - dumping core
- SF_HALT - halted
- SF_REBOOT - rebooting
- SF_GIVEWAIT - waiting for giveback
- SF_MBWAIT - waiting for cluster mailbox release
- SF_SPARECORE - dumping sparecore and ready to be taken-over
- SF_MDP - multi-disk panic
- SF_TO - in takeover
- SF_NOTO - takeover disabled
- SF_CLUSTERWAIT - waiting for cluster apps
Attributes: non-creatable, non-modifiable
- partner-name => string, optional
Storage failover partner node name Attributes: non-creatable, non-modifiable
- partner-nvram-id => integer, optional
Partner NVRAM identifier Attributes: non-creatable, non-modifiable
Reason why takeover is not possible. - not_initialized - Controller Failover not initialized
- non_ha_mode - Controller is in non-HA mode
- disabled - Controller Failover takeover disabled
- mailbox_invalid - Partner mailbox disks not accessible or invalid
- mailbox_uninit - Partner mailbox status uninitialized
- fm_version_mismatch - Failover monitor version mismatch
- partner_disabled - Takeover disabled by partner
- operator_deny - Takeover disabled by operator
- nvram_mismatch - NVRAM size mismatch
- version - Version mismatch
- ic_error - Interconnect error
- booting - Partner booting
- shelf_hot - Disk shelf is too hot
- partner_revert_in_progress - Partner is performing revert
- local_revert_in_progress - Revert is in progress
- partner_takeover - Partner is attempting takeover
- local_takeover - Already in takeover mode
- halt_no_takeover - Partner halted in notakeover mode
- log_unsync - NVRAM log unsynchronized
- unknown - No takeover due to unknown reason
- waiting_for_partner - Waiting for partner to recover
- low_memory - Low memory condition
- halting - Local halt in progress
- mailbox_uncertain - Status of partner mailbox is uncertain
- no_auto_takeover - Automatic takeover is disabled
- disk_inventory_not_exchanged - Disk inventory information not received - from partner
- disk_inventory_mismatch_local - Local node missing some of partner node's file system disks
- pending_shutdown - Local node is shutting down
Fields
A failover monitor resource table entry.Fields
- fail => string
Entry failure code, represented as a string: ok fail fail_always hang panic veto
- name => string
Name of the entry
- state => string
Entry state, represented as a string: up start_running start_done start_failed stop_running stop_failed takeover_barrier only_when_initd
Disk information.Fields
- disk-uid => string
Disk unique identifier. Maximum length of 90 characters. XXX should use same typedef as storage ZAPI. Note sure where it is defined.
- name => string
Name of the disk, e.g. v1.1
Options for debugging purpose.Fields
- bypass-takeover-optimization => boolean, optional
If true, then optimized negotiated takeover is bypassed. If false, negotiated takeover will be optimized. The default value for this option is false. This option will be available starting with Data ONTAP 8.2.
- mode => string
HA mode in registry
- send-home-auto-delay-seconds => integer
The number of seconds of delay before initiating automatic send-home. This will be the minimum time a node will be in takeover state before performing auto sendhome.
Storage Failover Info 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
Storage InfoFields
Takeover info.Fields
- reason => string
reason we can't takeover: - not_initialized - Controller Failover not initialized
- non_ha_mode - Controller is in non-HA mode
- disabled - Controller Failover takeover disabled
- mailbox_invalid - Partner mailbox disks not accessible or invalid
- mailbox_uninit - Partner mailbox status uninitialized
- fm_version_mismatch - Failover monitor version mismatch
- partner_disabled - Takeover disabled by partner
- operator_deny - Takeover disabled by operator
- nvram_mismatch - NVRAM size mismatch
- version - Version mismatch
- ic_error - Interconnect error
- booting - Partner booting
- shelf_hot - Disk shelf is too hot
- partner_revert_in_progress - Partner is performing revert
- local_revert_in_progress - Revert is in progress
- partner_takeover - Partner is attempting takeover
- local_takeover - Already in takeover mode
- halt_no_takeover - Partner halted in notakeover mode
- log_unsync - NVRAM log unsynchronized
- unknown - No takeover due to unknown reason
- waiting_for_partner - Waiting for partner to recover
- low_memory - Low memory condition
- halting - Local halt in progress
- mailbox_uncertain - Status of partner mailbox is uncertain
- no_auto_takeover - Automatic takeover is disabled
- disk_inventory_not_exchanged - Disk inventory information not received from partner
- disk_inventory_mismatch_local - Local node missing some of partner node's file system disks
- pending_shutdown - Local node is shutting down
Takeover related InfoFields
- takeover-by-partner-not-possible-reason => reason-takeover-not-possible[], optional
It list of one or more reasons why takeover by partner is not possible. Attributes: non-creatable, non-modifiable
- takeover-enabled => boolean, optional
True, if the storage failover facility is enabled, false otherwise. Note that the facility can be enabled but takeover may not be possible due to various reasons. Attributes: non-creatable, modifiable
- takeover-failure-reason => string, optional
This is the reason for the takeover failure. Attributes: non-creatable, non-modifiable
- takeover-of-partner-not-possible-reason => reason-takeover-not-possible[], optional
If takeover-possible field is false, it lists of one or more reasons why takeover of partner is not possible. Attributes: non-creatable, non-modifiable
- takeover-state => string, optional
Takeover state of the node. Possible values are: - takeover_failed - Takeover Failed
- sfo_takeover_in_progress - SFO phase of takeover of partner is in progress
- relocating_aggrs_before_takeover - Relocating aggregates to partner as a takeover was initiated by partner
- cfo_takeover_scheduled - CFO phase of takeover is scheduled
- relocated_aggrs_before_takeover - Relocated aggregates to partner after a takeover was initiated by partner
- takeover_by_partner_failed - A takeover attempt by partner failed. Refer to takeover-failure-reason field to check the reason for takeover failure.
- in_takeover - Node is in takeover
- takeover_started - A takeover is in progress
- takeover_scheduled - A takeover of partner is scheduled
Refer to time-until-takeover field to check time remaining till takeover. - not_in_takeover - Local node is not in takeover
Attributes: non-creatable, non-modifiable
- time-since-takeover => integer, optional
Time in milliseconds since the local node has taken over partner. Attributes: non-creatable, non-modifiable
- time-until-takeover => integer, optional
This is the countdown time in seconds until takeover is started. Attributes: non-creatable, non-modifiable
Takeover status of a node and all of its partner aggregates. 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, assuming that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
- aggregate-takeover-status => string
Takeover status of the partner aggregate. This includes the reason for the failure of takeover of an aggregate. If takeover is in progress in a particular module, or if takeover was vetoed by a particular module, that is also indicated. Possible values include: - Done
- Failed
- In progress, Module: wafl
- Not attempted yet
- Failed: Operation was vetoed, Module: example. The aggregate will be taken over during CFO phase of takeover.
- Failed: Aggregate does not have SFO HA policy. The aggregate will be taken over during CFO phase of takeover.
- Failed: Aggregate is in failed or limbo state. The aggregate will be taken over during CFO phase of takeover.
- Failed to offline the aggregate. The aggregate will be taken over during CFO phase of takeover.
- No aggregates to relocate
- Failed: Node cannot communicate with the destination node. To takeover the remaining aggregates, run the "storage failover takeover -ofnode -bypass-optimization true" command. To giveback the relocated aggregates, run the "storage failover giveback -ofnode " command.
- Failed: Destination node did not online the aggregate on time. To takeover the remaining aggregates, run the "storage failover takeover -ofnode -bypass-optimization true" command. To giveback the relocated aggregates, run the "storage failover giveback -ofnode " command.
- Failed: Destination node failed to online the aggregate. To takeover the remaining aggregates, run the "storage failover takeover -ofnode -bypass-optimization true" command. To giveback the relocated aggregates, run the "storage failover giveback -ofnode " command.
- Failed: Destination cannot receive the aggregate. To takeover the remaining aggregates, run the "storage failover takeover -ofnode -bypass-optimization true" command. To giveback the relocated aggregates, run the "storage failover giveback -ofnode " command.
- Failed: Aggregate is restricted. The aggregate will be taken over during CFO phase of takeover.
- Failed: Aggregate does not have disks. The aggregate will be taken over during CFO phase of takeover.
- Failed: Aggregate is foreign. The aggregate will be taken over during CFO phase of takeover.
- Failed: Aggregate is offline. The aggregate will be taken over during CFO phase of takeover.
- Failed: Mirrored aggregate does not have both plexes online. The aggregate will be taken over during CFO phase of takeover.
- Failed, could not disable firmware updates on .
Attributes: non-creatable, non-modifiable
- node => string
Name of the node. Attributes: key, non-creatable, non-modifiable
Failover monitor timeouts.Fields
The name of a volume. The maximum string length is 255 characters.Fields
The list of possible known authentication mechanisms supported by the CIFS server. Possible values: - "None" - None
- "NTLMv1" - NTLMv1
- "NTLMv2" - NTLMv2
- "Kerberos" - Kerberos
- "Anonymous" - Anonymous
Fields
access rights Possible values: - "no_access" - No access,
- "read" - Read,
- "change" - Change,
- "full_control" - Full Control
Fields
domain|workgroup Possible values: - "domain" - DOMAIN,
- "workgroup" - WORKGROUP
Fields
Versions of CIFS BranchCache that are currently supported.Fields
CIFS BranchCache configuration 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
- hash-store-max-size => size, optional
Maximum size the hash store can grow to. Attributes: optional-for-create, modifiable
- hash-store-path => string, optional
Path to the directory where hash files are stored. Attributes: required-for-create, modifiable
- operating-mode => string, optional
The mode in which the BranchCache service will operate. Attributes: optional-for-create, modifiable
- server-key => string, optional
BranchCache server key. Attributes: optional-for-create, modifiable
- versions => cifs-bc-version-control[], optional
Versions of the BranchCache protocol that are supported. Attributes: optional-for-create, modifiable
- vserver => vserver-name, optional
The name of the Vserver associated with this CIFS server. Attributes: key, non-creatable, non-modifiable
The list of possible protection levels. Open files are "Continuously Available" if they are opened from an SMB 3 client through a share with the "continuously_available" property set. These open files are capable of non-disruptively recovering from takeover and giveback as well as general aggregate relocation between partners in a high-availability relationship. This is in addition to the traditional SMB 2 capability allowing clients to recover from LIF migration and other brief network interruptions. Note: The CA protection levels depicts the continuous availability at the connection level so it might not be accurate for a session if the connection has multiple sessions. Streams opened through a continuously available share are permitted, but are not currently made continuously available. Directories may be opened through a continuously available share, but will not appear continuously available as clients do not open them that way by design. These protection levels are applicable to the sessions/files on read/write volumes on SFO aggregates. Possible values: - "No" - The open file is not continuously available. For sessions, it contains one or more open files but none of them are continuously available.
- "Yes" - The open file is continuously available. For sessions, it contains one or more open files and all of them are continuously available.
- "Partial" - This value is used for sessions only. It contains at least one continuously available open file but other open files that are not.
Fields
The list of possible known dialects Dialects negotiated by CIFS servers. Possible values: - "SMB1" - SMB 1.0
- "SMB2" - SMB 2.0
- "SMB2_1" - SMB 2.1
- "SMB3" - SMB 3.0
Fields
Classification of server based on the status of the connection. Possible values: - "ok" - The connection to this server is usable.,
- "unavailable" - This server is currently unavailable for use.,
- "slow" - The connection to this server is usable but slow.,
- "expired" - The connection to this server has expired.,
- "undetermined" - A connection to this server has not been attempted.,
- "unreachable" - This server is currently unreachable.
Fields
The classification of servers based on service provided. Possible values: - "unknown" - The server type is not known,
- "kerberos" - Kerberos server,
- "ms_ldap" - Microsoft Lightweight Directory Access Protocol (LDAP) server,
- "ms_dc" - Microsoft Domain Controller,
- "ldap" - Lightweight Directory Access Protocol (LDAP) server,
- "nis" - Network Information Service (NIS) server
Fields
List of servers discovered by the cluster. 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
- domain => string, optional
The Active Directory domain that the discovered server is a member of. Attributes: key, non-creatable, non-modifiable
- name => string, optional
The hostname of the server that was discovered. Attributes: key, non-creatable, non-modifiable
- node => node-name, optional
The name of the node on which server discovery was done. Attributes: key, non-creatable, non-modifiable
- prefer-type => cifs-domain-server-prefer-type, optional
The preference level of the server that was discovered. Attributes: non-creatable, non-modifiable Possible values: - "unknown" - The preference level of this server is unknown.,
- "preferred" - This server was administratively marked as a preferred server due to its presence in the list of preferred servers.,
- "favored" - This server was marked as favored by the server discovery process by virtue of site membership.,
- "adequate" - This server was discovered by the server discovery process and can be used, but has no preference associated with it.
- server-type => cifs-domain-discovered-server-type, optional
The type of the server that was discovered. Attributes: key, non-creatable, non-modifiable Possible values: - "unknown" - The server type is not known,
- "kerberos" - Kerberos server,
- "ms_ldap" - Microsoft Lightweight Directory Access Protocol (LDAP) server,
- "ms_dc" - Microsoft Domain Controller,
- "ldap" - Lightweight Directory Access Protocol (LDAP) server,
- "nis" - Network Information Service (NIS) server
- status => cifs-domain-discovered-server-status, optional
The status of the connection to the server that was discovered. Attributes: non-creatable, non-modifiable Possible values: - "ok" - The connection to this server is usable.,
- "unavailable" - This server is currently unavailable for use.,
- "slow" - The connection to this server is usable but slow.,
- "expired" - The connection to this server has expired.,
- "undetermined" - A connection to this server has not been attempted.,
- "unreachable" - This server is currently unreachable.
- vserver => vserver-name, optional
The name of the Vserver which scopes the discovered servers. Attributes: key, non-creatable, non-modifiable
List of preferred domain controllers associated with an Active Directory domain, organized by Vserver. 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
- domain => string, optional
The fully qualified domain name of the Active Directory domain to which the domain controllers in the list belong. Attributes: key, required-for-create, non-modifiable
- vserver => vserver-name, optional
Vserver containing the CIFS server. Attributes: key, non-creatable, non-modifiable
The preference level of the server either set due to configuration or due to the site membership determined by server discovery. Possible values: - "unknown" - The preference level of this server is unknown.,
- "preferred" - This server was administratively marked as a preferred server due to its presence in the list of preferred servers.,
- "favored" - This server was marked as favored by the server discovery process by virtue of site membership.,
- "adequate" - This server was discovered by the server discovery process and can be used, but has no preference associated with it.
Fields
The list of possible types of files opened through CIFS servers. Possible values: - "Regular" - Regular file
- "Symlink" - Symlink file
- "Stream" - Stream file
- "Directory" - Directory
Fields
This is a list of CIFS Home Directory search paths. When a CIFS client connects to a home directory share, these paths are searched in the order indicated by the 'position' field to find the user's home directory. 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
- path => string, optional
The file system path that will be searched for finding a CIFS user's home directory. Attributes: key, required-for-create, non-modifiable
- position => integer, optional
The position of this entry in the list of paths that will be searched for finding a CIFS user's home directory. Attributes: key, non-creatable, non-modifiable
- vserver => vserver-name, optional
The name of the Vserver associated with this CIFS server. Attributes: key, non-creatable, non-modifiable
List of local groups, organized by Vserver 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
The description of the local group Attributes: optional-for-create, modifiable
- vserver => vserver-name, optional
Vserver Attributes: key, non-creatable, non-modifiable
List of local groups, organized by Vserver 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
- group-name => cifs-name, optional
The name of the local group Attributes: key, non-creatable, non-modifiable
- vserver => vserver-name, optional
Vserver Attributes: key, non-creatable, non-modifiable
List of local users, organized by Vserver 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
The description of the local user Attributes: optional-for-create, modifiable
- full-name => string, optional
Full name of the local user Attributes: optional-for-create, modifiable
- is-account-disabled => boolean, optional
The user account is disabled Attributes: optional-for-create, modifiable
- vserver => vserver-name, optional
Vserver Attributes: key, non-creatable, non-modifiable
List of local users' membership information, organized by Vserver 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
- user-name => cifs-name, optional
The name of the local user Attributes: key, non-creatable, non-modifiable
- vserver => vserver-name, optional
Vserver Attributes: key, non-creatable, non-modifiable
nullFields
Display NetBIOS Statistics. 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
- nbt-mode => string, optional
Mode in which the NetBIOS Name Service is configured. Possible values: 'p' - Point to Point, 'h' - Hybrid, 'm' - Mixed or 'b' - Broadcast. Attributes: non-creatable, non-modifiable
- nbt-name-state => string, optional
Registration State of NetBIOS Name. Possible values: 'must_register', 'must_unregister', 'wins', 'broadcast', 'name_released', 'wins_conflict', 'broadcast_conflict. Attributes: non-creatable, non-modifiable
- nbt-scope => string, optional
Scope is used as a name for the set of NetBIOS nodes that participate in an NBT virtual LAN. Attributes: non-creatable, non-modifiable
- netbios-suffix => string, optional
A NetBIOS suffix is the 16th character of the 16-character NetBIOS name. The NetBIOS suffix is used by Microsoft Networking software to identify functionality installed on the registered device. Attributes: key, non-creatable, non-modifiable
- node => string, optional
The name of the node on which nbtstat was done. Attributes: key, non-creatable, non-modifiable
- vserver => string, optional
The Vserver name on which nbtstat was done. Attributes: key, non-creatable, non-modifiable
The list of possible modes used when opening files over CIFS servers. Possible values: - "R" - The file opened for read operation.
- "W" - The file opened for write operation.
- "D" - The file opened for delete operation.
Fields
The CIFS specific tunables that can be set on a Vserver. 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
- default-unix-group => string, optional
The default UNIX group used if the identity of a CIFS group cannot be mapped using normal group mapping rules. Attributes: optional-for-create, modifiable
- default-unix-user => string, optional
The default UNIX user used if the identity of a CIFS user cannot be mapped using normal user mapping rules. Attributes: optional-for-create, modifiable
- is-copy-offload-enabled => boolean, optional
This optional parameter specifies whether the CIFS server is capable of performing copy offload operation. The default value for this parameter is true. Attributes: optional-for-create, modifiable
- is-exportpolicy-enabled => boolean, optional
This optional parameter specifies whether the CIFS server uses export policies to control client access. The default value for this parameter is false. Attributes: optional-for-create, modifiable
- is-local-auth-enabled => boolean, optional
This optional parameter specifies whether CIFS local users can authenticate. Attributes: optional-for-create, modifiable
- is-local-users-and-groups-enabled => boolean, optional
This optional parameter specifies whether the CIFS local users and groups feature is enabled on the cluster. Attributes: optional-for-create, modifiable
- is-referral-enabled => boolean, optional
This optional parameter specifies whether the CIFS server refers clients to more optimal data access paths (LIFs). The default value for this parameter is false. Attributes: optional-for-create, modifiable
- is-shadowcopy-enabled => boolean, optional
This optional parameter specifies whether the CIFS server is capable of performing shadow copy operations. Attributes: optional-for-create, modifiable
- is-smb2-enabled => boolean, optional
This optional parameter specifies whether the CIFS server negotiates the SMB2 versions of the CIFS protocol. The default value for this parameter is true. Attributes: optional-for-create, modifiable
- is-smb3-enabled => boolean, optional
This optional parameter specifies whether the CIFS server negotiates the SMB3 version of the CIFS protocol. The default value for this parameter is true. Attributes: optional-for-create, modifiable
- is-use-junctions-as-reparse-points-enabled => boolean, optional
This optional parameter specifies whether the CIFS server exposes junction points as reparse points to Windows clients. Attributes: optional-for-create, modifiable
- max-mpx => integer, optional
This option controls maximum simultaneous operations the CIFS server reports it can process per TCP connection. The default value for this option is 255. Attributes: optional-for-create, modifiable
- read-grants-execute => enable, optional
On a file with UNIX Style security effective on it, if the file has read permission on it, a CIFS user would be allowed to execute permissions if this option is enabled. Attributes: optional-for-create, modifiable
- shadowcopy-dir-depth => integer, optional
This optional parameter specifies the maximum depth of directories to shadow copy. Attributes: optional-for-create, modifiable
- vserver => vserver-name, optional
The name of the Vserver associated with this CIFS server. Attributes: key, non-creatable, non-modifiable
- wins-servers => inet-address[], optional
List of Windows Internet Name Service (WINS) IP addresses. The Vserver will send NetBIOS name resolution requests to these addresses. Attributes: optional-for-create, modifiable
List of privileges assigned to local or Active Directory users or groups, organized by Vserver 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
- privileges => cifs-privilege-entries[], optional
The privileges associated with a local or Active Directory user or group Attributes: non-creatable, non-modifiable Possible values: - "setcbprivilege" - Act as part of the operating system,
- "sebackupprivilege" - Back up files and directories, overriding any ACLs,
- "serestoreprivilege" - Restore files and directories, overriding any ACLs,
- "setakeownershipprivilege" - Take ownership of files or other objects,
- "sesecurityprivilege" - Manage auditing and viewing/dumping/clearing the security log
- vserver => vserver-name, optional
Vserver Attributes: key, non-creatable, non-modifiable
Privilege Possible values: - "setcbprivilege" - Act as part of the operating system,
- "sebackupprivilege" - Back up files and directories, overriding any ACLs,
- "serestoreprivilege" - Restore files and directories, overriding any ACLs,
- "setakeownershipprivilege" - Take ownership of files or other objects,
- "sesecurityprivilege" - Manage auditing and viewing/dumping/clearing the security log
Fields
CIFS security tunable parameters. 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
- is-password-complexity-required => boolean, optional
This option determines whether password complexity is required for local users. By default this option is true. Attributes: required-for-create, modifiable
- is-signing-required => boolean, optional
This option determines whether signing is required for incoming CIFS traffic. By default this option is false. Attributes: required-for-create, modifiable
- kerberos-clock-skew => integer, optional
The clock skew in minutes is the tolerance for accepting tickets with time stamps that do not exactly match the host's system clock. Attributes: required-for-create, modifiable
- kerberos-renew-age => integer, optional
This option determines the maximum amount of time in days for which a ticket can be renewed. Attributes: required-for-create, modifiable
- kerberos-ticket-age => integer, optional
This option determines the maximum amount of time in hours that a user's ticket may be used for the purpose of Kerberos authentication. Attributes: required-for-create, modifiable
- vserver => vserver-name, optional
The name of the Vserver associated with this CIFS server. Attributes: key, non-creatable, non-modifiable
Basic configuration information for the CIFS Server. 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
- administrative-status => service-state, optional
CIFS Server Administrative Status. Attributes: optional-for-create, modifiable Possible values:
- auth-style => cifs-auth-style, optional
The authentication style to be used for CIFS clients connecting to this CIFS server. Attributes: non-creatable, non-modifiable Possible values: - "domain" - DOMAIN,
- "workgroup" - WORKGROUP
- default-site => string, optional
The default site used by LIFs that do not have a site membership. Attributes: optional-for-create, modifiable
- domain => string, optional
The Fully Qualified Domain Name of the Windows Active Directory this CIFS server belongs to. Attributes: required-for-create, modifiable
- organizational-unit => string, optional
The Organizational Unit (OU) within the Windows Active Directory this CIFS server belongs to. Attributes: optional-for-create, non-modifiable
- vserver => string, optional
Vserver containing the CIFS server. Attributes: key, non-creatable, non-modifiable
Displays the established CIFS sessions 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
- address => ip-address, optional
The ip address of the workstation from which the session is opened. Attributes: non-creatable, non-modifiable
- auth-mechanism => auth-mechanism, optional
The authentication mechanism used to establish the session. Attributes: non-creatable, non-modifiable Possible values: - "none" ,
- "ntlmv1" ,
- "ntlmv2" ,
- "kerberos" ,
- "anonymous"
- continuously-available => cifs-ca-protection, optional
The type of continuous avalability protection provided to the session. Attributes: non-creatable, non-modifiable Possible values: - "no" - The open file is not continuously available. For sessions, it contains one or more open file but none of them are continuously available.,
- "yes" - The open file is continuously available. For sessions, it contains one or more open files and all of them are continuously available.,
- "partial" - This value is used for sessions only. It contains at least one continuously available open file but other open files that are not.
- files => integer, optional
The number of the regular files that are opened under the session. Attributes: non-creatable, non-modifiable
- node => string, optional
The name of the node on which the session listing is done. Attributes: key, required-for-create, non-modifiable
- other => integer, optional
The number of the special files that are opened under the session. Attributes: non-creatable, non-modifiable
- protocol-version => cifs-dialects, optional
The CIFS protocol version that is used to establish the session. Attributes: non-creatable, non-modifiable Possible values: - "smb1" - SMB 1.0,
- "smb2" - SMB 2.0,
- "smb2_1" - SMB 2.1,
- "smb3" - SMB 3.0
- vserver => string, optional
The Vserver name on which the session listing is done. Attributes: key, non-creatable, non-modifiable
Displays the opened CIFS files 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
- connection-id => integer, optional
The connection that is used to open the file. Attributes: non-creatable, non-modifiable
- continuously-available => cifs-ca-protection, optional
The type of continuous availability protection provided to the file. Attributes: non-creatable, non-modifiable Possible values: - "no" - The open file is not continuously available. For sessions, it contains one or more open file but none of them are continuously available.,
- "yes" - The open file is continuously available. For sessions, it contains one or more open files and all of them are continuously available.,
- "partial" - This value is used for sessions only. It contains at least one continuously available open file but other open files that are not.
- node => string, optional
The name of the node on which the file listing is done. Attributes: key, required-for-create, non-modifiable
- path => string, optional
The path of the file. Attributes: non-creatable, non-modifiable
- session-id => integer, optional
The session under which file is opened. Attributes: non-creatable, non-modifiable
- vserver => string, optional
The Vserver name on which the file listing is done. Attributes: key, non-creatable, non-modifiable
CIFS share configuration. 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
- acl => string[], optional
This string list gives the applicable Access Control list for the CIFS share. Each list entry is a '/' separated pair of the User or Group name and the effective permissions. The permission could be 'Full Control', Change', 'Read' or 'No access'. e.g.: If the group is 'Everyone' and the effective permission for this group is 'Change', the entry would be 'Everyone / Change'. Attributes: non-creatable, non-modifiable
- attribute-cache-ttl => integer, optional
The lifetime of an entry in the file attribute cache, in seconds. This value is used if the share has the 'attributecache' property set, which improves the performance of certain metadata operations in common workloads. The default is 10 seconds. Raising this value may improve performance, but the likelihood that stale metadata will be served increases as well. The value of this field must be in the range of 1 to 86400. Attributes: optional-for-create, modifiable
- cifs-server => string, optional
The NetBIOS name of the CIFS server that owns this share. Attributes: non-creatable, non-modifiable
- comment => string, optional
This string gives a description of the CIFS share. CIFS clients see this description when browsing the Vserver's CIFS shares. Attributes: optional-for-create, modifiable
- dir-umask => integer, optional
The value of this field controls the file mode creation mask for the CIFS share in qtrees with UNIX or Mixed security styles. The mask restricts the initial permissions setting of a newly created directory. The input value is a numeric mode comprising of one to three octal digits (0-7), derived by adding up the bits with values 4, 2, and 1. The first digit selects permissions for the user who owns the file: read (4), write (2), and execute (1); the second selects permissions for other users in the file's group, with the same values; and the third for other users not in the file's group, with the same values. Attributes: optional-for-create, modifiable
- file-umask => integer, optional
The value of this field controls the file mode creation mask for the CIFS share in qtrees with UNIX or Mixed security styles. The mask restricts the initial permissions setting of a newly created file. The input value is a numeric mode comprising of one to three octal digits (0-7), derived by adding up the bits with values 4, 2, and 1. The first digit selects permissions for the user who owns the file: read (4), write (2), and execute (1); the second selects permissions for other users in the file's group, with the same values; and the third for other users not in the file's group, with the same values. Attributes: optional-for-create, modifiable
- offline-files-mode => string, optional
Mode of the offline file for the CIFS share. The default value is manual. Possible values: - "none" - Clients are not permitted to cache files for offline access.,
- "manual" - Clients may cache files that are explicitly selected by the user for offline use.,
- "documents" - Clients may automatically cache files that are used by the user for offline access.,
- "programs" - Clients may automatically cache files that are used by the user for offline access and may use those files in an offline mode even if the share is available.
- path => string, optional
The file system path that is shared through this CIFS share. The path is the full, user visible path relative to the vserver root, and it might be crossing junction mount points. The path is in UTF8 and uses forward slash as directory separator. Attributes: required-for-create, modifiable
- share-name => string, optional
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 \/[]:|<>+=;,?"* Attributes: key, required-for-create, non-modifiable
- share-properties => cifs-share-properties[], optional
The list of properties for this CIFS share. Attributes: optional-for-create, modifiable Possible values: - "oplocks" - This specifies that opportunistic locks (client-side caching) are enabled on this share.,
- "browsable" - This specifies that the share can be browsed by Windows clients.,
- "showsnapshot" - This specifies that Snapshots can be viewed and traversed by clients.,
- "changenotify" - This specifies that CIFS clients can request for change notifications for directories on this share.,
- "homedirectory" - This specifies that the share is added and enabled as part of the CIFS home directory feature. The configuration of this share should be done using CIFS home directory feature interface.,
- "attributecache" - This specifies that connections through this share are caching attributes for a short time to improve performance.
- "branchcache" - This specifies that 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.
- "continuously_available" - This specifies that clients connecting to this share can open files in a persistent manner. Files opened this way are protected from disruptive events, such as failover and giveback.
- "shadowcopy" - This specifies that the share is pointing to a shadow copy. This attribute cannot be added nor removed from a share.
- "access_based_enumeration" - This specifies that Access Based Enumeration is enabled on this share. 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.
- symlink-properties => cifs-share-symlink-properties[], optional
This flag controls whether the symlinks under this shared directory are hidden (option 'hide'), accessible (option 'enable') or are accessible as read-only (option 'read-only' along with option 'enable'). Attributes: optional-for-create, modifiable Possible values: - "enable" ,
- "hide" ,
- "read_only"
- volume => string, optional
The name of the volume where the root of the CIFS share resides.
- vserver => string, optional
The name of the Vserver. Attributes: key, required-for-create, non-modifiable
The permissions that users and groups have to a CIFS share. 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
- permission => cifs-access-perms, optional
The access rights that the user or group has on the defined CIFS share. Attributes: required-for-create, modifiable Possible values: - "no_access" - No access,
- "read" - Read,
- "change" - Change,
- "full_control" - Full Control
- share => string, optional
The CIFS share for which the permissions are defined. Attributes: key, required-for-create, non-modifiable
- vserver => vserver-name, optional
The name of the Vserver associated with this CIFS server. Attributes: key, non-creatable, non-modifiable
The name of the CIFS share. The CIFS share name is a Unicode string with the following characters being illegal: control characters from 0x00 to 0x1F, both inclusive, 0x22 (double quotes) and the characters \/[]:|<>+=;,?Fields
The list of properties on a CIFS share. Possible values: - "oplocks" - This specifies that opportunistic locks (client-side caching) are enabled on this share.,
- "browsable" - This specifies that the share can be browsed by Windows clients.,
- "showsnapshot" - This specifies that Snapshots can be viewed and traversed by clients.,
- "changenotify" - This specifies that CIFS clients can request for change notifications for directories on this share.,
- "homedirectory" - This specifies that the share is added and enabled as part of the CIFS home directory feature. The configuration of this share should be done using CIFS home directory feature interface.,
- "attributecache" - This specifies that connections through this share are caching attributes for a short time to improve performance.
- "branchcache" - This specifies that 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.
- "continuously_available" - This specifies that clients connecting to this share can open files in a persistent manner. Files opened this way are protected from disruptive events, such as failover and giveback.
- "shadowcopy" - This specifies that the share is pointing to a shadow copy. This attribute cannot be added nor removed from a share.
Fields
enable|hide|read_only Possible values: - "enable" ,
- "hide" ,
- "read_only"
Fields
CIFS symbolic link path mapping configuration. 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
- cifs-path => string, optional
This field specifies the CIFS path on the destination to which the symbolic link maps. The final path is generated by concatenating the CIFS server name, the share name, the cifs-path and the remaining path in the symbolic link left after the prefix match. This value is specified by using a UNIX-style path name. The trailing forward slash is required for the full path name to be properly interpreted. This is a UTF-8 string and supports localization. Attributes: required-for-create, modifiable
- cifs-server => string, optional
This field specifies the destination CIFS server name for the mapping to which the symbolic link is mapped. The default is the local CIFS server. The field needs to be specified if the locality of the symbolic link is 'widelink'. This can be either a DNS name, NetBIOS name or an IP address. If a DNS name or a NetBIOS name are specified, the CIFS client configuration should be such that it is capable of resolving the CIFS server name to the correct IP address. Attributes: optional-for-create, modifiable
- locality => cifs-symlink-locality, optional
This field specifies whether the CIFS symbolic link is a local link or wide link. A local symbolic link maps to the local CIFS share, whereas a wide symbolic link maps to any CIFS share on the network. If the CIFS server matches the VServer's NetBIOS name then the default value is local otherwise widelink. Attributes: optional-for-create, modifiable Possible values: - "local" - Share On This VServer,
- "widelink" - Share On Another CIFS Server
- share-name => string, optional
This field specifies the CIFS share name on the destination CIFS server to which the symbolic link is mapped. This is a UTF-8 string and supports localization. Attributes: required-for-create, modifiable
- unix-path => string, optional
This field specifies the UNIX path prefix to be matched for the mapping. If the prefix of the target path in the symbolic link matches against this field, this entry of symbolic link path mapping would be used. The path is a UTF-8 string and supports localization. The path must start and end with a forward slash ('/'). For example '/usr/local/'. Attributes: key, required-for-create, non-modifiable
- vserver => vserver-name, optional
The name of the Vserver associated with this CIFS server. Attributes: key, non-creatable, non-modifiable
Locality of the destination where this symbolic link points. Possible values: - "local" - Share On This VServer,
- "widelink" - Share On Another CIFS Server
Fields
The domain name is an identification label that defines a realm based on Domain Name Service (DNS).Fields
The difference between the two points in time.Fields
EMS IdFields
EMS Message Info 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
- ems-severity => emsseverity, optional
Message EMS severity. Attributes: non-creatable, non-modifiable Possible values: - "node_fault" - A data corruption has been detected or the node is unable to provide client service,
- "svc_fault" - A temporary loss of service has been detected, typically a transient software fault,
- "node_error" - A hardware error has been detected which is not immediately fatal,
- "svc_error" - A software error has been detected which is not immediately fatal,
- "warning" - A high-priority message, does not indicate a fault,
- "notice" - A normal-priority message, does not indicate a fault,
- "info" - A low-priority message, does not indicate a fault,
- "debug" - A debugging message, typically suppressed from customer,
- "var" - Message has variable severity, selected at runtime
- node => node-name, optional
Node emitting the EMS message. Attributes: key, non-creatable, non-modifiable
- severity => eventseverity, optional
Message severity. Attributes: non-creatable, non-modifiable Possible values: - "emergency" - System is unusable,
- "alert" - Action must be taken immediately,
- "critical" - Critical condition,
- "error" - Error condition,
- "warning" - Warning condition,
- "notice" - Normal but significant condition,
- "informational" - Information message,
- "debug" - A debugging message
NODE_FAULT|SVC_FAULT|NODE_ERROR|SVC_ERROR|WARNING|NOTICE|INFO|DEBUG|VAR Possible values: - "node_fault" - A data corruption has been detected or the node is unable to provide client service,
- "svc_fault" - A temporary loss of service has been detected, typically a transient software fault,
- "node_error" - A hardware error has been detected which is not immediately fatal,
- "svc_error" - A software error has been detected which is not immediately fatal,
- "warning" - A high-priority message, does not indicate a fault,
- "notice" - A normal-priority message, does not indicate a fault,
- "info" - A low-priority message, does not indicate a fault,
- "debug" - A debugging message, typically suppressed from customer,
- "var" - Message has variable severity, selected at runtime
Fields
'enabled' or 'disabled'Fields
EMERGENCY|ALERT|CRITICAL|ERROR|WARNING|NOTICE|INFORMATIONAL|DEBUG Possible values: - "emergency" - System is unusable,
- "alert" - Action must be taken immediately,
- "critical" - Critical condition,
- "error" - Error condition,
- "warning" - Warning condition,
- "notice" - Normal but significant condition,
- "informational" - Information message,
- "debug" - A debugging message
Fields
Internet AddressFields
Name of a client or a server participating in a NetBIOS Windows File sharing service network. This can be different from the host name.Fields
down|up Possible values: Fields
Unique Windows Security Identifier that identifies a User or Group or Machine account.Fields
Windows Internet Name Server (WINS) informationFields
Structure containing source and destination block range for sub-file/sub-LUN cloning.Fields
Information that identifies a given cluster. 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
- cluster-contact => string, optional
The contact information for the cluster Attributes: non-creatable, modifiable
- cluster-location => string, optional
The location of the cluster Attributes: non-creatable, modifiable
- cluster-name => string, optional
The textual name of the cluster Attributes: non-creatable, modifiable
- cluster-uuid => uuid, optional
The 128-bit universally-unique identifier, that designates the cluster forever, assigned during cluster creation Attributes: non-creatable, non-modifiable
Information that identifies state of nodes in a cluster. 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
- is-node-eligible => boolean, optional
This parameter states nodes that are eligible to participate in the cluster. A boolean value of true means the node is eligible. Attributes: non-creatable, modifiable
- is-node-epsilon => boolean, optional
You can designate a node as epsilon to add weight to its voting in a cluster with an even number of nodes. In a cluster, only one node can be designated as epsilon at any given time. A boolean value of true means the node is epsilon. Attributes: non-creatable, modifiable
- is-node-healthy => boolean, optional
This parameter is used to determine health of a node in a cluster. A boolean value of true means the node is healthy. Attributes: non-creatable, non-modifiable
- node-uuid => uuid, optional
The 128-bit universally-unique identifier, that designates a node forever, assigned during node creation. Attributes: non-creatable, non-modifiable
Assigned Cluster serial-number during cluster createFields
Name of the Peer ClusterFields
The availability of the peer cluster. Possible values: - "unavailable" ,
- "available"
Fields
Cluster Peer Health Info 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
- bypass-cache => boolean, optional
When false, do not use cached results. Cached results may not be current, but may be retrieved quickly. Attributes: non-creatable, non-modifiable
- data-ping => peer-ping-status, optional
The status of Data Ping operation. Possible values are (interface-reachable, unreachable). Attributes: non-creatable, non-modifiable Possible values: - "unknown_node" - Unknown Node,
- "internal_error" - Internal Error,
- "unreachable" - Unreachable,
- "session_reachable" - Session Reachable,
- "interface_reachable" - Interface Reachable
- icmp-ping => peer-ping-status, optional
The status of ICMP Ping operation. Possible values are (interface-reachable, unreachable). Attributes: non-creatable, non-modifiable Possible values: - "unknown_node" - Unknown Node,
- "internal_error" - Internal Error,
- "unreachable" - Unreachable,
- "session_reachable" - Session Reachable,
- "interface_reachable" - Interface Reachable
- is-node-healthy => boolean, optional
The RDB health of the node. True means the node is in quorum. Attributes: non-creatable, non-modifiable
Contains information about the cluster peer. 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
- cluster-name => string, optional
The name of the peer cluster. Attributes: key, non-creatable, non-modifiable
- peer-addresses => remote-inet-address[], optional
The Remote IP address or host name of the peer cluster. Attributes: non-creatable, modifiable
- timeout => integer, optional
The timeout for operations in the peer cluster in seconds. Default: 15 Attributes: non-creatable, modifiable
Cluster Peer Ping Configuration 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
- destination-cluster => cluster-name, optional
The name of the destination cluster. Attributes: key, non-creatable, non-modifiable
- destination-cluster-uuid => string, optional
The UUID of the destination cluster. Attributes: non-creatable, non-modifiable
- destination-node => string, optional
The name of the destination node. Attributes: key, non-creatable, non-modifiable
- originating-node => node-name, optional
The name of the originating node. Attributes: key, non-creatable, non-modifiable
- ping-status => peer-ping-status, optional
The status of the ping operation. Attributes: non-creatable, non-modifiable Possible values: - "unknown_node" - Unknown Node,
- "internal_error" - Internal Error,
- "unreachable" - Unreachable,
- "session_reachable" - Session Reachable,
- "interface_reachable" - Interface Reachable
- timeout => integer, optional
The timeout to use when pinging the peer cluster in seconds. Default: 15 Attributes: non-creatable, non-modifiable
- type => peer-ping-protocol, optional
The network protocol to use when performing the ping operation. Attributes: non-creatable, non-modifiable Possible values: - "data" - Data Ping,
- "icmp" - ICMP Ping
The name of a node in a peer clusterFields
The network protocol to use when performing the ping operation. Possible values: - "data" - Data Ping,
- "icmp" - ICMP Ping
Fields
The status of the ping operation. Possible values: - "unknown_node" - Unknown Node,
- "internal_error" - Internal Error,
- "unreachable" - Unreachable,
- "session_reachable" - Session Reachable,
- "interface_reachable" - Interface Reachable
Fields
IPv4 Address or Host NameFields
The type of a configuration backup. Possible values: - "node" - Node Backup,
- "cluster" - Cluster Backup
Fields
Configuration Backup Information 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
- backup-name => string, optional
The name of the configuration backup. Attributes: key, non-creatable, non-modifiable
- backup-type => backup-type, optional
Indicates if the backup is a node or a cluster backup. A node backup contains only node-specific configuration of a particular node in the cluster. A cluster backup contains cluster-wide replicas in addition to node backup of each node in the cluster. If backup-type is not provided, cluster backup is assumed by default. Attributes: non-creatable, non-modifiable Possible values: - "node" - Node Backup,
- "cluster" - Cluster Backup
- cluster-name => string, optional
The name of the cluster which the configuration backup was created for. This field is set only for cluster backups. For node backups, the nodes-in-backup field indicates the name of the node. Attributes: non-creatable, non-modifiable
- cluster-uuid => string, optional
The UUID of the cluster which the configuration backup was created for. This field is set only for cluster backups. Attributes: non-creatable, non-modifiable
- is-auto => boolean, optional
True indicates that configuration backup is a scheduled backup that was created automatically by a schedule. False indicates that configuration backup was created on demand. Attributes: non-creatable, non-modifiable
- node => string, optional
The node that owns the configuration backup. This is the node that has the backup file on its root volume. Attributes: key, non-creatable, non-modifiable
- schedule => string, optional
The name of the job schedule for scheduled backups. Possible values are: '8hour', 'daily', and 'weekly'. This field is not set for on demand backups created via management CLI or ZAPI. Attributes: non-creatable, non-modifiable
- version => string, optional
The software version which the configuration backup was created with. Attributes: non-creatable, non-modifiable
Configuration Backup Settings 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
- backup-count1 => integer, optional
The number of configuration backups to keep in the cluster for schedule 1. Attributes: non-creatable, modifiable
- backup-count2 => integer, optional
The number of configuration backups to keep in the cluster for schedule 2. Attributes: non-creatable, modifiable
- backup-count3 => integer, optional
The number of configuration backups to keep in the cluster for schedule 3. Attributes: non-creatable, modifiable
- destination-url => string, optional
The destination URL for uploading the configuration backups. URL is specified following the syntax described in RFC 3986. Only 'ftp', 'http' and 'https' protocols are supported. Attributes: non-creatable, modifiable
- job-schedule1 => string, optional
The name of the first job schedule for generating configuration backups. It is pre-programmed to be '8hour'. Attributes: non-creatable, non-modifiable
- job-schedule2 => string, optional
The name of the second job schedule for generating configuration backups. It is pre-programmed to be 'daily'. Attributes: non-creatable, non-modifiable
- job-schedule3 => string, optional
The name of the third job schedule for generating configuration backups. It is pre-programmed to be 'weekly'. Attributes: non-creatable, non-modifiable
- username-for-destination-url => string, optional
The username for the destination URL. Attributes: non-creatable, modifiable
Alarm Monitoring State Possible values: - "ok" ,
- "warning" ,
- "critical"
Fields
Alarm monitoring data 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
- dashboard-metric-type => dashboard-metric-type, optional
The type of metric being monitored. Attributes: key, non-creatable, non-modifiable Possible values: - "cpu_busy" - CPU Utilization,
- "port_util" - Port Utilization,
- "op_latency" - Average Client Latency of NFS and CIFS operations,
- "aggregate_used" - Storage Aggregate Utilization,
- "port_problems" - Packet Error Ratio
- node => string, optional
Name of the node associated with the alarm metrics. Attributes: key, non-creatable, non-modifiable
- object-name => string, optional
Name associated with the object being monitored. For example, the object-name is the name of the node if the dashboard-metric-type is cpu-busy. Attributes: key, non-creatable, non-modifiable
- state => alarm-state, optional
The current alarm state of the object being monitored. Attributes: non-creatable, non-modifiable Possible values: - "ok" ,
- "warning" ,
- "critical"
Alarm threshold configuration settings 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
- critical-threshold => string, optional
The threshold value that must be reached to generate a critical alarm for this type of metric. Get request is returned with % sign for percent values and ms for milliseconds value. Example : 95%, 500ms Attributes: optional-for-create, modifiable
- dashboard-metric-type => dashboard-metric-type, optional
The type of metric being monitored. Attributes: key, required-for-create, non-modifiable Possible values: - "cpu_busy" - CPU Utilization,
- "port_util" - Port Utilization,
- "op_latency" - Average Client Latency of NFS and CIFS operations,
- "aggregate_used" - Storage Aggregate Utilization,
- "port_problems" - Packet Error Ratio
- is-user-notification-enabled => boolean, optional
Specifies whether user notifications are enabled. Attributes: required-for-create, modifiable
- polling-interval => integer, optional
The refresh interval for the alarm dashboard metrics (in seconds). Attributes: required-for-create, modifiable
- threshold-units => threshold-unit, optional
Threshold Units Attributes: optional-for-create, modifiable Possible values: - "none" - none,
- "ms" - milliseconds,
- "percent" - percent
- warning-threshold => string, optional
The threshold value that must be reached to generate a warning alarm for this type of metric. Get request is returned with % sign for percent values and ms for milliseconds value. Example : 85%, 200ms Attributes: required-for-create, modifiable
Metric Type Possible values: - "cpu_busy" - CPU Utilization,
- "port_util" - Port Utilization,
- "op_latency" - Average Client Latency of NFS and CIFS operations,
- "aggregate_used" - Storage Aggregate Utilization,
- "port_problems" - Packet Error Ratio
Fields
Dashboard Threshold Units Possible values: - "none" - none,
- "ms" - milliseconds,
- "percent" - percent
Fields
Date (in seconds since Jan. 1, 1970 12:00:00) Range : [0..2^31-1].Fields
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
- node => string, optional
Node hosting this health monitor. Attributes: key, non-creatable, non-modifiable
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
- policy => string, optional
Policy rule responsible for creating this 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
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
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
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
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
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
Type of alertFields
Event typeFields
Notify typeFields
Alert severityFields
Probable cause for alert generationFields
Node or Cluster context of Health Monitor Possible values: - "node_context" ,
- "cluster_context"
Fields
Health Monitor Status Possible values: - "ok" ,
- "ok_with_suppressed" ,
- "degraded" ,
- "unreachable" ,
- "unknown"
Fields
Health Monitor SubsystemFields
Health Monitor Subsystem State Possible values: - "invalid" ,
- "initializing" ,
- "initialized" ,
- "start_discovery" ,
- "start_rediscovery" ,
- "discovered_partially" ,
- "discovery_done" ,
- "discovery_max"
Fields
Type of Health MonitorFields
name of a disk.Fields
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.
- dr-home-id => integer, optional
ID (NVRAM ID) of home owner of a disk in switchover state when there is a disaster. Before disaster switchover, the value of this field is zero. At the time of switchover, it would be changed so as to keep track of whom to give the disks to, at the time of switchback. If the disk has no dr home id, this will not be returned.
- dr-home-owner => string, optional
This is the name of home owner of a disk in switchover state when there is a disaster. Before disaster switchover, the value of this field is a NULL string. At the time of switchover, it would be changed so as to keep track of whom to give the disks to, at the time of switchback. If the disk has no dr home owner, this will not be returned.
- 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 information.Fields
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.
EMS Configuration Info 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
- console => boolean, optional
Whether console logging should be used. Attributes: non-creatable, modifiable
- console-log-level => emsseverity, optional
Console logging level. Attributes: non-creatable, modifiable Possible values: - "node_fault" - A data corruption has been detected or the node is unable to provide client service,
- "svc_fault" - A temporary loss of service has been detected, typically a transient software fault,
- "node_error" - A hardware error has been detected which is not immediately fatal,
- "svc_error" - A software error has been detected which is not immediately fatal,
- "warning" - A high-priority message, does not indicate a fault,
- "notice" - A normal-priority message, does not indicate a fault,
- "info" - A low-priority message, does not indicate a fault,
- "debug" - A debugging message, typically suppressed from customer,
- "var" - Message has variable severity, selected at runtime
- mail-from => mail-address, optional
The from address of ems mail. Attributes: non-creatable, modifiable
- mail-server => remote-ip, optional
The mail server to use when sending mail. Attributes: non-creatable, modifiable
- max-log-show-size => integer, optional
Maximum number of events to show. Attributes: non-creatable, modifiable
- max-target-event-bytes => integer, optional
Maximum bytes per event per week. Used by autosuppression to control growth of log file size. Attributes: non-creatable, modifiable
- max-target-log-size => integer, optional
The target upper limit of the event log file size in bytes. Used by autosuppression to control growth of log file size. Attributes: non-creatable, modifiable
- suppression => boolean, optional
Whether suppression should be used. Attributes: non-creatable, modifiable
- trace-log-size => integer, optional
Maximum number of traces kept. Attributes: non-creatable, modifiable
EMS destinationFields
Information about the deletion operation that was attempted/performed against ems-destination object.Fields
EMS Destination Info 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
- hide-parameters => boolean, optional
Hide parameter values? Attributes: optional-for-create, modifiable
- mail => mail-address[], optional
The e-mail address to which events are sent. Attributes: optional-for-create, modifiable
- name => string, optional
The name of the EMS destination. Attributes: key, required-for-create, non-modifiable
- snmp => remote-ip[], optional
The SNMP addresses to which traps are sent. Attributes: optional-for-create, modifiable
- snmp-community => string, optional
The SNMP community name. Attributes: optional-for-create, modifiable
- syslog => remote-ip[], optional
The remote syslog servers to which messages are sent. Attributes: optional-for-create, modifiable
- syslog-facility => syslog-facility, optional
The syslog logging facility. Attributes: optional-for-create, modifiable
Information about the modify operation that was attempted/performed against ems-destination object.Fields
- ems-destination-key => ems-destination-info
The keys for the ems-destination object to which the modify operation applies.
- error-code => integer, optional
Error code, if the modify operation caused an error.
- error-message => string, optional
Error description, if the modify operation caused an error.
Information about the deletion operation that was attempted/performed against ems-mail-history object.Fields
- error-code => integer, optional
Error code, if the deletion operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
EMS Mail History Info 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
- message => string, optional
The alert message. Attributes: non-creatable, non-modifiable
- message-name => ems-id, optional
The emitted message's name. Attributes: non-creatable, non-modifiable
- node => node-name, optional
Node emitting the EMS message. Attributes: key, required-for-create, non-modifiable
- seq-num => seqnum, optional
The message sequence number. Attributes: key, required-for-create, non-modifiable
- time => datetime, optional
The mail transmission time. Attributes: non-creatable, non-modifiable
EMS Routing Info 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
- action => string, optional
The configured action. Attributes: non-creatable, non-modifiable
- description => string, optional
The event description. Attributes: non-creatable, non-modifiable
- destinations => ems-destination[], optional
The event destinations. Attributes: non-creatable, modifiable
- frequency-threshold => integer, optional
Number of times an event occurs before a repeat notification of the event is sent. Attributes: non-creatable, modifiable
- message-name => ems-id, optional
The name of the EMS message. Attributes: key, non-creatable, non-modifiable
- severity => eventseverity, optional
The event severity. Attributes: non-creatable, non-modifiable Possible values: - "emergency" - System is unusable,
- "alert" - Action must be taken immediately,
- "critical" - Critical condition,
- "error" - Error condition,
- "warning" - Warning condition,
- "notice" - Normal but significant condition,
- "informational" - Information message,
- "debug" - A debugging message
- time-threshold => integer, optional
Minimum number of seconds between repeat notifications of an event. Attributes: non-creatable, modifiable
Information about the modify operation that was attempted/performed against ems-routing object.Fields
- error-code => integer, optional
Error code, if the modify operation caused an error.
- error-message => string, optional
Error description, if the modify operation caused an error.
Information about the deletion operation that was attempted/performed against ems-snmp-history object.Fields
- error-code => integer, optional
Error code, if the deletion operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
EMS SNMP History Info 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
- drops-since-previous-time => integer, optional
Number of drops since previous transmission. Attributes: non-creatable, non-modifiable
- message => string, optional
The alert message. Attributes: non-creatable, non-modifiable
- message-name => ems-id, optional
The emitted message's name. Attributes: non-creatable, non-modifiable
- node => node-name, optional
Node emitting the EMS message. Attributes: key, required-for-create, non-modifiable
- previous-time => datetime, optional
Previous transmission time. Attributes: non-creatable, non-modifiable
- seq-num => seqnum, optional
The message sequence number. Attributes: key, required-for-create, non-modifiable
- time => datetime, optional
The SNMP transmission time. Attributes: non-creatable, non-modifiable
EMS Message Info 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
- change-since => boolean, optional
The algorithm to determine which events are considered chatter is run periodically. The change-since parameter indicates whether the event has been posted since the last time the chatter determination algorithm has run. Attributes: non-creatable, non-modifiable
- is-chatter => boolean, optional
Whether the event is considered chatter, and therefore subject to autosuppression. Attributes: non-creatable, non-modifiable
- last-day-histogram => integer[], optional
24-hour histogram. Number of times the event was posted in the last day. The histogram is divided into 24 buckets, each bucket collecting one hour. The buckets are displayed in reverse chronological order (most recent first). Attributes: non-creatable, non-modifiable
- last-hour-histogram => integer[], optional
60-minute histogram. Number of times the event was posted in the last hour. The histogram is divided into sixty buckets, each bucket collecting one minute. The buckets are displayed in reverse chronological order (most recent first). Attributes: non-creatable, non-modifiable
- last-week-histogram => integer[], optional
7-day histogram. Number of times the event was posted in the last week. The histogram is divided into 7 buckets, each bucket collecting one day. The buckets are displayed in reverse chronological order (most recent first). Attributes: non-creatable, non-modifiable
- message-name => ems-id, optional
The message name. Attributes: key, non-creatable, non-modifiable
- node => node-name, optional
Node emitting the EMS message. Attributes: key, non-creatable, non-modifiable
- num-suppressed-since-last => integer, optional
Number of times suppressed since last time logged. Attributes: non-creatable, non-modifiable
- severity => emsseverity, optional
The severity of the event. Attributes: non-creatable, non-modifiable Possible values: - "node_fault" - A data corruption has been detected or the node is unable to provide client service,
- "svc_fault" - A temporary loss of service has been detected, typically a transient software fault,
- "node_error" - A hardware error has been detected which is not immediately fatal,
- "svc_error" - A software error has been detected which is not immediately fatal,
- "warning" - A high-priority message, does not indicate a fault,
- "notice" - A normal-priority message, does not indicate a fault,
- "info" - A low-priority message, does not indicate a fault,
- "debug" - A debugging message, typically suppressed from customer,
- "var" - Message has variable severity, selected at runtime
Remote IP AddressFields
The syslog facility.Fields
any|nfs3|nfs|cifs|nfs4|flexcache Possible values: - "any" - Any,
- "nfs2" - NFS Version 2,
- "nfs3" - NFS Version 3,
- "nfs" - Any Version of NFS,
- "cifs" - CIFS,
- "nfs4" - NFS Version 4,
- "flexcache" - Flexcache
Fields
Information about the Export policy configuration. 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
- policy-name => string, optional
Export policy name. Attributes: key, required-for-create, non-modifiable
- vserver => string, optional
Vserver name. Attributes: key, non-creatable, non-modifiable
Information about the Export rule configuration. 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
- anonymous-user-id => string, optional
User name or ID to which anonymous users are mapped. Default value is '65534'. Attributes: optional-for-create, modifiable
- client-match => string, optional
Client match specification for Export rule. The clients specified are enforced with this Export rule. The rule with the higher rule index value takes precedence. Attributes: required-for-create, modifiable
- export-chown-mode => exportchownmode, optional
Change ownership mode. Possible values are 'restricted', 'unrestricted'. Default value is 'restricted'. Attributes: optional-for-create, modifiable Possible values: - "restricted" ,
- "unrestricted"
- export-ntfs-unix-security-ops => exportntfsunixsecops, optional
Ignore/Fail unix security operations on NTFS volumes. Possible values are 'ignore', 'fail'. Default value is 'fail'. Attributes: optional-for-create, modifiable Possible values:
- is-allow-dev-is-enabled => boolean, optional
If 'true', the NFS server will allow creation of devices. Default value is 'true'. Attributes: optional-for-create, modifiable
- is-allow-set-uid-enabled => boolean, optional
If 'true', NFS server will honor SetUID bits in SETATTR operation. Default value is 'true'. Attributes: optional-for-create, modifiable
- policy-name => string, optional
Export policy name. Attributes: key, required-for-create, non-modifiable
- protocol => access-protocol[], optional
Client access protocol. Default value is 'any'. Attributes: optional-for-create, modifiable Possible values: - "any" - Any,
- "nfs2" - NFS Version 2,
- "nfs3" - NFS Version 3,
- "nfs" - Any Version of NFS,
- "cifs" - CIFS,
- "nfs4" - NFS Version 4,
- "flexcache" - Flexcache
- ro-rule => security-flavor[], optional
Rule for read-only access. Attributes: required-for-create, modifiable Possible values: - "any" - Any,
- "none" - Anonymous Access Allowed If Security Type Not Already Listed,
- "never" - Never,
- "krb5" - Kerberos 5 Authentication,
- "ntlm" - CIFS NTLM,
- "sys" - NFS AUTH_SYS,
- "spinauth" - SpinAuth
- rule-index => integer, optional
Export rule index. Attributes: key, optional-for-create, non-modifiable
- rw-rule => security-flavor[], optional
Rule for read-write access. Attributes: required-for-create, modifiable Possible values: - "any" - Any,
- "none" - Anonymous Access Allowed If Security Type Not Already Listed,
- "never" - Never,
- "krb5" - Kerberos 5 Authentication,
- "ntlm" - CIFS NTLM,
- "sys" - NFS AUTH_SYS,
- "spinauth" - SpinAuth
- super-user-security => security-flavor[], optional
Security flavors for the superuser. Default value is 'none'. Attributes: optional-for-create, modifiable Possible values: - "any" - Any,
- "none" - Anonymous Access Allowed If Security Type Not Already Listed,
- "never" - Never,
- "krb5" - Kerberos 5 Authentication,
- "ntlm" - CIFS NTLM,
- "sys" - NFS AUTH_SYS,
- "spinauth" - SpinAuth
restricted|unrestricted Possible values: - "restricted" ,
- "unrestricted"
Fields
ignore|fail Possible values: Fields
any|none|never|krb5|ntlm|sys Possible values: - "any" - Any,
- "none" - Anonymous Access Allowed If Security Type Not Already Listed,
- "never" - Never,
- "krb5" - Kerberos 5 Authentication,
- "ntlm" - CIFS NTLM,
- "sys" - NFS AUTH_SYS,
- "spinauth" - SpinAuth
Fields
fc 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
- node-name => string, optional
Node name Attributes: key, non-creatable, non-modifiable
A list of WWPNs and their aliases generated according to the input - alias, WWPN or nothing.Fields
- vserver => string, optional
Vserver containing the alias
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.
- vserver => string, optional
Vserver of the FCP LIF.
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.
- 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.
Configuration information for one physical FC adapter.Fields
- adapter => string
The slot name of the FC adapter.
- fabric-name => string, optional
The name of the FC fabric this adapter is connected to. Only returned if the adapter is logged into the fabric. This field is available in Data ONTAP 8.2 and later.
- 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 => string
The name of the node where the adapter is installed.
- 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.
- physical-protocol => string, optional
The physical protocol of the adapter. Possible values: - "fibre_channel" - The adapter is a Fibre Channel adapter,
- "ethernet" - The adapter is a Fibre Channel over Ethernet adapter.
- 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". If an error occured while retrieving info for this adapter, this will not be returned.
- 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.
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.
Information about a single FCP Logical Interface (LIF). 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
- node-name => string, optional
World Wide Node Name (WWNN) of the LIF. All LIFs in a Vserver have the same WWNN as the Vserver's FCP service. Attributes: non-creatable, non-modifiable
- port-name => string, optional
World Wide Port Name (WWPN) of the LIF. Attributes: non-creatable, non-modifiable
- vserver => string, optional
Vserver hosting the LIF. Attributes: key, non-creatable, non-modifiable
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.
- vserver => string
Vserver containing this port name
FCP target service configuration. 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
- node-name => string, optional
The world-wide node name (WWNN) of the FCP target in the Vserver. Attributes: optional-for-create, modifiable
- vserver => string, optional
Vserver hosting the FCP service. Attributes: key, non-creatable, non-modifiable
Aliases for this WWPNFields
Information about the ports belonging to the fiber channel adapterFields
- 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"
list link-state info of a specific adapter channelFields
- 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.
- node-name => string, optional
This field is only valid when the request is sent to the Admin Vserver LIF, in which case it is the storage system name.
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
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
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
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-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.
- 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.
- 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.
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]
no-access|full-control|modify|read-and-execute|read|write Possible values: - "no_access" ,
- "full_control" ,
- "modify" ,
- "read_and_execute" ,
- "read" ,
- "write"
Fields
deny|allow Possible values: Fields
Advanced access right Possible values: - "read_data" ,
- "write_data" ,
- "append_data" ,
- "read_ea" ,
- "write_ea" ,
- "execute_file" ,
- "delete_child" ,
- "read_attr" ,
- "write_attr" ,
- "delete" ,
- "read_perm" ,
- "write_perm" ,
- "write_owner" ,
- "full_control"
Fields
failure|success Possible values: Fields
NTFS security descriptor management 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
- control-flags-raw => integer, optional
Specifies the security descriptor control flags in hexa decimal. The following are the bit fields of control flags.
1... .... .... .... = Self Relative
.0.. .... .... .... = RM Control Valid
..0. .... .... .... = SACL Protected
...0 .... .... .... = DACL Protected
.... 0... .... .... = SACL Inherited
.... .0.. .... .... = DACL Inherited
.... ..0. .... .... = SACL Inherit Required
.... ...0 .... .... = DACL Inherit Required
.... .... ..0. .... = SACL Defaulted
.... .... ...0 .... = SACL Present
.... .... .... 0... = DACL Defaulted
.... .... .... .1.. = DACL Present
.... .... .... ..0. = Group Defaulted
.... .... .... ...0 = Owner Defaulted
At present only the following flags are honored. Others are ignored.
..0. .... .... .... = SACL Protected
...0 .... .... .... = DACL Protected
.... .... ..0. .... = SACL Defaulted
.... .... .... 0... = DACL Defaulted
.... .... .... ..0. = Group Defaulted
.... .... .... ...0 = Owner Defaulted Attributes: optional-for-create, modifiable
- group => name-or-sid, optional
Specifies group's SID or domain account name of NTFS security descriptor. Attributes: optional-for-create, modifiable
- ntfs-sd => fsecurity-ntfs-sd, optional
Specifies NTFS security descriptor identifier. Attributes: key, required-for-create, non-modifiable
- owner => name-or-sid, optional
Specifies owner's SID or domain account name of NTFS security descriptor. Attributes: optional-for-create, modifiable
- vserver => string, optional
Vserver Attributes: key, non-creatable, non-modifiable
fsecurity SACL configuration 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
- account => name-or-sid, optional
Specifies DACL ACE's SID or domain account name of NTFS security descriptor. Attributes: key, required-for-create, non-modifiable
- advanced-rights => advanced-access-rights[], optional
Specifies DACL ACE's Advanced access rights. Mutually exclusive with rights and rights-raw fields. Attributes: optional-for-create, modifiable Possible values: - "read_data" ,
- "write_data" ,
- "append_data" ,
- "read_ea" ,
- "write_ea" ,
- "execute_file" ,
- "delete_child" ,
- "read_attr" ,
- "write_attr" ,
- "delete" ,
- "read_perm" ,
- "write_perm" ,
- "write_owner" ,
- "full_control"
- apply-to => inheritance-level[], optional
Specifies this ACE has to be applied on. Attributes: optional-for-create, modifiable Possible values: - "this_folder" ,
- "sub_folders" ,
- "files"
- ntfs-sd => fsecurity-ntfs-sd, optional
Specifies NTFS security descriptor identifier. Attributes: key, required-for-create, non-modifiable
- rights => access-rights, optional
Specifies DACL ACE's access rights. Mutually exclusive with advanced-rights and rights-raw fields. Attributes: optional-for-create, modifiable Possible values: - "no_access" ,
- "full_control" ,
- "modify" ,
- "read_and_execute" ,
- "read" ,
- "write"
- rights-raw => integer, optional
Specifies DACL ACE's access rights in raw. This field is similar to advanced-rights fields. 'advanced-rights' specifies the value in enum but rights-raw specifies the access rights in integer format. Mutually exclusive with rights and advanced-rights fields. Attributes: optional-for-create, modifiable
- vserver => string, optional
Vserver Attributes: key, non-creatable, non-modifiable
fsecurity SACL configuration 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
- account => name-or-sid, optional
Specifies SACL ACE's SID or domain account name of NTFS security descriptor. Attributes: key, required-for-create, non-modifiable
- advanced-rights => advanced-access-rights[], optional
Specifies SACL ACE's access rights. Mutually exclusive with rights-raw field. Attributes: optional-for-create, modifiable Possible values: - "read_data" ,
- "write_data" ,
- "append_data" ,
- "read_ea" ,
- "write_ea" ,
- "execute_file" ,
- "delete_child" ,
- "read_attr" ,
- "write_attr" ,
- "delete" ,
- "read_perm" ,
- "write_perm" ,
- "write_owner" ,
- "full_control"
- apply-to => inheritance-level[], optional
Specifies how this ACE has to be applied on this folder and it's subfolders and files. This field is ignored if the security is mapped with a path which is not a folder. Attributes: optional-for-create, modifiable Possible values: - "this_folder" ,
- "sub_folders" ,
- "files"
- audit-access-type => audit-access-type, optional
Specifies SACL ACE's access type. Attributes: key, required-for-create, non-modifiable Possible values:
- ntfs-sd => fsecurity-ntfs-sd, optional
Specifies NTFS security descriptor identifier. Attributes: key, required-for-create, non-modifiable
- readable-access-rights => string, optional
Specifies the current access rights. Access rights can be specified by one of the following fields, rights, advanced-rights and rights-raw. These fields are mutually exclusive fields. If rights field is set and other two fields (advanced-rights, rights-raw) cant be set and so readable-access-rights field has the value of rights field. If rights-raw field is set and other two fields (advanced-rights, rights) are not set then readable-access-rights field has the value of rights-raw field. If advanced-rights field is set and other two fields (rights, rights-raw) are not set then readable-access-rights field has the value of advanced-rights field. Attributes: non-creatable, non-modifiable
- rights => access-rights, optional
Specifies SACL ACE's access rights. Attributes: optional-for-create, modifiable Possible values: - "no_access" ,
- "full_control" ,
- "modify" ,
- "read_and_execute" ,
- "read" ,
- "write"
- rights-raw => integer, optional
Specifies SACL ACE's access rights in raw. This field is similar to advanced-rights fields. 'advanced-rights' specifies the value in enum but rights-raw specifies the access rights in integer format. Mutually exclusive with rights and advanced-rights fields. Attributes: optional-for-create, modifiable
File/folder security policy management 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
- policy-name => fsecurity-policy-name, optional
Specifies the name of the policy. To preserve the security configuration of a file(or, folder) or set of files(or, folders) security policy has been defined. Policy is a container for tasks and a task associates a file/folder path name and the security descriptor that needs to be set on the file/folder. Every task in a policy is uniquely identified by the file/folder path. Policy can't have duplicate task entries and there is only one task per path. Attributes: key, required-for-create, non-modifiable
- vserver => string, optional
Vserver Attributes: key, non-creatable, non-modifiable
File security policy task management 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
- ntfs-mode => ntfs-propagation-mode, optional
Specifies the NTFS propagation mode. Attributes: optional-for-create, modifiable Possible values: - "propagate" ,
- "ignore" ,
- "replace"
- ntfs-sd => fsecurity-ntfs-sd, optional
Specifies the NTFS security descriptor identifier. Attributes: optional-for-create, modifiable
- path => string, optional
Specifies the file or folder path of a task. Attributes: key, required-for-create, non-modifiable
- policy-name => fsecurity-policy-name, optional
Specifies the name of the policy who has the task. Attributes: key, required-for-create, non-modifiable
- security-type => security-type, optional
Specifies the type of security. Attributes: optional-for-create, modifiable Possible values:
- task-index-number => integer, optional
Specifies the target index/position of this task in the policy. If the task is currently placed in 5th position in a policy and you want to reorder this task as 2nd task, you can set the index-num to 2. If the index number exceeds the number of positions, it will go at the end. Attributes: optional-for-create, modifiable
- vserver => string, optional
Vserver Attributes: key, non-creatable, non-modifiable
The file or directory security access control list.Fields
NTFS file security descriptor identifier. This can be any valid text input.Fields
The file/folder security policy identifier. This can be any valid text.Fields
this-folder|sub-folders|files Possible values: - "this_folder" ,
- "sub_folders" ,
- "files"
Fields
An user or group name that is specified in the form of valid username/groupname with domain or valid SID stringFields
propagate|ignore|replace Possible values: - "propagate" ,
- "ignore" ,
- "replace"
Fields
unix|ntfs|mixed|unified Possible values: - "unix" - NFS,
- "ntfs" - CIFS,
- "mixed" - Mixed,
- "unified" - Unified
Fields
ntfs|nfsv4 Possible values: Fields
Vserver IdFields
Job Manager cron scheduling day of month. -1 represents all days of a month from 1 to 31, and only supported for cron schedule create and modify. Range : [-1..31].Fields
Job Manager cron scheduling day of week. Zero represents Sunday. -1 represents all days of a week and only supported for cron schedule create and modify. Range : [-1..6].Fields
Job Manager cron scheduling hour. -1 represents all hours and only supported for cron schedule create and modify. Range : [-1..23].Fields
Job Manager cron scheduling minute. -1 represents all minutes and only supported for cron schedule create and modify. Range : [-1..59].Fields
Job Manager cron scheduling month. -1 represents all months and only supported for cron schedule create and modify. Range : [-1..11].Fields
Vserver Audit configuration and management on name 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
- audit-guarantee => boolean, optional
Strict guarantee of auditing for a Vserver. If this is true, file access is denied if audit record can not be generated and if this is false, auditing is done on a best effort basis. Default: true Attributes: non-creatable, modifiable
- destination => string, optional
Audit log destination path. The path where consolidated audit logs are stored. If the path is not valid, the api returns error Attributes: required-for-create, modifiable
- is-enabled => boolean, optional
Auditing State. Default: false Attributes: non-creatable, non-modifiable
- rotate-limit => integer, optional
Audit log files rotation Limit. A value of 0 indicates that all the files will be retained. Default: 0 Attributes: optional-for-create, modifiable
- rotate-schedule-day => cron-day-of-month[], optional
Audit log rotation schedule: Day. By Default rotation is done based on size. This field is mutually exclusive with rotate-size. Do not use this field along with rotate-size field Attributes: optional-for-create, modifiable
- rotate-schedule-dayofweek => cron-day-of-week[], optional
Audit log rotation schedule: Day of Week. By Default rotation is done based on size. This field is mutually exclusive with rotate-size. Do not use this field along with rotate-size field Attributes: optional-for-create, modifiable
- rotate-schedule-hour => cron-hour[], optional
Audit log rotation schedule: Hour. By Default rotation is done based on size. This field is mutually exclusive with rotate-size. Do not use this field along with rotate-size field Attributes: optional-for-create, modifiable
- rotate-schedule-minute => cron-minute[], optional
Audit Log rotation schedule: Minute. By Default rotation is done based on size. This field is mutually exclusive with rotate-size. Do not use this field along with rotate-size field Attributes: optional-for-create, modifiable
- rotate-schedule-month => cron-month[], optional
Audit log rotation schedule: Month. By Default rotation is done based on size. This field is mutually exclusive with rotate-size. Do not use this field along with rotate-size field Attributes: optional-for-create, modifiable
- rotate-size => psize, optional
Audit log file size limit. By default rotation is done based on size. This field is mutually exclusive with time related rotate fields. If time based rotation is needed use the time based rotation fields(rotate-schedule-month, rotate-schedule-dayofweek, rotate-schedule-day... etc). Default: 100MB Attributes: optional-for-create, modifiable
- vserver => vserver-name, optional
Vserver Attributes: key, non-creatable, non-modifiable
size in bytes Range : [1..2^63-1].Fields
Flash device information.Fields
- firmware-revision => string
Firmware revision of FPGA on the flash device.
- node => string
The name of the system where the flash device is installed.
- 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".
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".
A definition for a threshold elementFields
- node => string
The name of the system to which the flash thresholds apply.
FlexCache Cache Policy 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
- cache-policy-name => string, optional
The name of the FlexCache Cache Policy being created, modified or deleted. The maximum length is 255 characters. Attributes: key, required-for-create, non-modifiable
- deleg-lru-timeout => integer, optional
The Timeout for the Delegations LRU represents the time in seconds since the last use of the delegation, after which a Cache considers it unused and returns it to Origin. Attributes: optional-for-create, modifiable
- prefer-local-cache => boolean, optional
If set to true, data is served from the local cache, otherwise from the local origin. Attributes: optional-for-create, modifiable
- time-to-live-directories => integer, optional
The Time To Live (TTL) for Directories represents the time, in seconds, that attributes and data of a Directory are served from the Cache volume before they are verified with the Origin volume. Attributes: required-for-create, modifiable
- time-to-live-files => integer, optional
The Time To Live (TTL) for files represents the time, in seconds, that attributes and data of a file are served from the Cache volume before they are verified with the Origin volume. Attributes: required-for-create, modifiable
- time-to-live-metafiles => integer, optional
The Time To Live (TTL) for ONTAP Metafiles represents the time, in seconds, that attributes and data of an ONTAP Metafile are served from the Cache volume before they are verified with the Origin volume. Attributes: optional-for-create, modifiable
- time-to-live-other => integer, optional
The Time To Live (TTL) for any file that doesn't fall into the other TTL categories represents the time, in seconds, that attributes and data of that file are served from the Cache volume before they are verified with the Origin volume. Attributes: optional-for-create, modifiable
- time-to-live-symbolic => integer, optional
The Time To Live (TTL) for Symbolic Links represents the time, in seconds, that attributes and data of a Symbolic Link are served from the Cache volume before they are verified with the Origin volume. Attributes: optional-for-create, modifiable
- vserver => string, optional
The name of the managing Vserver. Maximum length is 255 characters. Attributes: key, non-creatable, non-modifiable
FlexCache Info 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
- cache-size => integer, optional
Cache Volume Size Attributes: non-creatable, non-modifiable
- cache-state => string, optional
Cache Volume State Attributes: non-creatable, non-modifiable Possible values: - "online" ,
- "restricted" ,
- "offline" ,
- "force_online" ,
- "force_offline" ,
- "mixed"
- connection-status => string, optional
The status of the connection between the cache and the origin volumes. It can be 'connected', 'disconnected' or 'connecting'. Attributes: non-creatable, non-modifiable
- origin-state => string, optional
Origin Volume State Attributes: non-creatable, non-modifiable Possible values: - "online" ,
- "restricted" ,
- "offline" ,
- "force_online" ,
- "force_offline" ,
- "mixed"
- vserver => string, optional
The name of the Vserver where the created cache is located. Maximum length is 255 characters. Attributes: key, non-creatable, non-modifiable
FlexCache Options 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
- delegations-high-watermark => integer, optional
This is the maximum number of delegations that can be given out per node in the cluster. When this limit is reached, no further delegations can be given out to Cache clients. Attributes: non-creatable, modifiable
- delegations-low-watermark => integer, optional
This is the number of delegations per node, at which the node resumes giving out delegations to Cache clients. Attributes: non-creatable, modifiable
- per-cache-statistics => boolean, optional
Keep statistics per cache volume basis Attributes: non-creatable, modifiable
Engine nameFields
Event nameFields
External Engine Type Possible values: - "synchronous" - Synchronous External Engine,
- "asynchronous" - Asynchronous External Engine
Fields
Vserver FPolicy Event configuration and management on name 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
- file-operations => fpolicy-operation[], optional
Name of file operations. By default no operations are monitored. Attributes: optional-for-create, modifiable Possible values: - "close" - File close operation,
- "create" - File create operation,
- "create_dir" - File create directory operation,
- "delete" - File delete operation,
- "delete_dir" - Directory delete operation,
- "getattr" - Get attribute operation,
- "link" - Link operation,
- "lookup" - Lookup operation,
- "open" - File open operation,
- "read" - File read operation,
- "write" - File write operation,
- "rename" - File rename operation,
- "rename_dir" - Directory rename operation,
- "setattr" - Set attribute operation,
- "symlink" - Symbolic link operation
- filter-string => fpolicy-filter[], optional
Name of filters. It is notification filtering parameters. By default no filters are selected. Attributes: optional-for-create, modifiable Possible values: - "monitor_ads" - Monitor alternate data stream,
- "close_with_modification" - Filter close with modification,
- "close_without_modification" - Filter close without modification,
- "first_read" - Filter first read,
- "first_write" - Filter first write,
- "offline_bit" - Filter offline bit set,
- "open_with_delete_intent" - Filter open with delete intent,
- "open_with_write_intent" - Filter open with write intent,
- "write_with_size_change" - Filter write with size change
- protocol => fpolicy-proto, optional
Name of protocol for which event is created. By default no protocol is selected. Attributes: optional-for-create, modifiable Possible values: - "cifs" - CIFS protocol,
- "nfsv3" - NFSv3 protocol,
- "nfsv4" - NFSv4 protocol
- volume-operation => boolean, optional
Indicator if the volume operation required for the event.Default Value is false. Attributes: optional-for-create, modifiable
- vserver => string, optional
Vserver Attributes: key, non-creatable, non-modifiable
External engine configuration and management. 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
- certificate-ca => string, optional
Certificate authority name. No default value is set for this field. Attributes: optional-for-create, modifiable
- certificate-common-name => common-name, optional
FQDN or custom common name of certificate. No default value is set for this field. Attributes: optional-for-create, modifiable
- certificate-serial => string, optional
Serial number of certificate. No default value is set for this field. Attributes: optional-for-create, modifiable
- engine-name => engine-name, optional
Name of the external engine. Attributes: key, required-for-create, non-modifiable
- extern-engine-type => external-engine-type, optional
External engine type. If the engine is asynchronous, no reply is sent from FPolicy servers. Default value set for this field is synchronous. Attributes: optional-for-create, modifiable Possible values: - "synchronous" - Synchronous External Engine,
- "asynchronous" - Asynchronous External Engine
- keep-alive-interval => integer, optional
Interval time in seconds for storage appliance to send keep-alive message to FPolicy server. Default value set for this field is 10 seconds. Attributes: optional-for-create, modifiable
- max-connection-retries => integer, optional
Number of times storage appliance will attempt to establish a broken connection to FPolicy server. Default value set for this field is 5. Attributes: optional-for-create, modifiable
- max-server-requests => integer, optional
Maximum number of outstanding screen requests that will be queued for an FPolicy Server. Default value set for this field is 50. Attributes: optional-for-create, modifiable
- port-number => integer, optional
Port number of the FPolicy server application. Attributes: required-for-create, modifiable
- primary-servers => ip-address[], optional
Primary FPolicy servers. Attributes: required-for-create, modifiable
- request-abort-timeout => integer, optional
Timeout in seconds for a screen request to be aborted by storage appliance. Default value set for this field is 40 seconds. Attributes: optional-for-create, modifiable
- request-cancel-timeout => integer, optional
Timeout in seconds for a screen request to be processed by an FPolicy server. Default value set for this field is 20 seconds. Attributes: optional-for-create, modifiable
- secondary-servers => ip-address[], optional
Secondary FPolicy servers. No default value is set for this field. Attributes: optional-for-create, modifiable
- server-progress-timeout => integer, optional
Timeout in seconds in which a throttled FPolicy server must complete at least one screen request. If no request is processed within the timeout, connection to FPolicy server is terminated. Default value set for this field is 60 seconds. Attributes: optional-for-create, modifiable
- ssl-option => fpolicy-ssl-opts, optional
SSL option for external communication. No default value is set for this field. Attributes: required-for-create, modifiable Possible values: - "no_auth" - Communication over TCP,
- "server_auth" - Authentication of FPolicy server only,
- "mutual_auth" - Mutual authentication of storage system and FPolicy server
- status-request-interval => integer, optional
Interval time in seconds for storage appliance to query status request from FPolicy server. Default value set for this field is 10 seconds. Attributes: optional-for-create, modifiable
- vserver => string, optional
Vserver Attributes: key, non-creatable, non-modifiable
Filter Possible values: - "monitor_ads" - Monitor alternate data stream,
- "close_with_modification" - Filter close with modification,
- "close_without_modification" - Filter close without modification,
- "first_read" - Filter first read,
- "first_write" - Filter first write,
- "offline_bit" - Filter offline bit set,
- "open_with_delete_intent" - Filter open with delete intent,
- "open_with_write_intent" - Filter open with write intent,
- "write_with_size_change" - Filter write with size change
Fields
File Operation Possible values: - "close" - File close operation,
- "create" - File create operation,
- "create_dir" - File create directory operation,
- "delete" - File delete operation,
- "delete_dir" - Directory delete operation,
- "getattr" - Get attribute operation,
- "link" - Link operation,
- "lookup" - Lookup operation,
- "open" - File open operation,
- "read" - File read operation,
- "write" - File write operation,
- "rename" - File rename operation,
- "rename_dir" - Directory rename operation,
- "setattr" - Set attribute operation,
- "symlink" - Symbolic link operation
Fields
FPolicy policy information 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
- allow-privileged-access => boolean, optional
Indicator if privileged access should be given to FPolicy servers registered for the policy. Default Value is no. Attributes: optional-for-create, modifiable
- engine-name => engine-name, optional
Name of the Engine. Default Engine is 'native'. Attributes: required-for-create, modifiable
- events => event-name[], optional
Events for file access monitoring. Attributes: required-for-create, modifiable
- is-mandatory => boolean, optional
Indicator if the screening with this policy is required, i.e. it will fail if no servers are able process the notification registered as a part of external engine. 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 value is true. Attributes: optional-for-create, modifiable
- privileged-user-name => string, optional
User name for privileged access. No default value is set for this attribute. Attributes: optional-for-create, modifiable
- vserver => string, optional
Vserver Attributes: key, non-creatable, non-modifiable
FPolicy Policy status information. 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
- policy-name => policy-name, optional
Name of the policy. Attributes: key, non-creatable, non-modifiable
- sequence-number => integer, optional
Sequence number(or priority) of the policy. 1 being highest and 10 being smallest. Default value is 1. Attributes: non-creatable, non-modifiable
- status => boolean, optional
Status of the policy. When on, policy is active. Attributes: non-creatable, non-modifiable
- vserver => string, optional
Vserver Attributes: key, non-creatable, non-modifiable
Protocol Possible values: - "cifs" - CIFS protocol,
- "nfsv3" - NFSv3 protocol,
- "nfsv4" - NFSv4 protocol
Fields
Vserver FPolicy Scope configuration and management on name 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
- check-extensions-on-directories => boolean, optional
Indicates whether directory names are also subjected to extensions check, similar to file names. By default, the value is false. Attributes: optional-for-create, modifiable
- export-policies-to-exclude => string[], optional
Export Policies to exclude for file access monitoring. By default no export policy is selected. Attributes: optional-for-create, modifiable
- export-policies-to-include => string[], optional
Export policies to include for file access monitoring. By default no export policy is selected. Attributes: optional-for-create, modifiable
- file-extensions-to-exclude => string[], optional
File extensions excluded for screening. By default no file extension is selected. Attributes: optional-for-create, modifiable
- file-extensions-to-include => string[], optional
File extensions included for screening. By default no file extension is selected. Attributes: optional-for-create, modifiable
- policy-name => policy-name, optional
Name of the policy. Attributes: key, required-for-create, non-modifiable
- shares-to-exclude => string[], optional
Shares to exclude for file access monitoring. By default no share is selected. Attributes: optional-for-create, modifiable
- shares-to-include => string[], optional
Shares to include for file access monitoring. By default no share is selected. Attributes: optional-for-create, modifiable
- volumes-to-exclude => string[], optional
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. By default no volume is selected. Attributes: optional-for-create, modifiable
- volumes-to-include => string[], optional
Volumes that are active for the file policy. The list can include items which are regular expressions, such as 'vol*' or 'user?'. By default no volume is selected. Attributes: optional-for-create, modifiable
- vserver => string, optional
Vserver Attributes: key, non-creatable, non-modifiable
Status Possible values: - "connected" - Server Connected,
- "disconnected" - Server Disconnected,
- "connecting" - Connecting Server,
- "disconnecting" - Disconnecting Server
Fields
External engine configuration and management. 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
- node => node-name, optional
Cluster node name. Attributes: key, non-creatable, non-modifiable
- policy-name => policy-name, optional
Name of the policy. Attributes: key, non-creatable, non-modifiable
- server-status => fpolicy-server-status, optional
Status of the connection. Attributes: non-creatable, non-modifiable Possible values: - "connected" - Server Connected,
- "disconnected" - Server Disconnected,
- "connecting" - Connecting Server,
- "disconnecting" - Disconnecting Server
- server-type => fpolicy-server-type, optional
FPolicy server type. FPolicy server can be registered as primary or secondary server. Attributes: non-creatable, non-modifiable Possible values: - "primary" - Primary Server,
- "secondary" - Secondary Server
- vserver => string, optional
Vserver Attributes: key, non-creatable, non-modifiable
Server Type Possible values: - "primary" - Primary Server,
- "secondary" - Secondary Server
Fields
no-auth|server-auth|mutual-auth Possible values: - "no_auth" - Communication over TCP,
- "server_auth" - Authentication of FPolicy server only,
- "mutual_auth" - Mutual authentication of storage system and FPolicy server
Fields
Policy nameFields
GPO information that is currently applied on a CIFS-enabled Vserver. 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
- extension => string[], optional
List of the GPO extensions. Attributes: non-creatable, non-modifiable Possible values: - "registry" - Registry Setting,
- "diskquota" - Disk Quota,
- "scripts" - Scripts,
- "security" - Security,
- "efsrecovery" - EFS Recovery,
- "ipsecurity" - IP Security,
- "unsupport" - Unsupported Feature
- link => string, optional
Type of the GPO. Attributes: non-creatable, non-modifiable Possible values: - "local" - Local,
- "site" - Site,
- "domain" - Domain,
- "organizationalunit" - Organizational Unit
- registry-hash-publication => hash-publication-mode, optional
Hash Publication for BranchCache. Attributes: non-creatable, non-modifiable Possible values: - "per_share" - Allow hash publication only for shared folders on which BranchCache is enabled.,
- "disabled" - Disallow hash publication on all shared folders.,
- "all_shares" - Allow hash publication for all shared folder.
- vserver => string, optional
Vserver display name. Attributes: key, non-creatable, non-modifiable
Group Policy configuration for Vservers. 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
- is-gpo-enabled => boolean, optional
Group Policy Zapi Status. Attributes: non-creatable, modifiable
- vserver => vserver-name, optional
The name of the Vserver associated with this group-policy. Attributes: key, non-creatable, non-modifiable
GPO RSoP(Resultant Set of Policy) that is currently defined on the Active Directory for a CIFS-enabled Vserver. 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
- dspath => string, optional
LDAP DN path. Attributes: non-creatable, non-modifiable
- extension => string[], optional
List of the GPO extensions. Attributes: non-creatable, non-modifiable Possible values: - "registry" - Registry Setting,
- "diskquota" - Disk Quota,
- "scripts" - Scripts,
- "security" - Security,
- "efsrecovery" - EFS Recovery,
- "ipsecurity" - IP Security,
- "unsupport" - Unsupported Feature
- filesyspath => string, optional
File System Path of a GPO policy file. Attributes: non-creatable, non-modifiable
- gpo-index => integer, optional
The index of the GPO in the GPO list of a Vserver. Attributes: key, non-creatable, non-modifiable
- gpo-name => string, optional
GPO name in text format. Attributes: non-creatable, non-modifiable
- gpo-status => string, optional
GPO status for each listed GPO: enabled or disabled. Attributes: non-creatable, non-modifiable
- gpo-uuid => string, optional
GPO name in UUID format. Attributes: non-creatable, non-modifiable
- link => string, optional
Type of the GPO. Attributes: non-creatable, non-modifiable Possible values: - "local" - Local,
- "site" - Site,
- "domain" - Domain,
- "organizationalunit" - Organizational Unit
- registry-hash-publication => hash-publication-mode, optional
Hash Publication for BranchCache. Attributes: non-creatable, non-modifiable Possible values: - "per_share" - Allow hash publication only for shared folders on which BranchCache is enabled.,
- "disabled" - Disallow hash publication on all shared folders.,
- "all_shares" - Allow hash publication for all shared folder.
- registry-hash-version => hash-version-type, optional
Hash Version Support for BranchCache. Attributes: non-creatable, non-modifiable Possible values: - "all_versions" - Version 1 and 2 (V1 and V2).,
- "version1" - Version 1 (V1).,
- "version2" - Version 2 (V2).
- registry-refresh-interval => integer, optional
Registry refreshint time interval. Attributes: non-creatable, non-modifiable
- registry-refresh-random-offset => integer, optional
Registry refreshing time random offset. Attributes: non-creatable, non-modifiable
- security-kerberos-clock-skew => integer, optional
Kerberos maximum clock skew; Maximum tolerance for computer clock synchronization. Attributes: non-creatable, non-modifiable
- security-kerberos-renewal-age => integer, optional
Kerberos maximum lifetime for user ticket renewal. Attributes: non-creatable, non-modifiable
- security-kerberos-ticket-age => integer, optional
Kerberos maximum lifetime for user ticket. Attributes: non-creatable, non-modifiable
- security-privilege-take-ownership => string, optional
Privilege rights: Take Ownership. Attributes: non-creatable, non-modifiable
- version => integer, optional
The individual GPO's update version. Attributes: non-creatable, non-modifiable
- vserver => string, optional
Vserver display name. Attributes: key, non-creatable, non-modifiable
Hash Support Possible values: - "per_share" - Allow hash publication only for shared folders on which BranchCache is enabled.,
- "disabled" - Disallow hash publication on all shared folders.,
- "all_shares" - Allow hash publication for all shared folder.
Fields
Hash Version Possible values: - "all_versions" - Version 1 and 2 (V1 and V2).,
- "version1" - Version 1 (V1).,
- "version2" - Version 2 (V2).
Fields
group mapping configuration for Vservers. The possible sources of group mapping information and the order in which they are searched is determined by the Vserver's 'name-mapping-switch' option. If the 'name-mapping-switch' is set to 'file', the rules in this table are used to determine the mapping. Windows user groups, UNIX user groups and Kerberos principal groups can be three disjoint sets of groups. A mechanism is needed to map groups from one set to another when presenting ACLs across multiprotocol clients. Each group mapping entry represents one such map in a given direction. group mappings are done using standard UNIX style regular expressions for pattern replacement. For example if a configuration is required to convert any Windows user in the Windows domain name 'EXAMPLE' into a UNIX user with the same name in NIS, the direction entry should be set to 'win-unix', the pattern string should be set to 'EXAMPLE\\(.+)' and the replacement string should be set to1389 :double backslash (\\) in the pattern matches a single backslash in the source name. The parentheses denote a subexpression but do not match any characters themselves. The 'period' matches any single character. The 'plus' matches one or more characters of the previous expression. The pattern 'EXAMPLE\\(.+)' matches 'EXAMPLE\' followed by one or more of any character. In the replacement, '\1' refers to the string that the first subexpression matched. Assuming the Windows user 'EXAMPLE\user1', the replacement evaluates to 'user1'. If a mapping is required from Windows to UNIX and none of the name mapping entries match, the domain name is stripped from the the username and it is directly mapped to the UNIX user of the same name. Similarly if a mapping is required from a UNIX user to a Windows user and none of the name mapping entries match, the domain name is prefixed to the username and it is directly mapped to a Windows user of the same name. 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
- direction => name-mapping-direction, optional
Direction in which the group mapping is applied. Attributes: key, required-for-create, non-modifiable Possible values: - "krb_unix" - Kerberos principal name to UNIX user name mapping,
- "win_unix" - Windows user name to UNIX user name mapping,
- "unix_win" - UNIX user name to Windows user name mapping
- pattern => string, optional
Pattern to use to match the group while searching for a group that can be used as a replacement. The pattern is a UNIX-style regular expression. Regular expressions are case-insensitive when mapping from Windows to UNIX, and they are case-sensitive for mappings from Kerberos to UNIX and UNIX to Windows. Attributes: required-for-create, modifiable
- position => integer, optional
Position of an existing group mapping in the list of group mappings for this Vserver. Attributes: key, required-for-create, non-modifiable
- replacement => string, optional
The group that is to be used as a replacement if the pattern associated with this entry matches. The replacement is a string containing escape sequences representing subexpressions from the pattern, as in the UNIX 'sed' program. Attributes: required-for-create, modifiable
- vserver => string, optional
Specifies the Vserver for the group mapping. Attributes: key, non-creatable, non-modifiable
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.
- vserver => string, optional
Name of the vserver hosting this initiator group
Initiator group this initiator belogs to.Fields
- initiator-group-name => string
Name of initiator group.
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
Information about one initiator.Fields
Information about a single interfaceFields
- 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.
Counts for Command Descriptor Blocks processedFields
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-name => string
The name of the target portal group associated with this session.
- tpgroup-tag => integer
The tag of the target portal group associated with this session.
- vserver => string
Name of the vserver containing this connection.
Counts for iSCSI errors.Fields
- total => integer
Total errors.
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-name => string
The name of the target portal group associated with this session.
- tpgroup-tag => integer
Tag of target portal group associated with this session.
- vserver => string
Name of the vserver this initiator is connected to.
Information about a single accesslist entry 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
- interface-name => string, optional
iSCSI LIF Name Attributes: key, non-creatable, non-modifiable
- vserver => string, optional
Vserver hosting the iSCSI LIF Attributes: key, non-creatable, non-modifiable
Information about a single interfaceFields
- 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.
- vserver => string, optional
The name of the vserver containing this iSCSI data LIF.
iSCSI iSNS Service Configuration. 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
- last-successful-update => integer, optional
Last successful iSNS update time in seconds since January 1, 1970. Attributes: non-creatable, non-modifiable
- last-update-attempt => integer, optional
Last iSNS update attempt time in seconds since January 1, 1970. Attributes: non-creatable, non-modifiable
- last-update-result => string, optional
Result of the last iSNS update. Attributes: non-creatable, non-modifiable
- vserver => string, optional
Vserver hosting the iSNS service. Attributes: key, non-creatable, non-modifiable
Counts for PDUs received.Fields
- total => integer
Total PDUs received.
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.
- vserver => string
Vserver containing this authentication information.
iSCSI Target Service Configuration. 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
- alias-name => string, optional
The iSCSI target alias of the Vserver. Attributes: optional-for-create, modifiable
- is-available => boolean, optional
true if the iSCSI Service is running, false otherwise. Attributes: non-creatable, non-modifiable
- node-name => string, optional
The iSCSI target name of the Vserver. Attributes: optional-for-create, modifiable
- vserver => string, optional
Vserver hosting the iSCSI service. Attributes: key, non-creatable, non-modifiable
Information about a single tcp connectionFields
- authentication-method => string
Authentication method of this connection. Possible values: "CHAP", "none".
- 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.
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-name => string
The name of the target portal group associated with this session.
- tpgroup-tag => integer
The tag of the target portal group associated with this session.
- vserver => string
The name of the vserver containing this session.
information about a particular commandFields
- 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".
Statistics blockFields
- vserver => string
Vserver hosting the iSCSI service.
Information about a single portal groupFields
- tpgroup-name => string
Portal group name.
- tpgroup-tag => integer
Portal group tag.
- vserver => string, optional
Vserver containing this target portal group.
Counts for PDUs transmitted.Fields
- total => integer
Total PDUs transmitted.
All jobs are scheduled with direction as to where they should execute. This affinity may either be node-specific or apply to all nodes (cluster). The affinity of the job is specific to the type of operations the job performs and is not user configurable. Possible values: - "cluster" - Cluster Affinity,
- "node" - Node Affinity
Fields
Jobs will trigger history events at certain stages of their life cycle. These events are of the types described herein. Possible values: - "idle" - The job has become idle,
- "running" - The job has started running,
- "succeeded" - The job has completed successfully,
- "failed" - The job has completed with a failure,
- "paused" - The job has been paused,
- "stopped" - The job has been stopped,
- "deleted" - The job has been deleted,
- "error" - Job Manager experienced an error while processing the job
Fields
Job history log event 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
- job-event-type => job-event-type, optional
The type of this history event. Attributes: non-creatable, non-modifiable Possible values: - "idle" - The job has become idle,
- "running" - The job has started running,
- "succeeded" - The job has completed successfully,
- "failed" - The job has completed with a failure,
- "paused" - The job has been paused,
- "stopped" - The job has been stopped,
- "deleted" - The job has been deleted,
- "error" - Job Manager experienced an error while processing the job
- job-id => integer, optional
The identifier associated with this job by the Job Manager. This identifier is unique within a cluster. The 'job-history-get-iter' API can return multiple records for a given job identifier because it logs the state transitions that the job has been through. Records in the 'job-history-get-iter' API are returned in reverse chronological order. Attributes: non-creatable, non-modifiable
- job-manager-error-code => integer, optional
The error code, if any, that the Job Manager associated with this event. If set, 'job-error-text' will contain human-readable information about the error. Attributes: non-creatable, non-modifiable
- job-node => node-name, optional
The name of the node where the job ran, or the node that changed the job's state. Attributes: key, non-creatable, non-modifiable
- job-status-code => integer, optional
Status code. Value other than 0 indicates an error in the job execution, in which case 'job-completion' will contain human-readable information about the error. Attributes: non-creatable, non-modifiable
The name of the Vserver.Fields
Contains information about a specific job. 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
- job-affinity => job-affinity, optional
Job affinity indicates whether this job is tied to a specific node or not. Attributes: non-creatable, non-modifiable Possible values: - "cluster" - Cluster Affinity,
- "node" - Node Affinity
- job-completion => string, optional
Human-readable job completion text. Attributes: non-creatable, non-modifiable
- job-description => string, optional
Job description. Attributes: non-creatable, non-modifiable
- job-end-time => integer, optional
When the job finished running. The time value is in seconds since January 1, 1970. Attributes: non-creatable, non-modifiable
- job-id => integer, optional
The job id. Attributes: key, non-creatable, non-modifiable
- job-name => string, optional
Name of the job. Attributes: non-creatable, non-modifiable
- job-progress => string, optional
Information about the progress of this job. Attributes: non-creatable, non-modifiable
- job-start-time => integer, optional
When the job started running. The time value is in seconds since January 1, 1970. Attributes: non-creatable, non-modifiable
- job-state => job-state, optional
Job state. See the category discussion section for a detailed description of job states. Attributes: non-creatable, non-modifiable Possible values: - "initial" - Initializing,
- "queued" - Queued,
- "running" - Running,
- "waiting" - Waiting For Another Job,
- "pausing" - Entering Paused State,
- "paused" - Paused,
- "quitting" - Entering Quit State,
- "success" - Succeeded,
- "failure" - Failed,
- "reschedule" - Forcing Reschedule,
- "error" - Internal Error,
- "quit" - Quit,
- "dead" - Died,
- "unknown" - Unknown,
- "restart" - Forcing Restart,
- "dormant" - Waiting For External Event
- job-status-code => integer, optional
Status code. Value other than 0 indicates an error in the job execution, in which case 'job-completion' will contain human-readable information about the error. Attributes: non-creatable, non-modifiable
- job-username => string, optional
The name of the user that created the job. Attributes: non-creatable, non-modifiable
- job-uuid => uuid, optional
Job's universally unique identifier (UUID). Attributes: non-creatable, non-modifiable
Information about the operation that was attempted/performed against job object.Fields
- error-code => integer, optional
Error code, if the operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
Execution priority of a job. There are thread pools for each priority level. Higher priority jobs may run in the pools of lower priorities. So High-priority jobs may run in the High, Medium or Low thread pools, Medium-priority jobs may run in the Medium or Low thread pools and Low-priority jobs may only run in the Low thread pool. The exception to this is Exclusive jobs: Exclusive-priority jobs will only run in the Exclusive thread pool and only Exclusive-priority jobs will be run in the Exclusive thread pool. Possible values: - "low" ,
- "medium" ,
- "high" ,
- "exclusive"
Fields
Information about the operation that was attempted/performed against private job object.Fields
- error-code => integer, optional
Error code, if the operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
Information about the operation that was attempted/performed against private job object.Fields
- error-code => integer, optional
Error code, if the operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
- job-private-key => job-info
The keys for the private job object to which the operation applies.
Information about the operation that was attempted/performed against private job object.Fields
- error-code => integer, optional
Error code, if the operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
- job-private-key => job-info
The keys for the private job object to which the operation applies.
Information about the operation that was attempted/performed against private job object.Fields
- error-code => integer, optional
Error code, if the operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
- job-private-key => job-info
The keys for the private job object to which the operation applies.
Information about the operation that was attempted/performed against job object.Fields
- error-code => integer, optional
Error code, if the operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
- job-key => job-info
The keys for the job object to which the operation applies.
Information about the deletion operation that was attempted/performed against job-schedule-cron object.Fields
- error-code => integer, optional
Error code, if the deletion operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
Contains detail information about cron job schedules. 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
- job-schedule-cron-day => cron-day-of-month[], optional
The day(s) of the month when the job should be run. Attributes: optional-for-create, modifiable
- job-schedule-cron-day-of-week => cron-day-of-week[], optional
The day(s) in the week when the job should be run. Attributes: optional-for-create, modifiable
- job-schedule-cron-hour => cron-hour[], optional
The hour(s) of the day when the job should be run. Attributes: optional-for-create, modifiable
- job-schedule-cron-minute => cron-minute[], optional
The minute(s) of each hour when the job should be run. Attributes: required-for-create, modifiable
- job-schedule-cron-month => cron-month[], optional
The month(s) when the job should be run. Attributes: optional-for-create, modifiable
Contains overview information about a single job schedule. 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
- job-schedule-description => string, optional
The description of the job schedule. Attributes: non-creatable, non-modifiable
- job-schedule-name => string, optional
The name of the job schedule. Attributes: key, required-for-create, non-modifiable
Information about the deletion operation that was attempted/performed against job-schedule-interval object.Fields
- error-code => integer, optional
Error code, if the deletion operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
Contains detail information about interval job schedules. 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
- job-schedule-description => string, optional
The description of the job schedule. Attributes: non-creatable, non-modifiable
- job-schedule-interval-days => integer, optional
The number of days between jobs. Attributes: optional-for-create, modifiable
- job-schedule-interval-hours => integer, optional
The number of hours between jobs. Attributes: optional-for-create, modifiable
- job-schedule-interval-minutes => integer, optional
The number of minutes between jobs. Attributes: optional-for-create, modifiable
- job-schedule-interval-seconds => integer, optional
The number of seconds between jobs. Attributes: optional-for-create, modifiable
- job-schedule-name => string, optional
The name of the job schedule. Attributes: key, required-for-create, non-modifiable
Information about the operation that was attempted/performed against job object.Fields
- error-code => integer, optional
Error code, if the operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
- job-key => job-info
The keys for the job object to which the operation applies.
Information about the operation that was attempted/performed against job object.Fields
- error-code => integer, optional
Error code, if the operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
- job-key => job-info
The keys for the job object to which the operation applies.
Jobs may be scheduled according to one of three major styles: 'cron' is for jobs that should be run at a specific time or well-defined calendar date; 'interval' is for jobs that should be run on a regular period; 'builtin' is for jobs that should be run according to internal rules. Of these 'cron' and 'interval' may be customized. Possible values: - "cron" ,
- "interval" ,
- "builtin" ,
- "unknown"
Fields
Kerberos Key Distribution Center (KDC) Vendor Possible values: Fields
Kerberos configuration. 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
- admin-password => string, optional
Administrator password. Attributes: non-creatable, modifiable
- admin-user-name => string, optional
Administrator username. Attributes: non-creatable, modifiable
- interface-name => string, optional
Logical interface. Attributes: key, non-creatable, non-modifiable
- is-kerberos-enabled => boolean, optional
If 'true', then kerberos security is enabled. Attributes: non-creatable, modifiable
- keytab-uri => string, optional
Load Keytab from URI. Attributes: non-creatable, modifiable
- service-principal-name => string, optional
Kerberos service principal name. Attributes: non-creatable, modifiable
- vserver => string, optional
Vserver name. Attributes: key, non-creatable, non-modifiable
Kerberos realm configuration specifies the locations of Key Distribution Center (KDC) servers and administration daemons for the Kerberos realms of interest. 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
- ad-server-ip => ip-address, optional
IP Address of the Active Directory Domain Controller (DC). This is a mandatory parameter if the kdc-vendor is 'microsoft'. Attributes: optional-for-create, modifiable
- ad-server-name => string, optional
Host name of the Active Directory Domain Controller (DC). This is a mandatory parameter if the kdc-vendor is 'microsoft' Attributes: optional-for-create, modifiable
- admin-server-ip => ip-address, optional
IP address of the host where the Kerberos administration daemon is running. This is usually the master KDC. If this parameter is omitted, the IP address specified in kdc-ip is used. If specified, this should be the same as the kdc-ip if the kdc-vendor is 'microsoft'. Attributes: optional-for-create, modifiable
- admin-server-port => integer, optional
The TCP port on the Kerberos administration server where the Kerberos administration service is running. The default for this parmater is 749. Attributes: optional-for-create, modifiable
- clock-skew => integer, optional
The clock skew in minutes is the tolerance for accepting tickets with time stamps that do not exactly match the host's system clock. The default for this parameter is 5 minutes. Attributes: optional-for-create, modifiable
- comment => string, optional
Comment Attributes: optional-for-create, modifiable
- kdc-ip => ip-address, optional
IP address of the Key Distribution Centre (KDC) server for this Kerberos realm. Attributes: required-for-create, modifiable
- kdc-port => integer, optional
TCP port on the KDC to be used for Kerberos communication. The default for this parameter is 88. Attributes: optional-for-create, modifiable
- kdc-vendor => kdc-vendor, optional
The vendor of the Key Distribution Centre (KDC) server. If the configuration uses a Microsoft Active Directory (AD) domain for authentication, this field should be 'microsoft'. Attributes: required-for-create, modifiable Possible values:
- password-server-ip => ip-address, optional
IP address of the host where the Kerberos password-changing server is running. Typically, this is the same as the host indicated in the adminserver-ip. If this parameter is omitted, the IP address in kdc-ip is used. Attributes: optional-for-create, modifiable
- password-server-port => integer, optional
The TCP port on the Kerberos password-changing server where the Kerberos password-changing service is running. The default for this parameter is 464. Attributes: optional-for-create, modifiable
- realm => string, optional
Kerberos realm name. Attributes: required-for-create, modifiable
anonymous|simple|sasl Possible values: - "anonymous" - Anonymous bind,
- "simple" - Simple bind,
- "sasl" - Simple Authentication and Security Layer (SASL) bind
Fields
LDAP Client Information. Each entry specifies an LDAP client configuration that can be associated with a Vserver using the ldap-config-create API. 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
- ad-domain => string, optional
The Active Directory Domain Name for this LDAP configuration. The option is ONLY applicable for configurations using Active Directory LDAP servers. Attributes: optional-for-create, modifiable
- base-dn => ldap-dn, optional
Indicates the starting point for searches within the LDAP directory tree. If omitted, searches will start at the root of the directory tree. Attributes: optional-for-create, modifiable
- base-scope => ldap-search-scope, optional
This indicates the scope for LDAP search. If omitted, this parameter defaults to 'subtree'. Attributes: optional-for-create, modifiable Possible values: - "base" - Search only the base directory entry,
- "onelevel" - Search the base directory entry and the children of the base entry,
- "subtree" - Search the base directory entry and all its decendants
- bind-as-cifs-server => boolean, optional
If set, the cluster will use the CIFS server's credentials to bind to the LDAP server. If omitted, this parameter defaults to 'true' if the configuration uses Active Directory LDAP and defaults to 'false' otherwise. Attributes: optional-for-create, modifiable
- bind-dn => ldap-dn, optional
The Bind Distinguished Name (DN) is the LDAP identity used during the authentication process by the clients. This is required if the LDAP server does not support anonymous binds. This field is not used if 'bind-as-cfs-server' is set to 'true'. Example : cn=username,cn=Users,dc=example,dc=com Attributes: optional-for-create, modifiable
- bind-password => string, optional
The password to be used with the bind-dn. Attributes: optional-for-create, modifiable
- group-dn => ldap-dn, optional
The Group Distinguished Name (DN), if specified, is used as the starting point in the LDAP directory tree for group lookups. If not specified, group lookups will start at the base-dn. Attributes: optional-for-create, modifiable
- group-scope => ldap-search-scope, optional
This indicates the scope for LDAP search when doing group lookups. Attributes: optional-for-create, modifiable Possible values: - "base" - Search only the base directory entry,
- "onelevel" - Search the base directory entry and the children of the base entry,
- "subtree" - Search the base directory entry and all its decendants
- min-bind-level => ldap-auth-method, optional
The minimum authentication level that can be used to authenticate with the LDAP server. If omitted, this parameter defaults to 'sasl' if the configuration uses Active Directory LDAP. For configurations that use LDAP servers from other vendors, this parameter defaults to 'simple' if a 'bind-dn' is specified and 'anonymous' otherwise. Attributes: optional-for-create, modifiable Possible values: - "anonymous" - Anonymous bind,
- "simple" - Simple bind,
- "sasl" - Simple Authentication and Security Layer (SASL) bind
- netgroup-dn => ldap-dn, optional
The Netgoup Distinguished Name (DN), if specified, is used as the starting point in the LDAP directory tree for netgroup lookups. If not specified, netgroup lookups will start at the base-dn. Attributes: optional-for-create, modifiable
- netgroup-scope => ldap-search-scope, optional
This indicates the scope for LDAP search when doing netgroup lookups. Attributes: optional-for-create, modifiable Possible values: - "base" - Search only the base directory entry,
- "onelevel" - Search the base directory entry and the children of the base entry,
- "subtree" - Search the base directory entry and all its decendants
- preferred-ad-servers => ip-address[], optional
Preferred Active Directory (AD) Domain controllers to use for this configuration. This option is ONLY applicable for configurations using Active Directory LDAP servers Attributes: optional-for-create, modifiable
- query-timeout => integer, optional
Maximum time in seconds to wait for a query response from the LDAP server. The default for this parameter is 3 seconds. Attributes: optional-for-create, modifiable
- schema => string, optional
LDAP schema to use for this configuration. The list of possible schemas can be obtained using the ldap-client-schema-get-iter API. Attributes: required-for-create, modifiable
- servers => ip-address[], optional
List of LDAP Server IP addresses to use for this configuration. The option is NOT applicable for configurations using Active Directory LDAP servers. Attributes: optional-for-create, modifiable
- tcp-port => integer, optional
The TCP port on the LDAP server to use for this configuration. If omitted, this parameter defaults to 389. Attributes: optional-for-create, modifiable
- user-dn => ldap-dn, optional
The User Distinguished Name (DN), if specified, is used as the starting point in the LDAP directory tree for user lookups. If this parameter is omitted, user lookups will start at the base-dn. Attributes: optional-for-create, modifiable
- user-scope => ldap-search-scope, optional
This indicates the scope for LDAP search when doing user lookups. Attributes: optional-for-create, modifiable Possible values: - "base" - Search only the base directory entry,
- "onelevel" - Search the base directory entry and the children of the base entry,
- "subtree" - Search the base directory entry and all its decendants
- vserver => vserver-name, optional
Name of the Vserver. Attributes: key, non-creatable, non-modifiable
An LDAP Client Schema Definition. A schema definition is a way of defining what attribute names are to be used in LDAP queries to get information that the storage system needs for its operation. This will depend on the schema that the LDAP server supports. For example, to query for user account information, the LDAP query should ask for the 'posixAccount' class if the LDAP server is compatible with RFC-2307 and it should ask for 'User' class if the LDAP server is an Active Directory LDAP Server. The default LDAP configuration has two schemas defined namely 'RFC-2307' and 'AD-SFU'. The 'RFC-2307' schema is the default schema that should be used to query servers that support RFC-2307. The 'AD-SFU' schema is the default schema that should be used to query Active Directory LDAP servers. These schemas are read-only and cannot be modified. The default schemas will work with most common LDAP configurations. If it is required to support other schema configurations, 494 :existing schemas can be copied using the 'ldap-client-schema-copy' API and modified using the 'ldap-client-schema-modify' API to work for the new configuration. 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
- cn-group-attribute => string, optional
Name that represents the RFC 2256 cn attribute used by RFC 2307 when working with groups. Attributes: optional-for-create, modifiable
- cn-netgroup-attribute => string, optional
Name that represents the RFC 2256 cn attribute used by RFC 2307 when working with netgroups. Attributes: optional-for-create, modifiable
- comment => string, optional
A comment that can be associated with the schema. Attributes: optional-for-create, modifiable
- gecos-attribute => string, optional
Name that represents the RFC 2307 gecos attribute. Attributes: optional-for-create, modifiable
- gid-number-attribute => string, optional
Name that represents the RFC 2307 gidNumber attribute. Attributes: optional-for-create, modifiable
- home-directory-attribute => string, optional
Name that represents the RFC 2307 homeDirectory attribute. Attributes: optional-for-create, modifiable
- is-owner => boolean, optional
This indicates if the vserver owns the client schema. Attributes: non-creatable, non-modifiable
- login-shell-attribute => string, optional
Name that represents the RFC 2307 loginShell attribute. Attributes: optional-for-create, modifiable
- member-nis-netgroup-attribute => string, optional
Name that represents the RFC 2307 memberNisNetgroup attribute. Attributes: optional-for-create, modifiable
- member-uid-attribute => string, optional
Name that represents the RFC 2307 memberUid attribute. Attributes: optional-for-create, modifiable
- nis-netgroup-object-class => string, optional
Name that represents the RFC 2307 nisNetgroup object class. Attributes: optional-for-create, modifiable
- nis-netgroup-triple-attribute => string, optional
Name that represents the RFC 2307 nisNetgroupTriple attribute. Attributes: optional-for-create, modifiable
- posix-account-object-class => string, optional
Name that represents the RFC 2307 posixAccount object class. Attributes: optional-for-create, modifiable
- posix-group-object-class => string, optional
Name that represents the RFC 2307 posixGroup object class. Attributes: optional-for-create, modifiable
- schema => string, optional
A name for the schema. Attributes: key, required-for-create, non-modifiable
- uid-attribute => string, optional
Name that represents the RFC 1274 userid attribute used by RFC 2307 as uid. Attributes: optional-for-create, modifiable
- uid-number-attribute => string, optional
Name that represents the RFC 2307 uidNumber attribute. Attributes: optional-for-create, modifiable
- user-password-attribute => string, optional
Name that represents the RFC 2256 userPassword attribute used by RFC 2307. Attributes: optional-for-create, modifiable
- vserver => vserver-name, optional
Vserver Attributes: key, non-creatable, non-modifiable
- windows-account-attribute => string, optional
Attribute name to be used to get the windows account information for a unix user account. Attributes: optional-for-create, modifiable
Lightweight Directory Access Protocol (LDAP) configuration. Specifies the LDAP client configuration that is associated with this Vserver and whether the configuration is enabled. 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
- client-config => string, optional
The name of an existing Lightweight Directory Access Protocol (LDAP) client configuration. The LDAP client configuration can be created using the ldap-client-create API. The ldap-client-get-iter API can be used to retrieve the list of available LDAP client configurations for the cluster. Attributes: required-for-create, modifiable
- client-enabled => boolean, optional
If true, the corresponding Lightweight Directory Access Protocol (LDAP) configuration is enabled for this Vserver. Attributes: required-for-create, modifiable
- vserver => vserver-name, optional
Vserver Attributes: key, non-creatable, non-modifiable
LDAP Distinguished NameFields
base|onelevel|subtree Possible values: - "base" - Search only the base directory entry,
- "onelevel" - Search the base directory entry and the children of the base entry,
- "subtree" - Search the base directory entry and all its decendants
Fields
The number of seconds since January 1, 1970. Range : [0..2^31-1].Fields
License Code version 2Fields
Status 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
- owner => string, optional
Name of the controller associated with the license. Attributes: non-creatable, non-modifiable
- package => licensed-package, optional
Name of the licensed package. Attributes: key, non-creatable, 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
- reason => string, optional
The reason the license can be cleaned up. Attributes: non-creatable, non-modifiable
- serial-number => node-serial-number, optional
Serial number of the controller or cluster. Attributes: key, non-creatable, non-modifiable
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
- 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
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
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
Status 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
- expiration-time => datetime, optional
License expiration date. Attributes: non-creatable, non-modifiable
- method => licensed-method, optional
Method in which a package is licensed in a cluster. Attributes: non-creatable, non-modifiable Possible values: - "none" - None,
- "license" - License,
- "site" - Site,
- "demo" - Demo
- package => licensed-package, optional
Name of the licensed package. Attributes: key, non-creatable, 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
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
Licensed Method. The licensed method of a package is determined by the aggregate of all license types in the cluster for that particular package. The license method determines the how a package is licensed at a cluster level. Possible values: - "none" - None,
- "license" - License,
- "site" - Site,
- "demo" - Demo
Fields
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
Assigned Node serial-numberFields
aligned|misaligned|partial-writes|indeterminate Possible values: - "aligned" - All or most of the IO to the LUN is aligned to the underlying file,
- "misaligned" - A significant amount of IO to the LUN is not aligned to the underlying file,
- "partial_writes" - A significant amount of IO to the LUN is partial,
- "indeterminate" - There is not enough IO to determine the LUN's alignment state
Fields
Information about fcp nexus owning the persistent reservation These two componients identify the relationship between the FCP initiator and the target.Fields
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.
- tpgroup-tag => integer, optional
The target portal group tag of the persistent reservation owner.
LUN alignment Info of a LUN 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
- alignment => alignment-state, optional
Alignment of the LUN. Possible values: aligned, misaligned, partial-writes, indeterminate. Attributes: non-creatable, non-modifiable Possible values: - "aligned" - All or most of the IO to the LUN is aligned to the underlying file,
- "misaligned" - A significant amount of IO to the LUN is not aligned to the underlying file,
- "partial_writes" - A significant amount of IO to the LUN is partial,
- "indeterminate" - There is not enough IO to determine the LUN's alignment state
- partition-scheme => partition-scheme, optional
Partition scheme on the LUN. Possible values: mbr and gpt Attributes: non-creatable, non-modifiable Possible values: - "mbr" - Master Boot Record Partition Table Scheme.,
- "gpt" - GUID Partition Table Scheme.,
- "unknown" - Partition Scheme other than MBR or GPT or an unformatted LUN.
- path => string, optional
Path of the LUN Attributes: key, non-creatable, non-modifiable
- vserver => string, optional
Vserver hosting the LUN Attributes: key, non-creatable, non-modifiable
LUN attribute name / value pairFields
- name => string
Name of the attribute.
- value => string
Value of the attribute.
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.
- class => string, optional
The class of the LUN. Possible values: - "regular" - The LUN is intended for normal blocks access,
- "protocol_endpoint" - The LUN is a VMware vvol protocol endpoint,
- "vvol" - The LUN is a VMware vvol data LUN.
- comment => string, optional
User-specified comment for the LUN. This field is unavailable when the LUN is in a snapshot or while the LUN fenced for a restore operation.
- creation-timestamp => integer, optional
The time this LUN was created, in seconds since January 1, 1970. This field is unavailable when the LUN is in a snapshot or while the LUN fenced for a restore operation.
- device-binary-id => string, optional
SCSI Peripheral Device Identifying Information returned in response to the SCSI command REPORT IDENTIFYING INFORMATION (INFORMATION TYPE 0000000b). Value is encoded as a hexadecimal string, representing 1 to 64 bytes. Only present if a Peripheral Device Idendentifying Information value has been set on the LUN.
- 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.
- device-text-id => string, optional
SCSI Peripheral Device Text Identifying Information returned in response to the SCSI command REPORT IDENTIFYING INFORMATION (INFORMATION TYPE 0000010b). Value is a free-form UTF-8 string between 1 and 255 bytes in length. Only present if a Peripheral Device Text Identifying Information value has been set on the LUN.
- is-clone-autodelete-enabled => boolean, optional
"true" if the lun clone is allowed to be deleted by autodelete in try/disrupt mode. autodelete will be allowed to delete the lun clone in try/disrupt mode if configured. "false" otherwise. The lun clone will not be deleted by autodelete in try/disrupt mode if configured.
- 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.
- qos-policy-group => string, optional
QoS policy group defines measurable Service Level Objectives (SLOs) that apply to the storage objects with which the policy group is associated. This field is only present if the LUN is assigned to a QoS policy This field is available in Data ONTAP 8.2 and later.
- qtree => string
Name of the qtree containing the LUN.
- 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.
- size-used => integer, optional
Number of bytes used by this LUN. 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.
- volume => string
Name of the volume containing the LUN.
- vserver => string, optional
Vserver containing the LUN.
Information about a lun mappingFields
- 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.
- vserver => string, optional
Vserver containing the initiator group
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
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")
- vserver => string, optional
Vserver containing the lun
Partition entries on the LUN.Fields
mbr|gpt|unknown Possible values: - "mbr" - Master Boot Record Partition Table Scheme.,
- "gpt" - GUID Partition Table Scheme.,
- "unknown" - Partition Scheme other than MBR or GPT or an unformatted LUN.
Fields
Information about the persistent reservationFields
- 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".
Histogram of read operations of size 4k in percentage value.Fields
Histogram of write operations of size 4k in percentage value.Fields
- bin-number => integer, optional
Histogram bin number Attributes: non-creatable, non-modifiable
- bin-value => integer, optional
Write histogram bin percentage value. Attributes: non-creatable, non-modifiable
Direction of the name mapping. Possible values: - "krb_unix" - Kerberos principal name to UNIX user name mapping,
- "win_unix" - Windows user name to UNIX user name mapping,
- "unix_win" - UNIX user name to Windows user name mapping
Fields
Name mapping configuration for Vservers. The possible sources of name mapping information and the order in which they are searched is determined by the Vserver's 'name-mapping-switch' option. If the 'name-mapping-switch' is set to 'file', the rules in this table are used to determine the mapping. Windows user names, UNIX user names and Kerberos principal names can be three disjoint sets of names. A mechanism is needed to map users from one set to another when performing authorization checks. Each name mapping entry represents one such map in a given direction. Name mappings are done using standard UNIX style regular expressions for pattern replacement. For example if a configuration is required to convert any Windows user in the Windows domain name 'EXAMPLE' into a UNIX user with the same name in NIS, the direction entry should be set to 'win-unix', the pattern string should be set to 'EXAMPLE\\(.+)' and the replacement string should be set to '\1'. The double backs1293 :n the pattern matches a single backslash in the source name. The parentheses denote a subexpression but do not match any characters themselves. The 'period' matches any single character. The 'plus' matches one or more characters of the previous expression. The pattern 'EXAMPLE\\(.+)' matches 'EXAMPLE\' followed by one or more of any character. In the replacement, '\1' refers to the string that the first subexpression matched. Assuming the Windows user 'EXAMPLE\user1', the replacement evaluates to 'user1'. If a mapping is required from Windows to UNIX and none of the name mapping entries match, the domain name is stripped from the the username and it is directly mapped to the UNIX user of the same name. Similarly if a mapping is required from a UNIX user to a Windows user and none of the name mapping entries match, the domain name is prefixed to the username and it is directly mapped to a Windows user of the same name. 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
- direction => name-mapping-direction, optional
Direction in which the name mapping is applied. Attributes: key, required-for-create, non-modifiable Possible values: - "krb_unix" - Kerberos principal name to UNIX user name mapping,
- "win_unix" - Windows user name to UNIX user name mapping,
- "unix_win" - UNIX user name to Windows user name mapping
- pattern => string, optional
Pattern to use to match the name while searching for a name that can be used as a replacement. The pattern is a UNIX-style regular expression. Regular expressions are case-insensitive when mapping from Windows to UNIX, and they are case-sensitive for mappings from Kerberos to UNIX and UNIX to Windows. Attributes: required-for-create, modifiable
- position => integer, optional
Position of an existing name mapping in the list of name mappings for this Vserver. Attributes: key, required-for-create, non-modifiable
- replacement => string, optional
The name that is to be used as a replacement if the pattern associated with this entry matches. The replacement is a string containing escape sequences representing subexpressions from the pattern, as in the UNIX 'sed' program. Attributes: required-for-create, modifiable
- vserver => string, optional
Specifies the Vserver for the name mapping. Attributes: key, non-creatable, non-modifiable
UNIX group information 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
- group-id => integer, optional
Specifies an identification number for the UNIX group. Attributes: required-for-create, modifiable
- vserver => string, optional
Specifies the Vserver for the group. Attributes: key, non-creatable, non-modifiable
UNIX user information 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
- full-name => string, optional
Specifies the full name of the UNIX user. Attributes: optional-for-create, modifiable
- group-id => integer, optional
Specifies the primary group identification number for the UNIX user. Attributes: required-for-create, modifiable
- user-id => integer, optional
Specifies an identification number for the UNIX user. Attributes: required-for-create, modifiable
- user-name => string, optional
Specifies user's UNIX account name. Attributes: key, required-for-create, non-modifiable
- vserver => string, optional
Specifies the Vserver for the UNIX user. Attributes: key, non-creatable, non-modifiable
Specifies user name information.Fields
- user-name => string, optional
Specifies user's UNIX account name. Attributes: non-creatable, non-modifiable
Information about generate password 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
- password => string, optional
The generated NDMP password for the given user. The command fails if such a user does not exist in the Vserver context. Attributes: non-creatable, non-modifiable
- user-name => string, optional
The user for which the password is to be generated. Attributes: key, non-creatable, non-modifiable
- vserver-name => string, optional
The Vserver on which the user password is to be generated for the given user. Attributes: key, non-creatable, non-modifiable
fc|cna|nic Possible values: - "fc" - Used for FC Adapters,
- "cna" - Used for CNA Adapters,
- "nic" - Used for NIC Adapters
Fields
nfs|cifs|iscsi|fcp|fcache|none Possible values: - "nfs" - Used for NFS connections,
- "cifs" - Used for CIFS connections,
- "iscsi" - Used for iSCSI connections,
- "fcp" - Used for Fibre Channel connections,
- "fcache" - Used for FlexCache connections,
- "none" - Used for management. Does not serve any file protocols.
Fields
Specifies the unique, fully qualified domain name of the DNS zone of this LIF.Fields
Specifies the failover group name.Fields
Name attributes for one host 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
- aliases => string[], optional
The list of aliases such as 'host1.sales.foo.com'. Attributes: optional-for-create, modifiable
- hostname => string, optional
Canonical hostname in a simple string or in FQDN Attributes: required-for-create, modifiable
One ip address, in dotted-decimal format (for example, "192.168.11.12").Fields
Network options ipv6 typedefFields
- enabled => boolean, optional
IPv6 Enabled Attributes: non-creatable, modifiable
|Fields
SAN LIF placement 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
- home-port => string, optional
Port info Attributes: non-creatable, non-modifiable
Contains DNS configuration information of a Vserver 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
- attempts => integer, optional
Max number of trials before giving up and returning error. Default is one. Attributes: optional-for-create, modifiable
- dns-state => enable, optional
Enable/Disable DNS. Possible values are 'enabled' or 'disabled'. Attributes: required-for-create, modifiable
- domains => string[], optional
List of DNS domains such as 'sales.bar.com'. The first domain is the one that the Vserver belongs to. Attributes: required-for-create, modifiable
- name-servers => ip-address[], optional
IPv4 addresses of name servers such as '123.123.123.123'. Attributes: optional-for-create, modifiable
- timeout => integer, optional
Number of seconds to wait for a response from a name server before trying a different name server. Default is two seconds. Attributes: optional-for-create, modifiable
- vserver-name => vserver-name, optional
Vserver Attributes: key, non-creatable, non-modifiable
Network interface group information 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
- distribution-function => string, optional
Specifies the traffic distribution function for the ifgrp. Attributes: required-for-create, non-modifiable Possible values: - "mac" - Network traffic is distributed on the basis of MAC addresses,
- "ip" - Network traffic is distributed on the basis of IP addresses,
- "sequential" - Network traffic is distributed round-robin to each interface,
- "port" - Network traffic is distributed by transport layer address 4-tuple
- mode => string, optional
Specifies the link policy for the ifgrp. Possible values: - 'multimode - All links are simultaneously active',
- 'multimode_lacp - Link state is managed by the switch using link aggregation control protocol (LACP) (IEEE 802.3ad)',
- 'singlemode - Only one link is active at a time'
Attributes: required-for-create, non-modifiable
- node => string, optional
Specifies the name of node. Attributes: key, required-for-create, non-modifiable
- port-participation => string, optional
Port participation state of the ifgrp. Attributes: non-creatable, non-modifiable Possible values: - "full" - Indicates all the ifgrp ports are active,
- "partial" - Indicates not all the ifgrp ports are active,
- "none" - Indicates none of the ifgrp ports is active
Network interface information 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
- address => ip-address, optional
Specifies the LIF's IP address. This element is valid for all data protocols except FCP. Attributes: optional-for-create, modifiable
- administrative-status => string, optional
Specifies the administrative status of the LIF. The administrative status can differ from the operational status; for instance, if you specify the status as up but a network problem prevents the interface from functioning, the operational status remains as down. Possible values: Attributes: optional-for-create, modifiable
- comment => string, optional
Comment Attributes: optional-for-create, modifiable
- current-node => string, optional
The node on which the LIF currently resides. Upon LIF migration 'current-node' may be different from 'home-node'. Attributes: non-creatable, non-modifiable
- current-port => string, optional
The port on which the LIF currently resides. Upon LIF migration 'current-port' may be different from 'home-port'. Attributes: non-creatable, non-modifiable
- data-protocols => data-protocol[], optional
Specifies the list of data protocols configured on the LIF. By default, the values in this element are nfs, cifs and fcache. Other supported protocols are iscsi and fcp. A LIF can be configured to not support any data protocols by specifying 'none'. Protocol values of none, iscsi or fcp can't be combined with any other data protocol(s). Attributes: optional-for-create, non-modifiable Possible values: - "nfs" - Used for NFS connections,
- "cifs" - Used for CIFS connections,
- "iscsi" - Used for iSCSI connections,
- "fcp" - Used for Fibre Channel connections,
- "fcache" - Used for FlexCache connections,
- "none" - Used for management. Does not serve any file protocols.
- dns-domain-name => dns-zone, optional
Specifies the unique, fully qualified domain name of the DNS zone of this LIF. Attributes: optional-for-create, modifiable
- failover-group => failover-group, optional
Specifies the failover group name. Attributes: optional-for-create, modifiable
- failover-policy => string, optional
Specifies the failover policy for the LIF. For FCP and iSCSI LIFs, the only failover policy is 'disabled'; for NFS, CIFs and fcache LIFs, the default policy is 'nextavail'. Attributes: optional-for-create, modifiable Possible values: - "nextavail" - Next failover target selected based on next port in failover targets list, preferring local ports first,
- "priority" - Next failover target selected based on first available port in failover targets list,
- "disabled" - Failover disabled
- firewall-policy => string, optional
Specifies the firewall policy for the LIF. Default firewall-policy is set as per the following table: - 'LIF Role Protocols Default policy',
- '------- --------- --------------',
- 'data none mgmt',
- 'data any data',
- 'node_mgmt any mgmt',
- 'cluster_mgmt any mgmt',
- 'cluster any cluster',
- 'intercluster any intercluster'
Attributes: optional-for-create, modifiable
- home-node => string, optional
Specifies the LIF's home node. Attributes: required-for-create, modifiable
- home-port => string, optional
Specifies the LIF's home port. Attributes: required-for-create, modifiable
- interface-name => string, optional
Specifies the logical interface (LIF) name. Attributes: key, required-for-create, non-modifiable
- is-auto-revert => boolean, optional
If true, data LIF will revert to its home node under certain circumstances such as startup, and load balancing migration capability is disabled automatically. Default: false Attributes: optional-for-create, modifiable
- is-ipv4-link-local => boolean, optional
If true, automatically configure an interface with an IPv4 address. User can configure an interface by explicitly specifying <address> and <netmask> (or <netmask-length>); or by enabling is-ipv4-link-local to true. Attributes: optional-for-create, modifiable
- listen-for-dns-query => boolean, optional
If True, this IP address will listen for DNS queries for the dns-zone specified. Attributes: optional-for-create, modifiable
- netmask => ip-address, optional
Specifies the LIF's netmask. This element is valid for all data protocols except FCP. Attributes: optional-for-create, modifiable
- netmask-length => integer, optional
Specifies number of bits in the netmask. Attributes: optional-for-create, modifiable
- role => string, optional
Specifies the role of the LIF. Default: data Attributes: required-for-create, non-modifiable Possible values: - "undef" - No defined role,
- "cluster" - Used for communication using the private cluster network,
- "data" - Used for communicating with file service clients,
- "node_mgmt" - Used by administrators to configure the node,
- "intercluster" - Used for communication with a different cluster,
- "cluster_mgmt" - Used by administrators to configure the cluster
- routing-group-name => routing-group, optional
Specifies the routing group, which enables multiple logical interfaces to share a set of routing table entries. For example: d192.168.1.0/24 ('d' stands for data LIF and 192.168.1.0/24 is subnet) c192.168.1.0/24 ('c' stands for cluster LIF and 192.168.1.0/24 is subnet) n192.168.1.0/24 ('n' stands for node management LIF and 192.168.1.0/24 is subnet) dfd20:13::0/50 ('d' stands for data LIF and fd20:13::0/50 is IPv6 subnet) Attributes: optional-for-create, modifiable
- use-failover-group => string, optional
Specifies whether failover rules are automatically created, manually created by the administrator, or disabled. For FCP and iSCSI LIFs, the default policy is 'disabled'; for NFS, CIFs and fcache LIFs, the default policy is 'system_defined'. Attributes: optional-for-create, modifiable Possible values: - "system_defined" - Failover targets generated automatically by the system,
- "disabled" - Failover targets generated manually by the admin,
- "enabled" - Failover targets defined by failover-group
- vserver => string, optional
Specifies the Vserver name. Attributes: key, non-creatable, non-modifiable
Information about the modify operation that was attempted/performed against given network interface object.Fields
- error-code => integer, optional
Error code, if the modify operation caused an error.
- error-message => string, optional
Error description, if the modify operation caused an error.
Network Options Typedef 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
Network interface (LIF) placement cached information 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
- address => ip-address, optional
The IP address that was searched. Attributes: key, required-for-create, non-modifiable
- netmask-length => integer, optional
The number of bits in the subnet mask (i.e. 24 or 64). Attributes: key, required-for-create, non-modifiable
- node => string, optional
Specifies the name of the node. Attributes: key, required-for-create, non-modifiable
- port => string, optional
The port name on the node. Attributes: key, required-for-create, non-modifiable
- vserver => string, optional
Vserver Name Attributes: key, required-for-create, non-modifiable
Network port information 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
- administrative-duplex => string, optional
Specifies the user preferred duplex setting of the port. Attributes: required-for-create, modifiable Possible values: - "undef" - No defined duplex,
- "auto" - Auto-negotiate duplex setting for link,
- "half" - Half-duplex link usage,
- "full" - Full-duplex link usage
- administrative-flowcontrol => string, optional
Specifies the user preferred flow control setting of the port. Attributes: required-for-create, modifiable
- administrative-speed => string, optional
Specifies the user preferred speed setting of the port. Attributes: required-for-create, modifiable Possible values: - "undef" - No defined speed,
- "auto" - Auto-negotiate speed for link,
- "10" - 10 megabits per second,
- "100" - 100 megabits per second,
- "1000" - 1 gigabit per second,
- "10000" - 10 gigabits per second
- autorevert-delay => integer, optional
For a port with role 'cluster', specifies the delay in seconds before autoreverting a LIF to this port. Attributes: optional-for-create, modifiable
- ifgrp-distribution-function => string, optional
For a port of type 'ifgrp', specifies the traffic distribution function. Attributes: non-creatable, non-modifiable Possible values: - "mac" - Network traffic is distributed on the basis of MAC addresses,
- "ip" - Network traffic is distributed on the basis of IP addresses,
- "sequential" - Network traffic is distributed round-robin to each interface,
- "port" - Network traffic is distributed by transport layer address 4-tuple
- ifgrp-mode => string, optional
For a port of type 'ifgrp', specifies the link policy. Possible values: - 'multimode - All links are simultaneously active',
- 'multimode_lacp - Link state is managed by the switch using link aggregation control protocol (LACP) (IEEE 802.3ad)',
- 'singlemode - Only one link is active at a time'
Attributes: non-creatable, non-modifiable
- ifgrp-node => string, optional
For a port of type 'physical' that is a member of an interface group (ifgrp), specifies the name of the node on which the interface group was created. Attributes: non-creatable, non-modifiable
- ifgrp-port => string, optional
For a port of type 'physical' that is a member of an interface group (ifgrp), specifies the name of the interface group. Attributes: non-creatable, non-modifiable
- is-administrative-auto-negotiate => boolean, optional
Enables or disables Ethernet auto-negotiation of speed, duplex and flow control. Attributes: required-for-create, modifiable
- is-administrative-up => boolean, optional
If true, it changes the state of the port to 'up'. Attributes: required-for-create, modifiable
- link-status => string, optional
Specifies the link status of the port. Possible values: - 'unknown - Port status unknown',
- 'up - Port is up',
- 'down - Port is down'
Attributes: non-creatable, non-modifiable
- mac-address => string, optional
Specifies the MAC address of the port. Attributes: non-creatable, non-modifiable
- mtu => integer, optional
Specifies the maximum transmission unit (MTU) of the port. Attributes: required-for-create, modifiable
- node => string, optional
Specifies the name of node. Attributes: key, required-for-create, non-modifiable
- operational-duplex => string, optional
Duplex setting reported by the port after Ethernet auto-negotiation. Attributes: non-creatable, non-modifiable Possible values: - "undef" - No defined duplex,
- "auto" - Auto-negotiate duplex setting for link,
- "half" - Half-duplex link usage,
- "full" - Full-duplex link usage
- operational-speed => string, optional
Speed setting reported by the port after Ethernet auto-negotiation. Attributes: non-creatable, non-modifiable Possible values: - "undef" - No defined speed,
- "auto" - Auto-negotiate speed for link,
- "10" - 10 megabits per second,
- "100" - 100 megabits per second,
- "1000" - 1 gigabit per second,
- "10000" - 10 gigabits per second
- port => string, optional
Specifies the name of port. Attributes: key, required-for-create, non-modifiable
- port-type => string, optional
Specifies the type of port. Attributes: non-creatable, non-modifiable Possible values: - "physical" - Physical network interface,
- "if_group" - Logical interface group (IEEE 802.3, section 43),
- "vlan" - Virtual LAN (IEEE 802.1Q),
- "undef" - No defined port type
- role => string, optional
Specifies the role associated with the port. Possible values: - 'undef - No defined role',
- 'cluster - Used for communication using the private cluster network',
- 'data - Used for communicating with file service clients',
- 'node_mgmt - Used by administrators to configure the node',
- 'intercluster - Used for communication with a different cluster'
Attributes: required-for-create, modifiable
- vlan-id => integer, optional
For a port of type 'vlan', specifies the vlan identification number. Attributes: non-creatable, non-modifiable
- vlan-port => string, optional
For a port of type 'vlan', specifies the name of the physical port on which the vlan is created. Attributes: non-creatable, non-modifiable
Information about the modify operation that was attempted/performed against given network port object.Fields
- error-code => integer, optional
Error code, if the modify operation caused an error.
- error-message => string, optional
Error description, if the modify operation caused an error.
The network topology classification Possible values: - "wan" ,
- "lan" ,
- "undefined"
Fields
The network layer 4 protocol type Possible values: - "udp" - UDP,
- "tcp" - TCP,
- "na" - not_available
Fields
Receive buffer window size configuration 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
- network => network-type, optional
The network topology classification Attributes: key, required-for-create, non-modifiable Possible values: - "wan" ,
- "lan" ,
- "undefined"
- protocol => protocol-layer4, optional
The network layer 4 protocol type Attributes: key, required-for-create, non-modifiable Possible values: - "udp" - UDP,
- "tcp" - TCP,
- "na" - not_available
- receive-auto-tune => boolean, optional
If true, allow the system to automatically adjust the receive buffer size. The default value is false for the ctlopcp service using the LAN network type, and true in all other cases. Attributes: required-for-create, modifiable
- receive-buffer => integer, optional
If receive-auto-tune is false, receive buffer size in kilobytes (1024). If receive-auto-tune flag is true, this value has no effect. The default value is 2048 for the ctlopcp service using the WAN network type, and 256 in other cases. Attributes: required-for-create, modifiable
- service => stream-protocol-service, optional
The stream protocol connection classification Attributes: key, required-for-create, non-modifiable Possible values: - "mount" - Mount stream protocol,
- "nfs" - NFS stream protocol,
- "nfs_v2" - NFS version 2 stream protocol,
- "nfs_v3" - NFS version 3 stream protocol,
- "nlm_v4" - Network lock manager stream protocol,
- "sm" - Session Manager stream protocol,
- "ftp_ctrl" - FTP control stream protocol,
- "ftp_data" - FTP data stream protocol,
- "http_1_0" - HTTP version 1 stream protocol,
- "http_1_1" - HTTP version 1.1 stream protocol,
- "iscsi" - ISCSI stream protocol,
- "cifs_srv" - CIFS server stream protocol,
- "cifs_nam" - CIFS name server stream protocol,
- "loopback" - loopback stream protocol,
- "rf" - RC stream protocol,
- "rawscp" - Raw secure copy stream protocol,
- "discard" - Descard stream protocol,
- "port_map" - Port map stream protocol,
- "pass_thru" - Passthru stream protocol,
- "rclopcp" - Rc connection stream protocol,
- "nfs_v4" - NFS version 4 stream protocol,
- "fcache" - Flex cache stream protocol,
- "ctlopcp" - Ct connection stream protocol,
- "rquota" - Rquota stream protocol,
- "cifs_msrpc" - CIFS MsRpc stream protocol,
- "unknown" - unknown protocol
Specifies the name of routing group. For example: - d192.168.1.0/24 ('d' stands for data LIF and 192.168.1.0/24 is subnet),
- c192.168.1.0/24 ('c' stands for cluster LIF and 192.168.1.0/24 is subnet),
- n192.168.1.0/24 ('n' stands for node management LIF and 192.168.1.0/24 is subnet)
Fields
Routing group route information 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
- address-family => string, optional
Address Family. Possible values: ipv4, ipv6 Attributes: non-creatable, non-modifiable
- destination-address => string, optional
Specifies the IP address and subnet mask of destination. For example: '198.18.10.0/24', 'fd20:13::0/64' Attributes: key, required-for-create, non-modifiable
- metric => integer, optional
Specifies the metric (hop count) of the LIF. The default value is determined by the LIF role as follows: - If the LIF role is 'node_mgmt' or 'cluster_mgmt': 10,
- If the LIF role is 'data' or 'undef': 20,
- If the LIF role is 'cluster': 30,
- If the LIF role is 'intercluster': 40
Attributes: optional-for-create, non-modifiable
- routing-group => string, optional
Specifies the name of routing group. For example: - d192.168.1.0/24 ('d' stands for data LIF and 192.168.1.0/24 is subnet),
- c192.168.1.0/24 ('c' stands for cluster LIF and 192.168.1.0/24 is subnet),
- n192.168.1.0/24 ('n' stands for node management LIF and 192.168.1.0/24 is subnet)
- dfd20:13::0/64 ('d' stands for data LIF and fd20:13::0/64 is IPv6 subnet)
Attributes: key, required-for-create, non-modifiable
- vserver => string, optional
Specifies the name of Vserver. Attributes: key, non-creatable, non-modifiable
The stream protocol connection classification Possible values: - "mount" - Mount stream protocol,
- "nfs" - NFS stream protocol,
- "nfs_v2" - NFS version 2 stream protocol,
- "nfs_v3" - NFS version 3 stream protocol,
- "nlm_v4" - Network lock manager stream protocol,
- "sm" - Session Manager stream protocol,
- "ftp_ctrl" - FTP control stream protocol,
- "ftp_data" - FTP data stream protocol,
- "http_1_0" - HTTP version 1 stream protocol,
- "http_1_1" - HTTP version 1.1 stream protocol,
- "iscsi" - ISCSI stream protocol,
- "cifs_srv" - CIFS server stream protocol,
- "cifs_nam" - CIFS name server stream protocol,
- "loopback" - loopback stream protocol,
- "rf" - RC stream protocol,
- "rawscp" - Raw secure copy stream protocol,
- "discard" - Descard stream protocol,
- "port_map" - Port map stream protocol,
- "pass_thru" - Passthru stream protocol,
- "rclopcp" - Rc connection stream protocol,
- "nfs_v4" - NFS version 4 stream protocol,
- "fcache" - Flex cache stream protocol,
- "ctlopcp" - Ct connection stream protocol,
- "rquota" - Rquota stream protocol,
- "cifs_msrpc" - CIFS MsRpc stream protocol,
- "unknown" - unknown protocol
Fields
Network options switchless-cluster typedefFields
- enabled => boolean, optional
Enable Switchless Cluster Attributes: non-creatable, modifiable
vlanFields
- 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>
- node => string, optional
Node name of vlan interface.
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.
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 a junction path of the volume to be exported.
- 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.
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 a junction path of the volume to be exported.
Information about NFS server configuration 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
- chown-mode => nfschownmode, optional
Vserver Change Ownership Mode. Possible values are 'ignore', 'fail', 'use_export_policy'. If 'use_export_policy' is set, export policy option is used. Default value is 'use_export_policy'. Attributes: optional-for-create, modifiable Possible values: - "restricted" ,
- "unrestricted" ,
- "use_export_policy"
- default-windows-group => string, optional
The default windows group for CIFS access. Attributes: optional-for-create, modifiable
- default-windows-user => string, optional
The default windows user for CIFS access. Attributes: optional-for-create, modifiable
- enable-ejukebox => boolean, optional
If 'true', then the NFS server will send EJUKEBOX error on server delays. Attributes: optional-for-create, modifiable
- is-mount-rootonly-enabled => boolean, optional
If 'true', then the vserver allows MOUNT protocol calls only from privileged ports (port numbers less than 1024). Default value is 'true'. Attributes: optional-for-create, modifiable
- is-nfs-access-enabled => boolean, optional
If 'true',then NFS server access is enabled. Default value is 'true'. Attributes: optional-for-create, modifiable
- is-nfs-rootonly-enabled => boolean, optional
If 'true', then the vserver allows NFS protocol calls only from privileged ports (port numbers less than 1024). Default value is 'false'. Attributes: optional-for-create, modifiable
- is-nfsv2-enabled => boolean, optional
Starting Data ONTAP 8.2, NFS v2 is no longer supported. Default value is 'false'. Attributes: optional-for-create, modifiable
- is-nfsv3-connection-drop-enabled => boolean, optional
If 'true', then connection is dropped when an NFSv3 request is dropped. Default value is 'true'. Attributes: optional-for-create, modifiable
- is-nfsv3-enabled => boolean, optional
If 'true', then NFS version 3 is enabled. Default value is 'true'. Attributes: optional-for-create, modifiable
- is-nfsv3-fsid-change-enabled => boolean, optional
If 'true', then NFSv3 clients see change in FSID as they traverse filesystems. Default value is 'true'. Attributes: optional-for-create, modifiable
- is-nfsv4-fsid-change-enabled => boolean, optional
If 'true', then clients see change in FSID as NFSv4 clients traverse filesystems. Default value is 'true'. Attributes: optional-for-create, modifiable
- is-nfsv4-numeric-ids-enabled => boolean, optional
If 'true', then NFSv4 support for Numeric Owner IDs is enabled. Default value is 'true'. Attributes: optional-for-create, modifiable
- is-nfsv40-acl-enabled => boolean, optional
If 'true', then NFSv4.0 ACL feature is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
- is-nfsv40-enabled => boolean, optional
If 'true', then NFS version 4.0 is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
- is-nfsv40-migration-enabled => boolean, optional
If 'true', then NFSv4.0 Migration feature is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
- is-nfsv40-read-delegation-enabled => boolean, optional
If 'true', NFSv4.0 read delegation feature is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
- is-nfsv40-referrals-enabled => boolean, optional
If 'true', then NFSv4.0 Referrals feature is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
- is-nfsv40-req-open-confirm-enabled => boolean, optional
If 'true', then the server will require an OPEN_CONFIRM operation for all NFSv4.0 clients. Default value is 'false'. Attributes: optional-for-create, modifiable
- is-nfsv40-write-delegation-enabled => boolean, optional
If 'true', NFSv4.0 write delegation feature is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
- is-nfsv41-acl-enabled => boolean, optional
If 'true', then NFSv4.1 ACL feature is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
- is-nfsv41-acl-preserve-enabled => boolean, optional
If 'true', the NFSv4 server will preserve and modify ACL when chmod is done. Default value is 'true'. Attributes: optional-for-create, modifiable
- is-nfsv41-enabled => boolean, optional
If 'true', then NFS version 4.1 is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
- is-nfsv41-migration-enabled => boolean, optional
If 'true', then NFSv4.1 Migration feature is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
- is-nfsv41-pnfs-enabled => boolean, optional
If 'true', then Parallel NFS support for NFS version 4.1 is enabled. Default value is 'true'. Attributes: optional-for-create, modifiable
- is-nfsv41-pnfs-striped-volumes-enabled => boolean, optional
If 'true', Striped volume support for Parallel NFS is enabled . Default value is 'false'. Attributes: optional-for-create, modifiable
- is-nfsv41-read-delegation-enabled => boolean, optional
If 'true', NFSv4.1 read delegation feature is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
- is-nfsv41-referrals-enabled => boolean, optional
If 'true', then NFSv4.1 Referrals feature is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
- is-nfsv41-state-protection-enabled => boolean, optional
If 'true', then NFSv4.1 State Protection is enabled. Default value is 'true'. Attributes: optional-for-create, modifiable
- is-nfsv41-write-delegation-enabled => boolean, optional
If 'true', NFSv4.1 write delegation feature is enabled. Default value is 'false'. Attributes: optional-for-create, modifiable
- is-vstorage-enabled => boolean, optional
If 'true', then enables the usage of vStorage protocol for server side copies, which is mostly used in hypervisors. Default value is 'false'. Attributes: optional-for-create, modifiable
- nfsv4-acl-max-aces => integer, optional
Maximum Number of ACEs allowed in an ACL. Range is 192 to 1024. Default value is 400. Attributes: optional-for-create, modifiable
- nfsv4-grace-seconds => integer, optional
NFSv4 Grace timeout value in seconds. Default value is 45 seconds. Attributes: optional-for-create, modifiable
- nfsv4-id-domain => string, optional
NFSv4 ID mapping domain. Default value is 'defaultv4iddomain.com'. Attributes: optional-for-create, modifiable
- nfsv4-lease-seconds => integer, optional
NFSv4 Lease timeout value in seconds. Default value is 30 seconds. Attributes: optional-for-create, modifiable
- nfsv41-implementation-id-domain => string, optional
NFSv4.1 Implementation id domain. Default value is 'defaultv41impliddomain.com'. Attributes: optional-for-create, modifiable
- nfsv41-implementation-id-name => string, optional
NFSv4.1 Implementation id name. Default value is 'defaultv41implidname'. Attributes: optional-for-create, modifiable
- nfsv41-implementation-id-time => date, optional
NFSv4.1 Implementation id time.The number of seconds since January 1, 1970. Attributes: optional-for-create, modifiable
- nfsv4x-session-num-slots => integer, optional
Number of Slots in the NFSv4.x Session Slot Tables. Default value is 180. Attributes: optional-for-create, modifiable
- nfsv4x-session-slot-reply-cache-size => integer, optional
Size of the Reply that will be Cached in Each NFSv4.x Session Slot (in bytes). Default value is 640. Attributes: optional-for-create, modifiable
- ntfs-unix-security-ops => string, optional
Ignore/Fail unix security operations on NTFS volumes. Possible values are 'ignore', 'fail','use_export_policy'. If 'use_export_policy' is set, export policy option is used. Default value is 'use_export_policy'. Attributes: optional-for-create, modifiable
- rpcsec-ctx-high => integer, optional
High water mark for the RPCSEC_GSS Context Cache. Default value is 0. Attributes: optional-for-create, modifiable
- rpcsec-ctx-idle => integer, optional
Time in seconds before an idle entry in RPCSEC_GSS context cache is deleted. Default value is 0. Attributes: optional-for-create, modifiable
- vserver => string, optional
Vserver name Attributes: key, non-creatable, non-modifiable
restricted|unrestricted|use-export-policy Possible values: - "restricted" ,
- "unrestricted" ,
- "use_export_policy"
Fields
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 junction path of the volume.
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.
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.
NIS domain configuration information 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
- is-active => boolean, optional
Specifies whether the NIS domain configuration is active or inactive. Attributes: required-for-create, modifiable
- nis-servers => ip-address[], optional
Specifies the IP address of one or more NIS servers in the domain. Attributes: required-for-create, modifiable
- vserver => string, optional
Specifies the Vserver for the NIS domain configuration. Attributes: key, non-creatable, non-modifiable
nullFields
- 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.
- data-type => string, optional
Data type of the option 'name'. Possible values are: - "bool" - A boolean true / false value,
- "integer" - A decimal integer value,
- "unsigned" - A non-negative decimal integer value,
- "string" - A UTF-8 character string.
- description => string, optional
Brief description of this option.
- 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.
- vserver => string, optional
The name of the vserver to which this option belongs to.
Information about the modify operation that was attempted/performed against options object.Fields
- error-code => integer, optional
Error code, if the modify operation caused an error.
- error-message => string, optional
Error description, if the modify operation caused an error.
Information related to aggregation that was done.Fields
- result => string, optional
Each counter for an instance can be part of an aggregation set. Each counter can either have a strict or permissive aggregation. (Basically whether an aggregation with missing data samples in the aggregation set can be considered valid.)
Possible values: "complete_aggregation", "partial_aggregation" - If aggregation is 'strict', and we have all of the data samples, we return: complete_aggregation
- If aggregation is 'strict' and we DON'T have all of the data samples, we return: partial_aggregation
- If aggregation is 'strict' and we only have one instance (such as a flex vole) we return: complete_aggregation
- If aggregation is 'permissive', we always return: complete_aggregation (since the results are always valid)
NOTE: Since a given node DOES NOT have enough information to determine all of the members of the set, we have to assume if we can't contact a given node/process that may contain a piece to be aggregated, the aggregation is incomplete. (For example, if we're trying to aggregate 'volume' stats, and we can't contact the local dblade or a remote node, we'll mark it as incomplete.)
Performance Archive configuration information 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
- datastore-file-rotation => integer, optional
Minutes Between Performance Archive Data File Rotations Attributes: non-creatable, modifiable
- datastore-max-percent => integer, optional
Maximum Percentage of Root Volume Used for Performance Archive Data Attributes: non-creatable, modifiable
- datastore-max-retention => integer, optional
Days to Retain Performance Archive Data Attributes: non-creatable, modifiable
- is-enabled => boolean, optional
Is the Performance Archive Enabled? Attributes: non-creatable, modifiable
- version => string, optional
Data ONTAP Version of Installed Configuration Attributes: non-creatable, non-modifiable
Counter name.Fields
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.
Information about a single counter.Fields
- aggregation-style => string, optional
For counters that can be aggregated, this element decribes the style. If the element is absent, no aggregation is available for this counter. Valid values include: [ strict, permissive ]. "strict" aggregation requires all items of a set to perform aggregation. If any item is missing, the aggregation will be rejected. "permissive" aggregation is a best effort aggregation. All available items of a set will be aggregated.
Aggregation-style is deprecated in Data ONTAP 8.2 and later. This field has never been used.
- 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.
- translation-input-counter => string, optional
Name of counter that is used as input for translation. Translation is needed for some counters because the precise value is unknown at the moment of sampling, and must be determined from another counter at a later time. Note that the time frame is still within a single request and response from the ZAPI client's point of view.
Translation-input-counter is deprecated in Data ONTAP 8.2 and later. This field does not convey necessary information for about counters. It was previously used for diagnostic purposes, but it is no longer needed.
- 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 filter specified as a comma-seperated list of "counter=value" pairs.Fields
A string, representing filter data, in the format of counter_name=counter_value clauses. Multiple pairs can be specified via comma (",") or pipe ("|") separation. The applied filter is a combination of ANDing and ORing the clauses. A comma indicates ANDing, a pipe indicates ORing, and the order of precedence is AND and then OR. For example, "instance_name=volA,vserver_name=vs1|vserver_name=vs2" equates to "(instance_name=volA && vserver_name=vs1) | (vserver_name=vs2)". This would return instances on Vserver vs1 with the name volA, as well as all of the instances on Vserver vs2.
Fields
Instance name.Fields
Instance name and counter values.Fields
- name => string
Name of the instance
Description of an instance of an object.Fields
- name => string, optional
Name of the instance
- uuid => string, optional
UUID of the instance
Instance UUID.Fields
Comma separated list of labels of an array type counter.Fields
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.
Performance Archive Information 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
- case-number => string, optional
Support Case Number Associated with Archive Attributes: optional-for-create, modifiable
- comment => string, optional
Performance Archive Comment Attributes: optional-for-create, modifiable
- source-nodes => node-name[], optional
Originating Nodes for Archive Data Attributes: optional-for-create, non-modifiable
- state => performance-archive-state, optional
State of Performance Archive Attributes: non-creatable, non-modifiable Possible values: - "create_calculating" - Archive properties being calculated,
- "create_queueing" - Archive waiting to be created,
- "create_packaging" - Archive files being packaged on source nodes,
- "create_incomplete" - Not all requested nodes included in saved Archive,
- "created" - Successfully saved Archive to disk,
- "create_failed" - Errors occurred while saving Archive to disk,
- "destroy_queueing" - Archive waiting to be destroyed,
- "destroy_cleaning" - Archive actively being destroyed and removed from disk,
- "destroy_incomplete" - Archive not completely removed from all nodes,
- "destroyed" - Archive successfully removed from the cluster,
- "destroy_failed" - Errors occurred while destroying Archive,
- "invalid_state" - Invalid state that should not be reached
The state of a Performance Archive Possible values: - "create_calculating" - Archive properties being calculated,
- "create_queueing" - Archive waiting to be created,
- "create_packaging" - Archive files being packaged on source nodes,
- "create_incomplete" - Not all requested nodes included in saved Archive,
- "created" - Successfully saved Archive to disk,
- "create_failed" - Errors occurred while saving Archive to disk,
- "destroy_queueing" - Archive waiting to be destroyed,
- "destroy_cleaning" - Archive actively being destroyed and removed from disk,
- "destroy_incomplete" - Archive not completely removed from all nodes,
- "destroyed" - Archive successfully removed from the cluster,
- "destroy_failed" - Errors occurred while destroying Archive,
- "invalid_state" - Invalid state that should not be reached
Fields
Performance Preset Detail information, including specific objects, counter sets, instance filters, and associated sample period information for the Performance Archive.Fields
- sample-period => string, optional
Performance Archive Sample Period
As input, this field is optional; as output, this field is always present.
Possible Values: none, 1s, 5s, 10s, 30s, 1m, 5m, 10m, 30m, 1h, 6h, 12h, 1d, 1w, config
Default: none
Performance Preset information 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
- comment => string, optional
Preset Description Attributes: optional-for-create, modifiable
- generation-id => integer, optional
Preset Generation ID Attributes: non-creatable, non-modifiable
- is-archive-enabled => boolean, optional
Is Preset Archive-Enabled? Attributes: non-creatable, modifiable
- privilege => privilege-level, optional
Preset Privilege Level Attributes: optional-for-create, modifiable
- uuid => uuid, optional
Preset UUID Attributes: non-creatable, non-modifiable
Level of PrivilegeFields
The name of an initiator groupFields
Information about a port set.Fields
- portset-name => string
Name of this port set.
- portset-type => string
Possible values: "fcp", "iscsi", "mixed".
- vserver => string
Vserver containing this portset.
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
preset|user-defined|system-defined Possible values: - "preset" - Preset,
- "user_defined" - User Defined,
- "system_defined" - System Defined
Fields
Information about the deletion operation that was attempted/performed against qos-policy object.Fields
- error-code => integer, optional
Error code, if the deletion operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
Information about the deletion operation that was attempted/performed against qos-policy-group object.Fields
- error-code => integer, optional
Error code, if the deletion operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
Information about a QoS policy group 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
- max-throughput => qos-tput, optional
Maximum throughput defined by this policy. It is specified in terms of IOPS or MB/s, and the range is zero to infinity. The values entered here are case-insensitive, and the units are base ten. There should be no space between the number and the units. The default value for max-throughput is infinity. The default unit is IOPS. Two reserved keywords, 'none' and 'INF', are available for the situation that requires removal of a value, and the situation that needs to specify the maximum available value. Examples of valid specifications are: 100B/s, 10KB/s, 1gb/s, 500MB/s, 1tb/s, and 100iops. Attributes: optional-for-create, modifiable
- policy-group => string, optional
Name of the policy group. Policy group names must be unique and are restricted to 128 alphanumeric characters, '-', and '_', and must start with an alphanumeric character (a-z, A-Z, or 0-9). Attributes: key, required-for-create, non-modifiable
- policy-group-class => qos-class, optional
Class for the policy group. Attributes: non-creatable, non-modifiable Possible values: - "preset" - Preset,
- "user_defined" - User Defined,
- "system_defined" - System Defined
- uuid => uuid, optional
Universally unique identifier for the QoS policy group. Attributes: non-creatable, non-modifiable
- vserver => vserver-name, optional
The Data Vserver to which the policy group belongs. Attributes: required-for-create, non-modifiable
Information about the modify operation that was attempted/performed against qos-policy-group object.Fields
- error-code => integer, optional
Error code, if the modify operation caused an error.
- error-message => string, optional
Error description, if the modify operation caused an error.
- qos-policy-group-key => qos-policy-group-info
The keys for the qos-policy-group object to which the modify operation applies.
QoS policy typedef 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
- cache-policy-name => string, optional
Name of an entry in the cache policy table. Identifies cache settings that will be used by workloads using this policy. If this field contains the special value 'default' then the default cache policies will be used. Modifying this field is not recommended. Attributes: optional-for-create, modifiable
- policy-class => qos-class, optional
Identifies how policy was created. Preset polices may not be modified or destroyed. Attributes: optional-for-create, non-modifiable Possible values: - "preset" - Preset,
- "user_defined" - User Defined
- policy-name => string, optional
User visible name of QoS policy. Attributes: required-for-create, modifiable
- read-ahead-policy-name => string, optional
Name of an entry in the read-ahead policy table. Identifies read-ahead settings that will be used by workloads using this policy. If this field contains the special value 'default' then the default read-ahead policies will be used. Modifying this field is not recommended. Attributes: optional-for-create, modifiable
Information about the modify operation that was attempted/performed against qos-policy object.Fields
- error-code => integer, optional
Error code, if the modify operation caused an error.
- error-message => string, optional
Error description, if the modify operation caused an error.
- qos-policy-key => qos-policy-info
The keys for the qos-policy object to which the modify operation applies.
Information about the deletion operation that was attempted/performed against qos-policy-read-ahead object.Fields
- error-code => integer, optional
Error code, if the deletion operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
QoS read-ahead policy typedef 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
- align-blocks => integer, optional
Block Alignment Attributes: optional-for-create, modifiable
- default => boolean, optional
Default Attributes: optional-for-create, modifiable
- disk-response-factor => integer, optional
Disk Response Time Factor Attributes: optional-for-create, modifiable
- disk-response-weight => integer, optional
Weight for Disk Response Time Aging (%) Attributes: optional-for-create, modifiable
- early-count => integer, optional
Number of IO Operations Cautiously Predicted Attributes: optional-for-create, modifiable
- force-dump => boolean, optional
Force DUMP-Style Readahead Attributes: optional-for-create, modifiable
- force-full => boolean, optional
Force Full-File Readahead Attributes: optional-for-create, modifiable
- force-none => boolean, optional
Disable Readahead Attributes: optional-for-create, modifiable
- interarrival-weight => integer, optional
Weight for Interarrival Time Aging (%) Attributes: optional-for-create, modifiable
- jitter => integer, optional
Threshold for Detecting Jitter (%) Attributes: optional-for-create, modifiable
- max-blocks => integer, optional
Maximum Blocks to Speculate Attributes: optional-for-create, modifiable
- max-deadline => integer, optional
Maximum Deadline Offset (us) Attributes: optional-for-create, modifiable
- max-disk-response-time => integer, optional
Maximum Disk Response Time (us) Attributes: optional-for-create, modifiable
- max-gap => integer, optional
Maximum Speculative Blocks Outstanding Attributes: optional-for-create, modifiable
- max-range => integer, optional
Maximum Range Used When Aging Streams (Blocks) Attributes: optional-for-create, modifiable
- max-retire-time => integer, optional
Maximum Time Before a Stream is Retired (us) Attributes: optional-for-create, modifiable
- metadata-blocks => integer, optional
Minimum Blocks for Which Metadata is Predicted Attributes: optional-for-create, modifiable
- min-blocks => integer, optional
Minimum Blocks to Speculate Attributes: optional-for-create, modifiable
- min-disk-response-time => integer, optional
Minimum Disk Response Time (us) Attributes: optional-for-create, modifiable
- min-range => integer, optional
Minimum Range Used When Aging Streams (Blocks) Attributes: optional-for-create, modifiable
- min-retire-time => integer, optional
Minimum Time Before a Stream is Retired (us) Attributes: optional-for-create, modifiable
- overshoot => integer, optional
Allowable Overshoot (%) Attributes: optional-for-create, modifiable
- read-ahead-class => qos-class, optional
Readahead Policy Class Attributes: optional-for-create, non-modifiable Possible values: - "preset" - Preset,
- "user_defined" - User Defined
- read-ahead-policy-name => string, optional
Name of QoS Readahead Policy. Attributes: key, required-for-create, non-modifiable
- smallfile-blocks => integer, optional
Maximum Blocks for Small-File Handling Attributes: optional-for-create, modifiable
- use-async => boolean, optional
Use Asynchronous Speculation Attributes: optional-for-create, modifiable
- use-feedback => boolean, optional
Provide Cache-Miss Feedback Attributes: optional-for-create, modifiable
- use-timing => boolean, optional
Use Timing Algorithms Attributes: optional-for-create, modifiable
Information about the modify operation that was attempted/performed against qos-policy-read-ahead object.Fields
- error-code => integer, optional
Error code, if the modify operation caused an error.
- error-message => string, optional
Error description, if the modify operation caused an error.
- qos-policy-read-ahead-key => qos-policy-read-ahead-info
The keys for the qos-policy-read-ahead object to which the modify operation applies.
Archival settings for QoS workload Objects. 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
- max-workloads => integer, optional
Maximum Number of Workloads to be Archived Attributes: non-creatable, modifiable
Information about QoS control settings. 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
- enforcement => boolean, optional
Cluster-wide QoS enforcement Attributes: non-creatable, modifiable
- ratebucket-rebalance => boolean, optional
Manage QoS ratebucket budgets across the cluster Attributes: non-creatable, modifiable
Information about the deletion operation that was attempted/performed against qos-settings-read-ahead object.Fields
- error-code => integer, optional
Error code, if the deletion operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
QoS read-ahead setting typedef 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
- align-blocks => integer, optional
Block alignment Attributes: optional-for-create, modifiable
- default => boolean, optional
Specifies whether this is the default readahead setting Attributes: optional-for-create, modifiable
- disk-response-factor => integer, optional
Disk response time factor Attributes: optional-for-create, modifiable
- disk-response-weight => integer, optional
Weight for disk response time aging (%) Attributes: optional-for-create, modifiable
- early-count => integer, optional
Number of IO operations cautiously predicted Attributes: optional-for-create, modifiable
- force-dump => boolean, optional
Force DUMP-style readahead Attributes: optional-for-create, modifiable
- force-full => boolean, optional
Force full-file readahead Attributes: optional-for-create, modifiable
- force-none => boolean, optional
Disable readahead Attributes: optional-for-create, modifiable
- interarrival-weight => integer, optional
Weight for interarrival time aging (%) Attributes: optional-for-create, modifiable
- jitter => integer, optional
Threshold for detecting jitter (%) Attributes: optional-for-create, modifiable
- max-blocks => integer, optional
Maximum blocks to speculate Attributes: optional-for-create, modifiable
- max-deadline => integer, optional
Maximum deadline Offset (ms) Attributes: optional-for-create, modifiable
- max-disk-response-time => integer, optional
Maximum disk response time (ms) Attributes: optional-for-create, modifiable
- max-gap => integer, optional
Maximum speculative blocks outstanding Attributes: optional-for-create, modifiable
- max-range => integer, optional
Maximum range used when aging streams (Blocks) Attributes: optional-for-create, modifiable
- max-retire-time => integer, optional
Maximum Time Before a Stream is Retired (us) Attributes: optional-for-create, modifiable
- metadata-blocks => integer, optional
Minimum blocks for which metadata is predicted Attributes: optional-for-create, modifiable
- min-blocks => integer, optional
Minimum blocks to speculate Attributes: optional-for-create, modifiable
- min-disk-response-time => integer, optional
Minimum disk response time (ms) Attributes: optional-for-create, modifiable
- min-range => integer, optional
Minimum range used when aging streams (Blocks) Attributes: optional-for-create, modifiable
- min-retire-time => integer, optional
Minimum Time Before a Stream is Retired (us) Attributes: optional-for-create, modifiable
- overshoot => integer, optional
Allowable overshoot (%) Attributes: optional-for-create, modifiable
- read-ahead-class => qos-class, optional
Readahead setting class Attributes: optional-for-create, non-modifiable Possible values: - "preset" - Preset,
- "user_defined" - User Defined,
- "system_defined" - System Defined
- smallfile-blocks => integer, optional
Maximum blocks for small-file handling Attributes: optional-for-create, modifiable
- use-async => boolean, optional
Use asynchronous speculation Attributes: optional-for-create, modifiable
- use-feedback => boolean, optional
Provide cache-miss feedback Attributes: optional-for-create, modifiable
- use-histogram => boolean, optional
Use Histogram-based predictions Attributes: optional-for-create, modifiable
- use-timing => boolean, optional
Use timing algorithms Attributes: optional-for-create, modifiable
Information about the modify operation that was attempted/performed against qos-settings-read-ahead object.Fields
- error-code => integer, optional
Error code, if the modify operation caused an error.
- error-message => string, optional
Error description, if the modify operation caused an error.
- qos-settings-read-ahead-key => qos-settings-read-ahead-info
The keys for the qos-settings-read-ahead object to which the modify operation applies.
QoS stream characteristics. The set of parameters that defines this stream.Fields
- vserver => vserver-name, optional
Vserver Attributes: optional-for-create, non-modifiable
Information about the deletion operation that was attempted/performed against qos-stream object.Fields
- error-code => integer, optional
Error code, if the deletion operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
QoS stream typedef 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
- characteristics => qos-stream-characteristics, optional
QoS stream characteristics. The set of parameters that defines this stream.
- stream-id => integer, optional
Identifier for this stream. Together with the workload-uuid, uniquely identifies the stream. Attributes: key, required-for-create, non-modifiable
- workload-uuid => uuid, optional
Universally unique identifier for the workload to which the stream is attached. Attributes: key, required-for-create, non-modifiable
QoS throughput typeFields
Information about the deletion operation that was attempted/performed against qos-workload object.Fields
- error-code => integer, optional
Error code, if the deletion operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
Information about the deletion operation that was attempted/performed against qos-workload object.Fields
- error-code => integer, optional
Error code, if the deletion operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
- qos-workload-key => qos-workload-info
The keys for the qos-workload object to which the deletion applies.
Information about a QoS workload 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
- lun => string, optional
Name for a lun workload. Attributes: optional-for-create, non-modifiable
- policy-group => string, optional
Name for a QoS policy group. Attributes: non-creatable, non-modifiable
- qtree => string, optional
Name for a qtree workload. Attributes: optional-for-create, non-modifiable
- read-ahead => string, optional
Name for a read-ahead tunable policy. Attributes: optional-for-create, modifiable
- volume => string, optional
Name for a volume workload. Attributes: optional-for-create, non-modifiable
- vserver => string, optional
Name for a vserver workload. Attributes: optional-for-create, non-modifiable
- workload-class => qos-class, optional
Class for the workload. Attributes: non-creatable, non-modifiable Possible values: - "preset" - Preset,
- "user_defined" - User Defined,
- "system_defined" - System Defined
- workload-uuid => uuid, optional
Universally unique identifier for the QoS workload. Attributes: non-creatable, non-modifiable
Information about the modify operation that was attempted/performed against qos-workload object.Fields
- error-code => integer, optional
Error code, if the modify operation caused an error.
- error-message => string, optional
Error description, if the modify operation caused an error.
- qos-workload-key => qos-workload-info
The keys for the qos-workload object to which the modify operation applies.
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".
- qtree => string
Name of the qtree, blank if qtree is the volume itself
- status => string
Status of the qtree. Possible values include: "snapvaulted", "snapmirrored", "normal", and "readonly".
- volume => string
Name of the volume containing the qtree
- vserver => string, optional
The vserver in which the volume belongs
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. 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.
- files-used => string
Current number of files used by the quota target. 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.
- volume => string
Name of the volume to which the quota is applied.
- vserver => string, optional
The vserver name in which the volume belongs, for which the quota is applicable
Information about a single quota rule.Fields
- disk-limit => string, optional
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, optional
Maximum number of files allowed for the quota target (hard files limit). The value is "-" if the limit is unlimited.
- perform-user-mapping => boolean, optional
If the value is true, user mapping will be performed for this rule.
- policy => string, optional
The quota policy to which the rule belongs.
- 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.
- soft-disk-limit => string, optional
Soft disk space limit, in kilobytes, for the quota target. The value is "-" if the limit is unlimited.
- soft-file-limit => string, optional
Soft file limit, in number of files, for the quota target. The value is "-" if the limit is unlimited.
- threshold => string, optional
Disk space threshold, in kilobytes, for the quota target. The value is "-" if the limit is unlimited.
- volume => string, optional
Name of the volume for the quota. If there is an error in the quota entry, this value might not present.
- vserver => string, optional
The vserver name.
Information about a single quota error.Fields
- reason => string
A human-readable concise reason for the error.
Information about the single quota error.Fields
Attributes of quota statusFields
- percent-complete => integer, optional
The percentage complete for an "on" or "resize" operation. This is present when the status is "upgrading", "resizing" or "initializing".
- quota-error-msgs => quota-error-msg[], optional
Collection of quota errors including the value of the reason tag above. 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"
- volume => string
Name of the volume to which the quota is applied.
- vserver => string
The vserver name in which the volume belongs, for which the quota is applicable
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).
Effective security style on file Possible values: - "security_none" - Security not Set,
- "security_unix_modebits" - UNIX and UNIX permissions,
- "security_unix_acl" - UNIX and NFSv4 ACL,
- "security_unix_sd" - UNIX and NT ACL,
- "security_mixed_modebits" - MIXED and UNIX permissions,
- "security_mixed_acl" - MIXED and NFSv4 ACL,
- "security_mixed_sd" - MIXED and NT ACL,
- "security_ntfs_modebits" - NTFS and UNIX permissions,
- "security_ntfs_acl" - NTFS and NT ACL,
- "security_ntfs_sd" - NTFS and NT ACL,
- "security_unix" - UNIX,
- "security_mixed" - MIXED,
- "security_ntfs" - NTFS,
- "security_modebits" - UNIX permissions,
- "security_acl" - ACL,
- "security_sd" - SD
Fields
Security trace configuration. 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
- client-ip => ip-address, optional
The IP address of the client. Attributes: optional-for-create, modifiable
- enabled => enable, optional
This is used to enable or disable the filter. Attributes: optional-for-create, modifiable
- path => string, optional
Path to match. Attributes: optional-for-create, modifiable
- time-enabled => integer, optional
The admin can specify a timeout for this filter after which it would be disabled. Attributes: optional-for-create, modifiable
- trace-allow => boolean, optional
The deny events are traced by default. This option is to record trace results for allow events as well. Attributes: optional-for-create, modifiable
- unix-name => string, optional
Unix user name to trace. Attributes: optional-for-create, modifiable
- vserver => vserver-name, optional
Vserver on which the permission tracing is applied. Attributes: key, non-creatable, non-modifiable
- windows-name => string, optional
Windows User Name to trace. Attributes: optional-for-create, modifiable
List of security tracing results. 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
- client-ip => ip-address, optional
The IP address of the client that triggered the permission tracing event. Attributes: required-for-create, non-modifiable
- index => integer, optional
The index of the filter corresponding to the permission tracing event. Attributes: required-for-create, non-modifiable
- keytime => date, optional
The date and time of day when the persmission tracing event occured. Attributes: required-for-create, non-modifiable
- node => node-name, optional
The cluster node on which the permission tracing event occured. Attributes: key, required-for-create, non-modifiable
- path => string, optional
The path of the file whose access triggered the permission tracing event. Attributes: required-for-create, non-modifiable
- result => string, optional
A brief explanation of the result of the security check. Attributes: required-for-create, non-modifiable
- security-style => security-style, optional
The security style of the file system where the persmission tracing event occured. Attributes: required-for-create, non-modifiable Possible values: - "security_none" - Security not Set,
- "security_unix_modebits" - UNIX and UNIX permissions,
- "security_unix_acl" - UNIX and NFSv4 ACL,
- "security_unix_sd" - UNIX and NT ACL,
- "security_mixed_modebits" - MIXED and UNIX permissions,
- "security_mixed_acl" - MIXED and NFSv4 ACL,
- "security_mixed_sd" - MIXED and NT ACL,
- "security_ntfs_modebits" - NTFS and UNIX permissions,
- "security_ntfs_acl" - NTFS and NT ACL,
- "security_ntfs_sd" - NTFS and NT ACL,
- "security_unix" - UNIX,
- "security_mixed" - MIXED,
- "security_ntfs" - NTFS,
- "security_modebits" - UNIX permissions,
- "security_acl" - ACL,
- "security_sd" - SD
- user-name => string, optional
Windows or Unix user who triggered the permission tracing event. Attributes: required-for-create, non-modifiable
- vserver => vserverid, optional
The Vserver on which the permission tracing event occured. Attributes: key, non-creatable, non-modifiable
The displays the hexadecimal value in string. Integer value 161 will be displayed as a1Fields
User account information 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
- application => string, optional
Name of the application. Possible values: 'console', 'http', 'ontapi', 'rsh', 'snmp', 'sp', 'ssh', 'telnet'. Attributes: key, required-for-create, non-modifiable
- authentication-method => string, optional
Authentication method for the application. Possible values: 'community', 'password', 'publickey', 'domain', 'nsswitch' and 'usm'. Not all authentication methods are valid for an application. Valid authentication methods for each application are: 'password' for 'console' application. 'password', 'domain', 'nsswitch', 'cert' for 'http' application. 'password', 'domain', 'nsswitch', 'cert' for 'ontapi' application. 'community' for 'snmp' application (when creating SNMPv1 and SNMPv2 users). 'usm' and 'community' for 'snmp' application (when creating SNMPv3 users). 'password' for 'sp' application. 'password' for 'rsh' application. 'password' for 'telnet' application. 'password', 'publickey', 'domain', 'nsswitch' for 'ssh' application. Attributes: key, required-for-create, non-modifiable
- comment => string, optional
Comments for the user account. The length of comment should be less than or equal to 128 charaters. Attributes: optional-for-create, modifiable
- user-name => string, optional
Name of the user. When creating a SNMPv1 or SNMPv2 user with 'snmp' application and 'community' authentication-method, the user name is the community string. Attributes: key, required-for-create, non-modifiable
- vserver => string, optional
Name of the Vserver. Attributes: key, non-creatable, non-modifiable
Information about the deletion operation that was attempted/performed against security login account object.Fields
- error-code => integer, optional
Error code, if the deletion operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
Information about the modify operation that was attempted/performed against security login account object.Fields
- error-code => integer, optional
Error code, if the modify operation caused an error.
- error-message => string, optional
Error description, if the modify operation caused an error.
User role configuration information. 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
- change-password-duration-in-days => integer, optional
This optionally specifies the number of days that must pass between password changes. The default setting is 0 (zero) meaning the user is allowed to change the password immediately. Attributes: non-creatable, modifiable
- last-passwords-disallowed-count => integer, optional
This optionally specifies the number of previous passwords that are disallowed for reuse. The default setting is 6. Attributes: non-creatable, modifiable
- lockout-duration => integer, optional
This optionally specifies the number of days to lock the account if maximum number of failed attempts occur. Default is 0. Attributes: non-creatable, modifiable
- max-failed-login-attempts => integer, optional
This optionally specifies the maximum number of invalid login attempts after which the account gets locked. Default is 0. Attributes: non-creatable, modifiable
- min-passwd-specialchar => integer, optional
This optionally specifies the minimum special characters required in password. The default setting is no special chars i.e. 0. Attributes: non-creatable, modifiable
- min-password-size => integer, optional
This optionally specifies the minimum length of the password. Possible values range from 3 to 64 characters. The default setting is 8 characters. Attributes: non-creatable, modifiable
- min-username-size => integer, optional
The minimum length of the user name. Possible values range from 3 to 16 characters. The default setting is 3 characters. Attributes: non-creatable, modifiable
- password-expiration-duration => string, optional
This optionally specifies the password expiry in days. A value of 0 means it expiries now. Default is 2^32-1 (ie., never expire). Attributes: non-creatable, modifiable
- require-initial-password-update => boolean, optional
This optionally specifies to change the password upon first-login to the storage controller from SSH or serial-console. Default is false. Attributes: non-creatable, modifiable
- require-password-alpha-numeric => boolean, optional
If this field is set it specifies that the password must have atleast 1 alpha and 1 numeric character. Attributes: non-creatable, modifiable
- require-username-alpha-numeric => boolean, optional
If this field is set it specifies that the username must have atleast 1 alpha and 1 numeric character. Attributes: non-creatable, modifiable
- role-name => string, optional
Name of the role. Attributes: key, non-creatable, non-modifiable
- vserver => string, optional
Name of the Vserver. Attributes: key, non-creatable, non-modifiable
Information about the modify operation that was attempted/performed against security login roleconfig object.Fields
- error-code => integer, optional
Error code, if the modify operation caused an error.
- error-message => string, optional
Error description, if the modify operation caused an error.
Information about the deletion operation that was attempted/performed against security login role object.Fields
- error-code => integer, optional
Error code, if the deletion operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
User role information. 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
- access-level => string, optional
Access level for the role. Possible values: 'none', 'readonly', 'all'. The default value is 'all'. Attributes: optional-for-create, modifiable
- role-name => string, optional
Name of the role. Attributes: key, required-for-create, non-modifiable
- role-query => string, optional
A query for the role. The query must apply to the specified command or directory name. Example: The command is 'volume show' and the query is '-volume vol1'. The query is applied to the command resulting in populating only the volumes with name vol1. Attributes: optional-for-create, modifiable
- vserver => string, optional
Name of the Vserver. Attributes: key, non-creatable, non-modifiable
Information about the modify operation that was attempted/performed against security login role object.Fields
- error-code => integer, optional
Error code, if the modify operation caused an error.
- error-message => string, optional
Error description, if the modify operation caused an error.
- security-key => security-login-role-info
The keys for the security login role object to which the modify operation applies.
SNMPv3 user login information for 'usm' authentication methodFields
- authentication-password => string, optional
Password for the authentication protocol. This should be minimum 8 characters long. This is required for 'md5' and 'sha' authentication protocols and not required for 'none'. Attributes: optional-for-create, non-modifiable
- engine-id => hex-string, optional
Authoritative entity's EngineID for the SNMPv3 user. This is required for creating SNMPv3 users (users for SNMPv3 INFORMs) with 'usm' authentication method only. This should be specified as a hexadecimal string. Engine ID with first bit set to 1 in first octet should have a minimum of 5 or maximum of 32 octets. Engine Id with first bit set to 0 in the first octet should be 12 octets in length. Engine Id cannot have all zeros in its address For e.g. 8000014603000000000000. Attributes: optional-for-create, non-modifiable
- privacy-password => string, optional
Password for the privacy protocol. This should be minimum 8 characters long. This is required for 'des' privacy protocol and not required for 'none'. Attributes: optional-for-create, non-modifiable
- privacy-protocol => string, optional
Privacy protocol for the snmp user. Possible values: 'none', 'des'. The default value is 'none'. Attributes: optional-for-create, non-modifiable
Information about issued digital certificates by Self-Signed Root CA 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
- certificate-authority => string, optional
Certificate Authority Attributes: key, non-creatable, non-modifiable
- common-name => string, optional
Represents the domain name in FQDN form that specifies its exact location in the tree hierarchy of the Domain Name System (DNS). Attributes: non-creatable, non-modifiable
- country => string, optional
Name of the country. Attributes: non-creatable, non-modifiable
- locality => string, optional
Name of the locality. Attributes: non-creatable, non-modifiable
- organization => string, optional
Name of the organization. Attributes: non-creatable, non-modifiable
- organization-unit => string, optional
Name of the unit. Example: IT, Finance. Attributes: non-creatable, non-modifiable
- serial-number => string, optional
Serial number of certificate. Attributes: key, non-creatable, non-modifiable
- state => string, optional
Name of the state. Attributes: non-creatable, non-modifiable
- status => string, optional
Status of certificate. Attributes: non-creatable, non-modifiable Possible values:
- vserver => string, optional
Name of vserver. Attributes: key, non-creatable, non-modifiable
Information about location of certificate files 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
- certificate-authority => string, optional
Certificate Authority. Attributes: key, non-creatable, non-modifiable
- common-name => string, optional
Represents the domain name in FQDN form that specifies its exact location in the tree hierarchy of the Domain Name System (DNS). Attributes: key, non-creatable, non-modifiable
- file => string, optional
Type of file. Attributes: key, non-creatable, non-modifiable Possible values: - "certificate" - Public Key,
- "key" - Private Key,
- "crl" - Certificate Revocation List
- node-name => string, optional
The node on which the file exists. Attributes: key, non-creatable, non-modifiable
- path => string, optional
Path of the file in the file system. Attributes: non-creatable, non-modifiable
- serial-number => string, optional
Serial number of certificate. Attributes: key, non-creatable, non-modifiable
- type => string, optional
Type of certificate. Possible values:
- 'server' - Server certificate,
- 'root_ca' - Self-Signed Root CA,
- 'client_ca' - CA who signed user certificates',
- 'server_chain' - Intermediate certificate for server authentication
Attributes: key, non-creatable, non-modifiable
- vserver => string, optional
Name of vserver. Attributes: key, non-creatable, non-modifiable
Information about a Digital Certificate 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
- certificate-authority => string, optional
Certificate Authority Attributes: key, required-for-create, non-modifiable
- common-name => string, optional
Represents the domain name in FQDN form that specifies its exact location in the tree hierarchy of the Domain Name System (DNS). Attributes: key, required-for-create, non-modifiable
- country => string, optional
Name of the country. Default value is 'US'. Attributes: required-for-create, non-modifiable
- email-address => string, optional
Email address of administrator. Default value is empty string. Attributes: required-for-create, non-modifiable
- expiration-date => integer, optional
Certificate Expiration Date Attributes: non-creatable, non-modifiable
- expire-days => integer, optional
Number of days until expiration. Default value is '365'. Attributes: required-for-create, non-modifiable
- hash-function => string, optional
Hashing function used to sign the certificate. Default value is 'sha256'. Attributes: required-for-create, non-modifiable Possible values: - "sha1" ,
- "sha256" ,
- "md5"
- locality => string, optional
Name of the locality Default value is empty string. Attributes: required-for-create, non-modifiable
- organization => string, optional
Name of the organization. Default value is empty string. Attributes: required-for-create, non-modifiable
- organization-unit => string, optional
Name of the unit. Example: IT, Finance. Default value is empty string. Attributes: required-for-create, non-modifiable
- protocol => string, optional
Protocol Attributes: non-creatable, non-modifiable Possible values:
- serial-number => string, optional
Serial number of certificate. Attributes: key, required-for-create, non-modifiable
- size => string, optional
Size of requested certificate in bits. Default value is '2048'. Attributes: required-for-create, non-modifiable Possible values: - "512" - 512 bits private key,
- "1024" - 1024 bits private key,
- "1536" - 1536 bits private key,
- "2048" - 2048 bits private key
- state => string, optional
Name of the state. Default value is empty string. Attributes: required-for-create, non-modifiable
- type => string, optional
Type of certificate. Possible values:
- 'server' - Server certificate,
- 'root_ca' - Self-Signed Root CA,
- 'client_ca' - CA who signed user certificates',
- 'server_chain' - Intermediate certificate for server authentication
Attributes: key, required-for-create, non-modifiable
- vserver => string, optional
Name of vserver. Attributes: key, non-creatable, non-modifiable
Represents the domain name in FQDN form that specifies its exact location in the tree hierarchy of the Domain Name System (DNS).Fields
nullFields
Information about the deletion operation that was attempted/performed against security-certificate object.Fields
- error-code => integer, optional
Error code, if the deletion operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
nullFields
Information about SSL authentication for a Vserver 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
- certificate-authority => string, optional
Issuing Certificate Authority (CA) of server certificate. This field is required when you specify server-enabled as true. Attributes: non-creatable, modifiable
- certificate-serial-number => string, optional
Serial number of certificate in hexadecimal format. This field is required when you specify server-enabled as true. Attributes: non-creatable, modifiable
- client-authentication-enabled => boolean, optional
Informs if SSL Client Authentication is enabled. Attributes: non-creatable, modifiable
- common-name => string, optional
Represents the domain name in FQDN form that specifies its exact location in the tree hierarchy of the Domain Name System (DNS). This field is optional when you specify server-enabled as true. Attributes: non-creatable, modifiable
- server-authentication-enabled => boolean, optional
Informs if SSL Server Authentication is enabled. Attributes: non-creatable, modifiable
- vserver => string, optional
Name of vserver. Attributes: key, non-creatable, non-modifiable
MAC AddressFields
Service processor firmware information 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
- firmware-image => sp-fw-type, optional
Is this image primary or backup firmware for the device Attributes: key, non-creatable, non-modifiable Possible values: - "primary" - Firmware which the device boots into by default,
- "backup" - Firmware which the device boots into if primary fails
- is-autoupdate-enabled => boolean, optional
Is firmware autoupdate enabled on the device Attributes: non-creatable, non-modifiable
- last-update-status => sp-pass-fail, optional
Did last firmware install on the device pass or fail Attributes: non-creatable, non-modifiable Possible values: - "failed" - Operation failed,
- "passed" - Operation was successful
- node => node-name, optional
Node on which the device is located Attributes: key, non-creatable, non-modifiable
- status => sp-fw-status, optional
Status of this firmware image Attributes: non-creatable, non-modifiable Possible values: - "installed" - Firmware installed and in normal state,
- "corrupt" - Firmware is corrupt,
- "updating" - Firmware is undergoing a manual update,
- "auto_updating" - Firmware is undergoing an automatic update,
- "none" - Firmware status not known
- type => sp-type, optional
Type of device Attributes: non-creatable, non-modifiable Possible values: - "rlm" - Remote LAN Module,
- "sp" - Service Processor
- version => string, optional
Firmware version in this image Attributes: non-creatable, non-modifiable
Service processor image update progress information 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
- node => node-name, optional
Node on which the device is located Attributes: key, non-creatable, non-modifiable
Service processor information 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
- is-autoupdate-enabled => boolean, optional
Is firmware autoupdate enabled for the device Attributes: non-creatable, non-modifiable
- node => node-name, optional
Node on which the device is located Attributes: key, non-creatable, non-modifiable
- status => sp-status, optional
Current status of the device Attributes: non-creatable, non-modifiable Possible values: - "online" - Device is up and running fine,
- "offline" - Device is out of communication,
- "sp_daemon_offline" - Daemon which communicates with the device is not running,
- "node_offline" - Node that hosts the device is out of communication,
- "degraded" - Node that hosts the device is missing heartbeat signals from the device,
- "rebooting" - Device is rebooting,
- "unknown" - Device status could not be determined
- type => sp-type, optional
Type of device Attributes: non-creatable, non-modifiable Possible values: - "rlm" - Remote LAN Module,
- "sp" - Service Processor
Service processor network configuration 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
- address-type => sp-ip-address-type, optional
Network configuration that is being addressed i.e. IPv4 or IPv6 Attributes: key, non-creatable, non-modifiable Possible values: - "ipv4" - Internet Protocol version 4,
- "ipv6" - Internet Protocol version 6
- dhcp => sp-dhcp-status, optional
DHCP status for the configuration Attributes: non-creatable, modifiable Possible values: - "v4" - DHCP for IPv4,
- "none" - DHCP not enabled
- gateway-ip-address => ip-address, optional
IP address of the network gateway Attributes: non-creatable, modifiable
- ip-address => ip-address, optional
IP address currently held by the device Attributes: non-creatable, modifiable
- is-enabled => boolean, optional
Is this address configuration enabled Attributes: non-creatable, modifiable
- link-status => sp-link-status, optional
Current status of the underlying network link used by this address Attributes: non-creatable, non-modifiable Possible values: - "up" - Link is connected,
- "down" - Link is severed,
- "disabled" - Link has been disabled by user,
- "unknown" - Link status is no known
- mac-address => mac-address, optional
MAC address of the device Attributes: non-creatable, non-modifiable
- netmask => ip-address, optional
Netmask for the device Attributes: non-creatable, modifiable
- node => node-name, optional
Node on which the device is located Attributes: key, non-creatable, non-modifiable
- prefix-length => integer, optional
Prefix length of subnet mask Attributes: non-creatable, modifiable
- status => sp-status, optional
Current status of the device Attributes: non-creatable, non-modifiable Possible values: - "online" - Device is up and running fine,
- "offline" - Device is out of communication,
- "sp_daemon_offline" - Daemon which communicates with the device is not running,
- "node_offline" - Node that hosts the device is out of communication,
- "degraded" - Node that hosts the device is missing heartbeat signals from the device,
- "rebooting" - Device is rebooting,
- "unknown" - Device status could not be determined
Possible configurations for DHCP protocol Possible values: - "v4" - DHCP for IPv4,
- "none" - DHCP not enabled
Fields
Possible states the firmware of a SP/RLM device can be in Possible values: - "installed" - Firmware installed and in normal state,
- "corrupt" - Firmware is corrupt,
- "updating" - Firmware is undergoing a manual update,
- "auto_updating" - Firmware is undergoing an automatic update,
- "none" - Firmware status not known
Fields
Choices for the two firmware images installed on a SP/RLM device Possible values: - "primary" - Firmware which the device boots into by default,
- "backup" - Firmware which the device boots into if primary fails
Fields
Possible choices for a firmware update type Possible values: - "full" - Replace the fimrware completely with new package,
- "differential" - Replace only parts of firmware which have changed in new package
Fields
Choices for which IP version to use Possible values: - "ipv4" - Internet Protocol version 4,
- "ipv6" - Internet Protocol version 6
Fields
Possible states for the underlying physical link for a network insterface Possible values: - "up" - Link is connected,
- "down" - Link is severed,
- "disabled" - Link has been disabled by user,
- "unknown" - Link status is no known
Fields
Possible completion states of a task Possible values: - "failed" - Operation failed,
- "passed" - Operation was successful
Fields
Possible states a Service Processor or Remote LAN Module can be in Possible values: - "online" - Device is up and running fine,
- "offline" - Device is out of communication,
- "sp_daemon_offline" - Daemon which communicates with the device is not running,
- "node_offline" - Node that hosts the device is out of communication,
- "degraded" - Node that hosts the device is missing heartbeat signals from the device,
- "rebooting" - Device is rebooting,
- "unknown" - Device status could not be determined
Fields
Types of remote management device that can be found in a node Possible values: - "rlm" - Remote LAN Module,
- "sp" - Service Processor
Fields
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".
Vendor specific enclosure system information for Ariodata shelf.Fields
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]
Information on cables and/or connectors connected to the shelfFields
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.
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 informationFields
- 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".
Information on the enclosure type. This information will be presented for ESH and SAS shelves only.Fields
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.
Information on individual ESH modules in the shelf.Fields
Vendor specific enclosure system information for Eurologic shelf.Fields
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.
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.
- 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.
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 informationFields
- 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.
Available information on the processor complex modules (PCMs) in the shelf.Fields
Detailed information on SAS cables and connectors connected to the shelf. Only information on the connectors with cables attached will be presented.Fields
- 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
Serial 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-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.
Vendor specific enclosure system information for SAS shelf.Fields
- serial-no => string
Shelf backplane serial number.
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 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.
Bay and port information on a shelf module.Fields
- channel-name => string
The channel the shelf (hub) is attached to. Example: 0c.
- node-name => string, optional
This field is only valid when the request is sent to the Admin Vserver LIF, in which case it is the storage system name.
- 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", "offline", "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".
- 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 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-designator => string, optional
Shelf bay port designator. Possible values: "in", "out", "aux", "sqr", "cir", "sil", "hi_lo", "a_to_b", "b_to_a", "disk_bay".
- 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".
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 environment information.Fields
- channel-name => string
Storage controller channel the shelf is connected to.
- node-name => string, optional
This field is only valid when the request is sent to the Admin Vserver LIF, in which case it is the storage system name.
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".
- 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".
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".
- node-name => string
This field is only valid when the request is sent to the Admin Vserver LIF, in which case it is the storage system name.
- 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", "offline", "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.
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".
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.
Vendor specific enclosure system information for Xyratex shelf.Fields
nullFields
- 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-content-available => boolean
This indicates if the value of other elements in this dense-status object are valid. Attributes: non-creatable, non-modifiable This parameter is not supported on Infinite Volumes. A "true" value for this field indicates a normal case when everything went fine while fetching the status values for this volume. All values returned are valid. A "false" value for this field indicates something went wrong while fetching the status values for this volume. Not all values returned are valid. The volume returned may not be a sis volume.
- is-idd-enabled => boolean, optional
Indicates incompressible data detection is enabled. Possible values: 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-state => string, optional
Completion status for the last operation. Possible values: 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.
- 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.
- policy => string, optional
sis policy name. Returned only if verbose option is set.
- 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:
- 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: 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.
- vserver => vserver-name, optional
Vserver Name
cluster-admin|vserver-admin Possible values: - "cluster_admin" ,
- "vserver_admin"
Fields
sis checkpoint type Possible values: - "Scan" - Scanning volume for fingerprints,
- "Start" - Starting a sis operation,
- "Check" - Checking for stale data in the fingerprint database,
- "Undo" - Undoing sis on the volume,
- "Downgrade" - Downgrading sis metafiles to a previous Data ONTAP release.
Fields
sis checkpoint stage Possible values: - "Gathering" - Scanning the volume for fingerprints,
- "Sorting" - Sorting the gathered fingerprints,
- "Compress_preproc" - Preprocessing volume data for compression,
- "Compressing" - Compressing the volume data,
- "Saving_pass1" - Creating duplicate list from the newly gathered fingerprints,
- "Saving_pass2" - Creating duplicate list from the fingerprint database,
- "Saving_sharing" - Creating shared data structures in the volume,
- "Saving_end" - Completing sis operations,
- "Checking_pass0" - Organizing data in the fingerprint database for block sharing,
- "Checking_pass1" - Organizing data in the fingerprint database for block sharing,
- "Checking_pass2" - Organizing data in the fingerprint database for block sharing,
- "Unknown_stage" - Invalid stage
Fields
sis checkpoint sub-stage Possible values: - "Sort_pass2" - Sorting the fingerprints for deduplication
Fields
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.
sis operation status Possible values: - "Idle" - No sis operations are happening on this volume,
- "Initializing" - sis operation is being initialized,
- "Active" - A 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.
Fields
sis-policy-info typedef 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
- comment => string, optional
A brief description of the policy. Attributes: optional-for-create, modifiable
- duration => string, optional
The duration in hours for which the scheduled sis operation should run. After this time expires, the sis operation will be stopped even if the operation is incomplete. If there is no duration set on the volume, the operation will run till it completes. Attributes: optional-for-create, modifiable
- enabled => boolean, optional
If the value is true, the sis policy is active and sis operations will be triggered on the volume on the specified schedule. If the value is false, the sis policy will be inactive and sis operations will not be triggered on the volume on the specified schedule. Attributes: optional-for-create, modifiable
- policy-name => string, optional
sis policy name. Attributes: key, required-for-create, non-modifiable
- policy-owner => string, optional
Owner of the policy. Possible values: - "cluster_admin" - Policy is owned by the cluster admin. This policy can be applied to volumes owned by any Vserver.
- "vserver_admin" - Policy is owned by the Vserver admin. This policy can only be applied to volumes owned by the same Vserver.
- qos-policy => string, optional
QoS policy for the sis operation. Possible values: - "background" - sis operation will run in background, with minimal or no impact on data aserving client operations,
- "best-effort" - sis operations may have some impact on data serving client operations.
Default value: "best-effort" Attributes: optional-for-create, modifiable
- schedule => string, optional
Cron type job schedule name. When the associated policy is set on a volume, the sis operation will be triggered for the volume on this schedule. These schedules can be created using the job-schedule-cron-create API. Existing schedules can be queried using the job-schedule-cron-get-iter API. Attributes: required-for-create, modifiable
- vserver => vserver-name, optional
Vserver name. Attributes: key, non-creatable, non-modifiable
Disabled|Enabled Possible values: Fields
When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller.
When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Fields
- 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. This parameter is not supported on Infinite Volumes.
- changelog-used-percent => integer, optional
Percentage of changelog used. This parameter is not supported on Infinite Volumes.
- checkpoint-op-type => sis-checkpoint-op-type, optional
Checkpoint operation Type. This parameter is not supported on Infinite Volumes. Attributes: non-creatable, non-modifiable Possible values: - "Scan" - Scanning volume for fingerprints,
- "Start" - Starting a sis operation,
- "Check" - Checking for stale data in the fingerprint database,
- "Undo" - Undoing sis on the volume,
- "Downgrade" - Downgrading sis metafiles to a previous Data ONTAP release.
- checkpoint-progress => string, optional
Checkpoint Stage Progress with information as to which stage of deduplication is checkpointed and how much data is processed for that stage. For ex: 25 MB Scanned, 20 MB Searched, 40 MB (20%) Done, 30 MB Verified. This parameter is not supported on Infinite Volumes. Attributes: non-creatable, non-modifiable
- checkpoint-stage => sis-checkpoint-stage, optional
Checkpoint stage information. This parameter is not supported on Infinite Volumes. Attributes: non-creatable, non-modifiable Possible values: - "Gathering" - Scanning the volume for fingerprints,
- "Sorting" - Sorting the gathered fingerprints,
- "Compress_preproc" - Preprocessing volume data for compression,
- "Compressing" - Compressing the volume data,
- "Saving_pass1" - Creating duplicate list from the newly gathered fingerprints,
- "Saving_pass2" - Creating duplicate list from the fingerprint database,
- "Saving_sharing" - Creating shared data structures in the volume,
- "Saving_end" - Completing sis operations,
- "Checking_pass0" - Organizing data in the fingerprint database for block sharing,
- "Checking_pass1" - Organizing data in the fingerprint database for block sharing,
- "Checking_pass2" - Organizing data in the fingerprint database for block sharing,
- "Unknown_stage" - Invalid stage
- checkpoint-sub-stage => sis-checkpoint-substage, optional
Checkpoint sub-stage information. This parameter is not supported on Infinite Volumes. Attributes: non-creatable, non-modifiable Possible values: - "-" - No sub stage check point present,
- "Sort_pass1" - Sorting the fingerprints for deduplication,
- "Sort_p1merge" - Merging the fingerprints for deduplication,
- "Sort_pass2" - Merging the fingerprints for deduplication,
- "Bucket_sort_init" - Sorting the fingerprints for deduplication,
- "Bucket_sort" - Sorting the fingerprints for deduplication,
- "Bucket_sort_done" - Sorting the fingerprints for deduplication completed
- checkpoint-time => integer, optional
Checkpoint creation timestamp. The value is in seconds since January 1, 1970. This parameter is not supported on Infinite Volumes. Attributes: non-creatable, non-modifiable
- is-compression-enabled => boolean, optional
Compression state of the volume Attributes: non-creatable, modifiable
- is-content-available => boolean, optional
When returned as part of the output, this indicates if the value of other elements in this sis-info object are valid. This parameter is not supported on Infinite Volumes. Attributes: non-creatable, non-modifiable A "true" value for this field indicates a normal case when everything went fine while fetching the status values for this volume. All values returned are valid. A "false" value for this field indicates something went wrong while fetching the status values for this volume. Not all values returned are valid. The volume returned may not be a sis volume. Default: true
- is-idd-enabled => boolean, optional
Indicates incompressible data detection is enabled. Possible values: 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.
- is-inline-compression-enabled => boolean, optional
Inline compression state of the volume Attributes: non-creatable, modifiable
- last-op-begin-timestamp => integer, optional
Start timestamp of the last sis operation. The value is in seconds since January 1, 1970. Returned only if verbose option is requested. This parameter is not supported on Infinite Volumes. Attributes: non-creatable, non-modifiable
- last-op-error => string, optional
A human readable error message of the last sis operation. Present when there was an error. This parameter is not supported on Infinite Volumes. Attributes: non-creatable, non-modifiable
- last-op-size => size, optional
The amount of data processed in bytes for the last sis operation. This parameter is not supported on Infinite Volumes. Attributes: non-creatable, non-modifiable
- last-op-state => string, optional
Completion status for the last operation. Possible values: Returned only if verbose option is set and when there is last completed operation. This parameter is not supported on Infinite Volumes.
- last-success-op-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-op-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-size => integer, optional
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.
- 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.
- path => volume-path, optional
Volume for which sis information is returned. Path is of the format /vol/<vol_name>. Attributes: key, non-creatable, non-modifiable
- policy => string, optional
sis policy name. Attributes: non-creatable, modifiable
- progress => string, optional
The progress of the current sis operation with information as to which stage of sis process is currently in progress and how much data is processed for that stage. For ex: 25 MB Scanned, 20 MB Searched, 40 MB (20%) Done, 30 MB Verified. This parameter is not supported on Infinite Volumes. Attributes: non-creatable, non-modifiable
- 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"
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. Attributes: non-creatable, modifiable
- stale-fingerprint-percentage => integer, optional
Percentage of fingerprints that are stale in the fingerprint database. This parameter is not supported on Infinite Volumes.
- status => sis-op-status, optional
Status of any sis operation running on the volume. This parameter is not supported on Infinite Volumes. Attributes: non-creatable, non-modifiable 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.
- type => sis-type, optional
Any sis volume with Snapvault qtree in it would be marked as Snapvault and all others would be returned as type Regular. Attributes: non-creatable, non-modifiable Possible values:
- vserver => vserver-name, optional
A string identifying the Vserver Attributes: key, non-creatable, non-modifiable
Regular|SnapVault Possible values: Fields
nullFields
Volume path nameFields
Vserver NameFields
SnapMirror PolicyFields
low|normal Possible values: Fields
Information about the operation that was attempted/performed against snapmirror object.Fields
- error-code => integer, optional
Error code, if the operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
Information about the operation that was attempted/performed against snapmirror object.Fields
- error-code => integer, optional
Error code, if the operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
- snapmirror-key => snapmirror-info
The keys for the snapmirror object to which the operation applies.
Information about the operation that was attempted/performed against snapmirror object.Fields
- error-code => integer, optional
Error code, if the operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
- snapmirror-key => snapmirror-info
The keys for the snapmirror object to which the operation applies.
- status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
Information about a Destination of a SnapMirror Relationship Source 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
- destination-location => string, optional
Specifies the destination endpoint of the SnapMirror relationship in the format [vserver:]volume. This format may change in the future. The destination endpoint can be specified using the location format above, or by specifying the parameters for the name of the destination Vserver and the name of the destination volume. Attributes: key, non-creatable, non-modifiable
- destination-volume => string, optional
Specifies the name of destination volume for the SnapMirror relationshp. The name of the destination Vserver must also be specified if using this parameter. Attributes: key, non-creatable, non-modifiable
- destination-vserver => string, optional
Specifies the name of the destination Vserver for the relationship. The name of the destination volume must also be specified if using this parameter. Attributes: key, non-creatable, non-modifiable
- is-constituent => boolean, optional
Specifies whether or not the SnapMirror relationship is between Infinite Volume constituent volumes. Attributes: non-creatable, non-modifiable
- relationship-id => string, optional
Specifies the SnapMirror relationship ID. Attributes: key, non-creatable, non-modifiable
- relationship-status => string, optional
Specifies the SnapMirror relationship status. This parameter is present only if at least one transfer has been performed since the node hosting the source volume joined the quorum. Possible values are: Attributes: non-creatable, non-modifiable
- relationship-type => string, optional
Specifies the SnapMirror relationship type. Attributes: non-creatable, non-modifiable Possible values: - "data_protection" ,
- "load_sharing" ,
- "vault" ,
- "restore" ,
- "transition_data_protection"
- source-location => string, optional
Specifies the source endpoint of the SnapMirror relationship in the format [vserver:]volume. This format may change in the future. The source endpoint can be specified using the location format above, or by specifying the parameters for the name of the source Vserver and the name of the source volume. Attributes: key, non-creatable, non-modifiable
- source-volume => string, optional
Specifies the name of the source volume of the SnapMirror relationship. The name of the source Vserver must also be specified if using this parameter. Attributes: key, non-creatable, non-modifiable
- source-vserver => string, optional
Specifies the name of the source Vserver for the SnapMirror relationship. The name of the source volume must also be specified if using this parameter. Attributes: key, non-creatable, non-modifiable
Information about the operation that was attempted/performed against snapmirror object.Fields
- error-code => integer, optional
Error code, if the operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
- snapmirror-key => snapmirror-info
The keys for the snapmirror object to which the operation applies.
Information about the SnapMirror Relationship. 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
- current-max-transfer-rate => integer, optional
The upper bound in kilobytes per second, at which data is transferred between clusters for the current transfer. This value can be the same as the 'max-transfer-rate' or different if overwritten when starting the transfer via the associated commands or APIs (snapmirror-initialize, snapmirror-update, snapmirror-resync, snapmirror-restore). This parameter is only valid when a transfer is in progress. This paramter is available only on Data ONTAP 8.2 or later if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
- current-transfer-error => string, optional
A message describing the last retryable error encountered by the current transfer. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
- current-transfer-priority => string, optional
Priority assigned to the ongoing transfer. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2', and if a transfer is in progress. Attributes: non-creatable, non-modifiable Possible values:
- current-transfer-type => string, optional
The type of transfer taking place. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable Possible values: - "initialize" ,
- "update" ,
- "resync" ,
- "restore" ,
- "check"
- destination-cluster => string, optional
Specifies the destination cluster name for the SnapMirror relationship. The parameters for the name of the destination Vserver, and the name of the destination volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
Attributes: key, optional-for-create, non-modifiable
- destination-location => string, optional
Specifies the destination endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The destination endpoint can be specified using the location formats above, or by specifying the parameters for the name of the destination Vserver, the name of the destination volume, and the name of the destination cluster. The name of the destination cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode. Attributes: key, optional-for-create, non-modifiable
- destination-volume => string, optional
Specifies the name of the destination volume for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the destination Vserver.
- The name of the destination cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
Attributes: key, optional-for-create, non-modifiable
- destination-volume-node => string, optional
Node which owns the destination volume of the relationship. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
- destination-vserver => string, optional
Specifies the name of the destination Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of destination volume.
- The name of the destination cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
Attributes: key, optional-for-create, non-modifiable
- is-constituent => boolean, optional
Specifies whether or not the SnapMirror relationship is between Infinite Volume constituent volumes. Attributes: non-creatable, non-modifiable
- is-healthy => boolean, optional
False if the last manual or scheduled update failed or was aborted, or if the last scheduled update was delayed. Otherwise true. Attributes: non-creatable, non-modifiable
- lag-time => integer, optional
The amount of time in seconds by which the data on the mirror lags behind the source. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
- last-transfer-duration => integer, optional
The amount of time in seconds it took for the last transfer to complete. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2', and if the last transfer was successful. Attributes: non-creatable, non-modifiable
- last-transfer-end-timestamp => integer, optional
The Timestamp of the end of the last transfer. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
- last-transfer-error => string, optional
A message describing the cause of the last transfer failure. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode, if the relationship control plane is 'v2', and if the last transfer was unsuccessful. Attributes: non-creatable, non-modifiable
- last-transfer-error-codes => integer[], optional
List of codes providing additional information on the cause and context of the last transfer failure. These are Data ONTAP internal codes, not API errnos. This parameter is reserved for use only by vendor provided management tools, and is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2', and if the last transfer was unsuccessful. Attributes: non-creatable, non-modifiable
- last-transfer-from => string, optional
The source endpoint of the last transfer. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
- last-transfer-size => integer, optional
The total number of bytes transferred as part of the last transfer. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2', and if the last transfer was successful. Attributes: non-creatable, non-modifiable
- last-transfer-type => string, optional
The type of the previous transfer for the relationship. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable Possible values: - "initialize" ,
- "update" ,
- "resync" ,
- "restore" ,
- "check"
- max-transfer-rate => integer, optional
Specifies the upper bound, in kilobytes per second, at which data is transferred between clusters. The default is unlimited (0) which permits the SnapMirror relationship to fully utilize the available network bandwidth. The max-transfer-rate option does not affect load-sharing mirrors and other SnapMirror relationships confined to a single cluster. Attributes: optional-for-create, modifiable
- mirror-state => string, optional
Specifies the mirror state of the SnapMirror relationship. Possible values are: - 'uninitialized' - Destination volume has not been initialized,
- 'snapmirrored' - Destination volume has been initialized and is ready to receive SnapMirror updates,
- 'broken-off' - Destination volume is RW and snapshots are present.
Attributes: non-creatable, non-modifiable
- policy => string, optional
Specifies the name of the snapmirror policy for the relationship. For SnapMirror relationships of type 'vault', the policy will also have rules to select snapshot copies that must be transferred. If no policy is specified, a default policy will be applied depending on the type of the SnapMirror relationship. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: optional-for-create, modifiable
- progress-last-updated => integer, optional
A timestamp indicating when the progress of the transfer was last updated. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2', and if a transfer is in progress. Attributes: non-creatable, non-modifiable
- relationship-control-plane => string, optional
The type of the control plane used for the relationship. Possible values are: - 'v1' - Data ONTAP 8.1 compatible control plane. The endpoint location format [<cluster>:][//<vserver>/]<volume> must be used. Long operations such as initialize, update and resync will spawn a job, and return a job id. The job API must be used to track the progress of the operations.
- 'v2' - Data ONTAP 8.2 and later compatible control plane. The endpoint location format [<vserver>:]<volume> should be used. Long operations such as initialize, update, and resync do not spawn a job and do not return a job id. The snapmirror-get API must be used to track the progress of these operations.
This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode.' Attributes: non-creatable, non-modifiable
- relationship-id => string, optional
A unique identifier assigned to the SnapMirror relationship when it is created. This parameter is only available on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
- relationship-progress => integer, optional
The total number of bytes that have been processed so far for the current activity of the relationship as returned in the relationship-status. This is set only when the relationship-status indicates that an activity is in progress. Attributes: non-creatable, non-modifiable
- relationship-status => string, optional
Specifies the status of the SnapMirror relationship. Possible values are: - 'idle' - Transfers are enabled, and no transfer is in progress,
- 'transferring' - SnapMirror transfers are enabled and a transfer is in progress,
- 'checking'- The destination volume is undergoing a diagnostic check and no transfer is in progress. Only applicable for SnapMirror relationships with the relationship-control-plane field set to 'v1',
- 'quiescing' - A SnapMirror transfer is in progress, additional transfers are disabled,
- 'quiesced' - SnapMirror transfers are disabled, no transfer is in progress,
- 'queued' - SnapMirror transfers are enabled, and a transfer operation has been accepted and queued in the system,
- 'preparing' - SnapMirror transfers are enabled, currently in the pre-transfer phase for Vault incremental transfers,
- 'finalizing' - SnapMirror transfers are enabled, currently in the post-transfer phase for vault incremental transfers,
- 'aborting' - SnapMirror transfers are enabled, however a transfer abort operation that may include removal of the checkpoint is underway.
Attributes: non-creatable, non-modifiable
- relationship-type => string, optional
Specifies the type of the SnapMirror relationship. Attributes: optional-for-create, non-modifiable Possible values: - "data_protection" ,
- "load_sharing" ,
- "vault" ,
- "restore" ,
- "transition_data_protection"
- schedule => string, optional
Specifies the name of the cron schedule, which is used to update the SnapMirror relationship. Attributes: optional-for-create, modifiable
- snapshot-progress => integer, optional
The number of bytes transferred for the transfer snapshot. This is set only when the relationship-status indicates that an activity is in progress. Attributes: non-creatable, non-modifiable
- source-cluster => string, optional
Specifies the name of the source cluster for the SnapMirror relationship. The parameters for the name of the source Vserver, and the name of the source volume must also be specified if using this parameter. This parameter is available only on: - Data ONTAP 8.1 operating in Cluster-Mode.
- Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
Attributes: key, optional-for-create, non-modifiable
- source-location => string, optional
Specifies the source endpoint of the SnapMirror relationship in one of 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 Vserver peering setup between the source and destination Vservers.
This format may change in the future. The source endpoint can be specified using the location formats above, or by specifying the parameters for the name of the source Vserver, the name of the source volume, and the name of the source cluster. The name of the source cluster is only required on Data ONTAP 8.1 operating in Cluster-Mode. Attributes: key, optional-for-create, non-modifiable
- source-volume => string, optional
Specifies the name of the source volume of the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of the source Vserver.
- The name of the source cluster on Data ONTAP 8.1 operating in Cluster-Mode, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
Attributes: key, optional-for-create, non-modifiable
- source-vserver => string, optional
Specifies the name of the source Vserver for the SnapMirror relationship. If using this parameter, the following parameters should also be specified: - The name of source volume.
- The name of the source cluster on Data ONTAP 8.1, or on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v1'.
Attributes: key, optional-for-create, non-modifiable
- transfer-snapshot => string, optional
The name of the current snapshot copy being transferred. This is set only when the relationship-status indicates that an activity is in progress. Attributes: non-creatable, non-modifiable
- tries => string, optional
Specifies the maximum number of times to attempt each manual or scheduled transfer for a SnapMirror relationship. The default is eight times. Note: You can set the tries option to zero (0) to disable manual and scheduled updates for the SnapMirror relationship. This parameter is only relevant on Data ONTAP 8.1 operating in Cluster-Mode. On Data ONTAP 8.2 operating in Cluster-Mode, the maximum number of times to attempt a transfer is an attribute of the SnapMirror policy. Therefore the value of this parameter is ignored. Attributes: optional-for-create, modifiable
- unhealthy-reason => string, optional
The reason the relationship is not healthy. This parameter is available only on Data ONTAP 8.2 or later operating in Cluster-Mode if the relationship control plane is 'v2'. Attributes: non-creatable, non-modifiable
- vserver => string, optional
If this optional parameter is specified, designates the managing Vserver. The managing Vserver is authorized to use snapmirror commands to manage the SnapMirror relationship. The vserver option is currently a reserved option and should not be used for queries. The destination-vserver parameter should be used to select the Vserver in a cluster context. Attributes: optional-for-create, modifiable
Information about the operation that was attempted/performed against snapmirror object.Fields
- error-code => integer, optional
Error code, if the operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
- jobid => integer, optional
Job Id, if this operation was performed via a job.
- snapmirror-key => snapmirror-info
The keys for the snapmirror object to which the operation applies.
- status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
Information about the operation that was attempted/performed against snapmirror object.Fields
- error-code => integer, optional
Error code, if the operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
- snapmirror-key => snapmirror-info
The keys for the snapmirror object to which the operation applies.
Information about the operation that was attempted/performed against snapmirror object.Fields
- error-code => integer, optional
Error code, if the operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
- snapmirror-key => snapmirror-info
The keys for the snapmirror object to which the operation applies.
Information about the operation that was attempted/performed against snapmirror object.Fields
- error-code => integer, optional
Error code, if the operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
- snapmirror-key => snapmirror-info
The keys for the snapmirror object to which the operation applies.
Information about the operation that was attempted/performed against snapmirror object.Fields
- error-code => integer, optional
Error code, if the operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
Information about the operation that was attempted/performed against snapmirror object.Fields
- error-code => integer, optional
Error code, if the operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
- snapmirror-key => snapmirror-info
The keys for the snapmirror object to which the operation applies.
Information about the operation that was attempted/performed against snapmirror object.Fields
- error-code => integer, optional
Error code, if the operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
- jobid => integer, optional
Job Id, if this operation was performed via a job.
- snapmirror-key => snapmirror-info
The keys for the snapmirror object to which the operation applies.
- status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
Information about the operation that was attempted/performed against snapmirror object.Fields
- error-code => integer, optional
Error code, if the operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
- jobid => integer, optional
Job Id, if this operation was performed via a job.
- snapmirror-key => snapmirror-info
The keys for the snapmirror object to which the operation applies.
- status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
Snapshot IdFields
Snapshot Copy Owner NameFields
always|never|default Possible values: - "always" ,
- "never" ,
- "default"
Fields
Information about SnapMirror Policy 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
- comment => string, optional
A human readable description associated with the SnapMirror policy. Attributes: optional-for-create, modifiable
- ignore-atime => boolean, optional
Specifies whether incremental transfers will ignore files which have only their access time changed. Applies to SnapMirror vault relationships only. Attributes: optional-for-create, modifiable
- owner => policy-owner, optional
The owner of the SnapMirror policy. Attributes: non-creatable, non-modifiable Possible values: - "cluster_admin" ,
- "vserver_admin"
- restart => sm-restart-enum, optional
Defines the behavior of SnapMirror if an interrupted transfer exists. Applies to SnapMirror data protection relationship only. Attributes: optional-for-create, modifiable Possible values: - "always" ,
- "never" ,
- "default"
- transfer-priority => sm-transfer-priority-enum, optional
Specifies the priority at which a SnapMirror transfer runs. 'normal' : By default every transfer in the system has this priority. These transfers are scheduled before most 'low' priority transfers. 'low': These transfers have least priority and usually are scheduled after most 'normal' priority transfers. Attributes: optional-for-create, modifiable Possible values:
- tries => string, optional
Specifies the maximum number of times to attempt each manual or scheduled transfer for a SnapMirror relationship. Valid input is a positive integer or 'unlimited'. The default is '8'. Attributes: optional-for-create, modifiable
- vserver-name => vserver-name, optional
Specifies the vserver for the SnapMirror policy. Attributes: key, non-creatable, non-modifiable
Information about rules in the policy.Fields
- keep => string, optional
Specifies the maximum number of Snapshot copies that are retained on the SnapMirror vault destination volume for a rule. The total number of Snapshot copies retained for all the rules in a policy cannot exceed 251. Attributes: non-creatable, non-modifiable
- preserve => boolean, optional
Specifies the behavior when the Snapshot copy retention count is reached on the SnapMirror vault destination for the rule. The default value is 'false', which means that the oldest Snapshot copy will be rotated out to make room for new ones only if the number of Snapshot copies has exceeded the retention count specified in the keep parameter. When set to 'true', an incremental SnapMirror vault update will fail when the Snapshot copies have reached the retention count. Attributes: non-creatable, non-modifiable
- snapmirror-label => string, optional
Specifies the Snapshot copy label. It is used for the purpose of Snapshot copy selection as well as for accounting of Snapshot copies at the SnapMirror vault destination. Only Snapshot copies that have a SnapMirror label that matches this parameter will be transferred to the SnapMirror vault destination. The label can be 31 or fewer characters in length. Attributes: non-creatable, non-modifiable
- warn => integer, optional
Specifies the warning threshold count for the rule. The default value is 0. When set to a value greater than zero, an event is generated after the remaining number of Snapshot copies (for the particular rule) retained on a SnapMirror vault destination reaches the specified warn limit. The preserve parameter for the rule must be 'true' to set the warn parameter to a value greater than zero. Attributes: non-creatable, non-modifiable
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.
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.
- volume => string, optional
Volume name.
- vserver => string, optional
Name of the vserver to which this volume belongs. This field is returned only when request is sent to Admin Vserver LIF.
Information about the modify operation that was attempted/performed against snapshot object.Fields
- error-code => integer, optional
Error code, if the modify operation caused an error.
- error-message => string, optional
Error description, if the modify operation caused an error.
Information of the error details for snapshot multirename operation 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
Name of a snapshot.Fields
owner of a busy snapshotFields
Snapshot PolicyFields
A typedef containing information about the Snapshot Scheduling Policies. 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
- comment => string, optional
A human readable description associated with the snasphot policy. The maximum length of this field can be 255 characters. Attributes: optional-for-create, modifiable
- enabled => boolean, optional
The state of the snapshot policy. If true, the snapshot policy is enabled and scheduled snapshots will be created on the volume associated with this policy. Attributes: required-for-create, modifiable
- policy-owner => string, optional
Owner of the policy Attributes: non-creatable, non-modifiable
- vserver-name => vserver-name, optional
Vserver Name Attributes: key, non-creatable, non-modifiable
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.
- vserver => string, optional
Name of the vserver to which this volume belongs. This field is returned only when request is sent to Admin Vserver LIF.
Information about individual snapshot schedulesFields
- count => integer, optional
Maximum number of snapshots to retain for the schedule present in the snapshot policy. Attributes: non-creatable, non-modifiable
- prefix => string, optional
Snapshot name prefix for the schedule present in the snapshot policy. Prefix will be used in the snapshot name instead of the schedule name. If prefix is not provided, schedule name will be used in the snapshot name. For eg, if the prefix name 'hourly-even' is assigned to the schedule name 'hourly' then the snapshot name will look like 'hourly-even.2010-05-10_0205'. If no prefix is associated with the schedule 'hourly' then prefix will be set to 'hourly' as the default value. Attributes: non-creatable, non-modifiable
- schedule => string, optional
A human readable string describing the name of a schedule present in the snapshot policy. Maximum length of this field can be 255 characters. The schedule name can be any one of the reserved schedules like 'hourly', 'weekly','daily' or it can be a user created schedule. Attributes: non-creatable, non-modifiable
- snapmirror-label => string, optional
Snapshot SnapMirror Label for the schedule present in the snapshot policy. The value specified will be added as an attribute to the snapshot created by the schedule. The maximum length of this field is 31 characters Attributes: non-creatable, non-modifiable
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.
- vserver => string, optional
Virtual server containing the volume.
The status of the snapshot creation for a given volume.Fields
- name => volume-name
Name of a volume.
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.
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.
display base address informationFields
- bar-type => string
Type of base address information. Possible values are: "I/O", and "memory mapped I/O".
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".
- node-name => string, optional
This field is only valid when the request is sent to the Admin Vserver LIF, in which case it is the storage system name.
Detailed information for fc adapter.Fields
- is-enabled => boolean
Is the adapter enabled? true or false.
- preload-table-rev => string, optional
Preload table revision of adapter.
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
- node-name => string, optional
This field is only valid when the request is sent to the Admin Vserver LIF, in which case it is the storage system name.
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?
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.
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".
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 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.
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".
Adapter PHY and list of connected expander PHYs.Fields
QSPF Cable information.Fields
- 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-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: "copper", "optical".
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).
Contains error messages associated with array.Fields
- 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 => string
Enum describing type of error. ARRAY_INCONSISTENT_LUN_ADDRESSING_METHOD - 1. Array is using inconsistent LUN addressing schemes.
Maps array definition to target portFields
- array-name => string
Name of the array in the array record. (28 char max)
- connection-type => string, optional
Describes the type of connection between the controller and the back end storage. Possible values are:
- "direct" - Direct Attached
- "fabric" - Fabric Attached
- max-queue-depth => integer, optional
The target port queue depth for this target port. Range: [0..2048]
- switch-port => string, optional
For fabric attached connections, the switch port the array target port is connected to. N/A for direct attached.
- 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).
Contains statistics about an array port.Fields
- initiator-port => string
Initiator port name, e.g. 0a.
- node => string
Node name of array's target port.
- target-iops => integer
Rolling average of I/O operations per second read and written to this target port. Range: [0..2^64-1]
data describing characteristics/parameters of/about a storage arrayFields
- affinity => string
Describes the affinity model supported by the array. Possible values are:
- "none" - None
- "aaa" - Active/Active Asymmettric
- "ap" - Active/Passive
- "mixed" - This array is presenting different affinity models to different controllers within the cluster.
- 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)
- optimization-policy => string
Describes the I/O optimization policy used by this array. Possible values are:
- "ialua" - The array supports iALUA.
- "ealua" - The array supports eALUA.
- "symmetric" - All ports on the array will be treated equally.
- "proprietary" - A vendor specific optimization is supported for this array.
- "mixed" - This array supports multiple optimization policies, one per node.
- "unknown" - No known optimization method is supported for this array (will be treated as if Symmetric)
- 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)
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
- aggregate-name => string, optional
Name of aggregate or traditional volume with which this disk is associated. Omitted if excluded by 'desired-attributes'.
- 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-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-reconstructing => boolean, optional
True if disk is in process of being reconstructed. 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-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.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'.
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 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'.
- dr-home-node-id => integer, optional
ID (NVRAM ID) of home owner of a disk in switchover state when there is a disaster. Before disaster switchover, the value of this field is zero. At the time of switchover, it would be changed so as to keep track of whom to give the disks to, at the time of switchback. Omitted if disk has no dr home id.
- dr-home-node-name => string, optional
This is the name of home owner of a disk in switchover state when there is a disaster. Before disaster switchover, the value of this field is a NULL string. At the time of switchover, it would be changed so as to keep track of whom to give the disks to, at the time of switchback. Omitted if disk has no dr home owner.
- 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'.
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-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'.
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'.
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'.
Disk record.Fields
- disk-name => string, optional
Name of the disk, e.g. 0a.25. Omitted if 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'.
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. QNG - (Quiescing) : The disk is becoming quiesced on this path. 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.
- 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-link-errors => integer
Number of link errors reported on the path. Range: [0..2^32-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-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 LUNs 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]
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-text => string
A description of the error being reported.
- 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.
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.
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]
name of the APIFields
Contains information about a specific node 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
- cpu-busytime => integer, optional
The time (in hundredths of a second) that the CPU has been doing useful work since the last boot. Attributes: non-creatable, non-modifiable
- env-over-temperature => boolean, optional
An indication of whether the hardware is currently operating outside of its recommended temperature range. The hardware will shutdown if the temperature exceeds critical thresholds. Attributes: non-creatable, non-modifiable
- is-epsilon-node => boolean, optional
You can designate a node as epsilon to add weight to its voting in a cluster with an even number of nodes. In a cluster, only one node can be designated as epsilon at any given time. A boolean value of true means the node is epsilon. Attributes: non-creatable, modifiable
- is-node-healthy => boolean, optional
This parameter is used to determine health of a node in a cluster. A boolean value of true means the node is healthy. Attributes: non-creatable, non-modifiable
- maximum-number-of-volumes => integer, optional
The 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. Attributes: non-creatable, non-modifiable
- node => string, optional
The textual name of a node. Attributes: key, non-creatable, non-modifiable
- node-system-id => string, optional
The system Id of the node. This is defined by the vendor. Generally, it is a string of numbers. Attributes: non-creatable, non-modifiable
- node-uuid => string, optional
The univerally unique identifier for the node. It is a 36-character string composed of 32 hexadecimal characters. For example, '542366ea-a024-11dd-9caa-7302e474c5ae'. Attributes: non-creatable, non-modifiable
- nvram-battery-status => nvram-battery-status-enum, optional
Status of the NVRAM battery. The possible values that could be returned: - 'battery_ok'
- 'battery_partially_discharged'
- 'battery_fully_discharged '
- 'battery_not_present'
- 'battery_near_end_of_life'
- 'battery_at_end_of_life'
- 'battery_unknown'
- 'battery_over_charged'
- 'battery_fully_charged'
Attributes: non-creatable, non-modifiable Possible values: - "battery_ok" ,
- "battery_partially_discharged" ,
- "battery_fully_discharged" ,
- "battery_not_present" ,
- "battery_near_end_of_life" ,
- "battery_at_end_of_life" ,
- "battery_unknown" ,
- "battery_over_charged" ,
- "battery_fully_charged"
The node names along with the ONTAPI version on the respective node.Fields
- major-version => integer
Current ONTAPI major version supported by this node. Range: [0..2^31-1].
- minor-version => integer
Current ONTAPI minor version supported by this node. Range: [0..2^31-1].
- node-name => string
Name of the node.
The node names along with the ONTAP version on the respective node.Fields
- build-timestamp => integer, optional
Time of build creation, in seconds since January 1, 1970, of the image running on the node. This field is available in Data ONTAP 8.1 or later.
- node-name => string
Name of the node.
- node-uuid => string
UUID, Universal Unique IDentifier, of the node.
- version => string
Data ONTAP version running on the node.
ok|partially discharged|fully discharged|not present|near eol|eol|unknown|over charged|fully charged Possible values: - "battery_ok" ,
- "battery_partially_discharged" ,
- "battery_fully_discharged" ,
- "battery_not_present" ,
- "battery_near_end_of_life" ,
- "battery_at_end_of_life" ,
- "battery_unknown" ,
- "battery_over_charged" ,
- "battery_fully_charged"
Fields
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
list of api names and their elementsFields
api informationFields
- name => string
name of api
list of type names and their elementsFields
These attributes describe or modify the configuration of the nodes's boot images. 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
- is-current => boolean, optional
Is Current Image Attributes: non-creatable, non-modifiable
- is-default => boolean, optional
Is Default Image Attributes: non-creatable, modifiable
- node => string, optional
Node Attributes: key, non-creatable, non-modifiable
- version => string, optional
Software Version Attributes: non-creatable, non-modifiable
These attributes provide details about the software packages available on the system. 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
- node => string, optional
Node Attributes: key, non-creatable, non-modifiable
- package => string, optional
Package File Name Attributes: key, optional-for-create, non-modifiable
Information about the system. Here system refers to a cluster node when running in cluster mode.Fields
- cpu-firmware-release => string, optional
Firmware release number. Defined by the CPU manufacturer.
- 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.
Contains the Data ONTAP version tuple corresponding to the lowest version across the cluster.Fields
- generation => integer
First integer of the Data ONTAP version tuple corresponding the lowest version across the cluster.
- major => integer
Second integer of the Data ONTAP version tuple corresponding the lowest version across the cluster.
- minor => integer
Third integer of the Data ONTAP version tuple corresponding the lowest version across the cluster.
Name of the aggregateFields
Cache Policy NameFields
Status information about an active clone split.Fields
- name => string
Name of the clone being split.
Estimate information about a future clone split.Fields
Space configuration info 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
- delayed-free-footprint => integer, optional
This field represents the delayed free blocks footprint in bytes. This system is used to improve delete performance by batching delete requests. Attributes: non-creatable, non-modifiable
- delayed-free-footprint-percent => integer, optional
This field represents the delayed free blocks footprint as a percentage of aggregate size. This system is used to improve delete performance by batching delete requests. Attributes: non-creatable, non-modifiable
- volume => string, optional
Name of the volume for which the space usage is requested. Attributes: key, non-creatable, non-modifiable
- vserver => string, optional
Name of the Vserver that contains the volumes for which the space usage is requested. Attributes: key, non-creatable, non-modifiable
The Junction Path. The fully-qualified pathname in the owning Vserver's namespace at which a volume is mounted. Note that this pathname may itself contain junctions, one for each volume (other than the namespace root volume) that provides storage along the pathname's length. As with all fully-qualified pathnames , this string must begin with '/'. In addition, it must not end with '/'. An Infinite Volume has the additional restriction of allowing only one element.
An example of a valid FlexVol junction path is: '/user/my_volume'. An example of a valid Infinite Volume junction path is: '/repository'.
Only one volume can be mounted at any given junction path.
Fields
Language Code. The following are the possible language codes along with their names:
- '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.
Fields
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.
RAID types allowed on this filer.Fields
- raidtype => string
Name of an allowed RAID type. Possible values: raid0, raid4, raid_dp.
Constituent Roles Possible values: - "namespace" ,
- "data" ,
- "ols" ,
- "ns_mirror"
Fields
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].
Space configuration info 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
- snapshot-reserve-percent => integer, optional
This field represents the snapshot reserve as a percentage of volume size. Attributes: non-creatable, non-modifiable
- snapshot-spill => integer, optional
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. Attributes: non-creatable, non-modifiable
- snapshot-spill-percent => integer, optional
This field represents Snapshot spill as a percentage of volume size. It is computed as Snapshot used minus Snapshot reserve when Snapshot used exceeds Snapshot reserve. Attributes: non-creatable, non-modifiable
- user-data => integer, optional
This field represents user data in bytes. Alternatively, this is the space reserved to overwrite the data in the volume. Attributes: non-creatable, non-modifiable
- volume => string, optional
Name of the volume for which the space usage is requested. Attributes: key, non-creatable, non-modifiable
- vserver => string, optional
Name of the Vserver that contains the volumes for which the space usage is requested. Attributes: key, non-creatable, non-modifiable
The Storage Service IdentifierFields
Storage Services 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
- volume => volume-name, optional
Volume Name Attributes: key, non-creatable, non-modifiable
- vserver => vserver-name, optional
Vserver Name Attributes: key, non-creatable, non-modifiable
The Storage Service NameFields
legacy|normal Possible values: - "legacy" - No Support for Storage Services,
- "normal" - Support For Storage Services
Fields
Information related to 64-bit upgrade.Fields
Information returned when 'upgrade-64bit-mode' in 'aggr-add' is 'check'.Fields
- capacity => integer, optional
Percentage of space that would be used in the volume after it is upgraded to 64-bit. Attributes: non-creatable, non-modifiable
- check-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 check-last-errno is not 0. Attributes: non-creatable, non-modifiable
- grow-space => integer, optional
Amount of space (in bytes) the volume must be grown by before successfully upgrading its current data. Attributes: non-creatable, non-modifiable
- used-space => integer, optional
Amount of space (in bytes) that would be used in the volume after it is upgraded to 64-bit. Attributes: non-creatable, non-modifiable
Information about Antivirus settings for the volume.Fields
- on-access-policy => string, optional
The name of the Antivirus On-Access policy. The default policy name is 'default'. If not specified when creating a volume, the Antivirus On-Access Policy is inherited from the owning vserver. Currently, this policy can only be managed using the 'antivirus' command line interfaces.
Attributes: optional-for-create, modifiable
Attributes of a volume. 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
Information about autosize settings of the volume.Fields
- grow-threshold-percent => integer, optional
Used space threshold which triggers autogrow. When the volume-info.size-used is greater than this percent of volume-info.size-total, the volume will be grown. The computed value is rounded down. The default value of this element 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. Attributes: optional-for-create, modifiable
- increment-percent => integer, optional
Using this value, the increment size will be computed as a percentage of the volume size at the time autosize was enabled. The default value is 5%. The increment-percent element is mutually exclusive with increment-size, and an error will be generated if both are specified. Attributes: optional-for-create, modifiable
- increment-size => integer, optional
The increment size (in bytes) by which the volume would be grown. The default value is 5%. Increment-size and increment-percent are mutually exclusive, and an error will be generated if both are specified. Attributes: optional-for-create, modifiable
- 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'. Attributes: optional-for-create, modifiable
- maximum-size => integer, optional
The maximum size (in bytes) to which the volume would be grown automatically. 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. Attributes: optional-for-create, modifiable
- minimum-size => integer, optional
The minimum size (in bytes) below which the volume would not be shrunk automatically. 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. Attributes: optional-for-create, modifiable
- mode => string, optional
The current mode of operation of volume autosize. Valid modes are 'off', 'grow', and 'grow_shrink'. The default mode is 'off'. Attributes: optional-for-create, modifiable Possible values:
- "off" ,
- "grow" ,
- "grow_shrink"
- reset => boolean, optional
Resets the values of autosize, autosize-increment, max-autosize, min-autosize, autosize-shrink-threshold-percent, autosize-grow-threshold-percent and autosize-mode to their defaults. Attributes: non-creatable, modifiable
- shrink-threshold-percent => integer, optional
The used space threshold below which autoshrink is triggered. When the volume-info.size-used is less than this percent of volume-info.size-total, the volume will be shrunk. The computed value is rounded down. The default shrink theshold is 50%. It is an error for the shrink threshold to be greater than or equal to the grow threshold. Attributes: optional-for-create, modifiable
Information about volume clones.Fields
Volume FlexClone typedef 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
- aggregate => string, optional
FlexClone Aggregate Attributes: non-creatable, non-modifiable
- dsid => integer, optional
FlexClone Data Set ID Attributes: non-creatable, non-modifiable
- junction-active => boolean, optional
Junction Active Attributes: optional-for-create, non-modifiable
- junction-path => string, optional
Junction Path Attributes: optional-for-create, non-modifiable
- msid => integer, optional
FlexClone Master Data Set ID Attributes: non-creatable, non-modifiable
- parent-snapshot => string, optional
FlexClone Parent Snapshot Attributes: optional-for-create, non-modifiable
- qos-policy-group-name => string, optional
QoS Policy Group Name Attributes: optional-for-create, non-modifiable
- size => integer, optional
FlexClone Size Attributes: non-creatable, non-modifiable
- space-reserve => string, optional
Space Guarantee Style Attributes: optional-for-create, non-modifiable Possible values: - "none" ,
- "volume" ,
- "file"
- state => string, optional
FlexClone Volume State Possible values are: - 'online',
- 'offline',
- 'restricted'.
Attributes: non-creatable, non-modifiable
- volume => string, optional
FlexClone Volume Attributes: key, required-for-create, non-modifiable
- volume-type => string, optional
The type of the volume to be created. Possible values:
- 'rw' ... read-write volume,
- 'dp' ... data-protection volume
Default value is 'rw'.
Attributes: optional-for-create, non-modifiable
- vserver => string, optional
Vserver Name Attributes: key, non-creatable, non-modifiable
Information describing the parentage of a clone volume.Fields
- dsid => integer, optional
The clone parent volume's Data Set ID. Attributes: non-creatable, non-modifiable
- msid => integer, optional
The clone's parent volume's Mirror Set ID. Attributes: non-creatable, non-modifiable
- snapshot-id => integer, optional
The clone parent volume's base snapshot identifier. The only legal value for a snapshot identifier is its Data Set ID.
Attributes: non-creatable, non-modifiable
- snapshot-name => string, optional
The clone parent volume's base snapshot name. Attributes: non-creatable, non-modifiable
- uuid => uuid, optional
The clone parent volume's UUID. Attributes: non-creatable, non-modifiable
Information related to directories in the volume.Fields
- i2p-enabled => boolean, optional
If true, native inode-to-parent information is kept for inodes. By default, this field is true. Attributes: non-creatable, non-modifiable
- max-dir-size => integer, optional
The maximum size (in bytes) to which any directory in this volume can grow. The default maximum directory size is set to 1% of the system memory. So if the system memory is 1GB, then the maximum directory size value will be 10MB which allows upto 300,000 files. The number of files that the directory actually can hold varies depending on such things as the length of the names and whether it needs to use double-byte UNICODE characters.
Most users should not need to change this field's default setting. It is useful for environments where system users may grow a directory to a size that starts impacting system performance. When a user tries to create a file in a directory that is at the limit, the system returns a ENOSPC error and fails the create.
Attributes: optional-for-create, modifiable
Information about export settings of the volume.Fields
- policy => string, optional
The name of the Export Policy to be used by NFS/CIFS protocols. The default policy name is 'default'. Attributes: optional-for-create, modifiable
Information about FlexCache volumes.Fields
- cache-policy => cache-policy, optional
The name of the cache policy. The default policy name is 'default'.
This policy applies only to FlexCache volumes and can be created using the 'flexcache-cache-policy-create' API.
Attributes: optional-for-create, modifiable
- fill-policy => cache-policy, optional
The name of the fill policy. The default policy name is 'default'.
This policy applies only to FlexCache volumes and can be created using the 'flexcache-fill-policy-create' API.
Attributes: optional-for-create, modifiable
- min-reserve => size, optional
The amount of space requested to be preallocated in the aggregate hosting the FlexCache volume. Attributes: optional-for-create, modifiable
- origin => volume-name, optional
The name of the origin volume that contains the authoritative data. This field is valid only for a FlexCache volume. The origin volume must belong to the same vserver that owns this volume. Attributes: optional-for-create, non-modifiable
Information about the Flash Pool caching attributes of a volume.Fields
- eligibility => string, optional
Flash Pool caching eligibility of a volume Possible values:
- 'read' ... Indicates that the volume cannot participate in write caching,
- 'read-write' ... Indicates that the volume can participate in read and write caching,
Attributes: non-creatable, non-modifiable
Identification information about a volume.Fields
- comment => string, optional
A description for the volume. Range:[0..1023] Attributes: optional-for-create, modifiable
- dsid => integer, optional
The volume's Data Set ID. Attributes: non-creatable, non-modifiable
- fsid => string, optional
The File System Identifier (FSID) value that serves as one of this volume's internal indicies. This value serves as an internal index for a volume. All volumes on a given controller must have unique FSIDs, except for the two special values described below:
A value of 0 indicates that this volume does not currently have a legal FSID for some unexpected reason. Such volumes are forcibly kept offline until this attribute is assigned a legal value.
A value of 1 indicates that this volume has recently appeared on its current controller due to having its aggregate be copied from a different controller. All volumes in this newly-created aggregate must be assigned legal, controller-unique IDs when they are onlined. That will be handled automatically by WAFL upon mount.
If modifiable, this field may be set only when the volume is restricted. It may be set to any value that is not currently being used by any other volume on the same controller. If a request to set this value to '0' is received, the system will select a new value that is currently unused. Note that setting a volume's FSID sometimes has external effects. In particular, a 7-Mode volume's FSID is part of the NFS file handles constructed for its files.
Attributes: non-creatable, non-modifiable
- instance-uuid => uuid, optional
Universal unique identifier (UUID) for the volume that remains unchanged when the volume is moved to a new location. This differs from the volume's regular UUID which changes after a move. The instance UUID can be used to identify a volume even after it is moved. This field is valid for flexible volumes only. UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s. The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used.
Here is an example of an actual UUID:
49e370d6-5b5a-11d9-9eb5-000100000529
Attributes: non-creatable, non-modifiable
- junction-parent-name => volume-name, optional
The name of the parent volume that contains the junction inode of this volume. The junction parent volume must belong to the same vserver that owns this volume.
Attributes: non-creatable, non-modifiable
- msid => integer, optional
The volume's Mirror Set ID. This field is valid only for a Cluster-Mode volume.
Attributes: non-creatable, non-modifiable
- name => volume-name, optional
The name of the volume. Attributes: key, required-for-create, non-modifiable
- name-ordinal => string, optional
The ordinal assignment used in relation to this volume's name. Ordinals are used to disambiguate volumes that have the same base name on the same controller. A value of zero indicates that the base volume name is unique on a controller. A value greater than zero indicates that the volume's base name is used by two or more volumes on the same controller, and that appending '(n)' to this volume's name uniquely identifies it on that controller. A value of -1 indicates that the name ordinal has not yet been determined.
Attributes: non-creatable, non-modifiable
- provenance-uuid => uuid, optional
Universal unique identifier (UUID) for the volume that is used to identify the source volume in a mirroring relationship. When the mirroring relationship is broken, a volume's Instance UUID and Provenance UUID are made identical. An unmirrored volume's Provenance UUID is the same as its Instance UUID. This field is valid for flexible volumes only. UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s. The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used.
Here is an example of an actual UUID:
49e370d6-5b5a-11d9-9eb5-000100000529
Attributes: non-creatable, non-modifiable
- style => string, optional
The style of the volume. Possible values:
- 'flex' ... FlexVol,
- 'infinitevol' . Infinite Volume
Default value is 'flex'.
Attributes: non-creatable, non-modifiable
- type => string, optional
The type of the volume. Possible values:
- 'rw' ... read-write volume,
- 'ls' ... load-sharing volume,
- 'dp' ... data-protection volume,
- 'dc' ... data-cache volume (FlexCache),
- 'tmp' ... temporary volume (not valid for create)
Default value is 'rw'.
Attributes: optional-for-create, non-modifiable
- uuid => uuid, optional
Universal unique identifier (UUID) for this volume. Attributes: non-creatable, non-modifiable
Information about the state of an Infinite Volume.Fields
- constituent-role => repos-constituent-role, optional
This field specifies the role of a constituent within an Infinite Volume. This field is only supported for Infinite Volume constituents. Possible values:
- 'namespace' ... namespace constituent,
- 'data' ... data constituent,
- 'ns_mirror' ... namespace mirror constituent
Attributes: optional-for-create, non-modifiable Possible values:
- "namespace" ,
- "data" ,
- "ols" ,
- "ns_mirror"
- enable-snapdiff => boolean, optional
Whether to enable Snapdiff. If enabled, the namespace mirrors will be created for Snapdiff use. The default value is false. Attributes: optional-for-create, modifiable
- is-managed-by-service => boolean, optional
Specifies if the volume is managed by GUI services. The deafult value is false. Attributes: optional-for-create, modifiable
- max-data-constituent-size => size, optional
The maximum size of each data constituent in bytes. The default value is determined by checking the maximum FlexVol size setting on all nodes used by the Infinite Volume. The smallest value found is chosen as the default for the max-data-constituent-size for the Infinite Volume. Attributes: optional-for-create, modifiable
- namespace-mirror-aggr-list => aggr-name[], optional
Specifies an array of names of aggregates to be used for Infinite Volume Namespace Mirror constituents. If this input is not specified all the aggregates assigned to the Vserver are used. If the argument 'enable-snapdiff' is being set to 'true', and the Infinite Volume is managed by storage services, a value must be provided. Attributes: optional-for-create, modifiable
- storage-service => string, optional
The name of the initial storage service for the Infinite Volume. This can only be provided if is-managed-by-service is true. Attributes: optional-for-create, modifiable
Information about inodes in the volume.Fields
- block-type => string, optional
The indirect block format of the volume. Possible values:
Attributes: non-creatable, non-modifiable
- files-private-used => integer, optional
Number of system (not user-visible) files (inodes) used. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
- files-total => integer, optional
Total user-visible file (inode) count, i.e., current maximum number of user-visible files (inodes) that this volume can currently hold. Attributes: non-creatable, modifiable
- files-used => integer, optional
Number of user-visible files (inodes) used. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
- inodefile-private-capacity => integer, optional
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. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
- inodefile-public-capacity => integer, optional
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. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
Information about the volume language settings.Fields
- is-convert-ucode-enabled => boolean, optional
This field controls whether all directories in this volume are forcibly converted to UNICODE format when accessed from both NFS and CIFS. The default value for 7-Mode volumes is false, in which case access from CIFS causes conversion of pre-4.0 and 4.0-format directories, and access from NFS causes conversion to 4.0-format directories. The default value for Cluster-Mode volumes is true. Note that this field can be set to false if and only if the volume is a 7-Mode volume, or a Cluster-Mode volume that was transitioned from 7-Mode.
Attributes: non-creatable, modifiable
- is-create-ucode-enabled => boolean, optional
This field controls whether all directories in this volume are forced to use the UNICODE format when they are created, both from NFS and CIFS. The default value is false for 7-Mode volumes, in which case all directories are created in pre-4.0 format and only converted to UNICODE format upon the first CIFS access. The default value is true for Cluster-Mode volumes. Note that this field can be set to false if and only if the volume is a 7-Mode volume.
Attributes: non-creatable, non-modifiable
- language => string, optional
The volume's fully-qualified language mapping, in the form: 'LanguageCode (Full Name).' Example: 'en_US (English (US)).'
Attributes: non-creatable, non-modifiable
- nfs-character-set => string, optional
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'
Attributes: non-creatable, non-modifiable
- oem-character-set => string, optional
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 OEM character set is as follows:
- 'cp437|cp437|Thu Oct 1 15:00:53 PDT 1998'
Attributes: non-creatable, non-modifiable
Information about the volume mirror.Fields
- mirror-transfer-in-progress => boolean, optional
True if a SnapMirror transfer is in progress on this mirrored volume. This mirror's active filesystem can be inconsistent during snapmirror transfer. As a result, snapshot create operation is temporary disabled on this mirror until the current transfer session finishes.
This field is set to true at the start of a SnapMirror transfer session and set to false at the end of that session.
Attributes: non-creatable, non-modifiable
- redirect-snapshot-id => integer, optional
If the volume is a logical mirror destination or is in the process of being made one, this field indicates the logical-id of the snapshot to which clients are to be redirected. If modifiable, when setting this attribute, invalid snapshot id or a non-existent snapshot id specified will be rejected with error ESNAPSHOTDOESNOTEXIST. Failure to set ('stamp') the attribute in the volume will cause error ESTAMPREDIRECTSNAPIDERROR to be returned. This field can be set only for online volumes. This option is valid only in Cluster-Mode. The volume can be set to have no redirection snapshot by using a value of 0. This option can be set only for Cluster-Mode volumes participating in a logical-mirror relationship. Setting this field on a Cluster-Mode volume which is not a logical mirror destination (yet) will not have any impact on client access or the volume's behavior. The client access will be impacted with regard to this value only when the volume is converted to a logical-mirror destination.
When reading this attribute, the value of 0 indicates volume has no redirection snapshot. The field cannot be interpreted authoritatively if the volume is offline or restricted.
Attributes: non-creatable, non-modifiable
Information about the modify operation that was attempted/performed against volume object.Fields
- error-code => integer, optional
Error code, if the modify operation caused an error.
- error-message => string, optional
Error description, if the modify operation caused an error.
- jobid => integer, optional
Job Id, if this operation was performed via a job.
- status => string
The operation status. Possible values: "succeeded", "in_progress", "failed".
Information about the modify operation that was attempted/performed against volume object.Fields
- error-code => integer, optional
Error code, if the modify operation caused an error.
- error-message => string, optional
Error description, if the modify operation caused an error.
- volume-key => volume-attributes
The keys for the volume object to which the modify operation applies.
Status of the move operation 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
- actual-completion-timestamp => integer, optional
The date and time in cluster timezone when the volume move completed (successfully or otherwise). If the volume move operation completed successfully, this is the time when the volume on the destination aggregate has been made master and the original volume on the source aggregate has been deleted or is no longer a master copy. Attributes: non-creatable, non-modifiable
- bytes-remaining => integer, optional
The number of bytes remaining to be sent during volume move. This is an approximate number and lags the current status by a few (3) minutes while the volume move is in operation. The bytes-remaining is applicable only for ongoing volume moves. It is not applicable to completed or failed moves. The data inside the volume is considered to be much much larger than data outside the volume. This value most of the time will track data inside the volume yet to be sent. Note that the bytes-remaining can increase over a period of time depending on the rate of change of volume by protocols or other consumers of the volume. Attributes: non-creatable, non-modifiable
- bytes-sent => integer, optional
The number of bytes sent thus far as part of volume move. This is an approximate number and lags the current status by a few seconds while the volume move is in operation. The bytes-sent is applicable only for ongoing and successful volume moves. The bytes-sent counter is mononotonically increasing in most cases. It is stored in memory. As a result, any reboots or failover of the move operation can lead to resetting of this counter to a lesser value than reported earlier. The data inside the volume is considered to be much much larger than metadata of the volume, mostly stored outside the volume. This value most of the time will track data inside the volume sent at the time of retreiving status. Attributes: non-creatable, non-modifiable
- completion-code => integer, optional
The status code of the move operation. The status code will be 0 while the job is running or is successful. It will be non-zero if it is not successful. The code field will be the same as job show's 'status job' field. This field will be in diag mode of the UI. Attributes: non-creatable, non-modifiable
- completion-status => string, optional
Once a volume move is complete, the final state of the volume move operation. This is available in diag mode only. Attributes: non-creatable, non-modifiable
- cutover-action => string, optional
The action to be taken for cutover or during cutover failure. Can be one of abort_on_failure, defer_on_failure, force or wait. This is the input given during the start of volume move. Attributes: non-creatable, modifiable
- cutover-attempts => integer, optional
The number of attempts to be used by the move operation to cutover to the destination volume. This is the input by the upper layers. If the number of attempts is exhausted, the cutover-action input determines the next course of action for the move operation. Attributes: non-creatable, modifiable
- cutover-hard-deferred-count => integer, optional
Number of times cutover has been hard deferred during the move operation due to non-transient, intervention-necessary conditions. This is a diag only field. Attributes: non-creatable, non-modifiable
- cutover-trigger-timestamp => integer, optional
The time when move operation last accepted a trigger to initiate cutover. This is applicable when the move operation is waiting for a cutover to be triggered because of a hard cutover deferred state or because the cutover-action was wait. Attributes: non-creatable, non-modifiable
- cutover-window => integer, optional
The time window in seconds given as input for the cutover phase of volume move. Attributes: non-creatable, modifiable
- destination-node => string, optional
The name of the node where the destination aggregate is. This will be a diagnostic only field. Attributes: non-creatable, non-modifiable
- details => string, optional
This field contains details about any warnings, errors and state of the move operation. This is a string field. Attributes: non-creatable, non-modifiable
- estimated-completion-time => integer, optional
The approximate date and time in the cluster time zone when the entire volume move operation is expected to complete. The move operation completes when the volume instance on the destination aggregate has become the master copy and the volume instance on the source aggregate has been deleted or is no longer the master copy. The format will be in Ontap's Date format. Note that this time may keep increasing when the move goes into Cutover-Deferrred mode. In those cases where the input for cutover-action is wait, during data copy phase, estimated time of completion will approximate the time to reach cutover point and wait for user intervention. Attributes: non-creatable, non-modifiable
- estimated-remaining-duration => integer, optional
The approximate amount of time in terms of days, hours, minutes and seconds remaining to complete the volume move. Note that this duration will not go down to zero when the move goes into Cutover-Deferrred mode. The duration displayed in the examples is not correct. cutover. Attributes: non-creatable, non-modifiable
- execution-progress => string, optional
The execution progress of the job as reported by the job. This is used for debugging purposes only and is only available in diag mode. Attributes: non-creatable, non-modifiable
- internal-state => string, optional
This is the actual internal state of the move job. This is used for debugging purposes only and is only available in diag mode. Attributes: non-creatable, non-modifiable
- job-id => integer, optional
The ui job id of the move job. This is available in diag mode only. Attributes: non-creatable, non-modifiable
- job-uuid => uuid, optional
The job uuid of the move job. This is available in diag mode only. Attributes: non-creatable, non-modifiable
- managing-node => string, optional
The node in the cluster on which the move operation/job is or was running. This is usually on the node hosting the volume to be moved. Attributes: non-creatable, non-modifiable
- percent-complete => integer, optional
The amount of work to move the volume completed thus far in terms of percentage. Attributes: non-creatable, non-modifiable
- phase => string, optional
The phase of the move operation. The move operation can have the following phases: - Queued - Phase where the move operation is queued for execution by the cluster.
- Initializing - Phase where the move operation is setting up resources and initializing them for moving the volume.
- Replicating - Phase in which move operation is doing data copy from source volume to destination aggregate.
- Cutover - Phase in which the move operation is attempting to switch over volume to the destination aggregate and ensuring client i/o and system operations go to the volume on the destination aggregate. In this phase client i/o and system operations are temporarily suspended while a final data copy is taking place from the current volume to the destination aggregate.
- cutover_hard_deferred - Phase in which the move operation is deferring cutover due to some errors in the system during move. The move operation is waiting for corrective action from the admin or MEI tools to take place. The details field contains the reason for the error.
- cutover_soft_deferred - Phase in which the move operation is deferring cutover due to some transient errors in the system during move. The move operation is replicating in the background and waiting for the transient error which is causing the soft deferral to clear up. If the move operation has not yet started the replication in the background, the 'Detailed Status' field will contain the reason for soft deferral.
- Completed - The move operation has completed successfully and the volume is now on destination aggregate.
- cleaning_up - The move operation aborted and is in the process of cleaning up. This is a transient condition that will eventually lead to Failed phase.
- Failed - The move operation was not successful. The details field and the code indicates the reason for the failure.
- Failed - The move operation did not complete successfully.
- Restarting - The move operation is restarting.
Attributes: non-creatable, non-modifiable
- prior-issues => string, optional
The list of issues or transient errors encountered causing the move operation to retry the data copy phase or the cutover phase. For RR.1, there will be only one transient error reported. For later releases, there can be many transient errors seperated by newlines reported, with the order being earliest at top and latest error at the bottom of the list. This is a diag only field. Attributes: non-creatable, non-modifiable
- source-node => string, optional
The name of the node where the source aggregate is. Attributes: non-creatable, non-modifiable
- state => string, optional
The state of the volume move at the time of issuing the command and the system gathering up the information about the move. The states can have the following values: - Healthy - Volume move is proceeding as planned, with no issues so far
- Done - Volume move has finished successfully.
- Failed - Volume move has failed due to some reason, with the reason being available in the Detailed Status section.
- Warning - Volume move has encountered a transient error condition during its operation, but is continuing on since then. The details and phase section has more context into the cause of the error.
- Alert - Volume move has encountered a serious condition that cannot be rectified by the system alone and needs input from the upper layers (admin or tools) before proceeding. The volume move will go into Cutover-Deferred phase waiting for user intervention in case of errors, with volume move trigger-cutover being the way the move operation can be restarted.
Attributes: non-creatable, non-modifiable
- volume => volume-name, optional
This is the name of the vserver-scoped volume being moved. Attributes: key, non-creatable, non-modifiable
- vserver => vserver-name, optional
This is the name of the vserver in which the volume being moved is part of. Attributes: key, non-creatable, non-modifiable
Compatible target aggregate information 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
Option key and value.Fields
- name => string
Option key.
- value => string
Option value.
Information about performance settings on a volume.Fields
- extent-enabled => string, optional
If turned on, this field 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. The following values are recognized:
- 'on' ... Perform this optimization on this volume. This option may duplicate blocks from snapshots into the active file system, thereby using additional disk space. Read performance from snapshots will not be changed.
- 'space_optimized' ... Perform this optimization on this volume, but do not duplicate blocks from snapshots into the active file system, thereby using space conservatively. Read performance from snapshots may be degraded.
- 'off' ... Don't perform this optimization on this volume.
By default, it is set to 'off'.
Using extents may help workloads that perform many small random writes followed by a large sequential read. However, using extents may increase the number of disk operations performed on the controller, so this field should only be turned on when applicable.
Attributes: non-creatable, modifiable
- is-atime-update-enabled => boolean, optional
If false, prevent the update of inode access times when a file is read. This value is useful for volumes with extremely high read traffic, since it prevents writes to the inode file for the volume from contending with reads from other files.
By default, this value is true.
This field should be used carefully. That is, use this field when you know in advance that the correct access time for inodes will not be needed for files on that volume.
Attributes: non-creatable, modifiable
- max-write-alloc-blocks => integer, optional
The maximum number of blocks used for write allocation. This option is deprecated.
Attributes: optional-for-create, modifiable
- minimal-read-ahead => boolean, optional
If true, the node performs minimal read-ahead for the volume. By default, this field is false, causing the node that contains this volume to perform very aggressive read-ahead.
Attributes: non-creatable, modifiable
- read-realloc => string, optional
Controls whether application reads cause optimization of the layout of parts of a file or LUN after the data has been read from disk and is in the controller's memory. This optimization is only supported for flexible volumes. The following values are recognized:
- 'on' ... Perform this optimization on this volume. This option may duplicate blocks from snapshots into the active file system, thereby using additional disk space. Read performance from snapshots will not be changed.
- 'space_optimized' ... Perform this optimization on this volume, but do not duplicated blocks from snapshots into the active file system, thereby using space conservatively. Read performance from snapshots may be degraded.
- 'off' ... Don't perform this optimization on this volume.
By default, it is set to 'off'.
Using read reallocation may help workloads that perform a mixture of random writes and large sequential reads.
Attributes: non-creatable, modifiable
QoS policy group attached with a volume.Fields
- policy-group-name => string, optional
The QoS policy group associated with this volume. This optionally specifies which QoS policy group to apply to the volume. This policy group defines measurable service level objectives (SLOs) that apply to the storage objects with which the policy group is associated. If you do not assign a policy group to a volume, the system will not monitor and control the traffic to it. This parameter is not supported on Infinite Volumes.
Attributes: optional-for-create, modifiable
All security aspects of a volume.Fields
- style => string, optional
The security style associated with this volume. Possible values:
- 'mixed' ... Mixed-style security,
- 'ntfs' ... NTFS/Windows-style security,
- 'unified' .Unified-style security, Unified UNIX, NFS and CIFS permissions (default for Infinite Volume)
- 'unix' ... Unix-style security (default for Flexible Volume)
This field is only returned if this volume is online. If this field is empty ('') or not present for an online volume, this attribute isn't applicable to the volume. Infinite Volumes can only use the 'unified' security style. All other volumes cannot use the 'unified' security style.
Attributes: optional-for-create, modifiable
The Unix-oriented security settings associated with this volume.Fields
- group-id => integer, optional
The UNIX group ID for the volume. The default value is 0 ('root'). Attributes: optional-for-create, modifiable
- permissions => string, optional
Unix permission bits in octal string format. It's similar to Unix style permission bits:
In Data ONTAP 7-mode, the default setting of '0755' gives read/write/execute permissions to owner and read/execute to group and other users.
In Data ONTAP Cluster-Mode, for security style 'mixed' or 'unix', the default setting of '0755' gives read/write/execute permissions to owner and read/execute permissions to group and other users. For security style 'ntfs', the default setting of '0000' gives no permissions to owner, group and other users.
It consists of 4 octal digits derived by adding up bits 4, 2 and 1. Omitted digits are assumed to be zeros. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. The second digit selects permission for the owner of the file: read (4), write (2) and execute (1); the third selects permissions for other users in the same group; the fourth for other users not in the group.
Attributes: optional-for-create, modifiable
- user-id => integer, optional
The UNIX user ID for the volume. The default value is 0 ('root'). Attributes: optional-for-create, modifiable
Statistics for Deduplication, file clone, compression, etc.Fields
- is-sis-logging-enabled => boolean, optional
If true, it means that sis is enabled on the volume and fingerprints of newly-written data are being logged. If SIS is enabled, this field is true. If SIS is disabled, this field is false.
Attributes: non-creatable, non-modifiable
- is-sis-volume => boolean, optional
If true, it means that the volume contains shared (deduplication, file clones) or compressed data. If SIS is disabled, this field is false. Attributes: non-creatable, non-modifiable
Information about snapshot-related attributes in a volume. Volume disk space-related settings are excluded.Fields
- snapdir-access-enabled => boolean, optional
If true, enable the visible '.snapshot' directory that is normally present at system internal mount points. This value also turns on access to all other '.snapshot' directories in the volume. The default value is true.
Attributes: non-creatable, modifiable
- snapshot-clone-dependency-enabled => boolean, optional
Controls the locking of LUN clones. If true, all initial and intermediate backing snapshots are unlocked for all inactive LUN clones. For active LUN clones, only the backing snapshot will be locked.
If false, the backing snapshot will remain locked until all intermediate backing snapshots are deleted.
Attributes: non-creatable, modifiable
- snapshot-policy => string, optional
The name of the snapshot policy. The default policy name is 'default'.
This policy can be created using the 'snapshot-policy-create' API. It can be managed using the 'snapshot-policy-*' APIs.
Attributes: optional-for-create, modifiable
Snapshot autodelete policy settings.Fields
- commitment => string, optional
Possible values: - 'try',
- 'disrupt', or
- 'destroy'
This option determines the snapshots that 'snapshot autodelete' is allowed to delete to get back space. Setting this option to 'try' only permits the snapshots which are not locked by data protection utilities (dump, mirroring, NDMPcopy) and data-backing functionalities (volume and LUN clones) to be deleted. Setting this option to 'disrupt' permits all snapshots including the snapshots which are locked by data-backing functionalities (volume and LUN clones) to be deleted.
Attributes: non-creatable, modifiable
- defer-delete => string, optional
Possible values: - 'scheduled',
- 'user_created',
- 'prefix', or
- 'none'
This option determines which kind of snapshots to delete. Setting this option value to 'scheduled' will delete the snapshots created by the snapshot scheduler last. Setting this option value to 'user_created' will delete the snapshots not created by the snapshot scheduler last. Setting this option value to 'prefix' will delete the snapshots matching the prefix string to be deleted last. Setting this option value to 'none' will disable the above choices.
Attributes: non-creatable, modifiable
- delete-order => string, optional
Possible values: - 'oldest_first',
- 'newest_first'
This option determines if the oldest or newest snapshot is deleted first.
Attributes: non-creatable, modifiable
- destroy-list => string, optional
Possible values are the combination of: - 'lun_clone',
- 'vol_clone',
- 'cifs_share',
- 'file_clone',
- 'sfsr', or
- 'none'
This options specifies the list of service that can be destroyed if the snapshot is backing that service. This option is valid only when the commitment is set to 'destroy'. The option 'lun_clone,file_clone' should be used for deleting snapshot backing LUN clone and/or File clone. The option 'lun_clone,sfsr' should be used for deleting snapshot backing LUN clone and/or SFSR. It must be noted that 'lun_clone', 'file_clone' and 'sfsr' individually are not valid values. Only pairs of 'lun_clone,file_clone' and 'lun_clone,sfsr' are supported.
Attributes: non-creatable, modifiable
- prefix => string, optional
This option provides the prefix string for the 'prefix' field value of the 'defer-delete' option. If the null prefix is set, the string '(not specified)' is returned Attributes: non-creatable, modifiable
- target-free-space => integer, optional
This option determines when snapshot autodelete should stop deleting snapshot. Depending on the trigger, snapshots are deleted until we reach the target free space percentage. Attributes: non-creatable, modifiable
- trigger => string, optional
Possible values: - 'volume',
- 'snap_reserve', or
- 'space_reserve'
This option determines the condition in which snapshots should be automatically deleted.
If modifiable, setting this option to 'volume' triggers snapshot autodelete to run when the volume is near full. Setting this option to 'snap_reserve' triggers snapshot autodelete to run when the snap reserve of the volume is near full. Setting this option to 'space_reserve' triggers snapshot autodelete to run when the space reserved in the volume is near full.
Attributes: non-creatable, modifiable
Information about volume space management-related settings including on-disk layout.Fields
- filesystem-size => integer, optional
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. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
- is-filesys-size-fixed => boolean, optional
If true, this field causes the file system to remain the same size (and not grow) when a SnapMirror relationship is broken. This option is automatically set to 'true' when a volume becomes SnapMirrored. It remains true after the SnapMirror relationship is broken for the volume. This field allows a volume to be SnapMirrored back to the source without needing to grow the source volume. If the volume size is larger than the file system size, setting this field to false forces the file system to grow to the size of the volume.
Attributes: non-creatable, modifiable
- is-space-guarantee-enabled => boolean, optional
Whether or not the storage guarantee associated with the flexible volume is currently in effect. This field is valid only if this is a flexible volume and it is online. By default, space guarantee is enabled.
Attributes: non-creatable, non-modifiable
- overwrite-reserve => integer, optional
The size (in bytes) that is 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 'overwrite-reserve-required' if the value of 'percentage-fractional-reserve' is set to the default value of 100%, but otherwise may be less than 'overwrite-reserve-required'. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
- overwrite-reserve-required => integer, optional
The reserved size (in bytes) that is 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. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
- overwrite-reserve-used => integer, optional
The reserved size (in bytes) that is not available for new overwrites. The number includes both the reserved size which has actually been used for overwrites as well as the size which was never allocated in the first place. On a volume without free space, the 'never allocated' component can become non-zero when 'overwrite-reserve-required' increases as holes are filled in. Because of this, the 'overwrite-reserve-used' value can exceed the snapshotted size. The 'overwrite-reserve-used' value can also exceed the value of 'overwrite-reserve-required', as the filer maintains a small hidden reserve of last resort. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
- overwrite-reserve-used-actual => integer, optional
The reserved size (in bytes) that has been used. This value is computed as the smaller of: (1) snapshotted size not in the active filesystem, and (2) 'overwrite-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 'overwrite-reserve-required', as the filer maintains a small hidden reserve of last resort. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
- percentage-fractional-reserve => integer, optional
This field can be used to change the amount of space reserved for overwrites of reserved objects (e.g., files, LUNs) in a volume. This field is expressed as a percent. By default, it is set to 100, indicating that 100% of the required reserved space will actually be reserved so the objects are fully protected for overwrites.
Using a value of less than 100 indicates the percentage of the required reserved space should actually be reserved. This returns the extra space to the available space for the volume, decreasing the total amount of space used. However, this does leave the protected objects in the volume vulnerable to out of space errors, since less than 100% of the required reserved space is actually reserved. If reserved space becomes exhausted, this will cause disruptions on the hosts using the objects. If the percentage is decreased below 100%, it is highly recommended that the administrator actively monitor the space usage on the volume and take corrective action if the reserved space nears exhaustion.
Attributes: non-creatable, modifiable
- percentage-snapshot-reserve => integer, optional
The percentage of volume disk space that has been set aside as reserve for snapshot usage. Attributes: optional-for-create, modifiable
- size => integer, optional
Filesystem size (in bytes) of the volume. This is the total usable size of the volume, not including WAFL reserve. This field can not be set on Infinite Volumes that are managed by storage services.
Attributes: optional-for-create, modifiable
- size-available => integer, optional
The size (in bytes) that is still available in the volume. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
- size-total => integer, optional
Total usable size (in bytes) of the volume, not including WAFL reserve or volume snapshot reserve. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
- size-used => integer, optional
The size (in bytes) that is used in the volume. This field is valid only when the volume is online. Attributes: non-creatable, non-modifiable
- space-full-threshold-percent => integer, optional
This field defines the used space threshold percentage at which EMS critical errors regarding the volume fullness will be generated. The default value is 98%. Setting this threshold to 0 disables the volume full space alerts. This field is valid only if this is a flexible volume and it is online.
Attributes: non-creatable, modifiable
- space-guarantee => string, optional
The storage guarantee option that is associated with the flexible volume. Possible options:
- 'none',
- 'volume' (default option),
- 'file'
This field is valid only if the volume is online. For data-cache volumes, this field is not returned.
This field can not be set on Infinite Volumes that are managed by storage services.
Attributes: optional-for-create, modifiable
- space-mgmt-option-try-first => string, optional
This field controls the strategy to try first when this volume is space-challenged. There are two available settings:
- 'volume_grow' ... (default setting) Causes the volume to increase in size before deleting snapshots,
- 'snap_delete' ... Causes snapshots to be deleted before the volume size is increased.
Attributes: non-creatable, modifiable
- space-nearly-full-threshold-percent => integer, optional
This field defines the used space threshold percentage at which EMS warnings regarding the volume fullness will be generated. The default value is 95%. Setting this threshold to 0 disables the volume nearly full space alerts. This field is valid only if this is a flexible volume and it is online.
Attributes: non-creatable, modifiable
Information about the state or status of a volume or its features.Fields
- become-node-root-after-reboot => boolean, optional
Whether this non node-root volume has been marked as the one that will become the node root volume the next time the hosting controller is rebooted. Only one volume at a time may have this marking on any given controller. This field is not directly settable. Instead, a legal request to set the 'is-node-root' attribute (if modifiable) causes this field to be set. Note that marking a volume that is already the node root volume as the new node root has no net effect. By default, this field is false.
Attributes: non-creatable, non-modifiable
- ignore-inconsistent => boolean, optional
If true, then the volume can be brought online when booting even if it is marked as inconsistent. The user is cautioned that bringing it online prior to running wafliron may result in further file system inconsistency. By default, this field is false.
Attributes: non-creatable, non-modifiable
- in-nvfailed-state => boolean, optional
The user can only clear this state and never set it. The file system will set this state on the volume if NVFAIL event occurs. So long as the volume is in this state, all protocol Ops with a special SpinNP flag set are blocked. By clearing this state on the volume, the admin will allow protocol access to the data on the volume and can initiate the recovery process. By default, this field is false.
Attributes: non-creatable, modifiable
- is-cluster-volume => boolean, optional
Indicates whether this volume is a Cluster-Mode volume, namely one that is owned by cluster authorities and agents. These same clustering agents also provide all protocol services for this class of volume. Cluster-Mode volumes are not supported in 7-Mode Data ONTAP deployments. All such volumes are forced offline whenever they are detected in that environment.
Similarly, all 7-Mode volumes on a Data ONTAP Cluster-Mode system (except each controller's root volume) are by default forced offline. There are exceptions, in particular when a 7-Mode volume is being prepared to become that controller's new root volume in a recovery scenario.
At the moment, traditional volumes cannot be Cluster-Mode volumes.
By default, this field is false.
Attributes: non-creatable, non-modifiable
- is-constituent => boolean, optional
This field indicates if this volume is a constituent within another volume. For an Infinite Volume, this field is true for all its constituents (namespace as well as data). This field is set to false for volumes which are not the constituents of an Infinite Volume. The default value is false.
Attributes: non-creatable, non-modifiable
- is-inconsistent => boolean, optional
Whether or not there is known inconsistency in the file system associated with the volume. By default, the value is false. Attributes: non-creatable, non-modifiable
- 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, the value is false. Attributes: non-creatable, non-modifiable
- is-junction-active => boolean, optional
This field indicates whether the mounted volume is accessible. The default is true. If the mounted path is not accessible, the volume does not appear in the owning Vserver's namespace. This field applies only to Cluster-Mode volumes. Attributes: optional-for-create, modifiable
- is-moving => boolean, optional
Is the given volume moving? If true, this volume is moving from one aggregate to another aggregate in the cluster. The aggregates can be on different nodes of the cluster. Attributes: non-creatable, non-modifiable
- is-node-root => boolean, optional
If true, this volume is the root volume of the node in which it resides. Only the node's internal logic can change this option's value from true to false; this happens when some other volume has the value set to true.
By default, this field is false.
Attributes: non-creatable, non-modifiable
- is-nvfail-enabled => boolean, optional
If true, the controller performs additional work at boot and takeover times if it finds that there has been any potential data loss in this volume due to an NVRAM failure. For 7-Mode volumes, it causes the invalidation of all NFS file handles on all volumes affected by the problem so that client-side users are forced to remount the affected file system (and thus not continue to use potentially incorrect data).
It is also possible to specify a set of files per volume that are to be renamed out of the way in these cases. The controller sends error messages to the console whenever such problems are found.
For Cluster-Mode volumes, the volume would be put in a special state called 'in-nvfailed-state' such that protocol access is blocked. This will cause the client applications to crash and thus prevent access to stale data on the volume.
To get out of this situation, the admin needs to manually clear the 'in-nvfailed-state' on the volume.
By default, this value is false.
Attributes: optional-for-create, modifiable
- is-quiesced-in-memory => boolean, optional
Is the given volume quiesced? If true, this volume is in an (in-memory) quiesced state in which most operations on the volume are blocked except for certain internal operations. By default, this value is false. Attributes: non-creatable, non-modifiable
- is-quiesced-on-disk => boolean, optional
Is the given volume quiesced? If true, this volume is in an (on-disk) quiesced state in which most operations on the volume are blocked except for certain internal operations. By default, this value is false. Attributes: non-creatable, non-modifiable
- is-unrecoverable => boolean, optional
Whether or not there is known inconsistency in the associated file system and it is not recoverable. This field is valid only for flexible volumes. By default, this field is false.
Attributes: non-creatable, non-modifiable
- is-volume-in-cutover => boolean, optional
Is the given volume move operation in cutover phase? If true, this volume is moving from one aggregate to another aggregate in the cluster and is in cutover phase. The aggregates can be on different nodes of the cluster. Attributes: non-creatable, non-modifiable
- is-vserver-root => boolean, optional
If true, this volume is the namespace root volume of the Vserver which owns this volume. The default value is false. When creating a volume, if this field is set to true, the new volume is to become the new namespace root volume of the Vserver. This field can be used in a recovery scenario in which the namespace root volume of the Vserver becomes unrecoverable.
Attributes: optional-for-create, non-modifiable
- state => string, optional
Volume State. Possible values:
- 'online',
- 'restricted',
- 'offline',
- 'mixed'
If an Infinite Volumes constituents are not all in the same state, it will return 'mixed'. The 'mixed' state is read-only.
Attributes: optional-for-create, modifiable
Information about the transition attributes of a volume.Fields
- transition-behavior => string, optional
For an in progress transition, indicate what the behavior is. Possible values:
- 'none' ... No transition is in progress,
- 'data-move' ... Transition will follow volume move behavior. For example, Lun serial number is preserved,
- 'data-protection' ... Transition will follow a data protection relationship behavior.
Attributes: non-creatable, non-modifiable
Information about attributes included in an Action record.Fields
Information about a single log record.Fields
- description => string, optional
Detailed description if any associated with this record.
- feature => string, optional
Which feature logged this message. This is valid only for plugin_start, plugin_end and action record types.
- level => string, optional
Describes why this record was logged. Possible values: "all" "error" "warning" "info" "debug" "trace"
- phase => string
Which phase logged this message. Possible values: "all" "check" "lock_config" "prepare" "pre_commit" "commit" "post_commit" "online" "rollback" "cleanup" "unlock_config" "complete"
- record-type => string
Type of record. Possible values: "phase_start" "phase_end" "plugin_start" "plugin_end" "action"
- timestamp => string
Timestamp when record was logged. Timestamp will be in the following format: "MM/DD HH:MM:SS"
Information describing the volume and how to transition it.Fields
- junction-path => string, optional
The path in the vserver into which the volume should be mounted. Note that this is only valid for transitions from 7-mode to Cluster-mode and not untransition. Path should be of the format "/".
- volume-name => string
The name of the volume which is to be transitioned.
Information related to the 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. Attributes: optional-for-create, non-modifiable
- 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. Attributes: optional-for-create, non-modifiable
NIS DomainFields
file|ldap Possible values: Fields
nis|file|ldap Possible values: Fields
running|stopped|starting|stopping Possible values: - "running" ,
- "stopped" ,
- "starting" ,
- "stopping" ,
- "initializing" ,
- "deleting"
Fields
Assigned aggregate name and available size.Fields
- aggr-name => aggr-name, optional
Assigned aggregate name. Attributes: non-creatable, modifiable
Vserver Information 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
- aggr-list => aggr-name[], optional
List of aggregates assigned for volume operations. These aggregates could be shared for use with other Vservers. When specified as part of a vserver-create, this field represents the list of aggregates that are assigned to the Vserver for volume operations. When part of vserver-get-iter call, this will return the list of Vservers which have any of the aggregates specified as part of the aggr-list. Attributes: non-creatable, modifiable
- allowed-protocols => protocol[], optional
Allowed Protocols. If conflicting entries are provided as input to allowed-protocols and disallowed-protocols list, then those entries will become part of the disallowed-protocols list. When specified as part of a vserver-create, this field represent the list of protocols allowed on the Vserver. When part of vserver-get-iter call, this will return the list of Vservers which have any of the protocols specified as part of the allowed-protocols. Attributes: non-creatable, modifiable Possible values: - "nfs" - NFS protocol,
- "cifs" - CIFS protocol,
- "fcp" - FCP protocol,
- "iscsi" - iSCSI protocol,
- "ndmp" - NDMP protocol
- antivirus-on-access-policy => antivirus-policy, optional
Antivirus policy. When specified as part of vserver-create, this field represents the antivirus on access policy for the Vserver. When specified as part vserver-get-iter call, this will return the list of matching Vservers. default: default Attributes: optional-for-create, modifiable
- comment => string, optional
Comment. When specified as part of a vserver-create, this field represents the comment associated with the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers. Attributes: optional-for-create, modifiable
- disallowed-protocols => protocol[], optional
Disallowed Protocols. If conflicting entries are provided as input to allowed-protocols and disallowed-protocols list, then those entries will become part of the disallowed-protocols list. When specified as part of a vserver-create, this field represent the list of protocols not allowed on the Vserver. When part of vserver-get-iter call, this will return the list of Vservers which have any of the protocols specified as part of the disallowed-protocols. Attributes: non-creatable, modifiable Possible values: - "nfs" - NFS protocol,
- "cifs" - CIFS protocol,
- "fcp" - FCP protocol,
- "iscsi" - iSCSI protocol,
- "ndmp" - NDMP protocol
- is-repository-vserver => boolean, optional
Specifies if this Vserver is a Vserver with Infinite Volume. When part of vserver-get-iter call, this will return the list of matching Vservers. Default value is false. Prior to Data ONTAP 8.2.0, Vserver with Infinite Volume is called repository Vserver and once a repository Vserver is created in a cluster, additional Vservers cannot be created. Conversely, a repository Vserver cannot be created if non-repository Vservers already exist in a cluster. Attributes: optional-for-create, non-modifiable
- language => language-code, optional
Language to use for the Vserver. Default: C.UTF-8. 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'. When specified as part of vserver-create, this field represents the language used for the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers with the specified language. The values with the '*' suffixes are not supported by Clustered ONTAP. Attributes: optional-for-create, modifiable
- max-volumes => string, optional
Maximum number of volumes that can be created on the Vserver. When specified as part of a vserver-create, this field represents the maximum number of volumes that can be created on the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers. Attributes: non-creatable, modifiable
- name-mapping-switch => nmswitch[], optional
Name Mapping switch configuration details for the Vserver. When specified as part of the vserver-create, this field represents the list of Name Mapping switch configurations to be used. When specified as part of the vserver-get-iter, this will return the list of Vservers which have any of the specified Name Mapping configurations as part of their nm-switch configuration. Possible values: 'file', 'ldap'. default: file Attributes: optional-for-create, modifiable Possible values:
- name-server-switch => nsswitch[], optional
Name Server switch configuration details for the Vserver. When specified as part of the vserver-create, this field represents the list of Name Server switch configurations to be used. When specified as part of the vserver-get-iter, this will return the list of Vservers which have any of the specified Name Server configurations as part of their ns-switch configuration. Possible values: 'nis', 'file', 'ldap'. Attributes: required-for-create, modifiable Possible values:
- qos-policy-group => string, optional
The QoS policy group associated with this volume. This optionally specifies which QoS policy group to apply to the Vserver. The policy group defines measurable service level objectives (SLOs) that apply to the storage objects with which the policy group is associated. If you do not assign a policy group to a Vserver, the system will not monitor and control traffic to it. This parameter is not supported on a Vserver with Infinite Volume. Attributes: non-creatable, modifiable
- quota-policy => string, optional
Quota policy. When specified as part of vserver-create, this field represents the quota policy for the Vserver. When specified as part vserver-get-iter call, this will return the list of matching Vservers. default: default Attributes: optional-for-create, modifiable
- root-volume => volume-name, optional
Root volume of the Vserver. When specified as part of a vserver-create, this field represents the name of the Vserver root volume. When part of vserver-get-iter call, this will return the list of matching Vservers. Attributes: required-for-create, non-modifiable
- root-volume-aggregate => aggr-name, optional
The aggregate on which the root volume will be created. When specified as part of a vserver-create, this field represents the aggregate on which the Vserver root volume will be created. When part of vserver-get-iter call, this will return the list of matching Vservers. Attributes: required-for-create, non-modifiable
- root-volume-security-style => security-style-enum, optional
Security Style of the root volume. When specified as part of the vserver-create, this field represents the security style for the Vserver root volume. When specified as part of vserver-get-iter call, this will return the list of matching Vservers. Possible values: 'unix', 'ntfs', 'mixed'. The 'unified' security style, which applies only to Infinite Volumes, cannot be applied to a Vserver's root volume. Attributes: required-for-create, non-modifiable Possible values: - "unix" - NFS,
- "ntfs" - CIFS,
- "mixed" - Mixed,
- "unified" - Unified
- snapshot-policy => snapshot-policy, optional
Default snapshot policy setting for all volumes of the Vserver. This policy will be assigned to all volumes created in this Vserver unless the volume create request explicitly provides a snapshot policy or volume is modified later with a specific snapshot policy. A volume-level snapshot policy always overrides the default Vserver-wide snapshot policy. When specified as part vserver-get-iter call, this will return the list of matching Vservers. default: default Attributes: optional-for-create, modifiable
- state => vsadminstate, optional
State of the Vserver. This field represents the data serving ability of a Vserver, hence is applicable only for Data Vservers. Attributes: non-creatable, modifiable Possible values: - "running" ,
- "stopped" ,
- "starting" ,
- "stopping" ,
- "initializing" ,
- "deleting"
- uuid => uuid, optional
Universal unique identifier (UUID) for the Vserver. Attributes: non-creatable, non-modifiable
- vserver-name => string, optional
Name of the Vserver. When specified as part of a vserver-create, this field represents the name of the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers. Attributes: key, non-creatable, non-modifiable
Information about the modify operation that was attempted/performed against vserver object.Fields
- error-code => integer, optional
Error code, if the modify operation caused an error.
- error-message => string, optional
Error description, if the modify operation caused an error.
Application using the Vserver peering relationship Possible values: Fields
Contains information about the Vserver peer relationship(s). 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
- applications => vserver-peer-application[], optional
Applications which can make use of the peering relationship. This value is not shown and cannot be set in desired-attributes when the API is issued on Vserver LIF. Attributes: non-creatable, non-modifiable Possible values:
- peer-cluster => string, optional
Specifies name of the peer Cluster. If peer Cluster is not given, it considers local Cluster. This value is not shown and cannot be set in desired-attributes when the API is issued on Vserver LIF. Attributes: non-creatable, non-modifiable
- peer-state => vserver-peer-state, optional
State of the Vserver peer relationship Attributes: non-creatable, non-modifiable Possible values: - "peered" - Vserver peer relationship is established and the respective applications can use peer relationship,
- "pending" - Vserver peer relationship is initiated in the peer Cluster and local cluster needs to accept the request,
- "initializing" - Communicating to the peer cluster for initializing the peering relationship,
- "initiated" - Relationship initiated in local Cluster,
- "rejected" - Relationship initiated and peer Cluster rejected the same,
- "suspended" - Relationship got suspended, should not initiate any data transfers ,
- "deleted" - Relationship got deleted on peer Cluster
- vserver => string, optional
Specifies name of the local Vserver in the relationship Attributes: key, non-creatable, non-modifiable
peered|pending|initializing|initiated|rejected|suspended|deleted Possible values: - "peered" - Vserver peer relationship is established and the respective applications can use peer relationship,
- "pending" - Vserver peer relationship is initiated in the peer Cluster and local cluster needs to accept the request,
- "initializing" - Communicating to the peer cluster for initializing the peering relationship,
- "initiated" - Relationship initiated in local Cluster,
- "rejected" - Relationship initiated and peer Cluster rejected the same,
- "suspended" - Relationship got suspended, should not initiate any data transfers ,
- "deleted" - Relationship got deleted on peer Cluster
Fields
Information about the deletion operation that was attempted/performed against vserver-peer-transition object.Fields
- error-code => integer, optional
Error code, if the deletion operation caused an error.
- error-message => string, optional
Error description, if the operation caused an error.
Information about the transition peer. 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
- multi-path-address => string, optional
Additional address for source 7-Mode system Attributes: optional-for-create, modifiable
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
Handle representing a specific wafl-sync operation on a volume.Fields
- volume => volume-name, optional
Volume name on which wafl-sync operation being performed.
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).