Class CIM_FileServerConfigurationService
extends CIM_Service

This service provides active management for a FileServer. It supports the creation, modification, and deletion of FileServer elements and ConcreteJobs for long-runningtasks. In addition, it supports the creation, modification, and deletion of IP Interfaces associated with a given FileServer.

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

Class Hierarchy

Direct Known Subclasses

Class Qualifiers

Name	Data Type	Value
Description	string	This service provides active management for a FileServer. It supports the creation, modification, and deletion of FileServer elements and ConcreteJobs for long-runningtasks. In addition, it supports the creation, modification, and deletion of IP Interfaces associated with a given FileServer.
UMLPackagePath	string	CIM::System::FileServices
Version	string	2.45.0

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
LoSID	string	CIM_Service
LoSOrgID	string	CIM_Service
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

CreateFileServer (uint32)

Method Qualifiers (CreateFileServer)

Name	Data Type	Value
Description	string	CreateFileServer creates a FileServer and returns a reference to it as the value of the parameter TheElement.The FileServer shall be an instance of ComputerSystem with Dedicated="FileServer". Even if this operation does not complete but creates a ConcreteJob, an implementation may return a valid reference in TheElement. If the job fails subsequently, it is possible for this reference to become invalid. The desired settings for the FileServer are specified by several parameters (string-valued EmbeddedInstance elements of the appropriate class). A new FileServerSettings element that represents the settings of the FileServer shall be associated via ElementSettingData to the FileServer. In addition, new instances of CIFSSettingData, NFSSettingData, NISSettingData, IPInterfaceSettingData, and DNSSettingData shall be associated with the FileServerSettings element via ConcreteComponent. The IPInterfaceSettingData shall be used to 1) create an instance of IPProtocolEndPoint that shall be associated with the FileServer via HostedAccessPoint. 2) create an instance of NetworkVLAN and associate it with the IPProtocolEndPoint via MemberOfCollection, and 3) create an instance of TCPProtocolEndPoint associating it with the FileServer via HostedAccessPoint. The HostingComputerSystem identifies the ComputerSystem that is hosting the FileServer. A HostedDependency association shall be created to associate this ComputerSystem with the FileServer. The EthernetPort parameter is used to create an association between the EthernetPort's LANEndPoint and IPProtocolEndpoint, and to associate the EthernetPort with the CIFS and NFS ProtocolEndPoints via DeviceSAPImplementation. The NASComputerSystem is used to associate the new FileServer with the NAS system via ComponentCS
ValueMap	string	0, 1, .., 4096, 4098..32767, 32768..65535
Values	string	Job Completed with No Error, Failed, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (CreateFileServer)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
CIFSSettingData	string
		Description	string	The CIFSSettingData that specifies the CIFS settings for the FileServer being created. If this is NULL, the FileServer shall not have CIFS enabled and the resulting CIFSSettingData instance created shall have its "Enabled" property set to false. The CIFSSettingData instance will be returned on output.
		EmbeddedInstance	string	CIM_CIFSSettingData
		OUT	boolean	true
DNSSettingData	string
		Description	string	The DNSSettingData that specifies the DNS settings for the FileServer being created. If this is NULL, the FileServer shall not have access to a DNS server and a DNSSettingData instance shall not be instantiated for the FileServer.
		EmbeddedInstance	string	CIM_DNSSettingData
		OUT	boolean	true
ElementName	string
ElementName	string	Description	string	An end user relevant name for the file server being created. The value shall be stored in the 'ElementName' property for the created element. This parameter shall not be NULL or the empty string.
FileServerSettings	string
		Description	string	The FileServerSettings for the newly created FileServer. If NULL or the empty string, a default FileServerSettings shall be used and returned on output.
		EmbeddedInstance	string	CIM_FileServerSettings
		OUT	boolean	true
IPInterfaceSettingData	string
		Description	string	The IPInterfaceSettingData that specifies the IP Interface that the FileServer will use for servicing all CIFS and NFS requests. If NULL or the empty string, a default IPInterfaceSettingData shall be used and returned on output
		EmbeddedInstance	string	CIM_FSIPInterfaceSettingData
		OUT	boolean	true
NFSSettingData	string
		Description	string	The NFSSettingData that specifies the NFS settings for the FileServer being created. If this is NULL, the FileServer shall not have NFS enabled and the resulting NFSSettingData instance created shall have its "Enabled" property set to false. The NFSSettingData instance will be returned on output.
		EmbeddedInstance	string	CIM_NFSSettingData
		OUT	boolean	true
NISSettingData	string
		Description	string	The NISSettingData that specifies the NIS settings for the FileServer being created. If this is NULL, the FileServer shall not have access to a NIS server and a NISSettingData instance shall not be instantiated for the FileServer.
		EmbeddedInstance	string	CIM_NISSettingData
		OUT	boolean	true
