1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
|
Client API
==========
Power management
----------------
get_power_state
~~~~~~~~~~~~~~~
Returns the current power state of the node.
set_power_state
~~~~~~~~~~~~~~~
Turns the server power on/off or do a reboot.
Required parameters:
* ``target_state``: target power state. Valid options are: ``POWER_ON``,
``POWER_OFF`` and ``REBOOT``.
Boot management
---------------
list_boot_modes
~~~~~~~~~~~~~~~
Returns the list of boot modes.
list_boot_devices
~~~~~~~~~~~~~~~~~
Returns the list of boot devices.
change_boot_device_order
~~~~~~~~~~~~~~~~~~~~~~~~
Changes the boot device sequence for a boot mode.
Required parameters:
* ``boot_mode``: boot mode for which the boot device list is to be changed.
* ``boot_device_list``: a list of boot device ids in an order representing the
desired boot sequence.
BIOS configuration
------------------
list_bios_settings
~~~~~~~~~~~~~~~~~~
Lists the BIOS configuration settings.
set_bios_settings
~~~~~~~~~~~~~~~~~
Sets the BIOS configuration. To be more precise, it sets the ``pending_value``
parameter for each of the attributes passed in. It returns a dictionary
containing the ``commit_needed`` key with a boolean value indicating whether a
config job must be created for the values to be applied.
Required parameters:
* ``settings``: a dictionary containing the proposed values, with each key
being the name of attribute and the value being the proposed value.
commit_pending_bios_changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Applies all pending changes on the BIOS by creating a config job and returns
the id of the created job.
Optional parameters:
* ``reboot``: indicates whether a RebootJob should also be created or not.
Defaults to ``False``.
abandon_pending_bios_changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Deletes all pending changes on the BIOS.
.. note::
Once a config job has been submitted, it can no longer be abandoned.
RAID management
---------------
list_raid_controllers
~~~~~~~~~~~~~~~~~~~~~
Returns the list of RAID controllers.
list_virtual_disks
~~~~~~~~~~~~~~~~~~
Returns the list of RAID arrays.
list_physical_disks
~~~~~~~~~~~~~~~~~~~
Returns the list of physical disks.
create_virtual_disk
~~~~~~~~~~~~~~~~~~~
Creates a virtual disk and returns a dictionary containing the
``commit_needed`` key with a boolean value indicating whether a config job must
be created for the values to be applied.
.. note::
The created virtual disk will be in pending state.
Required parameters:
* ``raid_controller``: id of the RAID controller.
* ``physical_disks``: ids of the physical disks.
* ``raid_level``: RAID level of the virtual disk.
* ``size_mb``: size of the virtual disk in megabytes.
Optional parameters:
* ``disk_name``: name of the virtual disk.
* ``span_length``: number of disks per span.
* ``span_depth``: number of spans in virtual disk.
delete_virtual_disk
~~~~~~~~~~~~~~~~~~~
Deletes a virtual disk and returns a dictionary containing the
``commit_needed`` key with a boolean value indicating whether a config job must
be created for the values to be applied.
.. note::
The deleted virtual disk will be in pending state. For the changes to be
applied, a config job must be created and the node must be rebooted.
Required parameters:
* ``virtual_disk``: id of the virtual disk.
commit_pending_raid_changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Applies all pending changes on a RAID controller by creating a config job and
returns the id of the created job.
Required parameters:
* ``raid_controller``: id of the RAID controller.
Optional parameters:
* ``reboot``: indicates whether a RebootJob should also be created or not.
Defaults to ``False``.
abandon_pending_raid_changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Deletes all pending changes on a RAID controller.
.. note::
Once a config job has been submitted, it can no longer be abandoned.
Required parameters:
* ``raid_controller``: id of the RAID controller.
Inventory Management
--------------------
list_cpus
~~~~~~~~~
Returns a list of installed CPUs.
list_memory
~~~~~~~~~~~
Returns a list of installed memory modules.
list_nics
~~~~~~~~~
Returns a list of NICs.
Job management
--------------
list_jobs
~~~~~~~~~
Returns a list of jobs from the job queue.
Optional parameters:
* ``only_unfinished``: indicates whether only unfinished jobs should be
returned. Defaults to ``False``.
get_job
~~~~~~~
Returns a job from the job queue.
Required parameters:
* ``job_id``: id of the job.
create_config_job
~~~~~~~~~~~~~~~~~
Creates a config job and returns the id of the created job.
.. note::
In CIM (Common Information Model), weak association is used to name an
instance of one class in the context of an instance of another class.
``SystemName`` and ``SystemCreationClassName`` are the attributes of the
scoping system, while ``Name`` and ``CreationClassName`` are the attributes
of the instance of the class, on which the ``CreateTargetedConfigJob``
method is invoked.
Required parameters:
* ``resource_uri``: URI of resource to invoke.
* ``cim_creation_class_name``: creation class name of the CIM object.
* ``cim_name``: name of the CIM object.
* ``target``: target device.
Optional parameters:
* ``cim_system_creation_class_name``: creation class name of the scoping
system. Defaults to ``DCIM_ComputerSystem``.
* ``cim_system_name``: name of the scoping system. Defaults to
``DCIM:ComputerSystem``.
* ``reboot``: indicates whether a RebootJob should also be created or not.
Defaults to ``False``.
delete_pending_config
~~~~~~~~~~~~~~~~~~~~~
Cancels pending configuration.
.. note::
Once a config job has been submitted, it can no longer be abandoned.
.. note::
In CIM (Common Information Model), weak association is used to name an
instance of one class in the context of an instance of another class.
``SystemName`` and ``SystemCreationClassName`` are the attributes of the
scoping system, while ``Name`` and ``CreationClassName`` are the attributes
of the instance of the class, on which the ``CreateTargetedConfigJob``
method is invoked.
Required parameters:
* ``resource_uri``: URI of resource to invoke.
* ``cim_creation_class_name``: creation class name of the CIM object.
* ``cim_name``: name of the CIM object.
* ``target``: target device.
Optional parameters:
* ``cim_system_creation_class_name``: creation class name of the scoping
system. Defaults to ``DCIM_ComputerSystem``.
* ``cim_system_name``: name of the scoping system. Defaults to
``DCIM:ComputerSystem``.
* ``reboot``: indicates whether a RebootJob should also be created or not.
Defaults to ``False``.
Lifecycle controller management
-------------------------------
get_lifecycle_controller_version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Returns the Lifecycle controller version as a tuple of integers.
|
