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

NameData TypeValue
DescriptionstringThe 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..
UMLPackagePathstringCIM::Network
Versionstring2.52.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

AddIPEncapsulationInterface (uint32)

Method Qualifiers (AddIPEncapsulationInterface)

NameData TypeValue
DescriptionstringCreates 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)

NameTypeQualifiers
NameData TypeValue
CAIPEndpointstring
Descriptionstringstring 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.
EmbeddedInstancestringCIM_IPProtocolEndpoint
EncapsulationGatewaystring
DescriptionstringA 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
EmbeddedInstancestringCIM_IPEncapsulationInterface
PAIPEndpointstring
Descriptionstringstring 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.
EmbeddedInstancestringCIM_IPProtocolEndpoint
EncapsulationMappingstring[]
Descriptionstringarray 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.
EmbeddedInstancestringCIM_EncapsulationMappingSettingData
Job REF CIM_ConcreteJob
Descriptionstringa ConcreteJob instance is returned if the execution of the method is asynchronous
Outbooleantrue
ResultingInterface REF CIM_IPEncapsulationInterface
DescriptionstringIf 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.
Outbooleantrue
TargetSystem REF CIM_System
Descriptionstringreference to a system or network. The supported target interfaces for a CIM_IPEncapsulationInterface class or subclass

AddIPEncapsulationMappings (uint32)

Method Qualifiers (AddIPEncapsulationMappings)

NameData TypeValue
DescriptionstringAdds a set of IPEncapuslationMappings used to configure an IP Tunnel.

Method Parameters (AddIPEncapsulationMappings)

NameTypeQualifiers
NameData TypeValue
EncapsulationMappingsstring[]
Descriptionstringarray 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.
EmbeddedInstancestringCIM_EncapsulationMappingSettingData
Job REF CIM_ConcreteJob
DescriptionstringIf the method is executed asyncronously an reference to CIM_ConcreteJob is returned
Outbooleantrue
TargetInterface REF CIM_IPEncapsulationInterface
DescriptionstringReference to the IPEncapsulationInterface instance to associate the mapping.

RemoveIPEncapsulationInterface (uint32)

Method Qualifiers (RemoveIPEncapsulationInterface)

NameData TypeValue
DescriptionstringMethod to remove an IPEncapsulationInterface and any associated CIM_ProtocolEndpoints or CIM_SettingData.

Method Parameters (RemoveIPEncapsulationInterface)

NameTypeQualifiers
NameData TypeValue
Gateway REF CIM_IPEncapsulationInterface
DescriptionstringA reference to the gateway that is to be removed.
Job REF CIM_ConcreteJob
DescriptionstringIf the method is excuted asynchronously a reference to a ConcreteJob instance is returned.
Outbooleantrue

RemoveIPEncapsulationMappings (uint32)

Method Qualifiers (RemoveIPEncapsulationMappings)

NameData TypeValue
DescriptionstringSuccessful execution of the RemoveIPEncapsulationMappings removes the instances referenced in the methods EncapsulationMapping parameter

Method Parameters (RemoveIPEncapsulationMappings)

NameTypeQualifiers
NameData TypeValue
EncapsulationMappingsCIM_EncapsulationMappingSettingData[]
DescriptionstringAn array of references to the set of CIM_EncapsulationMappingSettingData instances that shall be removed.
Job REF CIM_ConcreteJob
DescriptionstringIf the method is executed asynchronously then a reference to a CIM_ConcreteJob instance is returned
Outbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service