Skip to content

Marketplace appliances

Name

hypercloud marketapp - manages appliances from Marketplaces

Synopsis

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

Options

--adjust x,y,z            Adjust size to not truncate selected columns
--admin                   Lock admin actions
--all                     Lock all actions
-a, --append              Append new attributes to the current template
--csv                     Write table in csv format
--csv-del del             Set delimiter for csv output
-d, --datastore id|name   Selects the datastore
-d, --delay x             Sets the delay in seconds for top command
--describe                Describe list columns
--description description Description for the new MarketPlaceApp
--dry                     Just print the template
--endpoint endpoint       URL of HyperCloud xmlrpc frontend
--expand [x=prop,y=prop]  Expands the columns size to fill the terminal.
                            For example: $hypercloud marketapp list --expand
                            name=0.4,group=0.6 will expand name 40% and
                            group 60%. $hypercloud marketapp list --expand name,group will
                            expand name and group based on its size. $hypercloud marketapp
                            list --expand will expand all columns.
--file-datastore id|name  Selects the file datastore
-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                   Overwrite the file
-h, --help                Show this message
--image id|name           Selects the image
-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
--manage                  Lock manage actions
--market market_id        Market to import all objects
-m, --marketplace id|name Selects the marketplace
--name name               Name of the new MarketPlaceApp
--no                      Do not import/export associated VM
                          templates/images
--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 marketapp list --size "name=20" will make column
                            name size 20.
--tag tag                 DockerHub image tag (default latest)
--template template_id    Associate with VM template
--use                     Lock use actions
--user name               User name used to connect to HyperCloud
-v, --verbose             Verbose mode
-V, --version             Show version and copyright information
--vmname name             Selects the name for the new VM Template, if the
                          App contains one
-x, --xml                 Show the resource in xml format
-y, --yaml                Show the resource in YAML format
--yes                     Import associated VM templates/images

Commands

  • chgrp <range|appid_list> <groupid> Changes the marketplace app group.

  • chmod <range|appid_list> <octet> Changes the marketplace app permissions.

  • chown <range|appid_list> <userid> [<groupid>] Changes the marketplace app owner and group.

  • create [<file>] Creates a new marketplace app in the given marketplace.

    • Valid options: description dry image marketplace name
  • delete <range|appid_list> Deletes the given marketplace app.

  • disable <range|appid_list> Disables the marketplace app. A disabled marketplace app cannot be exported to a cloud.

  • download <appid> <path> Downloads a MarketApp to a file.

    • Valid options: force
  • enable <range|appid_list> Enables the marketplace app.

  • export <appid> <name> Exports the marketplace app to the HyperCloud cloud.

    • Valid options: datastore file_datastore no tag template vmname
  • list [<filterflag>] Lists marketplace apps.

    • Valid options: adjust csv csv_del delay describe expand filter json list listconf no_expand no_header no_pager numeric operator size xml yaml
  • lock <range|appid_list> Locks a marketplace app to prevent certain actions defined by different levels. The show action will never be locked.

    • Valid states are: All.
    • Levels:
      • [Use]: locks Admin, Manage and Use actions.
      • [Manage]: locks Manage and Use actions.
      • [Admin]: locks only Admin actions.
    • Valid options: admin all manage use
  • rename <appid> <name> Renames the marketplace app.

  • service-template import <service_template_id> Imports a service template into the marketplace.

    • Valid options: market no vmname yes
  • show <appid> Shows information for the given marketplace app.

    • Valid options: json xml yaml
  • unlock <range|appid_list> Unlocks a marketplace app.

    • Valid states are: All.
  • update <appid> [<file>] Update the template contents for the app. If a path is not provided the editor will be launched to modify the current content.

    • Valid options: append
  • vm import <vm_id> Imports a VM into the marketplace.

    • Valid options: market no vmname yes
  • vm-template import <vm_template_id> Imports a VM template into the marketplace.

    • Valid options: market no vmname yes

Argument Formats

  • appid HyperCloud MARKETPLACEAPP name or ID.

  • appid_list Comma-separated list of HyperCloud MARKETPLACEAPP names or IDs.

  • file Path to a file.

  • filterflag

    • a, all all the known MARKETPLACEAPPs
    • m, mine the MARKETPLACEAPP belonging to the user in ONE_AUTH
    • g, group 'mine' plus the MARKETPLACEAPP belonging to the groups the user is member of
    • G, primary group the MARKETPLACEAPP owned the user's primary group
    • uid MARKETPLACEAPP of the user identified by this uid
    • user MARKETPLACEAPP of the user identified by the username
  • groupid HyperCloud GROUP name or ID.

  • range List of IDs in the form 1,8..15.

  • text String.

  • userid HyperCloud USER name or ID.

Version

HyperCloud Orchestrator 6.4.0.1

Copyright © SoftIron