wet_schema.mof

Pegasus is an open-source implementationof the DMTF CIM and WBEM standards. It is designed to be por

        "functional requests. In an offline state, a Device may be capable "
        "of running diagnostics or generating operational alerts. For "
        "example, when the \"Offline\" button is pushed on a Printer, the "
        "Device is no longer available to process print jobs, but "
        "could be available for diagnostics or maintenance.\n"
        "If this method is successful, the Device's Availability and "
        "AdditionalAvailability properties should reflect the updated "
        "status. If a failure occurs trying to bring the Device online "
        "or offline, it should remain in its current state. IE, the "
        "request, if unsuccessful, should not leave the Device in an "
        "indeterminate state. When bringing a Device back \"Online\", "
        "from an \"Offline\" mode, the Device should be restored to its "
        "last \"Online\" state, if at all possible. Only a Device that "
        "has a StatusInfo of \"Enabled\" (value=3) and has been "
        "configured can be brought online or taken offline.\n"
        "OnlineDevice should return 0 if successful, 1 if the request is not "
        "supported at all, 2 if the request is not supported due to the "
        "current state of the Device, and some other value if any other "
        "error occurred. In a subclass, the set of possible return codes "
        "could be specified, using a ValueMap qualifier on the method. "
        "The strings to which the ValueMap contents are 'translated' may "
        "also be specified in the subclass as a Values array qualifier.") ]
   uint32 OnlineDevice(
      [IN] boolean Online);
      [Description (
        "Requests that the LogicalDevice cleanly cease all current "
        "activity (\"Quiesce\" input parameter = TRUE) or resume "
        "activity (= FALSE). For this method to quiesce a Device, "
        "that Device should have an Availability (or Additional"
        "Availability) of \"Running/Full Power\" (value=3) and a "
        "StatusInfo of \"Enabled\" (value=3). For example, if quiesced, "
        "a Device may then be offlined for diagnostics, or disabled "
        "for power off and hot swap.  For the method to \"unquiesce\" "
        "a Device, that Device should have an Availability (or Additional"
        "Availability) of \"Quiesced\" (value=21) and a StatusInfo of "
        "\"Enabled\" (value=3). In this case, the Device would "
        "be returned to an \"Enabled\" and \"Running/Full Power\" "
        "status.\n"
        "The method's return code should indicate the success or "
        "failure of the quiesce. It should return 0 if successful, "
        "1 if the request is not supported at all, 2 if the request "
        "is not supported due to the current state of the Device, "
        "and some other value if any other error occurred. In a subclass, "
        "the set of possible return codes could be specified, using a "
        "ValueMap qualifier on the method.  The strings to which the "
        "ValueMap contents are 'translated' may also be specified in "
        "the subclass as a Values array qualifier.") ]
   uint32 QuiesceDevice(
      [IN] boolean Quiesce);
      [Description (
        "Requests that the Device capture its current configuration, "
        "setup and/or state information in a backing store. The goal "
        "would be to use this information at a later time (via the "
        "RestoreProperties method), to return a Device to its present "
        "\"condition\". This method may not be supported by all Devices.  "
        "The method should return 0 if successful, 1 if the request is "
        "not supported, and some other value if any other error occurred. "
        "In a subclass, the set of possible return codes could be "
        "specified, using a ValueMap qualifier on the method. The strings "
        "to which the ValueMap contents are 'translated' may also be "
        "specified in the subclass as a Values array qualifier.") ]
   uint32 SaveProperties();
      [Description (
        "Requests that the Device re-establish its configuration, "
        "setup and/or state information from a backing store. The "
        "intent is to capture this information at an earlier time "
        "(via the SaveProperties method), and use it to return a "
        "Device to this earlier \"condition\". This method may not "
        "be supported by all Devices. The method should return 0 if "
        "successful, 1 if the request is not supported, and some "
        "other value if any other error occurred. In a subclass, "
        "the set of possible return codes could be specified, using "
        "a ValueMap qualifier on the method. The strings to which "
        "the ValueMap contents are 'translated' may also be specified "
        "in the subclass as a Values array qualifier.") ]
   uint32 RestoreProperties();        
};  

   
// ==================================================================
//    Service
// ==================================================================  
   [Abstract, Description (
     "A WET_Service is a Logical Element that contains the "
     "information necessary to represent and manage the "
     "functionality provided by a Device and/or SoftwareFeature. "
     "A Service is a general-purpose object to configure and "
     "manage the implementation of functionality.  It is not the "
     "functionality itself.") ] 
