Statistics
| Branch: | Tag: | Revision:

one / share / man / onevnet.1 @ f3d57119

History | View | Annotate | Download (5.79 KB)

1
.\" generated with Ronn/v0.7.3
2
.\" http://github.com/rtomayko/ronn/tree/0.7.3
3
.
4
.TH "ONEVNET" "1" "August 2015" "" "onevnet(1) -- manages OpenNebula networks"
5
.
6
.SH "NAME"
7
\fBonevnet\fR \- manages OpenNebula networks
8
.
9
.SH "SYNOPSIS"
10
\fBonevnet\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR]
11
.
12
.SH "OPTIONS"
13
.
14
.nf
15

    
16
 \-c, \-\-cluster id|name     Selects the cluster
17
 \-v, \-\-verbose             Verbose mode
18
 \-h, \-\-help                Show this message
19
 \-V, \-\-version             Show version and copyright information
20
 \-\-user name               User name used to connect to OpenNebula
21
 \-\-password password       Password to authenticate with OpenNebula
22
 \-\-endpoint endpoint       URL of OpenNebula xmlrpc frontend
23
 \-s, \-\-size size           Number of addresses
24
 \-m, \-\-mac mac             First MAC address in : notation
25
 \-i, \-\-ip ip               First IP address in \. notation
26
 \-g, \-\-ip6_global ip6_pref IP6 global prefix
27
 \-u, \-\-ip6_ula ip6_pref    IP6 ula prefix
28
 \-\-gateway ip              IP of the gateway
29
 \-\-netmask mask            Netmask in dot notation
30
 \-\-vlan                    Use network isolation
31
 \-\-vlanid id               VLAN ID assigned
32
 \-a, \-\-address_range ar_id ID of the address range
33
 \-n, \-\-name reservation name Name of the address reservation
34
 \-l, \-\-list x,y,z          Selects columns to display with list command
35
 \-d, \-\-delay x             Sets the delay in seconds for top command
36
 \-f, \-\-filter x,y,z        Filter data\. An array is specified with
37
                           column=value pairs\.
38
 \-\-csv                     Write table in csv format
39
 \-x, \-\-xml                 Show the resource in xml format
40
 \-n, \-\-numeric             Do not translate user and group IDs
41
 \-k, \-\-kilobytes           Show units in kilobytes
42
 \-\-describe                Describe list columns
43
 \-\-show\-ar                 Show also AR templates
44
 \-a, \-\-append              Append new attributes to the current template
45
 \-v, \-\-verbose             Verbose mode
46
 \-h, \-\-help                Show this message
47
 \-V, \-\-version             Show version and copyright information
48
 \-\-user name               User name used to connect to OpenNebula
49
 \-\-password password       Password to authenticate with OpenNebula
50
 \-\-endpoint endpoint       URL of OpenNebula xmlrpc frontend
51
.
52
.fi
53
.
54
.SH "COMMANDS"
55
.
56
.IP "\(bu" 4
57
create \fIfile\fR Creates a new Virtual Network from the given template file valid options: cluster
58
.
59
.IP "\(bu" 4
60
delete \fIrange|vnetid_list\fR Deletes the given Virtual Network
61
.
62
.IP "\(bu" 4
63
addar \fIvnetid\fR [\fIfile\fR] Adds an address range to the Virtual Network valid options: verbose, help, version, user, password, endpoint, size, mac, ip, ip6_global, ip6_ula, gateway, netmask, vlan, vlanid
64
.
65
.IP "\(bu" 4
66
addleases \fIvnetid\fR \fIip\fR [\fImac\fR] (DEPRECATED, use addar) Adds a lease to the Virtual Network
67
.
68
.IP "\(bu" 4
69
rmar \fIvnetid\fR \fIar_id\fR Removes an address range from the Virtual Network
70
.
71
.IP "\(bu" 4
72
rmleases \fIvnetid\fR \fIip\fR (DEPRECATED, use rmar) Removes a lease from the Virtual Network
73
.
74
.IP "\(bu" 4
75
free \fIvnetid\fR \fIar_id\fR Frees a reserved address range from the Virtual Network
76
.
77
.IP "\(bu" 4
78
hold \fIvnetid\fR \fIip\fR Holds a Virtual Network lease, marking it as used valid options: verbose, help, version, user, password, endpoint, address_range
79
.
80
.IP "\(bu" 4
81
release \fIvnetid\fR \fIip\fR Releases a Virtual Network lease on hold valid options: verbose, help, version, user, password, endpoint, address_range
82
.
83
.IP "\(bu" 4
84
reserve \fIvnetid\fR [\fIvnetid\fR] Reserve addresses from the Virtual Network\. A new virtual network will be created to hold the reservation\. Optionally the reservation can be put on an exisiting VNET, as long as it contains a valid reservation from the same VNET valid options: verbose, help, version, user, password, endpoint, address_range, name, size, mac, ip
85
.
86
.IP "\(bu" 4
87
chgrp \fIrange|vnetid_list\fR \fIgroupid\fR Changes the Virtual Network group
88
.
89
.IP "\(bu" 4
90
chown \fIrange|vnetid_list\fR \fIuserid\fR [\fIgroupid\fR] Changes the Virtual Network owner and group
91
.
92
.IP "\(bu" 4
93
chmod \fIrange|vnetid_list\fR \fIoctet\fR Changes the Virtual Network permissions
94
.
95
.IP "\(bu" 4
96
list [\fIfilterflag\fR] Lists Virtual Networks in the pool valid options: list, delay, filter, csv, xml, numeric, kilobytes, describe
97
.
98
.IP "\(bu" 4
99
show \fIvnetid\fR Shows information for the given Virtual Network valid options: xml, show_ar
100
.
101
.IP "\(bu" 4
102
update \fIvnetid\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
103
.
104
.IP "\(bu" 4
105
updatear \fIvnetid\fR \fIar_id\fR [\fIfile\fR] Update Address Range variables\. SIZE, IP, MAC and TYPE cannot be updated
106
.
107
.IP "\(bu" 4
108
rename \fIvnetid\fR \fIname\fR Renames the Virtual Network
109
.
110
.IP "" 0
111
.
112
.SH "ARGUMENT FORMATS"
113
.
114
.IP "\(bu" 4
115
file Path to a file
116
.
117
.IP "\(bu" 4
118
range List of id\'s in the form 1,8\.\.15
119
.
120
.IP "\(bu" 4
121
text String
122
.
123
.IP "\(bu" 4
124
groupid OpenNebula GROUP name or id
125
.
126
.IP "\(bu" 4
127
userid OpenNebula USER name or id
128
.
129
.IP "\(bu" 4
130
vnetid OpenNebula VNET name or id
131
.
132
.IP "\(bu" 4
133
vnetid_list Comma\-separated list of OpenNebula VNET names or ids
134
.
135
.IP "\(bu" 4
136
filterflag a, all all the known VNETs m, mine the VNET belonging to the user in ONE_AUTH g, group \'mine\' plus the VNET belonging to the groups the user is member of uid VNET of the user identified by this uid user VNET of the user identified by the username
137
.
138
.IP "\(bu" 4
139
ar_id Integer
140
.
141
.IP "" 0
142
.
143
.SH "LICENSE"
144
OpenNebula 4\.13\.80 Copyright 2002\-2015, OpenNebula Project (OpenNebula\.org), C12G Labs
145
.
146
.P
147
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