|
APIs in Category: StorageService |
API version 5.0 |
StorageServiceCreate |
A storage Service is a set of policies, Resource pools and vFiler templates that define a storage Service level, usually corresponding To a service-level objective. A Dataset may be provisioned by specifying a desired storage Service. The Resource pool used To provision the storage and the policies governing the Dataset are determined by the storage Service specified. A storage provider controls the services being delivered To a set of Datasets by controlling the Service definitions and the Service attachments. If the storage provider modifies a storage Service definition, all Datasets with the Service attached will be affected. If the storage provider changes the storage Service attached To a Dataset From one Service To another, only the Dataset is affected. Affected Datasets may go out of conformance, possibly resulting in automated actions. In an environment where the storage provider is responsible for translating enterprise service-level agreements into NetApp-specific Policy configuration or subscribers lack expertise in NetApp technology, storage services should be used for provisioning instead of creating Datasets with explicitly assigned policies and Resource pools. This model is particularly well-suited To integration of orchestration tools and scripts with APIs. |
| StorageServiceCreate (supported) | [top] |
Create a new storage Service.
Input Name Type StorageServiceCreate StorageServiceCreate
Output Name Type StorageServiceCreateResult StorageServiceCreateResult
Error Name Description EACCESSDENIED EAPIERROR EAPILICENSE EDATABASEERROR EINTERNALERROR EINVALIDINPUT EOBJECTAMBIGUOUS EOBJECTNOTFOUND ESERVICEEXISTS
| StorageServiceDatasetListIterEnd (supported) | [top] |
Ends iteration To list of Datasets associated with a storage Service.
Input Name Type StorageServiceDatasetListIterEnd StorageServiceDatasetListIterEnd
Output Name Type StorageServiceDatasetListIterEndResult StorageServiceDatasetListIterEndResult
Error Name Description EINVALIDTAG
| StorageServiceDatasetListIterNext (supported) | [top] |
Get next few Records in the iteration started by storage-service-dataset-list-info-iter-start.
Input Name Type StorageServiceDatasetListIterNext StorageServiceDatasetListIterNext
Output Name Type StorageServiceDatasetListIterNextResult StorageServiceDatasetListIterNextResult
Error Name Description EAPIERROR EINVALIDINPUT EINVALIDTAG
| StorageServiceDatasetListIterStart (supported) | [top] |
Lists the association of Datasets with storage services. If no service/dataset Name or Id is provided then all Datasets with no storage Service are listed.
Input Name Type StorageServiceDatasetListIterStart StorageServiceDatasetListIterStart
Output Name Type StorageServiceDatasetListIterStartResult StorageServiceDatasetListIterStartResult
Error Name Description EACCESSDENIED EAPIAUTHENTICATION EAPIERROR EDATABASEERROR EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| StorageServiceDatasetModify (supported) | [top] |
Attach, detach, or clear a storage Service To a Dataset.
Input Name Type StorageServiceDatasetModify StorageServiceDatasetModify
Output Name Type StorageServiceDatasetModifyResult StorageServiceDatasetModifyResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EDPPOLICYNODENOTFOUND EINTERNALERROR EINVALIDINPUT EOBJECTAMBIGUOUS EOBJECTNOTFOUND EOPERATIONNOTSUPPORTED
| StorageServiceDatasetProvision (supported) | [top] |
Creates a Dataset with the specified storage Service
Input Name Type StorageServiceDatasetProvision StorageServiceDatasetProvision
Output Name Type StorageServiceDatasetProvisionResult StorageServiceDatasetProvisionResult
Error Name Description EACCESSDENIED EAPIERROR EAPILICENSE EDATABASEERROR EDATASETEXISTS EINVALIDINPUT EINVALIDMEMBER EINVALIDTIMEZONE EMEMBERALREADYINGROUP EOBJECTAMBIGUOUS EOBJECTNOTFOUND EPROVISIONFAILED EVFILERINTERFACENOTSET
| StorageServiceDestroy (supported) | [top] |
Destroy a storage Service. In order To Destroy storage Service containing Datasets, Force Option must be supplied.
Input Name Type StorageServiceDestroy StorageServiceDestroy
Output Name Type StorageServiceDestroyResult StorageServiceDestroyResult
Error Name Description EACCESSDENIED EAPIAUTHENTICATION EAPIERROR EDATABASEERROR EOBJECTAMBIGUOUS EOBJECTNOTFOUND ESTORAGESERVICEINUSE
| StorageServiceListInfoIterEnd (supported) | [top] |
Ends iteration To list storage services.
Input Name Type StorageServiceListInfoIterEnd StorageServiceListInfoIterEnd
Output Name Type StorageServiceListInfoIterEndResult StorageServiceListInfoIterEndResult
Error Name Description EINVALIDTAG
| StorageServiceListInfoIterNext (supported) | [top] |
Get next few Records in the iteration started by StorageServiceListInfoIterStart.
Input Name Type StorageServiceListInfoIterNext StorageServiceListInfoIterNext
Output Name Type StorageServiceListInfoIterNextResult StorageServiceListInfoIterNextResult
Error Name Description EAPIERROR EINVALIDINPUT EINVALIDTAG
| StorageServiceListInfoIterStart (supported) | [top] |
Starts iteration To list storage services.
Input Name Type StorageServiceListInfoIterStart StorageServiceListInfoIterStart
Output Name Type StorageServiceListInfoIterStartResult StorageServiceListInfoIterStartResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EOBJECTAMBIGUOUS EOBJECTNOTFOUND
| StorageServiceModify (supported) | [top] |
Modify Attributes for a storage Service
Input Name Type StorageServiceModify StorageServiceModify
Output Name Type StorageServiceModifyResult StorageServiceModifyResult
Error Name Description EACCESSDENIED EAPIERROR EDATABASEERROR EDATASETFAILINGOVER EDATASETMIGRATING EINTERNALERROR EINVALIDINPUT EOBJECTAMBIGUOUS EOBJECTNOTFOUND ESERVICEEXISTS
| Element definition: StorageServiceCreate | [top] |
Create a new storage Service.
Name Type Description GroupNameOrId ObjNameOrId
optional
Resource Group To which the newly created storage Service will be added To. User should have DFM.Service.Write Capability on the specified Group. Default Value: Global Group. ProtectionPolicyNameOrId ObjNameOrId
optional
Name or identifier of the protection Policy To associate with this storage Service. The data protection License is required for this input. StorageServiceContact EmailAddressList
optional
Contact for the storage Service, such as the owner's e-mail Address. StorageServiceDescription xsd:string
optional
Description of the new storage Service, up To 255 characters long. StorageServiceName ObjName
Name of the new storage Service. It cannot be all numeric. The allowed characters are a To z A To Z 0 To 9 ' ' (space) . (Period) _ (underscore) - (hyphen) If any other characters are included, an Error is returned. StorageServiceNodeList ArrayOfStorageServiceNodeAttributes
Attributes of the Policy nodes. StorageServiceOwner xsd:string
optional
Name of the owner of the storage Service, up To 255 characters long.
| Element definition: StorageServiceCreateResult | [top] |
Name Type Description StorageServiceId ObjId
Identifier of the new storage Service
| Element definition: StorageServiceDatasetListIterEnd | [top] |
Ends iteration To list of Datasets associated with a storage Service.
Name Type Description Tag xsd:string
Tag From a previous StorageServiceDatasetListIterStart.
| Element definition: StorageServiceDatasetListIterEndResult | [top] |
[none]
| Element definition: StorageServiceDatasetListIterNext | [top] |
Get next few Records in the iteration started by storage-service-dataset-list-info-iter-start.
Name Type Description Maximum xsd:integer
The Maximum number of entries To retrieve. Tag xsd:string
Tag From a previous StorageServiceDatasetListIterStart.
| Element definition: StorageServiceDatasetListIterNextResult | [top] |
Name Type Description Records xsd:integer
The number of Records actually returned. StorageServiceDatasetsInfo ArrayOfStorageServiceDatasetInfo
Information about a Dataset and its association with a storage Service.
| Element definition: StorageServiceDatasetListIterStart | [top] |
Lists the association of Datasets with storage services. If no service/dataset Name or Id is provided then all Datasets with no storage Service are listed.
Name Type Description ObjectNameOrId ObjNameOrId
optional
Name or identifier of the storage Service, Resource Group or Dataset. If a Resource Group is provided, storage services and Datasets associated with them are returned. If this input is not provided then all Datasets with no storage Service are listed.
| Element definition: StorageServiceDatasetListIterStartResult | [top] |
Name Type Description Records xsd:integer
Number of Records that have been saved for future retrieval with StorageServiceDatasetListIterNext. Tag xsd:string
Tag To be used in subsequent calls To StorageServiceDatasetListIterNext.
| Element definition: StorageServiceDatasetModify | [top] |
Attach, detach, or clear a storage Service To a Dataset.
Name Type Description AssumeConfirmation xsd:boolean
optional
Value determining whether confirmation is given for all resolvable conformance actions that require user confirmation. If the Value is true, all conformance actions which require user confirmation will be executed as if confirmation is already granted. If the Value is false, all conformance actions which require user confirmation will not be executed. One Key, and sometimes undesirable, resolvable Action that requires user confirmation is the possible re-baseline of a relationship. By default, AssumeConfirmation is false. DatasetNameOrId ObjNameOrId
Name or identifier of the Dataset object DryRun xsd:boolean
optional
If true, return the DryRunResults list as well as the ConformanceAlerts list. The DryRunResults list contains actions that would be taken should the changes be committed without actually committing the changes. The ConformanceAlerts list contains high level alerts To notify a user of conditions that will impact any attempt To commit the changes. A conformance alert may warn that if the changes are committed, one or more rebaseline operations may be done. The conformance alerts may also warn of conditions that exist that may prevent the successful conformance of services. By default, DryRun is false. IncludeDryRunReasonDetails xsd:boolean
optional
If true or omitted, then include any possible DryRunReasonDetails along with the associated DryRunResult element. Default Value is true. If false, the DryRunReasonDetails will not be returned. OperationType xsd:string
Possible Values, "attach", "detach", or "clear". "detach" means: For storage Datasets, detach the storage Service, but leave the dp Policy and Resource pools attached To the Dataset. For Datasets containing application resources or having an application Policy, detachment of storage Service is not allowed, since these Datasets can not have dp Policy or Resource pools directly attached. So this will Error out. "clear" means To detach the storage Service, as well as detach the dp Policy and Resource pools. It can have some destructive side effects such as destroying protection relationships. StorageServiceNameOrId ObjNameOrId
optional
Name or identifier of the storage Service object. It is not required for 'detach' or 'clear' Operation StorageServiceNodeList ArrayOfStorageServiceNodeAttributes
optional
Information about dp Policy node mapping. This input is considered only for 'attach' Operation To specify the node mapping. Specify only DpNodeName and OldDpNodeName. All other elements of this input will be ignored, if specified.
| Element definition: StorageServiceDatasetModifyResult | [top] |
Name Type Description ConformanceAlerts ArrayOfConformanceAlert
optional
Alerts that apply To the conformance check. Each alert describes one Type of Condition that a user should be aware of before attempting To conform any more services. Only returned if DryRun is true. DryRunResults ArrayOfDryRunResult
optional
Results of a dry run. Each Result describes one Action the system would take and the predicted effects of that Action. Only returned if DryRun is true.
| Element definition: StorageServiceDatasetProvision | [top] |
Creates a Dataset with the specified storage Service
Name Type Description ApplicationInfo ApplicationInfo
optional
If IsApplicationData is true, then this element will contain information about the application which manages this Dataset. AssumeConfirmation xsd:boolean
optional
Value determining whether confirmation is given for all resolvable conformance actions that require user confirmation. If the Value is true, all conformance actions which require user confirmation will be executed as if confirmation is already granted. If the Value is false, all conformance actions which require user confirmation will not be executed. Default Value is false. DatasetContact EmailAddressList
optional
Contact for the Dataset, such as the owner's e-mail Address. DatasetDescription xsd:string
optional
Description of the new Dataset, up To 255 characters long. DatasetMetadata ArrayOfDfmMetadataField
optional
Opaque metadata for Dataset. Metadata is usually set and interpreted by an application that is using the Dataset. DFM does not look into the contents of the metadata. DatasetName ObjName
Name of the new Dataset. It cannot be all numeric. The allowed characters are a To z A To Z 0 To 9 ' ' (space) . (Period) _ (underscore) - (hyphen) If any other characters are included, an Error is returned. DatasetOwner xsd:string
optional
Name of the owner of the Dataset, up To 255 characters long. DryRun xsd:boolean
optional
If true, return the DryRunResults list as well as the ConformanceAlerts list. The DryRunResults list contains actions that would be taken should the changes be committed without actually committing the changes. The ConformanceAlerts list contains high level alerts To notify a user of conditions that will impact any attempt To commit the changes. A conformance alert may warn that if the changes are committed, one or more rebaseline operations may be done. The conformance alerts may also warn of conditions that exist that may prevent the successful conformance of services. By default, AssumeConfirmation is false. GroupNameOrId ObjNameOrId
optional
Resource Group To which the newly created Dataset should be added To. User should have DFM.Dataset.Write Capability on the specified Group. Default Value: Global Group. IncludeDryRunReasonDetails xsd:boolean
optional
If true or omitted, then include any possible DryRunReasonDetails along with the associated DryRunResult element. Default Value is true. If false, the DryRunReasonDetails will not be returned. IsApplicationData xsd:boolean
optional
If true, the Dataset is an application Dataset managed by an external application. Default Value is false.
IsSuspended xsd:boolean
optional
True if an administrator has chosen To suspend this Dataset for all automated actions (data protection and conformance check of the Dataset). Default is false.
OnlineMigration xsd:boolean
optional
Indicates, that the migration cutover has To be non-disrputive. By default the migration will be assumed To be disruptive. This applies only To the vFiler Unit To be created or attached To the primary node of the Dataset. If provided in input, either DatasetAccessDetails or ServerNameOrId should be provided in StorageSetInfo for the primary node. ProvisionMember WrapperOfProvisionMemberRequestInfo
optional
Information of the provisioning Request for the member RequiresNonDisruptiveRestore RequiresNonDisruptiveRestore
optional
Specifies whether the Dataset should be configured To enable non-disruptive restores From backup destinations. Default Value is false.
StorageServiceNameOrId ObjNameOrId
Name or object identifier of a storage Service object. StorageSetDetails ArrayOfStorageSetInfo
optional
Configuration details for each storage set. VolumeQtreeNamePrefix xsd:string
optional
Prefix for Volume and Qtree names, up To 60 characters long. The allowed characters are a To z A To Z 0 To 9 ' ' (space) . (Period) _ (underscore) - (hyphen) If any other characters are included, an Error is returned.
| Element definition: StorageServiceDatasetProvisionResult | [top] |
Name Type Description ConformanceAlerts ArrayOfConformanceAlert
optional
Alerts that apply To the conformance check. Each alert describes one Type of Condition that a user should be aware of. Only returned if DryRun is true. DatasetId ObjId
Identifier of the newly provisioned Dataset. DryRunResults ArrayOfDryRunResult
optional
Results of a dry run. Each Result describes one Action the system would take and the predicted effects of that Action. Only returned if DryRun is true.
| Element definition: StorageServiceDestroy | [top] |
Destroy a storage Service. In order To Destroy storage Service containing Datasets, Force Option must be supplied.
Name Type Description Force xsd:boolean
optional
If true, allows destroying a storage Service that is attached To Datasets. By default, only storage services that are not associated with any Datasets can be destroyed. This can only Destroy storage services that have storage Datasets attached. If the Datasets attached To the storage services contain application resources or have application Policy assigned, then the Force Option will not work. Because doing so would have destructive implications, the relationships would get destroyed, therefore, users have To manually clear the storage Service From those Datasets before the storage Service can be destroyed. StorageServiceNameOrId ObjNameOrId
Name or identifier of the storage Service To Destroy.
| Element definition: StorageServiceDestroyResult | [top] |
[none]
| Element definition: StorageServiceListInfoIterEnd | [top] |
Ends iteration To list storage services.
Name Type Description Tag xsd:string
Tag From a previous StorageServiceListInfoIterStart.
| Element definition: StorageServiceListInfoIterEndResult | [top] |
[none]
| Element definition: StorageServiceListInfoIterNext | [top] |
Get next few Records in the iteration started by StorageServiceListInfoIterStart.
Name Type Description Maximum xsd:integer
The Maximum number of entries To retrieve. Tag xsd:string
Tag From a previous StorageServiceListInfoIterStart.
| Element definition: StorageServiceListInfoIterNextResult | [top] |
Name Type Description Records xsd:integer
The number of Records actually returned. StorageServices ArrayOfStorageServiceInfo
List of storage services.
| Element definition: StorageServiceListInfoIterStart | [top] |
Starts iteration To list storage services.
Name Type Description IsDrCapable xsd:boolean
optional
If true, return only storage services which contain data protection policies, that are disaster recovery capable. If false, return only storage services which contain data protection policies, that are not disaster recovery capable or which do not contain any data protection Policy. By default, return all storage services. ObjectNameOrId ObjNameOrId
optional
Name or identifier of a storage Service or Resource Group. If a Resource Group is given, only the storage services which are direct Members of the Group are returned.
| Element definition: StorageServiceListInfoIterStartResult | [top] |
Name Type Description Records xsd:integer
Number of Records that have been saved for future retrieval with StorageServiceListInfoIterNext. Tag xsd:string
Tag To be used in subsequent calls To StorageServiceListInfoIterNext.
| Element definition: StorageServiceModify | [top] |
Modify Attributes for a storage Service
Name Type Description AssumeConfirmation xsd:boolean
optional
Value determining whether confirmation is given for all resolvable conformance actions that require user confirmation. If the Value is true, all conformance actions which require user confirmation will be executed as if confirmation is already granted. If the Value is false, all conformance actions which require user confirmation will not be executed. One Key, and sometimes undesirable, resolvable Action that requires user confirmation is the possible re-baseline of a relationship. By default, AssumeConfirmation is false. DryRun xsd:boolean
optional
If true, return the DryRunResults list as well as the ConformanceAlerts list. The DryRunResults list contains actions that would be taken should the changes be committed without actually committing the changes. The ConformanceAlerts list contains high level alerts To notify a user of conditions that will impact any attempt To commit the changes. A conformance alert may warn that if the changes are committed, one or more rebaseline operations may be done. The conformance alerts may also warn of conditions that exist that may prevent the successful conformance of services. By default, DryRun is false. IncludeDryRunReasonDetails xsd:boolean
optional
If true or omitted, then include any possible DryRunReasonDetails along with the associated DryRunResult element. Default Value is true. If false, the DryRunReasonDetails will not be returned. ProtectionPolicyNameOrId ObjNameOrId
optional
Name or identifier of the protection Policy To associate with this storage Service. The data protection License is required for this input. StorageServiceContact EmailAddressList
optional
Contact for the storage Service, such as the owner's e-mail Address. StorageServiceDescription xsd:string
optional
Description of the storage Service, up To 255 characters long. StorageServiceName ObjName
Description of the storage Service, up To 255 characters long. StorageServiceNameOrId ObjNameOrId
Name or object identifier of a storage Service object. StorageServiceNodeList ArrayOfStorageServiceNodeAttributes
optional
Information about dp Policy nodes. StorageServiceOwner xsd:string
optional
Name of the owner of the storage Service, up To 255 characters long.
| Element definition: StorageServiceModifyResult | [top] |
Name Type Description ConformanceAlerts ArrayOfConformanceAlert
optional
Alerts that apply To the conformance check. Each alert describes one Type of Condition that a user should be aware of before attempting To conform any more services. Only returned if DryRun is true. DryRunResults ArrayOfDryRunResult
optional
Results of a dry run. Each Result describes one Action the system would take and the predicted effects of that Action. Only returned if DryRun is true.
| Element definition: ApplicationInfo | [top] |
Information about an application.
Name Type Description ApplicationName xsd:string
Name of an application, up To 255 characters long. For example: "SnapManager for Oracle" ApplicationServerName xsd:string
The Name of the server the application is running on, up To 255 characters long. This is the Name of the Host server, rather than the Name of the client application. ApplicationVersion xsd:string
Version of an application, up To 255 characters long. For example: "2.1" CarryPrimaryBackupRetention xsd:boolean
optional
If this input is true, Retention Type of the primary backup is assigned To its replicas on the other nodes of the Dataset. An exception is made if the DpBackupStart API with RetentionType specified, starts the replication. In that case, the Retention Type specified in DpBackupStart is assigned To the replicas thereby overriding the Retention Type of the primary backup. If a scheduled event starts the replication, Retention Type specified in the schedule event is ignored. If this input is false, Retention Type of the primary backup is ignored when assigning Retention Type To its replicas. Depending on how the backup transfer job was started, the Retention Type specified either in DpBackupStart API or the one specified in the schedule is assigned To the replica of the primary backup.
When this input is false, replicas of the primary backup may get an undesired Retention Type if the schedules are not configured very carefully. Therefore, it is recommended that any new users of the API should always set this input To true.
Note that even if the Retention Type of primary and secondary Backups is the same, the Retention Duration may be different for them. The Retention Duration is specified for each node in the data protection Policy. See DpPolicyNodeInfo for more details.
Always present in the output.
Default is true.
IsApplicationManagingPrimaryBackupRetention xsd:boolean
optional
If this input is true, Protection Manager does not enforce Retention settings in the Policy on the primary Backups. Application is responsible for deleting primary Backups, possibly by invoking DpBackupVersionDelete API. If this input is false, Protection Manager deletes the primary Backups according To the Retention settings specified in the Policy.
Always present in the output.
Default is false.
IsApplicationResponsibleForPrimaryBackup xsd:boolean
DFM creates primary backup versions only if this Option is false.
| Element definition: ArrayOfConformanceAlert | [top] |
Name Type Description ConformanceAlert ConformanceAlert[]
| Element definition: ArrayOfDfmMetadataField | [top] |
Name Type Description DfmMetadataField DfmMetadataField[]
| Element definition: ArrayOfDryRunResult | [top] |
Name Type Description DryRunResult DryRunResult[]
| Element definition: ArrayOfStorageServiceDatasetInfo | [top] |
Name Type Description StorageServiceDatasetInfo StorageServiceDatasetInfo[]
| Element definition: ArrayOfStorageServiceInfo | [top] |
Name Type Description StorageServiceInfo StorageServiceInfo[]
| Element definition: ArrayOfStorageServiceNodeAttributes | [top] |
Name Type Description StorageServiceNodeAttributes StorageServiceNodeAttributes[]
| Element definition: ArrayOfStorageSetInfo | [top] |
Name Type Description StorageSetInfo StorageSetInfo[]
| Element definition: EmailAddressList | [top] |
A list of email addresses. If more than one email Address is specified, the addresses must be seperated by a ','. Spaces (and other white space) are not allowed, either between addresses or in them. Unprintable characters are also invalid. The list may contain up To 255 characters.
[none]
| Element definition: ObjId | [top] |
Identification number (ID) for a DFM object. This typedef is an alias for the builtin ZAPI Type integer. Object IDs are unsigned integers in the range [1..2^31 - 1]. In some contexts, an object ID is also allowed To be 0, which is interpreted as a null Value, e.g., a reference To no object at all. The ID for a DFM object is always assigned by the system; the user is never allowed To assign an ID To an object. Therefore, an input element of Type ObjId is always used To refer To an existing object by its ID. The ZAPI must specify the object's DFM object Type (e.g. Dataset, Host, DP Policy, etc.). Some ZAPIs allow the object To be one of several different types.
If the Value of an ObjId input element does not Match the ID of any existing DFM object of the specified Type or types, then typically the ZAPI fails with Error code EOBJECTNOTFOUND. A ZAPI may deviate From this general rule, for example, it may return a more specific Error code. In either case, the ZAPI specification must document its behavior.
[none]
| Element definition: ObjName | [top] |
Name of a DFM object. This typedef is an alias for the built in ZAPI Type string. An object Name must conform To the following format: The behavior of a ZAPI when it encounters an Error involving an ObjName input element depends on how the ZAPI uses the input element. Here are the general rules:
- It must contain between 1 and 64 characters.
- It may start with any character and may contain any combination of characters, except that it may not consist solely of decimal digits ('0' through '9').
- In some contexts, a Name may be the empty string (""), which is interpreted as a null Value, e.g., a reference To no object at all.
A ZAPI may deviate From these general rules, for example, it may return more specific Error codes. In such cases, the ZAPI specification must document its behavior.
- If the input Name element is used To create a new object with the given Name, or rename an existing object To that Name, and the Name does not conform To the above format, then the ZAPI fails with Error code EINVALIDINPUTERROR. Note that because EINVALIDINPUTERROR is such a common Error code, ZAPI specifications are not required To document cases when they may return it.
- If the input Name element is used To refer To an existing object with that Name, and there is no object with that Name, then the ZAPI fails with Error code EOBJECTNOTFOUND. Generally the ZAPI specification documents cases when it may return this Error code.
If an input Name element is used To refer To an existing object, then the ZAPI specification must specify which DFM object Type (e.g. data set, Host, DP Policy, etc.) is allowed. Some ZAPIs allow the object To be one of several different types. See the Description of ObjFullName for examples of valid input formats.
Note that there is no requirement that all object names must be unique. However, the names for some specific types of Objects are constrained such that no two Objects of that Type may have the same Name. For example, this constraint applies To Datasets, DP schedules, and DP policies. This means that no two Datasets may have the same Name, but a Dataset may have the same Name as a DP schedule or DP Policy.
In general, object names are compared in a case-insensitive manner. This means that, for example, "MyObject" and "MYOBJECT" are considered To be the same Name for purposes of: creating new Objects, renaming existing Objects, or looking up an object by Name. On the other hand, ZAPIs that return an ObjName generally do not change the capitalization at all. For example, if an object's Name has been set To "MyObject", then list iteration ZAPIs that return the object's Name return it as "MyObject" rather than "MYOBJECT" or "myobject".
ZAPIs that operate on ObjName Values and do not follow these general rules about case sensitivity must document the rules that they do follow.
One important exception To these general rules is that Volumes, Qtrees, OSSV Directories, SRM Paths, Interfaces, FCP Targets and FC switch ports all have case-sensitive names. When looking up Objects of these types by Name, the case must Match the object Name.
[none]
| Element definition: ObjNameOrId | [top] |
Name or internal ID of a DFM object. This typedef is an alias for the builtin ZAPI Type string. An ObjNameOrId must contain between 1 and 64 characters, and must conform To one of the following formats: Elements of Type ObjNameOrId are used only as inputs To ZAPIs. The Value must Match either the Name or internal ID of an existing DFM object. The ZAPI must specify the object's DFM object Type (e.g. Dataset, Host, DP Policy, etc.). Some ZAPIs allow the object To be one of several different types.
- It must have the format of an ObjName, or
- It must be the decimal numeric string form of a positive integer whose Value is in the range [1..2^31 - 1].
- In case of application resources From the Host Service, this field can contain unique identifier assigned To the object by the Host Service e.g. for a Virtual Machine, it can be a GUID of the VM. One exception is when such unique identifier is a decimal numeric string containing only digits From 0 through 9. In that case, you cannot use such identifier as ObjNameOrId input.
If the format of an ObjNameOrId input element does not conform, or the Value does not Match the Name or ID of an existing object, then generally the ZAPI documents that it fails with Error code EOBJECTNOTFOUND. A ZAPI may return more specific Error codes. In such cases, the ZAPI specification must document its behavior.
If a ZAPI can accept a null Value (e.g. reference To no object at all) for such an element, then the element is declared optional, and the absence of the input element represents a null Value.
[none]
| Element definition: RequiresNonDisruptiveRestore | [top] |
When this attribute is set, the Dataset is configured To allow LUNs To be restored From Backups in such a way that the Host need not detach From the LUN. Configuring the Dataset for non-disruptive restore does not guarantee that all backup Instances may be restored non-disruptively. It only applies To backup Instances reached through a Backup connection. The caller must check the SupportsNonDisruptiveRestore output element returned by dp-backup-list-info-next To tell whether a given backup Instance can be restored non-disruptively.
Specifically, when this attribute is set:
- All storage systems must be running ONTAP 7.3 or later.
- Protection Manager must have working ZAPI credentials for all storage systems in use by this Dataset.
- All Backup connections will be implemented using SnapVault, not Qtree SnapMirror.
- All non-primary storage systems used by the data set must have a SnapVault Secondary License.
If any of these constraints is not met when adding a member To the Dataset, the Dataset will not be in conformance and the addition will generate conformance Errors. Addition of Members with ONTAP Version less than 7.3 To the primary node of the Dataset will fail with Errors.
requires-nondisruptive-restore may only be specified if:
Thus, if RequiresNonDisruptiveRestore is specified as true, IsApplicationData must also be present and true. Callers may check the non-disruptive-restore-compatible output element of the dp-policy-list-info-iter-next API To tell which policies may be applied To Datasets requiring non-disruptive restores.
- No Backup connection in the protection Policy used by the Dataset is DR capable (i.e. the IsDrCapable attribute may not be set for any Backup connection of the Policy).
- The Dataset must be an application Dataset.
[none]
| Element definition: WrapperOfProvisionMemberRequestInfo | [top] |
Name Type Description ProvisionMemberRequestInfo ProvisionMemberRequestInfo
| Element definition: ConformanceAlert | [top] |
A Description of one conformance check alert that should be noted by a user.
Name Type Description ConformanceAlertEffect xsd:string
optional
The predicted Effect of the alert. If there is no Effect, this element will not be present ConformanceAlertReason xsd:string
Specifies possible reasons for alert. ConformanceAlertSeverity ObjStatus
Severity of the alert. Possible Values are "information", "Error" or "warning". ConformanceAlertSuggestion xsd:string
optional
Present only if Severity is Error or warning. Specifies any suggestions To rectify the warnings, Errors. If there are no suggestions To specify, this element will not be present. ConformanceAlertType ConformanceAlertType
Indicates the Type for this alert
| Element definition: DfmMetadataField | [top] |
Named field in the metadata.
Name Type Description FieldName xsd:string
Name of the metadata field. Field names are up To 255 characters in Length and are case- insensitive. FieldValue xsd:string
Arbitrary, user-defined data expressed as a string. The string is opaque To the server and must not exceed 16384 (16k) characters in Length.
| Element definition: DryRunResult | [top] |
A Description of one Action and the predicted effects of taking that Action.
Name Type Description DryRunAction xsd:string
An Action the system would take. DryRunEffect xsd:string
The predicted Effect of the Action. DryRunReason xsd:string
optional
Present only if Severity is Error or warning. Specifies possible reasons for the Error, warning. If there are no reasons To specify, this element will not be present. DryRunReasonDetails ArrayOfResultDetail
optional
These details apply To the associated DryRunReason within the same DryRunResult. These offer additional information such as the reasons individual reasources may not have been selected for the DryRunAction in this same DryRunResult. DryRunSeverity ObjStatus
Severity of the DryRun Result. Possible Values are "information", "Error" or "warning". DryRunSuggestion xsd:string
Present only if Severity is Error or warning. Specifies any suggestions To rectify the warnings, Errors. If there are no suggestions To specify, this element will not be present.
| Element definition: ProvisionMemberRequestInfo | [top] |
Details specific To the 'provision_member' Request.
Name Type Description Comments ArrayOfProvisionMemberComment
optional
Comment Values To assign To the newly provisioned storage object. CreateNewVfiler xsd:boolean
optional
True, if new vFiler Unit needs To be created during provisioning. The provisioned storage container is then moved To the vFiler Unit. This input is applicable only in the context of ResourcepoolMemberListInfoIterStart zapi and RunProvisioningChecks is specified as 'true'. This input is ignored in DatasetProvisionMember and StorageServiceDatasetProvision zapi. The default Value is 'false'. DatasetExportInfo DatasetExportInfo
optional
Specifies the NAS or SAN export settings for the the provisioning member. Member level export settings cannot be specified, if export settings have been configured at node level. Description xsd:string
optional
Description of the provisioning Request. The Length of this string cannot be more than 255 characters. InitialSnapshotSpace xsd:integer
optional
Applicable when provisioning Members in SAN data sets (i.e. Datasets associated with provisioning Policy of Type 'san'). Specify the initial disk space in bytes that needs To be allocated upfront for Snapshot copies of the member. Range: [1..2^63-1] MaximumDataSize xsd:integer
optional
Maximum storage space for the Dataset member. Applicable when provisioning Members in NFS data sets (i.e. Datasets associated with provisioning Policy of Type 'nas' and export over 'NFS' Protocol). Storage clients can write data up To this limit if the containing Aggregate has space. The Value is specified in bytes. Range: [1..2^63-1] MaximumSnapshotSpace xsd:integer
optional
Applicable when provisioning Members in SAN data sets (i.e. Datasets associated with provisioning Policy of Type 'san'). Specify the Maximum disk space in bytes for the Snapshot copies of the member. Once the space consumed by Snapshot copies reaches this Value, further Snapshot copies will fail. Range: [1..2^63-1] Name xsd:string
Name of the storage container. If this is a NAS Dataset, i.e the provisioning Policy associated with the primary node of the Dataset is of Type 'nas', then this Name corresponds To the Qtree or Volume created. If this is a SAN Dataset, i.e the provisioning Policy associated with the primary node of the Dataset is of Type 'san', then this Name corresponds To the LUN or Volume that will be provisioned as part of this Request. The Length of this string cannot be more than 255 characters. OnlineMigration xsd:boolean
optional
Indicates whether pre checks related To online migration has To be performed on the storage system during provisioning. This input is applicable only in the context of ResourcepoolMemberListInfoIterStart API and RunProvisioningChecks is specified as true and either CreateNewVfiler is true or VfilerNameOrId is specified. This input is ignored in StorageServiceDatasetProvision and DatasetProvisionMember APIs. ProvisioningPolicyId ObjId
optional
Name or identifier of the provisioning Policy used with this Request. Ignored for DatasetProvisionMember and StorageServiceDatasetProvision and is used only when listing provisioning requests and Jobs. ProvisioningPolicyName ObjFullName
optional
Name of the provisioning Policy used with this Request. Present only if the Request Type is 'provision_member'. Ignored for DatasetProvisionMember and StorageServiceDatasetProvision and is used only when listing provisioning requests and Jobs. ResourceNameOrId ObjNameOrId
optional
Name or identifier of the Resource object From which storage space will be provisioned. valid types of Objects are:- The Filer or Aggregate specified should belong To the Resource pool(s) associated with primary node of the Dataset.
- Filer
- Aggregate
Size xsd:integer
Amount of storage space for data. Whether this space has To allocated on demand or reserved upfront From an Aggregate in Resource pool is decided based on the provisioning Policy settings. The Value is specified in bytes. Range: [1..2^63-1] VfilerNameOrId ObjNameOrId
optional
Name or Id of the vFiler Unit, if specified the newly provisioned Dataset member will be moved To the specified vFiler Unit and accessed via the vFiler Unit's IP addresses. Ignored for StorageServiceDatasetProvision.
| Element definition: StorageServiceDatasetInfo | [top] |
Name Type Description DatasetId ObjId
Identifier of the Dataset. DatasetName ObjName
Name of the Dataset. StorageServiceId ObjId
optional
Name of the storage Service. This will not be returned if the Dataset is not associated with the storage Service. StorageServiceName ObjName
optional
Name of the storage Service. This will not be returned if the Dataset is not associated with the storage Service.
| Element definition: StorageServiceInfo | [top] |
Name Type Description Datasets ArrayOfDatasetReference
optional
List of Datasets attached To the storage Service. IsDrCapable xsd:boolean
optional
True, if storage Service has data protection Policy associated with it, which is disaster recovery capable. ProtectionPolicyId ObjId
optional
Identifier of the protection Policy ProtectionPolicyName ObjName
optional
Name of the protection Policy. StorageServiceContact EmailAddressList
Contact for the storage Service, such as the owner's e-mail Address. StorageServiceDescription xsd:string
Description of the new storage Service. StorageServiceId ObjId
Identifier of storage Service. StorageServiceName ObjName
Name of the storage Service. StorageServiceNodes ArrayOfStorageServiceNodeInfo
Information about storage Service nodes. StorageServiceOwner xsd:string
Name of the owner of the storage Service.
| Element definition: StorageServiceNodeAttributes | [top] |
Name Type Description DpNodeName DpPolicyNodeName
optional
Name of the node in the data protection Policy. DpNodeName must Match exactly the Name of one of the nodes in the data protection Policy that is currently assigned To the storage Service. This element can be absent if no protection Policy was assigned To the storage Service, in which case, the details are assumed for the primary node. OldDpNodeName DpPolicyNodeName
optional
Name of the old data protection Policy node To be mapped To the new data protection Policy node. When the data protection Policy of storage Service is modified and this element is provided, the node DpNodeName of the new Policy will acquire the Attributes of this node. Also for all the Datasets attached To the storage Service, storage sets mapped To OldDpNodeName of the old protection Policy will be re-mapped To node DpNodeName of the new protection Policy. If not provided when data protection Policy is being modified, for all the Datasets attached To the storage Service, new storage sets would be created for node DpNodeName. This element is only used by StorageServiceModify and StorageServiceDatasetModify API for 'attach' Operation Type. This input is ignored in StorageServiceCreate API ProvisioningPolicyNameOrId ObjNameOrId
optional
Name or identifier of the provisioning Policy To be associated with the node. This element is used only by StorageServiceCreate and StorageServiceModify API. This element will be ignored, if specified for StorageServiceDatasetModify API. In StorageServiceModify API, if the Value specified for the element is empty, then the provisioning Policy associated with the node will be cleared. Resourcepools ArrayOfResourcepoolNameOrId
optional
Name or identifier of the Resource pools To be associated with the node. This element is used only by StorageServiceCreate and StorageServiceModify API. This element will be ignored, if specified for StorageServiceDatasetModify API. VfilerTemplateNameOrId ObjNameOrId
optional
Name or identifier of the vFiler template To be used To create a vFiler Unit for Dataset node. This element is used only by StorageServiceCreate and StorageServiceModify API. This element will be ignored, if specified for StorageServiceDatasetModify API. In StorageServiceModify API, if the Value specified for the element is empty, then the vFiler template associated with the node will be cleared.
| Element definition: StorageSetInfo | [top] |
Name Type Description DatasetAccessDetails DatasetAccessDetails
optional
Details of the vFiler Unit To be created through which the Dataset Members provisioned for this node will be exported. Both ServerNameOrId and DatasetAccessDetails cannot be specified for a node. DatasetExportInfo DatasetExportInfo
optional
Specifies the NAS or SAN export settings for Members provisioned in this node of the Dataset DpNodeName DpPolicyNodeName
optional
Name of the node in the data protection Policy. DpNodeName must Match exactly the Name of one of the nodes in the data protection Policy that is currently assigned To the storage Service. This element can be absent if no protection Policy was assigned To the storage Service, in which case, the details are assumed for the root storage set. ServerNameOrId ObjNameOrId
optional
Name or identifier of the vFiler Unit To be attached To the node. If a vFiler Unit is attached, then all Members provisioned into this node will be exported over this vFiler Unit. Both ServerNameOrId and DatasetAccessDetails cannot be specified for a node. TimezoneName xsd:string
optional
Timezone To assign To the node. If specified, the Value must be a TimezoneName returned by TimezoneListInfoIterNext. If no Timezone is assigned, then the default system Timezone will be used.
| Element definition: ArrayOfDatasetReference | [top] |
Name Type Description DatasetReference DatasetReference[]
| Element definition: ArrayOfProvisionMemberComment | [top] |
Name Type Description ProvisionMemberComment ProvisionMemberComment[]
| Element definition: ArrayOfResourcepoolNameOrId | [top] |
Name Type Description ResourcepoolNameOrId ResourcepoolNameOrId[]
| Element definition: ArrayOfResultDetail | [top] |
Name Type Description ResultDetail ResultDetail[]
| Element definition: ArrayOfStorageServiceNodeInfo | [top] |
Name Type Description StorageServiceNodeInfo StorageServiceNodeInfo[]
| Element definition: ConformanceAlertType | [top] |
The Type of alert that is being issued is indicated by a field of this Type. The alert-type may apply To the ConformanceAlerts. Possible Values are: 'diskspace' and 'rebaseline'.
Please see ConformanceAlerts where the above Values may be used for additional information.
- diskspace: An alert can be issued for when DFM station disk space is so low as To impact the Operation of DFM.
- rebaseline: When the system detects that existing relationships are in need of migration an alert of this Type may be issued To warn that a rebaseline may be done should the user confirm conformance for non-conformant Datasets.
[none]
| Element definition: DatasetAccessDetails | [top] |
The data access details of a Dataset. Currently, this is used To configure a Dataset in a way that it is capable of transparent migration. A Dataset can be configured and provisioned in a way that it is capable of transparent migration. IP Address and Netmask has To be configured on the Dataset in order To make the Dataset capable of transparent migration. Provisioning Manager will create a vFiler Unit with this IP Address and all the storage provisioned for this Dataset will be accessed From this vFiler Unit or this IP Address. As input, it is valid only when: - There are no Members in the Dataset. - There is no vFiler Unit attached To the Dataset.
Name Type Description IpAddress xsd:string
IP Address in dotted decimal format. (for example, "192.168.11.12"). The Length of this string cannot be more than 16 characters. Netmask xsd:string
Netmask for the IP Address in dotted decimal notation. As input, this is valid only when IpAddress is also provided in DatasetAccessDetails. Provisioning Manager will create a vFiler Unit whose IP Address will be the one configured as IpAddress and it will be bound To an Interface with this Netmask.
| Element definition: DatasetExportInfo | [top] |
Specifies the NAS or SAN export settings for a Dataset node.
Name Type Description DatasetCifsExportSetting DatasetCifsExportSetting
optional
The CIFS export settings for storage exported over CIFS. This field may be present only if the DatasetExportProtocol is 'cifs' or 'mixed'. DatasetExportProtocol DatasetExportProtocol
optional
Specifies the Protocol over which Members of the Dataset node will be exported. This Value is always returned. If omitted during a modify Operation, the existing Value is not changed. If specified as 'none' in a modify Operation, the existing settings will be cleared. Default Value is 'none'. Depending on the export Protocol, dataset-lun-mapping, or a combination of DatasetNfsExportSetting and DatasetCifsSharePermissions, should be specified in a modify Operation, and will be returned in the iterator output. DatasetLunMappingInfo DatasetLunMappingInfo
optional
Specifies the Hosts and/or Initiators To which LUNs in this Dataset node will be mapped, and the igroup OS Type. This field may be present only if the DatasetExportProtocol is 'fcp' or 'iscsi'. DatasetNfsExportSetting DatasetNfsExportSetting
optional
The NFS export settings for storage exported over NFS. This field may be present only if the DatasetExportProtocol is 'nfs' or 'mixed'.
| Element definition: DpPolicyNodeName | [top] |
Name of a node in a DP Policy graph. This typedef is an alias for the builtin ZAPI Type string. A node Name may contain From 1 To 64 characters. It may start with any character and may contain any combination of characters, except that it may not consist solely of decimal digits ('0' through '9'). The Name of each node in a DP Policy must be unique, but nodes in different policies may share the same Name. Node names are always compared in a case-insensitive manner. This means that, for example, "a" and "A" are considered To be the same Name for purposes of: creating new nodes for a new Policy, renaming nodes of an existing Policy, or looking up a Policy's nodes by Name. On the other hand, ZAPIs that return node names do not change the capitalization at all. For example, if a node's Name has been set To "Backup", then DpPolicyListIterNext returns its Name as "Backup".
Note that a node Name has the same format as an ObjName, and has similar Properties such as case-insensitivity. However, a node Name is not a kind of ObjName because a DP Policy node is a part of a DP Policy object, but is not itself a first-class DFM object.
[none]
| Element definition: ObjFullName | [top] |
Full Name of a DFM object. This typedef is an alias for the builtin ZAPI Type string. An object full Name conforms To all the rules of an ObjName, except that the full Name may be up To 255 characters long. DFM creates full names by concatenating an object Name with any parent object names, so as To create a unique Name for an object. The format of full names is as follows:
- Host full names are the either the fully-qualified domain Name or the IP Address of the Host.
- Aggregate full names are the Host Name and the Aggregate Name, separated by a colon, e.g. Hostname:aggr0.
- Volume full names are the Host Name and the Volume Name, separated by ":/", e.g. Hostname:/volume. Note this does not include "/vol". Volume and Aggregate full names are distinguished by the presence of a forward slash after the colon.
- Qtree full names are the containing Volume full Name and the Qtree Name, separated by a slash, e.g. Hostname:/volume/qtree. The data not contained by any Qtree may be represented by "-", e.g. Hostname:/volume/-.
- Lun Path full names are either a Volume or Qtree full Name and the LUN Path, separated by a slash, e.g. Hostname:/volume/LUN or Hostname:/volume/qtree/LUN.
- Network full names are a network Address block in CIDR format, e.g. 1.2.3.0/8.
- OSSV Directory full names are the OSSV Host Name and the OSSV Path, separated by a colon, e.g. host-lnx:/usr/local or host-w2k:c:/temp
- Include any others here...
- Initiator Group full names are Host Name and the initiator Group Name, separated by a colon, e.g. Hostname:igroup.
For any DFM object not listed above, the ObjName and ObjFullName are identical.
[none]
| Element definition: ObjStatus | [top] |
A Status Value which can be associated with a DFM object. This typedef is an alias for the builtin ZAPI Type string. The Severity associated with an event has this Type. Possible Values are: 'unknown', 'normal', 'information', 'unmanaged' 'warning', 'Error', 'critical', 'emergency'.
In some contexts, it is important that severities are ordered (as above). For example, an alarm might be triggered if an event with a given Severity "or worse" occurs. In this example, worse means "after" in the list above.
- unknown: An object has an unknown Status when it transitions From one state To another. Ideally, an object will have this Status briefly. For example, when an object has been added, but not yet discovered.
- normal: An object has normal Status when it is working within the Thresholds specified in DFM.
- information: The information Events are normal occurrences on an object for which you can define alarms.
- unmanaged: An object is considered To be unmanaged when the login and Password are not set for the storage system or agent.
- warning: An object has the warning Status when an event related To the object occurred that an administrator should know about. The event will not cause Service disruption.
- Error: An object has Error Status when it does not cause any Service disruption, but it may affect performance.
- critical: An object has critical Status when it is still performing, but Service disruption may occur if corrective Action is not taken immediately.
- emergency: An object is in emergency Status when it stops performing unexpectedly and could lose data.
[none]
| Element definition: DatasetCifsExportSetting | [top] |
If storage inside this Dataset node is exported over CIFS, this specifies some of the common Properties that will be applied To all such provisioned storage.
Name Type Description CifsDomain xsd:string
optional
Name of the CIFS domain. If present, then only filers or vFilers belonging To this CIFS domain is considered for provisioning. If not present, then any Filer is picked. Up To 255 characters. DatasetCifsSharePermissions ArrayOfDatasetCifsSharePermission
optional
Specifies the permissions granted To users on storage provisioned in this Dataset node. This field may be present only if the DatasetExportProtocol is 'cifs' or 'mixed'.
| Element definition: DatasetExportProtocol | [top] |
Specifies the export protocols that Members in this Dataset node will be exported over. Possible Values are 'nfs', 'cifs', 'mixed', 'fcp', 'iscsi' and 'none'. Specifying 'mixed' implies that the storage in the Dataset should be exported over both NFS and CIFS.
[none]
| Element definition: DatasetLunMappingInfo | [top] |
Specifies the Hosts and/or Initiators To which LUNs in this Dataset node will be mapped, and the igroup OS Type.
Name Type Description IgroupOsType xsd:string
Specifies the OS Type for Initiators To map LUNs in the Dataset node To. Possible Values are: 'windows', 'windows_gpt', 'windows_2008', 'hpux', 'aix, 'linux, 'solaris', 'vmware', 'netware', 'hyper_v', 'xen', 'solaris_efi', and 'openvms' Here "windows_gpt" refers To Windows using GPT (GUID Partition Type) partitioning style and "windows_2008" refers To Windows Longhorn systems. LunMappingInitiators ArrayOfLunMappingInitiator
Specifies the Initiators To map LUNs in the Dataset node To, and, optionally, the Host To which they belong.
| Element definition: DatasetNfsExportSetting | [top] |
If storage inside this Dataset node is exported over NFS, this specifies some of the common Properties that will be applied To all such provisioned storage.
Name Type Description AnonymousAccessUser xsd:integer
optional
If the client accessing the export is not present in the root access list for the export, the effective user for root is the Value specified for this field. Default Value is 65534 which maps To user nobody. It could be an integer Range: [0..65534] or a user Name not more than 255 characters. DisableSetuid xsd:boolean
optional
If true, causes the server file system To ignore attempts To enable the setuid or setgid mode bits. Default Value is true. IsReadonlyForAllHosts xsd:boolean
optional
Specifies that all Hosts receive read-only permissions on nfs exports in this Dataset node. Equivalent To specifying "ro" on the Filer. Default Value is false. If true, IsReadwriteForAllHosts must be false. IsReadwriteForAllHosts xsd:boolean
optional
Specifies that all Hosts receive read-write permissions on nfs exports in this Dataset node. Equivalent To specifying "rw" on the Filer. Default Value is false. If true, IsReadonlyForAllHosts must be false. NfsExportRoHosts ArrayOfNfsExportHost
optional
A list of Hosts with read-only permissions on exports in this Dataset node. If a non empty list of NfsExportRoHosts is present along with IsReadonlyForAllHosts as true, then ZAPI will throw an Error. NfsExportRootHosts ArrayOfNfsExportHost
optional
A list of Hosts with the root user having read-only or read-write permissions on exports in this Dataset node. NfsExportRwHosts ArrayOfNfsExportHost
optional
A list of Hosts with read-write permissions on exports in this Dataset node. If a non empty list of NfsExportRwHosts is present along with IsReadwriteForAllHosts as true, then ZAPI will throw an Error. NfsProtocolVersion xsd:string
optional
NFS Protocol Version, valid Values are "v2", "v3" and "v4". Default Value is "v3". If set, the storage systems that have the given Version enabled will be selected To provision storage for the Dataset. NfsSecurityFlavors ArrayOfNfsSecurityFlavor
optional
List of strings specifying the security flavors supported on exports in this Dataset node. If this field is not specified, the default Value of 'sys' is assumed.
| Element definition: DatasetReference | [top] |
The Name and Id of a Dataset.
Name Type Description DatasetId ObjId
Identifier for the Dataset.
Range: [1..2^31-1]DatasetName ObjName
Name of the Dataset.
| Element definition: ProvisionMemberComment | [top] |
One comment field To fill in as part of the Request
Name Type Description CommentFieldNameOrId CommentFieldNameOrId
Name or identifier of the comment field. CommentValue CommentValue
Value of the comment field. An empty string can be used To unset the Value of the comment field for this object.
| Element definition: ResourcepoolNameOrId | [top] |
Resource Pool. Value can be a DFM object Name (Maximum 255 characters) or the DFM Id [1..2^31-1].
[none]
| Element definition: ResultDetail | [top] |
Details on a specific Action that adds information intended To explain more about a higher level Result. For example, the detail may be used To explain a DryRun Result by explaining why resources were not selected.
Name Type Description Action xsd:string
An Action or check the system had taken. Effect xsd:string
The Result of the Action or check. Reason xsd:string
optional
Specifies possible reasons for the this Result. If there are no reasons To specify, this element will not be present. Severity ObjStatus
Severity of the Result Result. Possible Values are "information", "Error" "warning". It is normal for "information" To be used To explain why a Resource was not selected. Suggestion xsd:string
Specifies any suggestions To rectify the information, warnings, Errors. If there are no suggestions To specify, this element will not be present.
| Element definition: StorageServiceNodeInfo | [top] |
Name Type Description DpNodeId ObjId
ID of the node in the data protection Policy that maps To the storage Service node. DpNodeName ObjName
Name of the node in the data protection Policy that maps To the storage Service node. ProvisioningPolicyId ObjId
optional
Identifier of the provisioning Policy associated with the node. ProvisioningPolicyName ObjName
optional
Name of the provisioning Policy associated with the node. Resourcepools ArrayOfResourcepoolInfo
optional
List of the Resource pools associated with the node. VfilerTemplateId ObjId
optional
Identifier of the vFiler template associated with the node. VfilerTemplateName ObjName
optional
Name of the vFiler template associated with the node.
| Element definition: ArrayOfDatasetCifsSharePermission | [top] |
Name Type Description DatasetCifsSharePermission DatasetCifsSharePermission[]
| Element definition: ArrayOfLunMappingInitiator | [top] |
Name Type Description LunMappingInitiator LunMappingInitiator[]
| Element definition: ArrayOfNfsExportHost | [top] |
Name Type Description NfsExportHost NfsExportHost[]
| Element definition: ArrayOfNfsSecurityFlavor | [top] |
Name Type Description NfsSecurityFlavor NfsSecurityFlavor[]
| Element definition: ArrayOfResourcepoolInfo | [top] |
Name Type Description ResourcepoolInfo ResourcepoolInfo[]
| Element definition: CommentFieldNameOrId | [top] |
Name or identifier of the comment field. It must conform To one of the following formats:
- It must be of the format of CommentFieldName
- It must be of the format of CommentFieldId
[none]
| Element definition: CommentValue | [top] |
Value of the specified comment field To be set on the object. This can be of Maximum 1024 characters.
[none]
| Element definition: DatasetCifsSharePermission | [top] |
A single Permission granted To a user on CIFS shares within a Dataset node.
Name Type Description CifsUsername xsd:string
Name of a user in the specified domain. The Username may be the Name of an actual domain user or one of the built-in names - 'administrator' or 'everyone'. Permission CifsPermission
Specifies the permissions granted To a user.
| Element definition: LunMappingInitiator | [top] |
Specifies an initiator To map LUNs in the Dataset node To, and, optionally, the Host To which it belongs.
Name Type Description Hostname xsd:string
optional
Specifies the Name of the Host which owns the initiator. InitiatorId InitiatorId
Specifies an initiator Id on a Host To which a LUN should be mapped.
| Element definition: NfsExportHost | [top] |
Specifies a single Host or all-hosts. A Host can be a Host Name (DNS Name), an IP Address, a subnet or a domain Name. If an 'all-hosts' entry is present, all other Host Name entries must be negated.
Name Type Description Hostname xsd:string
optional
Specifies a single Host Name entry. A Host Name may be a DNS Name, an IP Address, a subnet (specified as <subnet Address>/<prefix Length> i.e. CIDR notation or '[network] <subnet-address> [netmask] <Netmask>'), a domain, or a workgroup. IsAnException xsd:boolean
optional
Specifies that the rule does not apply To this Host. Should be used when it is required To grant permissions To Hosts in a subnet or a domain or all Hosts excluding some. Default Value is false.
| Element definition: NfsSecurityFlavor | [top] |
A security flavor To be applied on nfs exports. Possible Values are 'none', 'sys' (Unix Style), 'krb5' (Kerberos v5) , krb5i' (Kerberos v5 integrity) and 'krb5p' (Kerberos v5 privacy). Default Value is 'sys'.
[none]
| Element definition: ResourcepoolInfo | [top] |
Information about a Resource pool.
Name Type Description AggregateNearlyOvercommittedThreshold xsd:unsignedShort
optional
The Value (as an integer percentage) of the fullness threshold used To generate an "Resourcepool nearly overcommitted" event for all the Resource pools. If the Value specified is empty, then the setting is cleared and the Value specified in global Options for aggrNearlyOvercommittedThreshold will be used. Range: [0..65535] AggregateOvercommittedThreshold xsd:unsignedShort
optional
The Value (as an integer percentage) of the fullness threshold used To generate an "Resourcepool overcommitted" event for all the Resource pools. If the Value specified is empty, then the setting is cleared and the Value specified in global Options for aggrOvercommittedThreshold will be used. Range: [0..65535] ResourceTag ResourceTag
optional
A label that can be associated with a Resource pool. ResourcepoolContact EmailAddressList
optional
Contact information for the Resource pool, such as the owner's e-mail Address. This is modifiable. ResourcepoolDescription xsd:string
optional
Description of the Resource pool, up To 255 characters long. This is modifiable. ResourcepoolFreeVfilers xsd:unsignedLong
optional
The number of vFiler units that can be created in this Resource pool based on the current limit and number of vFiler units present in the storage systems that are Members of the Resource pool. Ignored for ResourcepoolCreate and ResourcepoolModify. Range: [0..2^64-1]. ResourcepoolFullThreshold xsd:integer
optional
The Value (as an integer percentage) of the fullness threshold used To generate a "Resource pool full" event for this Resource pool. If the Value specified is empty, then the Resource pool setting is cleared and the Value specified in ResourcepoolGetDefaults is used. Range: [0..1000] ResourcepoolId xsd:integer
optional
Identifier of the Resource pool. Its a valid DFM object Id. A valid DFM object Id would be in the range of [1..2^31-1]. Ignored for ResourcepoolCreate and ResourcepoolModify. ResourcepoolIsProvisionable xsd:boolean
optional
This is returned in ResourcepoolListInfoIterNext if LicenseFilter, ResourceTag or reliability information is passed in the input, this is set To true or false depending on whether the Resource pool meets all the three filters, Default Value is set To TRUE. ResourcepoolKbytesAvailable xsd:integer
optional
Amount of Kbytes of storage available in this Resource pool. This Value only present if IncludeFreeSpace was true. Ignored for ResourcepoolCreate and ResourcepoolModify. Range: [0..2^63-1]. ResourcepoolKbytesTotal xsd:integer
optional
Total amount of Kbytes of storage in this Resource pool. This Value only present if IncludeFreeSpace was true. Ignored for ResourcepoolCreate and ResourcepoolModify. Range: [0..2^63-1]. ResourcepoolKbytesUsed xsd:integer
optional
Amount of Kbytes of storage used in this Resource pool. This Value only present if IncludeFreeSpace was true. Ignored for ResourcepoolCreate and ResourcepoolModify. Range: [0..2^63-1]. ResourcepoolMemberCount xsd:integer
optional
The Count of direct Members added To the Resource pool. This includes number of storage systems and Aggregates added To the Resource pool. Ignored for ResourcepoolCreate and ResourcepoolModify. Range: [0..2^31-1] ResourcepoolName xsd:string
optional
Name of the Resource pool. This is modifiable. This must be specified in ResourcepoolCreate. Its a valid DFM object Name. A valid DFM object Name would contain at least one non-numeric character. ResourcepoolNearlyFullThreshold xsd:integer
optional
The Value (as an integer percentage) of the fullness threshold used To generate a "Resource pool nearly full" event for this Resource pool. If the Value specified is empty, then the Resource pool setting is cleared and the Value specified in ResourcepoolGetDefaults is used. Range: [0..1000] ResourcepoolOwner xsd:string
optional
Name of the owner of the Resource pool, up To 255 characters long. This is modifiable. ResourcepoolPerfStatus ObjStatus
optional
Current performance Status of the Resource pool. Ignored for ResourcepoolCreate and ResourcepoolModify. ResourcepoolSpaceStatus xsd:string
optional
Space Status of the Resource pool. Possible Values are: ResourcepoolSpaceStatus is returned only if IncludeFreeSpace is true in ResourcepoolListInfoIterStart .
- ok : Sum of used space of all Aggregates in the Resource pool against the sum of Total Size of all Aggregates has not reached or crossed ResourcepoolNearlyFullThreshold and none of the member Aggregates have reached or crossed their full Thresholds.
- member_nearly_full : Atleast one of the member Aggregates of the Resource pool has reached or crossed its nearly full threshold.
- nearly_full : Sum of used space of all Aggregates in the Resource pool against the sum of Total Size of all Aggregates has reached or crossed ResourcepoolNearlyFullThreshold.
- member_full : Atleast one of the member Aggregates of the Resource pool has reached or crossed its full threshold.
- full : Sum of used space of all Aggregates in the Resource pool against the sum of Total Size of all Aggregates has reached or crossed ResourcepoolFullThreshold.
ResourcepoolStatus ObjStatus
optional
Current Status of the Resource pool. Ignored for ResourcepoolCreate and ResourcepoolModify. ResourcepoolTimezone xsd:string
optional
Time zone in which this pool's storage is located. This is modifiable. An empty Value means To use the system default (usually GMT). Currently valid time zones can be listed by TimezoneListInfoIterStart.
| Element definition: CifsPermission | [top] |
Permission granted To a CIFS user on a share. Possible Values are 'no_access', 'read', 'change' and 'full_control'
[none]
| Element definition: InitiatorId | [top] |
For FCP Initiators, this is a string composed of 16 hexadecimal digits. For iSCSI Initiators, this is an initiator Name in the dotted-domain notation.
[none]
| Element definition: ResourceTag | [top] |
Label for the Resource. Can be of Maximum 255 characters.
[none]