Class CIM_EncapsulationMappingSettingData
extends CIM_SettingData

Generic translation look up record for IP Encapsulation. For example NVGRE and VXLAN. This property contains all of the information required to make the headers for an IP overlay network.

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


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_SettingData
   |
   +--CIM_EncapsulationMappingSettingData

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringGeneric translation look up record for IP Encapsulation. For example NVGRE and VXLAN. This property contains all of the information required to make the headers for an IP overlay network.
Experimentalbooleantrue
UMLPackagePathstringCIM::Network
Versionstring2.45.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
CustomerIdentifierstring
DescriptionstringAn optional property that may be populated with a customer or tenant identifier.
CustomerIPAddressstring
DescriptionstringAn optional IP address of the Virtual machine or the customer system, the overlay network formatted according to the appropriate convention as defined in the AddressType property of this class e.g., 171.79.6.4). This property should be populated for an IP over IP overlay e.g., NVGRE.
CustomerMACAddressstring
DescriptionstringThe MAC address associated with the CustomerAddress. The MAC address is formatted as twelve hexadecimal digits (e.g., "010203040506"), with each pair representing one of the six octets of the MAC address in "canonical" bit order according to RFC " "2469." ),
EncapsulationMetadatastring
DescriptionstringOptional encapsulation type specific metadata that may be included in the encapsulation.
OtherEncapsulationModestring
Descriptionstringif the EncapsulationMode has a value 1 - OtherOtherEncapsulationMode should have a string describing the tunne mode
ProviderIPAddressstring
DescriptionstringThe IP address that will be used on the underlay or provider network for traffic encapsulated using this encapsulation mapping. The address is formatted according to the appropriate convention as defined in the AddressType property of this class (e.g., 171.79.6.40).
ProviderMACAddressstring
DescriptionstringRead only property that contains the encapsulation MAC address on the provider network
VirtualMachineNamestring
DescriptionstringAn optional property that can set to identify the VM corresponding to the CustomerAddress.
VirtualNetworkIdentifierstring
DescriptionstringThis property is populated with the identifier of the virtual or overlay network for the traffic mapped through an instance of this class. For example this would contain a VNI for VXLAN and a VSID for NVGRE.
CustomerIPAddressTypeuint16[]
DescriptionstringAn enumeration that describes the format of the Address property. It is deprecated since it is not needed, as the class contains both IPv4 and v6 addresses
ModelCorrespondencestringCIM_IPProtocolEndpoint.AddressType
ValueMapstring0, 1, 2
ValuesstringUnknown, IPv4, IPv6
EncapsulationModeuint16[]
Descriptionstring1- sets the Encapsulation mode typeOther - should only be used if there is not an enumerated value 2- GRE 3- IP-in-IP 4-NVGRE 5-VXLAN
ValueMapstring1, 2, 3, 4, 5, .., 0x8000..0xFFFF
ValuesstringOther, GRE, IP-in-IP, NVGRE, VXLAN, DMTF Reserved, Vendor Reserved
ProviderIPAddressTypeuint16[]
DescriptionstringAn enumeration that describes the format of the Address property. It is deprecated since it is not needed, as the class contains both IPv4 and v6 addresses
ModelCorrespondencestringCIM_IPProtocolEndpoint.AddressType
ValueMapstring0, 1, 2
ValuesstringUnknown, IPv4, IPv6

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
ChangeableTypeuint16CIM_SettingData
ConfigurationNamestringCIM_SettingData
DescriptionstringCIM_ManagedElement
ElementNamestringCIM_SettingData
Generationuint64CIM_ManagedElement
InstanceIDstringCIM_SettingData
SoIDstringCIM_SettingData
SoOrgIDstringCIM_SettingData
ComponentSettingstring[]CIM_SettingData

Class Methods