Skip to main content

Quick start: from sign-in to your first virtual machine

What you will achieve​

Five steps take you from an empty cluster to a machine whose console you can access: sign in to the web UI → VDC → network in the VDC → VM → start and open the console. The sequence follows vStack Center's own checks: a VM can be created only in a VDC, a network port only in a network assigned to that VDC, and a disk only on a pool that holds the selected OS image.

The entire procedure takes place in the web UI. Each step uses a navigation section, the Actions button, and a form. The same operations are available programmatically: the method list is at the end of the page.

The components and protocol are described in What is vStack Center.

Prerequisites​

  • The Cluster master role. Other roles cannot create VDCs. A vDC admin can also assign a network to their VDC if they created that network themselves. A vDC admin can create a VM within an existing VDC.
  • The cluster has a network, a storage pool, and an OS image distributed to that pool.
  • vStack Center version 3.0.5.

Access requirements for each step are collected in the table below. Check them before you start.

StepWho can perform it
Create a VDCCluster master only
Assign a networkCluster master, or a VDC administrator who created the network themselves
Create a VMCluster master — in any VDC; other users — with the vDC admin or VM Developer role in the required VDC
Start a VMCluster master — any VM in the cluster; other users — VMs in their VDC with the vDC user role or higher
Open the consoleCluster master — any VM in the cluster; other users — VMs in VDCs where they have the vDC admin, vDC user, or vDC viewer role

Step 1. Sign in to the web UI​

Open the web UI at the cluster's HTTPS address, for example https://cluster.example.com. Enter the username and password provided by the cluster administrator.

If the account requires a forced password change, the web UI immediately prompts you to set a new password. The other sections are unavailable until the password is changed. You have 5 minutes to change it; after that, you must sign in again.

Verify that sign-in succeeded. The side navigation displays the site tree: Provider Data Center, Virtual Data Centers, Settings, and Security Event Log. Open Virtual Data Centers to see the VDC table with the ID, Name, and Running VMS columns and three used of quota values for CPU, RAM, and storage. On a fresh cluster, the table is empty; this is expected.

The web UI after sign-in: the site tree on the left contains Provider Data Center, Virtual Data Centers, Settings, and Security Event Log; the VDC table on the right has ID, Name, Running VMS, and three used of quota values for CPU, RAM, and storage

If it does not work​

SymptomReasonWhat to do
The web UI requires a new password immediately after sign-inThe account has the forced password change flag setSet a new password in the form; the other sections become available after that
The sign-in form reappears even though the password is correctAccess before a password change lasts 5 minutes and has expiredSign in again and complete the password change
The Virtual Data Centers section is emptyThe cluster does not have any VDCs yetThis is expected on a fresh cluster; proceed to step 2

Step 2. Create a VDC​

A VDC is a unit of ownership and accounting. Quotas, networks, roles, and VMs are linked to it, so it is created first. You can leave quotas unset initially: an empty quota field imposes no limit.

  1. Open Virtual Data Centers in the side navigation.
  2. Click Actions and select Create a VDC to open the Create a Virtual Data Center wizard.
  3. Enter a name in the first step. The cluster checks only its length: 1 to 255 characters. The hint below the field says Alphanumerics, but hyphens and underscores are also accepted, for example vdc-test. The Next step button becomes available when the field is filled in.
  4. Complete the remaining wizard steps: Resources, with CPU, RAM, and storage quotas, Unified Storage, and Overview. Confirm creation in the last step.

The VDC creation wizard: the General step with the VDC name field

Verify the result. The new VDC appears in the Virtual Data Centers table with its own ID and a zero in Running VMS. Click its name to open its card: an ID: <number> button appears next to the title, and the form on the VDC tab shows the configured values in the General, Quotas, Oversubscription factor, and Secondary limits sections.

You can change quotas on the same card: edit the fields in Quotas and click Save changes. An empty field removes the limit.

If it does not work​

SymptomReasonWhat to do
Create a VDC is unavailable, or creation is rejected with code -403Only the Cluster master role can create VDCsPerform this step with a cluster-level account
The Next step button remains unavailableThe name is empty or longer than 255 charactersEnter a name with 1 to 255 characters
Quotas need to be changed after creationThe wizard sets quotas onceEdit them on the VDC card: Quotas section → Save changes

