ARX::Volume::Configuration¶
Introduced : ARX V6.02.000
This structure defines the configuration parameters of a managed
volume. You can find more details in the Volume section in the CLI
Reference Guide. CLI References: Volume.
| Member | Type | Description |
| name | String | The volume’s name. CLI References: volume (gbl-ns). |
| description | String | The description of this volume. CLI References: description (gbl-ns-vol). |
| direct | boolean | A flag indicating whether this volume contains managed shares or direct-mapped shares. CLI References: direct (gbl-ns-vol). |
| freespace_mode | FreespaceMode | A flag indicating how this volume calculates the free space. CLI References: freespace calculation manual (gbl-ns-vol), freespace calculation dir-master-only (gbl-ns-vol). |
| freespace_cifs_quota | boolean | A flag indicating whether this volume takes the back-end quotas into freespace calculation. CLI References: freespace cifs-quota (gbl-ns-vol). |
| metadata_critical | boolean | A flag indicating whether the metadata share is an HA critical resource. CLI References: metadata critical (gbl-ns-vol). |
| metadata_shares | MetadataShareConfiguration [] | A list of metadata share configurations. CLI References: metadata share (gbl-ns-vol). |
| modify | boolean | A flag indicating whether this volume is allowed to modify storage. CLI References: modify (gbl-ns-vol). |
| reimport_modify | boolean | A flag indicating that NSCK rebuild of this volume can modify storage devices. CLI References: reimport-modify (gbl-ns-vol). |
| reserved_files | long | Number of files to reserve for this volume. CLI References: reserve files (gbl-ns-vol). |
| shadow | boolean | A flag indicating whether this volume is a shadow volume. CLI References: shadow (gbl-ns-vol). |
| volume_group_id | long | The volume group identifier. CLI References: volume-group (gbl-ns-vol). |
| auto_reserve_files | boolean | Enable/disable automatic reservation of resources. CLI References: auto reserve files (gbl-ns-vol). |
| auto_sync_files | boolean | Enable/disable automatic sync files functionality. CLI References: auto sync files (gbl-ns-vol). |
| auto_sync_rename_files | boolean | Enable/disable renaming of files in the case of a name collision. CLI References: auto sync files (gbl-ns-vol). |
| cifs_access_based_enum | boolean | Enable/disable this volume to check access-based enumeration settings of its shares. CLI References: cifs access-based-enum (gbl-ns-vol). |
| cifs_access_based_enum_auto_enable | boolean | Enable access-based-enum consistency checking when shares are enabled. CLI References: cifs access-based-enum (gbl-ns-vol). |
| cifs_case_sensitive | boolean | Enable/disable case-sensitivity for CIFS volumes. CLI References: cifs case-sensitive (gbl-ns-vol). |
| cifs_compressed_files | boolean | Enable/disable compressed files support by CIFS. CLI References: compressed-files (gbl-ns-vol). |
| cifs_deny_symlinks | boolean | Diable/ensable dereferencing of symlinks via CIFS. CLI References: cifs deny-symlinks (gbl-ns-vol). |
| cifs_file_server_subshares | boolean | Enable/disable file server subshares for CIFS volumes. CLI References: filer-subshares (gbl-ns-vol). |
| cifs_file_server_subshares_native_names_only | boolean | A flag indicating that automatic generation of backend subshare names is disallowed. CLI References: filer-subshares (gbl-ns-vol). |
| cifs_file_system_name | String | The file system name returned to clients. CLI References: cifs file-system-name (gbl-ns-vol). |
| cifs_named_streams | boolean | Enable/disable named data streams support by CIFS. CLI References: named-streams (gbl-ns-vol). |
| cifs_notify_change_mode | CifsNotifyChangeModeType | The CIFS handling of Notify-Change requests. CLI References: cifs notify-change-mode (gbl-ns-vol). |
| cifs_oplocks | CifsOpLockType | Disable/enable oplock requests from CIFS clients. CLI References: cifs oplocks-disable (gbl-ns-vol). |
| cifs_path_cache | boolean | Enable/disable CIFS path cache. CLI References: cifs path-cache (gbl-ns-vol). |
| cifs_persistent_acls | boolean | Enable/disable file security support by CIFS. CLI References: persistent-acls (gbl-ns-vol). |
| cifs_sparse_files | boolean | Enable/disable sparse files support by CIFS. CLI References: sparse-files (gbl-ns-vol). |
| cifs_unicode_on_disk | boolean | Enable/disable unicode filenames support by CIFS. CLI References: unicode-on-disk (gbl-ns-vol). |
| nfs_rsize | long | The size of the NFS read packet. The valid size is 1024, 2048, 4096, 8192, 16384, 32768 and 65536 bytes. CLI References: nfs-param (gbl-ns-vol). |
| nfs_wsize | long | The size of the NFS write packet. The valid size is 1024, 2048, 4096, 8192, 16384, 32768 and 65536 bytes. CLI References: nfs-param (gbl-ns-vol). |
| policy_pause_schedule | String | A schedule that controls when the policies in the volume are paused. CLI References: policy pause (gbl-ns-vol). |
| snapshot_consistency | boolean | Enable/disable VIP fencing for snapshot operations. CLI References: snapshot consistency (gbl-ns-vol). |
| snapshot_display | SnapshotDirectoryDisplayType | The client display of snapshot directory. CLI References: snapshot directory display (gbl-ns-vol). |
| snapshot_display_hidden | boolean | The DOS ‘hidden’ attribute on of snapshot directory. CLI References: snapshot directory display (gbl-ns-vol). |
| snapshot_directory_cifs | String | The directory name for CIFS snapshots in this volume. CLI References: snapshot directory cifs-name (gbl-ns-vol). |
| snapshot_directory_nfs | String | The directory name for NFS snapshots in this volume. CLI References: snapshot directory nfs-name (gbl-ns-vol). |
| snapshot_privileged_access | boolean | A flag indicates whether snapshot directory access is restricted to privileged users. CLI References: snapshot privileged-access (gbl-ns-vol). |
| snapshot_vss_mode | VssModeType | The Windows Volume Shadow Services mode. CLI References: snapshot vss-mode (gbl-ns-vol). |
| enable | boolean | Enable/disable the volume. CLI References: enable (gbl-ns-vol). |
See Also¶
Warning
The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.
Sample Code¶
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.