apps

apps template create

Usage

  usage: symp apps template create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent] [--prefix PREFIX]
                                   [-m [NAME=VALUE [NAME=VALUE ...]]]
                                   [--description DESCRIPTION]
                                   [--category CATEGORY] [--author AUTHOR]
                                   [--visibility VISIBILITY]
                                   [--user-data USER_DATA]
                                   [--exposed-ports [EXPOSED_PORTS [EXPOSED_PORTS ...]]]
                                   [--instance-type INSTANCE_TYPE]
                                   [--instance-metadata INSTANCE_METADATA]
                                   [--instance-params [INSTANCE_PARAMS [INSTANCE_PARAMS ...]]]
                                   [--project-id PROJECT_ID]
                                   name image_id

Description

Create a new application template.

Returns

Returns dict: The new template dict

Mandatory

positional arguments:
  name                  A name for the new template
  image_id              Image ID for the template

Optional

optional arguments:
  -h, --help            show this help message and exit
  --description DESCRIPTION
                        A description for the new template
  --category CATEGORY   The application template's category
  --author AUTHOR       The author of the template
  --visibility VISIBILITY
                        Who can see the new application template.
                        Options are "public", "account" or the default - "private"
  --user-data USER_DATA
                        A user data to add to new instances of this template
  --exposed-ports [EXPOSED_PORTS [EXPOSED_PORTS ...]]
                        A list of ports from which new instances will be accessible
  --instance-type INSTANCE_TYPE
                        The name of the instance type for instances of this template
  --instance-metadata INSTANCE_METADATA
                        Constant metadata for new instances of this template
  --instance-params [INSTANCE_PARAMS [INSTANCE_PARAMS ...]]
                        Parameters to get from the user when instantiating the template
  --project-id PROJECT_ID
                        Project in which to create the template
                        Defaults to token's project

apps template delete

Usage

  usage: symp apps template delete
[-f {adaptive_table,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent] [--prefix PREFIX]
                                   [-m [NAME=VALUE [NAME=VALUE ...]]]
                                   template_id

Description

Delete an existing template.

Mandatory

positional arguments:
  template_id           The id of the template to delete

Optional

optional arguments:
  -h, --help            show this help message and exit

apps template download-license

Usage

  usage: symp apps template download-license
[-f {adaptive_table,json,shell,table,value,yaml}]
                                             [-c COLUMN] [--max-width <integer>]
                                             [--noindent] [--prefix PREFIX]
                                             [-m [NAME=VALUE [NAME=VALUE ...]]]
                                             template_id

Description

Get an application template’s license.

Returns

Returns str: A stream of the template’s license

Mandatory

positional arguments:
  template_id           The template to get the license of

Optional

optional arguments:
  -h, --help            show this help message and exit

apps template get

Usage

  usage: symp apps template get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>] [--noindent]
                                [--prefix PREFIX]
                                [-m [NAME=VALUE [NAME=VALUE ...]]]
                                [--include-instances]
                                template_id

Description

Get details of a specific template.

Returns

Returns dict: The template’s attributes and metadata

Mandatory

positional arguments:
  template_id           The id of the template to show

Optional

optional arguments:
  -h, --help            show this help message and exit
  --include-instances   Wether to include the instance IDs in the response

apps template launch

Usage

  usage: symp apps template launch
[-f {adaptive_table,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent] [--prefix PREFIX]
                                   [-m [NAME=VALUE [NAME=VALUE ...]]]
                                   [--storage-pool-id STORAGE_POOL_ID]
                                   [--elastic-ip ELASTIC_IP]
                                   [--tags [TAGS [TAGS ...]]]
                                   [--template-params TEMPLATE_PARAMS]
                                   [--instance-type INSTANCE_TYPE]
                                   [--key-pair KEY_PAIR]
                                   [--security-groups [SECURITY_GROUPS [SECURITY_GROUPS ...]]]
                                   [--project-id PROJECT_ID]
                                   template_id name network_id

Description

Launch a new application instance.

Returns

Returns dict: The new instance details

Mandatory

positional arguments:
  template_id           The UUID of the template from which to create this instance
  name                  A name for the instance
  network_id            The UUID of the network to which this instance should be attached

Optional

optional arguments:
  -h, --help            show this help message and exit
  --storage-pool-id STORAGE_POOL_ID
                        (Optional) The id of the storage pool on which to create the boot volume
  --elastic-ip ELASTIC_IP
                        (Optional) The UUID of the elastic IP to attach to the instance
  --tags [TAGS [TAGS ...]]
                        (Optional) List of tags to attach to the instance
  --template-params TEMPLATE_PARAMS
                        (Optional) The template's instance params, as filled by the user, to set the instance's configuration
  --instance-type INSTANCE_TYPE
                        (Optional) The name of the instance type of the instance
                        This overrides the instance type set by the template
  --key-pair KEY_PAIR   (Optional) The name of a key pair to attach to the instance
  --security-groups [SECURITY_GROUPS [SECURITY_GROUPS ...]]
                        (Optional) List of ids of security groups to set for the instnace
                        This will override the security groups automatically created by the template
  --project-id PROJECT_ID
                        (Optional) Project ID in which the instance will be created
                        Usable only by the system admin or by tenant admins
                        Defaults to the token's project

apps template list

Usage

  usage: symp apps template list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--noindent]
                                 [--quote {all,minimal,none,nonnumeric}]
                                 [-m [NAME=VALUE [NAME=VALUE ...]]]
                                 [--include-instances]

