.TH "PROFITBRICKS-CLIENT" "1" "May 14, 2014" "1.0.0" "ProfitBricks Client"
.SH NAME
profitbricks-client \- ProfitBricks Client
.
.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
..
.\" Man page generated from reStructeredText.
.
.SH SYNOPSIS
.sp
\fBprofitbricks\-client\fP [\fIOPTIONS\fP] \fB\-\-help\fP [\fIcall\fP]
.sp
\fBprofitbricks\-client\fP [\fIOPTIONS\fP] \fB\-\-list\fP [\fIkeyword\fP]
.sp
\fBprofitbricks\-client\fP [\fIOPTIONS\fP] \fIcall\fP [\fIper\-call\-arguments\fP]
.SH DESCRIPTION
.sp
The ProfitBricks client can be used to manage your data centers through ProfitBricks’ public API.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-h [\fIcall\fP], \-\-help [\fIcall\fP]
Display a list of options if no \fIcall\fP is specified. Optional \fIcall\fP displays
detailed usage information for the given call.
.TP
.B \-l [\fIkeyword\fP], \-\-list [\fIkeyword\fP]
List all available calls. Optional \fIkeyword\fP refines the list to display only calls listed
under the keyword header. Available keywords are: DataCenter, Firewall, Image, InternetAccess,
LoadBalancer, Nic, Notifications, PublicIp, RomDrive, Server, Snapshot, and Storage.
.TP
.B call
Execute call. Additional parameters required, depending on choice of call. Use \fB\-\-list\fP to
get an overview of available calls.
.UNINDENT
.INDENT 0.0
.TP
.BI \-\-username \ username
username used for making the API call. The username stored in the configuration file is used if
no username is specified on the command line. If no username is stored in the configuration
file, the user will get prompted to enter their username.
.TP
.BI \-\-password \ password
plain text password used for making the API call. When no password or password file is
specified on the command line, the password stored in the configuration file will be used or
the users keyring will be queried (if the Python keyring module is installed). If no password
is found, the user will get prompted to enter their password.
.TP
.BI \-\-password\-file \ password\-filename
file containing the plain text password. The file must contain only one line with the password
to use. See \fB\-\-password\fP for details.
.TP
.B \-\-clear\-credentials
Clear all stored user credentials from the configuration file and the keyring.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-api\-version [\fIversion\fP]
Configure which version of the API is used for making the calls. If \fIversion\fP is left
unspecified, the CLI will update to the most recent compatible release of the API.
.UNINDENT
.INDENT 0.0
.TP
.BI \-\-endpoint \ URL
Point the CLI at a URL of the user\(aqs choice.
.TP
.B \-\-clear\-cache
Updates to the latest version of the ProfitBricks WSDL.
.TP
.B \-v,  \-\-verbose
Print data on the outgoing call to stderr. By default, print only response data (on stdout).
.TP
.B \-\-xml
Returns an XML formatted version of the response.
.UNINDENT
.SH AUTHOR
Benjamin Drung <benjamin.drung@profitbricks.com>
.SH COPYRIGHT
2014, ProfitBricks GmbH
.\" Generated by docutils manpage writer.
.\" 
.