Return to CIM_BootService.mof CVS log

Up to [Pegasus] / pegasus / Schemas / CIM231 / DMTF / System

BUG#:9155
TITLE: Upgrade Pegasus to Include the CIM 2.31 Schema in CVS

DESCRIPTION:

// Copyright (c) 2008 DMTF.  All rights reserved.
   [Version ( "2.19.0" ), 
    UMLPackagePath ( "CIM::System::Boot" ), 
    Description ( 
       "A class derived from Service that provides the controls to "
       "manage the boot configuration of a managed computer system or "
       "device. This includes changing the order of the boot devices "
       "and affecting settings on managed elements during the boot "
       "process. This service can also affect the load of a specific "
       "operating system on the computer system through a "
       "BootSourceSetting that points to a specific operating system "
       "image." )]
class CIM_BootService : CIM_Service {


      [Description ( 
          "This method creates a new boot configuration by creating "
          "a replica of an existing boot configuration. The new "
          "boot configuration shall be a duplicate, with the "
          "exception of key property values, of the "
          "BootConfigSetting, and its associated classes, specified "
          "in the StartingBootConfig parameter. If \"State Data "
          "Supported\" is present in the "
          "BootServiceCapabilities.BootCapabilitiesSupported "
          "property, the new BootConfigSetting shall be associated "
          "via ElementSettingData to a \'State\' BootConfigSetting, "
          "which is associated to the ComputerSystem specified by "
          "the ScopingComputerSystem parameter. Otherwise the new "
          "BootConfigSetting shall be directly associated via "
          "ElementSettingData data to the ComputerSystem." ), 
       ValueMap { "0", "1", "2", "3", "4", "5", "6", "..", "4096", 
          "4097..32767", "32768..65535" }, 
       Values { "Completed with No Error", "Not Supported", 
          "Unknown/Unspecified Error", "Busy", "Invalid Reference", 
          "Invalid Parameter", "Access Denied", "DMTF Reserved", 
          "Method Parameters Checked - Job Started", 
          "Method Reserved", "Vendor Specified" }]
   uint32 CreateBootConfigSetting(
         [Required, IN, Description ( 
             "An existing BootConfigSetting instance used as a "
             "template to replicate. factory default "
             "configuration." )]
      CIM_BootConfigSetting REF StartingBootConfig, 
         [IN, Description ( 
             "directly or indirectly associated. If "
             "ScopingComputerSystem has a non-NULL value, the "
             "scoping system for NewBootConfig is explicitly "
             "identified. If ScopingComputerSystem has a value "
             "of NULL, the new BootConfigSetting shall be "
             "related to the same set of ComputerSystems as is "
             "the template configuration." )]
      CIM_ComputerSystem REF ScopingComputerSystem, 
         [IN ( false ), OUT, Description ( 
             "The BootConfigSetting instance created by the "
             "method. This parameter is not returned if the "
             "method is run as a Job." )]
      CIM_BootConfigSetting REF NewBootConfig, 
         [IN ( false ), OUT, Description ( 
             "Reference to the job spawned if the operation "
             "continues after the method returns. (May be null "
             "if the task is completed)." )]
      CIM_ConcreteJob REF Job);

      [Description ( 
          "This method is called to set the role of the "
          "BootConfigSetting that is directly or indirectly "
          "associated to one or more ComputerSystems. The method "
          "applies the new role equally to all related "
          "ComputerSystems. If a BootConfigSetting can be related "
          "to more than one ComputerSystem, but role modification "
          "applies to just one of them, the SetBootConfigUsage "
          "method shall be used instead.\n"
          "The method shall update the IsNext or IsDefault property "
          "of every ElementSettingData that directly or indirectly "
          "associates BootConfigSetting to a ComputerSystem. The "
          "method may also update the IsNext or IsDefault property "
          "of other ElementSettingDatas that reference the same "
          "ComputerSystems to satisfy cardinality constraints." ), 
       ValueMap { "0", "1", "2", "3", "4", "5", "6", "..", "4096", 
          "4097..32767", "32768..65535" }, 
       Values { "Completed with No Error", "Not Supported", 
          "Unknown/Unspecified Error", "Busy", "Invalid Reference", 
          "Invalid Parameter", "Access Denied", "DMTF Reserved", 
          "Method Parameters Checked - Job Started", 
          "Method Reserved", "Vendor Specified" }]
   uint32 SetBootConfigRole(
         [Required, IN, Description ( 
             "An existing BootConfigSetting instance whose role "
             "will be updated." )]
      CIM_BootConfigSetting REF BootConfigSetting, 
         [Required, IN, Description ( 
             "The desired Role of the BootConfigSetting. \n"
             "\"IsNext\" updates the ElementSettingData.IsNext "
             "property and indicates that the specified "
             "BootConfigSetting is to be used in the future when "
             "any of its related ComputerSystems are enabled.\n"
             "\"IsNextSingleUse\" updates the "
             "ElementSettingData.IsNext property. It is similar "
             "to IsNext, except the change applies only to the "
             "next time a related ComputerSystem is enabled.\n"
             "\"IsDefault\" updates the "
             "ElementSettingData.IsDefault property to indicate "
             "that the BootConfigSetting is identified as the "
             "default boot configuration for any of its related "
             "ComputerSystems" ), 
          ValueMap { "0", "1", "2", "3..32767", "32768..65535" }, 
          Values { "IsNext", "IsNextSingleUse", "IsDefault", 
             "DMTF Reserved", "Vendor Specified" }]
      uint16 Role, 
         [IN ( false ), OUT, Description ( 
             "Reference to the job spawned if the operation "
             "continues after the method returns. (May be null "
             "if the task is completed)." )]
      CIM_ConcreteJob REF Job);

