Class CIM_FileImportService
extends CIM_Service

Provides configuration support for importing and hosting FileShares exported from other ComputerSystems. FileImportService is the base class managing the client-side application in a client-server-based shared file system. A FileImportService is hosted by a ComputerSystem and supports 'mounting' (binding to a name in a local namespace) a FileSystem element or a FileShare element exported by a remote ComputerSystem host. Specifically this local name will be a LogicalFile sub-element of a FileSystem hosted by the local ComputerSystem. The relationship between the mount-point and the Share is represented by a CIM_ImportedShare association. The FileSystem required here only needs to support a namespace for a LogicalFile (it need not support the full complexity of a LocalFileSystem, for instance, real storage). The namespace could be constructed using any provider-specific algorithm - if it is based on LocalFileSystem, it would be configured by a FileSystemConfigurationService, hosted by the same ComputerSystem, on a StorageExtent, also hosted by that ComputerSystem. The remote Share is identified by a durable Id - this is a string that represents a path that uniquely identifies the remote Share.

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

Name	Data Type	Value
Description	string	Provides configuration support for importing and hosting FileShares exported from other ComputerSystems. FileImportService is the base class managing the client-side application in a client-server-based shared file system. A FileImportService is hosted by a ComputerSystem and supports 'mounting' (binding to a name in a local namespace) a FileSystem element or a FileShare element exported by a remote ComputerSystem host. Specifically this local name will be a LogicalFile sub-element of a FileSystem hosted by the local ComputerSystem. The relationship between the mount-point and the Share is represented by a CIM_ImportedShare association. The FileSystem required here only needs to support a namespace for a LogicalFile (it need not support the full complexity of a LocalFileSystem, for instance, real storage). The namespace could be constructed using any provider-specific algorithm - if it is based on LocalFileSystem, it would be configured by a FileSystemConfigurationService, hosted by the same ComputerSystem, on a StorageExtent, also hosted by that ComputerSystem. The remote Share is identified by a durable Id - this is a string that represents a path that uniquely identifies the remote Share.
Experimental	boolean	true
UMLPackagePath	string	CIM::System::FileServices
Version	string	2.8.1000

Class Properties

Inherited Properties

Name	Data Type	Class Origin
Caption	string	CIM_ManagedElement
CommunicationStatus	uint16	CIM_ManagedSystemElement
CreationClassName	string	CIM_Service
Description	string	CIM_ManagedElement
DetailedStatus	uint16	CIM_ManagedSystemElement
ElementName	string	CIM_ManagedElement
EnabledDefault	uint16	CIM_EnabledLogicalElement
EnabledState	uint16	CIM_EnabledLogicalElement
Generation	uint64	CIM_ManagedElement
HealthState	uint16	CIM_ManagedSystemElement
InstallDate	datetime	CIM_ManagedSystemElement
InstanceID	string	CIM_ManagedElement
Name	string	CIM_Service
OperatingStatus	uint16	CIM_ManagedSystemElement
OtherEnabledState	string	CIM_EnabledLogicalElement
PrimaryOwnerContact	string	CIM_Service
PrimaryOwnerName	string	CIM_Service
PrimaryStatus	uint16	CIM_ManagedSystemElement
RequestedState	uint16	CIM_EnabledLogicalElement
Started	boolean	CIM_Service
StartMode	string	CIM_Service
Status	string	CIM_ManagedSystemElement
SystemCreationClassName	string	CIM_Service
SystemName	string	CIM_Service
TimeOfLastStateChange	datetime	CIM_EnabledLogicalElement
TransitioningToState	uint16	CIM_EnabledLogicalElement
AvailableRequestedStates	uint16[]	CIM_EnabledLogicalElement
OperationalStatus	uint16[]	CIM_ManagedSystemElement
StatusDescriptions	string[]	CIM_ManagedSystemElement

Class Methods

Local Class Methods

CreateImportedShare (uint16)

Method Qualifiers (CreateImportedShare)

