1 krisbash 1.1 // Copyright (c) 2010 DMTF. All rights reserved.
2 [Version ( "2.25.0" ),
3 UMLPackagePath ( "CIM::System::SystemElements" ),
4 Description (
5 "CIM_VirtualSystemSettingData defines the virtual aspects of a "
6 "virtual system through a set of virtualization specific "
7 "properties. CIM_VirtualSystemSettingData is also used as the "
8 "top level class of virtual system configurations. Virtual "
9 "system configurations model configuration information about "
10 "virtual systems and their components. A virtual system "
11 "configuration consists of one top-level instance of class "
12 "CIM_VirtualSystemSettingData that aggregates a number of "
13 "instances of class CIM_ResourceAllocationSettingData, using "
14 "association CIM_ConcreteComponent. \n"
15 "Virtual system configurations may for example be used to "
16 "reflect configurations of \n"
17 "- virtual systems that are defined at a virtualization "
18 "platform, \n"
19 "- virtual systems that are currently active, \n"
20 "- input requests to create new virtual systems, \n"
21 "- input requests to modify existing virtual systems, or \n"
22 krisbash 1.1 "- snapshots of virtual systems." )]
23 class CIM_VirtualSystemSettingData : CIM_SettingData {
24
25 [Description (
26 "VirtualSystemIdentifier shall reflect a unique name for "
27 "the system as it is used within the virtualization "
28 "platform. Note that the VirtualSystemIdentifier is not "
29 "the hostname assigned to the operating system instance "
30 "running within the virtual system, nor is it an IP "
31 "address or MAC address assigned to any of its network "
32 "ports. \n"
33 "On create requests VirtualSystemIdentifier may contain "
34 "implementation specific rules (like simple patterns or "
35 "regular expresssion) that may be interpreted by the "
36 "implementation when assigning a VirtualSystemIdentifier." )]
37 string VirtualSystemIdentifier;
38
39 [Description (
40 "VirtualSystemType shall reflect a particular type of "
41 "virtual system.\n"
42 "The property value shall conform to this format (in "
43 krisbash 1.1 "ABNF): vs-type = dmtf-value / other-org-value / "
44 "legacy-value; dmtf-value = \"DMTF:\" defining-org \":\" "
45 "org-vs-type; other-org-value = defining-org \":\" org-vs-type;\n"
46 "Where: dmtf-value:\n"
47 "is a property value defined by DMTF and is defined in "
48 "the description of this property. other-org-value:\n"
49 "is a property value defined by a business entity other "
50 "than DMTF and is not defined in the description of this "
51 "property. legacy-value:\n"
52 "is a property value defined by a business entity other "
53 "than DMTF and is not defined in the description of this "
54 "property. These values are permitted but recommended to "
55 "be deprecated over time. defining-org:\n"
56 "is an identifier for the business entity that defines "
57 "the virtual system type. It shall include a copyrighted, "
58 "trademarked, or otherwise unique name that is owned by "
59 "that business entity. It shall not be \"DMTF\" and shall "
60 "not contain a colon (:). org-vs-type:\n"
61 "is an identifier for the virtual system type within the "
62 "defining business entity. It shall be unique within the "
63 "defining-org. It may use any character allowed for CIM "
64 krisbash 1.1 "strings, except for the following: U0000-U001F (Unicode "
65 "C0 controls) U0020 (space), note that the reason is that "
66 "OVF allows for multiple space-separated vs-type values "
67 "in this property. U007F (Unicode C0 controls) "
68 "U0080-U009F (Unicode C1 controls)\n"
69 "If there is a need to structure the value into segments, "
70 "the segments should be separated with a single colon (:).\n"
71 "The values of this property shall be processed case "
72 "sensitively. They are intended to be processed "
73 "programmatically (instead of being a display name) and "
74 "should be short.\n"
75 "As stated in the class description, instances of this "
76 "class may be used for various purposes. A management "
77 "application intending to use an instance of this class "
78 "as input parameter to an operation that creates or "
79 "modifies a virtual system should first determine the set "
80 "of valid virtual system types that are supported by the "
81 "virtualization platform hosting the virtual system by "
82 "inspecting values of array property "
83 "VirtualSystemTypesSupported of the instance of class "
84 "CIM_VirtualSystemManagementCapabilities that describes "
85 krisbash 1.1 "the capabilities of the virtualization platform.\n"
86 "The following DMTF values are defined: DMTF:unknown - "
87 "the virtual system type is unknown or cannot be "
88 "determined" )]
89 string VirtualSystemType;
90
91 [Description (
92 "End-user supplied notes that are related to the virtual system."
93 )]
94 string Notes[];
95
96 [Description (
97 "Time when the virtual system configuration was created." )]
98 datetime CreationTime;
99
100 [Description (
101 "Unique id of the virtual system configuration. Note that "
102 "the ConfigurationID is different from the InstanceID as "
103 "it is assigned by the implementation to a virtual system "
104 "or a virtual system configuration. It is not a key, and "
105 "the same value may occur within more than one instance." )]
106 krisbash 1.1 string ConfigurationID;
107
108 [Description (
109 "Filepath of a directory where information about the "
110 "virtual system configuration is stored.Format shall be "
111 "URI based on RFC 2079." )]
112 string ConfigurationDataRoot;
113
114 [Description (
115 "Filepath of a file where information about the virtual "
116 "system configuration is stored. A relative path appends "
117 "to the value of the ConfigurationDataRoot "
118 "property.Format shall be URI based on RFC 2079." )]
119 string ConfigurationFile;
120
121 [Description (
122 "Filepath of a directory where information about virtual "
123 "system snapshots is stored. A relative path appends to "
124 "the value of the ConfigurationDataRoot property.Format "
125 "shall be URI based on RFC 2079." )]
126 string SnapshotDataRoot;
127 krisbash 1.1
128 [Description (
129 "Filepath of a directory where suspend related "
130 "information about the virtual system is stored. A "
131 "relative path appends to the value of the "
132 "ConfigurationDataRoot property.Format shall be URI based "
133 "on RFC 2079." )]
134 string SuspendDataRoot;
135
136 [Description (
137 "Filepath of a directory where swapfiles of the virtual "
138 "system are stored. A relative path appends to the value "
139 "of the ConfigurationDataRoot property.Format shall be "
140 "URI based on RFC 2079." )]
141 string SwapFileDataRoot;
142
143 [Description (
144 "Filepath of a directory where log information about the "
145 "virtual system is stored. A relative path appends to the "
146 "value of the ConfigurationDataRoot property.Format shall "
147 "be URI based on RFC 2079." )]
148 krisbash 1.1 string LogDataRoot;
149
150 [Description (
151 "Action to take for the virtual system when the host is started."
152 ),
153 ValueMap { "2", "3", "4", ".." },
154 Values { "None", "Restart if previously active",
155 "Always startup", "DMTF Reserved" }]
156 uint16 AutomaticStartupAction;
157
158 [Description (
159 "Delay applicable to startup action. The value shall be "
160 "in the interval variant of the datetime datatype." )]
161 datetime AutomaticStartupActionDelay;
162
163 [Description (
164 "Number indicating the relative sequence of virtual "
165 "system activation when the host system is started. A "
166 "lower number indicates earlier activation. If one or "
167 "more configurations show the same value, the sequence is "
168 "implementation dependent. A value of 0 indicates that "
169 krisbash 1.1 "the sequence is implementation dependent." )]
170 uint16 AutomaticStartupActionSequenceNumber;
171
172 [Description (
173 "Action to take for the virtual system when the host is shut down."
174 ),
175 ValueMap { "2", "3", "4", ".." },
176 Values { "Turn Off", "Save state", "Shutdown", "DMTF Reserved" }]
177 uint16 AutomaticShutdownAction;
178
179 [Description (
180 "Action to take for the virtual system when the software "
181 "executed by the virtual system fails. Failures in this "
182 "case means a failure that is detectable by the host "
183 "platform, such as a non-interuptable wait state "
184 "condition." ),
185 ValueMap { "2", "3", "4", ".." },
186 Values { "None", "Restart", "Revert to snapshot",
187 "DMTF Reserved" }]
188 uint16 AutomaticRecoveryAction;
189
190 krisbash 1.1 [Description (
191 "Filepath of a file where recovery relateded information "
192 "of the virtual system is stored.Format shall be URI "
193 "based on RFC 2079." )]
194 string RecoveryFile;
195
196
197 };
|