.

NAME

ctys-vboxutils - VirtualBox utilities

SYNTAX

ctys-vboxutils

   [-d <debug-options>]
   [-h]
   [-H <help-options>]
   [-n]
   [-V]
   [-X]
   [
     (
       (FETCH|F) (
           VBOXPATH4ID|P4I
           |VBOXUUID4PATH|UUID
           |VBOXNAME|NAME
           |VBOXCFGFILE|CFGFILE
           |VMSTATE|STATE|VS
           |VMMAC|MAC
           |VMRDP|VR
           |VMRDPLST|VRL
        )
     )
     |
     (
       VMMANAGE (
           GETCFGFILE
        )
     )
     |
     (
       (LIST|L) (
           SERVERS_RAW
           |CLIENTS_RAW
       )
     )
   ]

DESCRIPTION

ctys-vboxutils is a collection of wrappers for miscellaneous function calls for display and conversion of inventory and machine data. The call could be executed on localhost or on a remote host with the tool 'ctys-beamer'.

.

OPTIONS

-d <debug-args>

Refer to "ctys" generic options for additional information.

-h

Print help, refer to "-H" for additional information.

-H <help-option>

The extended help option is based on system interfaces for display of manpages, PDF and HTML documents. This comprises the man pages and installed manuals.

For additional help refer to the documents or type ctys -H help.

-V

Version.

-X

Terse output format, effects "-V" when set left-of.

.

ARGUMENTS

<command>

The commands to be executed on the localhost or remote machine.

FETCH <subargs>

• (VMWPATH4ID|P4I) (<ID>|<UUID>|<NAME>) Transforms the provided object ID to a pathname.

• (VBOXUUID4PATH|UUID) (<ID>|<UUID>|<NAME>) Transforms the provided ID to a UUID.

• (VBOXNAME|NAME) (<ID>|<UUID>|<NAME>) Transforms the provided ID to a NAME.

• (VBOXCFGFILE|CFGFILE) (<ID>|<UUID>|<NAME>) Transforms the provided ID to a configuration(XML) file pathname.

• (VMSTATE|STATE|VS) (<ID>|<UUID>|<NAME>) Fetches the state.

• (VMMAC|MAC) (<ID>|<UUID>|<NAME>) Fetches the MAC address list.

• (VMRDP|VR) (<ID>|<UUID>|<NAME>) Fetches the RDP port.

• (VMRDPLST|VRL) (<ID>|<UUID>|<NAME>) Fetches the list of porvided RDP ports.
  
  

CHECK|CHK <subargs>

Checks whether the provided machine is already registered.

LIST <subargs>

Lists the requested entries in raw format for postprocessing.

.

EXIT-VALUES

0: OK:

Result is valid.

1: NOK:

Erroneous parameters.

2: NOK:

Missing an environment element like files or databases.

SEE ALSO

VMs

ctys-VMV(7)

AUTHOR

Written and maintained by Arno-Can Uestuensoez:

COPYRIGHT

Copyright (C) 2008, 2009, 2010 Ingenieurbuero Arno-Can Uestuensoez

For BASE package following licenses apply,

• for software see GPL3 for license conditions,
• for documents see GFDL-1.3 with invariant sections for license conditions,

This document is part of the DOC package,

• for documents and contents from DOC package see
  'Creative-Common-Licence-3.0 - Attrib: Non-Commercial, Non-Deriv'
  
  
  with optional extensions for license conditions.

For additional information refer to enclosed Releasenotes and License files.