Name	Data Type	Value
Description	string	Start a Job to import a share exported by a remote host. If 0 is returned, the method completed successfully and no ConcreteJob instance was required. If 0x1000 is returned, a ConcreteJob will be started to import the Share. The Job's Reference will be returned in the OUT parameter Job. If the method is successful, a CIM_FileShare will be created, hosted (via CIM_HostedShare) by the ComputerSystem host of this service. A reference to the FileShare will be returned in TheShare. The created FileShare will be mounted on a local mount-point (possibly a file/directory of a local file system) with the CIM_ImportedShare association. This method MUST return a CIM_Error representing that a single named property of a setting (or other) parameter (either reference or embedded object) has an invalid value or that an invalid combination of named properties of a setting (or other) parameter (either reference or embedded object) has been requested. The remote Share is specified by the IN parameter TheRemote, which can be either a CIM_FileShare or a CIM_FileSystem and therefore is typed as a CIM_EnabledLogicalElement. Goal is a CIM_ImportedFileShareSetting element encoded as a string-valued EmbeddedInstance; this allows the client to specify the properties desired for the share. The associated CIM_HostedShare.RemoteWWN property will hold the name of TheRemote file share.
ValueMap	string	0, 1, 2, 3, 4, 5, 6, .., 0x1000, 0x1001..0x7FFF, 0x8000..
Values	string	Job Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Mount-point already in use, Failed, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (CreateImportedShare)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
Goal	string
		Description	string	The client-specified requirements for how the specified FileShare element is to be shared or imported by the FileImportService. This is an element of the CIM_ImportedFileShareSetting class, or a derived class, encoded as a string-valued embedded object parameter. If NULL or the empty string, the default configuration will be specified by the FileImportService.
		EmbeddedInstance	string	CIM_ImportedFileShareSetting
		IN	boolean	true
MountPointPath	string
		Description	string	A string representing a path to the mount-point attached to the share from the element indicated by Root. If MountPointPath is NULL or the empty string, it indicates the FileSystem element indicated by Root. It is an error if the element indicated by MountPointPath is already in use as a mount-point (has a CIM_ImportedShare association). If both Root and MountPointPath are NULL, it would be considered an attempt to reuse a mount-point and would also return an error.
		IN	boolean	true
AccessPointPorts	CIM_RemotePort[]
		ArrayType	string	Indexed
		Description	string	An array of references to RemotePorts that this Share may use to connect to the remote Share, if the CIM_ImportedFileShareSettings.AccessPoints property is set to 'Named Ports'. The array will be processed in index order. If the array is NULL, or an entry in the array is NULL, all access points supported by the remote share will be surfaced as RemotePorts and made available. If the array is empty, no access points will be made available. All the RemotePorts will be associated with the created FileShare via the SAPAvailableForElement association.
		IN	boolean	true
		ModelCorrespondence	string	CIM_ImportedFileShareSetting.AccessPoints
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (may be null if job completed).
		IN	boolean	false
		OUT	boolean	true
Root	REF CIM_LogicalElement
		Description	string	A reference indicating an element whose sub-element is the mount-point. The class that Root references must be a FileSystem, or a FileShare that has an ImportedShare association (or a derived class of ImportedShare) to a LogicalFile (or Directory), or a LogicalFile (or Directory) that has a AttachedElement association to a FileShare or FileSystem. If Root is NULL, it indicates the root of the FileImportService host's default local FileSystem, that is used as the default local name space. It is a requirement that the host of the FileImportService must be the host for the newly created FileShare, as well as the host for the FileSystem or FileShare indicated by Root.
		IN	boolean	true
TheRemote	REF CIM_EnabledLogicalElement
		Description	string	A reference to the remote FileShare or FileSystem that is to be imported.
		IN	boolean	true
TheShare	REF CIM_FileShare
		Description	string	This specifies the FileShare element (or its derived class) that is created by the method, if successful.
		OUT	boolean	true

ModifyImportedShare (uint16)

Method Qualifiers (ModifyImportedShare)

