1 marek 1.1 // Copyright (c) 2005 DMTF.  All rights reserved.
 2           // <change cr="SysDevCR00717.001" type ="add">Deprecated</change>
 3           // <change cr="ArchCR00066.004" type="add">Add UmlPackagePath
 4           // qualifier values to CIM Schema.</change>
 5           // ==================================================================
 6           //  CIM_SpareGroup
 7           // ==================================================================
 8              [Deprecated { "CIM_RedundancySet" }, 
 9               Version ( "2.13.0" ), 
10               UMLPackagePath ( "CIM::Core::Redundancy" ), 
11               Description ( 
12                  "A class derived from RedundancyGroup indicating that one or "
13                  "more of the aggregated elements can be spared. (The actual "
14                  "Spares are defined using the ActsAsSpare association.) An "
15                  "example is the use of redundant NICs in a ComputerSystem - "
16                  "where one NIC is primary and the other is Spare. The \'primary\' "
17                  "NIC would be a member of the SpareGroup (associated using the "
18                  "RedundancyComponent class) and the \'other\' NIC would be "
19                  "associated using the ActsAsSpare relationship. \n"
20                  "The use of the class is being deprecated in lieu of using the "
21                  "RedundancySet class." )]
22 marek 1.1 class CIM_SpareGroup : CIM_RedundancyGroup {
23           
24           
25                 [Deprecated { "CIM_RedundancySet.FailOver()" }, 
26                  Description ( 
27                     "This method is forces a failover from one ManagedSystem "
28                     "Element to another. There are two parameters to the "
29                     "Failover method, FailoverFrom and FailoverTo. The "
30                     "FailoverFrom parameter is a reference to the primary "
31                     "ManagedSystemElement that will become inactive after the "
32                     "method. This Element should be associated with the "
33                     "SpareGroup through the RedundancyComponent relationship. "
34                     "The FailoverTo parameter is a reference to the "
35                     "ManagedSystemElement that will take over for the "
36                     "primary. This Element should be associated with the "
37                     "SpareGroup through the ActsAsSpare association. Once the "
38                     "failover has occurred, the SpareGroup and the Redundancy "
39                     "Component and ActsAsSpare associations will be updated "
40                     "with current status. For example, the ActsAsSpare "
41                     "association that contained the FailoverTo Element will "
42                     "be deleted and a new RedundancyComponent association "
43 marek 1.1           "instantiated in its place. The method should return 0 if "
44                     "successful, 1 if the request is not supported, and some "
45                     "other value if any other error occurred. In a subclass, "
46                     "the set of possible return codes could be specified, "
47                     "using a ValueMap qualifier on the method. The strings to "
48                     "which the ValueMap contents are \'translated\' may also "
49                     "be specified in the subclass as a Values array "
50                     "qualifier." )]
51              uint32 Failover(
52                    [IN, Description ( 
53                        "The primary ManagedSystemElement that will become "
54                        "inactive after the method." )]
55                 CIM_ManagedSystemElement REF FailoverFrom, 
56                    [IN, Description ( 
57                        "The ManagedSystemElement that will take over from "
58                        "the primary MSE." )]
59                 CIM_ManagedSystemElement REF FailoverTo);
60           
61           };