Step 3. Assign a network to the VDC​

A VM can receive a network port only in a network assigned to its VDC. Otherwise, VM creation stops at the network membership check. Networks themselves exist at the cluster level: Cluster master creates them and then assigns them to VDCs.

  1. Cluster network: open Provider Data Center → All Networks tab. The network table has the ID, Type, Name, VLAN ID, MTU, CIDR, Used IP Addresses, and Free IP Addresses columns. If the required network is missing, use the Add button above the table.

    The All Networks tab in Provider Data Center: the Demo_net, External, a, and Edges AMQP network networks with their type, VLAN ID, MTU, CIDR, and used and free address counts

  2. VDC assignment: open the VDC card, go to the Networks tab and the Primary subtab, and select the required network in the Assign column of the network table.

    The Networks tab on the VDC card, Primary subtab: four networks with ID, Name, VLAN ID, MTU, and CIDR columns, and Assign switches on the right — enabled for Demo_net and External, disabled for Edges AMQP network and a

  3. The IP Data subtab shows address capacity: Used IP addresses by this vDC, Used IP Addresses, Free IP Addresses, and Addrs limit.

    The IP Data subtab: the same four networks with Used IP addresses by this vDC, Used IP Addresses, Free IP Addresses, and an empty Addrs limit column

Verify the result. Assign remains selected, and the row shows the network parameters: CIDR, MTU, and VLAN ID. On the IP Data subtab, free addresses are available for the VDC↔network pair. The VM will receive one of them.

You can limit the address capacity of the VDC↔network pair with Addrs limit on the same subtab. There is no limit by default, and only Cluster master can change it.

If it does not work​

SymptomReasonWhat to do
The Assign selection is not saved, code -2108In addition to VDC permissions, vStack Center requires that the same user created the networkAssign the network with a cluster-level account
The required network is missing from the list, or code -2120 is returnedThe cluster has no network with that IDCreate the network on the All Networks tab and retry the assignment
Assignment is rejected with code -403The account has no permissions for this VDC, or its role is below VDC administratorObtain the vDC admin role in the target VDC
The network cannot be unassigned from the VDC, code -2206The network still has ports used by VMsFirst delete or reconfigure the machines that use it

Step 4. Create your first VM​

Creating a VM involves more than a single database write. vStack Center validates the parameters, selects a storage pool, creates disks and network interfaces, allocates addresses and console ports, and then hands the work to the Storage agent and VM agent on the node. The wizard therefore does not confirm creation instantly: wait for the machine to appear in the table.

  1. Open the VDC card, click Actions, and select Create a VM to open the Create a Virtual Machine wizard. The same option is available in Provider Data Center → All Virtual Machines tab.
  2. Enter a name: the first character must be a Latin letter or digit; subsequent characters can be letters, digits, periods, underscores, and hyphens. The maximum length is 128 characters. For example, test-vm-01.
  3. Check the selected VDC and placement method. The default is Least-loaded storage pool: vStack Center selects the least full pool among those with an active copy of the selected image. Select a specific pool only when you need it: it must contain an active copy of the image.
  4. Fill in the numeric resource fields: vCPU and memory size. Use the GB button to switch units. Memory must be at least 512 MB. The first disk must be at least the minimum size of the selected OS image; 10 GB is sufficient for a typical cloud image.
  5. Select an OS image and a network. The network list contains only networks assigned to this VDC in step 3. Fill in the guest configuration: a hostname is required for any guest, and Windows also requires an administrator password.
  6. Use Next step to complete the wizard and confirm creation.

The VM creation wizard, step 1/4 General properties: VM name, OS type, OS profile, VDC, Pool set to Least-loaded storage pool, CPU (Cores), and RAM fields; below are the Disks, Networks, and Guest OS customization steps

Verify the result. The machine appears on the Virtual Machines tab of the VDC card: its own ID, the assigned address in IP, the image in OS, and its state in State. The machine is locked during initial configuration. Each action in Actions has its own error code for a lock: start, stop, and restart — -409 ("VM is locked"), delete — -309, edit settings — -3219, add disk — -3448, remove disk — -4430, resize disk — -7128, snapshot — -3630, delete snapshot — -4330, roll back to snapshot — -4230, suspend and resume — -15015. Wait for the lock to be released, then proceed to startup.

