×
 
 
  •  
$helper.renderConfluenceMacro('{bmc-global-announcement:$space.key}')

Unsupported content

 

This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.
BMC Atrium Orchestrator Content 20.16.03 ... Application adapters NetApp Storage adapter NetApp Storage actor adapter requests and responses VFiler operations

Create vFiler operation

The Create vFiler operation creates a new vFiler on a storage system. A vFiler can be created by:

  • Specifying the filer on which to create it
  • Specifying a resource pool: In this case, a filer is selected from the resource pool based on the required licenses and in-built resource selection algorithm to evenly balance space and load in the resource pool, then a vFiler is created on the selected filer. 


The following table describes the elements for this request.

Adapter request elements for the Create vFiler operation

Element

Definition

Required

<operation-name>

Specifies the name of the operation: create-vfiler

Yes

<arguments>

Specifies a list of arguments that is required for this 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

<name>

Specifies the name of the new vFiler

A vFiler name can be of maximum 64 characters and only alphabets, numbers, hyphens and underscore characters are allowed in it.

Yes

<resource-name-or-id>

Specifies the name or identifier of the hosting filer or resource pool from which the new vFiler is provisioned

Yes

<allowed-protocols>

Specifies the list of protocols that needs to be allowed access to the vFiler

If not specified, none of the protocols are allowed on the vFiler.

No

<protocol>

Specifies the name of the protocol

This element is required if the list of allowed protocols is being specified.

Valid values: nfs, cifs, iscsi

No

<dry-run>

Checks whether a vFiler can be created on the given <resource-name-or-id>

The hosting filer on which the vFiler is created is returned. If there are any errors because of which a vFiler cannot be created on the given <resource-name-or-id>, the API generates an error.

No changes are made to the <resource-name-or-id> when the <dry-run> is TRUE.

Valid values: true, false (default)

No

<ip-address>

Specifies the IP address of the new vFiler

Note

The <ip-address> is not required when the API is run in the dry-run mode.

Conditional

<ipspace>

Specifies the IP Space of the new vFiler

The IP Space name can be of maximum 64 characters and only alphabets, numbers, hyphens and underscore characters are allowed in it. If not specified, vFiler is created in the "default-ipspace".

No

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

Sample adapter request for the Create vFiler operation 

<netapp-storage-request>
    <operation-name>create-vfiler</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 />
      <name>testfiler-1</name>
      <resource-name-or-id>172.11.11.111</resource-name-or-id>
      <ip-address>172.11.11.112</ip-address>
      <dry-run>false</dry-run>
      <allowed-protocols>
        <protocol>nfs</protocol>
      </allowed-protocols>
      <ipspace>test-ipspace</ipspace>
    </arguments>
  </netapp-storage-request>


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

Sample adapter response for the Create vFiler operation 

<netapp-storage-response>
  <metadata>
    <status>success</status>
    <response-count>1</response-count>
  </metadata>
  <responses>
    <response>
      <metadata>
        <target>server137</target>
        <status>success</status>
        <count>5</count>
      </metadata>
      <output>
        <vfiler-id>2878</vfiler-id>
        <root-volume-id>2875</root-volume-id>
        <root-volume-name>testfiler-1:/testfiler_1_root_1</root-volume-name>
        <filer-id>2065</filer-id>
        <filer-name>filer1.xyz.com</filer-name>
      </output>
    </response>
  </responses>
</netapp-storage-response>
Was this page helpful? Yes No Submitting... Thank you
Last modified by Deepa Bhat on May 05, 2016
vfiler netapp_storage

Comments

Log in or register to comment.

VFiler operations
Delete vFiler operation
© Copyright 2024 BMC Software, Inc.
Legal notices

Powered by Atlassian Confluence and Scroll Viewport

© Copyright 2005-2024 BMC Software, Inc. Use of this site signifies your acceptance of BMC’s Terms of Use . BMC, the BMC logo, and other BMC marks are assets of BMC Software, Inc. These trademarks are registered and may be registered in the U.S. and in other countries.