Sinn XMLRPC API 1.0.0

Methods List

go to index

api.version

string api.version()
Parameters

    Description

    Get the API version.

    go to index

    interface.attributes

    array interface.attributes(bool onlyMutables)
    Parameters
    • onlyMutables bool (optionnal) filters unmutable attributes.

    Description

    List attributes of an interface.


    Possible attributes are :

    • label : unmutable, string
    • macAddr : unmutable, string
    • model : mutable, string, default=virtio
    • packetIn : unmutable, integer
    • packetOut : unmutable, integer
    • byteIn : unmutable, integer
    • byteOut : unmutable, integer

    go to index

    interface.create

    none interface.create(string sitegroup , string label , struct attributes )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the new interface.
    • attributes struct (optionnal) attributes.

    Description

    Create an interface.
    An interface is a virtual network card.

    go to index

    interface.delete

    none interface.delete(string sitegroup, string label)
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the interface.

    Description

    Delete an interface.

    go to index

    interface.ipaddress.attach

    none interface.ipaddress.attach(string sitegroup , string label , string ipaddress )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the interface.
    • ipaddress string label of ipaddress to attach.

    Description

    Attach an ipaddress to an interface.

    go to index

    interface.ipaddress.detach

    none interface.ipaddress.detach(string sitegroup , string label , string ipaddress )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the interface.
    • ipaddress string label of ipaddress to detach.

    Description

    Detach an ipaddress from an interface.

    go to index

    interface.ipaddress.list

    array interface.ipaddress.list(string sitegroup , string label , none|string|array ipaddress )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the interface.
    • ipaddress none|string|array (optionnal) label(s) of the ipaddress(es).

    Description

    List interface's attached ipaddress(es) : detailed if label(s), general if not.

    go to index

    interface.list

    array interface.list(string sitegroup, none|string|array label)
    Parameters
    • sitegroup string associated sitegroup
    • label none|string|array (optionnal) label(s) of the interface(s).

    Description

    List interface(s).

    If no label, list all sitegroup interfaces labels.
    Else, list interfaces indexed by label in a struct compound of :

    • siteGroup : string name of asociated siteGroup.
    • machine : struct compound of label and current status of attached machine(s).
    • vlan : struct compound of label and tag of attached vlan.
    • ip : array of attached ip label(s)

    go to index

    interface.types.list

    array interface.types.list(string sitegroup)
    Parameters
    • sitegroup string to have the list related to.

    Description

    List network interface types (eg: virtio, ne2000, ...).

    go to index

    interface.update

    none interface.update(string sitegroup , string label , struct attributes )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the interface.
    • attributes struct (optionnal) attributes to update.

    Description

    Update mutable attributes of an interface.

    go to index

    ipaddress.attributes

    array ipaddress.attributes(bool onlyMutables)
    Parameters
    • onlyMutables bool (optionnal) filters unmutable attributes.

    Description

    List of attributes of a ipaddress.


    Possible attributes are :

    • label : unmutable, string
    • addr : unmutable string, IP address
    • reverse : mutable, string, default=None

    go to index

    ipaddress.create

    none ipaddress.create(string sitegroup, string label, struct attributes)
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the new ipaddress.
    • attributes struct (optionnal) attributes.

    Description

    Create an ipaddress.

    Note: ipaddress is dynamic, so you have to specify kind of IP Family you want to obtain in attributes : familiy=ipv4 or family=ipv6.

    go to index

    ipaddress.delete

    none ipaddress.delete(string sitegroup , string label )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of ipaddress.

    Description

    Destroy an ipaddress

    go to index

    ipaddress.list

    array ipaddress.list(string sitegroup , string label )
    Parameters
    • sitegroup string associated sitegroup.
    • label string (optionnal) label of ipaddress.

    Description

    List network ipaddresses.

    go to index

    ipaddress.update

    none ipaddress.update()

    Description


    go to index

    machine.attributes

    array machine.attributes(boolean onlyMutables)
    Parameters
    • onlyMutables boolean (optionnal) filters unmutable attributes.

    Description

    List attributes of a machine.


    Possible attributes are :

    • label : unmutable, string
    • vcpu : mutable, integer, default=1
    • cpu : mutable, integer, default=x86-64bit
    • memory : mutable, string, default=1024M
    - vnc (substruct) : password(mutable, string, default=None), keymap(mutable, string, default=en-us)

    go to index

    machine.boot

    none machine.boot(string sitegroup , string label )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the machine.

    Description

    Boot a machine.

    The machine can boot only if it has :
    - An interface.
    - At least a bootable storage.
    - All of its storages are ready.

    go to index

    machine.cputype.list

    array machine.cputype.list(string sitegroup)
    Parameters
    • sitegroup string associated sitegroup.

    Description

    List cpu types.

    go to index

    machine.create

    none machine.create(string sitegroup , string label , struct attributes )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the new machine.
    • attributes struct (optionnal) attributes.

    Description

    Create a machine.
    The machine is a GNU/Linux kvm virtual machine instance.

    go to index

    machine.delete

    none machine.delete(string sitegroup , string label )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the machine.

    Description

    Delete a machine.
    Attached resources (interface, storage, ...) must be detached first.

    go to index

    machine.interface.attach

    none machine.interface.attach(string sitegroup , string label , string interface )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the machine.
    • interface string label of interface to attach.

    Description

    Attach an interface to a machine.

    go to index

    machine.interface.detach

    none machine.interface.detach(string sitegroup , string label , string interface )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the machine.
    • interface string label of interface to detach.

    Description

    Detach an interface from a machine.

    go to index

    machine.interface.list

    array machine.interface.list(string sitegroup , string label , none|string|array interface )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the machine.
    • interface none|string|array (optionnal) label(s) of the interface(s).

    Description

    List machine's attached interface(s).
    Detailed if label(s), general if not.

    go to index

    machine.list

    array machine.list(string sitegroup , none|string|array label )
    Parameters
    • sitegroup string associated sitegroup.
    • label none|string|array (optionnal) label(s) of the machine(s).

    Description

    List machine(s).
    Detailed if label(s), general if not.

    go to index

    machine.migrate

    none machine.migrate(string sitegroup , string label , string hostnode )
    Parameters
    • sitegroup string associated sitegroup.
    • label string machine's label.
    • hostnode string machine destination node label.

    Description

    Migrate a machine.
    The machine can only migrate to another node than the one it runs.

    go to index

    machine.shutdown

    none machine.shutdown(string sitegroup , string label )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the machine.

    Description

    Shutdown a machine.

    go to index

    machine.storage.attach

    none machine.storage.attach(string sitegroup , string label , string storage , none|struct attributes )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the machine.
    • storage string label of storage to attach.
    • attributes none|struct (optionnal) array attributes.

    Description

    Attach a storage volume to a virual machine.

    Possible attributes are :
    - bus (default : virtio)
    - media (default : disk)
    - readOnly (default : False)
    - bootOrder (default : 1)
    - bootable (default: False)

    go to index

    machine.storage.bustype.list

    array machine.storage.bustype.list(string sitegroup)
    Parameters
    • sitegroup string label of associated sitegroup.

    Description

    List storage bus types.

    go to index

    machine.storage.detach

    none machine.storage.detach(string sitegroup , string label , string storage )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the machine.
    • storage string label of storage to detach.

    Description

    Detach a storage from a machine.

    go to index

    machine.storage.list

    array machine.storage.list(string sitegroup , string label , none|string|array storage )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the machine.
    • storage none|string|array (optionnal) label(s) of the storage(s).

    Description

    List machine's attached storage(s)
    Detailed if label(s), general if not.

    go to index

    machine.update

    none machine.update(string sitegroup , string label , struct attributes )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the machine.
    • attributes struct (optionnal) attributes.

    Description

    Update mutable attributes of a machine.

    go to index

    machine.vnc.keymap.list

    array machine.vnc.keymap.list(string sitegroup)
    Parameters
    • sitegroup string associated sitegroup.

    Description

    List vnc keymaps.

    go to index

    sitegroup.list

    none sitegroup.list(none|string|array label)
    Parameters
    • label none|string|array (optionnal) sitegroup label

    Description

    List sitegroups.

    go to index

    storage.attributes

    array storage.attributes(bool onlyMutables)
    Parameters
    • onlyMutables bool (optionnal) filters unmutable attributes.

    Description

    List of attributes of a storage.


    Possible attributes are :

    • label : unmutable
    • size : unmutable, string, default=1G
    • public : mutable, bool, default=False

    go to index

    storage.clone

    none storage.clone(string sitegroup , string label , string from_label )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the storage.
    • from_label string label of the storage to clone.

    Description

    Composite call of storage_cloneconfig and storage_clonedata

    go to index

    storage.clone_config

    none storage.clone_config(string sitegroup , string label , string from_label )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the storage.
    • from_label string label of the storage to clone.

    Description

    Create from an existant storage a new empty one with same
    size/sitegroup.

    go to index

    storage.clone_data

    none storage.clone_data(string sitegroup , string label , string from_label )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the storage.
    • from_label string label of the storage to clone.

    Description

    Clone data of a storage to another storage.

    go to index

    storage.create

    none storage.create(string sitegroup , string label , attributes attributes )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the new storage.
    • attributes attributes struct.

    Description

    Create a storage volume.

    go to index

    storage.delete

    none storage.delete(string sitegroup , string label )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the storage.

    Description

    Delete a storage, must not be attached to any machine.

    go to index

    storage.list

    array|struct storage.list(string sitegroup , (optionnal) label )
    Parameters
    • sitegroup string associated sitegroup.
    • label (optionnal) string|array label(s) of the storage(s).

    Description

    List storage(s) : detailed if label(s), general if not.

    go to index

    storage.update

    none storage.update(string sitegroup , string label , struct attributes )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the storage.
    • attributes struct (optionnal) attributes.

    Description

    Update mutables attributes of a storage.

    go to index

    system.listMethods

    none system.listMethods()

    Description

    Return a list of the method names implemented by this server.

    go to index

    system.methodHelp

    none system.methodHelp()

    Description

    Return a documentation string describing the use of the given method.

    go to index

    system.methodSignature

    none system.methodSignature()

    Description

    Return a list of type signatures.

    Each type signature is a list of the form [rtype, type1, type2, ...]
    where rtype is the return type and typeN is the type of the Nth
    argument. If no signature information is available, the empty
    string is returned.

    go to index

    vlan.attributes

    array vlan.attributes(bool onlyMutables)
    Parameters
    • onlyMutables bool (optionnal) filters unmutable attributes.

    Description

    List attributes of a vlan.


    Possible attributes are :

    • label : unmutable, string
    • tag : unmutable, integer, default=1

    go to index

    vlan.create

    none vlan.create(string sitegroup , string label )
    Parameters
    • sitegroup string associated sitegroup label.
    • label string vlan label.

    Description

    Create a tagged vlan.

    go to index

    vlan.delete

    none vlan.delete(string sitegroup , string label )
    Parameters
    • sitegroup string associated sitegroup label.
    • label string vlan label.

    Description

    Destroy a vlan.

    go to index

    vlan.interface.attach

    none vlan.interface.attach(string sitegroup , string label , string interface )
    Parameters
    • sitegroup string associated sitegroup label.
    • label string vlan label.
    • interface string interface label.

    Description

    Attach an interface to a vlan.

    go to index

    vlan.interface.detach

    none vlan.interface.detach(string sitegroup , string label , string interface )
    Parameters
    • sitegroup string associated sitegroup label.
    • label string vlan label.
    • interface string interface label.

    Description

    Restore interface attachment to default vlan.

    go to index

    vlan.interface.list

    array vlan.interface.list(string sitegroup , string label , none|string|array interface )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the vlan.
    • interface none|string|array label(s) of the interface(s).

    Description

    List vlan's attached interface(s)
    Detailed if interface(s) label(s), general if not.

    go to index

    vlan.list

    array vlan.list(string sitegroup , none|string|array label )
    Parameters
    • sitegroup string associated sitegroup label.
    • label none|string|array vlan label.

    Description

    List virtual networks.

    go to index

    vlan.update

    none vlan.update(string sitegroup , string label , struct attributes )
    Parameters
    • sitegroup string associated sitegroup.
    • label string label of the vlan.
    • attributes struct (optionnal) attributes.

    Description

    Update mutable attributes of a vlan.