Skip to content

Group

Name

hypercloud group - manages HyperCloud groups

Synopsis

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

Options

--adjust x,y,z            Adjust size to not truncate selected columns
-d, --admin_driver driver Auth driver for the admin user of the group
-p, --admin_password pass Password for the admin user of the group
-u, --admin_user name     Creates an admin user for the group with name
-a, --append              Append new attributes to the current template
--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
--endpoint endpoint       URL of HyperCloud xmlrpc frontend
--expand [x=prop,y=prop]  Expands the columns size to fill the terminal.
                        For example: $hypercloud group list --expand
                        name=0.4,group=0.6 will expand name 40% and
                        group 60%. $hypercloud group list --expand name,group will
                        expand name and group based on its size.  $hypercloud group
                        list --expand will expand all columns.
-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')
-h, --help                Show this message
-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
-n, --name name           Name for the new group
--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
-r, --resources res_str   Which resources can be created by group users
                        (VM+NET+IMAGE+TEMPLATE by default)
-s, --size x=size,y=size  Change the size of selected columns. For example:
                        $ hypercloud group list --size "name=20" will make column
                        name size 20.
--user name               User name used to connect to HyperCloud
-v, --verbose             Verbose mode
-V, --version             Show version and copyright information
-x, --xml                 Show the resource in xml format
-y, --yaml                Show the resource in YAML format

Commands

create [<group_name/>] Creates a new Group. A group name can be passed as the only argument, or via command line arguments.

Example

Create a group with an admin user and allow group users to only create new templates and VMs.

hypercloud group create --name groupA
                        --admin_user admin_userA --admin_password somestr
                        --resources TEMPLATE+VM

  • Valid options: admin_driver admin_password admin_user name resources

  • defaultquota [<file>] Sets the default quota limits for the groups. If a path is not provided the editor will be launched to modify the current default quotas.

  • deladmin <range|groupid_list> <userid> Removes a User from the Group administrators set.

  • delete <range|groupid_list> Deletes the given Group.

  • list Lists Groups 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

  • quota <groupid> [<file>] Set the quota limits for the group. If a path is not provided the editor will be launched to modify the current quotas.

  • show [<groupid>] Shows information for the given Group

    • Valid options: json xml yaml

  • update <groupid> [<file>] Update the 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.

  • groupid HyperCloud GROUP name or ID.

  • groupid_list Comma-separated list of HyperCloud GROUP names or IDs.

  • range List of ID's in the form 1,8..15.

  • text String.

  • userid HyperCloud USER name or ID.

Version

HyperCloud Orchestrator 6.4.0.1

Copyright © SoftIron