Dec. 22, 2015
An instance is another term used for a virtual machine. Virtual machines are software implementations of physical computers, and can execute computer programs. You can power on, power off, or suspend a virtual machine just like you would a physical computer.
Display Name: A unique name given to your VM by your service provider.
Group: The group to which the VM belongs. This is set when the VM is created.
Zone: A unique zone in which your VM is placed.
Template: The template from which your VM was created.
Compute Details: Details about the compute resources. CPU, RAM, and so on.
Account: The account this VM was created in.
Domain: The domain in which this VM resides.
Created: The date on which this VM was created.
HA enabled: HA stand for High Availability. If this is enabled for the selected VM, the downtime for the VM is minimal.
Attached ISO: If the value is Yes, it means that the VM container has an attached ISO.
The Filter menu shows a list by which you can order your VMs:
Move your cursor over the gear wheel icon. You see a list of actions that you can perform for the selected VM.
Edit VM: Click this option and change the Display Name. You can also change the Group to which this VM belongs.
Reboot VM: Click this option to reboot the selected VM.
Start VM: Click this option to start (power on) the selected VM. Only VMs in stopped state can be started.
Stop VM: Click this option to stop the selected VM. Only VMs that are running can be stopped.
Restore VM: Click this option to restore the VM to its original template.
Destroy VM: Click this option if you want to remove the VM completely. You cannot destroy a VM that is running.
Note: The system provides an option to terminate the associated subscription. If you choose to terminate the subscription as well then the subscription will be in the expired state else it will be Active(Unused).
Note: Recover VM: You have an option to recover the destroyed VM. On recovery of the VM, if you have terminated the associated subscription, a utility subscription gets created for this resource only in the next billing period. This is because the entitlement is available for the resource in the current billing period.
Reset Password: Click this option to reset the password for this VM. The VM must be password enabled for you to be able to reset the password.
Attach/Detach ISO: An ISO image is an exact copy of an existing file system. You can attach an ISO to your VM with this option. Attached ISOs can be detached. The ISO that you select must be compatible with the VM hypervisor for the ISO to be attached successfully. Click the option to attach or detach an ISO.
Scale up VM: Click this option to modify the level of compute resources available to a VM. You can change the service offering without stopping the VM. Scale down CPU and/or RAM are currently not supported.
Note: This option is not available from CPBM 2.2.1 onwards. You must use the 'Change Service' option.
Change service: This option is seen only for stopped VMs. Change service is always performed on stopped VM. Both scale up and scale down CPU and/or RAM can be performed.
Reset SSH Key: Click this option to reset the SSH Key for the selected VM.
Add Network to VM: This task is supported from CPBM 2.2.1 onwards. Click this option to add any additional networks to the VM. This option is shown for running and stopped VMs.
Note: This option is not available for running Hyper-V VMs.
Take VM Snapshot: This task is supported from CPBM 2.2.1 onwards. Click this option to take snapshot of the entire VM, including its volumes, memory, and CPU state.
Note: This option is not available for Hyper-V VMs.
Click the Volumes tab to view details of the volumes attached with the instance that is selected. In addition to viewing the details, you can also take snapshots by clicking the Take Snapshot option in the gear wheel menu. Click the View Snapshots option to view all the snapshots. This action will take you the Snapshots page.
Click the NICs tab to view details of the Network Interface Cards associated with the selected instance. The details shown are IP, Gateway, Netmask, Type (isolated or shared network), Network ID (system generated), and Network Name (that you provide).
Click the Snapshots tab to view details of the VM snapshots attached with the selected instance. In addition to viewing the details, you can revert the selected instance to the desired VM snapshot by clicking the Revert Snapshot option in the gear wheel menu. You can delete the selected VM snapshot by clicking the Delete Snapshot option in the gear wheel menu. Click the View Detailsoption to view all the details of the selected snapshots. This action will take you the Snapshots page.
Click the Subscriptions tab to view the details of the subscription associated with the VM. The ID is the UUID of the subscription. The 'View Details' link displays the included entitlements. The name of the subscription links to the subscription in the Subscriptions page.
The Instances tab lists all instances. As a master user/power user/normal user, you can find a particular instance/instances by using the search and filter options. The option to search and filter is visible in the CPBM UI only if the CCP Connector version supports search and filter operations for instances.
Any user can access their own VMs and perform actions on the VMs.
The properties used to provision a VM are described in detail in the table below. For provisioning VM, following resource properties are needed.
|Resource Property Name||Description||Required/Optional|
|displayName||User generated name for the virtual machine||Optional|
|group||Group for the virtual machine||Optional|
|diskOfferingUuid||The ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Else, this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.||Optional|
|keypair||Name of the ssh key pair used to login to the virtual machine||Optional|
|diskSize||The size for the DATADISK volume.||Optional|
|keyboard||Keyboard device type for the virtual machine. Valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us||Optional|
|networkIds||List of network ids used by virtual machine. Cannot be specified with ipToNetworkList parameter||Optional|
|securitygroupIds||List of security groups id seperated by comma that are going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support.||Optional|
|userData||Binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Currently only HTTP GET is supported. Using HTTP GET (via querystring), you can send up to 2KB of data after base64 encoding.||Optional|
|serviceOfferingUuid||The ID of the service offering for the virtual machine||Required|
|templateUuid||The template ID for the virtual machine||Required|
|isoUuid||The ID of the ISO attached to the virtual machine||Required|
|hypervisorType||The hypervisor on which to deploy the virtual machine||Required|
The VM snapshot features are supported from Citrix CloudPlatform 4.2.0 onwards. You can now take a VM snapshot of the entire VM, including its volumes, memory, and CPU state. VM snapshots reside on primary storage. VM snapshots can have a parent/child relationship. Each VM snapshot can have one (or zero) parent snapshot. The succeeding snapshot of the same VM is the child of the current snapshot. A current snapshot refers to the most recent snapshot compared to the current state of the VM. There are two types of snapshots:
Perform the following steps to create and manage a VM Snapshot.
To create a VM Snapshot
The snapshot is created and labelled as 'Current'. The Snapshots tab in the details pane displays the list of all the snapshots.
To revert a VM to a Snapshot
To delete a VM Snapshot
Note: If a current snapshot having a parent is deleted, then the parent snapshot becomes the current snapshot.
To view details of a VM Snapshot
You can add, update, or remove a Network Interface Card (NIC) on a VM from Citrix CloudPlatform 4.1.0 onwards. This feature supports the following:
As a user, you can add or remove networks to a VM that belongs to you. Network must be created to add a NIC to a VM. You cannot perform any actions for current default network of the VM. You have the option to update the default NIC. The default NIC will be labelled as 'Default'. You can remove a NIC added to a VM, if it is not the default.
Perform the following steps to add and manage a NIC on a VM.
To add a NIC on a VM Instance
Note: Only those networks that are created in the same zone as that of the VM are listed.
The NICs tab in the details pane displays the list of all the NICs added to the specific VM.
To update the default NIC on a VM Instance
Note: Master user can set a NIC as default for any of his users.
To delete a NIC from a VM Instance
You can add multiple IP addresses on a single NIC. This feature is supported from CCP 4.2.x onwards. The current guest VM has a default guest network interface that acquires primary IP address from the server during boot time. If required, you can add additional IP addresses for the guest VM NIC.
To add secondary IPs for a NIC
Note: If you do not specify the IP address, a private IP address will be picked from guest network.
A comma separated list of secondary IPs will be shown under primary IP.
To release secondary IPs for a NIC
Note: This option is not available if there are no Secondary IPs.
Users can change compute offering of the Virtual Machine. A compute offering is a set of virtual hardware features such as CPU core count, speed, and memory. To upgrade or downgrade the level of compute resources available to a virtual machine, you can change the VM's compute offering using the 'Change Service' wizard.
Note: Change service action on a running VM is supported from CCP 4.2 onwards. You can use this feature when the enable.dynamic.scale.vm setting is enabled on CCP.
Perform the following steps to change service for a VM.
To change service for a VM Instance
Note: The values in the drop-down list are as follows:
The Details tab in the details pane displays the new configuration for the specific VM.