Statistics
| Branch: | Tag: | Revision:

one / share / man / onevrouter.1 @ 27e61bae

History | View | Annotate | Download (8.21 KB)

1
.\" generated with Ronn/v0.7.3
2
.\" http://github.com/rtomayko/ronn/tree/0.7.3
3
.
4
.TH "ONEVROUTER" "1" "July 2017" "" "onevrouter(1) -- manages OpenNebula Virtual Routers"
5
.
6
.SH "NAME"
7
\fBonevrouter\fR \- manages OpenNebula Virtual Routers
8
.
9
.SH "SYNOPSIS"
10
\fBonevrouter\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
11
.
12
.SH "OPTIONS"
13
.
14
.nf
15

    
16
 \-\-name name               Name of the new VM or TEMPLATE\. When
17
                           instantiating multiple VMs you can use the "%i"
18
                           wildcard to produce different names such as
19
                           vm\-0, vm\-1\.\.\.
20
 \-m, \-\-multiple x          Instance multiple VMs
21
 \-\-hold                    Creates the new VM on hold state instead of
22
                           pending
23
 \-\-cpu cpu                 CPU percentage reserved for the VM (1=100% one
24
                           CPU)
25
 \-\-vcpu vcpu               Number of virtualized CPUs
26
 \-\-arch arch               Architecture of the VM, e\.g\.: i386 or x86_64
27
 \-\-memory memory           Memory amount given to the VM\. By default the
28
                           unit is megabytes\. To use gigabytes add a \'g\',
29
                           floats can be used: 8g=8192, 0\.5g=512
30
 \-\-disk image0,image1      Disks to attach\. To use an image owned by other
31
                           user use user[disk]\. Add any additional
32
                           attributes separated by \':\' and in the shape of
33
                           KEY=VALUE\. For example, if the disk must be
34
                           resized, use image0:size=1000 \. Or
35
                           image0:size=1000:target=vda,image1:target=vdb
36
 \-\-nic network0,network1   Networks to attach\. To use a network owned by
37
                           other user use user[network]\. Additional
38
                           attributes are supported like with the \-\-disk
39
                           option\.
40
 \-\-raw string              Raw string to add to the template\. Not to be
41
                           confused with the RAW attribute
42
 \-\-vnc                     Add VNC server to the VM
43
 \-\-vnc\-password password   VNC password
44
 \-\-vnc\-listen ip           VNC IP where to listen for connections\. By
45
                           default is 0\.0\.0\.0 (all interfaces)\.
46
 \-\-vnc\-keymap keymap       VNC keyboard layout
47
 \-\-spice                   Add spice server to the VM
48
 \-\-spice\-password password spice password
49
 \-\-spice\-listen ip         spice IP where to listen for connections\. By
50
                           default is 0\.0\.0\.0 (all interfaces)\.
51
 \-\-spice\-keymap keymap     spice keyboard layout
52
 \-\-ssh [file]              Add an ssh public key to the context\. If the file
53
                           is omited then the user variable SSH_PUBLIC_KEY
54
                           will be used\.
55
 \-\-net_context             Add network contextualization parameters
56
 \-\-context line1,line2,line3 Lines to add to the context section
57
 \-\-boot device_list        Set boot device list e\.g\. disk0,disk2,nic0
58
 \-\-files_ds file1,file2    Add files to the contextualization CD from
59
                           thefiles datastore
60
 \-\-init script1,script2    Script or scripts to start in context
61
 \-\-startscript [file]      Start script to be executed
62
 \-\-report_ready            Sends READY=YES to OneGate, useful for OneFlow
63
 \-\-vcenter_vm_folder path  In a vCenter environment sets the the VMs and
64
                           Template folder where the VM will be placed in\.
65
                           The path uses slashes to separate folders\. For
66
                           example: \-\-vcenter_vm_folder "/Management/VMs"
67
 \-a, \-\-append              Append new attributes to the current template
68
 \-f, \-\-file file           Selects the template file
69
 \-n, \-\-network id|name     Selects the virtual network
70
 \-i, \-\-ip ip               IP address for the new NIC
71
 \-\-float                   Makes this IP request a Floating one
72
 \-l, \-\-list x,y,z          Selects columns to display with list command
73
 \-c, \-\-listconf conf       Selects a predefined column list
74
 \-d, \-\-delay x             Sets the delay in seconds for top command
75
 \-f, \-\-filter x,y,z        Filter data\. An array is specified with
76
                           column=value pairs\.
77
 \-\-csv                     Write table in csv format
78
 \-x, \-\-xml                 Show the resource in xml format
79
 \-n, \-\-numeric             Do not translate user and group IDs
80
 \-\-describe                Describe list columns
81
 \-\-all                     Show all template data
82
 \-v, \-\-verbose             Verbose mode
