code.grnet.gr Git - kamaki/blob - docs/man/kamaki.rst

   1 :orphan:
   2
   3 kamaki tool manual page
   4 =======================
   5
   6 Synopsis
   7 --------
   8
   9 **kamaki** [*group*] [*command*] [...] [*options*]
  10
  11
  12 Description
  13 -----------
  14
  15 :program:`kamaki` is a simple, yet intuitive, command-line tool for managing
  16 clouds. It can be used in three forms: as an interactive shell, as a command line tool or as a clients API for other applications.
  17
  18 To run kamaki as an interactive shell, type
  19
  20     kamaki
  21
  22 To run kamaki as tool type
  23
  24     kamaki <group> <command> [...] [options]
  25
  26 The kamaki clients API can be imported in python applications as kamaki.clients
  27
  28
  29 List of available command groups:
  30
  31 config
  32
  33     Edit configuration options. Config options are stored in ~/.kamakirc file.
  34
  35 history
  36
  37     Access kamaki user history, which is stored in ~/.kamaki.history file.
  38
  39 server
  40
  41     Manage compute API virtual machines.
  42
  43 flavor
  44
  45     Manage compute API flavors.
  46
  47 network
  48
  49     Manage compute API networks.
  50
  51 image
  52
  53     Manage compute API and glance images.
  54
  55 store
  56
  57     Manage store API.
  58
  59
  60 Options
  61 -------
  62
  63 .. code-block:: console
  64
  65     --help, -h              Show help message and exit.
  66     -v                      Use verbose output.
  67     -d                      Use debug output.
  68     -o KEY=VAL              Override a config value (can be used multiple times)
  69
  70
  71 Commands
  72 --------
  73
  74 config commands
  75 ***************
  76
  77 * list       list configuration options
  78 * get        get a configuration option
  79 * set        set a configuration option
  80 * del        delete a configuration option
  81
  82
  83 history commands
  84 ****************
  85
  86 Command user history, as stored in ~/.kamaki.history
  87
  88 * all       show user history
  89 * clean     clean up history
  90
  91
  92 server commands
  93 ***************
  94
  95 * list       list servers
  96 * info       get server details
  97 * create     create server
  98 * rename     update server name
  99 * delete     delete server
 100 * reboot     reboot server
 101 * start      start server
 102 * shutdown   shutdown server
 103 * console    get a VNC console
 104 * firewall   set the firewall profile
 105 * addr       list server addresses
 106 * meta       get server metadata
 107 * addmeta    add server metadata
 108 * setmeta    update server metadata
 109 * delmeta    delete server metadata
 110 * stats      get server statistics
 111 * wait       wait for server to finish [BUILD, STOPPED, REBOOT, ACTIVE]
 112
 113
 114 flavor commands
 115 ***************
 116
 117 * list       list flavors
 118 * info       get flavor details
 119
 120
 121 image commands and options
 122 **************************
 123
 124 * list        list images
 125 * info        get image details
 126 * public      list public images
 127 * shared      list shared images
 128 * delete      delete image
 129 * register    register an image
 130 * reregister  re-register an image (preserve and update properties)
 131 * meta        get image metadata
 132 * members     get image members
 133 * addmember   add a member to an image
 134 * delmember   remove a member from an image
 135 * setmembers  set the members of an image
 136 * properties  get image properties
 137 * setproperty update an image property
 138 * addproperty add an image property
 139 * delproperty delete an image property
 140
 141 network commands
 142 ****************
 143
 144 * list       list networks
 145 * create     create a network
 146 * info       get network details
 147 * rename     update network name
 148 * delete     delete a network
 149 * connect    connect a server to a network
 150 * disconnect disconnect a server from a network
 151
 152
 153 store commands
 154 **************
 155
 156 * append    Append local file to (existing) remote object
 157 * cat       Print a file to console
 158 * copy      Copy an object
 159 * create    Create a container or a directory object
 160 * delete    Delete a container [or an object]
 161 * delgroup  Delete a user group on an account
 162 * delmeta   Delete an existing metadatum of account [, container [or object]]
 163 * delpermissions    Delete all sharing permissions
 164 * download  Download a file
 165 * group     Get user groups details for account
 166 * hashmap   Get the hashmap of an object
 167 * info      Get information for account [, container [or object]]
 168 * list      List containers, object trees or objects in a directory
 169 * manifest  Create a remote file with uploaded parts by manifestation
 170 * meta      Get custom meta-content for account [, container [or object]]
 171 * mkdir     Create a directory
 172 * move      Copy an object
 173 * overwrite Overwrite part (from start to end) of a remote file
 174 * permissions   Get object read/write permissions
 175 * publish   Publish an object
 176 * purge     Purge a container
 177 * quota     Get quota for account [or container]
 178 * setgroup  Create/update a new user group on account
 179 * setmeta   Set a new metadatum for account [, container [or object]]
 180 * setpermissions    Set sharing permissions
 181 * setquota  Set new quota (in KB) for account [or container]
 182 * setversioning Set new versioning (auto, none) for account [or container]
 183 * sharers   List the accounts that share objects with default account
 184 * truncate  Truncate remote file up to a size
 185 * unpublish Unpublish an object
 186 * upload    Upload a file
 187 * versioning    Get  versioning for account [or container ]
 188 * versions  Get the version list of an object
 189
 190
 191
 192 Author
 193 ------
 194
 195 GRNET development team <synnefo-devel@googlegroups.com>.
 196