Name	Data Type	Value
Description	string	Start a Job to modify an imported share. If 0 is returned, the method completed successfully and no ConcreteJob instance was required. If 0x1000 is returned, a ConcreteJob will be started to modify the Share. The Job's Reference will be returned in the OUT parameter Job. If the Job succeeds, the FileShare will be modified and re-configured and ready to be enabled. A reference to the FileShare will be returned in TheShare. The FileShare will have a HostedShare association to the host ComputerSystem, as before. This method MUST return a CIM_Error representing that a single named property of a setting (or other) parameter (either reference or embedded object) has an invalid value or that an invalid combination of named properties of a setting (or other) parameter (either reference or embedded object) has been requested. This method cannot be used to change the remotely shared entity or the mount point in the local namespace, but a provider may support changing the pathname to the mount-point by specifying Root and/or MountPointPath. The reference parameter Root indicates the FileSystem or FileShare whose element provides the mount-point, either directly, or indirectly by specifying a Directory element that is associated via MountedElement to the FileSystem or FileShare. The FileSystem or FileShare so indicated cannot be changed by this method. The parameter MountPointPath indicates the mount-point element within the file hierarchy by a path relative to the Root. If the Root is a FileSystem, this path begins at the root directory of the FileSystem; if the Root is a FileShare, this path begins at the directory associated to the FileShare via MountedElement; if the Root is a Directory, this path begins at that Directory. If this path is modified, it must still indicate the same terminal element. Goal is a CIM_ImportedFileShareSetting element encoded as a string-valued embedded object parameter; this allows the client to specify the properties desired for the share. If the method is successful, it will return a reference to the same CIM_FileShare in the INOUT parameter TheShare. The settings for the FileShare and the ServiceAccessPoint associations may change, but the HostedShare and ServiceAffectsElement associations to the share must not be changed by this method. The input TheShare must not be NULL.
ValueMap	string	0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, .., 0x1000, 0x1001..0x7FFF, 0x8000..
Values	string	Job Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, FileImportService Not Accessible, Root is not accessible, Base Directory element of Root is Not Accessible, Path does not specify a mount point element, Share in use, cannot be Modify, Failed, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (ModifyImportedShare)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
Goal	string
		Description	string	The client-specified requirements for how the import settings for the specified FileShare element are to be modifed by the FileImportService. This operation cannot be performed on a FileShare that not already imported (implying that it is currently only exported). Goal is an element of the CIM_ImportedFileShareSetting class, or a derived class, encoded as a string-valued embedded object parameter. If NULL or the empty string, the existing configuration must include an ImportedFileShareSetting which may be unchanged. Any differences in property values will be resolved by the FileImportService and CIM_Errors generated if appropriate.
		EmbeddedInstance	string	CIM_ImportedFileShareSetting
		IN	boolean	true
InUseOptions	uint16
		Description	string	An enumerated integer that specifies the action that the provider should take if the FileShare is still in use when this request is made. The WaitTime parameter indicates the 'specified time' used for this function. This option is only relevant if the FileShare must be made unavailable while the request is being executed.
		IN	boolean	true
		ValueMap	string	2, 3, 4, .., 0x1000..0xFFFF
		Values	string	Do Not Execute Request, Wait for specified time, then Execute Request Immediately, Attempt Quiescence for specified time, then Execute Request Immediately, DMTF Reserved, Vendor Defined
MountPointPath	string
		Description	string	A string representing a path to the mount point from the element indicated by Root. If the FileShare being modified is currently exported or imported, this parameter should specify the same mount point element, even if via a different path. If MountPointPath is NULL, it indicates no change to the current path. If MountPointPath is the empty string, it indicates the FileSystem element indicated by Root.
		IN	boolean	true
WaitTime	uint32
		Description	string	An integer that indicates the time (in seconds) that the provider must wait before executing this request if it cannot be made while the share is in use. If WaitTime is not zero, the method will create a job, if supported by the provider, and return immediately. If the provider does not support asynchronous jobs, there is a possibility that the client could time-out before the job is completed. The combination of InUseOptions = '4' and WaitTime ='0' (the default) is interpreted as 'Wait (forever) until Quiescence, then Execute Request' and will be performed asynchronously if possible.
		IN	boolean	true
		PUnit	string	second
		Units	string	seconds
