Dataset Remove Member operation

The Dataset Remove Member operation removes members from an existing dataset.

The following table describes the elements used in the request.

Adapter request elements for the Dataset Remove Member operation

Element	Definition	Required
`<operation-name>`	Specifies the name of the operation: `dataset-remove-member`	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. Notes An adapter configuration specified by using request-level dynamic targets takes precedence over Grid Manager level configuration information. If you specify the request-level dynamic target by using `<targets>`, the request ignores the `<targets>` element that is a child of the `<arguments>` element.	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 or identifier of the data set to be edited	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 data set or an object the data set 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
`<destroy>`	Specifies whether the member should be destroyed on the filer If not specified or FALSE, the member is not destroyed on the filer. The "destroy" flag can be TRUE, only when the members given in input are of the volume, qtree or lun types and may be indirect members of the data set. Valid values: true, false (default)	No
`<dataset-member-parameters>`	Specifies the parent element that contains information about members to be removed to dataset	Yes
`<dataset-member-parameter>`	Contains the information about a single member to be removed to dataset	Yes
`<dp-node-name>`	Specifies the name of the data protection policy node associated with the object If the `<dp-node-name>` is not specified, the object is considered to be removed from the root data protection policy node.	No
`<object-name-or-id>`	Specifies the identifier of the object to remove from the data set	No

A sample adapter request for this operation is given in the following figure.

Sample adapter request for Dataset Remove Member operation

<netapp-storage-request>
    <operation-name>dataset-remove-member</operation-name>
    <arguments>
      <targets>
        <target>
          <host>server137</host>
          <user-name>username</user-name>
          <password encryption-type = "Base64">cGFzc3dvcmQ=</password>
          <protocol>http</protocol>
          <port>8088</port>
        </target>
      </targets>
      <target />
      <dataset-name-or-id>testnew</dataset-name-or-id>
      <force>true</force>
      <destroy>true</destroy>
      <dataset-member-parameters>
        <dataset-member-parameter>
          <dp-node-name>Primary data</dp-node-name>
          <object-name-or-id>test1:/test1/demo1</object-name-or-id>
        </dataset-member-parameter>
      </dataset-member-parameters>
    </arguments>
</netapp-storage-request>

A sample adapter response for this operation is given in the following figure.

Sample adapter response for Dataset Remove Member operation

<netapp-storage-response>
  <metadata>
    <status>success</status>
    <response-count>1</response-count>
  </metadata>
  <responses>
    <response>
      <metadata>
        <status>success</status>
        <count>1</count>
      </metadata>
      <output>
        <job-ids>
          <job-info>
            <job-id>400</job-id>
          </job-info>
        </job-ids>
      </output>
    </response>
  </responses>
</netapp-storage-response>

Dataset Remove Member operation

Comments