ibm_cloud_power 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (330) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +255 -0
  4. data/Rakefile +10 -0
  5. data/docs/CloneTaskReference.md +19 -0
  6. data/docs/CloneTaskStatus.md +23 -0
  7. data/docs/ClonedVolume.md +19 -0
  8. data/docs/ClonedVolumeDetail.md +19 -0
  9. data/docs/CloudInstance.md +37 -0
  10. data/docs/CloudInstanceCreate.md +29 -0
  11. data/docs/CloudInstanceReference.md +31 -0
  12. data/docs/CloudInstanceUpdate.md +25 -0
  13. data/docs/CloudInstanceUsageLimits.md +37 -0
  14. data/docs/CreateDataVolume.md +29 -0
  15. data/docs/CreateImage.md +37 -0
  16. data/docs/Error.md +19 -0
  17. data/docs/Event.md +33 -0
  18. data/docs/EventUser.md +21 -0
  19. data/docs/Events.md +17 -0
  20. data/docs/ExportImage.md +23 -0
  21. data/docs/IPAddressRange.md +19 -0
  22. data/docs/Image.md +39 -0
  23. data/docs/ImageReference.md +33 -0
  24. data/docs/ImageSpecifications.md +29 -0
  25. data/docs/ImageVolume.md +23 -0
  26. data/docs/Images.md +17 -0
  27. data/docs/MinMaxDefault.md +21 -0
  28. data/docs/MultiVolumesCreate.md +29 -0
  29. data/docs/Network.md +37 -0
  30. data/docs/NetworkCreate.md +29 -0
  31. data/docs/NetworkIpAddressMetrics.md +23 -0
  32. data/docs/NetworkPort.md +29 -0
  33. data/docs/NetworkPortCreate.md +19 -0
  34. data/docs/NetworkPortPvmInstance.md +19 -0
  35. data/docs/NetworkPortUpdate.md +19 -0
  36. data/docs/NetworkPorts.md +17 -0
  37. data/docs/NetworkReference.md +27 -0
  38. data/docs/NetworkUpdate.md +23 -0
  39. data/docs/Networks.md +17 -0
  40. data/docs/Operations.md +21 -0
  41. data/docs/PCloudEventsApi.md +114 -0
  42. data/docs/PCloudImagesApi.md +342 -0
  43. data/docs/PCloudInstancesApi.md +148 -0
  44. data/docs/PCloudNetworksApi.md +504 -0
  45. data/docs/PCloudPVMInstancesApi.md +809 -0
  46. data/docs/PCloudSAPApi.md +150 -0
  47. data/docs/PCloudSnapshotsApi.md +200 -0
  48. data/docs/PCloudSystemPoolsApi.md +54 -0
  49. data/docs/PCloudTasksApi.md +100 -0
  50. data/docs/PCloudTenantsApi.md +102 -0
  51. data/docs/PCloudTenantsSSHKeysApi.md +248 -0
  52. data/docs/PCloudVolumesApi.md +746 -0
  53. data/docs/PVMInstance.md +77 -0
  54. data/docs/PVMInstanceAction.md +17 -0
  55. data/docs/PVMInstanceAddNetwork.md +19 -0
  56. data/docs/PVMInstanceCapture.md +29 -0
  57. data/docs/PVMInstanceClone.md +31 -0
  58. data/docs/PVMInstanceConsole.md +17 -0
  59. data/docs/PVMInstanceCreate.md +53 -0
  60. data/docs/PVMInstanceFault.md +23 -0
  61. data/docs/PVMInstanceHealth.md +21 -0
  62. data/docs/PVMInstanceMultiCreate.md +21 -0
  63. data/docs/PVMInstanceNetwork.md +33 -0
  64. data/docs/PVMInstanceNetworks.md +17 -0
  65. data/docs/PVMInstanceOperation.md +19 -0
  66. data/docs/PVMInstanceReference.md +71 -0
  67. data/docs/PVMInstanceRemoveNetwork.md +17 -0
  68. data/docs/PVMInstanceUpdate.md +33 -0
  69. data/docs/PVMInstanceUpdateResponse.md +27 -0
  70. data/docs/PVMInstanceVolumeUpdate.md +17 -0
  71. data/docs/PVMInstances.md +17 -0
  72. data/docs/PeeringNetwork.md +21 -0
  73. data/docs/PinPolicy.md +16 -0
  74. data/docs/SAPCreate.md +33 -0
  75. data/docs/SAPProfile.md +25 -0
  76. data/docs/SAPProfileReference.md +19 -0
  77. data/docs/SAPProfiles.md +17 -0
  78. data/docs/SRC.md +19 -0
  79. data/docs/SSHKey.md +21 -0
  80. data/docs/SSHKeys.md +17 -0
  81. data/docs/Snapshot.md +35 -0
  82. data/docs/SnapshotCreate.md +21 -0
  83. data/docs/SnapshotCreateResponse.md +17 -0
  84. data/docs/SnapshotRestore.md +17 -0
  85. data/docs/SnapshotUpdate.md +19 -0
  86. data/docs/Snapshots.md +17 -0
  87. data/docs/SoftwareLicenses.md +25 -0
  88. data/docs/StockImage.md +21 -0
  89. data/docs/System.md +21 -0
  90. data/docs/SystemPool.md +31 -0
  91. data/docs/Task.md +33 -0
  92. data/docs/TaskReference.md +19 -0
  93. data/docs/Tenant.md +29 -0
  94. data/docs/TenantUpdate.md +19 -0
  95. data/docs/UpdateVolume.md +23 -0
  96. data/docs/VirtualCores.md +21 -0
  97. data/docs/Volume.md +41 -0
  98. data/docs/VolumeInfo.md +19 -0
  99. data/docs/VolumeReference.md +43 -0
  100. data/docs/Volumes.md +17 -0
  101. data/docs/VolumesClone.md +31 -0
  102. data/docs/VolumesCloneAsyncRequest.md +19 -0
  103. data/docs/VolumesCloneCancel.md +17 -0
  104. data/docs/VolumesCloneCreate.md +19 -0
  105. data/docs/VolumesCloneDetail.md +33 -0
  106. data/docs/VolumesCloneExecute.md +19 -0
  107. data/docs/VolumesCloneRequest.md +19 -0
  108. data/docs/VolumesCloneResponse.md +17 -0
  109. data/docs/VolumesClones.md +17 -0
  110. data/git_push.sh +58 -0
  111. data/ibm_cloud_power.gemspec +38 -0
  112. data/lib/ibm_cloud_power.rb +144 -0
  113. data/lib/ibm_cloud_power/api/p_cloud_events_api.rb +163 -0
  114. data/lib/ibm_cloud_power/api/p_cloud_images_api.rb +473 -0
  115. data/lib/ibm_cloud_power/api/p_cloud_instances_api.rb +210 -0
  116. data/lib/ibm_cloud_power/api/p_cloud_networks_api.rb +719 -0
  117. data/lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb +1166 -0
  118. data/lib/ibm_cloud_power/api/p_cloud_sap_api.rb +216 -0
  119. data/lib/ibm_cloud_power/api/p_cloud_snapshots_api.rb +288 -0
  120. data/lib/ibm_cloud_power/api/p_cloud_system_pools_api.rb +82 -0
  121. data/lib/ibm_cloud_power/api/p_cloud_tasks_api.rb +142 -0
  122. data/lib/ibm_cloud_power/api/p_cloud_tenants_api.rb +150 -0
  123. data/lib/ibm_cloud_power/api/p_cloud_tenants_ssh_keys_api.rb +356 -0
  124. data/lib/ibm_cloud_power/api/p_cloud_volumes_api.rb +1065 -0
  125. data/lib/ibm_cloud_power/api_client.rb +387 -0
  126. data/lib/ibm_cloud_power/api_error.rb +57 -0
  127. data/lib/ibm_cloud_power/configuration.rb +241 -0
  128. data/lib/ibm_cloud_power/models/clone_task_reference.rb +229 -0
  129. data/lib/ibm_cloud_power/models/clone_task_status.rb +285 -0
  130. data/lib/ibm_cloud_power/models/cloned_volume.rb +219 -0
  131. data/lib/ibm_cloud_power/models/cloned_volume_detail.rb +227 -0
  132. data/lib/ibm_cloud_power/models/cloud_instance.rb +361 -0
  133. data/lib/ibm_cloud_power/models/cloud_instance_create.rb +294 -0
  134. data/lib/ibm_cloud_power/models/cloud_instance_reference.rb +315 -0
  135. data/lib/ibm_cloud_power/models/cloud_instance_update.rb +249 -0
  136. data/lib/ibm_cloud_power/models/cloud_instance_usage_limits.rb +334 -0
  137. data/lib/ibm_cloud_power/models/create_data_volume.rb +313 -0
  138. data/lib/ibm_cloud_power/models/create_image.rb +360 -0
  139. data/lib/ibm_cloud_power/models/error.rb +217 -0
  140. data/lib/ibm_cloud_power/models/event.rb +357 -0
  141. data/lib/ibm_cloud_power/models/event_user.rb +234 -0
  142. data/lib/ibm_cloud_power/models/events.rb +216 -0
  143. data/lib/ibm_cloud_power/models/export_image.rb +249 -0
  144. data/lib/ibm_cloud_power/models/image.rb +351 -0
  145. data/lib/ibm_cloud_power/models/image_reference.rb +333 -0
  146. data/lib/ibm_cloud_power/models/image_specifications.rb +269 -0
  147. data/lib/ibm_cloud_power/models/image_volume.rb +259 -0
  148. data/lib/ibm_cloud_power/models/images.rb +216 -0
  149. data/lib/ibm_cloud_power/models/ip_address_range.rb +229 -0
  150. data/lib/ibm_cloud_power/models/min_max_default.rb +244 -0
  151. data/lib/ibm_cloud_power/models/multi_volumes_create.rb +313 -0
  152. data/lib/ibm_cloud_power/models/network.rb +395 -0
  153. data/lib/ibm_cloud_power/models/network_create.rb +314 -0
  154. data/lib/ibm_cloud_power/models/network_ip_address_metrics.rb +260 -0
  155. data/lib/ibm_cloud_power/models/network_port.rb +293 -0
  156. data/lib/ibm_cloud_power/models/network_port_create.rb +219 -0
  157. data/lib/ibm_cloud_power/models/network_port_pvm_instance.rb +220 -0
  158. data/lib/ibm_cloud_power/models/network_port_update.rb +219 -0
  159. data/lib/ibm_cloud_power/models/network_ports.rb +216 -0
  160. data/lib/ibm_cloud_power/models/network_reference.rb +325 -0
  161. data/lib/ibm_cloud_power/models/network_update.rb +243 -0
  162. data/lib/ibm_cloud_power/models/networks.rb +216 -0
  163. data/lib/ibm_cloud_power/models/operations.rb +287 -0
  164. data/lib/ibm_cloud_power/models/peering_network.rb +241 -0
  165. data/lib/ibm_cloud_power/models/pin_policy.rb +37 -0
  166. data/lib/ibm_cloud_power/models/pvm_instance.rb +612 -0
  167. data/lib/ibm_cloud_power/models/pvm_instance_action.rb +248 -0
  168. data/lib/ibm_cloud_power/models/pvm_instance_add_network.rb +224 -0
  169. data/lib/ibm_cloud_power/models/pvm_instance_capture.rb +317 -0
  170. data/lib/ibm_cloud_power/models/pvm_instance_clone.rb +328 -0
  171. data/lib/ibm_cloud_power/models/pvm_instance_console.rb +214 -0
  172. data/lib/ibm_cloud_power/models/pvm_instance_create.rb +483 -0
  173. data/lib/ibm_cloud_power/models/pvm_instance_fault.rb +240 -0
  174. data/lib/ibm_cloud_power/models/pvm_instance_health.rb +230 -0
  175. data/lib/ibm_cloud_power/models/pvm_instance_multi_create.rb +279 -0
  176. data/lib/ibm_cloud_power/models/pvm_instance_network.rb +290 -0
  177. data/lib/ibm_cloud_power/models/pvm_instance_networks.rb +216 -0
  178. data/lib/ibm_cloud_power/models/pvm_instance_operation.rb +262 -0
  179. data/lib/ibm_cloud_power/models/pvm_instance_reference.rb +566 -0
  180. data/lib/ibm_cloud_power/models/pvm_instance_remove_network.rb +209 -0
  181. data/lib/ibm_cloud_power/models/pvm_instance_update.rb +322 -0
  182. data/lib/ibm_cloud_power/models/pvm_instance_update_response.rb +292 -0
  183. data/lib/ibm_cloud_power/models/pvm_instance_volume_update.rb +214 -0
  184. data/lib/ibm_cloud_power/models/pvm_instances.rb +216 -0
  185. data/lib/ibm_cloud_power/models/sap_create.rb +311 -0
  186. data/lib/ibm_cloud_power/models/sap_profile.rb +310 -0
  187. data/lib/ibm_cloud_power/models/sap_profile_reference.rb +229 -0
  188. data/lib/ibm_cloud_power/models/sap_profiles.rb +216 -0
  189. data/lib/ibm_cloud_power/models/snapshot.rb +321 -0
  190. data/lib/ibm_cloud_power/models/snapshot_create.rb +236 -0
  191. data/lib/ibm_cloud_power/models/snapshot_create_response.rb +214 -0
  192. data/lib/ibm_cloud_power/models/snapshot_restore.rb +211 -0
  193. data/lib/ibm_cloud_power/models/snapshot_update.rb +219 -0
  194. data/lib/ibm_cloud_power/models/snapshots.rb +216 -0
  195. data/lib/ibm_cloud_power/models/software_licenses.rb +257 -0
  196. data/lib/ibm_cloud_power/models/src.rb +219 -0
  197. data/lib/ibm_cloud_power/models/ssh_key.rb +239 -0
  198. data/lib/ibm_cloud_power/models/ssh_keys.rb +216 -0
  199. data/lib/ibm_cloud_power/models/stock_image.rb +230 -0
  200. data/lib/ibm_cloud_power/models/system.rb +239 -0
  201. data/lib/ibm_cloud_power/models/system_pool.rb +277 -0
  202. data/lib/ibm_cloud_power/models/task.rb +334 -0
  203. data/lib/ibm_cloud_power/models/task_reference.rb +229 -0
  204. data/lib/ibm_cloud_power/models/tenant.rb +295 -0
  205. data/lib/ibm_cloud_power/models/tenant_update.rb +221 -0
  206. data/lib/ibm_cloud_power/models/update_volume.rb +239 -0
  207. data/lib/ibm_cloud_power/models/virtual_cores.rb +253 -0
  208. data/lib/ibm_cloud_power/models/volume.rb +356 -0
  209. data/lib/ibm_cloud_power/models/volume_info.rb +219 -0
  210. data/lib/ibm_cloud_power/models/volume_reference.rb +396 -0
  211. data/lib/ibm_cloud_power/models/volumes.rb +216 -0
  212. data/lib/ibm_cloud_power/models/volumes_clone.rb +284 -0
  213. data/lib/ibm_cloud_power/models/volumes_clone_async_request.rb +231 -0
  214. data/lib/ibm_cloud_power/models/volumes_clone_cancel.rb +209 -0
  215. data/lib/ibm_cloud_power/models/volumes_clone_create.rb +231 -0
  216. data/lib/ibm_cloud_power/models/volumes_clone_detail.rb +296 -0
  217. data/lib/ibm_cloud_power/models/volumes_clone_execute.rb +224 -0
  218. data/lib/ibm_cloud_power/models/volumes_clone_request.rb +231 -0
  219. data/lib/ibm_cloud_power/models/volumes_clone_response.rb +211 -0
  220. data/lib/ibm_cloud_power/models/volumes_clones.rb +211 -0
  221. data/lib/ibm_cloud_power/version.rb +15 -0
  222. data/spec/api/p_cloud_events_api_spec.rb +62 -0
  223. data/spec/api/p_cloud_images_api_spec.rb +117 -0
  224. data/spec/api/p_cloud_instances_api_spec.rb +69 -0
  225. data/spec/api/p_cloud_networks_api_spec.rb +161 -0
  226. data/spec/api/p_cloud_pvm_instances_api_spec.rb +240 -0
  227. data/spec/api/p_cloud_sap_api_spec.rb +70 -0
  228. data/spec/api/p_cloud_snapshots_api_spec.rb +83 -0
  229. data/spec/api/p_cloud_system_pools_api_spec.rb +46 -0
  230. data/spec/api/p_cloud_tasks_api_spec.rb +57 -0
  231. data/spec/api/p_cloud_tenants_api_spec.rb +58 -0
  232. data/spec/api/p_cloud_tenants_ssh_keys_api_spec.rb +95 -0
  233. data/spec/api/p_cloud_volumes_api_spec.rb +223 -0
  234. data/spec/api_client_spec.rb +226 -0
  235. data/spec/configuration_spec.rb +42 -0
  236. data/spec/models/clone_task_reference_spec.rb +47 -0
  237. data/spec/models/clone_task_status_spec.rb +63 -0
  238. data/spec/models/cloned_volume_detail_spec.rb +47 -0
  239. data/spec/models/cloned_volume_spec.rb +47 -0
  240. data/spec/models/cloud_instance_create_spec.rb +77 -0
  241. data/spec/models/cloud_instance_reference_spec.rb +83 -0
  242. data/spec/models/cloud_instance_spec.rb +101 -0
  243. data/spec/models/cloud_instance_update_spec.rb +65 -0
  244. data/spec/models/cloud_instance_usage_limits_spec.rb +101 -0
  245. data/spec/models/create_data_volume_spec.rb +81 -0
  246. data/spec/models/create_image_spec.rb +109 -0
  247. data/spec/models/error_spec.rb +47 -0
  248. data/spec/models/event_spec.rb +93 -0
  249. data/spec/models/event_user_spec.rb +53 -0
  250. data/spec/models/events_spec.rb +41 -0
  251. data/spec/models/export_image_spec.rb +59 -0
  252. data/spec/models/image_reference_spec.rb +89 -0
  253. data/spec/models/image_spec.rb +107 -0
  254. data/spec/models/image_specifications_spec.rb +77 -0
  255. data/spec/models/image_volume_spec.rb +59 -0
  256. data/spec/models/images_spec.rb +41 -0
  257. data/spec/models/ip_address_range_spec.rb +47 -0
  258. data/spec/models/min_max_default_spec.rb +53 -0
  259. data/spec/models/multi_volumes_create_spec.rb +81 -0
  260. data/spec/models/network_create_spec.rb +81 -0
  261. data/spec/models/network_ip_address_metrics_spec.rb +59 -0
  262. data/spec/models/network_port_create_spec.rb +47 -0
  263. data/spec/models/network_port_pvm_instance_spec.rb +47 -0
  264. data/spec/models/network_port_spec.rb +77 -0
  265. data/spec/models/network_port_update_spec.rb +47 -0
  266. data/spec/models/network_ports_spec.rb +41 -0
  267. data/spec/models/network_reference_spec.rb +75 -0
  268. data/spec/models/network_spec.rb +105 -0
  269. data/spec/models/network_update_spec.rb +59 -0
  270. data/spec/models/networks_spec.rb +41 -0
  271. data/spec/models/operations_spec.rb +65 -0
  272. data/spec/models/peering_network_spec.rb +53 -0
  273. data/spec/models/pin_policy_spec.rb +35 -0
  274. data/spec/models/pvm_instance_action_spec.rb +45 -0
  275. data/spec/models/pvm_instance_add_network_spec.rb +47 -0
  276. data/spec/models/pvm_instance_capture_spec.rb +81 -0
  277. data/spec/models/pvm_instance_clone_spec.rb +87 -0
  278. data/spec/models/pvm_instance_console_spec.rb +41 -0
  279. data/spec/models/pvm_instance_create_spec.rb +161 -0
  280. data/spec/models/pvm_instance_fault_spec.rb +59 -0
  281. data/spec/models/pvm_instance_health_spec.rb +53 -0
  282. data/spec/models/pvm_instance_multi_create_spec.rb +61 -0
  283. data/spec/models/pvm_instance_network_spec.rb +89 -0
  284. data/spec/models/pvm_instance_networks_spec.rb +41 -0
  285. data/spec/models/pvm_instance_operation_spec.rb +51 -0
  286. data/spec/models/pvm_instance_reference_spec.rb +207 -0
  287. data/spec/models/pvm_instance_remove_network_spec.rb +41 -0
  288. data/spec/models/pvm_instance_spec.rb +225 -0
  289. data/spec/models/pvm_instance_update_response_spec.rb +75 -0
  290. data/spec/models/pvm_instance_update_spec.rb +93 -0
  291. data/spec/models/pvm_instance_volume_update_spec.rb +41 -0
  292. data/spec/models/pvm_instances_spec.rb +41 -0
  293. data/spec/models/sap_create_spec.rb +89 -0
  294. data/spec/models/sap_profile_reference_spec.rb +47 -0
  295. data/spec/models/sap_profile_spec.rb +69 -0
  296. data/spec/models/sap_profiles_spec.rb +41 -0
  297. data/spec/models/snapshot_create_response_spec.rb +41 -0
  298. data/spec/models/snapshot_create_spec.rb +53 -0
  299. data/spec/models/snapshot_restore_spec.rb +41 -0
  300. data/spec/models/snapshot_spec.rb +95 -0
  301. data/spec/models/snapshot_update_spec.rb +47 -0
  302. data/spec/models/snapshots_spec.rb +41 -0
  303. data/spec/models/software_licenses_spec.rb +65 -0
  304. data/spec/models/src_spec.rb +47 -0
  305. data/spec/models/ssh_key_spec.rb +53 -0
  306. data/spec/models/ssh_keys_spec.rb +41 -0
  307. data/spec/models/stock_image_spec.rb +53 -0
  308. data/spec/models/system_pool_spec.rb +83 -0
  309. data/spec/models/system_spec.rb +53 -0
  310. data/spec/models/task_reference_spec.rb +47 -0
  311. data/spec/models/task_spec.rb +89 -0
  312. data/spec/models/tenant_spec.rb +77 -0
  313. data/spec/models/tenant_update_spec.rb +47 -0
  314. data/spec/models/update_volume_spec.rb +59 -0
  315. data/spec/models/virtual_cores_spec.rb +53 -0
  316. data/spec/models/volume_info_spec.rb +47 -0
  317. data/spec/models/volume_reference_spec.rb +119 -0
  318. data/spec/models/volume_spec.rb +113 -0
  319. data/spec/models/volumes_clone_async_request_spec.rb +47 -0
  320. data/spec/models/volumes_clone_cancel_spec.rb +41 -0
  321. data/spec/models/volumes_clone_create_spec.rb +47 -0
  322. data/spec/models/volumes_clone_detail_spec.rb +89 -0
  323. data/spec/models/volumes_clone_execute_spec.rb +47 -0
  324. data/spec/models/volumes_clone_request_spec.rb +47 -0
  325. data/spec/models/volumes_clone_response_spec.rb +47 -0
  326. data/spec/models/volumes_clone_spec.rb +83 -0
  327. data/spec/models/volumes_clones_spec.rb +41 -0
  328. data/spec/models/volumes_spec.rb +41 -0
  329. data/spec/spec_helper.rb +111 -0
  330. metadata +519 -0