AccessPointPorts	CIM_RemotePort[]
		ArrayType	string	Indexed
		Description	string	An array of references to RemotePorts that this Share may use to connect to the remote Share, if the CIM_ImportedFileShareSettings.AccessPoints property is set to 'Named Ports'. The array will be processed in index order and added to the existing set of RemotePorts. If the array is NULL, the existing set will not be changed. If an entry in the array is NULL, all access points supported by the remote share will be surfaced as RemotePorts and made available. If the array is empty, no access points will be made available, and existing access points will be disabled. All the RemotePorts will be associated with the created FileShare via the SAPAvailableForElement association.
		IN	boolean	true
		ModelCorrespondence	string	CIM_ImportedFileShareSetting.AccessPoints
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (may be null if job completed).
		IN	boolean	false
		OUT	boolean	true
Root	REF CIM_LogicalElement
		Description	string	A reference indicating an element whose sub-element is the mount point. The class that Root references must be a FileSystem, a FileShare that has an ImportedShare association (or a derived class of ImportedShare) to a LogicalFile (or Directory), or a LogicalFile (or Directory) that has a MountedElement association to a FileShare or FileSystem. If the FileShare being modified is currently exported or imported, this parameter should indicate the same Root FileSystem or FileShare element. If Root is NULL, it indicates no change to the current root.
		IN	boolean	true
TheShare	REF CIM_FileShare
		Description	string	TheShare indicates the FileShare element that is to be modified and must be an existing imported FileShare.
		IN	boolean	true
		OUT	boolean	true

ReleaseImportedShare (uint32)

Method Qualifiers (ReleaseImportedShare)

Name	Data Type	Value
Description	string	Start a Job to release an imported FileShare. If 0 is returned, the method completed successfully and no ConcreteJob instance was required. If 0x1000 is returned, a ConcreteJob will be started to release the Share. The Job's reference will be returned in the OUT parameter Job. If the method is successful, the FileShare element will not be imported anymore. This method cannot be called if the FileShare element is also being exported - the FileExportService.ReleaseExportedShare method must be called first. If InUseOptions are specified, this method will succeed only if no more clients are accessing the share.
ValueMap	string	0, 1, 2, 3, 4, 5, 10, .., 0x1000, 0x1001..0x7FFF, 0x8000..
Values	string	Job Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Share in use, Failed, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (ReleaseImportedShare)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
InUseOptions	uint16
		Description	string	An enumerated integer that specifies the action that the provider should take if the FileShare is still in use when this request is made. The WaitTime parameter indicates the 'specified time' used for this function.
		IN	boolean	true
		ValueMap	string	2, 3, 4, .., 0x1000..0xFFFF
		Values	string	Do Not Release, Wait for specified time, then Release Immediately, Attempt Quiescence for specified time, then Release Immediately, DMTF Reserved, Vendor Defined
WaitTime	uint32
		Description	string	An integer that indicates the time (in seconds) that the provider must wait before releasing this FileShare. If WaitTime is not zero, the method will create a job, if supported by the provider, and return immediately. If the provider does not support asynchronous jobs, there is a possibility that the client could time-out before the job is completed. The combination of InUseOptions = '4' and WaitTime ='0' (the default) is interpreted as 'Wait (forever) until Quiescence, then Release' and will be performed asynchronously if possible.
		IN	boolean	true
		PUnit	string	second
		Units	string	seconds
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (may be null if job completed).
		IN	boolean	false
		OUT	boolean	true
TheShare	REF CIM_FileShare
		Description	string	The imported FileShare to be released.
		IN	boolean	true

Inherited Class Methods

Name	Return Type	Class Origin
ChangeAffectedElementsAssignedSequence	uint32	CIM_Service
RequestStateChange	uint32	CIM_EnabledLogicalElement
StartService	uint32	CIM_Service
StopService	uint32	CIM_Service

Class CIM_FileImportServiceextends CIM_Service

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

Class Hierarchy

Direct Known Subclasses

Class Qualifiers