The Virtual Machines tab on the VDC card: two machines with ID, Name, IP, OS, State, Health, vCPU class, CPU (Cores), and RAM (GB) columns

If it does not work​

SymptomReasonWhat to do
The selected OS image is "not found," code -256The image is private to another VDC: vStack Center does not disclose the existence of another VDC's imageUse a cluster-shared image or request access to the required image for your VDC
The image has not been distributed to the selected pool, code -259The specified pool has no active copy of the imageKeep Least-loaded storage pool — automatic selection accounts for the image distribution map — or specify a pool that has a copy
The first disk is smaller than the minimum, code -254A cloud image cannot be deployed to a disk smaller than its minimum sizeIncrease the first disk size to the minimum required by the selected image
Creation is rejected with code -262A port was requested in a network that is not assigned to this VDCReturn to step 3 and assign the network
The memory size is rejected, code -229Memory is counted in 4 KiB pages, so the value must be a multiple of 4096 bytesSet a whole number of gigabytes or a number of megabytes that is a multiple of 4
The VDC storage quota is exhausted, code -213The total disk size exceeds the quotaReduce the disk size or increase the quota on the VDC card
Windows VM creation is rejected with code -233 or -261A Windows guest requires an administrator password, and any guest requires a hostnameComplete all guest configuration fields

Step 5. Start the VM and open the console​

The created machine is not running yet. At startup, vStack Center checks access, VDC quotas, cluster overcommit, and the machine state, locks the machine, and sends the command to the VM agent. The response arrives after confirmation from the node; in the web UI, this appears as a delay before the state changes.

You do not need to select a node. vStack Center automatically places a machine with disks in NVMe mode on the least loaded running node in the cluster. A machine with virtio-blk disks starts only on the node hosting its data pool.

  1. Open the VM card from the Virtual Machines tab on the VDC card or from All Virtual Machines.
  2. Select the machine startup action in the Actions menu. The machine is locked for the duration of the operation.
  3. Wait for the state to change: check the State column in the VM table and the Node field on the card, which shows the node where the machine is running.
  4. Open the console from the same card. There are two console types: graphical (VNC), the default, and text. Opening the console resets the previous connection to the same machine, so any previously opened console window closes.

The VM card: ID, Actions menu, State field showing Offline/Completed, power buttons, and collapsed General properties, Networks, Disks, Snapshots, Perfdata, and Event history sections

If it does not work​

SymptomReasonWhat to do
Startup is rejected with code -457Only a stopped or newly created machine can be started, and this one is already runningCheck the State column; resume a suspended machine (-455) instead of starting it
virtio-blk VM: start only on the pool node, code -460The machine has disks in virtio-blk mode and starts only on the node hosting its data poolLeave node selection automatic or specify the pool node
Windows VM startup is rejected with code -459Initial configuration is incomplete, and startup was requested on a node other than the pool nodeComplete configuration on the pool node, then start the machine on any node
No nodes are available for placement, code -458No running node was found for automatic selectionWait for nodes to return to the cluster and retry startup
Codes -413, -414, -415, -440Startup adds the VM's resources to current usage and reaches the VDC storage, RAM, or core quota, or the cluster RAM overcommit limitFree resources or increase the quota on the VDC card
VM is locked, code -409Another operation is in progress on the machine, and it is locked for that operationWait for the operation to complete
The console does not open, code -3103The machine is outside the account's visibility scopeObtain a role in its VDC
The console does not open, code -403The Access VM Console privilege is granted to Cluster master, vDC admin, vDC user, and vDC viewer; VM Developer does not have itObtain one of the listed roles in this VDC

Verify the result​

Open the VDC card and the Virtual Machines tab. The table has the ID, Name, IP, OS, State, Health, vCPU class, CPU (Cores), RAM (GB), and Storage (GB) columns. Your machine appears in the list with an assigned address and a running state.

The machine's own card provides the rest: General properties with the Node, OS profile, and VDC fields, the Networks, Disks, and Snapshots sections, Perfdata charts, and Event history, a log of machine operations with the status, time, and duration of each.

See also​

API methods​

The operations on this page are available through the API: vdc-list, vdc-create, vdc-set, vdc-assign-network, vdc-deassign-network, vdc-networks, vdc-network-addr-limit, vms-create, vms-start, vms-resume, vm-console, vm-list — see the API reference.