class WET_Service : WET_LogicalElement {
      [Propagated ("WET_System.CreationClassName"), Key, 
       MaxLen (256), Description (
        "The scoping System's CreationClassName. ") ] 
   string SystemCreationClassName;
      [Propagated ("WET_System.Name"), Key, MaxLen (256),
       Description ("The scoping System's Name.") ] 
   string SystemName;
      [Key, MaxLen (256), Description (
        "CreationClassName 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, this property "
        "allows all instances of this class and its subclasses to "
        "be uniquely identified.") ]
   string CreationClassName;
      [Override ("Name"), Key, MaxLen (256), Description (
        "The Name property uniquely identifies the Service and "
        "provides an indication of the functionality that is "
        "managed. This functionality is described in more detail in "
        "the object's Description property. ") ] 
   string Name;
      [MaxLen (10), Description (
        "StartMode is a string value indicating whether the Service "
        "is automatically started by a System, Operating System, etc. "
        "or only started upon request."), 
       ValueMap {"Automatic", "Manual"} ] 
   string StartMode;
      [Description (
        "Started is a boolean indicating whether the Service "
        "has been started (TRUE), or stopped (FALSE).") ] 
   boolean Started;
      [Description (
        "The StartService method places the Service in the started "
        "state. It returns an integer value of 0 if the Service was "
        "successfully started, 1 if the request is not supported and "
        "any other number to indicate an error. In a subclass, the "
        "set of possible return codes could be specified, using a "
        "ValueMap qualifier on the method. The strings to which the "
        "ValueMap contents are 'translated' may also be specified in "
        "the subclass as a Values array qualifier.") ] 
   uint32 StartService();
      [Description (
        "The StopService method places the Service in the stopped "
        "state. It returns an integer value of 0 if the Service was "
        "successfully stopped, 1 if the request is not supported and "
        "any other number to indicate an error. In a subclass, the "
        "set of possible return codes could be specified, using a "
        "ValueMap qualifier on the method. The strings to which the "
        "ValueMap contents are 'translated' may also be specified in "
        "the subclass as a Values array qualifier.") ] 
   uint32 StopService();
};

     
// ==================================================================
//    ServiceAccessPoint
// ==================================================================
   [Abstract, Description (
     "WET_ServiceAccessPoint represents the ability to utilize or "
     "invoke a Service.  Access points represent that a Service is "
     "made available to other entities for use.") ] 
class WET_ServiceAccessPoint : WET_LogicalElement {
      [Propagated ("WET_System.CreationClassName"), Key, 
       MaxLen (256), Description (
        "The scoping System's CreationClassName.") ] 
   string SystemCreationClassName;
      [Propagated ("WET_System.Name"), Key, MaxLen (256),
       Description ("The scoping System's Name.") ] 
   string SystemName;
      [Key, MaxLen (256), Description (
        "CreationClassName 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, this property "
        "allows all instances of this class and its subclasses to "
        "be uniquely identified.") ]
   string CreationClassName;
      [Override ("Name"), Key, MaxLen (256), Description (
        "The Name property uniquely identifies the ServiceAccessPoint "
        "and provides an indication of the functionality that is "
        "managed.  This functionality is described in more detail in "
        "the object's Description property.") ] 
   string Name;
};

     
// ==================================================================
// Dependency   
// ==================================================================
   [Association, Abstract, Description (   
     "WET_Dependency is a generic association used to establish "   
     "dependency relationships between ManagedElements.") ]    
class WET_Dependency {   
      [Key, Description (   
        "Antecedent represents the independent object in this "   
        "association.") ]    
   WET_ManagedElement REF Antecedent;   
      [Key, Description (   
        "Dependent represents the object dependent on the "   
        "Antecedent.") ]    
   WET_ManagedElement REF Dependent;   
};   
 
                 
// ==================================================================
// MemberOfCollection    
// ==================================================================
   [Association, Aggregation, Description (   
     "WET_MemberOfCollection is an aggregation used to establish "   
     "membership of ManagedElements in a Collection." ) ]  
class WET_MemberOfCollection {   
      [Key, Aggregate, Description (
        "The Collection that aggregates members") ]    
   WET_Collection REF Collection;
      [Key, Description (
        "The aggregated member of the collection.") ]    
   WET_ManagedElement REF Member;   
};   


// ==================================================================
//    CollectedMSEs
// ==================================================================
   [Association, Aggregation, Description (
     "WET_CollectedMSEs is a generic association used to "
     "establish the members of the grouping object, CollectionOf"
     "MSEs.") ]
class WET_CollectedMSEs : WET_MemberOfCollection {
      [Aggregate, Description (
        "The grouping or 'bag' object that represents the "
        "Collection."), Override("Collection") ]
   WET_CollectionOfMSEs REF Collection;
      [Description ("The members of the Collection."),
       Override("Member") ]
   WET_ManagedSystemElement REF Member;
};


// ==================================================================
//    ServiceAccessBySAP
// ==================================================================
   [Association, Description (
     "WET_ServiceAccessBySAP is an association that identifies the "
     "access points for a Service. For example, a printer may be "
     "accessed by Netware, MacIntosh or Windows ServiceAccess"
     "Points, potentially hosted on different Systems.") ] 
class WET_ServiceAccessBySAP : WET_Dependency {
      [Override ("Antecedent"),
       Description ("The Service. ") ] 
   WET_Service REF Antecedent;
      [Override ("Dependent"), Description (
        "An Access Point for a Service. Access points are dependent " 
        "in this relationship since they have no function without a "
        "corresponding Service. ") ] 
   WET_ServiceAccessPoint REF Dependent;
};

     
// ==================================================================
//    HostedService
// ==================================================================
   [Association, Description (
     "WET_HostedService is an association between a Service and "
     "the System on which the functionality resides.  The "
     "cardinality of this association is 1-to-many.  A System may "
     "host many Services. Services are weak with respect to their "
     "hosting System. Heuristic:  A Service is hosted on the "
     "System where the LogicalDevices or SoftwareFeatures that "
     "implement the Service are located.  The model does not "
     "represent Services hosted across multiple systems.  This is "
     "modeled as an ApplicationSystem that acts as an aggregation "