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

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_Service
   |
   +--CIM_FileServerConfigurationService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThis 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.
UMLPackagePathstringCIM::System::FileServices
Versionstring2.45.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LoSIDstringCIM_Service
LoSOrgIDstringCIM_Service
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

CreateFileServer (uint32)

Method Qualifiers (CreateFileServer)

NameData TypeValue
DescriptionstringCreateFileServer 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
ValueMapstring0, 1, .., 4096, 4098..32767, 32768..65535
ValuesstringJob Completed with No Error, Failed, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (CreateFileServer)

NameTypeQualifiers
NameData TypeValue
CIFSSettingDatastring
DescriptionstringThe 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.
EmbeddedInstancestringCIM_CIFSSettingData
OUTbooleantrue
DNSSettingDatastring
DescriptionstringThe 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.
EmbeddedInstancestringCIM_DNSSettingData
OUTbooleantrue
ElementNamestring
DescriptionstringAn 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.
FileServerSettingsstring
DescriptionstringThe FileServerSettings for the newly created FileServer. If NULL or the empty string, a default FileServerSettings shall be used and returned on output.
EmbeddedInstancestringCIM_FileServerSettings
OUTbooleantrue
IPInterfaceSettingDatastring
DescriptionstringThe 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
EmbeddedInstancestringCIM_FSIPInterfaceSettingData
OUTbooleantrue
NFSSettingDatastring
DescriptionstringThe 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.
EmbeddedInstancestringCIM_NFSSettingData
OUTbooleantrue
NISSettingDatastring
DescriptionstringThe 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.
EmbeddedInstancestringCIM_NISSettingData
OUTbooleantrue
EthernetPort REF CIM_EthernetPort
DescriptionstringThe EthernetPort identifies the hardware port that the File Server will use for mount requests.
HostingComputerSystem REF CIM_ComputerSystem
DescriptionstringThe HostingComputerSystem identifies the ComputerSystem that will host the FileServer.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
NASComputerSystem REF CIM_ComputerSystem
DescriptionstringEither the NAS Head or Self-contained NAS system that the FileServer shall be a component system of.
TheElement REF CIM_LogicalElement
DescriptionstringThe newly created FileServer.
OUTbooleantrue

ModifyFileServer (uint32)

Method Qualifiers (ModifyFileServer)

NameData TypeValue
DescriptionstringModifyFileServer 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.
ValueMapstring0, 1, .., 4096, 4098..32767, 32768..65535
ValuesstringJob Completed with No Error, Failed, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (ModifyFileServer)

NameTypeQualifiers
NameData TypeValue
CIFSSettingDatastring
DescriptionstringIF 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.
EmbeddedInstancestringCIM_CIFSSettingData
DNSSettingDatastring
DescriptionstringIF non-NULL, this specifies the new DNS settings for the FileServer. If NULL, then the DNS setting of the FileServer shall not be modified.
EmbeddedInstancestringCIM_DNSSettingData
ElementNamestring
DescriptionstringA new end user relevant name for the FileServer specified by TheElement. If NULL, then the previous name is not changed.
FileServerSettingsstring
DescriptionstringIf non-NULL, this specifies the new FileServerSettings for the FileServer. If NULL, then the FileServerSettings of the FileServer shall ot be modified.
EmbeddedInstancestringCIM_FileServerSettings
NFSSettingDatastring
DescriptionstringIF 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.
EmbeddedInstancestringCIM_NFSSettingData
NISSettingDatastring
DescriptionstringIF non-NULL, this specifies the new NIS settings for the FileServer. If NULL, then the NIS setting of the FileServer shall not be modified.
EmbeddedInstancestringCIM_NISSettingData
FileServer REF CIM_ComputerSystem
DescriptionstringThe FileServer to be modified.
OUTbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue

DeleteFileServer (uint32)

Method Qualifiers (DeleteFileServer)

NameData TypeValue
DescriptionstringDeleteFileServer 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.
ValueMapstring0, 1, .., 0x1000, 0x1001..0x7FFF, 0x8000..
ValuesstringJob Completed with No Error, Failed, Unspecified Reasons, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (DeleteFileServer)

NameTypeQualifiers
NameData TypeValue
FileServer REF CIM_ComputerSystem
DescriptionstringThe FileServer that is to be deleted.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue

AddIPInterface (uint32)

Method Qualifiers (AddIPInterface)

NameData TypeValue
DescriptionstringAddIPInterface 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.
ValueMapstring0, 1, .., 0x1000, 0x1001..0x7FFF, 0x8000..
ValuesstringJob Completed with No Error, Failed, Unspecified Reasons, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (AddIPInterface)

NameTypeQualifiers
NameData TypeValue
IPInterfaceSettingDatastring
DescriptionstringThe IPInterfaceSettingData that specifies the settings of the IP Interface to be added to the FileServer.
EmbeddedInstancestringCIM_FSIPInterfaceSettingData
OUTbooleantrue
EthernetPort REF CIM_EthernetPort
DescriptionstringThe EthernetPort identifies the hardware port that will host the new IP Interface.
FileServer REF CIM_ComputerSystem
DescriptionstringThe FileServer that is to which the IP Interface shall be added.
HostingComputerSystem REF CIM_ComputerSystem
DescriptionstringThe HostingComputerSystem identifies the ComputerSystem that will host the new IP Interface for the FileServer.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue

ModifyIPInterface (uint32)

Method Qualifiers (ModifyIPInterface)

NameData TypeValue
DescriptionstringModifyIPInterface 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.
ValueMapstring0, 1, .., 0x1000, 0x1001..0x7FFF, 0x8000..
ValuesstringJob Completed with No Error, Failed, Unspecified Reasons, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (ModifyIPInterface)

NameTypeQualifiers
NameData TypeValue
NewIPInterfaceSettingDatastring
DescriptionstringIf non-NULL, the IPInterfaceSettingData that will replace an existing IPInterfaceSettingData instance in the FileServer. If NULL, then the IPInterfaceSettingData will not be modified.
EmbeddedInstancestringCIM_FSIPInterfaceSettingData
EthernetPort REF CIM_EthernetPort
DescriptionstringIf 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
DescriptionstringThe FileServer who's IP Interface shall be modified.
OUTbooleantrue
HostingComputerSystem REF CIM_ComputerSystem
DescriptionstringIf 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
DescriptionstringThe IPInterfaceSettingData that is to be modified. This is used to identify which IPInterfaceSettingData instance to modify
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue

DeleteIPInterface (uint32)

Method Qualifiers (DeleteIPInterface)

NameData TypeValue
DescriptionstringDeleteIPInterface 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.
ValueMapstring0, 1, .., 0x1000, 0x1001..0x7FFF, 0x8000..
ValuesstringJob Completed with No Error, Failed, Unspecified Reasons, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (DeleteIPInterface)

NameTypeQualifiers
NameData TypeValue
FileServer REF CIM_ComputerSystem
DescriptionstringThe FileServer who's IP Interface shall be deleted.
OUTbooleantrue
IPInterfaceSettingData REF CIM_FSIPInterfaceSettingData
DescriptionstringThe IPInterfaceSettingData that is to be deleted. This is used to identify which IPInterfaceSettingData instance to delete.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service