Description

List the available application templates.

Returns

Returns list: List of available application templates

Optional

optional arguments:
  -h, --help            show this help message and exit
  --include-instances   Wether to include the instance IDs in the response

apps template list-instances

Usage

  usage: symp apps template list-instances
[-f {adaptive_table,csv,json,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent]
                                           [--quote {all,minimal,none,nonnumeric}]
                                           [-m [NAME=VALUE [NAME=VALUE ...]]]
                                           [--show-all]
                                           template_id

Description

Get the list of application instances.

Returns

Returns list: Application instances in the system

Mandatory

positional arguments:
  template_id           The id of the template from which the instances were created

Optional

optional arguments:
  -h, --help            show this help message and exit
  --show-all            Wether to show instances that don't exist in vm-manager
                        Usable only by system admin

apps template remove-license

Usage

  usage: symp apps template remove-license
[-f {adaptive_table,json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent] [--prefix PREFIX]
                                           [-m [NAME=VALUE [NAME=VALUE ...]]]
                                           template_id

Description

Remove an application template’s license.

Mandatory

positional arguments:
  template_id           Template to remove the license of

Optional

optional arguments:
  -h, --help            show this help message and exit

apps template update

Usage

  usage: symp apps template update
[-f {adaptive_table,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--noindent] [--prefix PREFIX]
                                   [-m [NAME=VALUE [NAME=VALUE ...]]]
                                   [--image-id IMAGE_ID] [--name NAME]
                                   [--description DESCRIPTION]
                                   [--category CATEGORY] [--author AUTHOR]
                                   [--visibility VISIBILITY]
                                   [--user-data USER_DATA]
                                   [--exposed-ports [EXPOSED_PORTS [EXPOSED_PORTS ...]]]
                                   [--instance-type INSTANCE_TYPE]
                                   [--instance-metadata INSTANCE_METADATA]
                                   [--instance-params [INSTANCE_PARAMS [INSTANCE_PARAMS ...]]]
                                   template_id

Description

Updates an application template.

Returns

Returns dict: The updated template dict

Mandatory

positional arguments:
  template_id           The id of the template to update

Optional

optional arguments:
  -h, --help            show this help message and exit
  --image-id IMAGE_ID   Image ID for the template
  --name NAME           A name for the template
  --description DESCRIPTION
                        A description for the template
  --category CATEGORY   The application template's category
  --author AUTHOR       The author of the template
  --visibility VISIBILITY
                        Who can see the new application template.
                        Options are "public", "account" or the default - "private"
  --user-data USER_DATA
                        A user data to add to new instances of this template
  --exposed-ports [EXPOSED_PORTS [EXPOSED_PORTS ...]]
                        A list of ports from which new instances will be accessible
  --instance-type INSTANCE_TYPE
                        The name of the instance type for instances of this template
  --instance-metadata INSTANCE_METADATA
                        Constant metadata for new instances of this template
  --instance-params [INSTANCE_PARAMS [INSTANCE_PARAMS ...]]
                        Parameters to get from the user when instantiating the template

apps template upload-license

Usage

  usage: symp apps template upload-license
[-f {adaptive_table,json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--noindent] [--prefix PREFIX]
                                           [-m [NAME=VALUE [NAME=VALUE ...]]]
                                           file template_id

Description

Upload a new license for an application template.

Mandatory

positional arguments:
  file
  template_id           Application template to set the license to

Optional

optional arguments:
  -h, --help            show this help message and exit