2011-07-14 18:33:54 +02:00
. \" generated with Ronn/v0.7.3
. \" http://github.com/rtomayko/ronn/tree/0.7.3
.
2017-06-27 15:54:34 +02:00
.TH "ONEVNET" "1" "June 2017" "" "onevnet(1) -- manages OpenNebula networks"
2011-07-14 18:33:54 +02:00
.
.SH "NAME"
2015-08-17 15:09:19 +02:00
\fB onevnet\fR \- manages OpenNebula networks
2011-07-14 18:33:54 +02:00
.
.SH "SYNOPSIS"
\fB onevnet\fR \fI command\fR [\fI args\fR ] [\fI options\fR ]
.
.SH "OPTIONS"
.
.nf
2012-03-29 13:02:25 +02:00
\- c, \- \- cluster id|name Selects the cluster
2014-07-14 10:20:57 +02:00
\- 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
2014-07-29 11:34:25 +02:00
\- s, \- \- size size Number of addresses
\- m, \- \- mac mac First MAC address in : notation
\- i, \- \- ip ip First IP address in \. notation
2017-05-25 16:07:35 +02:00
\- 6, \- \- ip6 ip6 First IPv6 address, in CIDR notation e\. g\.
2001::1/48
2014-07-29 11:34:25 +02:00
\- g, \- \- ip6_global ip6_pref IP6 global prefix
\- u, \- \- ip6_ula ip6_pref IP6 ula prefix
2014-10-13 12:50:25 +02:00
\- \- gateway ip IP of the gateway
\- \- netmask mask Netmask in dot notation
2016-05-11 10:44:46 +02:00
\- \- vn_mad mad Use this driver for the network
2014-10-13 12:50:25 +02:00
\- \- vlanid id VLAN ID assigned
2014-07-14 10:20:57 +02:00
\- a, \- \- address_range ar_id ID of the address range
\- n, \- \- name reservation name Name of the address reservation
2011-07-14 18:33:54 +02:00
\- l, \- \- list x,y,z Selects columns to display with list command
2016-09-14 17:29:22 +02:00
\- c, \- \- listconf conf Selects a predefined column list
2011-07-14 18:33:54 +02:00
\- d, \- \- delay x Sets the delay in seconds for top command
2013-01-24 16:18:30 +01:00
\- f, \- \- filter x,y,z Filter data\. An array is specified with
column=value pairs\.
2014-03-07 19:14:31 +01:00
\- \- csv Write table in csv format
2011-09-12 13:00:47 +02:00
\- x, \- \- xml Show the resource in xml format
2011-07-14 18:33:54 +02:00
\- n, \- \- numeric Do not translate user and group IDs
\- k, \- \- kilobytes Show units in kilobytes
2012-10-04 11:58:17 +02:00
\- \- describe Describe list columns
2014-10-29 17:44:48 +01:00
\- \- show\- ar Show also AR templates
2013-08-06 07:42:57 -04:00
\- a, \- \- append Append new attributes to the current template
2011-07-14 18:33:54 +02:00
\- v, \- \- verbose Verbose mode
\- h, \- \- help Show this message
\- V, \- \- version Show version and copyright information
2013-01-24 16:18:30 +01:00
\- \- user name User name used to connect to OpenNebula
\- \- password password Password to authenticate with OpenNebula
\- \- endpoint endpoint URL of OpenNebula xmlrpc frontend
2011-07-14 18:33:54 +02:00
.
.fi
.
.SH "COMMANDS"
.
.IP "\(bu" 4
2013-03-25 12:39:05 +01:00
create \fI file\fR Creates a new Virtual Network from the given template file valid options: cluster
2011-07-14 18:33:54 +02:00
.
.IP "\(bu" 4
2013-03-25 12:39:05 +01:00
delete \fI range|vnetid_list\fR Deletes the given Virtual Network
2011-07-14 18:33:54 +02:00
.
.IP "\(bu" 4
2017-05-25 16:07:35 +02:00
addar \fI vnetid\fR [\fI file\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
2014-07-14 10:20:57 +02:00
.
.IP "\(bu" 4
2014-07-29 11:34:25 +02:00
addleases \fI vnetid\fR \fI ip\fR [\fI mac\fR ] (DEPRECATED, use addar) Adds a lease to the Virtual Network
.
.IP "\(bu" 4
2014-07-14 10:20:57 +02:00
rmar \fI vnetid\fR \fI ar_id\fR Removes an address range from the Virtual Network
.
.IP "\(bu" 4
2014-07-29 11:34:25 +02:00
rmleases \fI vnetid\fR \fI ip\fR (DEPRECATED, use rmar) Removes a lease from the Virtual Network
.
.IP "\(bu" 4
2014-07-14 10:20:57 +02:00
free \fI vnetid\fR \fI ar_id\fR Frees a reserved address range from the Virtual Network
2011-07-14 18:33:54 +02:00
.
.IP "\(bu" 4
2014-07-29 11:34:25 +02:00
hold \fI vnetid\fR \fI ip\fR Holds a Virtual Network lease, marking it as used valid options: verbose, help, version, user, password, endpoint, address_range
2011-12-05 17:56:34 +01:00
.
.IP "\(bu" 4
2014-07-29 11:34:25 +02:00
release \fI vnetid\fR \fI ip\fR Releases a Virtual Network lease on hold valid options: verbose, help, version, user, password, endpoint, address_range
2011-12-05 17:56:34 +01:00
.
.IP "\(bu" 4
2017-05-25 16:07:35 +02:00
reserve \fI vnetid\fR [\fI vnetid\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
2011-07-14 18:33:54 +02:00
.
.IP "\(bu" 4
2013-03-25 12:39:05 +01:00
chgrp \fI range|vnetid_list\fR \fI groupid\fR Changes the Virtual Network group
2011-07-14 18:33:54 +02:00
.
.IP "\(bu" 4
2013-03-25 12:39:05 +01:00
chown \fI range|vnetid_list\fR \fI userid\fR [\fI groupid\fR ] Changes the Virtual Network owner and group
2012-01-12 12:29:18 +01:00
.
.IP "\(bu" 4
2013-03-25 12:39:05 +01:00
chmod \fI range|vnetid_list\fR \fI octet\fR Changes the Virtual Network permissions
2011-07-14 18:33:54 +02:00
.
.IP "\(bu" 4
2016-09-14 17:29:22 +02:00
list [\fI filterflag\fR ] Lists Virtual Networks in the pool valid options: list, listconf, delay, filter, csv, xml, numeric, kilobytes, describe
2011-07-14 18:33:54 +02:00
.
.IP "\(bu" 4
2014-10-29 17:44:48 +01:00
show \fI vnetid\fR Shows information for the given Virtual Network valid options: xml, show_ar
2011-12-05 17:56:34 +01:00
.
.IP "\(bu" 4
2013-08-06 07:42:57 -04:00
update \fI vnetid\fR [\fI file\fR ] Update the template contents\. If a path is not provided the editor will be launched to modify the current content\. valid options: append
2013-01-24 16:18:30 +01:00
.
.IP "\(bu" 4
2014-07-14 10:20:57 +02:00
updatear \fI vnetid\fR \fI ar_id\fR [\fI file\fR ] Update Address Range variables\. SIZE, IP, MAC and TYPE cannot be updated
.
.IP "\(bu" 4
2013-03-25 12:39:05 +01:00
rename \fI vnetid\fR \fI name\fR Renames the Virtual Network
2011-07-14 18:33:54 +02:00
.
.IP "" 0
.
.SH "ARGUMENT FORMATS"
.
.IP "\(bu" 4
2013-03-25 12:39:05 +01:00
file Path to a file
2011-07-14 18:33:54 +02:00
.
.IP "\(bu" 4
2013-03-25 12:39:05 +01:00
range List of id\' s in the form 1,8\. \. 15
2011-07-14 18:33:54 +02:00
.
.IP "\(bu" 4
2013-03-25 12:39:05 +01:00
text String
2011-07-14 18:33:54 +02:00
.
.IP "\(bu" 4
2013-03-25 12:39:05 +01:00
groupid OpenNebula GROUP name or id
2011-07-14 18:33:54 +02:00
.
.IP "\(bu" 4
2013-03-25 12:39:05 +01:00
userid OpenNebula USER name or id
2011-07-14 18:33:54 +02:00
.
.IP "\(bu" 4
2013-03-25 12:39:05 +01:00
vnetid OpenNebula VNET name or id
2011-07-14 18:33:54 +02:00
.
.IP "\(bu" 4
2013-03-25 12:39:05 +01:00
vnetid_list Comma\- separated list of OpenNebula VNET names or ids
2011-07-14 18:33:54 +02:00
.
.IP "\(bu" 4
2017-05-25 16:07:35 +02:00
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
2011-07-14 18:33:54 +02:00
.
2014-07-14 10:20:57 +02:00
.IP "\(bu" 4
ar_id Integer
.
2011-07-14 18:33:54 +02:00
.IP "" 0
.
.SH "LICENSE"
2017-06-27 15:54:34 +02:00
OpenNebula 5\. 3\. 85 Copyright 2002\- 2017, OpenNebula Project, OpenNebula Systems
2011-07-14 18:33:54 +02:00
.
.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