Class CIM_IPConfigurationService
extends CIM_Service

CIM_IPConfigurationService provides management of the IP configuration associated with a LANEndpoint or IPProtocolEndpoint or IPNetworkConnection or the global IP configuration for the ComputerSystem. CIM_IPConfigurationService also provides methods to support the additon and removal of an IPProtocolEndpoint to support the addition of a Layer 3 interface to a port, system or network.

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	CIM_IPConfigurationService provides management of the IP configuration associated with a LANEndpoint or IPProtocolEndpoint or IPNetworkConnection or the global IP configuration for the ComputerSystem. CIM_IPConfigurationService also provides methods to support the additon and removal of an IPProtocolEndpoint to support the addition of a Layer 3 interface to a port, system or network.
UMLPackagePath	string	CIM::Network::IP
Version	string	2.51.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

ApplySettingToIPProtocolEndpoint (uint32)

Method Qualifiers (ApplySettingToIPProtocolEndpoint)

Name	Data Type	Value
Description	string	Apply the configuration represented by the CIM_IPAssignmentSettingData to the specified IPProtocolEndpoint. This will result in the value of the IsCurrent property of the CIM_ElementSettingData which associates the specified CIM_IPAssignmentSettingData and specified CIM_IPProtocolEndpoint having a value of "true". The IsCurrent property of any other instances of CIM_ElementSettingData which reference the specified CIM_IPProtocolEndpoint and an instance of CIM_IPAssignmentSettingData will have a value of "false". Each instance of CIM_IPAssignmentSettingData which is aggregated into the target CIM_IPAssignmentSettingData instance will be applied to the CIM_ProtocolEndpoint to which it is associated via an instance of CIM_ElementSettingData where the CIM_ProtocolEndpoint is associated with the target CIM_IPProtocolEndpoint via an instance of CIM_EndpointIdentity.
ValueMap	string	0, 1, 2, 3, 4, 5, 4096, .., 32768..65535
Values	string	Completed with No Error, Not Supported, Unknown/Unspecified Error, Failed, Invalid Parameter, Busy, Method Parameters Checked - Job Started, DMTF Reserved, Vendor Reserved

Method Parameters (ApplySettingToIPProtocolEndpoint)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
Configuration	REF CIM_IPAssignmentSettingData
		Description	string	The IPAssignmentSettingData to apply.
		Required	boolean	true
Endpoint	REF CIM_IPProtocolEndpoint
		Description	string	The IPProtocolEndpoint to which the configuration will be applied.
		Required	boolean	true
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job spawned if the operation continues after the method returns. This parameter MUST NOT be null if a value of 4096 is returned. This parameter MUST be null if any other value is returned by the method.
		IN	boolean	false
		OUT	boolean	true

ApplySettingToComputerSystem (uint32)

Method Qualifiers (ApplySettingToComputerSystem)

Name	Data Type	Value
Description	string	Apply the IP Version respresented by the CIM_IPVersionSettingData to the specified ComputerSystem. The IP Version may take effect or disable immediatley or may be set to take effect or disable in the next boot, depending on ComputerSystem and the value specified for Mode. This will reflect in the IsCurrent & IsNext property of CIM_ElementSettingData associating the IPVersionSettingData with the ComputerSystem. Refer the description for the Mode parameter for more details.
ValueMap	string	0, 1, 2, 4096, .., 32768..65535
Values	string	Completed with No Error, Not Supported, Failed, Job Started, DMTF Reserved, Vendor Reserved

