one/share/man/oneimage.1

.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "ONEIMAGE" "1" "March 2015" "" "oneimage(1) -- manages OpenNebula images"
.
.SH "NAME"
\fBoneimage\fR
.
.SH "SYNOPSIS"
\fBoneimage\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
.
.SH "OPTIONS"
.
.nf

 \-d, \-\-datastore id|name   Selects the datastore
 \-\-name name               Name of the new image
 \-\-description description Description for the new Image
 \-\-type type               Type of the new Image: OS, CDROM, DATABLOCK,
                           KERNEL, RAMDISK, CONTEXT
 \-\-persistent              Tells if the image will be persistent
 \-\-prefix prefix           Device prefix for the disk (eg\. hd, sd, xvd or
                           vd)
 \-\-target target           Device the disk will be attached to
 \-\-path path               Path of the image file
 \-\-driver driver           Driver to use image (raw, qcow2, tap:aio:\.\.\.)
 \-\-disk_type disk_type     Type of the image (BLOCK, CDROM, RBD or FILE)
 \-\-source source           Source to be used\. Useful for not file\-based
                           images
 \-\-size size               Size in MB\. Used for DATABLOCK type or SOURCE
                           based images\.
 \-\-fstype fstype           Type of file system to be built\. This can be any
                           value understood by mkfs unix command\.
 \-\-dry                     Just print the template
 \-a, \-\-append              Append new attributes to the current template
 \-l, \-\-list x,y,z          Selects columns to display with list command
 \-d, \-\-delay x             Sets the delay in seconds for top command
 \-f, \-\-filter x,y,z        Filter data\. An array is specified with
                           column=value pairs\.
 \-\-csv                     Write table in csv format
 \-x, \-\-xml                 Show the resource in xml format
 \-n, \-\-numeric             Do not translate user and group IDs
 \-\-describe                Describe list columns
 \-v, \-\-verbose             Verbose mode
 \-h, \-\-help                Show this message
 \-V, \-\-version             Show version and copyright information
 \-\-user name               User name used to connect to OpenNebula
 \-\-password password       Password to authenticate with OpenNebula
 \-\-endpoint endpoint       URL of OpenNebula xmlrpc frontend
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
create [\fIfile\fR] Creates a new Image Examples:
.
.IP "" 4
.
.nf

  \- using a template description file:

    oneimage create \-d default centOS\.tmpl

  \- new image "arch" using a path of type centOS:

    oneimage create \-d default \-\-name arch \-\-path /tmp/arch\.img

  \- new persistent image, OS type and qcow2 format:

    oneimage create \-d 1 \-\-name ubuntu \-\-path /tmp/ubuntu\.qcow2 \e
                    \-\-prefix sd \-\-type OS \-\-driver qcow2 \e
                    \-\-description "A OS plain installation"

  \- a datablock image of 400MB:

    oneimage create \-d 1 \-\-name data \-\-type DATABLOCK \-\-size 400 \e
                    \-\-fstype ext2
valid options: datastore, name, description, type, persistent, prefix, target, path, driver, disk_type, source, size, fstype, dry
.
.fi
.
.IP "" 0

.
.IP "\(bu" 4
clone \fIimageid\fR \fIname\fR Creates a new Image from an existing one valid options: datastore
.
.IP "\(bu" 4
delete \fIrange|imageid_list\fR Deletes the given Image
.
.IP "\(bu" 4
persistent \fIrange|imageid_list\fR Makes the given Image persistent\. A persistent Image saves the changes made to the contents after the VM instance is shutdown (or in real time if a shared FS is used)\. Persistent Images can be used by only one VM instance at a time\.
.
.IP "\(bu" 4
nonpersistent \fIrange|imageid_list\fR Makes the given Image non persistent\. See \'oneimage persistent\'
.
.IP "\(bu" 4
update \fIimageid\fR [\fIfile\fR] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
.
.IP "\(bu" 4
enable \fIrange|imageid_list\fR Enables the given Image
.
.IP "\(bu" 4
chtype \fIrange|imageid_list\fR \fItype\fR Changes the Image\'s type
.
.IP "\(bu" 4
disable \fIrange|imageid_list\fR Disables the given Image
.
.IP "\(bu" 4
chgrp \fIrange|imageid_list\fR \fIgroupid\fR Changes the Image group
.
.IP "\(bu" 4
chown \fIrange|imageid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the Image owner and group
.
.IP "\(bu" 4
chmod \fIrange|imageid_list\fR \fIoctet\fR Changes the Image permissions
.
.IP "\(bu" 4
rename \fIimageid\fR \fIname\fR Renames the Image
.
.IP "\(bu" 4
list [\fIfilterflag\fR] Lists Images in the pool valid options: list, delay, filter, csv, xml, numeric, describe
.
.IP "\(bu" 4
show \fIimageid\fR Shows information for the given Image valid options: xml
.
.IP "\(bu" 4
top [\fIfilterflag\fR] Lists Images continuously valid options: list, delay, filter, csv, xml, numeric, describe
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
file Path to a file
.
.IP "\(bu" 4
range List of id\'s in the form 1,8\.\.15
.
.IP "\(bu" 4
text String
.
.IP "\(bu" 4
groupid OpenNebula GROUP name or id
.
.IP "\(bu" 4
userid OpenNebula USER name or id
.
.IP "\(bu" 4
imageid OpenNebula IMAGE name or id
.
.IP "\(bu" 4
imageid_list Comma\-separated list of OpenNebula IMAGE names or ids
.
.IP "\(bu" 4
filterflag a, all all the known IMAGEs m, mine the IMAGE belonging to the user in ONE_AUTH g, group \'mine\' plus the IMAGE belonging to the groups the user is member of uid IMAGE of the user identified by this uid user IMAGE of the user identified by the username
.
.IP "\(bu" 4
type Image type: OS, CDROM, DATABLOCK, KERNEL, RAMDISK, CONTEXT
.
.IP "" 0
.
.SH "LICENSE"
OpenNebula 4\.12\.0 Copyright 2002\-2015, OpenNebula Project (OpenNebula\.org), C12G Labs
.
.P
Licensed under the Apache License, Version 2\.0 (the "License"); you may not use this file except in compliance with the License\. You may obtain a copy of the License at http://www\.apache\.org/licenses/LICENSE\-2\.0