SUMMARY: NESTED | FIELD | | METHOD
DETAIL: FIELD | METHOD

Class CIM_ListenerDestination

CIM_ManagedElement
   extended by CIM_ListenerDestination
Known Subclasses:
CIM_ListenerDestinationWSManagement 
Abstract class CIM_ListenerDestination
 extends CIM_ManagedElement


General Information:
The description of a CIM Listener destination. 
A CIM_Listener is an entity capable of receiving CIM Export Messages (e.g., 
Indications or responses to an asynchronous CIM 
Operation).

Qualifiers:
-------------
Abstract
Version=2.22.0
UMLPackagePath=CIM::Event









  
  

    Supported Fields 
      Summary

  

     string 
      
    ElementName 
A 
      user-friendly name for the object . . .

  

     string 
      
    Description 
The 
      Description property provides a textual description of the object.

  

     string 
      
    Caption 
The Caption 
      property is a short textual description (one- line string) of the 
      object.

  

     string 
      
    SystemCreationClassName Key  
A System's CreationClassName . . 
    .

  

     string 
      
    SystemName Key  
A System's Name . . .

  

     string 
      
    CreationClassName Key  
Indicates the name of the class or 
      the subclass used in the creation of an instance . . .

  

     string 
      
    Name Key  
Indicates the name of the CIM Listener 
      destination.

  

     uint16 
      
    PersistenceType 
      
Describes the Persistence Type of the destination defined by 
      this instance . . .

  

     string 
      
    OtherPersistenceType 
      
A string describing ("Other") values for PersistenceType . . 
      .

  

     string 
      
    Destination 
The 
      destination IETF URI to which Export Messages are to be delivered . . 
    .

  

     string 
      
    OtherProtocol 
A 
      free-form string providing a description of the supported protocols when 
      1, "Other", is specified for the Protocol.

  

     uint16 
      
    Protocol 
Protocol 
      describes an encoding and protocol which will be used to deliver the 
      indication . . .




  
  

    Methods Summary

  

     
    Create(Instance, 
      ResourceCreated) 
Creates a new instance of this class

  

     
    Put(Instance) 
Changes 
      properties of the selected instance

  

     
    Get(Instance) 
Gets the 
      representation of the instance

  

     
    Delete() 
Deletes an 
      instance

  

     
    Pull(EnumerationContext, 
      MaxElements) 
Pulls instances of this class, following an 
      Enumerate operation

  

     
    Enumerate() 
      
Enumerates the instances of this class

  

     
    Release(EnumerationContext) 
      
Releases an enumeration context

  

     
    Subscribe() 
      
Subscribes to this resource (WS-Eventing)

  

     
    Unsubscribe() 
      
Remove subscription to this resource 
  (WS-Eventing)




  
  

    Field 
Detail


ElementName 
public string ElementName



  
General Information:
A user-friendly name for the object. This 
  property allows each instance to define a user-friendly name in addition to 
  its key properties, identity data, and description information. 
Note that 
  the Name property of ManagedSystemElement is also defined as a user-friendly 
  name. But, it is often subclassed to be a Key. It is not reasonable that the 
  same property can convey both identity and a user-friendly name, without 
  inconsistencies. Where Name exists and is not a Key (such as for instances of 
  LogicalDevice), the same information can be present in both the Name and 
  ElementName properties. Note that if there is an associated instance of 
  CIM_EnabledLogicalElementCapabilities, restrictions on this properties may 
  exist as defined in ElementNameMask and MaxElementNameLen properties defined 
  in that 
class.

Qualifiers:
-------------
MaxLen=256


  

  





Description 
public string Description



  
General Information:
The Description property provides a textual 
  description of the 
  object.

Qualifiers:
-------------
MaxLen=256


  

  





Caption 
public string Caption



  
General Information:
The Caption property is a short textual 
  description (one- line string) of the 
  object.

Qualifiers:
-------------
MaxLen=64


  

  





