New OVF Transfer Plugin for vCO released

– December 13, 2012Posted in: Integrate vCO, Plugins

At the beginning of the Week I was pleased to place a new Plugin for the VMware vCenter Orchestrator in the VMware Solution Exchange (https://solutionexchange.vmware.com/store ). The Plugin is called VMware Orchestrator OVF Transfer Plug-In and can be used to Up- and Download ovf Files with the VMware vCenter Orchestrator. Here is the description of the Plugin:
Description:
The OVF Transfer plug-in allows you to up and download OVF Templates to/from the vCenter via the vCO.
• The following operations are possible:
• Automatic deployment of your OVF templates
• Automatic export of VMs to an OVF

And some highlights:
• Upload OVF Templates via vCenter Orchestrator
• Download OVF Templates via vCenter Orchestrator
• As Source and Destinations the following places are available: Local file, HTTP, HTTPS and FTP. With the Windows installable version you can also use File share (CIFS)
You can download the Plugin from the VMware Solution Exchange here: https://solutionexchange.vmware.com/store/products/ovf-transfer-plug-in

Many thanks to my colleague Carsten Schaefer who wrote and maintains the Plugin!

C Buchberger

Nice work – we did try it out, but it is not working reliable. We were able to export a very smal vm successfully. Exporting a bigger one (size of vmd 7 gb) failed with the exception: Cannot convert org.mozilla.javascript.NativeArray@49afeccc to com.vmware.vim.vi4.OvfFile[] (Dynamic Script Module name : exportOVF#124)

The vmdk was at the destination with the right size, but in vSphere client the export task stalled at 19%.
- Christian Strijbos
  
  Hi, I will check it and give you a feedback.
- Christian Strijbos
  
  Hi,
  
  We have taken an exact look at the problem and tried to reproduce it – unfortunately without success.
  Before we published the Plugin we tested it with VMs up to 100GB without problems.
  
  The strange thing is, that the problem appears while the XML creation. This creation is done after the export of the large files.
  
  Based on your description and the stack position at the script, I would say that there is no internal problem with the Plugin. I think there are some devices mapped to the VM that can’t be described at the OVF or we have to filter/convert it before the OVF creation starts.
  We would like to take a closer look at the error. Clearly we need a lot more information.
  Can you please send us some more information’s?
  • The vso.log (is stored on the desktop)
  • The created OVF (ONLY the OVF without the OVF)
  • A screenshot of the VM configuration.
  With this information we think it’s possible to reproduce the scenario.
  
  best regards
  Christian
- C Buchberger
  
  Hi, thank you for the Information and your efforts. I also thought that the Export itself Works, since the size is ok.
  There is no ovf file created at all. I can send you the Information you need. Pls send your contact-data to : c dot buchberger at witcom dot de.
  
  Thanks
  Carsten
- Arao
  
  Hi,
  Even we are facing the same issue when we are trying to export 40 GB VM, but export works fine in vCenter. Can you please help?
- Vladimir Dimitrov
  
  Hi
  I know this post is a bit old, but I decided to put the solution to this issue if anyone else hits this:
  
  Replace this line:
  var myOvfFiles = new Array(allVmdkFiles);
  with
  var myOvfFiles = [];
  
  Replace this line:
  myOvfFiles[i] = myOvfFile;
  with
  myOvfFiles.push(myOvfFile);
  
  This small fix worked for me
  
  Cheers!
  -Vladimir
Leahy_s

Hi,

I have been trying to use this plugin but I keep getting the following error

[2013-02-13 13:38:25.317] [I] Load OVF contend
[2013-02-13 13:38:25.892] [I]
Attribute xsi:nil not allowed on element spec, which is not nillable.

while parsing call information for method ImportVApp
at line 3, column 2

while parsing SOAP body
at line 2, column 1

while parsing SOAP envelope
at line 1, column 38

while parsing HTTP request for method importVApp
on object of type vim.ResourcePool
at line 1, column 0 (Dynamic Script Module name : deployOVF#23)

Do I need to install additional plugins or do something to resolve this, I get the error on both VCO 5.1 and on VCO 4.2

I am also not 100% on what you put in for the ovflocation for the deploy ovf workflow. If I could see a few examples for syntex of each all supported locations .

I am testing with a local ovf. . . . ‘e:vCO_VA-4.2.1.0-612841_OVF10.ovf’ and I have also tried ‘file:///E:/vCO_VA-4.2.1.0-612841_OVF10.ovf’

Thanks

Sean
- Christian Strijbos
  
  Hi Sean,
  
  we will take a look on the error. I just became the same response from an other customer.
  
  regards
  Christian
- Leahy_s
  
  Hi Christian,
  
  I think the problem is it cannot find my OVF, if I put in x as the location I get the same error.
  
  I have been trying to use a local file as the ovfLocation but Local where ? Local to the system you are connected to vco on, local to the vcenter ? Where is local and what is the syntax for local file ?
  C: ?
  
  Thank for looking into it.
  
  Sean.
- Christian Strijbos
  
  Hi Sean,
  
  We just tested it again – your guess is correct, it is a problem with the file access.
  In the next version of the plugin we will intercept this message and return a better text!
  
  Local file means locally on the vCO. It is important that both the exporting user and the service user of the vCO have access to the file.
  
  Here are some examples of valid paths:
  Local -> D:OVFmyOVF.ovf
  CIFS (Windows) -> \192.168.0.1OVFmyOVF.ovf
  HTTP/HTTPS -> https://192.168.0.1/OVF/myOVF.ovf
  FTP -> ftp://192.168.0.1/OVF/myOVF.ovf or ftp://username:password@server/directory/file.ovf
  
  Regards
  Christian
- Christian Strijbos
  
  Hi Sean,
  
  Thanks for the detailed information’s!
  I received a few days ago an error message at the same position.
  I regret to say that I do not quite understand the error at the moment… this code was while the development and in our tests always absolutely unproblematic …
  
  I suspect that this problem occurs with the used versions…
  I will take a closer look at your logs and try to reproduce the error.
  I will contact you as soon as possible with new information’s!
  
  regards
  Christian
- Adi Palmer
  
  I’m unsure about the file access error, in my case, because it crated the ovfdescriptor.. and the myVcOvfCreateImportSpecResult object is created, but the myVcOvfCreateImportSpecResult.importSpec is null — confused, can’t fix for days/weeks.
Loren Gordon

Would it be possible to update the plugin to support a Cluster as well as a host, and a Distributed Switch port group as well as a standard switch port group? Thanks!
- Christian Strijbos
  
  Hi, I will check it and give you a feedback.
  
  Regrads
  Christian
Victor

Hi,

I’m having issues using the ovf export utility. The workflow starts and ends without an error but the action does not transfer the vmdk file but it does transfer the ovf file. There are no errors in VCO. However, vCenter shows “the task was cancelled by user” error
- Christian Strijbos
  
  Hi Victor,
  
  do you have more informations from the vCO Server or anyything else? How does your setup look like?
  
  regards
  Christian
Mannie

Hi Christian,

How can I get the result of the “ovf deploy” as a VM. I want to have the workflow mark the VM thats deployed from “ovf deploy” action as a “template”

Is there a way to return the vm instead of boolean value?

Thanks in advance
- Christian Strijbos
  
  Hi Mannie,
  
  the easiest way to archive your goal is to
  execute the vCO Workflow “Get VM by Name”
  after the ovf is deployed. We will check if we can modify the Plugin and
  come back to you if it is possible.
  
  Regards
  Christian
- Mannie
  
  Thanks, I was able to accomplish my task with “Get VM by Name” workflow.
Peter

Hi my ovf required to put in ip address, netmask, gateway, etc. Also password for vm but I don’t see any attributes for that in the plug-in. How can I add them? Maybe direct to the right API (like: VcOvfNetworkMapping or something) thanks
- Christian Strijbos
  
  Hi Peter,
  
  that didn’t we include so far. I will check if we can include it into the code.
  
  regards
  Christian
- Peter
  
  Thanks Christian,
  
  This could be specific to just my usercase. So, if you may point me to the right VMware APIs I can try to modify the plug-in myself.
  
  Please let me know your thoughts..
  
  Thank you for your time,
  Peter
- Christian Strijbos
  
  Hi Peter,
  
  I think the best start for you is the VMware vSphere API Reference Documentation.
  
  regrads
  Christian
- Peter
  
  I have been looking into APIs:
  
  https://www.vmware.com/support/orchestrator/doc/vco_vsphere41_api/html/VcOvfCreateImportSpecParams.html
  
  https://www.vmware.com/support/orchestrator/doc/vco_vsphere41_api/html/VcOvfNetworkMapping.html
  
  and
  
  https://www.vmware.com/support/orchestrator/doc/vco_vsphere41_api/html/VcOvfManager.html
  
  ..but Im kinda lost! 🙁
  Plz let me know if you guys may workout a solution.
  
  Thanks,
  Peter
- David35
  
  Hi,
  
  I’m trying to install the OvaTransfer Plugin (o11nplugin-ovatransfer_2.0.3.68) into my VCO 5.1. But it seems to have been compiled into a JRE 1.7 and VCO is working with a JRE 1.6.
  
  Somebody has a JRE 1.6 compiled version of this plugin ?
  
  Thx
- Christian Strijbos
  
  Hi David,
  
  I will check this again our installation and will come back to you.
  
  regards
  Christian
Idan

Hi,

I have two vCenters connected to the vCO. (there is no network relation between the VCs)
I want to move a VM from one VC to another.

If I want to export a VM, what should I write in the destination path if I have a vCO appliance?
Does it require fw ports between the vcenteresx and the vCO for the export?
- Christian Strijbos
  
  Hi Idan,
  
  the primary design of the OVF Transfer Plug-in was not to “migrate” the virtual machines between two vCenter Server but I think you can modify it so, that it will work for you (the actual version support Import and Export)
  
  From my point of view, you have these options:
  
  1) Convert the Templates with vCO to a virtual machine (this can be easily done with a vCO workflow)
  
  2) Export the virtual Machine as OVF from the “old vCenter Server” with the OVF Transfer Plugin
  
  3) Import the virtual Machine as OVF to the new vCenter Server with the Plugin
  
  4) Convert the virtual Machine as Template with a vCO Workflow.
  
  Regards
  
  Christian
