vmware:createSnapshot

Full name:

agaetis.public.maven-plugins:maven-vmware-plugin:1.0.0.7:createSnapshot

Description:

This goal Create a snapshot with a running virtual machine.

sample :
mvn vmware:createSnapshot -DvixLibPath=./path/to/vixlib -Dusername=myUsername -Dpassword=myPassword
-Dhost=192.168.x.x -DvmxFilepath="/path/to/the/vmx/file"

Attributes:

  • Requires a Maven 2.0 project to be executed.

Optional Parameters

Name Type Since Description
_cmd String - (no description)
Default value is: createSnapshot.
_guestPassword String - Guest password
Default value is: none.
_guestUsername String - Guest username
Default value is: none.
_host String - (no description)
Default value is: localhost.
_password String - Password for the virtual machine.
Default value is: ****.
_port Integer - (no description)
Default value is: 902.
_serviceProvider Integer - the default value is VMWARE_VI_SERVER
Default value is: 10.
_shutdownOpt String - shutdown option
Default value is: now.
_snapshotDesc String - Snapshot description
Default value is: none.
_snapshotName String - Snapshot name
Default value is: none.
_username String - Username for the virtual machine. It is the user on the remote machine who can run the vm. This is completely different from the guest username.
Default value is: Anonymous.
_version String - Plugin version
Default value is: ${project.version}.
_vixLibPath String - Path to the vix lib.
Default value is: none.
_vmxFilepath String - String to define the filepath of the vmx file locally on the vmware server. e.g : "/var/lib/vmware/Virtual Machines/test/test.vmx"
_waitForTools boolean - Boolean that defines if after powering on the vm, we should wait for vmware tools to start.
Default value is: false.
_waitForToolsTimeout Integer - Integer that defines the time to wait before exiting from the waitToolsInGuest method of the virtual machine.
Default value is: 60000.

Parameter Details

_cmd:

(no description)
  • Type: java.lang.String
  • Required: No
  • Expression: ${cmd}
  • Default: createSnapshot

_guestPassword:

Guest password
  • Type: java.lang.String
  • Required: No
  • Expression: ${guestPassword}
  • Default: none

_guestUsername:

Guest username
  • Type: java.lang.String
  • Required: No
  • Expression: ${guestUsername}
  • Default: none

_host:

(no description)
  • Type: java.lang.String
  • Required: No
  • Expression: ${host}
  • Default: localhost

_password:

Password for the virtual machine.
  • Type: java.lang.String
  • Required: No
  • Expression: ${password}
  • Default: ****

_port:

(no description)
  • Type: java.lang.Integer
  • Required: No
  • Expression: ${port}
  • Default: 902

_serviceProvider:

the default value is VMWARE_VI_SERVER
  • Type: java.lang.Integer
  • Required: No
  • Expression: ${serviceProvider}
  • Default: 10

_shutdownOpt:

shutdown option
  • Type: java.lang.String
  • Required: No
  • Expression: ${shutdownOpt}
  • Default: now

_snapshotDesc:

Snapshot description
  • Type: java.lang.String
  • Required: No
  • Expression: ${snapshotDesc}
  • Default: none

_snapshotName:

Snapshot name
  • Type: java.lang.String
  • Required: No
  • Expression: ${snapshotName}
  • Default: none

_username:

Username for the virtual machine. It is the user on the remote machine who can run the vm. This is completely different from the guest username.
  • Type: java.lang.String
  • Required: No
  • Expression: ${username}
  • Default: Anonymous

_version:

Plugin version
  • Type: java.lang.String
  • Required: No
  • Default: ${project.version}

_vixLibPath:

Path to the vix lib.
  • Type: java.lang.String
  • Required: No
  • Expression: ${vixLibPath}
  • Default: none

_vmxFilepath:

String to define the filepath of the vmx file locally on the vmware server. e.g : "/var/lib/vmware/Virtual Machines/test/test.vmx"
  • Type: java.lang.String
  • Required: No
  • Expression: ${vmxFilepath}

_waitForTools:

Boolean that defines if after powering on the vm, we should wait for vmware tools to start.
  • Type: boolean
  • Required: No
  • Expression: ${waitForTools}
  • Default: false

_waitForToolsTimeout:

Integer that defines the time to wait before exiting from the waitToolsInGuest method of the virtual machine.
  • Type: java.lang.Integer
  • Required: No
  • Expression: ${waitForToolsTimeout}
  • Default: 60000