/
xe-vm-param-set.ad
158 lines (109 loc) · 4.08 KB
/
xe-vm-param-set.ad
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
XE(1)
=======
:doctype: manpage
:man source: xe vm-param-set
:man version: {1}
:man manual: xe vm-param-set manual
NAME
-----
xe-vm-param-set - Set parameters for a Virtual Machine (VM)
SYNOPSIS
--------
*xe vm-param-set* uuid=<VM UUID> [ <PARAMETER>=<VALUE> ] [ <MAP PARAMETER>:<MAP PARAMETER KEY>=<VALUE> ]
DESCRIPTION
-----------
*xe vm-param-set* sets writable parameters. Use *xe vm-list* and *xe vm-param-list to identify writable parameters (RW, MRW). To append a value to a writable set or map (SRW, MRW) parameter use *xe vm-param-add*
REQUIRED PARAMETERS
-------------------
*uuid*::
VM UUID - Use *xe VM-list* to obtain a list of VM UUIDs.
OPTIONAL PARAMETERS
-------------------
*name-label*::
Set name of VM. Inclose your name-label in quotes to incorpurate spaces
*name-description*::
Set name-description. Inclose your description in quotes to incorpurate spaces
*user-version*::
Set user-version number
*is-a-template*::
Set template mode of a VM: is-a-template=[ true | false ]
*memory-static-max*::
Set the max static memory in bytes
*memory-dynamic-max*::
Set the max dynamic memory in bytes
*memory-dynamic-min*::
Set the minimal dynamic memory in bytes
*memory-static-min*::
Set the static minimal memory in bytes
*suspend-VDI-uuid*::
Set the suspend VDI UUID
*suspend-SR-uuid*::
Set the suspend SR UUID
*VCPUs-max*::
Set the maximum number of Virtual CPUs
*VCPUs-at-startup*::
Set the maximum number of boot Virtual CPUs
*actions-after-shutdown*::
Set the actions to occur after the VM has shutdown
*actions-after-reboot*::
Set the actions to occur after the VM has rebooted
*actions-after-crash*::
Set the actions to occur after the VM has crashed
*HVM-boot-policy*::
Set the boot policy for HVM guests. Either BIOS Order or an empty string.
*HVM-shadow-multiplier*::
Set a floating point value which controls the amount of shadow memory overhead to grant the VM (Default is 1.0)
*PV-kernel*::
Set path to kernal
*PV-ramdisk*::
Set path to initrd
*PV-args*::
Set a string of kernel command line read/write arguments
*PV-legacy-args*::
Set a string of arguments to make read/write legacy VMs boot
*PV-bootloader*::
Set name or path to bootloader
*PV-bootloader-args*::
Set string of read/write arguments for the bootloader
*affinity*::
Set the prefered host to start the VM on: affinity=<HOST UUID>
*ha-always-run*::
Set the VM to be restarted on another host in case of of the failure of the host the VM is resident on: ha-always-run=< True | False >
*ha-restart-priority*::
Set the HA restart priority, 1 2 3 or best effort. 1 is the highest restart priority: ha-restart-priority=< 1 | 2 | 3 | best effort>
*appliance*::
Set the appliance/vApp to which the VM belongs
*start-delay*::
Set the delay to wait before a call to start up the VM returns
*shutdown-delay*::
Set the delay to wait before a call to shutdown the VM returns
*order*::
Set the start order for vApp startup/shutdown and for startup after HA failover
*VCPUs-params*::
Set configuration parameters for the selected VCPU policy
*platform:*::
Set platform-specific configuration parameters
*blocked-operations:*::
Set blocked-operations: blocked-operations=< start | shutdown | reboot> # Verify
*HVM-boot-params*::
Set HVM-boot-params
*other-config*::
Set other-config parameters
*xenstore-data*::
Set xenstore-data
EXAMPLES
--------
SEE ALSO
--------
*xe help vm-param-set*,
AUTHORS
-------
Manpage Author(s):
- Matthew Spah <spahmatthew@xenapiadmin.com>
BUGS
----
For guidelines on submitting bug reports see http://wiki.xen.org/wiki/Reporting_Bugs_against_XCP. Submit bugs and general questions to xen-api@lists.xen.org.
COPYRIGHT
---------
Copyright \(C) 2014- Matthew Spah
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".