Statistics
| Branch: | Tag: | Revision:

one / share / man / onevnet.1 @ 05241124

History | View | Annotate | Download (6.04 KB)

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