LMI_IPAssignmentSettingData¶
Class reference¶
Subclass of CIM_IPAssignmentSettingData
This class and its sub-classes represents Internet Protocol (IP) related settings. When used as an accumulation of settings (AddressOrigin set to 11 “cumulative configuration”), this SettingData instance is the aggregation point identifying an IP configuration. Multiple IP configurations could exist for a target. Each configuration is represented with an instance of IPAssignmentSettingData. The details of the IP configuration are defined by instances of sub-classes of this class (i.e. StaticIPAssignmentSettingData, DHCPSettingData, DNSSettingData). These instances are associated with the IPAssignmentSettingData instance using the OrderedComponent or ConcreteComponent associations. For example, a static IP configuration would be represented by an instance of IPAssignmentSettingData and an instance of StaticIPAssignmentSettingData associated via an instance of ConcreteComponent. A static IP configuration including DNS would be modeled using an instance of IPAssignmentSettingData, DNSSettingData, and StaticIPAssignmentSettingData. The DNSSettingData and StaticIPAssignmentSettingData instance would be associated with the IPAssignmentSettingData using instances of ConcreteComponent.
Key properties¶
Local properties¶
uint16
ProtocolIFType
An enumeration that describes the IP version.
ValueMap Values 4096 IPv4 4097 IPv6 32768 Both IPv4 and IPv6
string
Caption
Name of the configuration.
uint16
IPv6Type
Type of the setting for IPv6. Value of this property comes from LMI_CreateIPSetting method. Use ModifyInstance method to change the type of the configuration.
ValueMap Values 0 Disabled 3 Static 7 DHCPv6 9 Stateless
uint16
AddressOrigin
AddressOrigin identifies the method by which the IP Address, Subnet Mask for IPv4 or Prefix Length for IPv6, and Gateway shall be assigned to the IPProtocolEndpoint.
Value
9 - Stateless
means that the values are autoconfigured using stateless IPv6 configuration. Value11 - Cumulative Configuration
means that the configuration contains multiple sub-configurations, that are in instances of CIM_IPAssignmentSettingData subclasses and are associated via LMI_OrderedIPAssignmentComponent to instance of this class
ValueMap Values 9 Stateless 11 cumulative configuration
uint16
IPv4Type
Type of the setting for IPv4. Value of this property comes from LMI_CreateIPSetting method. Use ModifyInstance method to change the type of the configuration.
ValueMap Values 0 Disabled 3 Static 4 DHCP
Local methods¶
uint32
LMI_AddStaticIPRoute (uint16
AddressType, string
DestinationAddress, string
DestinationMask, uint8
PrefixLength, LMI_IPRouteSettingData Route)
Add static IP route that will be part of the IPAssignmentSettingData.
Parameters
- IN
uint16
AddressTypeAn enumeration that describes the format of the address properties.
ValueMap Values 1 IPv4 2 IPv6 - IN
string
DestinationAddress- The address which serves as the destination to be reached.
- IN
string
DestinationMask- The mask for the IPv4 destination address.
- IN
uint8
PrefixLength- The prefix length for the IPv6 destination address.
- OUT LMI_IPRouteSettingData Route
- Created static IP route
Inherited properties¶
string
SoOrgIDstring
SoIDuint16
AddressPrefixOriginuint16
ChangeableTypestring
InstanceIDstring[]
ComponentSettingstring
ElementNamestring
Descriptionstring
ConfigurationNameuint64
Generationuint16
AddressSuffixOriginInherited methods¶
None