NAS Update Dataset Node operation

<operation-name>

Specifies the name of the operation: update-dataset-node

Yes

<arguments>

Specifies a list of arguments required for the operation

Yes

<targets>

Contains the parent XML element for the <target> element, which specifies the dynamic targets

Conditional; required if the adapter configuration is empty in Grid Manager

<target>

Contains the child XML <targets> element, which specifies the dynamic targets

Using dynamic targets, you can define connection information for a remote host in an adapter request. This capability enables you to configure an adapter in Grid Manager by specifying configuration information in an adapter request.

This XML element can have <host>, <user-name>, <password>, <protocol>, and <port> as its child elements.

Conditional; required if <targets> is present in the adapter request

<host>

Specifies the host name or IP address of the server on which NetApp DataFabric Manager is running

Conditional; required if <targets> is present in the adapter request

<user-name>

Specifies the user name required to log on to the NetApp DataFabric Manager

Conditional; required if <targets> is present in the adapter request

<password>

Specifies the password that corresponds to the <user-name>

The <password> element can contain an encryption-type attribute. The encryption-type attribute indicates whether the password specified is encrypted.

Valid values for encryption-type attribute: Base64, Plain (default)

Conditional; required if <targets> is present in the adapter request

<protocol>

Specifies the communication protocol used by the adapter

Valid values: http (default), https

No

<port>

Specifies the port on which NetApp DataFabric Manager is enabled

Default values: 8088 (http), 8488 (https)

No

<target>

Specifies the child XML element of the <arguments> element

You can use this element to specify the connection information for a DFM server. You can use a comma-separated list of configuration names, which executes the request simultaneously on all DFM servers identified by the configuration names.

Valid values:

• The values specified for the <target> XML element must be the same as the values that have been specified for the name attribute of the <config> element in the Grid Manager adapter configuration.
• You can provide "ALL" as the value. In this case, the request is executed on all the DFM servers defined in the Grid Manager adapter configuration.
• You can specify multiple comma-separated names to allow for simultaneous execution of requests across multiple DFM servers.
• You can skip this element. In this case, the request is executed on the first defined Grid Manager adapter configuration.
• You can leave this element empty. In this case, the request is executed on the first defined Grid Manager adapter configuration.

  Note

  If you specify a request-level dynamic target by using <targets>, the request ignores this element.

No

<dataset-name-or-id>

Specifies the name of the dataset whose attributes are modified

Yes

<force>

Specifies whether a new dataset edit session should be started irrespective whether an edit is in progress

If TRUE, and an edit is already in progress on the specified dataset or an object the dataset is dependent on (such as a data protection policy), the previous edit session is rolled back and a new edit session is begun.

Valid values: true, false (default)

No

<dp-node-name>

Specifies the name of the node in the data protection policy that maps to the storage set

The <dp-node-name> must match exactly the name of one of the nodes in the data protection policy that is currently assigned to the data set.

If the <dp-node-name> is not specified, then the storage set associated with the root node is modified.

No

<online-migration>

Indicates, that the migration cut-over has to be non-disruptive.

By default the migration is assumed to be disruptive.

Valid values: true, false (default)

No

<resourcepool-name-or-id>

Specifies the name or object identifier of a resource pool to assign to the storage set

If other resource pool(s) are already assigned to the storage set, then this one replaces it. This deletes all the attached resource pools and adds a new one.

If the input value is the empty string "", then no resource pool is assigned to the storage set i.e. all the attached resource pools are removed. If you do not specify this element, then the storage set's resource pool assignment is not changed.

No

<provisioning-policy-name-or-id>

Specifies the name or object identifier of the provisioning policy to be attached to the node

The implications of this are:

1. Members of the storage set associated with the node are checked for conformance with the provisioning policy.
2. Any new members provisioned into the storage set are based on this provisioning policy.

No

<relinquish-vfiler>

Specifies whether to relinquish the vFiler unit associated with the dataset

This destroys the vFiler unit, moves all the storage owned by the vFiler unit to the hosting storage system and re-export the dataset over the storage system. This option can be specified only when:

1. The vFiler unit associated with the root node of the dataset has been created for transparent migration by Provisioning Manager. In this case, the <is-vfiler-created-for-migration> is TRUE in the dataset-info returned by the <dataset-list-info-iter> APIs.
2. All storage of the vFiler unit belongs to the primary node of the dataset, except for the root storage.
   
   Valid values: true, false (default)

No

<vfiler-name-or-id>

Specifies the name or object identifier of the vFiler unit to be attached to the node

If there are any members currently in the node, they should belong to this vFiler unit. Any new member provisioned for this node, are exported over this vFiler unit.

No

<dataset-access-details>

Specifies the data access details for a dataset that has to be configured and provisioned in a way that it is capable of transparent migration

