VM Api Reference

Menu

Vm >> Manage Vm
Vm >> Create Vm
Vm >> Manage Vm Image
Vm >> Ip Address List

Manage Vm

List User VM details under this menu and have a option to Start,Stop,Restart & Shutdown the VM.

Fields Display

Vm Name	Vm Code	Status	Status Info	Last Update	Nic Details	Action
sts-test.sathyainfo.com	ins-219215e8cfcd48a3af0d680cd121bbcc	Online	Restarted Completed	12-Jan-2022 10:21 AM	Edit

Filter

• Vm Name : Text box

Function : ReadVmList, CreateTask (Change UpdateVmState to Create Task)

Depend upon the Vm status. Vm Action state is active or in-active as below

Name	Action State	Online	Offline
Power On		Inactive	Active
Power Off		Active	Inactive
Restart		Active	Inactive

Start Vm

To Start VM need to create task using Create Task Function. All Vm realted Task Execute using Create Task function.

• Login Token
• Task Id as 0
• HypervisorId (ReadVmList)
• TaskName as StartVm (Enum)
• Account Id
• User Id
• StartVmInfo Pass HyperVisorVmName (ReadVmList)

Stop Vm

To Stop VM need to create task using Create Task Function. Pass below details to stop vm

• Login Token
• Task Id as 0
• HypervisorId (ReadVmList)
• TaskName as StopVm (Enum)
• Account Id
• User Id
• StopVmInfo Pass HyperVisorVmName (ReadVmList)

Restart Vm

To Restart VM need to create task using Create Task Function. Pass below details to stop vm

• Login Token
• Task Id as 0
• HypervisorId (ReadVmList)
• TaskName as RestartVm (Enum)
• Account Id
• User Id
• RestartVmInfo Pass HyperVisorVmName (ReadVmList)

Create Vm Image

To Create VM Image back up. Use Create Vm Image Function and pass below details in CreateVmRqst

• Login Token
• Vm Code Pass Vm Guid
• After Succesful update redirect to Manage Vm Image List

Create Vm

To Create VM need to get below details from user
Input Fields

• Zone (Drop down) - Function Name : ReadZoneList (Pass Region Id => 1 for default)
• Guest Os (Drop Down) - Function Name : ReadGuestOsList(Pass Selected Zone Id)
• Vm Name (Text box)

Arguments

• Login Token
• Task Id as 0
• HypervisorId as 0)
• TaskName as CreateVm (Enum)
• Account Id
• User Id
• CreateVmInfo Pass ZoneId,GuestOsId and VM Name

Manage Vm Image

Function Name : ReadVmImageList()
Need option to refresh the page
Filter :

• Date : From and To Date

Image Date	Source Vm Name	Status	Status Info	Restore Vm
08-Feb-2022	STS-TEST-VM	Not Started	Vm Image Task Scheduled

Restore Vm Image

To Restore VM image use below function
Function Name : RestoreVmImage, ReadVmImageDetails
Input Fields

• ReadVmImageDetails function used to get the Source Vm Name and Source Vm OS
• VM Name *
• Source Vm Name (Fill from ReadVmImageDetails and Disabled)
• Source Vm Guest Os (Fill from ReadVmImageDetails and Disabled)
• Pass Vm Name and VmImageGuid in RestoreVmImage

After successfull update redirect to Manage Vm Page

Ip Address List

Function Name : ReadIpAddressList()
Need option to refresh the page
To Release Ip Details use Function ReleaseIpAddress()
Above table right side corner need button Allocate Ip Address Function Name : AllocateIpAddress()

Public IP Address	Nic Details	Release Ip
103.24.52.104	Edit	image link

Edit Nic Details

Separate Pop up window to edit Nic Details
Function Name : AttachIpAddress(), DetachIpAddress()
Input Fields

• Public Ip Address not Editable
• Vm Name as Dropdown => ReadVmList()
• Button for AttachIpAddress & DetachIpAddress
• if Same window also open from vm list Vm Name as Not Editable and option to choose Ip Address using function ReadIpAddressLists()