Name Last Update
cli Loading commit data...
cli_legacy Loading commit data...
grid Loading commit data...
proxy Loading commit data...
register Loading commit data...
slap Loading commit data...
tests Loading commit data...
README.console.txt Loading commit data...
README.format.txt Loading commit data...
README.grid.txt Loading commit data...
README.proxy.txt Loading commit data...
README.slap.txt Loading commit data... Loading commit data... Loading commit data... Loading commit data... Loading commit data... Loading commit data...
slapos.xsd Loading commit data... Loading commit data... Loading commit data...

The slapconsole tool allows to interact with a SlapOS Master throught the SLAP

For more information about SlapOS or slapconsole usages, please go to

The slapconsole tool is only a bare Python console with several global variables
defined and initialized.

Initialization and configuration file

Slapconsole allows to automatically connect to a Master using URL and SSL
certificate from given slapos.cfg.
Certificate has to be *USER* certificate, manually obtained from SlapOS master
web interface.

Slapconsole tools reads the given slapos.cfg configuration file and use the
following informations :

 * Master URL is read from [slapos] in the "master_url" parameter.
 * SSL Certificate is read from [slapconsole] in the "cert_file" parameter.
 * SSL Key is read from [slapconsole] in the "key_file" parameter.

See slapos.cfg.example for examples.

Global functions

 * request() is a shorthand for slap.registerOpenOrder().request() allowing
   to request instances.
 * supply() is a shorthand for slap.registerSupply().supply() allowing to
   request software installation.

For more information about those methods, please read the SLAP library

Global aliases

"software_list" is a list containing all the Software Release URLs defined in
client slapos.cfg configuration file.

Also, each Software Release defined in this configuration file is translated
into a global variable to ease the request of those Sofware Releases.

This allows to request instances in a few words, i.e::

  request("", "mykvm")

can be simplified into ::

  request(kvm, "mykvm")

If the slapos.cfg file contains ::

  alias =

Global objects

"slap" is an instance of the SLAP library. It is only used for advanced usages.
"slap" instance is obtained by doing ::

  slap = slapos.slap.slap()
    key_file=config.key_file, cert_file=config.cert_file)



  >>> # Request instance
  >>> request(kvm, "myuniquekvm")

  >>> # Request instance on specific computer
  >>> request(kvm, "myotheruniquekvm",
    filter_kw={ "computer_guid": "COMP-12345" })
  >>> # Request instance, specifying parameters (here nbd_ip and nbd_port)
  >>> request(kvm, "mythirduniquekvm",

  >>> # Request software installation on owned computer
  >>> supply(kvm, "mycomputer")

  >>> # Fetch existing instance status
  >>> request(kvm, "myuniquekvm").getState()

  >>> # Fetch instance information on already launched instance
  >>> request(kvm, "myuniquekvm").getConnectionParameter("url")