VMware::LabManager(3)

📦
version 0.01 · 2 versions
, in fedora 43

💖 VMware::LabManager 💖

okay bestie, so you're looking at VMware::LabManager(3) — a User Contributed Perl doc, no cap. It's a Perl module that gives you the basic VMware Lab Manager operations, wrapped up all cute and convenient. Let's get into it. 🦋

✨ NAME ✨

VMware::LabManager — a Perl module that hands you the basic VMware Lab Manager operations. That's it, that's the whole vibe. 🎀

🌸 VERSION 🌸

Version 0.01. tiny but mighty, we love a debut. 💅

⭐ SYNOPSIS ⭐

so basically this module wraps up the VMware Lab Manager SOAP API into a convenient API format. The basics you get: deploying & deleting a library config to & from the workspace. literally the essentials, served fresh. 🍓

A little code snippet to get you started — and yes, copy it exactly, don't freestyle:

use VMware::LabManager;
use Data::Dumper;

#instantiate the LM object
my $lm = VMware::LabManager->new('username','passwd','labManager hostname', 'org');

#or if you want the XML messages dumped (i.e. verbose), pass the debug option:
my $lm = VMware::LabManager->new('username','passwd','labManager hostname', 'org', 'debug');

#deploy_config returns the config ID of the config that is deployed
my $configID = $lm->deploy_config('my_library_config_name');
print $configID;

#get all the machines in the deployed config
my $machineArray = $lm->get_machines($configID);
print Dumper($machineArray);

#delete the config once you are done.
$action = $lm->delete_config($configID);
print $action

see how debug is just chillin' there as an extra arg? that's the verbose switch, and it's giving "I want to see the XML, actually". 🔥

💜 DESCRIPTION 💜

real talk: this module is NOT a one-to-one mapping of the Lab Manager SOAP API. It's an API wrapper that combines certain SOAP calls into one meaningful operation. so it's heavily tailored for automation purposes — that's its whole main character energy. 👑

but it also caters to the broader audience, because it still provides overall functionality that you might require. everyone eats. 🫶

with this module you can checkout a config & deploy it in one single method call, and similarly undeploy & delete in a single method call. obsessed, honestly. It also gives you a method to get the list of all machines (and their details) that a deployed configuration has. And on top of all that, the SOAP object & auth header methods are exposed — so if need be, you can use them to reach other SOAP calls available through the Lab Manager SOAP service. iykyk. ✨

🧚 SUBROUTINES/METHODS 🧚

💅 new

this function instantiates the LM object. the arguments, in the required order, are:

  • Username — your username for Lab Manager login.
  • Password — your password for Lab Manager login.
  • Hostname — FQDN of the Lab Manager you are trying to log in.
  • Organization — the Organization to which you belong to in Lab Manager.
heads up bestie: this does not authenticate with the Lab Manager server yet. that happens when you use one of the other methods. so don't come for me when new doesn't log you in, it was never gonna. 😭

🌈 get_soap

this method is primarily used internally, but there are situations where it could be used for other SOAP methods that have not been exposed by this module. it returns a SOAP::Lite object & sets the readable option on. you can use this in conjunction with the Authentication header, which you can grab from the get_auth_header() method. 💖

NOTE: usage of this method outside the scope of this API is not recommended. that's the disclaimer, respect it. 🙈

🎀 get_auth_header

this method returns an authentication header wrapper that is needed for each SOAP call you make to Lab Manager. it uses the options you provided in the new() method to build this header. so like, the vibes you gave at construction time? that's what builds it. ✨

🦋 deploy_config

this method is tailored for automation. during automation, one primarily cares about deploying a library image. a single method call that encapsulates the whole set of operations is more desirable. periodt. 💅

this method requires a config name (make sure it is unique in the system), which it uses to:

  • Checkout the config to your default workspace with a random name.
  • Deploy the configuration in fenced mode.
  • Return the unique numeric Config ID of the deployed config.

you have to use this config ID to undeploy & delete it at a later stage. keep it safe, it's your golden ticket. 🎟️

⭐ get_machines

this method returns an array of all the Machines in the deployed config. for each machine it includes mac address, name, internal IP, external IP, name & its id. yes it says name twice — that's what the original says, and I don't make the rules, I just relay them. 😌

💀 delete_config

this method performs two actions — 1) undeploy the configuration (if it is not undeployed) and 2) delete the configuration. this method takes the config ID of the configuration you deployed earlier using the deploy_config() method. two-for-one, slay. 🔥

👑 AUTHOR 👑

"Aditya Ivaturi", "<"ivaturi at gmail.com">"

🫶 BUGS 🫶

please report any bugs or feature requests to "ivaturi@gmail.com", or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=VMware-LabManager>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. teamwork makes the dream work, fr fr. 💖

🌸 SUPPORT 🌸

you can find documentation for this module with the perldoc command.

perldoc VMware::LabManager

you can also look for information at:

Copyright 2010 "Aditya Ivaturi".

this program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

see <http://dev.perl.org/licenses/> for more information.

and that's a wrap, bestie 🎀✨ this page came to you from perl v5.42.0, dated 2025-07-25, and it lives at VMware::LabManager(3). go forth and deploy your configs, you absolute icon. 💅👑

📦 where this page comes from