316 lines
17 KiB
Plaintext
316 lines
17 KiB
Plaintext
// 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 {
|
|
|
|
[Override ( "EnabledState" ),
|
|
Description (
|
|
"EnabledState is an integer enumeration that indicates "
|
|
"the enabled and disabled states of an element. It can "
|
|
"also indicate the transitions between these requested "
|
|
"states. For example, shutting down (value=4) and "
|
|
"starting (value=10) are transient states between enabled "
|
|
"and disabled. The following text briefly summarizes the "
|
|
"various enabled and disabled states: \n"
|
|
"Enabled (2) indicates that the element is or could be "
|
|
"executing commands, will process any queued commands, "
|
|
"and queues new requests. \n"
|
|
"Disabled (3) indicates that the element will not execute "
|
|
"commands and will drop any new requests. \n"
|
|
"Shutting Down (4) indicates that the element is in the "
|
|
"process of going to a Disabled state. \n"
|
|
"Not Applicable (5) indicates the element does not "
|
|
"support being enabled or disabled. \n"
|
|
"Enabled but Offline (6) indicates that the element might "
|
|
"be completing commands, and will drop any new requests. \n"
|
|
"Test (7) indicates that the element is in a test state. \n"
|
|
"Deferred (8) indicates that the element might be "
|
|
"completing commands, but will queue any new requests. \n"
|
|
"Quiesce (9) indicates that the element is enabled but in "
|
|
"a restricted mode. The behavior of the element is "
|
|
"similar to the Enabled state, but it processes only a "
|
|
"restricted set of commands. All other requests are "
|
|
"queued. \n"
|
|
"Starting (10) indicates that the element is in the "
|
|
"process of going to an Enabled state. New requests are "
|
|
"queued."
|
|
"Default value is 32769, means that OCR is enabled and RPE is disabled" ),
|
|
ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
|
|
"10", "11..32767", "32768", "32769", "32770", "32771", "32772..65535" },
|
|
Values { "Unknown", "Other", "Enabled", "Disabled",
|
|
"Shutting Down", "Not Applicable", "Enabled but Offline",
|
|
"In Test", "Deferred", "Quiesce", "Starting",
|
|
"DMTF Reserved", "OCR and RPE are disabled, all other boot options are enabled", "OCR is enabled, RPE is disabled, all other boot options are enabled",
|
|
"RPE is enabled, OCR is disabled, all other boot options are enabled", "OCR, RPE and all other boot options are enabled",
|
|
"Vendor Reserved" },
|
|
ModelCorrespondence {
|
|
"CIM_EnabledLogicalElement.OtherEnabledState" }]
|
|
uint16 EnabledState = 5;
|
|
|
|
[Override ( "RequestStateChange" ),
|
|
Description (
|
|
"Requests that the state of the element be changed to the "
|
|
"value specified in the RequestedState parameter. When "
|
|
"the requested state change takes place, the EnabledState "
|
|
"and RequestedState of the element will be the same. "
|
|
"Invoking the RequestStateChange method multiple times "
|
|
"could result in earlier requests being overwritten or "
|
|
"lost. \n"
|
|
"If 0 is returned, then the task completed successfully "
|
|
"and the use of ConcreteJob was not required. If 4096 "
|
|
"(0x1000) is returned, then the task will take some time "
|
|
"to complete, ConcreteJob will be created, and its "
|
|
"reference returned in the output parameter Job. Any "
|
|
"other return code indicates an error condition." ),
|
|
ValueMap { "0", "1", "2", "3", "4", "5", "6", "..", "4096",
|
|
"4097", "4098", "4099", "4100..32767", "32768..65535" },
|
|
Values { "Completed with No Error", "Not Supported",
|
|
"Unknown or Unspecified Error",
|
|
"Cannot complete within Timeout Period", "Failed",
|
|
"Invalid Parameter", "In Use", "DMTF Reserved",
|
|
"Method Parameters Checked - Job Started",
|
|
"Invalid State Transition",
|
|
"Use of Timeout Parameter Not Supported", "Busy",
|
|
"Method Reserved", "Vendor Specific" },
|
|
ModelCorrespondence {
|
|
"CIM_EnabledLogicalElement.RequestedState" }]
|
|
uint32 RequestStateChange(
|
|
[IN, Description (
|
|
"The state requested for the element. This "
|
|
"information will be placed into the RequestedState "
|
|
"property of the instance if the return code of the "
|
|
"RequestStateChange method is 0 (\'Completed with "
|
|
"No Error\'), 3 (\'Timeout\'), or 4096 (0x1000) "
|
|
"(\'Job Started\'). Refer to the description of the "
|
|
"EnabledState and RequestedState properties for the "
|
|
"detailed explanations of the RequestedState "
|
|
"values." ),
|
|
ValueMap { "2", "3", "4", "6", "7", "8", "9", "10",
|
|
"11", "12..32767", "32768", "32769", "32770", "32771" },
|
|
Values { "Enabled", "Disabled", "Shut Down", "Offline",
|
|
"Test", "Defer", "Quiesce", "Reboot", "Reset",
|
|
"DMTF Reserved", "disable OCR and RPE, enable all other boot options", "disable RPE, enable OCR and all other boot options",
|
|
"disable OCR, enable RPE and all other boot options", "enable OCR, RPE and all other boot options" },
|
|
ModelCorrespondence {
|
|
"CIM_EnabledLogicalElement.RequestedState" }]
|
|
uint16 RequestedState,
|
|
[IN ( false ), OUT, Description (
|
|
"Reference to the job (can be null if the task is completed)."
|
|
)]
|
|
CIM_ConcreteJob REF Job,
|
|
[IN, Description (
|
|
"A timeout period that specifies the maximum amount "
|
|
"of time that the client expects the transition to "
|
|
"the new state to take. The interval format must be "
|
|
"used to specify the TimeoutPeriod. A value of 0 or "
|
|
"a null parameter indicates that the client has no "
|
|
"time requirements for the transition. \n"
|
|
"If this property does not contain 0 or null and "
|
|
"the implementation does not support this "
|
|
"parameter, a return code of \'Use Of Timeout "
|
|
"Parameter Not Supported\' must be returned." )]
|
|
datetime TimeoutPeriod);
|
|
|
|
[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);
|
|
|
|
};
|