Clone Volume operation

The Clone Volume operation creates a flexible volume that is a clone of a backing or parent flexible volume. A clone is a writable snapshot of another volume.

The following table describes the elements for this request.


Adapter request elements for the Clone Volume operation

Element

Definition

Required

<operation-name>

Specifies the name of the operation: clone-volume

Yes

<arguments>

Specifies a list of arguments required for this operation

Yes

<targets>

Contains the parent XML element for the <target> element

The <target> XML element is used to specify dynamic targets at a request level.

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

<target>

Contains the child XML element of the <targets> element, which is used to specify dynamic targets at request level

Using dynamic targets you can define connection information for a remote host within an adapter request. This allows 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.

Note


  • An adapter configuration specified by using request-level dynamic targets takes precedence over Grid Manager level configuration information.
  • If you specify a request-level dynamic target by using <targets>, the request ignores the <targets> element that is a child of <arguments>

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 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: 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 the DFM servers identified by the configuration names.

Valid values:

  • The values specified for <target> XML element must be the same as the values 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

<target-host>

Specifies the host name or IP address of the target storage/filer

Yes

<force-worm-clone>

Specifies whether the clone on a worm volume is created by force

If this element is set to true, it forces the creation of clone on a worm volume.

If this element is set to false, clone creation on any worm volume fails, as clones of worm volumes cannot be deleted until all the inherited worm files on newly created clones expire.

Valid values: true, false (default)

No

<parent-snapshot>

Specifies the name of the snapshot in the parent-volume, which serves as the parent snapshot for the clone

If this element is not provided, the filer creates a new parent snapshot named clone_parent_ (using a freshy-generated UUID) in the parent-volume.

No

<parent-volume>

Specifies the name of the parent flexible volume for the clone

Yes

<space-reserve>

Specifies the type of volume guarantee for the clone

If the <space-reserve> is not provided, the default value, volume, is used.

Valid values: none, file, volume (default)

No

<volume>

Specifies the desired name of the clone

Yes

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

Sample adapter request for Clone Volume operation

<netapp-storage-request>
    <operation-name>clone-volume</operation-name>
    <arguments>
      <targets>
        <target>
          <host>172.11.11.111</host>
          <user-name>username</user-name>
          <password encryption-type = "Base64">cGFzc3dvcmQ=</password>
          <protocol>http</protocol>
          <port>8088</port>
        </target>
      </targets>
      <target />
      <target-host>Filer1</target-host>
      <parent-volume>test</parent-volume>
      <volume>clonedvol1</volume>
      <force-worm-clone>false</force-worm-clone>
      <space-reserve>none</space-reserve>
      <parent-snapshot>temp_snapshot</parent-snapshot>
    </arguments>
</netapp-storage-request>


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

Sample adapter response for Clone Volume operation

<netapp-storage-response>
  <metadata>
    <status>success</status>
    <response-count>1</response-count>
  </metadata>
  <responses>
    <response>
      <metadata>
        <target>server137</target>
        <status>success</status>
        <count>0</count>
      </metadata>
    </response>
  </responses>
</netapp-storage-response>
Was this page helpful? Yes No Submitting... Thank you

Comments