First preview

LICENSE

@@ -0,0 +1,74 @@
+#   Copyright 2012 ProfitBricks GmbH
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+
+#   Project name: ProfitBricks command-line interface for the ProfitBricks application programming interface
+#   Author: ProfitBricks GmbH
+#   Contact: [email protected] / Greifswalder Str. 207, 10405 Berlin, Germany / +49 (0)30 609 856 990
+#   Files: pbapi.py (application), pbapi.1 (manual), test-pbapi.sh (functional test)
+#   License: Apache 2.0
+
+Apache License, Version 2.0, January 2004
+
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+

pbapi.1

@@ -0,0 +1,225 @@
+.\"
+.\" Copyright 2012 ProfitBricks GmbH
+.\"
+.\" Licensed under the Apache License, Version 2.0 (the "License");
+.\" you may not use this file except in compliance with the License.
+.\" You may obtain a copy of the License at
+.\"
+.\"     http://www.apache.org/licenses/LICENSE-2.0
+.\"
+.\" Unless required by applicable law or agreed to in writing, software
+.\" distributed under the License is distributed on an "AS IS" BASIS,
+.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.\" See the License for the specific language governing permissions and
+.\" limitations under the License.
+.\"
+.Dd Jan 30, 2012
+.Dt PBAPI 1
+.Os \" Current operating system
+.\" NAME
+.Ss NAME
+.Nm pbapi \- ProfitBricks API tools
+.Nd Manipulates the ProfitBricks data centers and components.
+.\" SYNOPSYS
+.Sh SYNOPSYS
+.Nm
+.Op Fl u Ar username
+.Op Fl p Ar password | Fl p Ar -
+.Op Fl auth Ar authfile
+.Op Fl s
+.Ar operation
+.Op Fl dcid Ar id | Fl srvid Ar id
+.Op ...
+.\" DESCRIPTION
+.Sh DESCRIPTION
+The
+.Nm
+may be used to create, update and delete ProfitBricks Virtual Data Centers and their components (servers, storage devices, etc).
+.\" EXAMPLES
+.Sh EXAMPLES
+.Nm Fl authfile Ar "/home/user/pbauth" Fl dcid Ar "012abcdef" Ar get-datacenter-state
+.Pp
+.Nm Fl authfile Ar "/home/user/pbauth" Fl srvid Ar "abc" Ar delete-server
+.Pp
+.Nm Fl u Ar santaclaus Fl p Ar jinglebells Ar create-server Fl dcid Ar "012abcdef" Fl cpu Ar 4 Fl ram Ar 4096 Fl server-name Ar testsrv Fl internet-access Ar y
+.\" BASE ARGUMENTS
+.Sh BASE ARGUMENTS
+All the operations and their respective parameters are Case Insensitive and dash-insensitive, so these are the same: createServer, CREATESERVER, create-server, Create-SERVER; and these are the same: -ramUnits, -RAMUnits, -ram-units, -r-a-m-U-n-i-t-s.
+.Pp
+All the operations require authentication, therefore the base arguments for all operations are
+.Fl u Ar username Fl p Ar password
+or instead of that you can use
+.Fl auth Ar authfile .
+.Bl -tag -width Ds
+.It Fl u Ar username
+The ProfitBricks username.
+.It Fl p Ar password
+The ProfitBricks password. If the password is not provided, it will be read from stdin. Providing
+.Ar -
+as password will prompt the user for the password from the stdin.
+.It Fl auth Ar authfile
+The
+.Ar authfile
+must contain the authentication username on the first line and password on the second line. For security reasons, the file must only be readable by your user.
+.It Fl s
+Enable short output formatting (display less information).
+.El
+.\" VIRTUAL SERVER OPERATIONS AND ARGUMENTS
+.Sh VIRTUAL SERVER OPERATIONS AND ARGUMENTS
+.Nm
+.Fl u Ar username Fl p Ar password Ar operation Fl srvid Ar serverId Op ...
+.Pp
+The
+.Ar operation
+may be:
+.Bl -tag -width Ds
+.It Ar createServer
+Creates a Virtual Server within an existing Data Center. Parameters can be specified to set up a boot device and connect the server to an existing LAN or the Internet. This operation doesn't require the
+.Fl srvid
+argument.
+.Bl -tag -width Ds
+.It Fl dcid Ar dataCenterId
+The ID of the Data Center.
+.It Fl cpu Ar cpuUnits
+Number of virtual CPUs to be assigned to the server.
+.It Fl ram Ar ramUnits
+Number of Megabytes (MiB) to be assigned to the server. Minimum value is 256 (256 MiB).
+.It Op Fl name Ar serverName
+Names the server to be created.
+.It Op Fl bootFromImageId Ar bootFromImageId
+Defines an existing CD/DVD image ID to be set as boot device for the server. It will be connected to the server implicitly.
+.It Op Fl bootFromStorageId Ar bootFromStorageId
+Defines an existing storage device ID to be set as boot device of the server. The storage will be connected to the server implicitly.
+.It Op Fl lanId Ar lanId
+Connects the server to the specified LAN ID. If the respective LAN does not exist, it is going to be created.
+.It Op Fl internetAccess Ar y | n
+If set to "y", the specified
+.Ar lanId
+will be connected to the Internet.
+.It Op Fl osType Ar osType
+Sets the OS type of the server (WINDOWS, OTHER). If left empty, the server will inherit the OS Type of its selected boot image / storage.
+.El
+.It Ar getServer
+Returns the following information about the server:
+.Bl -tag -width Ds
+.It server name
+The name of the Virtual Server.
+.It creation time
+Timestamp when the server was created.
+.It last modification time
+Timestamp when the server has been modified.
+.It provisioning state
+Current provisioning state (INACTIVE, INPROCESS, AVAILABLE, DELETED).
+.It virtual machine state
+Current state of the Virtual Machine (NOSTATE (provisioning in progress or boot failed), RUNNING, BLOCKED, PAUSED, SHUTDOWN, SHUTOFF, CRASHED).
+.It cpu
+Number of virtual CPUs assigned to the server.
+.It ram
+Amount of RAM in Megabytes (MiB) assigned to the server.
+.It internet access
+yes | no, tells if the
+.Ar lanid
+has access to the Internet.
+.It ips
+Lists all IP addresses assigned to the server. Empty if provisioning in progress.
+.It nics
+Lists all NICs assigned to the server. Empty if provisioning in progress.
+.It connected storages
+Lists all storages assigned to the server.
+.It rom drives
+Lists CD/DCD drives assigned to the server, including
+.Ar imageId
+and
+.Ar imageName .
+.It os type
+Operating system type (WINDOWS, OTHER, UNKNOWN).
+.El
+.It Ar rebootServer
+Reboots an existing Virtual Server (POWER CYCLE).
+.It Ar updateServer
+Updates parameters of an existing Virtual Server.
+.Bl -tag -width Ds
+.It Op Fl name Ar serverName
+Rename the Virtual Server.
+.It Op Fl cpu Ar cpuUnits
+Update number of virtual CPUs to be assigned to the server.
+.It Op Fl ram Ar ramUnits
+Update number of Megabytes (MiB) to be assigned to the server. Minimum value is 256 (256 MiB).
+.It Op Fl bootFromImageId Ar bootFromImageId
+Defines an existing CD/DVD image ID to be set as boot device for the server. It will be connected to the server implicitly.
+.It Op Fl bootFromStorageId Ar bootFromStorageId
+Defines an existing storage device ID to be set as boot device of the server. The storage will be connected to the server implicitly.
+.It Op Fl osType Ar osType
+Updates the OS type of the server (WINDOWS, OTHER). If left empty, the server will inherit the OS Type of its selected boot image / storage.
+.El
+.It Ar deleteServer
+Deletes an existing virtual server.
+.El
+.\" DATACENTER OPERATIONS AND ARGUMENTS
+.Sh DATACENTER OPERATIONS AND ARGUMENTS
+.Nm
+.Fl u Ar username Fl p Ar password Ar operation Fl dcid Ar dataCenterId Op ...
+.Pp
+The
+.Ar operation
+may be:
+.Bl -tag -width Ds
+.It Ar createDataCenter
+In the case of
+.Ar createDataCenter
+there is no need for
+.Fl dcid .
+Outputs the id of the newly created data center.
+.Bl -tag -width Ds
+.It Op Fl name Ar name
+The name of the newly created Data Center. Cannot contain \@, \\, /, |, ", or \'.
+.El
+.It Ar getDataCenter
+Returns information about the Data Center:
+.Bl -tag -width Ds
+.It data center name
+Name of the Virtual Data Center.
+.It state
+The current provisioning state (INACTIVE, INPROCESS, AVAILABLE, DELETED).
+.It servers
+A list of Virtual Servers contained by the Virtual Data Center.
+.It storages
+A list of Virtual Storages contained by the Virtual Data Center.
+.It version
+Version of the Virtual Data Center.
+.El
+.It Ar getDataCenterState
+Returns the data center provisioning state (INACTIVE, INPROCESS, AVAILABLE, DELETED).
+.It Ar getAllDataCenters
+Returns a list of all data centers created by the current user.
+.Bl -tag -width Ds
+.It id
+The unique identifier of the Virtual Data Center.
+.It name
+The name provided when the Virtual Data Center was created (or updated).
+.It version
+Version of the Virtual Data Center.
+.El
+.It Ar updateDataCenter
+Update the data center. The only argument that can be specified for now is the new name of the data center.
+.Bl -tag -width Ds
+.It Op Fl name Ar name
+The new name of the Data Center.
+.It Ar clearDataCenter
+Removes all components from an existing data center.
+.It Ar deleteDataCenter
+Deletes an empty Virtual Data Center. All components must be removed first.
+.El
+.El
+.\" EXIT STATUS
+.Sh EXIT STATUS
+.Ex -std
+.\" DIAGNOSTICS
+.Sh DIAGNOSTICS
+(should give an overview of the most common error messages from your program and how to cope with them. There is no need to explain system error error messages (from perror(3)) or fatal signals (from psignal(3)) as they can appear during execution of any program.)
+.\" TO DO
+.Sh TO DO
+Everything.
+.\" AUTHOR
+.Sh AUTHOR
+Report bugs to <bugs at profitbricks dot com>