Tools

Archipel comes with some utilities that can make your life easier.

archipel-tagnode

This tool allow to create and configure the needed PubSub "/archipel/tags" used for central tags management. This tag MUST be created on the common pubsub server if you want tags to be shared all over the platform

arch-tagnode (c) 2010 Antoine Mercadal
this tool allows to create a new tags node. 
you should create this node using admin account (or a special dedicated account)

usage :
    arch-tagnode --jid aJid --password aPassword --pubsubserver pubsub.server [--create] [--delete]

    --jid           : set the JID to use
    --password      : set the password associated to the JID
    --pubsubserver  : set the pubsubserver to use. if not given it will be pubsub.[jid.getDomain()]
    --create, -c    : create the node (default action)
    --delete, -d    : delete the node
    --help, -h      : shows this message

You should use the admin account to create this node.

archipel-rolesnode

This tool allow to create and configure the needed PubSub "/archipel/roles" node used to store roles (permissions templates)

arch-rolesnode (c) 2010 Antoine Mercadal
this tool allows to create a new role node. 
you should create this node using admin account (or a special dedicated account)

usage :
    arch-rolesnode --jid aJid --password aPassword --pubsubserver pubsub.server [--create] [--delete]

    --jid           : set the JID to use
    --password      : set the password associated to the JID
    --pubsubserver  : set the pubsubserver to use. if not given it will be pubsub.[jid.getDomain()]
    --create, -c    : create the node (default action)
    --delete, -d    : delete the node
    --help, -h      : shows this message

You should use the admin account to create this node.

archipel-vmparking

This tool creates the needed pubsub node to handle vmparking.

Usage: archipel-vmparkingnode [options]

Options:
  -h, --help            show this help message and exit
  -j user@domain, --jid=user@domain
                        set the JID to use
  -p 123456, --password=123456
                        set the password associated to the JID
  -P pubsub.domain, --pubsubserver=pubsub.domain
                        set the pubsubserver to use. if not given it will be
                        pubsub.[jid.getDomain()]
  -c, --create          create the node (default action)
  -d, --delete          delete the node
  -a user@domain, --authorize=user@domain
                        authorize an hypervisor to handle the parking
  -u user@domain, --unauthorize=user@domain
                        unauthorize an hypervisor to handle the parking
  -l, --list            List authorized accounts

You should use the admin account to create this node. If you want your hypervisors to be able to park/unpark virtual machines, you need to declare them able to by doing:

# archipel-vmparkingnode [email protected] --password=yourpassword -a [email protected]

To remove one:

# archipel-vmparkingnode [email protected] --password=yourpassword -u [email protected]

And to list authorized ones:

# archipel-vmparkingnode [email protected] --password=yourpassword -l

archipel-adminaccounts

This tools allow you to declare dynamically new Archipel administrators (all permissions, on everything).

Usage: archipel-adminaccounts [options]

Options:
  -h, --help            show this help message and exit
  -j user@domain, --jid=user@domain
                        set the JID to use
  -p 123456, --password=123456
                        set the password associated to the JID
  -P pubsub.domain, --pubsubserver=pubsub.domain
                        set the pubsubserver to use. if not given it will be
                        pubsub.[jid.getDomain()]
  -c, --create          create the node
  -d, --delete          delete the node
  -a jid@domain, --authorize=jid@domain
                        insert a new admin JID
  -u jid@domain, --unauthorize=jid@domain
                        remove an admin JID identified by the item ID
  -l, --list            list all existing JID

Once created, you can add an admin account

# archipel-adminaccounts [email protected] --password=yourpassword -a [email protected] 

To remove one:

# archipel-adminaccounts [email protected] --password=yourpassword -a [email protected] 

And to list them:

# archipel-adminaccounts [email protected] --password=yourpassword -l

The platform will be notified in real time. Note that you can grant admin access right from the XMPPServer module, from the UI

archipel-updatedomain

This tool allow to quickly change the XMPP domain of all virtual machines stored in the hypervisor's database. For example, if your domain was @olddomain you can use this tool to update to @newshinydomain.

update_xmpp_domain (c) 2010 Antoine Mercadal
This tool allows you to quicky change the domain of all virtual machines in a hypervisor database.

usage: 
    update_xmpp_domain --file aFile --domain aDomain

    --file      : the sqlite3 file of hypervisor
    --domain    : the new domain to use
    --help, -h  : displays this message

archipel-importvirtualmachine

**This tool is deprecated. You should use the UI directly to import virtual machines now ** This tool allows you to import already existing virtual machine into your hypervisor's archipel agent.

archipel-importvirtualmachine (c) 2010 Antoine Mercadal
this tool allows to import already existing libvirt virtual machine into Archipel.
Be sure to stop archipel agent before running this tool

usage :
    archipel-importvirtualmachine --file=sqlite3DB --uuid=aUUID --xmppserver=aServer --name=aName [--password=aPassword]
    
    --file          : the sqlite3 file of hypervisor
    --uuid          : the UUID of the exting libvirt machine
    --xmppserver    : the current Archipel's XMPP server
    --name          : the name you want to use for this virtual machine
    --password      : OPTIONAL, the password the VM should use to connect to XMPP server. Generated if ommitted
    --help, -h      : shows this message