onevnet(1)

ONEVNET(1)

onevnet(1) -- manages OpenNebula networks

ONEVNET(1)

NAME

onevnet - manages OpenNebula networks

SYNOPSIS

onevnet command [args] [options]

OPTIONS



 -a, --address_range ar_id ID of the address range


 --adjust x,y,z            Adjust size to not truncate selected columns


 --admin                   lock admin actions


 --all                     lock all actions


 -a, --append              Append new attributes to the current template


 -c, --cluster id|name     Selects the cluster


 --csv                     Write table in csv format


 --csv-del del             Set delimiter for csv output


 --decrypt                 Get decrypted attributes


 -d, --delay x             Sets the delay in seconds for top command


 --describe                Describe list columns


 --endpoint endpoint       URL of OpenNebula xmlrpc frontend


 --endpoint endpoint       URL of OpenNebula xmlrpc frontend


 --expand [x=prop,y=prop]  Expands the columns size to fill the terminal.


                           For example: $onevm list --expand


                           name=0.4,group=0.6 will expand name 40% and


                           group 60%. $onevm list --expand name,group will


                           expand name and group based on its size.$onevm


                           list --expand will expand all columns.


 --extended                Show info extended (it only works with xml


                           output)


 -f, --filter x,y,z        Filter data. An array is specified with


                           column=value pairs. Valid operators


                           =,!=,<,<=,>,>=,~ e.g. NAME=test (match name with


                           test) NAME~test (match test, te, tes..)


 --force                   Force execution of action, bypass the consistency


                           checks


 --gateway ip              IP of the gateway


 -h, --help                Show this message


 -h, --help                Show this message


 -i, --ip ip               First IP address in . notation


 -6, --ip6 ip6             First IPv6 address, in CIDR notation e.g.


                           2001::1/48


 -g, --ip6_global ip6_pref IP6 global prefix


 -u, --ip6_ula ip6_pref    IP6 ula prefix


 -j, --json                Show the resource in JSON format


 -k, --kilobytes           Show units in kilobytes


 -l, --list x,y,z          Selects columns to display with list command


 -c, --listconf conf       Selects a predefined column list


 -m, --mac mac             First MAC address in : notation


 --manage                  lock manage actions


 -n, --name reservation name Name of the address reservation


 --netmask mask            Netmask in dot notation


 --no-expand               Disable expand


 --no-header               Hides the header of the table


 --no-pager                Disable pagination


 -n, --numeric             Do not translate user and group IDs


 --operator operator       Logical operator used on filters: AND, OR.


                           Default: AND.


 --password password       Password to authenticate with OpenNebula


 --password password       Password to authenticate with OpenNebula


 --show-ar                 Show also AR templates


 -s, --size size           Number of addresses


 --use                     lock use actions


 --user name               User name used to connect to OpenNebula


 --user name               User name used to connect to OpenNebula


 -v, --verbose             Verbose mode


 -v, --verbose             Verbose mode


 -V, --version             Show version and copyright information


 -V, --version             Show version and copyright information


 --vlanid id               VLAN ID assigned


 --vn_mad mad              Use this driver for the network


 -x, --xml                 Show the resource in xml format


 -y, --yaml                Show the resource in YAML format

COMMANDS

○: addar vnetid [file] Adds an address range to the Virtual Network valid options: endpoint, gateway, help, ip, ip6, ip6_global, ip6_ula, mac, netmask, password, size, user, verbose, version, vlanid, vn_mad
○: addleases vnetid ip [mac] (DEPRECATED, use addar) Adds a lease to the Virtual Network
○: chgrp range|vnetid_list groupid Changes the Virtual Network group
○: chmod range|vnetid_list octet Changes the Virtual Network permissions
○: chown range|vnetid_list userid [groupid] Changes the Virtual Network owner and group
○: create file Creates a new Virtual Network from the given template file valid options: cluster
○: delete range|vnetid_list Deletes the given Virtual Network
○: free vnetid ar_id Frees a reserved address range from the Virtual Network
○: hold vnetid ip Holds a Virtual Network lease, marking it as used valid options: address_range, endpoint, help, password, user, verbose, version
○: list [filterflag] Lists Virtual Networks in the pool valid options: adjust, csv, csv_del, delay, describe, expand, extended, filter, json, kilobytes, list, listconf, no_expand, no_header, no_pager, numeric, operator, size, xml, yaml
○: lock range|vnetid_list Locks a VM with differents levels for lock any actions with this VM, show and monitoring never will be locked. Valid states are: All. Levels: [Use]: locks Admin, Manage and Use actions. [Manage]: locks Manage and Use actions. [Admin]: locks only Admin actions. valid options: admin, all, manage, use
○: orphans Shows orphans vnets (i.e vnets not referenced in any template).
○: release vnetid ip Releases a Virtual Network lease on hold valid options: address_range, endpoint, help, password, user, verbose, version
○: rename vnetid name Renames the Virtual Network
○: reserve vnetid [vnetid] 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: address_range, endpoint, help, ip, ip6, mac, name, password, size, user, verbose, version
○: rmar vnetid ar_id Removes an address range from the Virtual Network valid options: force
○: rmleases vnetid ip (DEPRECATED, use rmar) Removes a lease from the Virtual Network
○: show vnetid Shows information for the given Virtual Network valid options: decrypt, json, show_ar, xml, yaml
○: unlock range|vnetid_list Unlocks a VM for unlock any actions with this VM. Valid states are: All.
○: update vnetid [file] Update the template contents. If a path is not provided the editor will be launched to modify the current content. valid options: append
○: updatear vnetid ar_id [file] Update Address Range variables. SIZE, IP, MAC and TYPE cannot be updated valid options: append

ARGUMENT FORMATS

○: ar_id Integer
○: file Path to a file
○: 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
○: groupid OpenNebula GROUP name or id
○: range List of id´s in the form 1,8..15
○: text String
○: userid OpenNebula USER name or id
○: vnetid OpenNebula VNET name or id
○: vnetid_list Comma-separated list of OpenNebula VNET names or ids

VERSION

July 2025