.\" Man page generated from reStructuredText.
.
.TH "PYTHON-MURANOCLIENT" "1" "July 12, 2016" "" "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
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
.SH 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 (\fB\-\-os\-username\fP, \fB\-\-os\-password\fP,
\fB\-\-os\-tenant\-id\fP, and \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 \fB\-\-os\-image\-url\fP and
\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.
.SH RELEASE NOTES
.SS 0.1.0
.INDENT 0.0
.IP \(bu 2
Initial release
.UNINDENT
.SH COPYRIGHT
Mirantis, Inc
.\" Generated by docutils manpage writer.
.