Method Parameters (ApplySettingToComputerSystem)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
Mode	uint16
		Description	string	The mode in which the configuration need to be applied to the ComputerSystem. Mode 0 - implies use Mode 1 if allowed, else Mode 2. Mode 1 - Results in IsNext = 1 (Is Next), IsCurrent = 1 (Is Current) for the CIM_ElementSettingData associating the setting with ComputerSystem. Mode 2 - Results in IsNext = 1 (Is Next) for the CIM_ElementSettingData associating the setting with ComputerSystem. The value of IsCurrent will not be affected. Mode 3 - implies use Mode 4 if allowed, else Mode 5. Mode 4 - Results in IsNext = 2 (Is Not Next), IsCurrent = 2 (Is Not Current) for the CIM_ElementSettingData associating the setting with ComputerSystem. Mode 5 - Results in IsNext = 2 (Is Not Next) for the CIM_ElementSettingData associating the setting with ComputerSystem. The value of IsCurrent will not be affected. Mode 6 - Results in IsNext = 3 (Is Next For Single Use)for the CIM_ElementSettingData associating the setting with ComputerSystem. The value of IsCurrent will not be affected. To change the IsNext=3 (Is Next For Single Use) for a Setting, invoke the method with any of the other values for the mode.
		Required	boolean	true
		ValueMap	string	0, 1, 2, 3, 4, 5, 6, .., 32768..65535
		Values	string	Mode 0, Mode 1, Mode 2, Mode 3, Mode 4, Mode 5, Mode 6, DMTF Reserved, Vendor Reserved
ComputerSystem	REF CIM_ComputerSystem
		Description	string	The ComputerSystem to which the setting will be applied
		Required	boolean	true
IPVersionSettingData	REF CIM_IPVersionSettingData
		Description	string	The IPVersionSettingData to be apply.
		Required	boolean	true
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job spawned if the operation continues after the method returns. (may be null if task completed).
		IN	boolean	false
		OUT	boolean	true

ApplySettingToIPNetworkConnection (uint32)

Method Qualifiers (ApplySettingToIPNetworkConnection)

Name	Data Type	Value
Description	string	Apply the IP setting respresented by the CIM_IPAssignmentSettingData and/or the IPVersion Setting respresented by the CIM_IPVersionSettingData to the specified IPNetworkConnection. The settings may take effect or disable immediatley or may be set to take effect or disable in the next boot, depending on system, IPNetworkConnection, Setting and the value specified for Mode. This will reflect in the IsCurrent & IsNext property of instances of CIM_ElementSettingData associating the SettingData and or IPVersionSettingData with the IPNetworkConnection. For cases, enabling one setting can result in automatic disabling of another setting, it will be refelected in the properties of ElementSettingData associating those settings to the IPNetworkConnection.Refer the description for the Mode parameter for more details. At least one of the SettingData or IPVersionSettingData is required in the method call; both may be specified on the same method call.
ValueMap	string	0, 1, 2, 4096, .., 32768..65535
Values	string	Completed with No Error, Not Supported, Failed, Job Started, DMTF Reserved, Vendor Reserved

Method Parameters (ApplySettingToIPNetworkConnection)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
Mode	uint16
		Description	string	The mode in which the configuration need to be applied to the IPNetworkConnection. Mode 0 - implies use Mode 1 if allowed, else Mode 2. Mode 1 - Results in IsNext = 1 (Is Next), IsCurrent = 1 (Is Current) for the CIM_ElementSettingData associating the setting with IPNetworkConnection. Mode 2 - Results in IsNext = 1 (Is Next) for the CIM_ElementSettingData associating the setting with IPNetworkConnection. The value of IsCurrent will not be affected. Mode 3 - implies use Mode 4 if allowed, else Mode 5. Mode 4 - Results in IsNext = 2 (Is Not Next), IsCurrent = 2 (Is Not Current) for the CIM_ElementSettingData associating the setting with IPNetworkConnection. Mode 5 - Results in IsNext = 2 (Is Not Next) for the CIM_ElementSettingData associating the setting with IPNetworkConnection. The value of IsCurrent will not be affected. Mode 6 - Results in IsNext = 3 (Is Next For Single Use)for the CIM_ElementSettingData associating the setting with IPNetworkConnection. The value of IsCurrent will not be affected. To change the IsNext=3 (Is Next For Single Use) for a Setting, invoke the method with any of the other values for the mode.
		Required	boolean	true
		ValueMap	string	0, 1, 2, 3, 4, 5, 6, .., 32768..65535
		Values	string	Mode 0, Mode 1, Mode 2, Mode 3, Mode 4, Mode 5, Mode 6, DMTF Reserved, Vendor Reserved
