Skip to content

vm: fix display name, internal name notes #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yadvr merged 12 commits into from
Mar 29, 2021
Merged

vm: fix display name, internal name notes #177

Changes from 6 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
76e54ad
vm: fix display name, internal name notes
shwstppr Jan 8, 2021
d6f41e3
fix
shwstppr Jan 13, 2021
6688f7e
revert heading
shwstppr Jan 14, 2021
b343829
use brackets
shwstppr Jan 27, 2021
88f3d30
change display name to name
shwstppr Jan 27, 2021
bdcd39e
fix
shwstppr Jan 28, 2021
0f1c118
table formatting
shwstppr Feb 4, 2021
f68b48d
fix
shwstppr Feb 4, 2021
af2eb06
fix
shwstppr Feb 4, 2021
d758b7c
fix
shwstppr Feb 5, 2021
5d7ff20
changes
shwstppr Feb 5, 2021
1cb84c9
fix
shwstppr Mar 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 16 additions & 30 deletions source/adminguide/virtual_machines.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,39 +322,25 @@ To access a VM through the CloudStack UI:
#. Click Apply.


Appending a Display Name to the Guest VM’s Internal Name
----------------------------------------------------------

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 display name. You can set this display 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.

The default format of the internal name is
i-<user\_id>-<vm\_id>-<instance.name>, where instance.name is a global
parameter. However, If vm.instancename.flag is set to true, and if a
display name is provided during the creation of a guest VM, the display
name is appended to the internal name of the guest VM on the host. This
makes the internal name format as i-<user\_id>-<vm\_id>-<displayName>.
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.

The following table explains how a VM name is displayed in different
scenarios.
Appending a Name to the Guest VM’s Internal Name
------------------------------------------------

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.

The default format of the internal name is i-<user\_id>-<vm\_id>-<instance.name>, where instance.name is a global parameter. 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-<user\_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.

The following table explains how a VM name is displayed in different scenarios.

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

============================= ======================= ==================== ===================================== ==========================
User-Provided Display Name vm.instancename.flag Hostname on the VM Name on vCenter Internal Name
============================= ======================= ==================== ===================================== ==========================
Yes True Display name i-<user\_id>-<vm\_id>-displayName i-<user\_id>-<vm\_id>-displayName
No True UUID i-<user\_id>-<vm\_id>-<instance.name> i-<user\_id>-<vm\_id>-<instance.name>
Yes False Display name i-<user\_id>-<vm\_id>-<instance.name> i-<user\_id>-<vm\_id>-<instance.name>
No False UUID i-<user\_id>-<vm\_id>-<instance.name> i-<user\_id>-<vm\_id>-<instance.name>
============================= ======================= ==================== ===================================== ==========================
===================== ======================= ====================== ====================== ====================== ===================================== ==========================
User-Provided Name vm.instancename.flag User Display Name Hostname on the VM Name on vCenter Internal Name
===================== ======================= ====================== ====================== ====================== ===================================== ==========================
Yes True <Name> <Display name> <Name> i-<user\_id>-<vm\_id>-<Name> i-<user\_id>-<vm\_id>-<Name>
No True <instance.name>-<UUID> <instance.name>-<UUID> <instance.name>-<UUID> <instance.name>-<UUID> i-<user\_id>-<vm\_id>-<instance.name>
Yes False <Name> <Display name> <Name> i-<user\_id>-<vm\_id>-<instance.name> i-<user\_id>-<vm\_id>-<instance.name>
No False <instance.name>-<UUID> <instance.name>-<UUID> <instance.name>-<UUID> i-<user\_id>-<vm\_id>-<instance.name> i-<user\_id>-<vm\_id>-<instance.name>
===================== ======================= ====================== ====================== ====================== ===================================== ==========================


Changing the Service Offering for a VM
Expand Down