Virtual Network template

Name

hypercloud vntemplate - manages Virtual Network Templates.

Synopsis

hypercloud vntemplate <command> [<args>] [<options>]

Options

--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
--as_gid gid              The Group ID to instantiate the VM
--as_uid uid              The User ID to instantiate the VM
--csv                     Write table in csv format
--csv-del del             Set delimiter for csv output
-d, --delay x             Sets the delay in seconds for top command
--describe                Describe list columns
--dry                     Just print the template
--endpoint endpoint       URL of HyperCloud xmlrpc frontend
--expand [x=prop,y=prop]  Expands the columns size to fill the terminal.
                            For example: $hypercloud vntemplate list --expand
                            name=0.4,group=0.6 will expand name 40% and
                            group 60%.
                            $hypercloud vntemplate list --expand name,group will
                            expand name and group based on its size. 
                            $hypercloud vntemplate list --expand will expand all columns.
--extended                Process the template and included extended
                          information
-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 every NAME containing the substring 'test')
--gateway ip              IP of the gateway
-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
-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
-m, --multiple x          Instance multiple VNs
--name name               Name of the new VN TEMPLATE. When instantiating
                          multiple VNs you can use the "%i" wildcard to
                          produce different names such as vm-0, vm-1...
--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 HyperCloud
--prefix prefix           Prefix to autogenerate name
                            e.g: 001, 01
-s, --size size           Number of addresses
--use                     lock use actions
--user name               User name used to connect to HyperCloud
-v, --verbose             Verbose mode
-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

chgrp <range|templateid_list> <groupid> Changes the Virtual Network Template group.
chmod <range|templateid_list> <octet> Changes the Virtual Network Template permissions.
chown <range|templateid_list> <userid> [<groupid>] Changes the Virtual Network Template owner and group.
clone <templateid> <name> Creates a new Virtual Network Template from an existing one.
create [<file>] Creates a new Virtual Network Template from the given description.
- Valid options: dry

Example

Using a Virtual Network Template description file:

hypercloud vntemplate create vn_description.tmpl

delete <range|templateid_list> Deletes the given Virtual Network Template.
instantiate <templateid> [<file>] Creates a new Virtual Network instance from the given Virtual Network Template. This Virtual Network can be managed with the hypercloud vnet command.
The source Template can be modified adding or replacing attributes with the optional file argument, or with the options.
- Valid options: as_gid as_uid extended gateway ip ip6 ip6_global ip6_ula mac multiple name netmask prefix size vlanid vn_mad
list [<filterflag>] Lists Virtual Network Templates in the pool.
- Valid options: adjust csv csv_del delay describe expand filter json list listconf no_expand no_header no_pager numeric operator size xml yaml
lock <range|templateid_list> Locks a Virtual Network Template to prevent certain actions defined by different levels. The show action will never 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
rename <templateid> <name> Renames the Virtual Network Template.
show <templateid> Shows information for the given Virtual Network Template
- Valid options: extended json xml yaml
top [<filterflag>] Lists Templates continuously.
- Valid options: adjust csv csv_del delay describe expand filter json list listconf no_expand no_header no_pager numeric operator size xml yaml
unlock <range|templateid_list> Unlocks a Virtual Network Template.
- Valid states are: All.
update <templateid> [<file>] Update the Virtual Network template contents. If a path is not provided the editor will be launched to modify the current content.
- Valid options: append

Argument Formats

file Path to a file.
filterflag
- a, all all the known VNTEMPLATEs
- m, mine the VNTEMPLATE belonging to the user in ONE_AUTH
- g, group 'mine' plus the VNTEMPLATE belonging to the groups the user is member of
- G, primary group the VNTEMPLATE owned by the user's primary group
- uid VNTEMPLATE of the user identified by this uid
- user VNTEMPLATE of the user identified by the username
groupid HyperCloud GROUP name or ID.
range List of ID's in the form 1,8..15.
templateid HyperCloud VNTEMPLATE name or ID.
templateid_list Comma-separated list of HyperCloud VNTEMPLATE names or IDs.
text String.
userid HyperCloud USER name or ID.

Version

HyperCloud Orchestrator 6.4.0.1