# Class CIM_IPEncapsulationManagementService
extends CIM_Service

The service has a set of extrinsic methods to control the creation and removal of the instances required to create an IP encapsulation gateway also known as an IP Tunnel gateway..

### 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_IPEncapsulationManagementService

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | The service has a set of extrinsic methods to control the creation and removal of the instances required to create an IP encapsulation gateway also known as an IP Tunnel gateway..
UMLPackagePath | string | CIM::Network
Version | string | 2.52.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
LoSID | string | CIM_Service
LoSOrgID | string | CIM_Service
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

#### AddIPEncapsulationInterface (uint32)

#### Method Qualifiers (AddIPEncapsulationInterface)

Name | Data Type | Value
--- | --- | ---
Description | string | Creates an instance of CIM_IPEncapsulationInterface that is used in IP Tunnel gateways. The method also creates a set of CIM_IPProtocolEndpoints and optionally a set of CIM_EncapsulationMappingSettingData instances.

#### Method Parameters (AddIPEncapsulationInterface)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
CAIPEndpoint | string
Description | string | string containing an embedded instances of the class or subclass of CIM_IPProtocolEndpoint that describes the initial configuration of an CIM_IPProtocolEndpoint that is on the customer network. The populated properties of the embedded instance should not contain key properties, and any key property values may be ignored.
EmbeddedInstance | string | CIM_IPProtocolEndpoint
EncapsulationGateway | string
Description | string | A required string containing an embedded instance of the class or subclass of CIM_IPEncapsulationInterface describes the initial configuration of the resulting CIM_IPEncapsulationInterface instance. The populated properties of the embedded instance should not contain key properties, and any key property values may be ignored
EmbeddedInstance | string | CIM_IPEncapsulationInterface
PAIPEndpoint | string
Description | string | string containing an embedded instance of the class or subclass of CIM_IPProtocolEndpoint that describes the initial configuration of a CIM_IPProtocolEndpoint that is on the provider network. The populated properties of the embedded instance should not contain key properties, and any key property values may be ignored.
EmbeddedInstance | string | CIM_IPProtocolEndpoint
EncapsulationMapping | string[]
Description | string | array of strings containing embedded instances of the class or subclass of CIM_EncapsulationMappingSettingData that describes entries in a mapping table used by the encapsulation gateway to provide the encapsulation header information used by the gateway. The populated properties of the embedded CIM_EncapsulationMappingSettingData instances should not contain key properties, and any key property values may be ignored.
EmbeddedInstance | string | CIM_EncapsulationMappingSettingData
Job | REF CIM_ConcreteJob
Description | string | a ConcreteJob instance is returned if the execution of the method is asynchronous
Out | boolean | true
ResultingInterface | REF CIM_IPEncapsulationInterface
Description | string | If the creation of the CIM_IPEncapsulationInterface is successful, the instance of the class CIM_IPEncapsulationInterface that represents the instantiated instance of CIM_IPEncapsulationInteface is returned.
Out | boolean | true
TargetSystem | REF CIM_System
Description | string | reference to a system or network. The supported target interfaces for a CIM_IPEncapsulationInterface class or subclass

#### AddIPEncapsulationMappings (uint32)

#### Method Qualifiers (AddIPEncapsulationMappings)

Name | Data Type | Value
--- | --- | ---
Description | string | Adds a set of IPEncapuslationMappings used to configure an IP Tunnel.

#### Method Parameters (AddIPEncapsulationMappings)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
EncapsulationMappings | string[]
Description | string | array of strings containing embedded instances of the class or subclass of CIM_EncapsulationMappingSettingData that describes entries in a mapping table used by the encapsulation interface to provide the encapsulation header for the resultant IIPEncapsulationInterface. The populated properties of the embedded CIM_EncapsulationMappingSettingData instances should not contain key properties, and any key property values may be ignored.
EmbeddedInstance | string | CIM_EncapsulationMappingSettingData
Job | REF CIM_ConcreteJob
Description | string | If the method is executed asyncronously an reference to CIM_ConcreteJob is returned
Out | boolean | true
TargetInterface | REF CIM_IPEncapsulationInterface
Description | string | Reference to the IPEncapsulationInterface instance to associate the mapping.

#### RemoveIPEncapsulationInterface (uint32)

#### Method Qualifiers (RemoveIPEncapsulationInterface)

Name | Data Type | Value
--- | --- | ---
Description | string | Method to remove an IPEncapsulationInterface and any associated CIM_ProtocolEndpoints or CIM_SettingData.

#### Method Parameters (RemoveIPEncapsulationInterface)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Gateway | REF CIM_IPEncapsulationInterface
Description | string | A reference to the gateway that is to be removed.
Job | REF CIM_ConcreteJob
Description | string | If the method is excuted asynchronously a reference to a ConcreteJob instance is returned.
Out | boolean | true

#### RemoveIPEncapsulationMappings (uint32)

#### Method Qualifiers (RemoveIPEncapsulationMappings)

Name | Data Type | Value
--- | --- | ---
Description | string | Successful execution of the RemoveIPEncapsulationMappings removes the instances referenced in the methods EncapsulationMapping parameter

#### Method Parameters (RemoveIPEncapsulationMappings)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
EncapsulationMappings | CIM_EncapsulationMappingSettingData[]
Description | string | An array of references to the set of CIM_EncapsulationMappingSettingData instances that shall be removed.
Job | REF CIM_ConcreteJob
Description | string | If the method is executed asynchronously then a reference to a CIM_ConcreteJob instance is returned
Out | 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