.\" Man page generated from reStructuredText.
.
.TH "PYTHON-MURANOCLIENT" "1" "Aug 22, 2018" "" "python-muranoclient"
.SH NAME
python-muranoclient \- python-muranoclient 
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.sp
This is a client for the OpenStack Application Catalog API.
There\(aqs a Python API (the \fBmuranoclient\fP
module) and a command\-line script
(installed as \fBmurano\fP).
.SH MURANO API CLIENT
.sp
In order to use the python api directly, you must first obtain an auth token
and identify which endpoint you wish to speak to. Once you have done so,
you can use the API like so:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
>>> from muranoclient import Client
>>> murano = Client(\(aq1\(aq, endpoint=MURANO_URL, token=OS_AUTH_TOKEN)
\&...
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Command\-line Tool
.sp
In order to use the CLI, you must provide your OpenStack username,
password, tenant, and auth endpoint. Use the corresponding configuration
options (:option:\fB\-\-os\-username\fP, :option:\fB\-\-os\-password\fP,
:option:\fB\-\-os\-tenant\-id\fP, and :option:\fB\-\-os\-auth\-url\fP) or
set them in environment variables:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
export OS_USERNAME=user
export OS_PASSWORD=pass
export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b
export OS_AUTH_URL=http://auth.example.com:5000/v2.0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The command line tool will attempt to reauthenticate using your provided
credentials for every request. You can override this behavior by manually
supplying an auth token using :option:\fB\-\-os\-image\-url\fP and
:option:\fB\-\-os\-auth\-token\fP\&. You can alternatively set these environment
variables:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
export MURANO_URL=http://murano.example.org:8082/
export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Once you\(aqve configured your authentication parameters, you can run
\fBmurano help\fP to see a complete listing of available commands.
.SS Application Catalog service (murano) command\-line client
.sp
The murano client is the command\-line interface (CLI) for
the Application Catalog service (murano) API and its extensions.
.sp
This chapter documents \fBmurano\fP version \fB0.13.0\fP\&.
.sp
For help on a specific \fBmurano\fP command, enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ murano help COMMAND
.ft P
.fi
.UNINDENT
.UNINDENT
.SS murano usage
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano [\-\-version] [\-d] [\-v] [\-\-cert\-file OS_CERT] [\-\-key\-file OS_KEY]
              [\-\-ca\-file OS_CACERT] [\-\-api\-timeout API_TIMEOUT]
              [\-\-os\-tenant\-id OS_TENANT_ID] [\-\-os\-tenant\-name OS_TENANT_NAME]
              [\-\-os\-region\-name OS_REGION_NAME]
              [\-\-os\-auth\-token OS_AUTH_TOKEN] [\-\-os\-no\-client\-auth]
              [\-\-murano\-url MURANO_URL] [\-\-glance\-url GLANCE_URL]
              [\-\-glare\-url GLARE_URL]
              [\-\-murano\-api\-version MURANO_API_VERSION]
              [\-\-os\-service\-type OS_SERVICE_TYPE]
              [\-\-os\-endpoint\-type OS_ENDPOINT_TYPE] [\-\-include\-password]
              [\-\-murano\-repo\-url MURANO_REPO_URL]
              [\-\-murano\-packages\-service {murano,glance,glare}] [\-\-insecure]
              [\-\-os\-cacert <ca\-certificate>] [\-\-os\-cert <certificate>]
              [\-\-os\-key <key>] [\-\-timeout <seconds>]
              [\-\-os\-auth\-url OS_AUTH_URL] [\-\-os\-domain\-id OS_DOMAIN_ID]
              [\-\-os\-domain\-name OS_DOMAIN_NAME]
              [\-\-os\-project\-id OS_PROJECT_ID]
              [\-\-os\-project\-name OS_PROJECT_NAME]
              [\-\-os\-project\-domain\-id OS_PROJECT_DOMAIN_ID]
              [\-\-os\-project\-domain\-name OS_PROJECT_DOMAIN_NAME]
              [\-\-os\-trust\-id OS_TRUST_ID] [\-\-os\-user\-id OS_USER_ID]
              [\-\-os\-username OS_USERNAME]
              [\-\-os\-user\-domain\-id OS_USER_DOMAIN_ID]
              [\-\-os\-user\-domain\-name OS_USER_DOMAIN_NAME]
              [\-\-os\-password OS_PASSWORD]
              <subcommand> ...
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBSubcommands:\fP
.INDENT 0.0
.TP
.B \fBapp\-show\fP
List applications, added to specified environment.
.TP
.B \fBbundle\-import\fP
Import a bundle.
.TP
.B \fBbundle\-save\fP
Save a bundle.
.TP
.B \fBcategory\-create\fP
Create a category.
.TP
.B \fBcategory\-delete\fP
Delete a category.
.TP
.B \fBcategory\-list\fP
List all available categories.
.TP
.B \fBcategory\-show\fP
Display category details.
.TP
.B \fBclass\-schema\fP
Display class schema
.TP
.B \fBdeployment\-list\fP
List deployments for an environment or multiple
environments.
.TP
.B \fBenv\-template\-add\-app\fP
Add application to the environment template.
.TP
.B \fBenv\-template\-clone\fP
Create a new template, cloned from template.
.TP
.B \fBenv\-template\-create\fP
Create an environment template.
.TP
.B \fBenv\-template\-create\-env\fP
Create a new environment from template.
.TP
.B \fBenv\-template\-del\-app\fP
Delete application from the environment template.
.TP
.B \fBenv\-template\-delete\fP
Delete an environment template.
.TP
.B \fBenv\-template\-list\fP
List the environments templates.
.TP
.B \fBenv\-template\-show\fP
Display environment template details.
.TP
.B \fBenv\-template\-update\fP
Update an environment template.
.TP
.B \fBenvironment\-action\-call\fP
Call action \(gaACTION\(ga in environment \(gaID\(ga.
.TP
.B \fBenvironment\-action\-get\-result\fP
Get result of \(gaTASK\(ga in environment \(gaID\(ga.
.TP
.B \fBenvironment\-apps\-edit\fP
Edit environment\(aqs object model.
.TP
.B \fBenvironment\-create\fP
Create an environment.
.TP
.B \fBenvironment\-delete\fP
Delete an environment.
.TP
.B \fBenvironment\-deploy\fP
Start deployment of a murano environment session.
.TP
.B \fBenvironment\-list\fP
List the environments.
.TP
.B \fBenvironment\-model\-edit\fP
Edit an environment\(aqs object model.
.TP
.B \fBenvironment\-model\-show\fP
Display an environment\(aqs object model.
.TP
.B \fBenvironment\-rename\fP
Rename an environment.
.TP
.B \fBenvironment\-session\-create\fP
Creates a new configuration session for environment
ID.
.TP
.B \fBenvironment\-show\fP
Display environment details.
.TP
.B \fBpackage\-create\fP
Create an application package.
.TP
.B \fBpackage\-delete\fP
Delete a package.
.TP
.B \fBpackage\-download\fP
Download a package to a filename or stdout.
.TP
.B \fBpackage\-import\fP
Import a package.
.TP
.B \fBpackage\-list\fP
List available packages.
.TP
.B \fBpackage\-save\fP
Save a package.
.TP
.B \fBpackage\-show\fP
Display details for a package.
.TP
.B \fBpackage\-update\fP
Update an existing package.
.TP
.B \fBstatic\-action\-call\fP
Call static method \(gaMETHOD\(ga of the class \(gaCLASS\(ga with
\(gaARGUMENTS\(ga.
.TP
.B \fBbash\-completion\fP
Prints all of the commands and options to stdout.
.TP
.B \fBhelp\fP
Display help about this program or one of its
subcommands.
.UNINDENT
.SS murano optional arguments
.INDENT 0.0
.TP
.B \fB\-\-version\fP
Show program\(aqs version number and exit.
.TP
.B \fB\-d, \-\-debug\fP
Defaults to \fBenv[MURANOCLIENT_DEBUG]\fP\&.
.TP
.B \fB\-v, \-\-verbose\fP
Print more verbose output.
.TP
.B \fB\-\-cert\-file OS_CERT\fP
\fBDEPRECATED!\fP Use \-\-os\-cert.
.TP
.B \fB\-\-key\-file OS_KEY\fP
\fBDEPRECATED!\fP Use \-\-os\-key.
.TP
.B \fB\-\-ca\-file OS_CACERT\fP
\fBDEPRECATED!\fP Use \-\-os\-cacert.
.TP
.B \fB\-\-api\-timeout API_TIMEOUT\fP
Number of seconds to wait for an API response,
defaults to system socket timeout.
.TP
.B \fB\-\-os\-tenant\-id OS_TENANT_ID\fP
Defaults to \fBenv[OS_TENANT_ID]\fP\&.
.TP
.B \fB\-\-os\-tenant\-name OS_TENANT_NAME\fP
Defaults to \fBenv[OS_TENANT_NAME]\fP\&.
.TP
.B \fB\-\-os\-region\-name OS_REGION_NAME\fP
Defaults to \fBenv[OS_REGION_NAME]\fP\&.
.TP
.B \fB\-\-os\-auth\-token OS_AUTH_TOKEN\fP
Defaults to \fBenv[OS_AUTH_TOKEN]\fP\&.
.TP
.B \fB\-\-os\-no\-client\-auth\fP
Do not contact keystone for a token. Defaults to
\fBenv[OS_NO_CLIENT_AUTH]\fP\&.
.TP
.B \fB\-\-murano\-url MURANO_URL\fP
Defaults to \fBenv[MURANO_URL]\fP\&.
.TP
.B \fB\-\-glance\-url GLANCE_URL\fP
Defaults to \fBenv[GLANCE_URL]\fP\&.
.TP
.B \fB\-\-glare\-url GLARE_URL\fP
Defaults to \fBenv[GLARE_URL]\fP\&.
.TP
.B \fB\-\-murano\-api\-version MURANO_API_VERSION\fP
Defaults to \fBenv[MURANO_API_VERSION]\fP or 1.
.TP
.B \fB\-\-os\-service\-type OS_SERVICE_TYPE\fP
Defaults to \fBenv[OS_SERVICE_TYPE]\fP\&.
.TP
.B \fB\-\-os\-endpoint\-type OS_ENDPOINT_TYPE\fP
Defaults to \fBenv[OS_ENDPOINT_TYPE]\fP\&.
.TP
.B \fB\-\-include\-password\fP
Send os\-username and os\-password to murano.
.TP
.B \fB\-\-murano\-repo\-url MURANO_REPO_URL\fP
Defaults to \fBenv[MURANO_REPO_URL]\fP or
\fI\%http://apps.openstack.org/api/v1/murano_repo/liberty/\fP
.TP
.B \fB\-\-murano\-packages\-service {murano,glance,glare}\fP
Specifies if murano\-api ("murano") or Glance Artifact
Repository ("glare") should be used to store murano
packages. Defaults to \fBenv[MURANO_PACKAGES_SERVICE]\fP or
to "murano"
.TP
.B \fB\-\-insecure\fP
Explicitly allow client to perform "insecure" TLS
(https) requests. The server\(aqs certificate will not be
verified against any certificate authorities. This
option should be used with caution.
.TP
.B \fB\-\-os\-cacert <ca\-certificate>\fP
Specify a CA bundle file to use in verifying a TLS
(https) server certificate. Defaults to
\fBenv[OS_CACERT]\fP\&.
.TP
.B \fB\-\-os\-cert <certificate>\fP
Defaults to \fBenv[OS_CERT]\fP\&.
.TP
.B \fB\-\-os\-key <key>\fP
Defaults to \fBenv[OS_KEY]\fP\&.
.TP
.B \fB\-\-timeout <seconds>\fP
Set request timeout (in seconds).
.TP
.B \fB\-\-os\-auth\-url OS_AUTH_URL\fP
Authentication URL
.TP
.B \fB\-\-os\-domain\-id OS_DOMAIN_ID\fP
Domain ID to scope to
.TP
.B \fB\-\-os\-domain\-name OS_DOMAIN_NAME\fP
Domain name to scope to
.TP
.B \fB\-\-os\-project\-id OS_PROJECT_ID\fP
Project ID to scope to
.TP
.B \fB\-\-os\-project\-name OS_PROJECT_NAME\fP
Project name to scope to
.TP
.B \fB\-\-os\-project\-domain\-id OS_PROJECT_DOMAIN_ID\fP
Domain ID containing project
.TP
.B \fB\-\-os\-project\-domain\-name OS_PROJECT_DOMAIN_NAME\fP
Domain name containing project
.TP
.B \fB\-\-os\-trust\-id OS_TRUST_ID\fP
Trust ID
.TP
.B \fB\-\-os\-user\-id OS_USER_ID\fP
User ID
.TP
.B \fB\-\-os\-username OS_USERNAME, \-\-os\-user\-name OS_USERNAME, \-\-os\-user_name OS_USERNAME\fP
Username
.TP
.B \fB\-\-os\-user\-domain\-id OS_USER_DOMAIN_ID\fP
User\(aqs domain id
.TP
.B \fB\-\-os\-user\-domain\-name OS_USER_DOMAIN_NAME\fP
User\(aqs domain name
.TP
.B \fB\-\-os\-password OS_PASSWORD\fP
User\(aqs password
.UNINDENT
.SS murano app\-show
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano app\-show [\-p <PATH>] <ID>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
List applications, added to specified environment.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ID>\fP
Environment ID to show applications from.
.UNINDENT
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-p <PATH>, \-\-path <PATH>\fP
Level of detalization to show. Leave empty to browse
all applications in the environment.
.UNINDENT
.SS murano bundle\-import
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano bundle\-import [\-\-is\-public] [\-\-exists\-action {a,s,u}]
                            <FILE> [<FILE> ...]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Import
a
bundle.
\(gaFILE\(ga
can
be
either
a
path
to
a
zip
file,
URL,
or
name
from
repo. If \(gaFILE\(ga is a local file, treat names of packages in a bundle as file
names, relative to location of the bundle file. Requirements are first
searched in the same directory.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<FILE>\fP
Bundle URL, bundle name, or path to the bundle file.
.UNINDENT
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-\-is\-public\fP
Make packages available to users from other tenants.
.TP
.B \fB\-\-exists\-action {a,s,u}\fP
Default action when a package already exists.
.UNINDENT
.SS murano bundle\-save
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano bundle\-save [\-p <PATH>] [\-\-no\-images] <BUNDLE>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Save a bundle. This will download a bundle of packages with all dependencies
to specified path. If path doesn\(aqt exist it will be created.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<BUNDLE>\fP
Bundle URL, bundle name, or path to the bundle file.
.UNINDENT
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-p <PATH>, \-\-path <PATH>\fP
Path to the directory to store packages. If not set
will use current directory.
.TP
.B \fB\-\-no\-images\fP
If set will skip images downloading.
.UNINDENT
.SS murano category\-create
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano category\-create <CATEGORY_NAME>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Create a category.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<CATEGORY_NAME>\fP
Category name.
.UNINDENT
.SS murano category\-delete
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano category\-delete <ID> [<ID> ...]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Delete a category.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ID>\fP
ID of a category(ies) to delete.
.UNINDENT
.SS murano category\-list
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano category\-list
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
List all available categories.
.SS murano category\-show
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano category\-show <ID>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Display category details.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ID>\fP
ID of a category(s) to show.
.UNINDENT
.SS murano class\-schema
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano class\-schema [\-\-package\-name PACKAGE_NAME]
                           [\-\-class\-version CLASS_VERSION]
                           <CLASS> [<METHOD> [<METHOD> ...]]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Display class schema
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<CLASS>\fP
Class FQN
.TP
.B \fB<METHOD>\fP
Method name
.UNINDENT
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-\-package\-name PACKAGE_NAME\fP
FQN of the package where the class is located
.TP
.B \fB\-\-class\-version CLASS_VERSION\fP
Class version or version range (version spec)
.UNINDENT
.SS murano deployment\-list
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano deployment\-list [\-\-all\-environments] [<ID>]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
List deployments for an environment or multiple environments.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ID>\fP
Environment ID for which to list deployments.
.UNINDENT
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-\-all\-environments\fP
Lists all deployments for all environments in user\(aqs
tenant.
.UNINDENT
.SS murano env\-template\-add\-app
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano env\-template\-add\-app <ENV_TEMPLATE_ID> <FILE>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Add application to the environment template.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ENV_TEMPLATE_ID>\fP
Environment template ID.
.TP
.B \fB<FILE>\fP
Path to the template.
.UNINDENT
.SS murano env\-template\-clone
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano env\-template\-clone <ID> <ENV_TEMPLATE_NAME>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Create a new template, cloned from template.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ID>\fP
Environment template ID.
.TP
.B \fB<ENV_TEMPLATE_NAME>\fP
New environment template name.
.UNINDENT
.SS murano env\-template\-create
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano env\-template\-create [\-\-is\-public] <ENV_TEMPLATE_NAME>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Create an environment template.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ENV_TEMPLATE_NAME>\fP
Environment template name.
.UNINDENT
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-\-is\-public\fP
Make the template available for users from other
tenants.
.UNINDENT
.SS murano env\-template\-create\-env
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano env\-template\-create\-env [\-\-region <REGION_NAME>] <ID> <ENV_NAME>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Create a new environment from template.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ID>\fP
Environment template ID.
.TP
.B \fB<ENV_NAME>\fP
New environment name.
.UNINDENT
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-\-region <REGION_NAME>\fP
Name of the target OpenStack region.
.UNINDENT
.SS murano env\-template\-del\-app
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano env\-template\-del\-app <ENV_TEMPLATE_ID> <ENV_TEMPLATE_APP_ID>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Delete application from the environment template.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ENV_TEMPLATE_ID>\fP
Environment template ID.
.TP
.B \fB<ENV_TEMPLATE_APP_ID>\fP
Application ID.
.UNINDENT
.SS murano env\-template\-delete
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano env\-template\-delete <ID> [<ID> ...]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Delete an environment template.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ID>\fP
ID of environment(s) template to delete.
.UNINDENT
.SS murano env\-template\-list
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano env\-template\-list
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
List the environments templates.
.SS murano env\-template\-show
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano env\-template\-show <ID>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Display environment template details.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ID>\fP
Environment template ID.
.UNINDENT
.SS murano env\-template\-update
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano env\-template\-update <ID> <ENV_TEMPLATE_NAME>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Update an environment template.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ID>\fP
Environment template ID.
.TP
.B \fB<ENV_TEMPLATE_NAME>\fP
Environment template name.
.UNINDENT
.SS murano environment\-action\-call
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano environment\-action\-call \-\-action\-id <ACTION>
                                      [\-\-arguments [<KEY=VALUE> [<KEY=VALUE> ...]]]
                                      id
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Call
action
\(gaACTION\(ga
in
environment
\(gaID\(ga.
Returns
id
of
an
asynchronous
task,
that executes the action. Actions can only be called on a \(gadeployed\(ga
environment. To view actions available in a given environment use
\(gaenvironment\-show\(ga command.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fBid\fP
ID of Environment to call action against.
.UNINDENT
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-\-action\-id <ACTION>\fP
ID of action to run.
.TP
.B \fB\-\-arguments [<KEY=VALUE> [<KEY=VALUE> ...]]\fP
Action arguments.
.UNINDENT
.SS murano environment\-action\-get\-result
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano environment\-action\-get\-result \-\-task\-id <TASK> <ID>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Get result of \(gaTASK\(ga in environment \(gaID\(ga.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ID>\fP
ID of Environment where task is being executed.
.UNINDENT
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-\-task\-id <TASK>\fP
ID of action to run.
.UNINDENT
.SS murano environment\-apps\-edit
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano environment\-apps\-edit \-\-session\-id <SESSION_ID> <ID> [FILE]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Edit environment\(aqs object model. \(gaFILE\(ga is path to a file, that contains
jsonpatch, that describes changes to be made to environment\(aqs object\-model. [
{ "op": "add", "path": "/\-", "value": { ... your\-app object model here ... }
}, { "op": "replace", "path": "/0/?/name", "value": "new_name" }, ] NOTE:
Values \(aq===id1===\(aq, \(aq===id2===\(aq, etc. in the resulting object\-model will be
substituted with uuids. For more info on jsonpatch see RFC 6902
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ID>\fP
ID of Environment to edit.
.TP
.B \fBFILE\fP
File to read jsonpatch from (defaults to stdin).
.UNINDENT
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-\-session\-id <SESSION_ID>\fP
Id of a config session.
.UNINDENT
.SS murano environment\-create
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano environment\-create [\-\-join\-net\-id <NET_ID>]
                                 [\-\-join\-subnet\-id <SUBNET_ID>]
                                 [\-\-region <REGION_NAME>]
                                 <ENVIRONMENT_NAME>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Create an environment.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ENVIRONMENT_NAME>\fP
Environment name.
.UNINDENT
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-\-join\-net\-id <NET_ID>\fP
Network id to join.
.TP
.B \fB\-\-join\-subnet\-id <SUBNET_ID>\fP
Subnetwork id to join.
.TP
.B \fB\-\-region <REGION_NAME>\fP
Name of the target OpenStack region.
.UNINDENT
.SS murano environment\-delete
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano environment\-delete [\-\-abandon] <NAME or ID> [<NAME or ID> ...]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Delete an environment.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<NAME or ID>\fP
Id or name of environment(s) to delete.
.UNINDENT
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-\-abandon\fP
If set will abandon environment without deleting any of its
resources.
.UNINDENT
.SS murano environment\-deploy
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano environment\-deploy \-\-session\-id <SESSION> <ID>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Start deployment of a murano environment session.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ID>\fP
ID of Environment to deploy.
.UNINDENT
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-\-session\-id <SESSION>\fP
ID of configuration session to deploy.
.UNINDENT
.SS murano environment\-list
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano environment\-list [\-\-all\-tenants] [\-\-tenant <TENANT_ID>]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
List the environments.
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-\-all\-tenants\fP
Allows to list environments from all tenants (admin
only).
.TP
.B \fB\-\-tenant <TENANT_ID>\fP
Allows to list environments for a given tenant (admin
only).
.UNINDENT
.SS murano environment\-model\-edit
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano environment\-model\-edit \-\-session\-id <SESSION_ID> <ID> [<FILE>]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Edit an environment\(aqs object model.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ID>\fP
ID of Environment to edit.
.TP
.B \fB<FILE>\fP
File to read JSON\-patch from (defaults to stdin).
.UNINDENT
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-\-session\-id <SESSION_ID>\fP
Id of a config session.
.UNINDENT
.SS murano environment\-model\-show
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano environment\-model\-show [\-\-path <PATH>]
                                     [\-\-session\-id <SESSION_ID>]
                                     <ID>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Display an environment\(aqs object model.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ID>\fP
ID of Environment to show.
.UNINDENT
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-\-path <PATH>\fP
Path to Environment model section. Defaults to \(aq/\(aq.
.TP
.B \fB\-\-session\-id <SESSION_ID>\fP
Id of a config session.
.UNINDENT
.SS murano environment\-rename
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano environment\-rename <NAME or ID> <ENVIRONMENT_NAME>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Rename an environment.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<NAME or ID>\fP
Environment ID or name.
.TP
.B \fB<ENVIRONMENT_NAME>\fP
A name to which the environment will be renamed.
.UNINDENT
.SS murano environment\-session\-create
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano environment\-session\-create <ID>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Creates a new configuration session for environment ID.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ID>\fP
ID of Environment to add session to.
.UNINDENT
.SS murano environment\-show
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano environment\-show [\-\-session\-id <SESSION_ID>] [\-\-only\-apps]
                               <NAME or ID>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Display environment details.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<NAME or ID>\fP
Environment ID or name.
.UNINDENT
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-\-session\-id <SESSION_ID>\fP
Id of a config session.
.TP
.B \fB\-\-only\-apps\fP
Only print apps of the environment (useful for
automation).
.UNINDENT
.SS murano package\-create
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano package\-create [\-t <HEAT_TEMPLATE>] [\-c <CLASSES_DIRECTORY>]
                             [\-r <RESOURCES_DIRECTORY>] [\-n <DISPLAY_NAME>]
                             [\-f <full\-name>] [\-a <AUTHOR>]
                             [\-\-tags [<TAG1 TAG2> [<TAG1 TAG2> ...]]]
                             [\-d <DESCRIPTION>] [\-o <PACKAGE_NAME>]
                             [\-u <UI_DEFINITION>] [\-\-type TYPE] [\-l <LOGO>]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Create an application package.
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-t <HEAT_TEMPLATE>, \-\-template <HEAT_TEMPLATE>\fP
Path to the Heat template to import as an Application
Definition.
.TP
.B \fB\-c <CLASSES_DIRECTORY>, \-\-classes\-dir <CLASSES_DIRECTORY>\fP
Path to the directory containing application classes.
.TP
.B \fB\-r <RESOURCES_DIRECTORY>, \-\-resources\-dir <RESOURCES_DIRECTORY>\fP
Path to the directory containing application
resources.
.TP
.B \fB\-n <DISPLAY_NAME>, \-\-name <DISPLAY_NAME>\fP
Display name of the Application in Catalog.
.TP
.B \fB\-f <full\-name>, \-\-full\-name <full\-name>\fP
Fully\-qualified name of the Application in Catalog.
.TP
.B \fB\-a <AUTHOR>, \-\-author <AUTHOR>\fP
Name of the publisher.
.TP
.B \fB\-\-tags [<TAG1 TAG2> [<TAG1 TAG2> ...]]\fP
A list of keywords connected to the application.
.TP
.B \fB\-d <DESCRIPTION>, \-\-description <DESCRIPTION>\fP
Detailed description for the Application in Catalog.
.TP
.B \fB\-o <PACKAGE_NAME>, \-\-output <PACKAGE_NAME>\fP
The name of the output file archive to save locally.
.TP
.B \fB\-u <UI_DEFINITION>, \-\-ui <UI_DEFINITION>\fP
Dynamic UI form definition.
.TP
.B \fB\-\-type TYPE\fP
Package type. Possible values: Application or Library.
.TP
.B \fB\-l <LOGO>, \-\-logo <LOGO>\fP
Path to the package logo.
.UNINDENT
.SS murano package\-delete
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano package\-delete <ID> [<ID> ...]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Delete a package.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ID>\fP
Package ID to delete.
.UNINDENT
.SS murano package\-download
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano package\-download <ID> [file]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Download a package to a filename or stdout.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ID>\fP
Package ID to download.
.TP
.B \fBfile\fP
Filename to save package to. If it is not specified and there is no
stdout redirection the package won\(aqt be saved.
.UNINDENT
.SS murano package\-import
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano package\-import [\-c [<CATEGORY> [<CATEGORY> ...]]] [\-\-is\-public]
                             [\-\-package\-version PACKAGE_VERSION]
                             [\-\-exists\-action {a,s,u}]
                             [\-\-dep\-exists\-action {a,s,u}]
                             <FILE> [<FILE> ...]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Import a package. \(gaFILE\(ga can be either a path to a zip file, url or a FQPN.
You
can
use
\(ga\-\-\(ga
to
separate
\(gaFILE\(gas
from
other
arguments.
Categories
have
to
be separated with a space and have to be already present in murano.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<FILE>\fP
URL of the murano zip package, FQPN, path to zip
package or path to directory with package.
.UNINDENT
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-c [<CATEGORY> [<CATEGORY> ...]], \-\-categories [<CATEGORY> [<CATEGORY> ...]]\fP
Category list to attach.
.TP
.B \fB\-\-is\-public\fP
Make the package available for users from other
tenants.
.TP
.B \fB\-\-package\-version PACKAGE_VERSION\fP
Version of the package to use from repository (ignored
when importing with multiple packages).
.TP
.B \fB\-\-exists\-action {a,s,u}\fP
Default action when a package already exists: (s)kip,
(u)pdate, (a)bort.
.TP
.B \fB\-\-dep\-exists\-action {a,s,u}\fP
Default action when a dependency package already
exists: (s)kip, (u)pdate, (a)bort.
.UNINDENT
.SS murano package\-list
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano package\-list [\-\-limit LIMIT] [\-\-marker MARKER]
                           [\-\-include\-disabled] [\-\-owned]
                           [\-\-search <SEARCH_KEYS>] [\-\-name <PACKAGE_NAME>]
                           [\-\-fqn <PACKAGE_FULLY_QUALIFIED_NAME>]
                           [\-\-type <PACKAGE_TYPE>]
                           [\-\-category <PACKAGE_CATEGORY>]
                           [\-\-class_name <PACKAGE_CLASS_NAME>]
                           [\-\-tag <PACKAGE_TAG>]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
List available packages.
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-\-limit LIMIT\fP
Show limited number of packages
.TP
.B \fB\-\-marker MARKER\fP
Show packages starting from package with id excluding
it
.UNINDENT
.sp
\fB\-\-include\-disabled\fP
.sp
\fB\-\-owned\fP
.INDENT 0.0
.TP
.B \fB\-\-search <SEARCH_KEYS>\fP
Show packages, that match search keys fuzzily
.TP
.B \fB\-\-name <PACKAGE_NAME>\fP
Show packages, whose name match parameter exactly
.TP
.B \fB\-\-fqn <PACKAGE_FULLY_QUALIFIED_NAME>\fP
Show packages, whose fully qualified name match
parameter exactly
.TP
.B \fB\-\-type <PACKAGE_TYPE>\fP
Show packages, whose type match parameter exactly
.TP
.B \fB\-\-category <PACKAGE_CATEGORY>\fP
Show packages, whose categories include parameter
.TP
.B \fB\-\-class_name <PACKAGE_CLASS_NAME>\fP
Show packages, whose class name match parameter
exactly
.TP
.B \fB\-\-tag <PACKAGE_TAG>\fP
Show packages, whose tags include parameter
.UNINDENT
.SS murano package\-save
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano package\-save [\-p <PATH>] [\-\-package\-version PACKAGE_VERSION]
                           [\-\-no\-images]
                           <PACKAGE> [<PACKAGE> ...]
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Save a package. This will download package(s) with all dependencies to
specified path. If path doesn\(aqt exist it will be created.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<PACKAGE>\fP
Package URL or name.
.UNINDENT
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-p <PATH>, \-\-path <PATH>\fP
Path to the directory to store package. If not set
will use current directory.
.TP
.B \fB\-\-package\-version PACKAGE_VERSION\fP
Version of the package to use from repository (ignored
when saving with multiple packages).
.TP
.B \fB\-\-no\-images\fP
If set will skip images downloading.
.UNINDENT
.SS murano package\-show
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano package\-show <ID>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Display details for a package.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ID>\fP
Package ID to show.
.UNINDENT
.SS murano package\-update
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano package\-update [\-\-is\-public {true|false}]
                             [\-\-enabled {true|false}] [\-\-name NAME]
                             [\-\-description DESCRIPTION]
                             [\-\-tags [<TAG> [<TAG> ...]]]
                             <ID>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Update an existing package.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<ID>\fP
Package ID to update.
.UNINDENT
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-\-is\-public {true|false}\fP
Make package available to users from other tenants.
.TP
.B \fB\-\-enabled {true|false}\fP
Make package active and available for deployments.
.TP
.B \fB\-\-name NAME\fP
New name for the package.
.TP
.B \fB\-\-description DESCRIPTION\fP
New package description.
.TP
.B \fB\-\-tags [<TAG> [<TAG> ...]]\fP
A list of keywords connected to the application.
.UNINDENT
.SS murano static\-action\-call
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
usage: murano static\-action\-call [\-\-arguments [<KEY=VALUE> [<KEY=VALUE> ...]]]
                                 [\-\-package\-name <PACKAGE>]
                                 [\-\-class\-version CLASS_VERSION]
                                 <CLASS> <METHOD>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Call
static
method
\(gaMETHOD\(ga
of
the
class
\(gaCLASS\(ga
with
\(gaARGUMENTS\(ga.
Returns
the
result
of
the
method
execution.
\(gaPACKAGE\(ga
and
\(gaCLASS_VERSION\(ga
can
be
specified
optionally to find class in a particular package and to look for the specific
version of a class respectively.
.sp
\fBPositional arguments:\fP
.INDENT 0.0
.TP
.B \fB<CLASS>\fP
FQN of the class with static method
.TP
.B \fB<METHOD>\fP
Static method to run
.UNINDENT
.sp
\fBOptional arguments:\fP
.INDENT 0.0
.TP
.B \fB\-\-arguments [<KEY=VALUE> [<KEY=VALUE> ...]]\fP
Method arguments. No arguments by default
.TP
.B \fB\-\-package\-name <PACKAGE>\fP
Optional FQN of the package to look for the class in
.TP
.B \fB\-\-class\-version CLASS_VERSION\fP
Optional version of the class, otherwise version =0 is
used
.UNINDENT
.SH COPYRIGHT
OpenStack Foundation
.\" Generated by docutils manpage writer.
.