Skip to content

Host

Name

hypercloud host - manages HyperCloud hosts.

Synopsis

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

Options

--adjust x,y,z            Adjust size to not truncate selected columns
-a, --append              Append new attributes to the current template
-c, --cluster id|name     Selects the cluster
--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
--end date                End date to show data
--endpoint endpoint       URL of HyperCloud xmlrpc frontend
--expand [x=prop,y=prop]  Expands the columns size to fill the terminal.
                              For example: $hypercloud host list --expand
                              name=0.4,group=0.6 will expand name 40% and
                              group 60%. $hypercloud host list --expand name,group will
                              expand name and group based on its size. $hypercloud host
                              list --expand will expand all columns.
--extended                Show info extended (it only works with xml
                              output)
-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')
--force                   Force probe upgrade in hypercloud host sync
-h, --help                Show this message
-i, --im im_mad           Set the information driver for the host
--ipv4 ip1,ip2            Comma separated IPV4 to set
--ipv6 ip1,ip2            Comma separated IPV6 to set
-j, --json                Show the resource in JSON format
-k, --kilobytes           Show units in kilobytes
-l, --list x,y,z          Selects columns to display with list command
-c, --listconf conf       Selects a predefined column list
--n elements              Number of records to show
--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 host list --size "name=20" will make column
                              name size 20.
--ssh                     Use SSH to synchronize remotes. In case some
                              probes are no longer in the fronted they will be
                              deleted in the hosts.
--start date              Start date to show data
--table                   Show monitoring information in table format
-t, --type remote_provider Use type to create a host using Cloud Bursting
--unit unit               Unit to format data
--user name               User name used to connect to HyperCloud
-V, --version             Show version and copyright information
-v, --vm vmm_mad          Set the virtualization driver for the host
-x, --xml                 Show the resource in xml format
-y, --yaml                Show the resource in YAML format

Commands

  • create <hostname> [<file>] Creates a new Host.

    • Valid options: cluster im type vm

  • delete <range|hostid_list> Deletes the given Host.

  • disable <range|hostid_list> Disables the given host:

    • monitor: enabled
    • scheduler deployment: disabled
    • manual deployment: enabled

  • enable <range|hostid_list> Enables the given host, fully operational.

  • flush <range|hostid_list> Disables the host and reschedules all the running VMs in it.

  • forceupdate [<range|hostid_list>] Forces host monitoring update.

    • Valid options: cluster

Examples

Force updates: 

hypercloud host forceupdate host01 
hypercloud host forceupdate host01,host02,host03 
hypercloud host forceupdate -c myCluster

  • importvm <hostid> <name> Import VM to HyperCloud.

    • Valid options: ipv4 ipv6

  • list Lists Hosts in the pool

    • Valid options: adjust csv csv_del delay describe expand extended filter json kilobytes list listconf no_expand no_header no_pager numeric operator size xml yaml

  • monitoring <hostid> <attr> Show monitoring metrics in a graphic

    • Valid options: csv end n_elems start table unit

  • offline <range|hostid_list> Sets the host offline:

    • monitor: disabled
    • scheduler deployment: disabled
    • manual deployment: disabled

  • rename <hostid> <name> Renames the Host.

  • show <hostid> Shows information for the given Host

    • Valid options: decrypt json xml yaml

  • sync [<range|hostid_list>] Synchronizes probes in /var/lib/one/remotes ($ONE\_LOCATION/var/remotes in self-contained installations) with Hosts.

    • Valid options: cluster force ssh

Examples

hypercloud host sync
hypercloud host sync -c myCluster
hypercloud host sync host01,host02,host03

  • top Lists Hosts continuously.

    • Valid options: adjust, csv, csv_del, delay, expand, extended, filter, json kilobytes list listconf no_expand no_header no_pager numeric operator size xml yaml

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

  • hostid HyperCloud HOST name or ID.

  • hostid_list Comma-separated list of HyperCloud HOST names or IDs.

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

  • text String.

Version

HyperCloud Orchestrator 6.4.0.1

Copyright © SoftIron