# Class CIM_LocallyAccessibleFileSystemSetting
extends CIM_SettingData

The LocallyAccessibleFileSystemSetting is a derived class of ScopedSettingData that specifies the attribute values set for a Filesystem that has been made locally accessible to the ComputerSystem. The ComputerSystem provides the scope (indicated via the ScopedSetting association).A FileSystem is 'locally accessible' to a ComputerSystem if a LocalAccessAvailable association exists between it and the ComputerSystem. This Setting provides further details on the functionality supported when locally accessible.When used as a setting for a FileSystem, these settings are associated with the FileSystem via the ElementSettingData association and cannot have undefined or NULL properties. When used to define a LocallyAccessibleFileSystemCapabilities via the SettingsDefineCapabilities association, these settings must be scoped to the ComputerSystem supported by the Capabilities element and cannot have undefined or NULL properties. Property values that represent an implementation-specific default can only be specified when this setting is used ina TemplateSettings parameter to the LocallyAccessibleFileSystemCapabilities.CreateGoalSettings() method.

### Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_SettingData
|
+--CIM_LocallyAccessibleFileSystemSetting

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | The LocallyAccessibleFileSystemSetting is a derived class of ScopedSettingData that specifies the attribute values set for a Filesystem that has been made locally accessible to the ComputerSystem. The ComputerSystem provides the scope (indicated via the ScopedSetting association).A FileSystem is 'locally accessible' to a ComputerSystem if a LocalAccessAvailable association exists between it and the ComputerSystem. This Setting provides further details on the functionality supported when locally accessible.When used as a setting for a FileSystem, these settings are associated with the FileSystem via the ElementSettingData association and cannot have undefined or NULL properties. When used to define a LocallyAccessibleFileSystemCapabilities via the SettingsDefineCapabilities association, these settings must be scoped to the ComputerSystem supported by the Capabilities element and cannot have undefined or NULL properties. Property values that represent an implementation-specific default can only be specified when this setting is used ina TemplateSettings parameter to the LocallyAccessibleFileSystemCapabilities.CreateGoalSettings() method.
Experimental | boolean | true
UMLPackagePath | string | CIM::System::FilesystemServices
Version | string | 2.43.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
CachingOptions | uint16 | 0
Description | string | An enumerated value that specifies if a local cache is supported by the operational file server when accessing the underlying operational file system.
Read | boolean | true
ValueMap | string | 0, 2, 3, 4, 5, .., 0x8000..
Values | string | Unknown, Not Supported, Asynchronized, Synchronized, Write-Through, DMTF Reserved, Vendor Defined
EnableOnSystemStart | uint16 | 0
Description | string | An enumerated value that specifies if local access from the operational file server to the operational file system should be enabled when the file server is started.
Read | boolean | true
ValueMap | string | 0, 2, 3, .., 0x8000..
Values | string | Vendor-specific Default, Automatic, Manual, DMTF Reserved, Vendor Defined
ExecutePref | uint16 | 0
Description | string | An enumerated value that specifies if support should be provided on the operational file server for executing elements contained in the operational file system accessed through this local access point. This may require setting up specialized paging or execution buffers either on the operational file server or on the operational file system side (as appropriate for the implementation). Note that this does not provide any rights to actually execute any element but only specifies support for such execution, if permitted.
Read | boolean | true
ValueMap | string | 0, 2, 3, .., 0x8000..
Values | string | Unknown, Execution Supported, Execution Not Supported, DMTF Reserved, Vendor Defined
FailurePolicy | uint16 | 0
Description | string | An enumerated value that specifies if the operation to make a FileSystem locally accessible to a scoping ComputerSystem should be attempted one or more times in the foreground or tried repeatedly in the background until it succeeds. The number of attempts would be limited by the corresponding RetriesMax property of the setting.
ModelCorrespondence | string | CIM_LocallyAccessibleFileSystemSetting.RetriesMax
Read | boolean | true
ValueMap | string | 0, 2, 3, .., 0x8000..
Values | string | Unknown, Foreground, Background, DMTF Reserved, Vendor Defined
InitialEnabledState | uint16 | 8
Description | string | InitialEnabledState is an integer enumeration that indicates the enabled/disabled states initially set for a locally accessible file system (LAFS). The element functions by passing commands onto the underlying filesystem, and so cannotindicate transitions between requested states because those states cannot be requested. The following text briefly summarizes the various enabled/disabled initial states: Enabled (2) indicates that the element will execute commands, will process any queued commands, and will queue new requests. Disabled (3) indicates that the element will not execute commands and will drop any new requests. In Test (7) indicates that the element will be in a test state. Deferred (8) indicates that the element will not process any commands but will queue new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes a restricted set of commands. All other requests are queued.
ModelCorrespondence | string | CIM_LocallyAccessibleFileSystemSetting.OtherEnabledState, CIM_EnabledLogicalElement.EnabledState
ValueMap | string | 0, 1, 2, 3, 7, 8, 9, 11..32767, 32768..65535
Values | string | Unknown, Other, Enabled, Disabled, In Test, Deferred, Quiesce, DMTF Reserved, Vendor Reserved
LockPolicy | uint16 | 0
Description | string | An enumerated value that specifies the Locking that will be enforced on the operational file system bythe operational file server when accessing it.'Enforce None' does not enforce locks. 'Enforce Write' does not allow writes to locked files. 'Enforce Read/Write' does not allow reads or writes to locked files.
Read | boolean | true
ValueMap | string | 0, 2, 3, 4, .., 0x8000..
Values | string | Unknown, Enforce None, Enforce Write, Enforce Read/Write, DMTF Reserved, Vendor Defined
OtherEnabledState | string |
Description | string | A string describing the element's initial enabled/disabled state when the InitialEnabledState property is set to 1 ("Other"). This property MUST be set to NULL when InitialEnabledState is any value other than 1.
ModelCorrespondence | string | CIM_LocallyAccessibleFileSystemSetting.InitialEnabledState, CIM_EnabledLogicalElement.OtherEnabledState
ReadBufferSizeMax | uint64 | 0
Description | string | An integer specifying the maximum number of bytes that may be allocated to each buffer used for reading. A value of '0' specifies an implementation-specific default.
ModelCorrespondence | string | CIM_LocallyAccessibleFileSystemSetting.ReadBufferSizeMin
Read | boolean | true
ReadBufferSizeMin | uint64 | 0
Description | string | An integer specifying the minimum number of bytes that must be allocated to each buffer used for reading. A value of '0' specifies an implementation-specific default.
ModelCorrespondence | string | CIM_LocallyAccessibleFileSystemSetting.ReadBufferSizeMax
Read | boolean | true
ReadWritePolicy | uint16 |
Description | string | An enumerated value that specifies the Read-Write policy set on the operational file system and supported by the operational file server when accessing it.'Read Only' specifies that the access to the operational file system by the operational file server is set up solely for reading. 'Read/Write' specifies that the access to the operational file system by the operational file server is set up for both reading and writing. 'Force Read/Write' specifies that 'Read-Only' has been over-ridden by a client with write access to the operational file system. This option is intended for use when the associated FileSystem has been made 'Read Only' by default, as might happen if it were created to be the target of a Synchronization or Mirror operation.
Read | boolean | true
ValueMap | string | 0, 2, 3, 4, .., 0x8000..
Values | string | Unknown, Read Only, Read/Write, Force Read/Write, DMTF Reserved, Vendor Defined
ReadWritePref | string |
Description | string | An instance of a CIM_Privilege, encoded as a string, that expresses the default client's expectations about access to elements contained in the operational file system. The provider is expected to surface this access using the CIM privilege model.
EmbeddedInstance | string | CIM_Privilege
Read | boolean | true
RequestRetryPolicy | uint16 | 0
Description | string | An enumerated value representing the policy that is supported by the operational file server on a request to the operational file system that either failed or left the file server hanging. If the request is being performed in the foreground, the options are to try once and fail if a timeout happens, or, to try repeatedly. If the request can be performed in the background, the request will be tried repeatedly until stopped.
ModelCorrespondence | string | CIM_LocallyAccessibleFileSystemSetting.TransmissionRetriesMax, CIM_LocallyAccessibleFileSystemSetting.RetransmissionTimeoutMin
Read | boolean | true
ValueMap | string | 0, 2, 3, 4, .., 0x8000..
Values | string | Unknown, Try Once, Try Again, Try in Background, DMTF Reserved, Vendor Defined
RetransmissionTimeoutMin | uint32 | 0
Description | string | An integer specifying the minimum number of milliseconds that the operational file server must wait before assuming that a request to the operational file system has failed. A value of '0' indicates an implementation-specific default.This is only relevant if there is a transmission channel between the operational file server and the operational file system.
ModelCorrespondence | string | CIM_LocallyAccessibleFileSystemSetting.TransmissionRetriesMax, CIM_LocallyAccessibleFileSystemSetting.RequestRetryPolicy
Read | boolean | true
RetriesMax | uint32 | 0
Description | string | An integer specifying the maximum number of attempts that should be made by the scoping ComputerSystem to make a Filesystem locally accessible.A value of '0' specifies an implementation-specific default.
ModelCorrespondence | string | CIM_LocallyAccessibleFileSystemSetting.FailurePolicy
Read | boolean | true
RootAccessPref | string |
Description | string | An instance of a CIM_Privilege, encoded as a string, that expresses the default expectations about privileged access by appropriately privileged System Administrative users on the operational file server ('root' or 'superuser') to theoperational file system and its elements. The provider is expected to surface this access using the CIM privilege model. Support for the privileged access might require setup at both the operational file server as well as the operational file system, so there is no guarantee that the request can be satisfied.
EmbeddedInstance | string | CIM_Privilege
Read | boolean | true
TransmissionRetriesMax | uint32 | 0
Description | string | An integer specifying the maximum number of retransmission attempts to be made from the operational file server to the operational file system when the transmission of a request fails or makes the file server hang. A value of '0' specifies an implementation-specific default.This is only relevant if there is a transmission channel between the file server and the underlying file system.
ModelCorrespondence | string | CIM_LocallyAccessibleFileSystemSetting.RequestRetryPolicy, CIM_LocallyAccessibleFileSystemSetting.RetransmissionTimeoutMin
Read | boolean | true
WriteBufferSizeMax | uint64 | 0
Description | string | An integer specifying the maximum number of bytes that may be allocated to each buffer used for writing. A value of '0' specifies an implementation-specific default.
ModelCorrespondence | string | CIM_LocallyAccessibleFileSystemSetting.WriteBufferSizeMin
Read | boolean | true
WriteBufferSizeMin | uint64 | 0
Description | string | An integer specifying the minimum number of bytes that must be allocated to each buffer used for writing. A value of '0' specifies an implementation-specific default.
ModelCorrespondence | string | CIM_LocallyAccessibleFileSystemSetting.WriteBufferSizeMax
Read | boolean | true
AttributeCaching | uint16[] |
ArrayType | string | Indexed
Description | string | An array of enumerated values that specify whether attribute caching is (or is not) supported by the operational file server when accessing specific typesof objects from the underlying operational file system.The object type and the support parameters are specified in the corresponding AttributeCachingObjects, AttributeCachingTimeMin, and AttributeCachingTimeMax array properties. Filesystem object types that can be accessed locally are represented by an entry in these arrays. The entry in the AttributeCaching array can be 'On', 'Off', or 'Unknown'. Implementation of this feature requires support from other system components, so it is quite possible that specifying 'On' may still not result in caching behavior. 'Unknown' indicates that the access operation will try to work with whatever options the operational file server and file system can support. In all cases, AttributeCachingTimeMin and AttributeCachingTimeMax provide the minimum and maximum time for which the attributes can be cached. When this Setting is used as a Goal, the client may specify 'Unknown', but the Setting in the created object should contain the supported setting, whether 'On' or 'Off'.
ModelCorrespondence | string | CIM_LocallyAccessibleFileSystemSetting.AttributeCachingObjects, CIM_LocallyAccessibleFileSystemSetting.AttributeCachingTimeMin, CIM_LocallyAccessibleFileSystemSetting.AttributeCachingTimeMax
Read | boolean | true
ValueMap | string | 0, 2, 3, .., 0x8000..
Values | string | Unknown, On, Off, DMTF Reserved, Vendor Defined
AttributeCachingObjects | uint16[] |
ArrayType | string | Indexed
Description | string | An array of enumerated values that specify the attribute caching support provided to various object types by the operational file server when accessing the underlying operational file system. Thesetypes represent the types of objects stored in a FileSystem -- files and directories as well as others that may be defined in the future. The corresponding properties, AttributeCaching, AttributeCachingTimeMin, and AttributeCachingTimeMax provide the supported features for the type of object. 'None' and 'All' cannot both be specified; if either one is specified, it must be the first entry in the array and the entry is interpreted as the default setting for all objects. If neither 'None' or 'All' are specified, the caching settings for other objects are defaulted by the implementation. If 'Rest' is specified, the entry applies to all known object types other than the named ones. If 'Unknown' is specified it applies to object types not known to this application (this can happen when foreign file systems are mounted.
ModelCorrespondence | string | CIM_LocallyAccessibleFileSystemSetting.AttributeCaching, CIM_LocallyAccessibleFileSystemSetting.AttributeCachingTimeMin, CIM_LocallyAccessibleFileSystemSetting.AttributeCachingTimeMax
Read | boolean | true
ValueMap | string | 0, 2, 3, 4, 5, 6, .., 0x8000..
Values | string | Unknown, None, All, Rest, File, Directory, DMTF Reserved, Vendor Defined
AttributeCachingTimeMax | uint32[] |
ArrayType | string | Indexed
Description | string | An array of integers specifying, in milliseconds, the maximum time for which an object of the type specified by the corresponding AttributeCaching property must be retained in the attribute cache. When used as a Goal, a value of '0' indicates an implementation-specific default.
ModelCorrespondence | string | CIM_LocallyAccessibleFileSystemSetting.AttributeCaching
Read | boolean | true
AttributeCachingTimeMin | uint32[] |
ArrayType | string | Indexed
Description | string | An array of integers specifying, in milliseconds, the minimum time for which an object of the type specified by the corresponding AttributeCaching property must be retained in the attribute cache. When used as a Goal, a value of '0' indicates an implementation-specific default.
ModelCorrespondence | string | CIM_LocallyAccessibleFileSystemSetting.AttributeCaching
Read | boolean | true
BuffersSupport | uint16[] |
Description | string | An array or enumerated values that specifies the buffering mechanisms supported by the operational file server for accessing the underlying operational file system.If supported, other properties will establish the level of support. If the property is NULL or the empty array, buffering is not supported.
ModelCorrespondence | string | CIM_LocallyAccessibleFileSystemSetting.ReadBufferSizeMax, CIM_LocallyAccessibleFileSystemSetting.ReadBufferSizeMin, CIM_LocallyAccessibleFileSystemSetting.WriteBufferSizeMax, CIM_LocallyAccessibleFileSystemSetting.WriteBufferSizeMin, CIM_LocallyAccessibleFileSystemSetting.AttributeCaching, CIM_LocallyAccessibleFileSystemSetting.AttributeCachingObjects, CIM_LocallyAccessibleFileSystemSetting.AttributeCachingTimeMin, CIM_LocallyAccessibleFileSystemSetting.AttributeCachingTimeMax
Read | boolean | true
ValueMap | string | 0, 2, 3, .., 0x8000..
Values | string | Attributes, Read, Write, DMTF Reserved, Vendor Defined

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
ChangeableType | uint16 | CIM_SettingData
ConfigurationName | string | CIM_SettingData
Description | string | CIM_ManagedElement
ElementName | string | CIM_SettingData
Generation | uint64 | CIM_ManagedElement
InstanceID | string | CIM_SettingData
SoID | string | CIM_SettingData
SoOrgID | string | CIM_SettingData
ComponentSetting | string[] | CIM_SettingData

## Class Methods