Security groups

Name

hypercloud secgroup - manages HyperCloud security groups.

Synopsis

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

Options

--adjust x,y,z            Adjust size to not truncate selected columns
-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 secgroup list --expand
                            name=0.4,group=0.6 will expand name 40% and
                            group 60%. $hypercloud secgroup list --expand name,group will
                            expand name and group based on its size. $hypercloud secgroup
                            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
--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, --recover             If set the commit operation will only operate on
                          outdated and error VMs. This is intended for
                          retrying updates of VMs or reinitialize the
                          updating process if oned stopped or fail.
-s, --size x=size,y=size  Change the size of selected columns. 
                            For example: $ hypercloud secgroup 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

• chgrp <range|secgroupid_list> <groupid> Changes the Security Group's group.

• chmod <range|secgroupid_list> <octet> Changes the Security Group permissions.

• chown <range|secgroupid_list> <userid> [<groupid>] Changes the Security Group's owner and group.

• clone <secgroupid> <name> Creates a new Security Group from an existing one.

• commit <secgroupid> Commit Security Group changes to associated VMs. This command is to propagate security group rules to VMs when they are updated. This operation takes time to iterate over all VMs in the security group, progress can be checked through the outdated, updating and error VM sets.

  • Valid options: recover

• create <file> Creates a new Security Group from the given description.

• delete <range|secgroupid_list> Deletes the given Security Group.

• list [<filterflag>] Lists Security Group 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

• rename <secgroupid> <name> Renames the Security Group.

• show <secgroupid> Shows information for the given Security Group

  • Valid options: json xml yaml

• update <secgroupid> [<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.

• filterflag

  • a, all all the known SECURITY_GROUPs
  • m, mine the SECURITY_GROUP belonging to the user in ONE_AUTH
  • g, group 'mine' plus the SECURITY_GROUP belonging to the groups the user is member of
  • G, primary group the SECURITY_GROUP owned the user's primary group
  • uid SECURITY_GROUP of the user identified by this uid
  • user SECURITY_GROUP of the user identified by the username

• groupid HyperCloud GROUP name or ID.

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

• secgroupid HyperCloud SECURITY_GROUP name or ID.

• secgroupid_list Comma-separated list of HyperCloud SECURITY_GROUP names or IDs.

• text String.

• userid HyperCloud USER name or ID.

Version

HyperCloud Orchestrator 6.4.0.1

Copyright © SoftIron