Skip to content

Commit 3411552

Browse files
shwstpprshwstppr
authored
vm: fix display name, internal name notes (apache#177)
* vm: fix display name, internal name notes Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com> * fix Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com> * revert heading Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com> * use brackets Signed-off-by: Abhishek Kumar <abhishek.kumar@shapeblue.com> * change display name to name Signed-off-by: Abhishek Kumar <abhishek.kumar@shapeblue.com> * fix Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com> * table formatting Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com> * fix Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com> * fix Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com> * fix Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com> * changes * fix Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>
1 parent aac90dd commit 3411552

File tree

1 file changed

+19
-29
lines changed

1 file changed

+19
-29
lines changed

‎source/adminguide/virtual_machines.rst‎

Lines changed: 19 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ names can be controlled by the user:
3838

3939
.. note::
4040
You can append the display name of a guest VM to its internal name.
41-
For more information, see `“Appending a Display Name to the Guest VM’s
42-
Internal Name” <#appending-a-display-name-to-the-guest-vms-internal-name>`_.
41+
For more information, see `“Appending a Name to the Guest VM’s
42+
Internal Name” <#appending-a-name-to-the-guest-vms-internal-name>`_.
4343

4444
Guest VMs can be configured to be Highly Available (HA). An HA-enabled
4545
VM is monitored by the system. If the system detects that the VM is
@@ -323,39 +323,29 @@ To access a VM through the CloudStack UI:
323323
#. Click Apply.
324324

325325

326-
Appending a Display Name to the Guest VM’s Internal Name
327-
----------------------------------------------------------
326+
Appending a Name to the Guest VM’s Internal Name
327+
--------------------------------------------------
328328

329-
Every guest VM has an internal name. The host uses the internal name to
330-
identify the guest VMs. CloudStack gives you an option to provide a
331-
guest VM with a display name. You can set this display name as the
332-
internal name so that the vCenter can use it to identify the guest VM. A
333-
new global parameter, vm.instancename.flag, has now been added to
334-
achieve this functionality.
329+
Every guest VM has an internal name. The host uses the internal name to identify the guest VMs. CloudStack gives you an option to provide a guest VM with a name. You can set this name as the internal name so that the vCenter can use it to identify the guest VM. A new global parameter, vm.instancename.flag, has now been added to achieve this functionality.
335330

336-
The default format of the internal name is
337-
i-<user\_id>-<vm\_id>-<instance.name>, where instance.name is a global
338-
parameter. However, If vm.instancename.flag is set to true, and if a
339-
display name is provided during the creation of a guest VM, the display
340-
name is appended to the internal name of the guest VM on the host. This
341-
makes the internal name format as i-<user\_id>-<vm\_id>-<displayName>.
342-
The default value of vm.instancename.flag is set to false. This feature
343-
is intended to make the correlation between instance names and internal
344-
names easier in large data center deployments.
331+
The default format of the internal name is i-<account\_id>-<vm\_id>-<i.n>, where i.n is the value of the global configuration - instance.name. However, If vm.instancename.flag is set to true, and if a name is provided during the creation of a guest VM, the name is appended to the internal name of the guest VM on the host. This makes the internal name format as i-<account\_id>-<vm\_id>-<name>. The default value of vm.instancename.flag is set to false. This feature is intended to make the correlation between instance names and internal names easier in large data center deployments.
345332

346-
The following table explains how a VM name is displayed in different
347-
scenarios.
333+
The following table explains how a VM name is displayed in different scenarios.
348334

349335
.. cssclass:: table-striped table-bordered table-hover
350336

351-
============================= ======================= ==================== ===================================== ==========================
352-
User-Provided Display Name vm.instancename.flag Hostname on the VM Name on vCenter Internal Name
353-
============================= ======================= ==================== ===================================== ==========================
354-
Yes True Display name i-<user\_id>-<vm\_id>-displayName i-<user\_id>-<vm\_id>-displayName
355-
No True UUID i-<user\_id>-<vm\_id>-<instance.name> i-<user\_id>-<vm\_id>-<instance.name>
356-
Yes False Display name i-<user\_id>-<vm\_id>-<instance.name> i-<user\_id>-<vm\_id>-<instance.name>
357-
No False UUID i-<user\_id>-<vm\_id>-<instance.name> i-<user\_id>-<vm\_id>-<instance.name>
358-
============================= ======================= ==================== ===================================== ==========================
337+
======================== =============================== ============================== ============================== ===========================
338+
**User-Provided Name** Yes No Yes No
339+
**vm.instancename.flag** True True False False
340+
**Name** <Name> <i.n>-<UUID> <Name> <i.n>-<UUID>
341+
**Display Name** <Display name> <i.n>-<UUID> <Display name> <i.n>-<UUID>
342+
**Hostname on the VM** <Name> <i.n>-<UUID> <Name> <i.n>-<UUID>
343+
**Name on vCenter** i-<account\_id>-<vm\_id>-<Name> <i.n>-<UUID> i-<account\_id>-<vm\_id>-<i.n> i-<account\_id>-<vm\_id>-<i.n>
344+
**Internal Name** i-<account\_id>-<vm\_id>-<Name> i-<account\_id>-<vm\_id>-<i.n> i-<account\_id>-<vm\_id>-<i.n> i-<account\_id>-<vm\_id>-<i.n>
345+
======================== =============================== ============================== ============================== ===========================
346+
347+
.. note::
348+
<i.n> represents the value of the global configuration - instance.name
359349

360350

361351
Changing the Service Offering for a VM

0 commit comments

Comments
 (0)