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.

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.
UMLPackagePath	string	CIM::Network::IP
Version	string	2.31.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
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

AddStaticIPv4Interface (uint32)

Method Qualifiers (AddStaticIPv4Interface)

Name	Data Type	Value
Description	string	Add a CIM_StaticIPAssignmentSettingData configuration to the specified IPAssignmentSettingData instance. This will also create an instance of CIM_ConcreteDependency which associates the specified CIM_IPAssignmentSettingData instance with the newly created CIM_StaticIPAssignmentSettingData instance. The newly created instance of StaticIPAssignmentSettingData contains the IP configuration of an additional CIM_IPProtocolEndpoint which will be created. When the CIM_IPProtocolEndpoint is created depends on the value of the IsCurrent property of the CIM_ElementSettingData association which associates the CIM_IPAssignmentSettingData instance with the the CIM_LANEndpoint instance. If the IsCurrent property has a value of "true", the CIM_IPProtocolEndpoint will be created immediately. The instance of CIM_StaticIPAssignmentSettingData identified by the StaticSetting parameter will be associated with the newly created instance of CIM_IPProtocolEndpoint via an instance of CIM_ElementSettingData. If the the value of the IsCurrent property is "false", the CIM_IPProtocolEndpoint will be created the next time the IPAssignmentSettingData is applied to the LANEndpoint. Note: this method may be deprecated in the future in lieu of intrinsics once the limitations in CIM operations are addressed.
Experimental	boolean	true
ValueMap	string	0, 1, 2, 3, 4, 5..32767, 32768..65535
Values	string	Completed with No Error, Not Supported, Unknown/Unspecified Error, Failed, Invalid Parameter, DMTF Reserved, Vendor Reserved

Method Parameters (AddStaticIPv4Interface)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
Address	string
		Description	string	The IPv4 address requested.
		IN	boolean	true
		Required	boolean	true
Gateway	string
		Description	string	The requested default gateway. If "null", the GatewayIPv4Address property of the created CIM_StaticIPAssignmentSettingData instance will have a value of 0.0.0.0.
		IN	boolean	true
SubnetMask	string
		Description	string	The requested subnet mask.
		IN	boolean	true
		Required	boolean	true
Configuration	REF CIM_IPAssignmentSettingData
		Description	string	The IPAssignmentSettingData to which a static IP interface will be added.
		IN	boolean	true
		Required	boolean	true
StaticSetting	REF CIM_StaticIPAssignmentSettingData
		Description	string	The created StaticIPAssignmentSettingData.
		IN	boolean	false
		OUT	boolean	true

ApplySettingToLANEndpoint (uint32)

Method Qualifiers (ApplySettingToLANEndpoint)

Name	Data Type	Value
Description	string	Apply the configuration represented by the IPAssignmentSettingData to the specified LANEndpoint. This will result in the value of the IsCurrent property of the CIM_ElementSettingData which associates the specified CIM_IPAssignmentSettingData and specified CIM_LANEndpoint have a value of "true". The IsCurrent property of any other instances of CIM_ElementSettingData which reference the specified CIM_LANEndpoint and an instance of CIM_IPAssignmentSettingData will have a value of "false". Each instance of CIM_StaticIPAssignmentSettingData which is aggregated into the target CIM_IPAssignmentSettingData instance will result in the creation of an instance of CIM_IPProtocolEndpoint associated with the target CIM_LANEndpoint instance via an instance of the CIM_BindsTo association. The created CIM_IPProtocolEndpoint instance will have the values specified in the CIM_StaticIPAssignmentSettingData instance.
Experimental	boolean	true
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 (ApplySettingToLANEndpoint)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
Configuration	REF CIM_IPAssignmentSettingData
		Description	string	The IPAssignmentSettingData to apply.
		IN	boolean	true
		Required	boolean	true
Endpoint	REF CIM_LANEndpoint
		Description	string	The LANEndpoint to which the configuration will be applied.
		IN	boolean	true
		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

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.
		IN	boolean	true
		Required	boolean	true
Endpoint	REF CIM_IPProtocolEndpoint
		Description	string	The IPProtocolEndpoint to which the configuration will be applied.
		IN	boolean	true
		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.
Experimental	boolean	true
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.
		IN	boolean	true
		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
		IN	boolean	true
		Required	boolean	true
IPVersionSettingData	REF CIM_IPVersionSettingData
		Description	string	The IPVersionSettingData to be apply.
		IN	boolean	true
		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.
Experimental	boolean	true
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.
		IN	boolean	true
		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
		IN	boolean	true
		Required	boolean	true
IPVersionSettingData	REF CIM_IPVersionSettingData
		Description	string	The IPVersionSettingData to be apply.
		IN	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
SettingData	REF CIM_IPAssignmentSettingData
		Description	string	The IPAssignmentSettingData to apply.
		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_IPConfigurationServiceextends CIM_Service

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