EthernetPort	REF CIM_EthernetPort
EthernetPort	REF CIM_EthernetPort	Description	string	The EthernetPort identifies the hardware port that the File Server will use for mount requests.
HostingComputerSystem	REF CIM_ComputerSystem
HostingComputerSystem	REF CIM_ComputerSystem	Description	string	The HostingComputerSystem identifies the ComputerSystem that will host the FileServer.
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (may be null if job completed).
		IN	boolean	false
		OUT	boolean	true
NASComputerSystem	REF CIM_ComputerSystem
NASComputerSystem	REF CIM_ComputerSystem	Description	string	Either the NAS Head or Self-contained NAS system that the FileServer shall be a component system of.
TheElement	REF CIM_LogicalElement
		Description	string	The newly created FileServer.
		OUT	boolean	true

ModifyFileServer (uint32)

Method Qualifiers (ModifyFileServer)

Name	Data Type	Value
Description	string	ModifyFileServer modifies a FileServer specified by the input reference parameter FileServer.The desired new settings for the FileServer are specified by the various parameters (string-valued EmbeddedInstance objects of class FileSystemSetting). One or all of the SettingData parameters may contain EmbeddedInstance objects reflecting the aspect(s) of the FileServer that are to be Modified. The parameters are essentially the same as found in CreateFileServer except the HostingComputerSystem and EthernetPort cannot be modified through this method. To modify those, use the ModifyIPInterface method.
ValueMap	string	0, 1, .., 4096, 4098..32767, 32768..65535
Values	string	Job Completed with No Error, Failed, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (ModifyFileServer)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
CIFSSettingData	string
		Description	string	IF non-NULL, this specifies the new CIFS settings for the FileServer. If the "Enabled" property set to false, CIFS will be disabled for the FileServer. If NULL, then the CIFS setting of the FileServer shall not be modified.
		EmbeddedInstance	string	CIM_CIFSSettingData
DNSSettingData	string
		Description	string	IF non-NULL, this specifies the new DNS settings for the FileServer. If NULL, then the DNS setting of the FileServer shall not be modified.
		EmbeddedInstance	string	CIM_DNSSettingData
ElementName	string
ElementName	string	Description	string	A new end user relevant name for the FileServer specified by TheElement. If NULL, then the previous name is not changed.
FileServerSettings	string
		Description	string	If non-NULL, this specifies the new FileServerSettings for the FileServer. If NULL, then the FileServerSettings of the FileServer shall ot be modified.
		EmbeddedInstance	string	CIM_FileServerSettings
NFSSettingData	string
		Description	string	IF non-NULL, this specifies the new NFS settings for the FileServer. If the "Enabled" property set to false, NFS will be disabled for the FileServer. If NULL, then the NFS setting of the FileServer shall not be modified.
		EmbeddedInstance	string	CIM_NFSSettingData
NISSettingData	string
		Description	string	IF non-NULL, this specifies the new NIS settings for the FileServer. If NULL, then the NIS setting of the FileServer shall not be modified.
		EmbeddedInstance	string	CIM_NISSettingData
FileServer	REF CIM_ComputerSystem
		Description	string	The FileServer to be modified.
		OUT	boolean	true
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (may be null if job completed).
		IN	boolean	false
		OUT	boolean	true

DeleteFileServer (uint32)

Method Qualifiers (DeleteFileServer)

Name	Data Type	Value
Description	string	DeleteFileServer deletes a FileServer specified by the parameter FileServer. This operation may not succeed if the FileServer is hosting any FileSystems. The ComputerSystem instance that represents the FileServer will be deleted along with the associated instances FileServerSettings, CIFSSettingData, NFSSettingData, NISSettingData, IPInterfaceSettingData, IPProtocolEndPoint, TCPProtocolEndPoint, NetworkVLAN, and the CIFS/NFS ProtocolEndpoints. All related Associations shall be deleted as well. If necessary, a ConcreteJob will be started to delete the FileServer. A reference to the ConcreteJob will be returned in the output parameter Job.
ValueMap	string	0, 1, .., 0x1000, 0x1001..0x7FFF, 0x8000..
Values	string	Job Completed with No Error, Failed, Unspecified Reasons, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (DeleteFileServer)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
FileServer	REF CIM_ComputerSystem
FileServer	REF CIM_ComputerSystem	Description	string	The FileServer that is to be deleted.
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (may be null if job completed).
		IN	boolean	false
		OUT	boolean	true

AddIPInterface (uint32)

Method Qualifiers (AddIPInterface)