      [Description ( 
          "This method is called to set the role of the "
          "BootConfigSetting for a specific ComputerSystem. The "
          "method shall update the IsNext or IsDefault property of "
          "the ElementSettingData that directly or indirectly "
          "associates ScopingComputerSystem and BootConfigSetting. "
          "The method may also update the IsNext or IsDefault "
          "property of other ElementSettingDatas that reference "
          "ScopingComputerSystem to satisfy cardinality "
          "constraints." ), 
       ValueMap { "0", "1", "2", "3", "4", "5", "6", "..", "4096", 
          "4097..32767", "32768..65535" }, 
       Values { "Completed with No Error", "Not Supported", 
          "Unknown/Unspecified Error", "Busy", "Invalid Reference", 
          "Invalid Parameter", "Access Denied", "DMTF Reserved", 
          "Method Parameters Checked - Job Started", 
          "Method Reserved", "Vendor Specified" }]
   uint32 SetBootConfigUsage(
         [Required, IN, Description ( 
             "An existing BootConfigSetting instance whose role "
             "will be updated." )]
      CIM_BootConfigSetting REF BootConfigSetting, 
         [IN, Description ( 
             "The ComputerSystem to which the new Role applies. "
             "A value of NULL indicates that the Role is to be "
             "applied to each ComputerSystem that is directly or "
             "indirectly associated to BootConfigSetting." )]
      CIM_ComputerSystem REF ScopingComputerSystem, 
         [Required, IN, Description ( 
             "The desired Role of the BootConfigSetting.\n"
             "\"IsNext\" updates the ElementSettingData.IsNext "
             "property and indicates that the specified "
             "BootConfigSetting is to be used in the future when "
             "ScopingComputerSystem is enabled.\n"
             "\"IsNextSingleUse\" updates the "
             "ElementSettingData.IsNext property. It is similar "
             "to IsNext, except the change applies only to the "
             "next time the ScopingComputerSystem is enabled.\n"
             "\"IsDefault\" updates the "
             "ElementSettingData.IsDefault property to indicate "
             "that the BootConfigSetting is identified as the "
             "default boot configuration for ScopingComputerSystem\n"
             "\"IsNotNext\" removes the IsNext or "
             "IsNextSingleUse designation. The ComputerSystem "
             "will not be automatically booted the next time it "
             "is enabled.\n"
             "\"IsDefault\" removes the IsDefault designation." ), 
          ValueMap { "0", "1", "2", "3", "4", "5..32767", 
             "32768..65535" }, 
          Values { "IsNext", "IsNextSingleUse", "IsDefault", 
             "IsNotNext", "IsNotDefault", "DMTF Reserved", 
             "Vendor Specified" }]
      uint16 Role, 
         [IN ( false ), OUT, Description ( 
             "Reference to the job spawned if the operation "
             "continues after the method returns. (May be null "
             "if the task is completed)." )]
      CIM_ConcreteJob REF Job);

      [Description ( 
          "This method is called to indicate to the referenced "
          "ComputerSystem to apply the referenced "
          "BootConfigSetting. This shall cause the referenced "
          "ComputerSystem\'s boot process to start and apply the "
          "referenced BootConfigSetting." ), 
       ValueMap { "0", "1", "2", "3", "4", "5", "6", "..", "4096", 
          "4097..32767", "32768..65535" }, 
       Values { "Completed with No Error", "Not Supported", 
          "Unknown/Unspecified Error", "Busy", "Invalid Reference", 
          "Invalid Parameter", "Access Denied", "DMTF Reserved", 
          "Method Parameters Checked - Job Started", 
          "Method Reserved", "Vendor Specified" }]
   uint32 ApplyBootConfigSetting(
         [Required, IN, Description ( 
             "Reference to an instance of ComputerSystem which "
             "will apply the BootConfigSetting referenced by the "
             "ApplyBootConfig parameter. A value of NULL "
             "indicates that the ApplyBootConfig is to be "
             "applied to each related ComputerSystem." )]
      CIM_ComputerSystem REF ScopingComputerSystem, 
         [Required, IN, Description ( 
             "Reference to an instance of BootConfigSetting "
             "which will be applied to the instance of "
             "ComputerSystem referenced by the ComputerSystem "
             "parameter." )]
      CIM_BootConfigSetting REF ApplyBootConfig, 
         [IN ( false ), OUT, Description ( 
             "Reference to the job spawned if the operation "
             "continues after the method returns. (May be null "
             "if the task is completed)." )]
      CIM_ConcreteJob REF Job);

};