This enables all the storage in the primary node of the dataset to be migrated to a different physical resource without having to reconfigure the clients accessing this storage.

This input is valid only when:

• There are no members in the dataset.
• There is no vFiler unit attached to the dataset.
• The node being edited is the primary node of the dataset.

No

<ip-address>

Specifies the IP address in dotted decimal format (for example, 192.168.11.12)

The length of this string cannot be more than 16 characters.

No

<netmask>

Specifies the netmask for the IP Address in dotted decimal notation

As an input, this is valid only when the <ip-address> is also provided in the <dataset-access-details>.

The Provisioning Manager creates a vFiler unit whose IP Address is configured as the ip-address that is bound to an interface with this netmask.

No

<dataset-export-info>

Specifies the NAS or SAN export settings for the provisioning member

Member level export settings cannot be specified, if the export settings have been configured at the node level.

No

<dataset-cifs-export-setting>

Specifies the CIFS export settings for storage exported over CIFS

This field may be present only if the <dataset-export-protocol> is CIFS or MIXED.

No

<cifs-domain>

Specifies the name of the CIFS domain; up to 255 characters

If present, then only filers or vFilers belonging to this CIFS domain is considered for provisioning.

If not present, then any filer is considered.

No

<dataset-cifs-share-permissions>

Specifies the permissions granted to users on storage provisioned in this dataset node

This field may be present only if the <dataset-export-protocol> is CIFS or MIXED.

No

<dataset-cifs-share-permission>

Specifies single permission granted to a user on CIFS shares within a dataset node

No

<cifs-username>

Specifies the name of a user in the specified domain

The user name may be the name of an actual domain user or one of the built-in names such as the 'administrator' or 'everyone'.

This is required for defining the <dataset-cifs-share-permission>.

No

<permission>

Specifies the permissions granted to a user

This is required for defining <dataset-cifs-share-permission>.

No

<dataset-export-protocol>

Specifies the protocol over which members of the dataset node are 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: NONE

Depending on the export protocol, the <dataset-lun-mapping>, or a combination of the <dataset-nfs-export-setting> and <dataset-cifs-share-permissions>, should be specified in a modify operation, and is returned in the iterator output.

No

<dataset-nfs-export-setting>

Specifies the NFS export settings for storage exported over NFS

This field may be present only if the <dataset-export-protocol> is NFS or MIXED.

No

<anonymous-access-user>

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 that maps to the user 'nobody'. It could be an integer

Range: [0--65534] or a user name not more than 255 characters.

No

<disable-setuid>

Specifies whether the server file system should ignore attempts to enable the setuid or setgid mode bits

Valid values: true (default), false

No

<is-readonly-for-all-hosts>

Specifies that all hosts receive read-only permissions on nfs exports in this dataset node

Equivalent to specifying RO on the filer

If TRUE, <is-readwrite-for-all-hosts> must be FALSE.

Valid values: true, false (default)

No

<is-readwrite-for-all-hosts>

Specifies that all hosts receive read-write permissions on nfs exports in this dataset node.

Equivalent to specifying RW on the filer. If TRUE, is-readonly-for-all-hosts must be FALSE.

Valid values: TRUE, FALSE (default)

No

<nfs-export-ro-hosts>

Specifies a list of hosts with read-only permissions on exports in this dataset node

If a non empty list of <nfs-export-ro-hosts> is present along with the <is-readonly-for-all-hosts> as TRUE, then an error is returned.

No

<nfs-export-root-hosts>

Specifies a list of hosts with the root user having read-only or read-write permissions on exports in this dataset node

No

<nfs-export-rw-hosts>

Specifies a list of hosts with read-write permissions on the exports in this dataset node

If a non empty list of the <nfs-export-rw-hosts> is present along with the <is-readwrite-for-all-hosts> as TRUE, then an error will be returned.

No

<nfs-export-host>

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.

No

<hostname>

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> that is, the CIDR notation or [network] <subnet-address>[netmask] <netmask>), a domain, or a workgroup.

No

<is-an-exception>

Specifies that the rule does not apply to this host

The <is-an-exception> should be used when it is required to grant permissions to hosts in a subnet or a domain or all hosts excluding some.

Valid values: true, false (default)

No

<nfs-security-flavors>

Specifies a list of strings specifying the security flavors supported on exports in this dataset node

Default value: sys

No

<nfs-security-flavor>

Specifies a security flavor to be applied on nfs exports

Valid values: none, sys (Unix Style; default), krb5 (Kerberos v5), krb5i (Kerberos v5 integrity) and krb5p (Kerberos v5 privacy)

No

<nfs-protocol-version>

Specifies the NFS protocol version

If set, the storage systems that have the given version enabled are selected to provision storage for the dataset.

Valid values: v2, v3 (default), 4

No