CIM_IPConfigurationService¶
Class reference¶
Subclass of 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.
Key properties¶
Local properties¶
None
Local methods¶
uint32 ApplySettingToComputerSystem (CIM_IPVersionSettingData IPVersionSettingData, CIM_ComputerSystem ComputerSystem, uint16 Mode, CIM_ConcreteJob Job)
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 Values 0 Completed with No Error 1 Not Supported 2 Failed 4096 Job Started DMTF Reserved 32768..65535 Vendor Reserved Parameters
- IN CIM_IPVersionSettingData IPVersionSettingData
- The IPVersionSettingData to be apply.
- IN CIM_ComputerSystem ComputerSystem
- The ComputerSystem to which the setting will be applied
- IN uint16 Mode
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.
ValueMap Values 0 Mode 0 1 Mode 1 2 Mode 2 3 Mode 3 4 Mode 4 5 Mode 5 6 Mode 6 DMTF Reserved 32768..65535 Vendor Reserved - OUT CIM_ConcreteJob Job
- Reference to the job spawned if the operation continues after the method returns. (may be null if task completed).
uint32 AddStaticIPv4Interface (CIM_IPAssignmentSettingData Configuration, CIM_StaticIPAssignmentSettingData StaticSetting, string Address, string SubnetMask, string Gateway)
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.
ValueMap Values 0 Completed with No Error 1 Not Supported 2 Unknown/Unspecified Error 3 Failed 4 Invalid Parameter 5..32767 DMTF Reserved 32768..65535 Vendor Reserved Parameters
- IN CIM_IPAssignmentSettingData Configuration
- The IPAssignmentSettingData to which a static IP interface will be added.
- OUT CIM_StaticIPAssignmentSettingData StaticSetting
- The created StaticIPAssignmentSettingData.
- IN string Address
- The IPv4 address requested.
- IN string SubnetMask
- The requested subnet mask.
- IN string Gateway
- The requested default gateway. If “null”, the GatewayIPv4Address property of the created CIM_StaticIPAssignmentSettingData instance will have a value of 0.0.0.0.
uint32 ApplySettingToLANEndpoint (CIM_IPAssignmentSettingData Configuration, CIM_LANEndpoint Endpoint, CIM_ConcreteJob Job)
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.
ValueMap Values 0 Completed with No Error 1 Not Supported 2 Unknown/Unspecified Error 3 Failed 4 Invalid Parameter 5 Busy 4096 Method Parameters Checked - Job Started DMTF Reserved 32768..65535 Vendor Reserved Parameters
- IN CIM_IPAssignmentSettingData Configuration
- The IPAssignmentSettingData to apply.
- IN CIM_LANEndpoint Endpoint
- The LANEndpoint to which the configuration will be applied.
- OUT CIM_ConcreteJob Job
- Reference to the job spawned if the operation continues after the method returns. (may be null if task completed).
uint32 ApplySettingToIPNetworkConnection (CIM_IPAssignmentSettingData SettingData, CIM_IPVersionSettingData IPVersionSettingData, CIM_IPNetworkConnection IPNetworkConnection, uint16 Mode, CIM_ConcreteJob Job)
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 Values 0 Completed with No Error 1 Not Supported 2 Failed 4096 Job Started DMTF Reserved 32768..65535 Vendor Reserved Parameters
- IN CIM_IPAssignmentSettingData SettingData
- The IPAssignmentSettingData to apply.
- IN CIM_IPVersionSettingData IPVersionSettingData
- The IPVersionSettingData to be apply.
- IN CIM_IPNetworkConnection IPNetworkConnection
- The IPNetworkConnection to which the setting will be applied
- IN uint16 Mode
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.
ValueMap Values 0 Mode 0 1 Mode 1 2 Mode 2 3 Mode 3 4 Mode 4 5 Mode 5 6 Mode 6 DMTF Reserved 32768..65535 Vendor Reserved - OUT CIM_ConcreteJob Job
- Reference to the job spawned if the operation continues after the method returns. (may be null if task completed).
uint32 ApplySettingToIPProtocolEndpoint (CIM_IPAssignmentSettingData Configuration, CIM_IPProtocolEndpoint Endpoint, CIM_ConcreteJob Job)
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 Values 0 Completed with No Error 1 Not Supported 2 Unknown/Unspecified Error 3 Failed 4 Invalid Parameter 5 Busy 4096 Method Parameters Checked - Job Started DMTF Reserved 32768..65535 Vendor Reserved Parameters
- IN CIM_IPAssignmentSettingData Configuration
- The IPAssignmentSettingData to apply.
- IN CIM_IPProtocolEndpoint Endpoint
- The IPProtocolEndpoint to which the configuration will be applied.
- OUT CIM_ConcreteJob Job
- 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.