IPNetworkConnection	REF CIM_IPNetworkConnection
		Description	string	The IPNetworkConnection to which the setting will be applied
		Required	boolean	true
IPVersionSettingData	REF CIM_IPVersionSettingData
IPVersionSettingData	REF CIM_IPVersionSettingData	Description	string	The IPVersionSettingData to be apply.
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job spawned if the operation continues after the method returns. (may be null if task completed).
		IN	boolean	false
		OUT	boolean	true
SettingData	REF CIM_IPAssignmentSettingData
SettingData	REF CIM_IPAssignmentSettingData	Description	string	The IPAssignmentSettingData to apply.

AddIPProtocolEndpoint (uint32)

Method Qualifiers (AddIPProtocolEndpoint)

Name	Data Type	Value
Description	string	Defines and assigns an CIM_IPProtocolEndpoint subclass to a CIM_ComputerSystem, CIM_EthernetPort or a CIM_Network instance. The provider should use default values for properites that are not populated in the embedded instance.
ValueMap	string	0, 1, 2, 3, 4, 5, 4096, .., 32768..65535
Values	string	Completed with No Error, Not Supported, Unknown/Unspecified Error, Failed, Invalid Parameter, Busy, Method Parameters Checked - Job Started, DMTF Reserved, Vendor Reserved

Method Parameters (AddIPProtocolEndpoint)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
EndpointSettings	string[]
		Description	string	An array of strings each containing an embedded instance of class-subclass of CIM_SettingData that are to be associated with the new IP protocol endpoint. Generally these should be associated to the CIM_IPProtocolEndpoint instance through an instance of CIM_ElementSettingData. This array of instances shall be indexed one to one with the embedded instances contained in the IPProtocolEndpoint parameter.
		EmbeddedInstance	string	CIM_SettingData
IPProtocolEndpoint	string[]
		Description	string	An array of string containing embedded instances of the class-subclass of CIM_IPProtocolEndpoint that describes the configuration of the new IPProtocolEndpoints
		EmbeddedInstance	string	CIM_IPProtocolEndpoint
ResultingEndpoint	CIM_IPProtocolEndpoint[]
		Description	string	If the addition of a protocol endpoint is successfully, a reference to the instance of class CIM_IPProtocolEndpoint that represents the newly defined endpoints are returned.
		In	boolean	false
		Out	boolean	true
Job	REF CIM_ConcreteJob
		Description	string	If the operation is long running, then optionally a job may be returned.
		In	boolean	false
		Out	boolean	true
TargetInterface	REF CIM_ManagedElement
TargetInterface	REF CIM_ManagedElement	Description	string	Optional reference to an associated interface or system. This is usally an instance of CIM_EthernetPort, or a VLANNetwork. If no value is provided the new IPProtocolEndpoint instances are associated with the ComputerSystem instance representing the host of the service. The new IPProtocolEndpoint instance should also be associated though an instance of CIM_ServiceAffectsElement to the instance of IPConfigurationService from which the method was called.

RemoveIPProtocolEndpoint (uint32)

Method Qualifiers (RemoveIPProtocolEndpoint)

Name	Data Type	Value
Description	string	Removes one more IPProtocolEndpoint classes or subclasses instances.
ValueMap	string	0, 1, 2, 3, 4, 5, 4096, .., 32768..65535
Values	string	Completed with No Error, Not Supported, Unknown/Unspecified Error, Failed, Invalid Parameter, Busy, Method Parameters Checked - Job Started, DMTF Reserved, Vendor Reserved

Method Parameters (RemoveIPProtocolEndpoint)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
Endpoint	CIM_IPProtocolEndpoint[]
Endpoint	CIM_IPProtocolEndpoint[]	Description	string	Reference to the targeted instances of CIM_ProtocolEndpoint.
Job	REF CIM_ConcreteJob
		Description	string	If the operation is long running, then optionally a job may be returned.
		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_IPConfigurationServiceextends CIM_Service

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