Hitachi

JP1 Version 12 JP1/Automatic Operation Service Template Reference


5.11.34 Moving a virtual server snapshot

Function

Moves a snapshot used by a virtual server to a specified snapshot on a different virtual server in the VMware vSphere environment

If the specified destination is a snapshot currently in use, the system moves to the state of the time of snapshot creation.

This component assumes the following servers as prerequisites:

- vCenter server

Server where VMware vCenter Server is installed

- vCenter control server (Execution target server)

Server where VMware vSphere PowerCLI is installed. JP1/AO transfers the component to the server for execution.

- Virtual server

Virtual server managed by vCenter server or VMware vSphere ESXi (or VMware ESX Server)

Use situation

This component can be used to move a snapshot used by a virtual server to a specified snapshot.

Prerequisites

For the latest support information about [Required product in the System]/[Required products on the execution target system]/[Required products on the execution target server]/[Prerequisite product OS running in the execution target server], see the release notes.

[Required product in the System]

JP1/Automatic Operation 11-10 or later

[Required products on the execution target system]

(1) Prerequisite product for the vCenter

- VMware vCenter Server 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0, 4.1, 4.0

(2) VMware vSphere ESXi (or VMware ESX Server) managing the virtual server

- VMware vSphere ESXi 7.0, 6.7, 6.5, 6.0, 5.5, 5.1, 5.0 or VMware ESX Server 4.1, 4.0

(3) Prerequisite OS for the virtual server

The following OSs are supported, based on the required products for the vCenter server and the required products for the VMware vSphere ESXi (or VMware ESX Server)/vCenter control server that manages the virtual server.

- Windows Server 2008 R2 Standard/Enterprise/Datacenter

- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter

- Windows Server 2016 Standard/Datacenter

- Windows Server 2019 Standard/Datacenter

- Red Hat Enterprise Linux Server 6 (32-bit x86), Red Hat Enterprise Linux Server 6 (64-bit x86_64)

- Red Hat Enterprise Linux Server 7 (64-bit x86_64)

- Red Hat Enterprise Linux Server 8 (64-bit x86_64)

- CentOS 6 (64-bit x86_64)

- CentOS 7 (64-bit x86_64)

- CentOS 8 (64-bit x86_64)

[Usage conditions for required products in the execution target system]

(1) The VMware vSphere ESXi (or VMware ESX Server) is managed by VMware vCenter Server.

(2) Conditions for the virtual server

- There is no duplicate virtual server name under the same vCenter.

- VMware Tools is installed in the virtual server.

[Required products on the execution target server]

- VMware vSphere PowerCLI 6.3 Release1, 6.0 Release3, 6.0 Release1, 5.8 Release1, 5.5 Release2, 5.5 Release1, 5.1 Release2, 5.0

- VMware PowerCLI 6.5 Release1

- VMware PowerCLI 6.5.1, 6.5.4

- VMware PowerCLI 10.1.0, 10.1.1, 11.3.0, 12.0.0, 12.1.0

[Prerequisite product OS running in the execution target server]

- Windows Server 2008 R2 Standard/Enterprise/Datacenter

- Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter

- Windows Server 2016 Standard/Datacenter

- Windows Server 2019 Standard/Datacenter

Cautions

(1) Do not target any virtual servers where a raw disk, an RDM physical mode disk, or an independent disk is set.

Execution privilege

(1) The user connecting to VMware vCenter Server must have the following permissions:

System administrator role permissions

Version

02.11.00

Plug-in tags

Move VM Snapshot,VMware vSphere

Plug-in name displayed in the task log

vsphereMoveSnapshot

Return code

0: Normal

23: Abnormal (Environment error) Invalid prerequisite environment

27: Abnormal (See the task log for error contents.)

41: Abnormal (Error detected inside the component) - A property is not specified. (The component script has detected an error.)

Property list

The following table lists the properties:

Property key

Property name

Description

Default value

I/O type

Required

VMware.vCenterServerName

Host name of the vCenter server

Specify the host name or IP address of the destination vCenter server. IPv6 addresses are not supported.

--

Input

R

VMware.userName

User name for connecting to the VMware vCenter Server

Specify the user name for connecting to the VMware vCenter Server.

--

Input

R

VMware.password

Password for connecting to the VMware vCenter Server

Specify the password for connecting to the VMware vCenter Server.

--

Input

R

VMware.portNumber

Port number for connecting to the VMware vCenter server

Specify the number of the port for connecting to VMware vCenter Server (for the VMware vCenter Server Web service).

443

Input

O

VMware.protocol

Protocol for connecting to the VMware vCenter server

Specify either HTTP or HTTPS as the protocol for connecting to VMware vCenter Server.

https

Input

R

VMware.vmName

Virtual server name

Specify the name of the virtual server. (This is the virtual server name in VMware vCenter Server. Do not specify a host name.)

--

Input

R

VMware.snapshotId

Snapshot ID

Specify the ID of the snapshot.

--

Input

R

plugin.destinationHost

Host name of the execution target server

Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported.

--

Input

R

common.returnValue

Return value for the plugin

The return value of this plugin stored.

--

Output

O