SystemCreationClassName Key 
public string SystemCreationClassName



  
General Information:
A System's CreationClassName. A CIM 
  Listener destination is defined in context of a CIM_System (e.g., the sending 
  system.

Qualifiers:
-------------
Key
MaxLen=256


  

  





SystemName Key 
public string SystemName



  
General Information:
A System's Name. A CIM Listener destination 
  is defined in context of a CIM_System (e.g., the sending 
  system.

Qualifiers:
-------------
Key
MaxLen=256


  

  





CreationClassName Key 
public string CreationClassName



  
General Information:
Indicates the name of the class or the 
  subclass used in the creation of an instance. When used with the other key 
  properties of this class, it allows all instances of this class and its 
  subclasses to be uniquely 
  identified.

Qualifiers:
-------------
Key
MaxLen=256


  

  





Name Key 
public string Name



  
General Information:
Indicates the name of the CIM Listener 
  destination.

Qualifiers:
-------------
Key
MaxLen=256


  

  





PersistenceType 
public uint16 PersistenceType



  
General Information:
Describes the Persistence Type of the 
  destination defined by this instance. If the value of PersistenceType is not 
  specified, the value of PersistenceType MUST be treated as 2 ("Permanent"). A 
  value of 2 ("Permanent") declares that the destination is always expected to 
  be available (e.g., system log file). Inability to access this destination 
  MUST be treated as an error condition. A value of 3 ("Transient") indicates 
  that the destination is short-lived. Inability to access the destination MAY 
  be treated as a normal termination condition. Subscriptions with "Transient" 
  destinations MAY be deleted when the destination terminates or is no longer 
  available.

Qualifiers:
-------------
ValueMap={1, 2, 
  3}
Values={Other, Permanent, 
  Transient}
ModelCorrespondence={CIM_ListenerDestination.OtherPersistenceType}


  

  





OtherPersistenceType 
public string OtherPersistenceType



  
General Information:
A string describing ("Other") values for 
  PersistenceType. This value MUST be set to a non NULL value when the 
  PersistenceType is 1 ("Other"). For all other values of PersistenceType, the 
  value of OtherPersistenceType MUST be 
  NULL.

Qualifiers:
-------------
ModelCorrespondence={CIM_ListenerDestination.PersistenceType}
MaxLen=256


  

  





Destination 
public string Destination



  
General Information:
The destination IETF URI to which Export 
  Messages are to be delivered. The scheme in the URI must be supported by 
  theprotocol selected in the Protocol 
  property.

Qualifiers:
-------------
MaxLen=256


  

  





OtherProtocol 
public string OtherProtocol



  
General Information:
A free-form string providing a description 
  of the supported protocols when 1, "Other", is specified for the 
  Protocol.

Qualifiers:
-------------
ModelCorrespondence={CIM_ListenerDestination.Protocol}
MaxLen=256


  

  





Protocol 
public uint16 Protocol



  
General Information:
Protocol describes an encoding and protocol 
  which will be used to deliver the indication. If Other is used, the value for 
  OtherProtocol must not be null.
If a protocol is not specified, 2 "CIM-XML" 
  must be assumed.

Qualifiers:
-------------
ValueMap={1, 2, 
  3, 4, 5, ..}
Values={Other, CIM-XML, SM CLP, WS-Management, WSDM, DMTF 
  Reserved}
ModelCorrespondence={CIM_ListenerDestination.OtherProtocol}


  

  






  
  

    Method 
Detail


Create
public  Create([IN]CIM_ListenerDestination Instance, [OUT] REF CIM_ListenerDestination ResourceCreated)



  
Permission Information:
No permissions defined

General 
  Information:
Creates a new instance of this class

Product 
  Specific Usage:
The following properties must be included in any 
  representation of CIM_ListenerDestination: 

SystemCreationClassName 
  
SystemName 
CreationClassName 
Name 






Put
public  Put([IN]CIM_ListenerDestination Instance)



  
Permission Information:
No permissions defined

General 
  Information:
Changes properties of the selected 
  instance

Product Specific Usage:
The following properties 
  must be included in any representation of CIM_ListenerDestination: 
  

SystemCreationClassName 
SystemName 
CreationClassName 
Name 
  






Get
public  Get([OUT]CIM_ListenerDestination Instance)



  
Permission Information:
No permissions defined

General 
  Information:
Gets the representation of the instance





Delete
public  Delete()



  
Permission Information:
No permissions defined

General 
  Information:
Deletes an instance





Pull
public  Pull([IN]String EnumerationContext, [IN]String MaxElements)



  
Permission Information:
All users permitted to use method, only 
  instances to whom the user has permissions will be returned

General 
  Information:
Pulls instances of this class, following an Enumerate 
  operation





Enumerate
public  Enumerate()



  
Permission Information:
All users permitted to use 
  method

General Information:
Enumerates the instances of this 
  class





Release
public  Release([IN]String EnumerationContext)



  
Permission Information:
All users permitted to use 
  method

General Information:
Releases an enumeration 
  context





Subscribe
public  Subscribe()



  
Permission Information:
No permissions defined

General 
  Information:
Subscribes to this resource (WS-Eventing)





Unsubscribe
public  Unsubscribe()



  
Permission Information:
No permissions defined

General 
  Information:
Remove subscription to this resource 
(WS-Eventing)






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

    
      
Copyright © 2006-2022, Intel 
      Corporation. All rights 
reserved.