- Idan
  
  Thanks. this is my plan.
  However I have problem with the export.
  What should I need to write in the destination path? I have a vCO appliance.
- Idan
  
  this is the error I receive in the Orchestrator:
  
  [2016-02-09 11:19:06.686] [I] OVF export failed! Unexpected error detected. Please review vCO logfile (Dynamic Script Module name : exportVM#82)
  [2016-02-09 11:19:06.686] [I] OVF export failed! Unexpected error detected. Please review vCO logfile (Dynamic Script Module name : exportVM#82)
  [2016-02-09 11:19:06.686] [I] OVF export failed! Unexpected error detected. Please review vCO logfile (Dynamic Script Module name : exportVM#82)https://esxdev6.dev.tase/nfc/5287e0ac-bd0e-2780-8e74-63ef7097e378/disk-0.vmdk
  [2016-02-09 11:19:06.686] [I] OVF export failed! Unexpected error detected. Please review vCO logfile (Dynamic Script Module name : exportVM#82)https://esxdev6.dev.tase/nfc/5287e0ac-bd0e-2780-8e74-63ef7097e378/disk-0.vmdk
  [2016-02-09 11:19:06.686] [I] OVF export failed! Unexpected error detected. Please review vCO logfile (Dynamic Script Module name : exportVM#82)
  [2016-02-09 11:19:06.686] [I] OVF export failed! Unexpected error detected. Please review vCO logfile (Dynamic Script Module name : exportVM#82)https://esxdev6.dev.tase/nfc/5287e0ac-bd0e-2780-8e74-63ef7097e378/disk-0.vmdk
  [2016-02-09 11:19:06.686] [I] OVF export failed! Unexpected error detected. Please review vCO logfile (Dynamic Script Module name : exportVM#82)
  [2016-02-09 11:19:06.686] [I] OVF export failed! Unexpected error detected. Please review vCO logfile (Dynamic Script Module name : exportVM#82)
- Christian Strijbos
  
  Hi Idan,
  
  it depends……so you have different options to export the OVF files. You can use: Locale file, HTTP, HTTPS, FTP and CIFS.
  
  If you want to use the vCO Appliance as target you must change some settings.
  
  The vCO has a secure configuration so to allow the vCO Server to access this folder you must allow this explicit. For that, you have to edit the file: js-io-rights.conf on the vCO appliance this file is located under the path:
  
  /opt/vmo/app-server/server/vmo/conf/js-io-rights.conf
  
  I added my created path and after that, the file was looking like this:
  
  -rwx /
  
  +rwx /var/run/orchestrator
  
  +rx ../../configuration/jetty/logs/
  
  +rx ../server/vmo/log/
  
  +rx ../bin/
  
  +rx ./boot.properties
  
  +rx ../server/vmo/conf/
  
  +rx ../server/vmo/conf/plugins/
  
  +rx ../server/vmo/deploy/vmo-server/vmo-ds.xml
  
  +rx ../../apps/
  
  +r ../../version.txt
  
  +rw /ConfigFiles
  
  It is much more easier to export the OVF to another Option like CIFS Share.
  
  Regards
  
  Christian
- Idan
  
  hi,
  I don’t have this file: /opt/vmo/app-server/server/vmo/conf/js-io-rights.conf
  The version of the orchestrator is: 5.5.3 build number: 2945800
- Christian Strijbos
  
  Hi Idan,
  
  then maybe the path has changed. Can you try to export to a CIFS Share?
  For a complete Troubleshooting I need the vCO Logfiles.
  
  regards
  Christian
- Idan
  
  I found this KB, now I have the file.
  I will try to edit it.
- Idan
  
  http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=2039821
- Idan
  
  Unfortunately, the paths you mentioned in your file don’t appear in my appliance.
- Idan
  
  I also try to you use the CIFS option, but still receive the same error.
- Christian Strijbos
  
  Hi Idan,
  
  as I wrote bevor……I need the log files to figure out what happens. Please them to me via email and I will take a look,
  
  Did you look at the documentation and examples how to use the plugin Workflows?
  
  Regards
  Christian
- Idan
  
  I saw examples in the previous comments.
  Where can I find the documentation for the plugin?
- Christian Strijbos
  
  Hi Idan,
  
  here is the link for the documentation:
  
  https://system-vertrieb-alexander.sharefile.eu/d-s2db732a7cf74206a
  
  regards
  Christian
- Idan
  
  Hi,
  With the help of the documentation I have realized that I had to open some port between the vCO appliance and the ESXs.
  Now the export and the import work without any problem.
  Thanks!
Joseph Papp

https://solutionexchange.vmware.com/store/products/vmware-realize-orchestrator-ovf-transfer-plug-in

Hello,

I have a question about the sourcePath value for the Import a Virtual Machine from OVF/OVA workflow. The description in your documentation is as follows:

Absolute path to the ovf/ova file.

Examples:

Local (vCO Installable): c:ovfstorewindowsmyOvf.ovf

Local (vCO Appliance): /data/ovfstore/myOva.ova

HTTP: https://mysub.mydomain.tld/ovfs/myOvf.ovf

FTP: ftp://myuser:mypwd@mydomain.tld/myOva.ova

I’m trying to open an HTTPS connection to a local build website to grab the OVA/OVF, but I need to pass credentials(username/password) to authenticate with the website. I don’t see a way to do this with your plug-in. Is it possible?
- Christian Strijbos
  
  Hi Joseph, we are working on a new version which allows you to authentication (Basic + Digest) for HTTP and HTTPS session. At the moment we are in process for quality checking and updating the documentation. I think the new version will be available in the next two weeks. If you need the version quicker, please contact me and I will forward the version to you.
  
  Regards
  Christian
Peter

Hi Christian

Do you know what could be the reason for this error message:
!!!!!!!!!!!!Module name : retrieveOvfProperties#4!!!!!!!!!!!!

I’m getting this error when I try to run workflow: Generate a new workflow from OVA/OVF. When I try to deploy through vsphere client using the url to the file location it will work.

ERROR:
Script execution error on workflow : Generate a new workflow from OVF/OVA / ‘retrieveOvfProperties'(item1) : https://esxi-1.test.local:443/https://esxi-1.test.local/folder/test/%2dvCO%2dAppliance%2d6.0.3.0%2d3000579%5fOVF10.ova?dcPath=ha%2ddatacenter&dsName=iSCSI (Dynamic Script Module name : retrieveOvfProperties#4)

Storage is ISCSI when I select local storage on vCO it will work but when i’m going through http/https I’m getting error “Dynamic Script Module name : retrieveOvfProperties#4)”

Thanks
Peter

Official vCenter Orchestrator Training

Class Schedule for: VMware vCenter Orchestrator: Develop Workflows
delivered by VMware Education and VMware Authorized Training Centers....
Categories
- Best-Practices (7)
- Books (1)
- Examples (36)
- Get Started! (37)
- Install-Configure-Upgrade (1)
- Integrate vCO (36)
  - Call Workflows from outside (18)
  - Database (10)
  - Powershell (8)
- OpenStack (3)
- Plugins (15)
- REST (1)
- SRM (1)
- Tools (11)
- Troubleshooting / Debugging (9)
- Uncategorized (34)
- vCAC (1)
- vCO Use-Cases (23)
- vCSHB (1)
- Wavemaker (17)
- Webviews (6)
- Workflow Design (8)
- Zerto (1)
Free vCO Training Videos
...on www.vmwarelearning.com"
Recommended Reading

Some books I found useful when working with vCO…

Steve Jin: VMware VI and vSphere SDK
Steve Jin ( www.doublecloud.org ) focus is on the VI Java Toolkit. However the books also includes a great general introduction of the vSphere API and lots of UML-diagrams of the API data model. Both is very useful when you develop vCO scripts interacting with vCenters
see also
http://www.amazon.com/VMware-VI-vSphere-SDK-Infrastructure/dp/0137153635

David Flanagan: JavaScript – The Definitive Guide
Since all the scripting elements are written in JavaScript, you need at least one book with a JavaScript-reference on your desk.
(Of course, you can find examples all over the web, but in most cases searching in the internet costs more time and distracts more than simply open the reference book on the marked site ).
see also
http://www.amazon.com/JavaScript-Definitive-Guide-David-Flanagan/dp/0596101996

Marijn Haverbeke: Eloquent JavaScript
If you are new to JavaScript, most of the books about it out there are do not fit for an vCO-guy because they contain too much web-related stuff.
An exceptional introduction to JavaScript NOT focussing on the web-stuff is "Eloquent JavaScript". The book is really good to read, and best of all: There is an online version available on http://eloquentjavascript.net which contains an interactive JavaScript console. So you can directly test the code examples online in your browser while you read:
The fastest way to learn JavaScript from scratch!
see also
http://www.amazon.com/Eloquent-JavaScript-Modern-Introduction-Programming/dp/1593272820

Cody Bunch: Automating vSphere: With VMware vCenter Orchestrator
http://www.amazon.com/Automating-vSphere-VMware-vCenter-Orchestrator/dp/0321799917

New OVF Transfer Plugin for vCO released

Related

Official vCenter Orchestrator Training

Categories

Free vCO Training Videos

Recommended Reading