Version notice:
ARX::Share::Configuration¶
Introduced : ARX V6.02.000
This structure contains the configuration of a share on a managed
volume. CLI References: share (gbl-ns-vol).
| Member | Type | Description |
| name | String | The share’s name. CLI References: share (gbl-ns-vol). |
| description | String | A description for this share. CLI References: description (gbl-ns-vol-shr). |
| cifs_access_based_enum_exclude | boolean | A flag indicating that the share does not support CIFS access-based enumeration. CLI References: cifs access-based-enum exclude (gbl-ns-vol-shr). |
| cifs_recall_offline_timeout | long | The timeout to mark share to recall a file if offline bit is set. |
| critical | boolean | A flag indicating that the share is critical. CLI References: critical (gbl-ns-vol-shr). |
| attached_directories | DirAttachConfiguration [] | A list of direct attached directories on a direct-mapped share to the volume. CLI References: attach (gbl-ns-vol-shr). |
| file_servers | FileServerConfiguration [] | A list of source exports/shares for this share. CLI References: filer (gbl-ns-vol-shr). |
| freespace_adjust | long | A delta value to add to the share free space value. CLI References: freespace adjust (gbl-ns-vol-shr). |
| freespace_ignore | boolean | A flag indicating that free space from this share is not included in free space reported to the client. CLI References: freespace ignore (gbl-ns-vol-shr). |
| ignore_sid_errors | boolean | A flag indicating that this share ignores invalid SID errors from file server. CLI References: ignore-sid-errors (gbl-ns-vol-shr). |
| import_priority | long | The import priority for this share. CLI References: import priority (gbl-ns-vol-shr). |
| import_rename_directory | boolean | This flag permits the managed volume to rename directories in this share during import. CLI References: import rename-directories (gbl-ns-vol-shr). |
| import_rename_directory_unmapped_unicode | boolean | This flag indicating that unmapped unicode characters are converted to an ASCII representation. CLI References: import rename-directories (gbl-ns-vol-shr). |
| import_rename_files | boolean | This flag permits the managed volume to rename files in this share during import. CLI References: import rename-files (gbl-ns-vol-shr). |
| import_skip_managed_check | boolean | This flag prevents the managed volume for checking this share’s directories. CLI References: import skip-managed-check (gbl-ns-vol-shr). |
| import_sync_attributes | boolean | The flag allows the managed volume to instead synchronize the directories attributes, rather than renaming them. CLI References: import sync-attributes (gbl-ns-vol-shr). |
| migrate_retain_files | boolean | This flag lets the share to keep copies of files that are migrated to other locations. CLI References: migrate retain-files (gbl-ns-vol-shr). |
| replica_snap | boolean | This share is snapshot only. CLI References: replica-snap (gbl-ns-vol-shr). |
| sid_translation | boolean | This flag enables SID translation for this share. CLI References: sid-translation (gbl-ns-vol-shr). |
| strict_attribute_consistency | boolean | The enforcement of strict attribute consistency for this share in a multi-protocol volume. CLI References: strict-attribute-consistency (gbl-ns-vol-shr). |
| policy | PolicyConfiguration | The maintain and resume-migrate free space thresholds for the share. CLI References: policy freespace (gbl-ns-vol-shr). |
| enable | boolean | Enable/disable a share in a volume. CLI References: enable (gbl-ns-vol-shr). |
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.