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

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

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringCIM_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.
UMLPackagePathstringCIM::Network::IP
Versionstring2.40.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

AddStaticIPv4Interface (uint32)

Method Qualifiers (AddStaticIPv4Interface)

NameData TypeValue
DescriptionstringAdd 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.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown/Unspecified Error, Failed, Invalid Parameter, DMTF Reserved, Vendor Reserved

Method Parameters (AddStaticIPv4Interface)

NameTypeQualifiers
NameData TypeValue
Addressstring
DescriptionstringThe IPv4 address requested.
INbooleantrue
Requiredbooleantrue
Gatewaystring
DescriptionstringThe requested default gateway. If "null", the GatewayIPv4Address property of the created CIM_StaticIPAssignmentSettingData instance will have a value of 0.0.0.0.
INbooleantrue
SubnetMaskstring
DescriptionstringThe requested subnet mask.
INbooleantrue
Requiredbooleantrue
Configuration REF CIM_IPAssignmentSettingData
DescriptionstringThe IPAssignmentSettingData to which a static IP interface will be added.
INbooleantrue
Requiredbooleantrue
StaticSetting REF CIM_StaticIPAssignmentSettingData
DescriptionstringThe created StaticIPAssignmentSettingData.
INbooleanfalse
OUTbooleantrue

ApplySettingToLANEndpoint (uint32)

Method Qualifiers (ApplySettingToLANEndpoint)

NameData TypeValue
DescriptionstringApply 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.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 4096, .., 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown/Unspecified Error, Failed, Invalid Parameter, Busy, Method Parameters Checked - Job Started, DMTF Reserved, Vendor Reserved

Method Parameters (ApplySettingToLANEndpoint)

NameTypeQualifiers
NameData TypeValue
Configuration REF CIM_IPAssignmentSettingData
DescriptionstringThe IPAssignmentSettingData to apply.
INbooleantrue
Requiredbooleantrue
Endpoint REF CIM_LANEndpoint
DescriptionstringThe LANEndpoint to which the configuration will be applied.
INbooleantrue
Requiredbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job spawned if the operation continues after the method returns. (may be null if task completed).
INbooleanfalse
OUTbooleantrue

ApplySettingToIPProtocolEndpoint (uint32)

Method Qualifiers (ApplySettingToIPProtocolEndpoint)

NameData TypeValue
DescriptionstringApply 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.
ValueMapstring0, 1, 2, 3, 4, 5, 4096, .., 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown/Unspecified Error, Failed, Invalid Parameter, Busy, Method Parameters Checked - Job Started, DMTF Reserved, Vendor Reserved

Method Parameters (ApplySettingToIPProtocolEndpoint)

NameTypeQualifiers
NameData TypeValue
Configuration REF CIM_IPAssignmentSettingData
DescriptionstringThe IPAssignmentSettingData to apply.
INbooleantrue
Requiredbooleantrue
Endpoint REF CIM_IPProtocolEndpoint
DescriptionstringThe IPProtocolEndpoint to which the configuration will be applied.
INbooleantrue
Requiredbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference 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.
INbooleanfalse
OUTbooleantrue

ApplySettingToComputerSystem (uint32)

Method Qualifiers (ApplySettingToComputerSystem)

NameData TypeValue
DescriptionstringApply 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.
ValueMapstring0, 1, 2, 4096, .., 32768..65535
ValuesstringCompleted with No Error, Not Supported, Failed, Job Started, DMTF Reserved, Vendor Reserved

Method Parameters (ApplySettingToComputerSystem)

NameTypeQualifiers
NameData TypeValue
Modeuint16
DescriptionstringThe 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.
INbooleantrue
Requiredbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 32768..65535
ValuesstringMode 0, Mode 1, Mode 2, Mode 3, Mode 4, Mode 5, Mode 6, DMTF Reserved, Vendor Reserved
ComputerSystem REF CIM_ComputerSystem
DescriptionstringThe ComputerSystem to which the setting will be applied
INbooleantrue
Requiredbooleantrue
IPVersionSettingData REF CIM_IPVersionSettingData
DescriptionstringThe IPVersionSettingData to be apply.
INbooleantrue
Requiredbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job spawned if the operation continues after the method returns. (may be null if task completed).
INbooleanfalse
OUTbooleantrue

ApplySettingToIPNetworkConnection (uint32)

Method Qualifiers (ApplySettingToIPNetworkConnection)

NameData TypeValue
DescriptionstringApply 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.
ValueMapstring0, 1, 2, 4096, .., 32768..65535
ValuesstringCompleted with No Error, Not Supported, Failed, Job Started, DMTF Reserved, Vendor Reserved

Method Parameters (ApplySettingToIPNetworkConnection)

NameTypeQualifiers
NameData TypeValue
Modeuint16
DescriptionstringThe 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.
INbooleantrue
Requiredbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 32768..65535
ValuesstringMode 0, Mode 1, Mode 2, Mode 3, Mode 4, Mode 5, Mode 6, DMTF Reserved, Vendor Reserved
IPNetworkConnection REF CIM_IPNetworkConnection
DescriptionstringThe IPNetworkConnection to which the setting will be applied
INbooleantrue
Requiredbooleantrue
IPVersionSettingData REF CIM_IPVersionSettingData
DescriptionstringThe IPVersionSettingData to be apply.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job spawned if the operation continues after the method returns. (may be null if task completed).
INbooleanfalse
OUTbooleantrue
SettingData REF CIM_IPAssignmentSettingData
DescriptionstringThe IPAssignmentSettingData to apply.
INbooleantrue

AddIPProtocolEndpoint (uint32)

Method Qualifiers (AddIPProtocolEndpoint)

NameData TypeValue
DescriptionstringDefines 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.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 4096, .., 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown/Unspecified Error, Failed, Invalid Parameter, Busy, Method Parameters Checked - Job Started, DMTF Reserved, Vendor Reserved

Method Parameters (AddIPProtocolEndpoint)

NameTypeQualifiers
NameData TypeValue
EndpointSettingsstring[]
DescriptionstringAn 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.
EmbeddedInstancestringCIM_SettingData
IPProtocolEndpointstring[]
DescriptionstringAn array of string containing embedded instances of the class-subclass of CIM_IPProtocolEndpoint that describes the configuration of the new IPProtocolEndpoints
EmbeddedInstancestringCIM_IPProtocolEndpoint
ResultingEndpointCIM_IPProtocolEndpoint[]
DescriptionstringIf 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.
Inbooleanfalse
Outbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringIf the operation is long running, then optionally a job may be returned.
Inbooleanfalse
Outbooleantrue
TargetInterface REF CIM_ManagedElement
DescriptionstringOptional 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)

NameData TypeValue
DescriptionstringRemoves one more IPProtocolEndpoint classes or subclasses instances.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 4096, .., 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown/Unspecified Error, Failed, Invalid Parameter, Busy, Method Parameters Checked - Job Started, DMTF Reserved, Vendor Reserved

Method Parameters (RemoveIPProtocolEndpoint)

NameTypeQualifiers
NameData TypeValue
EndpointCIM_IPProtocolEndpoint[]
DescriptionstringReference to the targeted instances of CIM_ProtocolEndpoint.
Job REF CIM_ConcreteJob
DescriptionstringIf the operation is long running, then optionally a job may be returned.
Inbooleanfalse
Outbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service