Skip to content

Zone

Name

hypercloud zone - manages HyperCloud zones.

Synopsis

hypercloud zone <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
--db                      Also sync database
-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 vm 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.
-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
-k, --keep                Don't overwrite endpoint file located in home
                              folder, use it as a temporary zone.
-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
-n, --name                Zone server name
-r, --rpc                 Zone server RPC endpoint
-s, --size x=size,y=size  Change the size of selected columns. For example:
                              $ onevm 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 <file> Creates a new Zone.

  • delete <range|zoneid_list> Deletes the given Zone.

  • disable <range|zoneid_list> Disable zone, disabled zones can execute only read-only commands.

  • enable <range|zoneid_list> Enable zone.

  • list Lists Zones 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 <zoneid> <name> Renames the Zone.

  • server-add <zoneid> Add an HyperCloud server to this zone.

    • Valid options: server_name server_rpc

  • server-del <zoneid> <serverid> Delete an HyperCloud server from this zone.

  • server-reset <zoneid> <serverid> Reset follower log index. This should be trigger when a follower DB has been reset.

  • serversync <server> Syncs configuration files and folders from another server.

    • Valid options: db

This command must be executed under root.

  • set <zoneid> Set shell session access point for the CLI to the given Zone.

    • Valid options: keep

  • show <zoneid> Shows information for the given Zone.

    • Valid options: json xml yaml

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

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

  • text String.

  • zoneid HyperCloud ZONE name or ID.

  • zoneid_list Comma-separated list of HyperCloud ZONE names or IDs.

Version

HyperCloud Orchestrator 6.4.0.1

Copyright © SoftIron