83
 \-h, \-\-help                Show this message
84
 \-V, \-\-version             Show version and copyright information
85
 \-\-user name               User name used to connect to OpenNebula
86
 \-\-password password       Password to authenticate with OpenNebula
87
 \-\-endpoint endpoint       URL of OpenNebula xmlrpc frontend
88
.
89
.fi
90
.
91
.SH "COMMANDS"
92
.
93
.IP "\(bu" 4
94
create \fIfile\fR Creates a new Virtual Router from the given description
95
.
96
.IP "\(bu" 4
97
instantiate \fIvrouterid\fR \fItemplateid\fR [\fIfile\fR] Creates a new VM instance from the given Template\. This VM can be managed with the \'onevm\' command\.
98
.
99
.IP "" 4
100
.
101
.nf
102

    
103
The NIC elements defined in the Virtual Router will be used\. The
104
source Template can be modified adding or replacing attributes with
105
the optional file argument, or with the options\.
106
valid options: name, multiple, hold, cpu, vcpu, arch, memory, disk, nic, raw, vnc, vnc_password, vnc_listen, vnc_keymap, spice, spice_password, spice_listen, spice_keymap, ssh, net_context, context, boot, files_ds, init, startscript, report_ready, vcenter_vm_folder
107
.
108
.fi
109
.
110
.IP "" 0
111

    
112
.
113
.IP "\(bu" 4
114
delete \fIrange|vrouterid_list\fR Deletes the given Virtual Router
115
.
116
.IP "\(bu" 4
117
chgrp \fIrange|vrouterid_list\fR \fIgroupid\fR Changes the Virtual Router group
118
.
119
.IP "\(bu" 4
120
chown \fIrange|vrouterid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the Virtual Router owner and group
121
.
122
.IP "\(bu" 4
123
chmod \fIrange|vrouterid_list\fR \fIoctet\fR Changes the Virtual Router permissions
124
.
125
.IP "\(bu" 4
126
update \fIvrouterid\fR [\fIfile\fR] Update the Virtual Router contents\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
127
.
128
.IP "\(bu" 4
129
rename \fIvrouterid\fR \fIname\fR Renames the Virtual Router
130
.
131
.IP "\(bu" 4
132
nic\-attach \fIvrouterid\fR Attaches a NIC to a VirtualRouter, and each one of its VMs\. When using \-\-file add only one NIC instance\.
133
.
134
.IP "" 4
135
.
136
.nf
137

    
138
Note if you are using a HA configuration for this router, \-\-float can be
139
added\. When an IP is requested in HA clusters use \-\-float\.
140
valid options: file, network, ip, float
141
.
142
.fi
143
.
144
.IP "" 0
145

    
146
.
147
.IP "\(bu" 4
148
nic\-detach \fIvrouterid\fR \fInicid\fR Detaches a NIC from a VirtualRouter, and each one of its VMs
149
.
150
.IP "\(bu" 4
151
list [\fIfilterflag\fR] Lists the Virtual Routers in the pool valid options: list, listconf, delay, filter, csv, xml, numeric, describe
152
.
153
.IP "\(bu" 4
154
show \fIvrouterid\fR Shows information for the given Virtual Router valid options: xml, all
155
.
156
.IP "\(bu" 4
157
top [\fIfilterflag\fR] Lists Virtual Routers continuously valid options: list, listconf, delay, filter, csv, xml, numeric, describe
158
.
159
.IP "" 0
160
.
161
.SH "ARGUMENT FORMATS"
162
.
163
.IP "\(bu" 4
164
file Path to a file
165
.
166
.IP "\(bu" 4
167
range List of id\'s in the form 1,8\.\.15
168
.
169
.IP "\(bu" 4
170
text String
171
.
172
.IP "\(bu" 4
173
groupid OpenNebula GROUP name or id
174
.
175
.IP "\(bu" 4
176
userid OpenNebula USER name or id
177
.
178
.IP "\(bu" 4
179
vrouterid OpenNebula VROUTER name or id
180
.
181
.IP "\(bu" 4
182
vrouterid_list Comma\-separated list of OpenNebula VROUTER names or ids
183
.
184
.IP "\(bu" 4
185
filterflag a, all all the known VROUTERs m, mine the VROUTER belonging to the user in ONE_AUTH g, group \'mine\' plus the VROUTER belonging to the groups the user is member of G, primary group the VROUTER owned the user\'s primary group uid VROUTER of the user identified by this uid user VROUTER of the user identified by the username
186
.
187
.IP "\(bu" 4
188
templateid OpenNebula VMTEMPLATE name or id
189
.
190
.IP "" 0
191
.
192
.SH "LICENSE"
193
OpenNebula 5\.4\.0 Copyright 2002\-2017, OpenNebula Project, OpenNebula Systems
194
.
195
.P
196
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