Name	Data Type	Value
Description	string	AddIPInterface adds a new IP Interface to an existing FileServer specified by the parameter FileServer. The parameters specify the IPInterfaceSettingData, HostingComputerSystem, and EthernetPort that make up the new IP Interface. In a manner similar to the actions in CreateFileServer, a new instance of IPInterfaceSettingData is associated with the FileServer via ConcreteComponent and is used to instantiate a new IPProtocolEndpoint, NetworkVLAN, and TCPProtocolEndpoint with appropriate associations, again as described in CreateFileServer. The HostingComputerSystem is associated with the FileServer via HostedDepedency. This operation may fail if the FileServer already has the same IP Interface or if any of the parameters are incompatible with the current state of the FileServer. If necessary, a ConcreteJob will be started to add the IP Interface. A reference to the ConcreteJob will be returned in the output parameter Job.
ValueMap	string	0, 1, .., 0x1000, 0x1001..0x7FFF, 0x8000..
Values	string	Job Completed with No Error, Failed, Unspecified Reasons, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (AddIPInterface)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
IPInterfaceSettingData	string
		Description	string	The IPInterfaceSettingData that specifies the settings of the IP Interface to be added to the FileServer.
		EmbeddedInstance	string	CIM_FSIPInterfaceSettingData
		OUT	boolean	true
EthernetPort	REF CIM_EthernetPort
EthernetPort	REF CIM_EthernetPort	Description	string	The EthernetPort identifies the hardware port that will host the new IP Interface.
FileServer	REF CIM_ComputerSystem
FileServer	REF CIM_ComputerSystem	Description	string	The FileServer that is to which the IP Interface shall be added.
HostingComputerSystem	REF CIM_ComputerSystem
HostingComputerSystem	REF CIM_ComputerSystem	Description	string	The HostingComputerSystem identifies the ComputerSystem that will host the new IP Interface for the FileServer.
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (may be null if job completed).
		IN	boolean	false
		OUT	boolean	true

ModifyIPInterface (uint32)

Method Qualifiers (ModifyIPInterface)

Name	Data Type	Value
Description	string	ModifyIPInterface modifies an existing IP Interface on the FileServer specified by the parameter FileServer. The parameters identify the IP Interface to modify and specify the new IPInterfaceSettingData, HostingComputerSystem, and EthernetPort for the IP Interface. If necessary, a ConcreteJob will be started to add the IP Interface. A reference to the ConcreteJob will be returned in the output parameter Job.
ValueMap	string	0, 1, .., 0x1000, 0x1001..0x7FFF, 0x8000..
Values	string	Job Completed with No Error, Failed, Unspecified Reasons, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (ModifyIPInterface)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
NewIPInterfaceSettingData	string
		Description	string	If non-NULL, the IPInterfaceSettingData that will replace an existing IPInterfaceSettingData instance in the FileServer. If NULL, then the IPInterfaceSettingData will not be modified.
		EmbeddedInstance	string	CIM_FSIPInterfaceSettingData
EthernetPort	REF CIM_EthernetPort
EthernetPort	REF CIM_EthernetPort	Description	string	If non-NULL, the EthernetPort identifies the new hardware port for the IPInterface. If NULL, the current EthernetPort setting will not be changed.
FileServer	REF CIM_ComputerSystem
		Description	string	The FileServer who's IP Interface shall be modified.
		OUT	boolean	true
HostingComputerSystem	REF CIM_ComputerSystem
HostingComputerSystem	REF CIM_ComputerSystem	Description	string	If non-NULL, the new ComputerSystem that will host the IPInterface. If NULL, the current ComputerSystem hosting the IPInterface will remain unchanged.
IPInterfaceSettingData	REF CIM_FSIPInterfaceSettingData
IPInterfaceSettingData	REF CIM_FSIPInterfaceSettingData	Description	string	The IPInterfaceSettingData that is to be modified. This is used to identify which IPInterfaceSettingData instance to modify
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (may be null if job completed).
		IN	boolean	false
		OUT	boolean	true

DeleteIPInterface (uint32)

Method Qualifiers (DeleteIPInterface)

Name	Data Type	Value
Description	string	DeleteIPInterface deletes an existing IP Interface on the FileServer specified by the parameter FileServer. The parameters identify the IP Interface to delete. This operation may fail if the IP Interface specified is the only IP Interface currently associated with the FileServer. Deleting a IP Interface includes deleting the IPInterfaceSettingData, IPProtocolEndPoint, NetworkVLAN, and TCPProtocolEndPoint instances. The related associations shall also be deleted. If necessary, a ConcreteJob will be started to add the IP Interface. A reference to the ConcreteJob will be returned in the output parameter Job.
ValueMap	string	0, 1, .., 0x1000, 0x1001..0x7FFF, 0x8000..
Values	string	Job Completed with No Error, Failed, Unspecified Reasons, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (DeleteIPInterface)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
FileServer	REF CIM_ComputerSystem
		Description	string	The FileServer who's IP Interface shall be deleted.
		OUT	boolean	true
IPInterfaceSettingData	REF CIM_FSIPInterfaceSettingData
IPInterfaceSettingData	REF CIM_FSIPInterfaceSettingData	Description	string	The IPInterfaceSettingData that is to be deleted. This is used to identify which IPInterfaceSettingData instance to delete.
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (may be null if job completed).
		IN	boolean	false
		OUT	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_FileServerConfigurationServiceextends CIM_Service

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