Update vFiler Template operation

The Update vFiler Template operation modifies the settings in a vFiler template.

The following table describes the elements for this request.

Adapter request elements for the Update vFiler Template operation

Element

Definition

Required

<operation-name>

Specifies the name of the operation: update-vfiler-template

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

<administrative-host-ip-address>

Specifies the IP Address of the vFiler's administrative host

By default, this field is empty.

No

<cifs-auth-type>

Specifies the CIFS authentication mode to be used for the CIFS setup of a vFiler

The <cifs-auth-type> determines the method by which clients will be authenticated while connecting to the CIFS service on the vFiler.

Valid values: "active_directory", "workgroup" (default)

No

<cifs-domain>

Specifies the active directory domain to which the vFiler joins to

The <cifs-domain> can be the NetBIOS or fully qualified domain name.

Examples: cifsdomain, cifs.domain.com.

Note

The <cifs-domain> element is applicable only when the <cifs-auth-type> is set to "active_directory".

No

<cifs-security-style>

Specifies the security style that determines whether or not the CIFS service on vFiler supports the multiprotocol access

Valid values: "ntfs", "multiprotocol" (default)

No

<description>

Specifies the description of the vFiler template

By default, this field is empty.

No

<dns-domain>

Specifies the name of the DNS domain for a vFiler that is setup using this vFiler template

By default, this field is empty.

No

<dns-servers>

Specifies the list of the DNS servers for a vFiler that is setup using this vFiler template

The IP address of each of these servers is provided using the <ip-address> element.

No

<nis-domain>

Specifies the name of the NIS domain for a vFiler that is setup using this vFiler template

By default, this field is empty.

No

<nis-servers>

Specifies the list of NIS servers for a vFiler that is setup using this vFiler template

The IP address of each of these servers is provided using the <ip-address> element.

No

<vfiler-template-id>

Specifies the identifier of the vFiler template

This value cannot be updated for a VFiler template.

Note

You must specify either <vfiler-template-id> or <vfiler-template-name> to modify a VFiler template.

Conditional

<vfiler-template-name>

Specifies the name of the vFiler template to be modified

Conditional; required if <vfiler-template-id> is not specified

<ip-address>

Specifies the IP address in the form of a string; can be up to 40 characters

No

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

Sample adapter request for the Update vFiler Template operation

<netapp-storage-request>
    <operation-name>update-vfiler-template</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 />
      <vfiler-template-id>3069</vfiler-template-id>
      <vfiler-template-name>test123</vfiler-template-name>
      <administrative-host-ip-address>172.1.1.1</administrative-host-ip-address>
      <description>test description</description>
      <dns-domain>test-dns-domain.com</dns-domain>
      <dns-servers>
        <ip-address>192.1.1.1</ip-address>
      </dns-servers>
      <cifs-auth-type>active_directory</cifs-auth-type>
      <cifs-domain>test-cifs-domain.com</cifs-domain>
      <cifs-security-style>multiprotocol</cifs-security-style>
      <nis-domain>test-nis-domain.com</nis-domain>
      <nis-servers>
        <ip-address>192.1.1.1</ip-address>
      </nis-servers>
    </arguments>
</netapp-storage-request>


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

Sample adapter response for the Update vFiler Template 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