modifyVolumeInfo

Modifies the quota or enabled attributes on an NSS logical volume.

Request

<modifyVolumeInfo>
   <volumeName/>
   <basicInfo>
      <mountPoint/>
   </basicInfo>
   <volumeQuota quota=" "/>
   <volumeReadAhead=" "/>
   <enabledAttributes>
      <salvage enabled=" "/>
      <compression enabled=" "/>
      <directoryQuota enabled=" "/>
      <userQuota enabled=" "/>
      <flushFiles enabled=" "/>
      <mfl enabled=" "/>
      <snapshot enabled=" "/>
      <backup enabled=" "/>
      <shredding count=" "/>
      <migration enabled=" "/>
      <userTransaction enabled=" "/>
      <noAccessTime enabled=" "/> 
   </enabledAttributes>
   <mountPoint/>
   <mountPointRename/>
   <nameSpace/>
</modifyVolumeInfo>

Reply

<modifyVolumeInfo> 
   <result value=" ">
      <description/>
   </result>
</modifyVolumeInfo>

Elements

volumeName

Specifies the name of the NSS logical volume whose properties need to be modified.

basicInfo

Specifies the basic information for the volume.

mountPoint

Linux only. Specifies the volume's mount point.

volumeQuota

(Optional) Specifies the NSS logical volume's quota is to be modified.

volumeReadAhead

Specifies the number of read ahead blocks (multiple of 4096 bytes) to be used when reading data from the volume.

enabledAttributes

(Optional) Specifies that the state of one or more enabled attributes of a volume is to be modified.

salvage

(Optional) Specifies to enable or disable salvage.

compression

(Optional) Specifies to enable or disable compression.

directoryQuota

(Optional) Specifies to enable or disable directory quotas.

userQuota

(Optional) Specifies to enable or disable user quotas.

flushFiles

(Optional) Specifies to enable or disable flush on close.

mfl

(Optional) Specifies to enable or disable the modified files list.

snapshot

(Optional) Specifies to enable or disable file level snapshotting.

backup

(Optional) Specifies to enable or disable the backup flag.

shredding

(Optional) Specifies to enable or disable data shredding.

migration

(Optional) Specifies to enable or disable migration. Not currently implemented.

userTransaction

(Optional) Specifies to enable to disable the user transaction feature.

mountPoint

(Optional) Specifies the mount point for the volume (to support the Linux platform). For example

<mountPoint>/media/nss/volname</mountPoint>
mountPointRename

(Optional) Specifies that the mount point is renamed if the volume is renamed (to support the Linux platform). This feature works only if the volume is mounted in its default location.

nameSpace

Specifies the default namespace for requests to the volume (to support the Linux platform):

  • long
  • unix
  • mac
  • dos
result

Specifies an error value or 0 (for no error).

description

Specifies a text description of the returned result.

Attributes

quota

Specifies the maximum size (in bytes) to which the volume is allowed to grow. A value of none specifies that the volume is allowed to use any free space in the pool.

enabled

Specifies whether to enable the option:

  • “yes” Enable the option
  • “no” Disable the option

The quotes are required.

count

Specifies whether to enable the data shredding option:

  • 1-7 Enable the option
  • 0 Disable the option

Remarks

Note that volumes cannot be encrypted or unencrypted after they are created.

Example

The following command sets the quota for the volume to none, which allows it to grow to the size of the pool and sets up the various enabled attributes:

<nssRequest>
   <volume>
      <modifyVolumeInfo>
         <volumeName>MYVOL</volumeName>
         <volumeQuota quota="none"/>
         <enabledAttributes>
            <salvage enabled="yes"/>
            <compression enabled="no"/>
            <directoryQuota enabled="yes"/>
            <userQuota enabled="yes"/>
            <flushFiles enabled="no"/>
            <mfl enabled="no"/>
            <snapshot enabled="no"/>
            <backup enabled="yes"/>
            <shredding count="2"/>
            <migration enabled="no"/>
            <userTransaction enabled="no"/>
         </enabledAttributes>
      </modifyVolumeInfo>
   </volume>
 </nssRequest>

A nssReply packet to modify volume information command follows:

<nssReply>
   <volume>
      <modifyVolumeInfo>
         <result value="0">
            <description/>success</description>
         </result>
      </modifyVolumeInfo>
   </volume>

   <result value="0">
      <description/>zOK</description>
   </result>
</nssReply>