Skip to content

Cluster

Name

hypercloud cluster - manages HyperCloud clusters.

Synopsis

hypercloud cluster <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
--decrypt                 Get decrypted attributes
-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 cluster list --expand
                              name=0.4,group=0.6 will expand name 40% and
                              group 60%. $hypercloud cluster list --expand name,group will
                              expand name and group based on its size.
                              $hypercloud vm 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
-s, --size x=size,y=size  Change the size of selected columns. For example:
                              $ hypercloud cluster 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

  • adddatastore <clusterid> <datastoreid> Adds a Datastore to the given Cluster.

  • addhost <clusterid> <hostid> Adds a Host to the given Cluster.

  • addvnet <clusterid> <vnetid> Adds a Virtual Network to the given Cluster.

  • create <name> Creates a new Cluster.

  • deldatastore <clusterid> <datastoreid> Deletes a Datastore from the given Cluster.

  • delete <range|clusterid_list> Deletes the given Cluster.

  • delhost <clusterid> <hostid> Deletes a Host from the given Cluster.

  • delvnet <clusterid> <vnetid> Deletes a Virtual Network from the given Cluster.

  • list Lists Clusters 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 <clusterid> <name> Renames the Cluster.

  • show <clusterid> Shows information for the given Cluster.

    • Valid options: decrypt json xml yaml
  • update <clusterid> [<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

  • clusterid HyperCloud CLUSTER name or ID.

  • clusterid_list Comma-separated list of HyperCloud CLUSTER names or IDs.

  • datastoreid HyperCloud DATASTORE name or ID.

  • file Path to a file.

  • hostid HyperCloud HOST name or ID.

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

  • text String.

  • vnetid HyperCloud VNET name or ID.

Version

HyperCloud Orchestrator 6.4.0.1

Copyright © SoftIron