...
Add VM variables
Excerpt | |||||||||
---|---|---|---|---|---|---|---|---|---|
| |||||||||
Before you deploy a VM, you can set guest variables to pass user data to your VM. This functionality uses cloud-init and requires appropriate templates. In private cloud, the templates must have the guest setup flag set to cloud init. The administrator can add default variables Include Page | | Add VM variables | Add VM variables |
Tip |
---|
This functionality is available through the API. The platform stores variables in the VirtualMachine |
Info |
---|
You can modify VM variables before you deploy the VM |
Note |
---|
Check your cloud providers' documentation for their recommendations about confidential information in variables |
To add VM variables:
Go to Virtual datacenters and edit a VM that is not deployed
Go to Variables
Enter a Key and Value
The length of these can be up to 255 characters each
Click Add
Add more variables as required
To delete a variable click the trash can symbol beside the Key. To edit the Value of a variable, click the pencil edit button beside the Value
To apply changes to variables, and other changes to the VM, click Save
...
Read guest variables
To delete a variable:
- Click the X in the left column beside the variable Name.
- To apply changes to variables, and other changes to the VM, click Save
Read Guest Variables
...
Related pages
...
The location of the variable will depend on the method of guest setup that you are using for your VM.
Here are some general guidelines.
Cloud | Method | Variable location |
---|---|---|
Private | Cloud-init |
|
Private | Hypervisor tools | On ESXi, run this command on the guest to get the value of a variable: |
Private | Hypervisor tools | For vCloud Director, hypervisor tools does not support variables |
Public | Cloud-init | The variables are stored in the |
Amazon | Cloudbase-init | On Windows, the variables are stored in the |
Azure | Cloud-init | On Windows, according to the Azure documentation on custom data
On Linux, use cloud-init to read the variables from custom data. |