├── .github ├── ISSUE_TEMPLATE │ └── bug_report.yml └── workflows │ └── maven-publish.yml ├── .gitignore ├── .vscode └── settings.json ├── 3rd-party-licenses.md ├── LICENSE ├── README.md ├── pom.xml └── src ├── main └── java │ └── it │ └── corsinvest │ └── proxmoxve │ └── api │ ├── MethodType.java │ ├── PveClient.java │ ├── PveClientBase.java │ ├── PveExceptionAuthentication.java │ ├── ResponseType.java │ └── Result.java └── test └── java └── Test.java /.github/ISSUE_TEMPLATE/bug_report.yml: -------------------------------------------------------------------------------- 1 | name: Bug Report 2 | description: File a bug report 3 | labels: [needs investigation] 4 | body: 5 | - type: markdown 6 | attributes: 7 | value: | 8 | Thanks for taking the time to fill out this bug report. Note that this template is only for bug reports. 9 | - type: textarea 10 | id: what-happened 11 | attributes: 12 | label: What happened? 13 | description: Please describe the issue briefly. You can use log, screenshots, gifs or videos to further explain your problem. 14 | placeholder: Describe your issue! 15 | validations: 16 | required: true 17 | - type: textarea 18 | id: expected-behavior 19 | attributes: 20 | label: Expected behavior 21 | description: Please provide a clear and concise description of what you expected to happen. 22 | placeholder: Describe the expected behavior! 23 | validations: 24 | required: true 25 | - type: textarea 26 | id: logs 27 | attributes: 28 | label: Relevant log output 29 | description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. 30 | render: shell 31 | 32 | - type: input 33 | id: net-version 34 | attributes: 35 | label: Java Version 36 | description: Java Version (SE 6, SE 9, .. SE 17) 37 | placeholder: SE 8 38 | validations: 39 | required: true 40 | 41 | - type: input 42 | id: proxmox-ve-version 43 | attributes: 44 | label: Proxmox VE Version 45 | description: Proxmox VE Version 46 | placeholder: 5.X.X 47 | validations: 48 | required: true 49 | 50 | - type: input 51 | id: bug-version 52 | attributes: 53 | label: Version (bug) 54 | description: With which version are you experiencing the issue? 55 | placeholder: 1.X.X 56 | validations: 57 | required: true 58 | - type: input 59 | id: working-version 60 | attributes: 61 | label: Version (working) 62 | description: Did it work on a previous version? If so, which version? 63 | placeholder: 1.X.X 64 | - type: dropdown 65 | id: os 66 | attributes: 67 | label: On what operating system are you experiencing the issue? 68 | description: You don't have to test it on every os. 69 | multiple: true 70 | options: 71 | - Windows 72 | - Mac OSX 73 | - Linux 74 | - Other 75 | validations: 76 | required: true 77 | 78 | - type: checkboxes 79 | id: pr 80 | attributes: 81 | label: Pull Request 82 | description: Are you interested in implementing a fix via a Pull Request? That would be the fastest way to resolve your issue. We appreciate every contribution! 83 | options: 84 | - label: I would like to do a Pull Request 85 | -------------------------------------------------------------------------------- /.github/workflows/maven-publish.yml: -------------------------------------------------------------------------------- 1 | # This workflow will build a package using Maven and then publish it to GitHub packages when a release is created 2 | # For more information see: https://github.com/actions/setup-java/blob/main/docs/advanced-usage.md#apache-maven-with-a-settings-path 3 | 4 | name: Maven Package 5 | 6 | on: 7 | workflow_dispatch: 8 | release: 9 | types: [created] 10 | 11 | jobs: 12 | build: 13 | 14 | runs-on: ubuntu-latest 15 | permissions: 16 | contents: read 17 | packages: write 18 | 19 | steps: 20 | - uses: actions/checkout@v3 21 | - name: Set up JDK 11 22 | uses: actions/setup-java@v3 23 | with: 24 | java-version: '11' 25 | distribution: 'temurin' 26 | server-id: github # Value of the distributionManagement/repository/id field of the pom.xml 27 | settings-path: ${{ github.workspace }} # location for the settings.xml file 28 | 29 | - name: Build with Maven 30 | run: mvn -B package --file pom.xml 31 | 32 | - name: Publish to GitHub Packages Apache Maven 33 | run: mvn deploy -s $GITHUB_WORKSPACE/settings.xml 34 | env: 35 | GITHUB_TOKEN: ${{ github.token }} 36 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target/ 2 | .project 3 | .settings/ 4 | .classpath -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "java.configuration.updateBuildConfiguration": "automatic" 3 | } -------------------------------------------------------------------------------- /3rd-party-licenses.md: -------------------------------------------------------------------------------- 1 | # License overview of included 3rd party libraries 2 | 3 | The project is licensed under the terms of the [LICENSE](LICENSE) 4 | 5 | However, includes several third-party Open-Source libraries, which are licensed under their own respective Open-Source licenses. 6 | 7 | ## Libraries directly included 8 | 9 | [json.org](https://github.com/stleary/JSON-java) 10 | License: JSON 11 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # cv4pve-api-java 2 | 3 | Proxmox VE Client API Java 4 | 5 | ![GitHub release](https://img.shields.io/github/release/Corsinvest/cv4pve-api-java.svg) 6 | 7 | [Proxmox VE Api](https://pve.proxmox.com/pve-docs/api-viewer/) 8 | 9 | ```text 10 | ______ _ __ 11 | / ____/___ __________(_)___ _ _____ _____/ /_ 12 | / / / __ \/ ___/ ___/ / __ \ | / / _ \/ ___/ __/ 13 | / /___/ /_/ / / (__ ) / / / / |/ / __(__ ) /_ 14 | \____/\____/_/ /____/_/_/ /_/|___/\___/____/\__/ 15 | 16 | Corsinvest for Proxmox VE Api Client (Made in Italy) 17 | ``` 18 | 19 | ## Copyright and License 20 | 21 | Copyright: Corsinvest Srl 22 | For licensing details please visit [LICENSE](LICENSE) 23 | 24 | ## Commercial Support 25 | 26 | This software is part of a suite of tools called cv4pve-tools. If you want commercial support, visit the [site](https://www.corsinvest.it/cv4pve) 27 | 28 | ## General 29 | 30 | The client is generated from a JSON Api on Proxmox VE. 31 | 32 | ## Result 33 | 34 | The result is class **Result** and contain methods: 35 | 36 | * **getResponse()** returned from Proxmox VE (data,errors,...) JSONObject . 37 | * **responseInError** (bool) : Contains errors from Proxmox VE. 38 | * **getStatusCode()** (int) : Status code of the HTTP response. 39 | * **getReasonPhrase()** (string): The reason phrase which typically is sent by servers together with the status code. 40 | * **isSuccessStatusCode()** (bool) : Gets a value that indicates if the HTTP response was successful. 41 | * **getError()** (string) : Get error. 42 | 43 | ## Main features 44 | 45 | * Easy to learn 46 | * Method named 47 | * Implementation respect the [Api structure of Proxmox VE](https://pve.proxmox.com/pve-docs/api-viewer/) 48 | * Full method generated from documentation 49 | * Comment any method and parameters 50 | * Parameters indexed eg [n] is structured in array index and value 51 | * Tree structure 52 | * client.getNodes().get("pve1").getQemu().vmlist().getResponse().getJSONArray("data") 53 | * Return data Proxmox VE 54 | * Debug Level show to console information 55 | * Return result 56 | * Request 57 | * Response 58 | * Status 59 | * Last result action 60 | * Wait task finish task 61 | * waitForTaskToFinish 62 | * taskIsRunning 63 | * getExitStatusTask 64 | * Method directly access 65 | * get 66 | * set 67 | * create 68 | * delete 69 | * Login return bool if access 70 | * Return Result class more information 71 | * Minimal dependency library 72 | * ClientBase lite function 73 | * Form Proxmox VE 6.2 support Api Token for user 74 | * Login with One-time password for Two-factor authentication 75 | * Support for Proxy 76 | * Set Timeout for the Connection. 77 | 78 | ## Api token 79 | 80 | From version 6.2 of Proxmox VE is possible to use [Api token](https://pve.proxmox.com/pve-docs/pveum-plain.html). 81 | This feature permit execute Api without using user and password. 82 | If using **Privilege Separation** when create api token remember specify in permission. 83 | Format USER@REALM!TOKENID=UUID 84 | 85 | ## Usage 86 | 87 | ```java 88 | //if you want use lite version only get/set/create/delete use PveClientBase 89 | 90 | PveClient client = new PveClient("10.92.90.91", 8006); 91 | if (client.login("root", "password", "pam")) { 92 | //version 93 | System.out.println(client.getVersion().version().getResponse().get("data")); 94 | 95 | // same for put/post/delete 96 | //loop nodes for 97 | JSONArray nodes = client.getNodes().index().getResponse().getJSONArray("data"); 98 | for (int i = 0; i < nodes.length(); i++) { 99 | System.out.println(nodes.get(i)); 100 | } 101 | 102 | //loop nodes for each 103 | PveClient.JSONArrayToList(client.getNodes().index().getResponse().getJSONArray("data")).forEach((node) -> { 104 | System.out.println(node); 105 | }); 106 | 107 | //loops vms qemu 108 | JSONArray vms = client.getNodes().get("pve1").getQemu().vmlist().getResponse().getJSONArray("data"); 109 | for (int i = 0; i < vms.length(); i++) { 110 | System.out.println(vms.get(i)); 111 | } 112 | 113 | //loop snapshots 114 | JSONArray snapshots = client.getNodes().get("pve1") 115 | .getQemu().get(100).getSnapshot().snapshotList().getResponse().getJSONArray("data"); 116 | for (int i = 0; i < snapshots.length(); i++) { 117 | System.out.println(snapshots.get(i)); 118 | } 119 | 120 | //create snapshot 121 | JSONObject retCreateSnap = client.getNodes().get("pve1").getQemu().get(100).getSnapshot().snapshot("pippo").getResponse(); 122 | 123 | //print UPID 124 | System.out.println(retCreateSnap.get("data")); 125 | 126 | //wait creation 127 | client.waitForTaskToFinish("pve1", retCreateSnap.getString("data"), 500, 10000); 128 | 129 | //delete snapshot 130 | Result retDeleSnap = client.getNodes().get("pve1").getQemu().get(100).getSnapshot().get("pippo").delsnapshot(); 131 | System.out.println(retDeleSnap.getResponse().get("data")); 132 | } 133 | ``` 134 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | it.corsinvest.proxmoxve 7 | cv4pve-api-java 8 | 8.4.0 9 | jar 10 | cv4pve-api-java 11 | Corsinvest for Proxmox VE Client API Java 12 | http://www.corsinvest.it/cv4pve 13 | 14 | 15 | scm:git:git://github.com/corsinvest/cv4pve-api-java.git 16 | scm:git:ssh://github.com:corsinvest/cv4pve-api-java.git 17 | http://github.com/corsinvest/cv4pve-api-java/tree/master 18 | 19 | 20 | 21 | Corsinvest Srl 22 | 23 | 24 | 25 | GPL-3.0 license 26 | >https://www.gnu.org/licenses/gpl-3.0.txt 27 | 28 | 29 | 30 | 50 | 51 | 52 | 53 | dc 54 | Daniele Corsini 55 | daniele.corsini@corsinvest.it 56 | 57 | Project Manager 58 | Architect 59 | 60 | Corsinvest Srl 61 | 0 62 | 63 | 64 | 65 | 66 | org.json 67 | json 68 | 20231013 69 | jar 70 | 71 | 72 | 73 | UTF-8 74 | 1.8 75 | 1.8 76 | 77 | 78 | 79 | 80 | 81 | org.apache.maven.plugins 82 | maven-source-plugin 83 | 2.2.1 84 | 85 | 86 | attach-sources 87 | 88 | jar-no-fork 89 | 90 | 91 | 92 | 93 | 94 | 130 | 131 | 132 | -------------------------------------------------------------------------------- /src/main/java/it/corsinvest/proxmoxve/api/MethodType.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SPDX-FileCopyrightText: Copyright Corsinvest Srl 3 | * SPDX-License-Identifier: GPL-3.0-only 4 | */ 5 | 6 | package it.corsinvest.proxmoxve.api; 7 | 8 | /** 9 | * Method Type 10 | */ 11 | public enum MethodType { 12 | GET, SET, CREATE, DELETE 13 | } 14 | -------------------------------------------------------------------------------- /src/main/java/it/corsinvest/proxmoxve/api/PveClientBase.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SPDX-FileCopyrightText: Copyright Corsinvest Srl 3 | * SPDX-License-Identifier: GPL-3.0-only 4 | */ 5 | package it.corsinvest.proxmoxve.api; 6 | 7 | import java.io.BufferedReader; 8 | import java.io.IOException; 9 | import java.io.InputStreamReader; 10 | import java.net.HttpURLConnection; 11 | import java.net.Proxy; 12 | import java.net.URL; 13 | import java.security.KeyManagementException; 14 | import java.security.NoSuchAlgorithmException; 15 | import java.security.cert.X509Certificate; 16 | import java.util.ArrayList; 17 | import java.util.Base64; 18 | import java.util.HashMap; 19 | import java.util.LinkedHashMap; 20 | import java.util.List; 21 | import java.util.Map; 22 | import java.util.logging.Level; 23 | import java.util.logging.Logger; 24 | import javax.net.ssl.HostnameVerifier; 25 | import javax.net.ssl.HttpsURLConnection; 26 | import javax.net.ssl.SSLContext; 27 | import javax.net.ssl.SSLSession; 28 | import javax.net.ssl.TrustManager; 29 | import javax.net.ssl.X509TrustManager; 30 | import org.json.JSONArray; 31 | import org.json.JSONException; 32 | import org.json.JSONObject; 33 | 34 | /** 35 | * Proxmox VE Client Base 36 | */ 37 | public class PveClientBase { 38 | 39 | private String _ticketCSRFPreventionToken; 40 | private String _ticketPVEAuthCookie; 41 | private final String _hostname; 42 | private final int _port; 43 | private int _debugLevel; 44 | private Result _lastResult; 45 | private ResponseType _responseType = ResponseType.JSON; 46 | private String _apiToken; 47 | private Proxy _proxy = Proxy.NO_PROXY; 48 | private int _timeout = 0; 49 | private boolean _validateCertificate = false; 50 | 51 | public PveClientBase(String hostname, int port) { 52 | _hostname = hostname; 53 | _port = port; 54 | } 55 | 56 | /** 57 | * Gets the hostname configured. 58 | * 59 | * @return string The hostname. 60 | */ 61 | public String getHostname() { 62 | return _hostname; 63 | } 64 | 65 | /** 66 | * Gets the port configured. 67 | * 68 | * @return int The port. 69 | */ 70 | public int getPort() { 71 | return _port; 72 | } 73 | 74 | /** 75 | * Get Validate Certificate 76 | * 77 | * @return bool 78 | */ 79 | public boolean getValidateCertificate() { 80 | return _validateCertificate; 81 | } 82 | 83 | /** 84 | * Set Validate Certificate 85 | * 86 | * @param validateCertificate 87 | */ 88 | public void setValidateCertificate(boolean validateCertificate) { 89 | _validateCertificate = validateCertificate; 90 | } 91 | 92 | /** 93 | * Get proxy 94 | * 95 | * @return Proxy 96 | */ 97 | public Proxy getProxy() { 98 | return _proxy; 99 | } 100 | 101 | /** 102 | * Set proxy 103 | * 104 | * @param proxy 105 | */ 106 | public void setProxy(Proxy proxy) { 107 | _proxy = proxy; 108 | } 109 | 110 | /** 111 | * Get the response type that is going to be returned when doing requests 112 | * (json, png). 113 | * 114 | * @return ResponseType 115 | */ 116 | public ResponseType getResponseType() { 117 | return _responseType; 118 | } 119 | 120 | /** 121 | * Set the response type that is going to be returned when doing requests 122 | * (json, png). 123 | * 124 | * @param responseType Response type 125 | */ 126 | public void setResponseType(ResponseType responseType) { 127 | _responseType = responseType; 128 | } 129 | 130 | /** 131 | * Set timeout connection 132 | * 133 | * @param timeout 134 | */ 135 | public void setTimeout(int timeout) { 136 | if (timeout < 0) { 137 | throw new IllegalArgumentException("timeout can not be negative"); 138 | } 139 | _timeout = timeout; 140 | } 141 | 142 | /** 143 | * Return timeout connection 144 | * 145 | * @return 146 | */ 147 | public int getTimeout() { 148 | return _timeout; 149 | } 150 | 151 | /** 152 | * Creation ticket from login. 153 | * 154 | * @param username user name or <username>@<realm> 155 | * @param password password connection 156 | * @return boolean 157 | * @throws JSONException 158 | * @throws PveExceptionAuthentication 159 | */ 160 | public boolean login(String username, String password) throws JSONException, PveExceptionAuthentication { 161 | String realm = "pam"; 162 | String[] data = username.split("@"); 163 | if (data.length > 1) { 164 | username = data[0]; 165 | realm = data[1]; 166 | } 167 | 168 | return login(username, password, realm, null); 169 | } 170 | 171 | /** 172 | * Creation ticket from login. 173 | * 174 | * @param username user name 175 | * @param password password connection 176 | * @param realm pam/pve or custom 177 | * 178 | * @return boolean 179 | * @throws JSONException 180 | * @throws PveExceptionAuthentication 181 | */ 182 | public boolean login(String username, String password, String realm) 183 | throws JSONException, PveExceptionAuthentication { 184 | return login(username, password, realm, null); 185 | } 186 | 187 | /** 188 | * Creation ticket from login. 189 | * 190 | * @param username user name 191 | * @param password password connection 192 | * @param realm pam/pve or custom 193 | * @param otp One-time password for Two-factor authentication. 194 | * 195 | * @return boolean 196 | * @throws JSONException 197 | * @throws PveExceptionAuthentication 198 | */ 199 | public boolean login(String username, String password, String realm, String otp) 200 | throws JSONException, PveExceptionAuthentication { 201 | Result result = create("/access/ticket", new HashMap() { 202 | { 203 | put("password", password); 204 | put("username", username); 205 | put("realm", realm); 206 | put("otp", otp); 207 | } 208 | }); 209 | 210 | if (result.isSuccessStatusCode()) { 211 | if (result.getResponse().getJSONObject("data").has("NeedTFA")) { 212 | throw new PveExceptionAuthentication(result, 213 | "Couldn't authenticate user: missing Two Factor Authentication (TFA)"); 214 | } 215 | 216 | _ticketCSRFPreventionToken = result.getResponse().getJSONObject("data").getString("CSRFPreventionToken"); 217 | _ticketPVEAuthCookie = result.getResponse().getJSONObject("data").getString("ticket"); 218 | } 219 | return result.isSuccessStatusCode(); 220 | } 221 | 222 | /** 223 | * Returns the base URL used to interact with the Proxmox VE API. 224 | * 225 | * @return The proxmox API URL. 226 | */ 227 | public String getApiUrl() { 228 | return "https://" + getHostname() + ":" + getPort() + "/api2/json"; 229 | } 230 | 231 | /** 232 | * Execute method GET 233 | * 234 | * @param resource Url request 235 | * @param parameters Additional parameters 236 | * @return Result 237 | * @throws JSONException 238 | */ 239 | public Result get(String resource, Map parameters) throws JSONException { 240 | return executeAction(resource, MethodType.GET, parameters); 241 | } 242 | 243 | /** 244 | * Execute method PUT 245 | * 246 | * @param resource Url request 247 | * @param parameters Additional parameters 248 | * @return Result 249 | * @throws JSONException 250 | */ 251 | public Result set(String resource, Map parameters) throws JSONException { 252 | return executeAction(resource, MethodType.SET, parameters); 253 | } 254 | 255 | /** 256 | * Execute method POST 257 | * 258 | * @param resource Url request 259 | * @param parameters Additional parameters 260 | * @return Result 261 | * @throws JSONException 262 | */ 263 | public Result create(String resource, Map parameters) throws JSONException { 264 | return executeAction(resource, MethodType.CREATE, parameters); 265 | } 266 | 267 | /** 268 | * Execute method DELETE 269 | * 270 | * @param resource Url request 271 | * @param parameters Additional parameters 272 | * @return Result 273 | * @throws JSONException 274 | */ 275 | public Result delete(String resource, Map parameters) throws JSONException { 276 | return executeAction(resource, MethodType.DELETE, parameters); 277 | } 278 | 279 | /** 280 | * Set debug level 281 | * 282 | * @param value 0 - nothing 1 - Url and method 2 - Url and method and result 283 | */ 284 | public void setDebugLevel(int value) { 285 | _debugLevel = value; 286 | } 287 | 288 | /** 289 | * Return debug level. 290 | * 291 | * @return int 292 | */ 293 | public int getDebugLevel() { 294 | return _debugLevel; 295 | } 296 | 297 | /** 298 | * Return Api Token 299 | * 300 | * @return String 301 | */ 302 | public String getApiToken() { 303 | return _apiToken; 304 | } 305 | 306 | /** 307 | * Set Api Token format USER@REALM!TOKENID=UUID 308 | * 309 | * @param apiToken 310 | */ 311 | public void setApiToken(String apiToken) { 312 | _apiToken = apiToken; 313 | } 314 | 315 | private void setToken(HttpURLConnection httpCon) { 316 | if (_ticketCSRFPreventionToken != null) { 317 | httpCon.setRequestProperty("CSRFPreventionToken", _ticketCSRFPreventionToken); 318 | httpCon.setRequestProperty("Cookie", "PVEAuthCookie=" + _ticketPVEAuthCookie); 319 | } 320 | 321 | if (_apiToken != null && !_apiToken.isEmpty()) { 322 | httpCon.setRequestProperty("Authorization", "PVEAPIToken " + _apiToken); 323 | } 324 | } 325 | 326 | private void setConnectionTimeout(HttpURLConnection httpCon) { 327 | if (_timeout > 0) { 328 | httpCon.setConnectTimeout(_timeout); 329 | } 330 | } 331 | 332 | private Result executeAction(String resource, MethodType methodType, Map parameters) 333 | throws JSONException { 334 | String url = getApiUrl() + resource; 335 | 336 | // decode http method 337 | String httpMethod = ""; 338 | switch (methodType) { 339 | case GET: 340 | httpMethod = "GET"; 341 | break; 342 | case SET: 343 | httpMethod = "PUT"; 344 | break; 345 | case CREATE: 346 | httpMethod = "POST"; 347 | break; 348 | case DELETE: 349 | httpMethod = "DELETE"; 350 | break; 351 | default: 352 | throw new AssertionError(); 353 | } 354 | 355 | Map params = new LinkedHashMap<>(); 356 | if (parameters != null) { 357 | parameters.entrySet().stream().filter((entry) -> (entry.getValue() != null)).forEachOrdered((entry) -> { 358 | Object value = entry.getValue(); 359 | if (value instanceof Boolean) { 360 | params.put(entry.getKey(), Boolean.TRUE.equals(value) ? 1 : 0); 361 | } else { 362 | params.put(entry.getKey(), value); 363 | } 364 | }); 365 | } 366 | 367 | if (!_validateCertificate) { 368 | // Create a trust manager that does not validate certificate chains 369 | TrustManager[] trustAllCerts = new TrustManager[]{new X509TrustManager() { 370 | @Override 371 | public java.security.cert.X509Certificate[] getAcceptedIssuers() { 372 | return null; 373 | } 374 | 375 | @Override 376 | public void checkClientTrusted(X509Certificate[] certs, String authType) { 377 | } 378 | 379 | @Override 380 | public void checkServerTrusted(X509Certificate[] certs, String authType) { 381 | } 382 | }}; 383 | 384 | // Install the all-trusting trust manager 385 | try { 386 | SSLContext sc = SSLContext.getInstance("SSL"); 387 | sc.init(null, trustAllCerts, new java.security.SecureRandom()); 388 | HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory()); 389 | } catch (NoSuchAlgorithmException | KeyManagementException ex) { 390 | Logger.getLogger(PveClientBase.class.getName()).log(Level.SEVERE, null, ex); 391 | } 392 | } 393 | 394 | // Create all-trusting host name verifier 395 | HostnameVerifier allHostsValid = (String hostname, SSLSession session) -> true; 396 | 397 | // Install the all-trusting host verifier 398 | HttpsURLConnection.setDefaultHostnameVerifier(allHostsValid); 399 | 400 | int statusCode = 0; 401 | String reasonPhrase = ""; 402 | JSONObject response = new JSONObject(); 403 | HttpURLConnection httpCon = null; 404 | 405 | try { 406 | switch (methodType) { 407 | case GET: { 408 | if (!params.isEmpty()) { 409 | StringBuilder urlParams = new StringBuilder(); 410 | params.forEach((key, value) -> { 411 | urlParams.append(urlParams.length() > 0 ? "&" : "") 412 | .append(key) 413 | .append("=") 414 | .append(value.toString()); 415 | }); 416 | url += "?" + urlParams.toString(); 417 | } 418 | 419 | httpCon = (HttpURLConnection) new URL(url).openConnection(_proxy); 420 | httpCon.setRequestMethod("GET"); 421 | setConnectionTimeout(httpCon); 422 | setToken(httpCon); 423 | break; 424 | } 425 | 426 | case SET: 427 | case CREATE: { 428 | String data = new JSONObject(params).toString(); 429 | httpCon = (HttpURLConnection) new URL(url).openConnection(_proxy); 430 | httpCon.setRequestMethod(httpMethod); 431 | httpCon.setRequestProperty("Content-Type", "application/json"); 432 | httpCon.setRequestProperty("Content-Length", String.valueOf(data.length())); 433 | setConnectionTimeout(httpCon); 434 | setToken(httpCon); 435 | 436 | httpCon.setDoOutput(true); 437 | httpCon.getOutputStream().write(data.getBytes("UTF-8")); 438 | break; 439 | } 440 | 441 | case DELETE: { 442 | httpCon = (HttpURLConnection) new URL(url).openConnection(_proxy); 443 | httpCon.setRequestMethod("DELETE"); 444 | setConnectionTimeout(httpCon); 445 | setToken(httpCon); 446 | break; 447 | } 448 | } 449 | 450 | if (getDebugLevel() >= 1) { 451 | System.out.println("Method: " + httpMethod + " , Url: " + url); 452 | if (methodType != MethodType.GET) { 453 | System.out.println("Parameters:"); 454 | params.forEach((key, value) -> { 455 | System.out.println(key + " : " + value); 456 | }); 457 | } 458 | } 459 | 460 | statusCode = httpCon.getResponseCode(); 461 | reasonPhrase = httpCon.getResponseMessage(); 462 | 463 | try (BufferedReader reader = new BufferedReader(new InputStreamReader(httpCon.getInputStream()))) { 464 | StringBuilder sb = new StringBuilder(); 465 | String line; 466 | while ((line = reader.readLine()) != null) { 467 | sb.append(line).append("\n"); 468 | } 469 | 470 | switch (getResponseType()) { 471 | case JSON: 472 | response = new JSONObject(sb.toString()); 473 | break; 474 | 475 | case PNG: 476 | response = new JSONObject("data:image/png;base64," 477 | + new String(Base64.getEncoder().encode(sb.toString().getBytes()))); 478 | break; 479 | 480 | default: 481 | throw new AssertionError(); 482 | } 483 | 484 | } 485 | } catch (IOException ex) { 486 | Logger.getLogger(PveClientBase.class.getName()).log(Level.SEVERE, null, ex); 487 | } 488 | 489 | _lastResult = new Result(response, 490 | statusCode, 491 | reasonPhrase, 492 | resource, 493 | parameters, 494 | methodType, 495 | getResponseType()); 496 | 497 | if (getDebugLevel() >= 2) { 498 | System.out.println(response.toString(2)); 499 | System.out.println("StatusCode: " + _lastResult.getStatusCode()); 500 | System.out.println("ReasonPhrase: " + _lastResult.getReasonPhrase()); 501 | System.out.println("IsSuccessStatusCode: " + _lastResult.isSuccessStatusCode()); 502 | } 503 | if (getDebugLevel() > 0) { 504 | System.out.println("============================="); 505 | } 506 | return _lastResult; 507 | } 508 | 509 | /** 510 | * Last result 511 | * 512 | * @return Result 513 | */ 514 | public Result getLastResult() { 515 | return _lastResult; 516 | } 517 | 518 | /** 519 | * Add indexed parameter 520 | * 521 | * @param parameters Parameters 522 | * @param name Name parameter 523 | * @param value Values 524 | */ 525 | public static void addIndexedParameter(Map parameters, String name, Map value) { 526 | if (value != null) { 527 | value.entrySet().forEach((entry) -> { 528 | parameters.put(name + entry.getKey(), entry.getValue()); 529 | }); 530 | } 531 | } 532 | 533 | /** 534 | * Wait for task to finish 535 | * 536 | * @param task Task identifier 537 | * @param wait Millisecond wait next check 538 | * @param timeOut Millisecond timeout 539 | * @return 0 Success 540 | * @throws JSONException 541 | */ 542 | public boolean waitForTaskToFinish(String task, long wait, long timeOut) throws JSONException { 543 | boolean isRunning = true; 544 | if (wait <= 0) { 545 | wait = 500; 546 | } 547 | if (timeOut < wait) { 548 | timeOut = wait + 5000; 549 | } 550 | 551 | long timeStart = System.currentTimeMillis(); 552 | long waitTime = System.currentTimeMillis(); 553 | while (isRunning && (System.currentTimeMillis() - timeStart) < timeOut) { 554 | if ((System.currentTimeMillis() - waitTime) >= wait) { 555 | waitTime = System.currentTimeMillis(); 556 | isRunning = taskIsRunning(task); 557 | } 558 | } 559 | 560 | return System.currentTimeMillis() - timeStart < timeOut; 561 | } 562 | 563 | /** 564 | * Check task is running 565 | * 566 | * @param task Task identifier 567 | * @return boolean 568 | * @throws JSONException 569 | */ 570 | public boolean taskIsRunning(String task) throws JSONException { 571 | return readTaskStatus(task).getResponse().getJSONObject("data").getString("status").equals("running"); 572 | } 573 | 574 | /** 575 | * Return exit status code task 576 | * 577 | * @param task Task identifier 578 | * @return String 579 | * @throws JSONException 580 | */ 581 | public String getExitStatusTask(String task) throws JSONException { 582 | return readTaskStatus(task).getResponse().getJSONObject("data").getString("exitstatus"); 583 | } 584 | 585 | /** 586 | * Convert JSONArray To List 587 | * 588 | * @param Type of data 589 | * @param array Array JSON 590 | * @return T List of Type of data 591 | * @throws JSONException 592 | */ 593 | public static List JSONArrayToList(JSONArray array) throws JSONException { 594 | ArrayList ret = new ArrayList(); 595 | if (array != null) { 596 | for (int i = 0; i < array.length(); i++) { 597 | ret.add((T) array.get(i)); 598 | } 599 | } 600 | return ret; 601 | } 602 | 603 | /** 604 | * Get node from task 605 | * 606 | * @param task Task 607 | * @return String 608 | */ 609 | public static String getNodeFromTask(String task) { 610 | return task.split(":")[1]; 611 | } 612 | 613 | /** 614 | * Read task status. 615 | * 616 | * @param task 617 | * @return Result 618 | * @throws JSONException 619 | */ 620 | private Result readTaskStatus(String task) throws JSONException { 621 | return get("/nodes/" + getNodeFromTask(task) + "/tasks/" + task + "/status", null); 622 | } 623 | } 624 | -------------------------------------------------------------------------------- /src/main/java/it/corsinvest/proxmoxve/api/PveExceptionAuthentication.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SPDX-FileCopyrightText: Copyright Corsinvest Srl 3 | * SPDX-License-Identifier: GPL-3.0-only 4 | */ 5 | package it.corsinvest.proxmoxve.api; 6 | 7 | /** 8 | * Pve Exception Authentication 9 | */ 10 | public class PveExceptionAuthentication extends Exception { 11 | 12 | private final Result _result; 13 | 14 | /** 15 | * Constructor 16 | * 17 | * @param result 18 | * @param errorMessage 19 | */ 20 | public PveExceptionAuthentication(Result result, String errorMessage) { 21 | super(errorMessage); 22 | _result = result; 23 | } 24 | 25 | /** 26 | * Get result 27 | * 28 | * @return 29 | */ 30 | public Result getResult() { 31 | return _result; 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /src/main/java/it/corsinvest/proxmoxve/api/ResponseType.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SPDX-FileCopyrightText: Copyright Corsinvest Srl 3 | * SPDX-License-Identifier: GPL-3.0-only 4 | */ 5 | 6 | package it.corsinvest.proxmoxve.api; 7 | 8 | /** 9 | * Response Type 10 | */ 11 | public enum ResponseType { 12 | JSON, 13 | PNG 14 | } 15 | -------------------------------------------------------------------------------- /src/main/java/it/corsinvest/proxmoxve/api/Result.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SPDX-FileCopyrightText: Copyright Corsinvest Srl 3 | * SPDX-License-Identifier: GPL-3.0-only 4 | */ 5 | package it.corsinvest.proxmoxve.api; 6 | 7 | import java.net.HttpURLConnection; 8 | import java.util.Map; 9 | import org.json.JSONException; 10 | import org.json.JSONObject; 11 | 12 | /** 13 | * Result request API 14 | */ 15 | public class Result { 16 | 17 | private final String _reasonPhrase; 18 | private final int _statusCode; 19 | private final JSONObject _response; 20 | private final String _requestResource; 21 | private final Map _requestParameters; 22 | private final MethodType _methodType; 23 | private final ResponseType _responseType; 24 | 25 | protected Result(JSONObject response, 26 | int statusCode, 27 | String reasonPhrase, 28 | String requestResource, 29 | Map requestParameters, 30 | MethodType methodType, 31 | ResponseType responseType) { 32 | _response = response; 33 | _statusCode = statusCode; 34 | _reasonPhrase = reasonPhrase; 35 | _requestResource = requestResource; 36 | _requestParameters = requestParameters; 37 | _methodType = methodType; 38 | _responseType = responseType; 39 | } 40 | 41 | /** 42 | * Method type 43 | * 44 | * @return 45 | */ 46 | public MethodType getMethodType() { 47 | return _methodType; 48 | } 49 | 50 | /** 51 | * Response Type 52 | * 53 | * @return 54 | */ 55 | public ResponseType getResponseType() { 56 | return _responseType; 57 | } 58 | 59 | /** 60 | * Resource request 61 | * 62 | * @return 63 | */ 64 | public String getRequestResource() { 65 | return _requestResource; 66 | } 67 | 68 | /** 69 | * Request parameter 70 | * 71 | * @return 72 | */ 73 | public Map getRequestParameters() { 74 | return _requestParameters; 75 | } 76 | 77 | /** 78 | * Gets the reason phrase which typically is sent by servers together with 79 | * the status code. 80 | * 81 | * @return 82 | */ 83 | public String getReasonPhrase() { 84 | return _reasonPhrase; 85 | } 86 | 87 | /** 88 | * Contains the values of status codes defined for HTTP. 89 | * 90 | * @return 91 | */ 92 | public int getStatusCode() { 93 | return _statusCode; 94 | } 95 | 96 | /** 97 | * Gets a value that indicates if the HTTP response was successful. 98 | * 99 | * @return 100 | */ 101 | public boolean isSuccessStatusCode() { 102 | return _statusCode == HttpURLConnection.HTTP_OK; 103 | } 104 | 105 | /** 106 | * Proxmox VE response. 107 | * 108 | * @return JSONObject 109 | */ 110 | public JSONObject getResponse() { 111 | return _response; 112 | } 113 | 114 | /** 115 | * Get if response Proxmox VE contain errors 116 | * 117 | * @return 118 | * @throws org.json.JSONException 119 | */ 120 | public boolean responseInError() throws JSONException { 121 | return !_response.isNull("errors"); 122 | } 123 | 124 | /** 125 | * Get error 126 | * 127 | * @return 128 | * @throws org.json.JSONException 129 | */ 130 | public String getError() throws JSONException { 131 | StringBuilder ret = new StringBuilder(); 132 | if (responseInError()) { 133 | JSONObject errors = _response.getJSONObject("errors"); 134 | for (int i = 0; i < errors.names().length(); i++) { 135 | if (ret.length() > 0) { 136 | ret.append("\n"); 137 | } 138 | 139 | String name = errors.names().getString(i); 140 | ret.append(name).append(" : ").append(errors.get(name)); 141 | } 142 | } 143 | return ret.toString(); 144 | } 145 | } 146 | -------------------------------------------------------------------------------- /src/test/java/Test.java: -------------------------------------------------------------------------------- 1 | /* 2 | * SPDX-FileCopyrightText: Copyright Corsinvest Srl 3 | * SPDX-License-Identifier: GPL-3.0-only 4 | */ 5 | import it.corsinvest.proxmoxve.api.*; 6 | import java.util.ArrayList; 7 | import java.util.List; 8 | import org.json.JSONArray; 9 | import org.json.JSONException; 10 | import org.json.JSONObject; 11 | 12 | public class Test { 13 | 14 | public static void main(String[] args) throws JSONException ,PveExceptionAuthentication{ 15 | PveClient client = new PveClient("192.168.0.2", 8006); 16 | client.setDebugLevel(999); 17 | if (client.login("root", "password")) { 18 | //version 19 | System.out.println(client.getVersion().version().getResponse().get("data")); 20 | 21 | // same for put/post/delete 22 | //loop nodes for 23 | JSONArray nodes = client.getNodes().index().getResponse().getJSONArray("data"); 24 | for (int i = 0; i < nodes.length(); i++) { 25 | System.out.println(nodes.get(i)); 26 | } 27 | 28 | //loop nodes for each 29 | PveClientBase.JSONArrayToList(client.getNodes().index().getResponse().getJSONArray("data")).forEach((node) -> { 30 | System.out.println(node); 31 | }); 32 | 33 | List commands = new ArrayList<>(); 34 | commands.add("powershell"); 35 | commands.add("-command"); 36 | commands.add("echo"); 37 | commands.add("test"); 38 | 39 | client.getNodes().get("cc01").getQemu().get(1006).getAgent().getExec().exec(commands); 40 | 41 | /* 42 | String nodeId = "cv-pve02"; 43 | 44 | //loops vms qemu 45 | JSONArray vms = client.getNodes().get(nodeId).getQemu().vmlist().getResponse().getJSONArray("data"); 46 | for (int i = 0; i < vms.length(); i++) { 47 | System.out.println(vms.get(i)); 48 | } 49 | 50 | //loop snapshots 51 | JSONArray snapshots = client.getNodes().get(nodeId) 52 | .getQemu().get(100).getSnapshot().snapshotList().getResponse().getJSONArray("data"); 53 | for (int i = 0; i < snapshots.length(); i++) { 54 | System.out.println(snapshots.get(i)); 55 | } 56 | 57 | //create snapshot 58 | client.getNodes().get(nodeId).getQemu().get(100).getSnapshot().snapshot("pippo"); 59 | JSONObject retCreateSnap = client.getNodes().get(nodeId).getQemu().get(100).getSnapshot().snapshot("pippo").getResponse(); 60 | 61 | //print UPID 62 | System.out.println(retCreateSnap.get("data")); 63 | 64 | //wait creation 65 | client.waitForTaskToFinish(retCreateSnap.getString("data"), 500, 10000); 66 | 67 | //delete snapshot 68 | Result retDeleSnap = client.getNodes().get(nodeId).getQemu().get(100).getSnapshot().get("pippo").delsnapshot(); 69 | System.out.println(retDeleSnap.getResponse().get("data")); 70 | */ 71 | } 72 | } 73 | } 74 | --------------------------------------------------------------------------------