Skip to content

Commit 4116323

Browse files
soreanaDaanHooglandstephankruggg
authored
Updated wrong doc parameters in UserVmService. (#7321)
Co-authored-by: dahn <daan.hoogland@gmail.com> Co-authored-by: Stephan Krug <stekrug@icloud.com>
1 parent 1e25340 commit 4116323

File tree

1 file changed

+8
-22
lines changed

1 file changed

+8
-22
lines changed

api/src/main/java/com/cloud/vm/UserVmService.java

Lines changed: 8 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -404,10 +404,7 @@ UserVm createAdvancedVirtualMachine(DataCenter zone, ServiceOffering serviceOffe
404404
/**
405405
* Creates a vm group.
406406
*
407-
* @param name
408-
* - name of the group
409-
* @param accountId
410-
* - accountId
407+
* @param cmd The command specifying domain ID, account name, group name, and project ID
411408
*/
412409
InstanceGroup createVmGroup(CreateVMGroupCmd cmd);
413410

@@ -438,16 +435,10 @@ UserVm createVirtualMachine(DeployVMCmd cmd) throws InsufficientCapacityExceptio
438435

439436
/**
440437
* Migrate the given VM to the destination host provided. The API returns the migrated VM if migration succeeds.
441-
* Only Root
442-
* Admin can migrate a VM.
438+
* Only Root Admin can migrate a VM.
443439
*
444-
* @param destinationStorage
445-
* TODO
446-
* @param Long
447-
* vmId
448-
* vmId of The VM to migrate
449-
* @param Host
450-
* destinationHost to migrate the VM
440+
* @param vmId The ID of the VM to be migrated
441+
* @param destinationHost The destination host to where the VM will be migrated
451442
*
452443
* @return VirtualMachine migrated VM
453444
* @throws ManagementServerException
@@ -466,14 +457,9 @@ VirtualMachine migrateVirtualMachine(Long vmId, Host destinationHost) throws Res
466457
* Migrate the given VM with its volumes to the destination host. The API returns the migrated VM if it succeeds.
467458
* Only root admin can migrate a VM.
468459
*
469-
* @param destinationStorage
470-
* TODO
471-
* @param Long
472-
* vmId of The VM to migrate
473-
* @param Host
474-
* destinationHost to migrate the VM
475-
* @param Map
476-
* A map of volume to which pool it should be migrated
460+
* @param vmId The ID of the VM to be migrated
461+
* @param destinationHost The destination host to where the VM will be migrated
462+
* @param volumeToPool A map of volume to which pool it should be migrated
477463
*
478464
* @return VirtualMachine migrated VM
479465
* @throws ManagementServerException
@@ -507,7 +493,7 @@ UserVm upgradeVirtualMachine(ScaleVMCmd cmd) throws ResourceUnavailableException
507493
/**
508494
* Finds and returns an encrypted password for a VM.
509495
*
510-
* @param userVmId
496+
* @param vmId
511497
* @return Base64 encoded userdata
512498
*/
513499
String getVmUserData(long vmId);

0 commit comments

Comments
 (0)