@@ -0,0 +1,102 @@
1
+ # IbmCloudPower::PCloudTenantsApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**pcloud_tenants_get**](PCloudTenantsApi.md#pcloud_tenants_get) | **GET** /pcloud/v1/tenants/{tenant_id} | Get a tenant's current state or information
8
+ [**pcloud_tenants_put**](PCloudTenantsApi.md#pcloud_tenants_put) | **PUT** /pcloud/v1/tenants/{tenant_id} | Update a tenant
9
+
10
+
11
+
12
+ ## pcloud_tenants_get
13
+
14
+ > Tenant pcloud_tenants_get(tenant_id)
15
+
16
+ Get a tenant's current state or information
17
+
18
+ ### Example
19
+
20
+ ```ruby
21
+ # load the gem
22
+ require 'ibm_cloud_power'
23
+
24
+ api_instance = IbmCloudPower::PCloudTenantsApi.new
25
+ tenant_id = 'tenant_id_example' # String | Tenant ID of a pcloud tenant
26
+
27
+ begin
28
+ #Get a tenant's current state or information
29
+ result = api_instance.pcloud_tenants_get(tenant_id)
30
+ p result
31
+ rescue IbmCloudPower::ApiError => e
32
+ puts "Exception when calling PCloudTenantsApi->pcloud_tenants_get: #{e}"
33
+ end
34
+ ```
35
+
36
+ ### Parameters
37
+
38
+
39
+ Name | Type | Description | Notes
40
+ ------------- | ------------- | ------------- | -------------
41
+ **tenant_id** | **String**| Tenant ID of a pcloud tenant |
42
+
43
+ ### Return type
44
+
45
+ [**Tenant**](Tenant.md)
46
+
47
+ ### Authorization
48
+
49
+ No authorization required
50
+
51
+ ### HTTP request headers
52
+
53
+ - **Content-Type**: Not defined
54
+ - **Accept**: application/json
55
+
56
+
57
+ ## pcloud_tenants_put
58
+
59
+ > Tenant pcloud_tenants_put(tenant_id, body)
60
+
61
+ Update a tenant
62
+
63
+ ### Example
64
+
65
+ ```ruby
66
+ # load the gem
67
+ require 'ibm_cloud_power'
68
+
69
+ api_instance = IbmCloudPower::PCloudTenantsApi.new
70
+ tenant_id = 'tenant_id_example' # String | Tenant ID of a pcloud tenant
71
+ body = IbmCloudPower::TenantUpdate.new # TenantUpdate | Parameters for updating a Tenant
72
+
73
+ begin
74
+ #Update a tenant
75
+ result = api_instance.pcloud_tenants_put(tenant_id, body)
76
+ p result
77
+ rescue IbmCloudPower::ApiError => e
78
+ puts "Exception when calling PCloudTenantsApi->pcloud_tenants_put: #{e}"
79
+ end
80
+ ```
81
+
82
+ ### Parameters
83
+
84
+
85
+ Name | Type | Description | Notes
86
+ ------------- | ------------- | ------------- | -------------
87
+ **tenant_id** | **String**| Tenant ID of a pcloud tenant |
88
+ **body** | [**TenantUpdate**](TenantUpdate.md)| Parameters for updating a Tenant |
89
+
90
+ ### Return type
91
+
92
+ [**Tenant**](Tenant.md)
93
+
94
+ ### Authorization
95
+
96
+ No authorization required
97
+
98
+ ### HTTP request headers
99
+
100
+ - **Content-Type**: application/json
101
+ - **Accept**: application/json
102
+
@@ -0,0 +1,248 @@
1
+ # IbmCloudPower::PCloudTenantsSSHKeysApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**pcloud_tenants_sshkeys_delete**](PCloudTenantsSSHKeysApi.md#pcloud_tenants_sshkeys_delete) | **DELETE** /pcloud/v1/tenants/{tenant_id}/sshkeys/{sshkey_name} | Delete a tenant's SSH key
8
+ [**pcloud_tenants_sshkeys_get**](PCloudTenantsSSHKeysApi.md#pcloud_tenants_sshkeys_get) | **GET** /pcloud/v1/tenants/{tenant_id}/sshkeys/{sshkey_name} | Get a tenant's SSH Key by name
9
+ [**pcloud_tenants_sshkeys_getall**](PCloudTenantsSSHKeysApi.md#pcloud_tenants_sshkeys_getall) | **GET** /pcloud/v1/tenants/{tenant_id}/sshkeys | List a tenant's SSH Keys
10
+ [**pcloud_tenants_sshkeys_post**](PCloudTenantsSSHKeysApi.md#pcloud_tenants_sshkeys_post) | **POST** /pcloud/v1/tenants/{tenant_id}/sshkeys | Add a new SSH key to the tenant
11
+ [**pcloud_tenants_sshkeys_put**](PCloudTenantsSSHKeysApi.md#pcloud_tenants_sshkeys_put) | **PUT** /pcloud/v1/tenants/{tenant_id}/sshkeys/{sshkey_name} | Update an SSH Key
12
+
13
+
14
+
15
+ ## pcloud_tenants_sshkeys_delete
16
+
17
+ > Object pcloud_tenants_sshkeys_delete(tenant_id, sshkey_name)
18
+
19
+ Delete a tenant's SSH key
20
+
21
+ ### Example
22
+
23
+ ```ruby
24
+ # load the gem
25
+ require 'ibm_cloud_power'
26
+
27
+ api_instance = IbmCloudPower::PCloudTenantsSSHKeysApi.new
28
+ tenant_id = 'tenant_id_example' # String | Tenant ID of a pcloud tenant
29
+ sshkey_name = 'sshkey_name_example' # String | SSH key name for a pcloud tenant
30
+
31
+ begin
32
+ #Delete a tenant's SSH key
33
+ result = api_instance.pcloud_tenants_sshkeys_delete(tenant_id, sshkey_name)
34
+ p result
35
+ rescue IbmCloudPower::ApiError => e
36
+ puts "Exception when calling PCloudTenantsSSHKeysApi->pcloud_tenants_sshkeys_delete: #{e}"
37
+ end
38
+ ```
39
+
40
+ ### Parameters
41
+
42
+
43
+ Name | Type | Description | Notes
44
+ ------------- | ------------- | ------------- | -------------
45
+ **tenant_id** | **String**| Tenant ID of a pcloud tenant |
46
+ **sshkey_name** | **String**| SSH key name for a pcloud tenant |
47
+
48
+ ### Return type
49
+
50
+ **Object**
51
+
52
+ ### Authorization
53
+
54
+ No authorization required
55
+
56
+ ### HTTP request headers
57
+
58
+ - **Content-Type**: Not defined
59
+ - **Accept**: */*
60
+
61
+
62
+ ## pcloud_tenants_sshkeys_get
63
+
64
+ > SSHKey pcloud_tenants_sshkeys_get(tenant_id, sshkey_name)
65
+
66
+ Get a tenant's SSH Key by name
67
+
68
+ ### Example
69
+
70
+ ```ruby
71
+ # load the gem
72
+ require 'ibm_cloud_power'
73
+
74
+ api_instance = IbmCloudPower::PCloudTenantsSSHKeysApi.new
75
+ tenant_id = 'tenant_id_example' # String | Tenant ID of a pcloud tenant
76
+ sshkey_name = 'sshkey_name_example' # String | SSH key name for a pcloud tenant
77
+
78
+ begin
79
+ #Get a tenant's SSH Key by name
80
+ result = api_instance.pcloud_tenants_sshkeys_get(tenant_id, sshkey_name)
81
+ p result
82
+ rescue IbmCloudPower::ApiError => e
83
+ puts "Exception when calling PCloudTenantsSSHKeysApi->pcloud_tenants_sshkeys_get: #{e}"
84
+ end
85
+ ```
86
+
87
+ ### Parameters
88
+
89
+
90
+ Name | Type | Description | Notes
91
+ ------------- | ------------- | ------------- | -------------
92
+ **tenant_id** | **String**| Tenant ID of a pcloud tenant |
93
+ **sshkey_name** | **String**| SSH key name for a pcloud tenant |
94
+
95
+ ### Return type
96
+
97
+ [**SSHKey**](SSHKey.md)
98
+
99
+ ### Authorization
100
+
101
+ No authorization required
102
+
103
+ ### HTTP request headers
104
+
105
+ - **Content-Type**: Not defined
106
+ - **Accept**: application/json
107
+
108
+
109
+ ## pcloud_tenants_sshkeys_getall
110
+
111
+ > SSHKeys pcloud_tenants_sshkeys_getall(tenant_id)
112
+
113
+ List a tenant's SSH Keys
114
+
115
+ ### Example
116
+
117
+ ```ruby
118
+ # load the gem
119
+ require 'ibm_cloud_power'
120
+
121
+ api_instance = IbmCloudPower::PCloudTenantsSSHKeysApi.new
122
+ tenant_id = 'tenant_id_example' # String | Tenant ID of a pcloud tenant
123
+
124
+ begin
125
+ #List a tenant's SSH Keys
126
+ result = api_instance.pcloud_tenants_sshkeys_getall(tenant_id)
127
+ p result
128
+ rescue IbmCloudPower::ApiError => e
129
+ puts "Exception when calling PCloudTenantsSSHKeysApi->pcloud_tenants_sshkeys_getall: #{e}"
130
+ end
131
+ ```
132
+
133
+ ### Parameters
134
+
135
+
136
+ Name | Type | Description | Notes
137
+ ------------- | ------------- | ------------- | -------------
138
+ **tenant_id** | **String**| Tenant ID of a pcloud tenant |
139
+
140
+ ### Return type
141
+
142
+ [**SSHKeys**](SSHKeys.md)
143
+
144
+ ### Authorization
145
+
146
+ No authorization required
147
+
148
+ ### HTTP request headers
149
+
150
+ - **Content-Type**: Not defined
151
+ - **Accept**: application/json
152
+
153
+
154
+ ## pcloud_tenants_sshkeys_post
155
+
156
+ > SSHKey pcloud_tenants_sshkeys_post(tenant_id, body)
157
+
158
+ Add a new SSH key to the tenant
159
+
160
+ ### Example
161
+
162
+ ```ruby
163
+ # load the gem
164
+ require 'ibm_cloud_power'
165
+
166
+ api_instance = IbmCloudPower::PCloudTenantsSSHKeysApi.new
167
+ tenant_id = 'tenant_id_example' # String | Tenant ID of a pcloud tenant
168
+ body = IbmCloudPower::SSHKey.new # SSHKey | Parameters for the creation of a new SSH key
169
+
170
+ begin
171
+ #Add a new SSH key to the tenant
172
+ result = api_instance.pcloud_tenants_sshkeys_post(tenant_id, body)
173
+ p result
174
+ rescue IbmCloudPower::ApiError => e
175
+ puts "Exception when calling PCloudTenantsSSHKeysApi->pcloud_tenants_sshkeys_post: #{e}"
176
+ end
177
+ ```
178
+
179
+ ### Parameters
180
+
181
+
182
+ Name | Type | Description | Notes
183
+ ------------- | ------------- | ------------- | -------------
184
+ **tenant_id** | **String**| Tenant ID of a pcloud tenant |
185
+ **body** | [**SSHKey**](SSHKey.md)| Parameters for the creation of a new SSH key |
186
+
187
+ ### Return type
188
+
189
+ [**SSHKey**](SSHKey.md)
190
+
191
+ ### Authorization
192
+
193
+ No authorization required
194
+
195
+ ### HTTP request headers
196
+
197
+ - **Content-Type**: application/json
198
+ - **Accept**: application/json
199
+
200
+
201
+ ## pcloud_tenants_sshkeys_put
202
+
203
+ > SSHKey pcloud_tenants_sshkeys_put(tenant_id, sshkey_name, body)
204
+
205
+ Update an SSH Key
206
+
207
+ ### Example
208
+
209
+ ```ruby
210
+ # load the gem
211
+ require 'ibm_cloud_power'
212
+
213
+ api_instance = IbmCloudPower::PCloudTenantsSSHKeysApi.new
214
+ tenant_id = 'tenant_id_example' # String | Tenant ID of a pcloud tenant
215
+ sshkey_name = 'sshkey_name_example' # String | SSH key name for a pcloud tenant
216
+ body = IbmCloudPower::SSHKey.new # SSHKey | Parameters for updating a Tenant's SSH Key
217
+
218
+ begin
219
+ #Update an SSH Key
220
+ result = api_instance.pcloud_tenants_sshkeys_put(tenant_id, sshkey_name, body)
221
+ p result
222
+ rescue IbmCloudPower::ApiError => e
223
+ puts "Exception when calling PCloudTenantsSSHKeysApi->pcloud_tenants_sshkeys_put: #{e}"
224
+ end
225
+ ```
226
+
227
+ ### Parameters
228
+
229
+
230
+ Name | Type | Description | Notes
231
+ ------------- | ------------- | ------------- | -------------
232
+ **tenant_id** | **String**| Tenant ID of a pcloud tenant |
233
+ **sshkey_name** | **String**| SSH key name for a pcloud tenant |
234
+ **body** | [**SSHKey**](SSHKey.md)| Parameters for updating a Tenant's SSH Key |
235
+
236
+ ### Return type
237
+
238
+ [**SSHKey**](SSHKey.md)
239
+
240
+ ### Authorization
241
+
242
+ No authorization required
243
+
244
+ ### HTTP request headers
245
+
246
+ - **Content-Type**: application/json
247
+ - **Accept**: application/json
248
+
@@ -0,0 +1,746 @@
1
+ # IbmCloudPower::PCloudVolumesApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**pcloud_cloudinstances_volumes_delete**](PCloudVolumesApi.md#pcloud_cloudinstances_volumes_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id} | Delete a cloud instance volume
8
+ [**pcloud_cloudinstances_volumes_get**](PCloudVolumesApi.md#pcloud_cloudinstances_volumes_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id} | Detailed information of a volume
9
+ [**pcloud_cloudinstances_volumes_getall**](PCloudVolumesApi.md#pcloud_cloudinstances_volumes_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes | List all volumes for this cloud instance
10
+ [**pcloud_cloudinstances_volumes_post**](PCloudVolumesApi.md#pcloud_cloudinstances_volumes_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes | Create a new data volume
11
+ [**pcloud_cloudinstances_volumes_put**](PCloudVolumesApi.md#pcloud_cloudinstances_volumes_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id} | Update a cloud instance volume
12
+ [**pcloud_pvminstances_volumes_delete**](PCloudVolumesApi.md#pcloud_pvminstances_volumes_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/volumes/{volume_id} | Detach a volume from a PVM Instance
13
+ [**pcloud_pvminstances_volumes_get**](PCloudVolumesApi.md#pcloud_pvminstances_volumes_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/volumes/{volume_id} | Detailed information of a volume attached to a PVM Instance
14
+ [**pcloud_pvminstances_volumes_getall**](PCloudVolumesApi.md#pcloud_pvminstances_volumes_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/volumes | List all volumes attached to a PVM Instance
15
+ [**pcloud_pvminstances_volumes_post**](PCloudVolumesApi.md#pcloud_pvminstances_volumes_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/volumes/{volume_id} | Attach a volume to a PVM Instance
16
+ [**pcloud_pvminstances_volumes_put**](PCloudVolumesApi.md#pcloud_pvminstances_volumes_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/volumes/{volume_id} | Update a volume attached to a PVMInstance
17
+ [**pcloud_pvminstances_volumes_setboot_put**](PCloudVolumesApi.md#pcloud_pvminstances_volumes_setboot_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/volumes/{volume_id}/setboot | Set the PVMInstance volume as the boot volume
18
+ [**pcloud_v2_volumes_clone_post**](PCloudVolumesApi.md#pcloud_v2_volumes_clone_post) | **POST** /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes/clone | Create a volume clone for specified volumes (version 2)
19
+ [**pcloud_v2_volumes_clonetasks_get**](PCloudVolumesApi.md#pcloud_v2_volumes_clonetasks_get) | **GET** /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes/clone-tasks/{clone_task_id} | Get the status of a volume clone request for the specified clone task ID
20
+ [**pcloud_v2_volumes_post**](PCloudVolumesApi.md#pcloud_v2_volumes_post) | **POST** /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes | Create multiple data volumes from a single definition
21
+ [**pcloud_volumes_clone_post**](PCloudVolumesApi.md#pcloud_volumes_clone_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/clone | Create a volume clone for specified volumes (version 1 - depricated)
22
+
23
+
24
+
25
+ ## pcloud_cloudinstances_volumes_delete
26
+
27
+ > Object pcloud_cloudinstances_volumes_delete(cloud_instance_id, volume_id)
28
+
29
+ Delete a cloud instance volume
30
+
31
+ ### Example
32
+
33
+ ```ruby
34
+ # load the gem
35
+ require 'ibm_cloud_power'
36
+
37
+ api_instance = IbmCloudPower::PCloudVolumesApi.new
38
+ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
39
+ volume_id = 'volume_id_example' # String | Volume ID
40
+
41
+ begin
42
+ #Delete a cloud instance volume
43
+ result = api_instance.pcloud_cloudinstances_volumes_delete(cloud_instance_id, volume_id)
44
+ p result
45
+ rescue IbmCloudPower::ApiError => e
46
+ puts "Exception when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_delete: #{e}"
47
+ end
48
+ ```
49
+
50
+ ### Parameters
51
+
52
+
53
+ Name | Type | Description | Notes
54
+ ------------- | ------------- | ------------- | -------------
55
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
56
+ **volume_id** | **String**| Volume ID |
57
+
58
+ ### Return type
59
+
60
+ **Object**
61
+
62
+ ### Authorization
63
+
64
+ No authorization required
65
+
66
+ ### HTTP request headers
67
+
68
+ - **Content-Type**: Not defined
69
+ - **Accept**: */*
70
+
71
+
72
+ ## pcloud_cloudinstances_volumes_get
73
+
74
+ > Volume pcloud_cloudinstances_volumes_get(cloud_instance_id, volume_id)
75
+
76
+ Detailed information of a volume
77
+
78
+ ### Example
79
+
80
+ ```ruby
81
+ # load the gem
82
+ require 'ibm_cloud_power'
83
+
84
+ api_instance = IbmCloudPower::PCloudVolumesApi.new
85
+ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
86
+ volume_id = 'volume_id_example' # String | Volume ID
87
+
88
+ begin
89
+ #Detailed information of a volume
90
+ result = api_instance.pcloud_cloudinstances_volumes_get(cloud_instance_id, volume_id)
91
+ p result
92
+ rescue IbmCloudPower::ApiError => e
93
+ puts "Exception when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_get: #{e}"
94
+ end
95
+ ```
96
+
97
+ ### Parameters
98
+
99
+
100
+ Name | Type | Description | Notes
101
+ ------------- | ------------- | ------------- | -------------
102
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
103
+ **volume_id** | **String**| Volume ID |
104
+
105
+ ### Return type
106
+
107
+ [**Volume**](Volume.md)
108
+
109
+ ### Authorization
110
+
111
+ No authorization required
112
+
113
+ ### HTTP request headers
114
+
115
+ - **Content-Type**: Not defined
116
+ - **Accept**: application/json
117
+
118
+
119
+ ## pcloud_cloudinstances_volumes_getall
120
+
121
+ > Volumes pcloud_cloudinstances_volumes_getall(cloud_instance_id, opts)
122
+
123
+ List all volumes for this cloud instance
124
+
125
+ ### Example
126
+
127
+ ```ruby
128
+ # load the gem
129
+ require 'ibm_cloud_power'
130
+
131
+ api_instance = IbmCloudPower::PCloudVolumesApi.new
132
+ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
133
+ opts = {
134
+ affinity: 'affinity_example' # String | A pvmInstance (id or name), limits a volumes list response to only volumes that have affinity to the pvmInstance
135
+ }
136
+
137
+ begin
138
+ #List all volumes for this cloud instance
139
+ result = api_instance.pcloud_cloudinstances_volumes_getall(cloud_instance_id, opts)
140
+ p result
141
+ rescue IbmCloudPower::ApiError => e
142
+ puts "Exception when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_getall: #{e}"
143
+ end
144
+ ```
145
+
146
+ ### Parameters
147
+
148
+
149
+ Name | Type | Description | Notes
150
+ ------------- | ------------- | ------------- | -------------
151
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
152
+ **affinity** | **String**| A pvmInstance (id or name), limits a volumes list response to only volumes that have affinity to the pvmInstance | [optional]
153
+
154
+ ### Return type
155
+
156
+ [**Volumes**](Volumes.md)
157
+
158
+ ### Authorization
159
+
160
+ No authorization required
161
+
162
+ ### HTTP request headers
163
+
164
+ - **Content-Type**: Not defined
165
+ - **Accept**: application/json
166
+
167
+
168
+ ## pcloud_cloudinstances_volumes_post
169
+
170
+ > Volume pcloud_cloudinstances_volumes_post(cloud_instance_id, body)
171
+
172
+ Create a new data volume
173
+
174
+ All regions use Tier 1 (NVMe-based flash storage) or Tier 3 (SSD flash storage) storage types.
175
+
176
+ ### Example
177
+
178
+ ```ruby
179
+ # load the gem
180
+ require 'ibm_cloud_power'
181
+
182
+ api_instance = IbmCloudPower::PCloudVolumesApi.new
183
+ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
184
+ body = IbmCloudPower::CreateDataVolume.new # CreateDataVolume | Parameters for the creation of a new data volume
185
+
186
+ begin
187
+ #Create a new data volume
188
+ result = api_instance.pcloud_cloudinstances_volumes_post(cloud_instance_id, body)
189
+ p result
190
+ rescue IbmCloudPower::ApiError => e
191
+ puts "Exception when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_post: #{e}"
192
+ end
193
+ ```
194
+
195
+ ### Parameters
196
+
197
+
198
+ Name | Type | Description | Notes
199
+ ------------- | ------------- | ------------- | -------------
200
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
201
+ **body** | [**CreateDataVolume**](CreateDataVolume.md)| Parameters for the creation of a new data volume |
202
+
203
+ ### Return type
204
+
205
+ [**Volume**](Volume.md)
206
+
207
+ ### Authorization
208
+
209
+ No authorization required
210
+
211
+ ### HTTP request headers
212
+
213
+ - **Content-Type**: application/json
214
+ - **Accept**: application/json
215
+
216
+
217
+ ## pcloud_cloudinstances_volumes_put
218
+
219
+ > Volume pcloud_cloudinstances_volumes_put(cloud_instance_id, volume_id, body)
220
+
221
+ Update a cloud instance volume
222
+
223
+ ### Example
224
+
225
+ ```ruby
226
+ # load the gem
227
+ require 'ibm_cloud_power'
228
+
229
+ api_instance = IbmCloudPower::PCloudVolumesApi.new
230
+ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
231
+ volume_id = 'volume_id_example' # String | Volume ID
232
+ body = IbmCloudPower::UpdateVolume.new # UpdateVolume | Parameters to update a cloud instance volume
233
+
234
+ begin
235
+ #Update a cloud instance volume
236
+ result = api_instance.pcloud_cloudinstances_volumes_put(cloud_instance_id, volume_id, body)
237
+ p result
238
+ rescue IbmCloudPower::ApiError => e
239
+ puts "Exception when calling PCloudVolumesApi->pcloud_cloudinstances_volumes_put: #{e}"
240
+ end
241
+ ```
242
+
243
+ ### Parameters
244
+
245
+
246
+ Name | Type | Description | Notes
247
+ ------------- | ------------- | ------------- | -------------
248
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
249
+ **volume_id** | **String**| Volume ID |
250
+ **body** | [**UpdateVolume**](UpdateVolume.md)| Parameters to update a cloud instance volume |
251
+
252
+ ### Return type
253
+
254
+ [**Volume**](Volume.md)
255
+
256
+ ### Authorization
257
+
258
+ No authorization required
259
+
260
+ ### HTTP request headers
261
+
262
+ - **Content-Type**: application/json
263
+ - **Accept**: application/json
264
+
265
+
266
+ ## pcloud_pvminstances_volumes_delete
267
+
268
+ > Object pcloud_pvminstances_volumes_delete(cloud_instance_id, pvm_instance_id, volume_id)
269
+
270
+ Detach a volume from a PVM Instance
271
+
272
+ ### Example
273
+
274
+ ```ruby
275
+ # load the gem
276
+ require 'ibm_cloud_power'
277
+
278
+ api_instance = IbmCloudPower::PCloudVolumesApi.new
279
+ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
280
+ pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
281
+ volume_id = 'volume_id_example' # String | Volume ID
282
+
283
+ begin
284
+ #Detach a volume from a PVM Instance
285
+ result = api_instance.pcloud_pvminstances_volumes_delete(cloud_instance_id, pvm_instance_id, volume_id)
286
+ p result
287
+ rescue IbmCloudPower::ApiError => e
288
+ puts "Exception when calling PCloudVolumesApi->pcloud_pvminstances_volumes_delete: #{e}"
289
+ end
290
+ ```
291
+
292
+ ### Parameters
293
+
294
+
295
+ Name | Type | Description | Notes
296
+ ------------- | ------------- | ------------- | -------------
297
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
298
+ **pvm_instance_id** | **String**| PCloud PVM Instance ID |
299
+ **volume_id** | **String**| Volume ID |
300
+
301
+ ### Return type
302
+
303
+ **Object**
304
+
305
+ ### Authorization
306
+
307
+ No authorization required
308
+
309
+ ### HTTP request headers
310
+
311
+ - **Content-Type**: Not defined
312
+ - **Accept**: application/json
313
+
314
+
315
+ ## pcloud_pvminstances_volumes_get
316
+
317
+ > Volume pcloud_pvminstances_volumes_get(cloud_instance_id, pvm_instance_id, volume_id)
318
+
319
+ Detailed information of a volume attached to a PVM Instance
320
+
321
+ ### Example
322
+
323
+ ```ruby
324
+ # load the gem
325
+ require 'ibm_cloud_power'
326
+
327
+ api_instance = IbmCloudPower::PCloudVolumesApi.new
328
+ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
329
+ pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
330
+ volume_id = 'volume_id_example' # String | Volume ID
331
+
332
+ begin
333
+ #Detailed information of a volume attached to a PVM Instance
334
+ result = api_instance.pcloud_pvminstances_volumes_get(cloud_instance_id, pvm_instance_id, volume_id)
335
+ p result
336
+ rescue IbmCloudPower::ApiError => e
337
+ puts "Exception when calling PCloudVolumesApi->pcloud_pvminstances_volumes_get: #{e}"
338
+ end
339
+ ```
340
+
341
+ ### Parameters
342
+
343
+
344
+ Name | Type | Description | Notes
345
+ ------------- | ------------- | ------------- | -------------
346
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
347
+ **pvm_instance_id** | **String**| PCloud PVM Instance ID |
348
+ **volume_id** | **String**| Volume ID |
349
+
350
+ ### Return type
351
+
352
+ [**Volume**](Volume.md)
353
+
354
+ ### Authorization
355
+
356
+ No authorization required
357
+
358
+ ### HTTP request headers
359
+
360
+ - **Content-Type**: Not defined
361
+ - **Accept**: application/json
362
+
363
+
364
+ ## pcloud_pvminstances_volumes_getall
365
+
366
+ > Volumes pcloud_pvminstances_volumes_getall(cloud_instance_id, pvm_instance_id)
367
+
368
+ List all volumes attached to a PVM Instance
369
+
370
+ ### Example
371
+
372
+ ```ruby
373
+ # load the gem
374
+ require 'ibm_cloud_power'
375
+
376
+ api_instance = IbmCloudPower::PCloudVolumesApi.new
377
+ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
378
+ pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
379
+
380
+ begin
381
+ #List all volumes attached to a PVM Instance
382
+ result = api_instance.pcloud_pvminstances_volumes_getall(cloud_instance_id, pvm_instance_id)
383
+ p result
384
+ rescue IbmCloudPower::ApiError => e
385
+ puts "Exception when calling PCloudVolumesApi->pcloud_pvminstances_volumes_getall: #{e}"
386
+ end
387
+ ```
388
+
389
+ ### Parameters
390
+
391
+
392
+ Name | Type | Description | Notes
393
+ ------------- | ------------- | ------------- | -------------
394
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
395
+ **pvm_instance_id** | **String**| PCloud PVM Instance ID |
396
+
397
+ ### Return type
398
+
399
+ [**Volumes**](Volumes.md)
400
+
401
+ ### Authorization
402
+
403
+ No authorization required
404
+
405
+ ### HTTP request headers
406
+
407
+ - **Content-Type**: Not defined
408
+ - **Accept**: application/json
409
+
410
+
411
+ ## pcloud_pvminstances_volumes_post
412
+
413
+ > Object pcloud_pvminstances_volumes_post(cloud_instance_id, pvm_instance_id, volume_id)
414
+
415
+ Attach a volume to a PVM Instance
416
+
417
+ ### Example
418
+
419
+ ```ruby
420
+ # load the gem
421
+ require 'ibm_cloud_power'
422
+
423
+ api_instance = IbmCloudPower::PCloudVolumesApi.new
424
+ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
425
+ pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
426
+ volume_id = 'volume_id_example' # String | Volume ID
427
+
428
+ begin
429
+ #Attach a volume to a PVM Instance
430
+ result = api_instance.pcloud_pvminstances_volumes_post(cloud_instance_id, pvm_instance_id, volume_id)
431
+ p result
432
+ rescue IbmCloudPower::ApiError => e
433
+ puts "Exception when calling PCloudVolumesApi->pcloud_pvminstances_volumes_post: #{e}"
434
+ end
435
+ ```
436
+
437
+ ### Parameters
438
+
439
+
440
+ Name | Type | Description | Notes
441
+ ------------- | ------------- | ------------- | -------------
442
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
443
+ **pvm_instance_id** | **String**| PCloud PVM Instance ID |
444
+ **volume_id** | **String**| Volume ID |
445
+
446
+ ### Return type
447
+
448
+ **Object**
449
+
450
+ ### Authorization
451
+
452
+ No authorization required
453
+
454
+ ### HTTP request headers
455
+
456
+ - **Content-Type**: Not defined
457
+ - **Accept**: application/json
458
+
459
+
460
+ ## pcloud_pvminstances_volumes_put
461
+
462
+ > Object pcloud_pvminstances_volumes_put(cloud_instance_id, pvm_instance_id, volume_id, body)
463
+
464
+ Update a volume attached to a PVMInstance
465
+
466
+ ### Example
467
+
468
+ ```ruby
469
+ # load the gem
470
+ require 'ibm_cloud_power'
471
+
472
+ api_instance = IbmCloudPower::PCloudVolumesApi.new
473
+ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
474
+ pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
475
+ volume_id = 'volume_id_example' # String | Volume ID
476
+ body = IbmCloudPower::PVMInstanceVolumeUpdate.new # PVMInstanceVolumeUpdate | Parameters to update a volume attached to a PVMInstance
477
+
478
+ begin
479
+ #Update a volume attached to a PVMInstance
480
+ result = api_instance.pcloud_pvminstances_volumes_put(cloud_instance_id, pvm_instance_id, volume_id, body)
481
+ p result
482
+ rescue IbmCloudPower::ApiError => e
483
+ puts "Exception when calling PCloudVolumesApi->pcloud_pvminstances_volumes_put: #{e}"
484
+ end
485
+ ```
486
+
487
+ ### Parameters
488
+
489
+
490
+ Name | Type | Description | Notes
491
+ ------------- | ------------- | ------------- | -------------
492
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
493
+ **pvm_instance_id** | **String**| PCloud PVM Instance ID |
494
+ **volume_id** | **String**| Volume ID |
495
+ **body** | [**PVMInstanceVolumeUpdate**](PVMInstanceVolumeUpdate.md)| Parameters to update a volume attached to a PVMInstance |
496
+
497
+ ### Return type
498
+
499
+ **Object**
500
+
501
+ ### Authorization
502
+
503
+ No authorization required
504
+
505
+ ### HTTP request headers
506
+
507
+ - **Content-Type**: application/json
508
+ - **Accept**: application/json
509
+
510
+
511
+ ## pcloud_pvminstances_volumes_setboot_put
512
+
513
+ > Object pcloud_pvminstances_volumes_setboot_put(cloud_instance_id, pvm_instance_id, volume_id)
514
+
515
+ Set the PVMInstance volume as the boot volume
516
+
517
+ ### Example
518
+
519
+ ```ruby
520
+ # load the gem
521
+ require 'ibm_cloud_power'
522
+
523
+ api_instance = IbmCloudPower::PCloudVolumesApi.new
524
+ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
525
+ pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
526
+ volume_id = 'volume_id_example' # String | Volume ID
527
+
528
+ begin
529
+ #Set the PVMInstance volume as the boot volume
530
+ result = api_instance.pcloud_pvminstances_volumes_setboot_put(cloud_instance_id, pvm_instance_id, volume_id)
531
+ p result
532
+ rescue IbmCloudPower::ApiError => e
533
+ puts "Exception when calling PCloudVolumesApi->pcloud_pvminstances_volumes_setboot_put: #{e}"
534
+ end
535
+ ```
536
+
537
+ ### Parameters
538
+
539
+
540
+ Name | Type | Description | Notes
541
+ ------------- | ------------- | ------------- | -------------
542
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
543
+ **pvm_instance_id** | **String**| PCloud PVM Instance ID |
544
+ **volume_id** | **String**| Volume ID |
545
+
546
+ ### Return type
547
+
548
+ **Object**
549
+
550
+ ### Authorization
551
+
552
+ No authorization required
553
+
554
+ ### HTTP request headers
555
+
556
+ - **Content-Type**: Not defined
557
+ - **Accept**: */*
558
+
559
+
560
+ ## pcloud_v2_volumes_clone_post
561
+
562
+ > CloneTaskReference pcloud_v2_volumes_clone_post(cloud_instance_id, body)
563
+
564
+ Create a volume clone for specified volumes (version 2)
565
+
566
+ ### Example
567
+
568
+ ```ruby
569
+ # load the gem
570
+ require 'ibm_cloud_power'
571
+
572
+ api_instance = IbmCloudPower::PCloudVolumesApi.new
573
+ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
574
+ body = IbmCloudPower::VolumesCloneAsyncRequest.new # VolumesCloneAsyncRequest | Parameters for the cloning of volumes
575
+
576
+ begin
577
+ #Create a volume clone for specified volumes (version 2)
578
+ result = api_instance.pcloud_v2_volumes_clone_post(cloud_instance_id, body)
579
+ p result
580
+ rescue IbmCloudPower::ApiError => e
581
+ puts "Exception when calling PCloudVolumesApi->pcloud_v2_volumes_clone_post: #{e}"
582
+ end
583
+ ```
584
+
585
+ ### Parameters
586
+
587
+
588
+ Name | Type | Description | Notes
589
+ ------------- | ------------- | ------------- | -------------
590
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
591
+ **body** | [**VolumesCloneAsyncRequest**](VolumesCloneAsyncRequest.md)| Parameters for the cloning of volumes |
592
+
593
+ ### Return type
594
+
595
+ [**CloneTaskReference**](CloneTaskReference.md)
596
+
597
+ ### Authorization
598
+
599
+ No authorization required
600
+
601
+ ### HTTP request headers
602
+
603
+ - **Content-Type**: application/json
604
+ - **Accept**: application/json
605
+
606
+
607
+ ## pcloud_v2_volumes_clonetasks_get
608
+
609
+ > CloneTaskStatus pcloud_v2_volumes_clonetasks_get(cloud_instance_id, clone_task_id)
610
+
611
+ Get the status of a volume clone request for the specified clone task ID
612
+
613
+ ### Example
614
+
615
+ ```ruby
616
+ # load the gem
617
+ require 'ibm_cloud_power'
618
+
619
+ api_instance = IbmCloudPower::PCloudVolumesApi.new
620
+ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
621
+ clone_task_id = 'clone_task_id_example' # String | Volumes Clone Task ID
622
+
623
+ begin
624
+ #Get the status of a volume clone request for the specified clone task ID
625
+ result = api_instance.pcloud_v2_volumes_clonetasks_get(cloud_instance_id, clone_task_id)
626
+ p result
627
+ rescue IbmCloudPower::ApiError => e
628
+ puts "Exception when calling PCloudVolumesApi->pcloud_v2_volumes_clonetasks_get: #{e}"
629
+ end
630
+ ```
631
+
632
+ ### Parameters
633
+
634
+
635
+ Name | Type | Description | Notes
636
+ ------------- | ------------- | ------------- | -------------
637
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
638
+ **clone_task_id** | **String**| Volumes Clone Task ID |
639
+
640
+ ### Return type
641
+
642
+ [**CloneTaskStatus**](CloneTaskStatus.md)
643
+
644
+ ### Authorization
645
+
646
+ No authorization required
647
+
648
+ ### HTTP request headers
649
+
650
+ - **Content-Type**: Not defined
651
+ - **Accept**: application/json
652
+
653
+
654
+ ## pcloud_v2_volumes_post
655
+
656
+ > Volumes pcloud_v2_volumes_post(cloud_instance_id, body)
657
+
658
+ Create multiple data volumes from a single definition
659
+
660
+ ### Example
661
+
662
+ ```ruby
663
+ # load the gem
664
+ require 'ibm_cloud_power'
665
+
666
+ api_instance = IbmCloudPower::PCloudVolumesApi.new
667
+ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
668
+ body = IbmCloudPower::MultiVolumesCreate.new # MultiVolumesCreate | Parameters for creating multiple volumes
669
+
670
+ begin
671
+ #Create multiple data volumes from a single definition
672
+ result = api_instance.pcloud_v2_volumes_post(cloud_instance_id, body)
673
+ p result
674
+ rescue IbmCloudPower::ApiError => e
675
+ puts "Exception when calling PCloudVolumesApi->pcloud_v2_volumes_post: #{e}"
676
+ end
677
+ ```
678
+
679
+ ### Parameters
680
+
681
+
682
+ Name | Type | Description | Notes
683
+ ------------- | ------------- | ------------- | -------------
684
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
685
+ **body** | [**MultiVolumesCreate**](MultiVolumesCreate.md)| Parameters for creating multiple volumes |
686
+
687
+ ### Return type
688
+
689
+ [**Volumes**](Volumes.md)
690
+
691
+ ### Authorization
692
+
693
+ No authorization required
694
+
695
+ ### HTTP request headers
696
+
697
+ - **Content-Type**: application/json
698
+ - **Accept**: application/json
699
+
700
+
701
+ ## pcloud_volumes_clone_post
702
+
703
+ > VolumesCloneResponse pcloud_volumes_clone_post(cloud_instance_id, body)
704
+
705
+ Create a volume clone for specified volumes (version 1 - depricated)
706
+
707
+ ### Example
708
+
709
+ ```ruby
710
+ # load the gem
711
+ require 'ibm_cloud_power'
712
+
713
+ api_instance = IbmCloudPower::PCloudVolumesApi.new
714
+ cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
715
+ body = IbmCloudPower::VolumesCloneRequest.new # VolumesCloneRequest | Parameters for the cloning of volumes
716
+
717
+ begin
718
+ #Create a volume clone for specified volumes (version 1 - depricated)
719
+ result = api_instance.pcloud_volumes_clone_post(cloud_instance_id, body)
720
+ p result
721
+ rescue IbmCloudPower::ApiError => e
722
+ puts "Exception when calling PCloudVolumesApi->pcloud_volumes_clone_post: #{e}"
723
+ end
724
+ ```
725
+
726
+ ### Parameters
727
+
728
+
729
+ Name | Type | Description | Notes
730
+ ------------- | ------------- | ------------- | -------------
731
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
732
+ **body** | [**VolumesCloneRequest**](VolumesCloneRequest.md)| Parameters for the cloning of volumes |
733
+
734
+ ### Return type
735
+
736
+ [**VolumesCloneResponse**](VolumesCloneResponse.md)
737
+
738
+ ### Authorization
739
+
740
+ No authorization required
741
+
742
+ ### HTTP request headers
743
+
744
+ - **Content-Type**: application/json
745
+ - **Accept**: application/json
746
+