ibm_cloud_power 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +255 -0
- data/Rakefile +10 -0
- data/docs/CloneTaskReference.md +19 -0
- data/docs/CloneTaskStatus.md +23 -0
- data/docs/ClonedVolume.md +19 -0
- data/docs/ClonedVolumeDetail.md +19 -0
- data/docs/CloudInstance.md +37 -0
- data/docs/CloudInstanceCreate.md +29 -0
- data/docs/CloudInstanceReference.md +31 -0
- data/docs/CloudInstanceUpdate.md +25 -0
- data/docs/CloudInstanceUsageLimits.md +37 -0
- data/docs/CreateDataVolume.md +29 -0
- data/docs/CreateImage.md +37 -0
- data/docs/Error.md +19 -0
- data/docs/Event.md +33 -0
- data/docs/EventUser.md +21 -0
- data/docs/Events.md +17 -0
- data/docs/ExportImage.md +23 -0
- data/docs/IPAddressRange.md +19 -0
- data/docs/Image.md +39 -0
- data/docs/ImageReference.md +33 -0
- data/docs/ImageSpecifications.md +29 -0
- data/docs/ImageVolume.md +23 -0
- data/docs/Images.md +17 -0
- data/docs/MinMaxDefault.md +21 -0
- data/docs/MultiVolumesCreate.md +29 -0
- data/docs/Network.md +37 -0
- data/docs/NetworkCreate.md +29 -0
- data/docs/NetworkIpAddressMetrics.md +23 -0
- data/docs/NetworkPort.md +29 -0
- data/docs/NetworkPortCreate.md +19 -0
- data/docs/NetworkPortPvmInstance.md +19 -0
- data/docs/NetworkPortUpdate.md +19 -0
- data/docs/NetworkPorts.md +17 -0
- data/docs/NetworkReference.md +27 -0
- data/docs/NetworkUpdate.md +23 -0
- data/docs/Networks.md +17 -0
- data/docs/Operations.md +21 -0
- data/docs/PCloudEventsApi.md +114 -0
- data/docs/PCloudImagesApi.md +342 -0
- data/docs/PCloudInstancesApi.md +148 -0
- data/docs/PCloudNetworksApi.md +504 -0
- data/docs/PCloudPVMInstancesApi.md +809 -0
- data/docs/PCloudSAPApi.md +150 -0
- data/docs/PCloudSnapshotsApi.md +200 -0
- data/docs/PCloudSystemPoolsApi.md +54 -0
- data/docs/PCloudTasksApi.md +100 -0
- data/docs/PCloudTenantsApi.md +102 -0
- data/docs/PCloudTenantsSSHKeysApi.md +248 -0
- data/docs/PCloudVolumesApi.md +746 -0
- data/docs/PVMInstance.md +77 -0
- data/docs/PVMInstanceAction.md +17 -0
- data/docs/PVMInstanceAddNetwork.md +19 -0
- data/docs/PVMInstanceCapture.md +29 -0
- data/docs/PVMInstanceClone.md +31 -0
- data/docs/PVMInstanceConsole.md +17 -0
- data/docs/PVMInstanceCreate.md +53 -0
- data/docs/PVMInstanceFault.md +23 -0
- data/docs/PVMInstanceHealth.md +21 -0
- data/docs/PVMInstanceMultiCreate.md +21 -0
- data/docs/PVMInstanceNetwork.md +33 -0
- data/docs/PVMInstanceNetworks.md +17 -0
- data/docs/PVMInstanceOperation.md +19 -0
- data/docs/PVMInstanceReference.md +71 -0
- data/docs/PVMInstanceRemoveNetwork.md +17 -0
- data/docs/PVMInstanceUpdate.md +33 -0
- data/docs/PVMInstanceUpdateResponse.md +27 -0
- data/docs/PVMInstanceVolumeUpdate.md +17 -0
- data/docs/PVMInstances.md +17 -0
- data/docs/PeeringNetwork.md +21 -0
- data/docs/PinPolicy.md +16 -0
- data/docs/SAPCreate.md +33 -0
- data/docs/SAPProfile.md +25 -0
- data/docs/SAPProfileReference.md +19 -0
- data/docs/SAPProfiles.md +17 -0
- data/docs/SRC.md +19 -0
- data/docs/SSHKey.md +21 -0
- data/docs/SSHKeys.md +17 -0
- data/docs/Snapshot.md +35 -0
- data/docs/SnapshotCreate.md +21 -0
- data/docs/SnapshotCreateResponse.md +17 -0
- data/docs/SnapshotRestore.md +17 -0
- data/docs/SnapshotUpdate.md +19 -0
- data/docs/Snapshots.md +17 -0
- data/docs/SoftwareLicenses.md +25 -0
- data/docs/StockImage.md +21 -0
- data/docs/System.md +21 -0
- data/docs/SystemPool.md +31 -0
- data/docs/Task.md +33 -0
- data/docs/TaskReference.md +19 -0
- data/docs/Tenant.md +29 -0
- data/docs/TenantUpdate.md +19 -0
- data/docs/UpdateVolume.md +23 -0
- data/docs/VirtualCores.md +21 -0
- data/docs/Volume.md +41 -0
- data/docs/VolumeInfo.md +19 -0
- data/docs/VolumeReference.md +43 -0
- data/docs/Volumes.md +17 -0
- data/docs/VolumesClone.md +31 -0
- data/docs/VolumesCloneAsyncRequest.md +19 -0
- data/docs/VolumesCloneCancel.md +17 -0
- data/docs/VolumesCloneCreate.md +19 -0
- data/docs/VolumesCloneDetail.md +33 -0
- data/docs/VolumesCloneExecute.md +19 -0
- data/docs/VolumesCloneRequest.md +19 -0
- data/docs/VolumesCloneResponse.md +17 -0
- data/docs/VolumesClones.md +17 -0
- data/git_push.sh +58 -0
- data/ibm_cloud_power.gemspec +38 -0
- data/lib/ibm_cloud_power.rb +144 -0
- data/lib/ibm_cloud_power/api/p_cloud_events_api.rb +163 -0
- data/lib/ibm_cloud_power/api/p_cloud_images_api.rb +473 -0
- data/lib/ibm_cloud_power/api/p_cloud_instances_api.rb +210 -0
- data/lib/ibm_cloud_power/api/p_cloud_networks_api.rb +719 -0
- data/lib/ibm_cloud_power/api/p_cloud_pvm_instances_api.rb +1166 -0
- data/lib/ibm_cloud_power/api/p_cloud_sap_api.rb +216 -0
- data/lib/ibm_cloud_power/api/p_cloud_snapshots_api.rb +288 -0
- data/lib/ibm_cloud_power/api/p_cloud_system_pools_api.rb +82 -0
- data/lib/ibm_cloud_power/api/p_cloud_tasks_api.rb +142 -0
- data/lib/ibm_cloud_power/api/p_cloud_tenants_api.rb +150 -0
- data/lib/ibm_cloud_power/api/p_cloud_tenants_ssh_keys_api.rb +356 -0
- data/lib/ibm_cloud_power/api/p_cloud_volumes_api.rb +1065 -0
- data/lib/ibm_cloud_power/api_client.rb +387 -0
- data/lib/ibm_cloud_power/api_error.rb +57 -0
- data/lib/ibm_cloud_power/configuration.rb +241 -0
- data/lib/ibm_cloud_power/models/clone_task_reference.rb +229 -0
- data/lib/ibm_cloud_power/models/clone_task_status.rb +285 -0
- data/lib/ibm_cloud_power/models/cloned_volume.rb +219 -0
- data/lib/ibm_cloud_power/models/cloned_volume_detail.rb +227 -0
- data/lib/ibm_cloud_power/models/cloud_instance.rb +361 -0
- data/lib/ibm_cloud_power/models/cloud_instance_create.rb +294 -0
- data/lib/ibm_cloud_power/models/cloud_instance_reference.rb +315 -0
- data/lib/ibm_cloud_power/models/cloud_instance_update.rb +249 -0
- data/lib/ibm_cloud_power/models/cloud_instance_usage_limits.rb +334 -0
- data/lib/ibm_cloud_power/models/create_data_volume.rb +313 -0
- data/lib/ibm_cloud_power/models/create_image.rb +360 -0
- data/lib/ibm_cloud_power/models/error.rb +217 -0
- data/lib/ibm_cloud_power/models/event.rb +357 -0
- data/lib/ibm_cloud_power/models/event_user.rb +234 -0
- data/lib/ibm_cloud_power/models/events.rb +216 -0
- data/lib/ibm_cloud_power/models/export_image.rb +249 -0
- data/lib/ibm_cloud_power/models/image.rb +351 -0
- data/lib/ibm_cloud_power/models/image_reference.rb +333 -0
- data/lib/ibm_cloud_power/models/image_specifications.rb +269 -0
- data/lib/ibm_cloud_power/models/image_volume.rb +259 -0
- data/lib/ibm_cloud_power/models/images.rb +216 -0
- data/lib/ibm_cloud_power/models/ip_address_range.rb +229 -0
- data/lib/ibm_cloud_power/models/min_max_default.rb +244 -0
- data/lib/ibm_cloud_power/models/multi_volumes_create.rb +313 -0
- data/lib/ibm_cloud_power/models/network.rb +395 -0
- data/lib/ibm_cloud_power/models/network_create.rb +314 -0
- data/lib/ibm_cloud_power/models/network_ip_address_metrics.rb +260 -0
- data/lib/ibm_cloud_power/models/network_port.rb +293 -0
- data/lib/ibm_cloud_power/models/network_port_create.rb +219 -0
- data/lib/ibm_cloud_power/models/network_port_pvm_instance.rb +220 -0
- data/lib/ibm_cloud_power/models/network_port_update.rb +219 -0
- data/lib/ibm_cloud_power/models/network_ports.rb +216 -0
- data/lib/ibm_cloud_power/models/network_reference.rb +325 -0
- data/lib/ibm_cloud_power/models/network_update.rb +243 -0
- data/lib/ibm_cloud_power/models/networks.rb +216 -0
- data/lib/ibm_cloud_power/models/operations.rb +287 -0
- data/lib/ibm_cloud_power/models/peering_network.rb +241 -0
- data/lib/ibm_cloud_power/models/pin_policy.rb +37 -0
- data/lib/ibm_cloud_power/models/pvm_instance.rb +612 -0
- data/lib/ibm_cloud_power/models/pvm_instance_action.rb +248 -0
- data/lib/ibm_cloud_power/models/pvm_instance_add_network.rb +224 -0
- data/lib/ibm_cloud_power/models/pvm_instance_capture.rb +317 -0
- data/lib/ibm_cloud_power/models/pvm_instance_clone.rb +328 -0
- data/lib/ibm_cloud_power/models/pvm_instance_console.rb +214 -0
- data/lib/ibm_cloud_power/models/pvm_instance_create.rb +483 -0
- data/lib/ibm_cloud_power/models/pvm_instance_fault.rb +240 -0
- data/lib/ibm_cloud_power/models/pvm_instance_health.rb +230 -0
- data/lib/ibm_cloud_power/models/pvm_instance_multi_create.rb +279 -0
- data/lib/ibm_cloud_power/models/pvm_instance_network.rb +290 -0
- data/lib/ibm_cloud_power/models/pvm_instance_networks.rb +216 -0
- data/lib/ibm_cloud_power/models/pvm_instance_operation.rb +262 -0
- data/lib/ibm_cloud_power/models/pvm_instance_reference.rb +566 -0
- data/lib/ibm_cloud_power/models/pvm_instance_remove_network.rb +209 -0
- data/lib/ibm_cloud_power/models/pvm_instance_update.rb +322 -0
- data/lib/ibm_cloud_power/models/pvm_instance_update_response.rb +292 -0
- data/lib/ibm_cloud_power/models/pvm_instance_volume_update.rb +214 -0
- data/lib/ibm_cloud_power/models/pvm_instances.rb +216 -0
- data/lib/ibm_cloud_power/models/sap_create.rb +311 -0
- data/lib/ibm_cloud_power/models/sap_profile.rb +310 -0
- data/lib/ibm_cloud_power/models/sap_profile_reference.rb +229 -0
- data/lib/ibm_cloud_power/models/sap_profiles.rb +216 -0
- data/lib/ibm_cloud_power/models/snapshot.rb +321 -0
- data/lib/ibm_cloud_power/models/snapshot_create.rb +236 -0
- data/lib/ibm_cloud_power/models/snapshot_create_response.rb +214 -0
- data/lib/ibm_cloud_power/models/snapshot_restore.rb +211 -0
- data/lib/ibm_cloud_power/models/snapshot_update.rb +219 -0
- data/lib/ibm_cloud_power/models/snapshots.rb +216 -0
- data/lib/ibm_cloud_power/models/software_licenses.rb +257 -0
- data/lib/ibm_cloud_power/models/src.rb +219 -0
- data/lib/ibm_cloud_power/models/ssh_key.rb +239 -0
- data/lib/ibm_cloud_power/models/ssh_keys.rb +216 -0
- data/lib/ibm_cloud_power/models/stock_image.rb +230 -0
- data/lib/ibm_cloud_power/models/system.rb +239 -0
- data/lib/ibm_cloud_power/models/system_pool.rb +277 -0
- data/lib/ibm_cloud_power/models/task.rb +334 -0
- data/lib/ibm_cloud_power/models/task_reference.rb +229 -0
- data/lib/ibm_cloud_power/models/tenant.rb +295 -0
- data/lib/ibm_cloud_power/models/tenant_update.rb +221 -0
- data/lib/ibm_cloud_power/models/update_volume.rb +239 -0
- data/lib/ibm_cloud_power/models/virtual_cores.rb +253 -0
- data/lib/ibm_cloud_power/models/volume.rb +356 -0
- data/lib/ibm_cloud_power/models/volume_info.rb +219 -0
- data/lib/ibm_cloud_power/models/volume_reference.rb +396 -0
- data/lib/ibm_cloud_power/models/volumes.rb +216 -0
- data/lib/ibm_cloud_power/models/volumes_clone.rb +284 -0
- data/lib/ibm_cloud_power/models/volumes_clone_async_request.rb +231 -0
- data/lib/ibm_cloud_power/models/volumes_clone_cancel.rb +209 -0
- data/lib/ibm_cloud_power/models/volumes_clone_create.rb +231 -0
- data/lib/ibm_cloud_power/models/volumes_clone_detail.rb +296 -0
- data/lib/ibm_cloud_power/models/volumes_clone_execute.rb +224 -0
- data/lib/ibm_cloud_power/models/volumes_clone_request.rb +231 -0
- data/lib/ibm_cloud_power/models/volumes_clone_response.rb +211 -0
- data/lib/ibm_cloud_power/models/volumes_clones.rb +211 -0
- data/lib/ibm_cloud_power/version.rb +15 -0
- data/spec/api/p_cloud_events_api_spec.rb +62 -0
- data/spec/api/p_cloud_images_api_spec.rb +117 -0
- data/spec/api/p_cloud_instances_api_spec.rb +69 -0
- data/spec/api/p_cloud_networks_api_spec.rb +161 -0
- data/spec/api/p_cloud_pvm_instances_api_spec.rb +240 -0
- data/spec/api/p_cloud_sap_api_spec.rb +70 -0
- data/spec/api/p_cloud_snapshots_api_spec.rb +83 -0
- data/spec/api/p_cloud_system_pools_api_spec.rb +46 -0
- data/spec/api/p_cloud_tasks_api_spec.rb +57 -0
- data/spec/api/p_cloud_tenants_api_spec.rb +58 -0
- data/spec/api/p_cloud_tenants_ssh_keys_api_spec.rb +95 -0
- data/spec/api/p_cloud_volumes_api_spec.rb +223 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/clone_task_reference_spec.rb +47 -0
- data/spec/models/clone_task_status_spec.rb +63 -0
- data/spec/models/cloned_volume_detail_spec.rb +47 -0
- data/spec/models/cloned_volume_spec.rb +47 -0
- data/spec/models/cloud_instance_create_spec.rb +77 -0
- data/spec/models/cloud_instance_reference_spec.rb +83 -0
- data/spec/models/cloud_instance_spec.rb +101 -0
- data/spec/models/cloud_instance_update_spec.rb +65 -0
- data/spec/models/cloud_instance_usage_limits_spec.rb +101 -0
- data/spec/models/create_data_volume_spec.rb +81 -0
- data/spec/models/create_image_spec.rb +109 -0
- data/spec/models/error_spec.rb +47 -0
- data/spec/models/event_spec.rb +93 -0
- data/spec/models/event_user_spec.rb +53 -0
- data/spec/models/events_spec.rb +41 -0
- data/spec/models/export_image_spec.rb +59 -0
- data/spec/models/image_reference_spec.rb +89 -0
- data/spec/models/image_spec.rb +107 -0
- data/spec/models/image_specifications_spec.rb +77 -0
- data/spec/models/image_volume_spec.rb +59 -0
- data/spec/models/images_spec.rb +41 -0
- data/spec/models/ip_address_range_spec.rb +47 -0
- data/spec/models/min_max_default_spec.rb +53 -0
- data/spec/models/multi_volumes_create_spec.rb +81 -0
- data/spec/models/network_create_spec.rb +81 -0
- data/spec/models/network_ip_address_metrics_spec.rb +59 -0
- data/spec/models/network_port_create_spec.rb +47 -0
- data/spec/models/network_port_pvm_instance_spec.rb +47 -0
- data/spec/models/network_port_spec.rb +77 -0
- data/spec/models/network_port_update_spec.rb +47 -0
- data/spec/models/network_ports_spec.rb +41 -0
- data/spec/models/network_reference_spec.rb +75 -0
- data/spec/models/network_spec.rb +105 -0
- data/spec/models/network_update_spec.rb +59 -0
- data/spec/models/networks_spec.rb +41 -0
- data/spec/models/operations_spec.rb +65 -0
- data/spec/models/peering_network_spec.rb +53 -0
- data/spec/models/pin_policy_spec.rb +35 -0
- data/spec/models/pvm_instance_action_spec.rb +45 -0
- data/spec/models/pvm_instance_add_network_spec.rb +47 -0
- data/spec/models/pvm_instance_capture_spec.rb +81 -0
- data/spec/models/pvm_instance_clone_spec.rb +87 -0
- data/spec/models/pvm_instance_console_spec.rb +41 -0
- data/spec/models/pvm_instance_create_spec.rb +161 -0
- data/spec/models/pvm_instance_fault_spec.rb +59 -0
- data/spec/models/pvm_instance_health_spec.rb +53 -0
- data/spec/models/pvm_instance_multi_create_spec.rb +61 -0
- data/spec/models/pvm_instance_network_spec.rb +89 -0
- data/spec/models/pvm_instance_networks_spec.rb +41 -0
- data/spec/models/pvm_instance_operation_spec.rb +51 -0
- data/spec/models/pvm_instance_reference_spec.rb +207 -0
- data/spec/models/pvm_instance_remove_network_spec.rb +41 -0
- data/spec/models/pvm_instance_spec.rb +225 -0
- data/spec/models/pvm_instance_update_response_spec.rb +75 -0
- data/spec/models/pvm_instance_update_spec.rb +93 -0
- data/spec/models/pvm_instance_volume_update_spec.rb +41 -0
- data/spec/models/pvm_instances_spec.rb +41 -0
- data/spec/models/sap_create_spec.rb +89 -0
- data/spec/models/sap_profile_reference_spec.rb +47 -0
- data/spec/models/sap_profile_spec.rb +69 -0
- data/spec/models/sap_profiles_spec.rb +41 -0
- data/spec/models/snapshot_create_response_spec.rb +41 -0
- data/spec/models/snapshot_create_spec.rb +53 -0
- data/spec/models/snapshot_restore_spec.rb +41 -0
- data/spec/models/snapshot_spec.rb +95 -0
- data/spec/models/snapshot_update_spec.rb +47 -0
- data/spec/models/snapshots_spec.rb +41 -0
- data/spec/models/software_licenses_spec.rb +65 -0
- data/spec/models/src_spec.rb +47 -0
- data/spec/models/ssh_key_spec.rb +53 -0
- data/spec/models/ssh_keys_spec.rb +41 -0
- data/spec/models/stock_image_spec.rb +53 -0
- data/spec/models/system_pool_spec.rb +83 -0
- data/spec/models/system_spec.rb +53 -0
- data/spec/models/task_reference_spec.rb +47 -0
- data/spec/models/task_spec.rb +89 -0
- data/spec/models/tenant_spec.rb +77 -0
- data/spec/models/tenant_update_spec.rb +47 -0
- data/spec/models/update_volume_spec.rb +59 -0
- data/spec/models/virtual_cores_spec.rb +53 -0
- data/spec/models/volume_info_spec.rb +47 -0
- data/spec/models/volume_reference_spec.rb +119 -0
- data/spec/models/volume_spec.rb +113 -0
- data/spec/models/volumes_clone_async_request_spec.rb +47 -0
- data/spec/models/volumes_clone_cancel_spec.rb +41 -0
- data/spec/models/volumes_clone_create_spec.rb +47 -0
- data/spec/models/volumes_clone_detail_spec.rb +89 -0
- data/spec/models/volumes_clone_execute_spec.rb +47 -0
- data/spec/models/volumes_clone_request_spec.rb +47 -0
- data/spec/models/volumes_clone_response_spec.rb +47 -0
- data/spec/models/volumes_clone_spec.rb +83 -0
- data/spec/models/volumes_clones_spec.rb +41 -0
- data/spec/models/volumes_spec.rb +41 -0
- data/spec/spec_helper.rb +111 -0
- metadata +519 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: b918cf3edabaa307270c77593c5e094499ab04c853f2fde4f8663dfeb6abb120
|
4
|
+
data.tar.gz: dc0db25da7f0c5c1c5c3569fce23bd47aa3368c967a8d0a84063bb36fa65e36b
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 9669a9448eaa9153bd17019144c3ac1b9c6d219435c1d29e545c6622b68e5092a56038ae4e5627b3524276b2c007633003e85bddb43b63af5351df5d9165148e
|
7
|
+
data.tar.gz: d6bb322db53a514c081488e7407f093973eaa83058d0d145110157dfc35c8fd304b7bf50ada00ef159019013c90a72dbc6432766b9a653f11c991924373577e8
|
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,255 @@
|
|
1
|
+
# ibm_cloud_power
|
2
|
+
|
3
|
+
IbmCloudPower - the Ruby gem for the Power Cloud API
|
4
|
+
|
5
|
+
IBM Power Cloud API for Power Hardware / Infrastructure
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
|
+
|
9
|
+
- API version: 1.0.0
|
10
|
+
- Package version: 1.0.0
|
11
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
|
+
For more information, please visit [https://github.ibm.com/power-iaas](https://github.ibm.com/power-iaas)
|
13
|
+
|
14
|
+
## Installation
|
15
|
+
|
16
|
+
### Build a gem
|
17
|
+
|
18
|
+
To build the Ruby code into a gem:
|
19
|
+
|
20
|
+
```shell
|
21
|
+
gem build ibm_cloud_power.gemspec
|
22
|
+
```
|
23
|
+
|
24
|
+
Then either install the gem locally:
|
25
|
+
|
26
|
+
```shell
|
27
|
+
gem install ./ibm_cloud_power-1.0.0.gem
|
28
|
+
```
|
29
|
+
|
30
|
+
(for development, run `gem install --dev ./ibm_cloud_power-1.0.0.gem` to install the development dependencies)
|
31
|
+
|
32
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
|
+
|
34
|
+
Finally add this to the Gemfile:
|
35
|
+
|
36
|
+
gem 'ibm_cloud_power', '~> 1.0.0'
|
37
|
+
|
38
|
+
### Install from Git
|
39
|
+
|
40
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
41
|
+
|
42
|
+
gem 'ibm_cloud_power', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
43
|
+
|
44
|
+
### Include the Ruby code directly
|
45
|
+
|
46
|
+
Include the Ruby code directly using `-I` as follows:
|
47
|
+
|
48
|
+
```shell
|
49
|
+
ruby -Ilib script.rb
|
50
|
+
```
|
51
|
+
|
52
|
+
## Getting Started
|
53
|
+
|
54
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
# Load the gem
|
58
|
+
require 'ibm_cloud_power'
|
59
|
+
|
60
|
+
api_instance = IbmCloudPower::PCloudEventsApi.new
|
61
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
62
|
+
event_id = 'event_id_example' # String | Event ID
|
63
|
+
opts = {
|
64
|
+
accept_language: 'accept_language_example' # String | The language requested for the return document
|
65
|
+
}
|
66
|
+
|
67
|
+
begin
|
68
|
+
#Get a single event
|
69
|
+
result = api_instance.pcloud_events_get(cloud_instance_id, event_id, opts)
|
70
|
+
p result
|
71
|
+
rescue IbmCloudPower::ApiError => e
|
72
|
+
puts "Exception when calling PCloudEventsApi->pcloud_events_get: #{e}"
|
73
|
+
end
|
74
|
+
|
75
|
+
```
|
76
|
+
|
77
|
+
## Documentation for API Endpoints
|
78
|
+
|
79
|
+
All URIs are relative to *http://localhost*
|
80
|
+
|
81
|
+
Class | Method | HTTP request | Description
|
82
|
+
------------ | ------------- | ------------- | -------------
|
83
|
+
*IbmCloudPower::PCloudEventsApi* | [**pcloud_events_get**](docs/PCloudEventsApi.md#pcloud_events_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/events/{event_id} | Get a single event
|
84
|
+
*IbmCloudPower::PCloudEventsApi* | [**pcloud_events_getsince**](docs/PCloudEventsApi.md#pcloud_events_getsince) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/events | Get events from this cloud instance since a specific timestamp
|
85
|
+
*IbmCloudPower::PCloudImagesApi* | [**pcloud_cloudinstances_images_delete**](docs/PCloudImagesApi.md#pcloud_cloudinstances_images_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/images/{image_id} | Delete an image from a cloud instance
|
86
|
+
*IbmCloudPower::PCloudImagesApi* | [**pcloud_cloudinstances_images_export_post**](docs/PCloudImagesApi.md#pcloud_cloudinstances_images_export_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/images/{image_id}/export | Export an image
|
87
|
+
*IbmCloudPower::PCloudImagesApi* | [**pcloud_cloudinstances_images_get**](docs/PCloudImagesApi.md#pcloud_cloudinstances_images_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/images/{image_id} | Detailed information of an image
|
88
|
+
*IbmCloudPower::PCloudImagesApi* | [**pcloud_cloudinstances_images_getall**](docs/PCloudImagesApi.md#pcloud_cloudinstances_images_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/images | List all of the images for this cloud instance
|
89
|
+
*IbmCloudPower::PCloudImagesApi* | [**pcloud_cloudinstances_images_post**](docs/PCloudImagesApi.md#pcloud_cloudinstances_images_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/images | Create a new image from available images
|
90
|
+
*IbmCloudPower::PCloudImagesApi* | [**pcloud_images_get**](docs/PCloudImagesApi.md#pcloud_images_get) | **GET** /pcloud/v1/images/{image_id} | Detailed information of an available image
|
91
|
+
*IbmCloudPower::PCloudImagesApi* | [**pcloud_images_getall**](docs/PCloudImagesApi.md#pcloud_images_getall) | **GET** /pcloud/v1/images | List all images available for copying into cloud instances
|
92
|
+
*IbmCloudPower::PCloudInstancesApi* | [**pcloud_cloudinstances_delete**](docs/PCloudInstancesApi.md#pcloud_cloudinstances_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id} | Delete a Power Cloud instance
|
93
|
+
*IbmCloudPower::PCloudInstancesApi* | [**pcloud_cloudinstances_get**](docs/PCloudInstancesApi.md#pcloud_cloudinstances_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id} | Get a cloud instance's current state or information
|
94
|
+
*IbmCloudPower::PCloudInstancesApi* | [**pcloud_cloudinstances_put**](docs/PCloudInstancesApi.md#pcloud_cloudinstances_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id} | Update or upgrade a cloud instance
|
95
|
+
*IbmCloudPower::PCloudNetworksApi* | [**pcloud_networks_delete**](docs/PCloudNetworksApi.md#pcloud_networks_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id} | Delete a network
|
96
|
+
*IbmCloudPower::PCloudNetworksApi* | [**pcloud_networks_get**](docs/PCloudNetworksApi.md#pcloud_networks_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id} | Get a network's current state or information
|
97
|
+
*IbmCloudPower::PCloudNetworksApi* | [**pcloud_networks_getall**](docs/PCloudNetworksApi.md#pcloud_networks_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks | Get all networks in this cloud instance
|
98
|
+
*IbmCloudPower::PCloudNetworksApi* | [**pcloud_networks_ports_delete**](docs/PCloudNetworksApi.md#pcloud_networks_ports_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id}/ports/{port_id} | Delete a network port
|
99
|
+
*IbmCloudPower::PCloudNetworksApi* | [**pcloud_networks_ports_get**](docs/PCloudNetworksApi.md#pcloud_networks_ports_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id}/ports/{port_id} | Get a port's information
|
100
|
+
*IbmCloudPower::PCloudNetworksApi* | [**pcloud_networks_ports_getall**](docs/PCloudNetworksApi.md#pcloud_networks_ports_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id}/ports | Get all ports for this network
|
101
|
+
*IbmCloudPower::PCloudNetworksApi* | [**pcloud_networks_ports_post**](docs/PCloudNetworksApi.md#pcloud_networks_ports_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id}/ports | Perform port addition, deletion, and listing
|
102
|
+
*IbmCloudPower::PCloudNetworksApi* | [**pcloud_networks_ports_put**](docs/PCloudNetworksApi.md#pcloud_networks_ports_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id}/ports/{port_id} | Update a port's information
|
103
|
+
*IbmCloudPower::PCloudNetworksApi* | [**pcloud_networks_post**](docs/PCloudNetworksApi.md#pcloud_networks_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks | Create a new network
|
104
|
+
*IbmCloudPower::PCloudNetworksApi* | [**pcloud_networks_put**](docs/PCloudNetworksApi.md#pcloud_networks_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id} | Update a network
|
105
|
+
*IbmCloudPower::PCloudPVMInstancesApi* | [**pcloud_pvminstances_action_post**](docs/PCloudPVMInstancesApi.md#pcloud_pvminstances_action_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/action | Perform an action (start stop reboot immediate-shutdown reset) on a PVMInstance
|
106
|
+
*IbmCloudPower::PCloudPVMInstancesApi* | [**pcloud_pvminstances_capture_post**](docs/PCloudPVMInstancesApi.md#pcloud_pvminstances_capture_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/capture | Capture a PVM instance and create a deployable image
|
107
|
+
*IbmCloudPower::PCloudPVMInstancesApi* | [**pcloud_pvminstances_console_post**](docs/PCloudPVMInstancesApi.md#pcloud_pvminstances_console_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/console | Generate the noVNC console URL
|
108
|
+
*IbmCloudPower::PCloudPVMInstancesApi* | [**pcloud_pvminstances_delete**](docs/PCloudPVMInstancesApi.md#pcloud_pvminstances_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id} | Delete a PCloud PVM instance
|
109
|
+
*IbmCloudPower::PCloudPVMInstancesApi* | [**pcloud_pvminstances_get**](docs/PCloudPVMInstancesApi.md#pcloud_pvminstances_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id} | Get a PVM instance's current state or information
|
110
|
+
*IbmCloudPower::PCloudPVMInstancesApi* | [**pcloud_pvminstances_getall**](docs/PCloudPVMInstancesApi.md#pcloud_pvminstances_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances | Get all the PVM instances for this cloud instance
|
111
|
+
*IbmCloudPower::PCloudPVMInstancesApi* | [**pcloud_pvminstances_networks_delete**](docs/PCloudPVMInstancesApi.md#pcloud_pvminstances_networks_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks/{network_id} | Remove all addresses of network from a PVM instance
|
112
|
+
*IbmCloudPower::PCloudPVMInstancesApi* | [**pcloud_pvminstances_networks_get**](docs/PCloudPVMInstancesApi.md#pcloud_pvminstances_networks_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks/{network_id} | Get a PVM instance's network information
|
113
|
+
*IbmCloudPower::PCloudPVMInstancesApi* | [**pcloud_pvminstances_networks_getall**](docs/PCloudPVMInstancesApi.md#pcloud_pvminstances_networks_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks | Get all networks for this PVM instance
|
114
|
+
*IbmCloudPower::PCloudPVMInstancesApi* | [**pcloud_pvminstances_networks_post**](docs/PCloudPVMInstancesApi.md#pcloud_pvminstances_networks_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks | Perform network addition, deletion, and listing
|
115
|
+
*IbmCloudPower::PCloudPVMInstancesApi* | [**pcloud_pvminstances_operations_post**](docs/PCloudPVMInstancesApi.md#pcloud_pvminstances_operations_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/operations | Perform an operation on a PVMInstance
|
116
|
+
*IbmCloudPower::PCloudPVMInstancesApi* | [**pcloud_pvminstances_post**](docs/PCloudPVMInstancesApi.md#pcloud_pvminstances_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances | Create a new PVM instance
|
117
|
+
*IbmCloudPower::PCloudPVMInstancesApi* | [**pcloud_pvminstances_put**](docs/PCloudPVMInstancesApi.md#pcloud_pvminstances_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id} | Update a PCloud PVM instance
|
118
|
+
*IbmCloudPower::PCloudPVMInstancesApi* | [**pcloud_pvminstances_snapshots_getall**](docs/PCloudPVMInstancesApi.md#pcloud_pvminstances_snapshots_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/snapshots | Get all snapshots for this PVM instance
|
119
|
+
*IbmCloudPower::PCloudPVMInstancesApi* | [**pcloud_pvminstances_snapshots_post**](docs/PCloudPVMInstancesApi.md#pcloud_pvminstances_snapshots_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/snapshots | Create a PVM instance snapshot
|
120
|
+
*IbmCloudPower::PCloudPVMInstancesApi* | [**pcloud_pvminstances_snapshots_restore_post**](docs/PCloudPVMInstancesApi.md#pcloud_pvminstances_snapshots_restore_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/snapshots/{snapshot_id}/restore | Restore a PVM Instance snapshot
|
121
|
+
*IbmCloudPower::PCloudSAPApi* | [**pcloud_sap_get**](docs/PCloudSAPApi.md#pcloud_sap_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/sap/{sap_profile_id} | Get the information on an SAP profile
|
122
|
+
*IbmCloudPower::PCloudSAPApi* | [**pcloud_sap_getall**](docs/PCloudSAPApi.md#pcloud_sap_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/sap | Get list of SAP profiles
|
123
|
+
*IbmCloudPower::PCloudSAPApi* | [**pcloud_sap_post**](docs/PCloudSAPApi.md#pcloud_sap_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/sap | Create a new SAP PVM Instance
|
124
|
+
*IbmCloudPower::PCloudSnapshotsApi* | [**pcloud_cloudinstances_snapshots_delete**](docs/PCloudSnapshotsApi.md#pcloud_cloudinstances_snapshots_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/snapshots/{snapshot_id} | Delete a PVM instance snapshot of a cloud instance
|
125
|
+
*IbmCloudPower::PCloudSnapshotsApi* | [**pcloud_cloudinstances_snapshots_get**](docs/PCloudSnapshotsApi.md#pcloud_cloudinstances_snapshots_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/snapshots/{snapshot_id} | Get the detail of a snapshot
|
126
|
+
*IbmCloudPower::PCloudSnapshotsApi* | [**pcloud_cloudinstances_snapshots_getall**](docs/PCloudSnapshotsApi.md#pcloud_cloudinstances_snapshots_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/snapshots | List all PVM instance snapshots for this cloud instance
|
127
|
+
*IbmCloudPower::PCloudSnapshotsApi* | [**pcloud_cloudinstances_snapshots_put**](docs/PCloudSnapshotsApi.md#pcloud_cloudinstances_snapshots_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/snapshots/{snapshot_id} | Update a PVM instance snapshot
|
128
|
+
*IbmCloudPower::PCloudSystemPoolsApi* | [**pcloud_systempools_get**](docs/PCloudSystemPoolsApi.md#pcloud_systempools_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/system-pools | List of available system pools within a particular data center
|
129
|
+
*IbmCloudPower::PCloudTasksApi* | [**pcloud_tasks_delete**](docs/PCloudTasksApi.md#pcloud_tasks_delete) | **DELETE** /pcloud/v1/tasks/{task_id} | Delete a task
|
130
|
+
*IbmCloudPower::PCloudTasksApi* | [**pcloud_tasks_get**](docs/PCloudTasksApi.md#pcloud_tasks_get) | **GET** /pcloud/v1/tasks/{task_id} | Get a task
|
131
|
+
*IbmCloudPower::PCloudTenantsApi* | [**pcloud_tenants_get**](docs/PCloudTenantsApi.md#pcloud_tenants_get) | **GET** /pcloud/v1/tenants/{tenant_id} | Get a tenant's current state or information
|
132
|
+
*IbmCloudPower::PCloudTenantsApi* | [**pcloud_tenants_put**](docs/PCloudTenantsApi.md#pcloud_tenants_put) | **PUT** /pcloud/v1/tenants/{tenant_id} | Update a tenant
|
133
|
+
*IbmCloudPower::PCloudTenantsSSHKeysApi* | [**pcloud_tenants_sshkeys_delete**](docs/PCloudTenantsSSHKeysApi.md#pcloud_tenants_sshkeys_delete) | **DELETE** /pcloud/v1/tenants/{tenant_id}/sshkeys/{sshkey_name} | Delete a tenant's SSH key
|
134
|
+
*IbmCloudPower::PCloudTenantsSSHKeysApi* | [**pcloud_tenants_sshkeys_get**](docs/PCloudTenantsSSHKeysApi.md#pcloud_tenants_sshkeys_get) | **GET** /pcloud/v1/tenants/{tenant_id}/sshkeys/{sshkey_name} | Get a tenant's SSH Key by name
|
135
|
+
*IbmCloudPower::PCloudTenantsSSHKeysApi* | [**pcloud_tenants_sshkeys_getall**](docs/PCloudTenantsSSHKeysApi.md#pcloud_tenants_sshkeys_getall) | **GET** /pcloud/v1/tenants/{tenant_id}/sshkeys | List a tenant's SSH Keys
|
136
|
+
*IbmCloudPower::PCloudTenantsSSHKeysApi* | [**pcloud_tenants_sshkeys_post**](docs/PCloudTenantsSSHKeysApi.md#pcloud_tenants_sshkeys_post) | **POST** /pcloud/v1/tenants/{tenant_id}/sshkeys | Add a new SSH key to the tenant
|
137
|
+
*IbmCloudPower::PCloudTenantsSSHKeysApi* | [**pcloud_tenants_sshkeys_put**](docs/PCloudTenantsSSHKeysApi.md#pcloud_tenants_sshkeys_put) | **PUT** /pcloud/v1/tenants/{tenant_id}/sshkeys/{sshkey_name} | Update an SSH Key
|
138
|
+
*IbmCloudPower::PCloudVolumesApi* | [**pcloud_cloudinstances_volumes_delete**](docs/PCloudVolumesApi.md#pcloud_cloudinstances_volumes_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id} | Delete a cloud instance volume
|
139
|
+
*IbmCloudPower::PCloudVolumesApi* | [**pcloud_cloudinstances_volumes_get**](docs/PCloudVolumesApi.md#pcloud_cloudinstances_volumes_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id} | Detailed information of a volume
|
140
|
+
*IbmCloudPower::PCloudVolumesApi* | [**pcloud_cloudinstances_volumes_getall**](docs/PCloudVolumesApi.md#pcloud_cloudinstances_volumes_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes | List all volumes for this cloud instance
|
141
|
+
*IbmCloudPower::PCloudVolumesApi* | [**pcloud_cloudinstances_volumes_post**](docs/PCloudVolumesApi.md#pcloud_cloudinstances_volumes_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes | Create a new data volume
|
142
|
+
*IbmCloudPower::PCloudVolumesApi* | [**pcloud_cloudinstances_volumes_put**](docs/PCloudVolumesApi.md#pcloud_cloudinstances_volumes_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id} | Update a cloud instance volume
|
143
|
+
*IbmCloudPower::PCloudVolumesApi* | [**pcloud_pvminstances_volumes_delete**](docs/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
|
144
|
+
*IbmCloudPower::PCloudVolumesApi* | [**pcloud_pvminstances_volumes_get**](docs/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
|
145
|
+
*IbmCloudPower::PCloudVolumesApi* | [**pcloud_pvminstances_volumes_getall**](docs/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
|
146
|
+
*IbmCloudPower::PCloudVolumesApi* | [**pcloud_pvminstances_volumes_post**](docs/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
|
147
|
+
*IbmCloudPower::PCloudVolumesApi* | [**pcloud_pvminstances_volumes_put**](docs/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
|
148
|
+
*IbmCloudPower::PCloudVolumesApi* | [**pcloud_pvminstances_volumes_setboot_put**](docs/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
|
149
|
+
*IbmCloudPower::PCloudVolumesApi* | [**pcloud_v2_volumes_clone_post**](docs/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)
|
150
|
+
*IbmCloudPower::PCloudVolumesApi* | [**pcloud_v2_volumes_clonetasks_get**](docs/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
|
151
|
+
*IbmCloudPower::PCloudVolumesApi* | [**pcloud_v2_volumes_post**](docs/PCloudVolumesApi.md#pcloud_v2_volumes_post) | **POST** /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes | Create multiple data volumes from a single definition
|
152
|
+
*IbmCloudPower::PCloudVolumesApi* | [**pcloud_volumes_clone_post**](docs/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)
|
153
|
+
|
154
|
+
|
155
|
+
## Documentation for Models
|
156
|
+
|
157
|
+
- [IbmCloudPower::CloneTaskReference](docs/CloneTaskReference.md)
|
158
|
+
- [IbmCloudPower::CloneTaskStatus](docs/CloneTaskStatus.md)
|
159
|
+
- [IbmCloudPower::ClonedVolume](docs/ClonedVolume.md)
|
160
|
+
- [IbmCloudPower::ClonedVolumeDetail](docs/ClonedVolumeDetail.md)
|
161
|
+
- [IbmCloudPower::CloudInstance](docs/CloudInstance.md)
|
162
|
+
- [IbmCloudPower::CloudInstanceCreate](docs/CloudInstanceCreate.md)
|
163
|
+
- [IbmCloudPower::CloudInstanceReference](docs/CloudInstanceReference.md)
|
164
|
+
- [IbmCloudPower::CloudInstanceUpdate](docs/CloudInstanceUpdate.md)
|
165
|
+
- [IbmCloudPower::CloudInstanceUsageLimits](docs/CloudInstanceUsageLimits.md)
|
166
|
+
- [IbmCloudPower::CreateDataVolume](docs/CreateDataVolume.md)
|
167
|
+
- [IbmCloudPower::CreateImage](docs/CreateImage.md)
|
168
|
+
- [IbmCloudPower::Error](docs/Error.md)
|
169
|
+
- [IbmCloudPower::Event](docs/Event.md)
|
170
|
+
- [IbmCloudPower::EventUser](docs/EventUser.md)
|
171
|
+
- [IbmCloudPower::Events](docs/Events.md)
|
172
|
+
- [IbmCloudPower::ExportImage](docs/ExportImage.md)
|
173
|
+
- [IbmCloudPower::IPAddressRange](docs/IPAddressRange.md)
|
174
|
+
- [IbmCloudPower::Image](docs/Image.md)
|
175
|
+
- [IbmCloudPower::ImageReference](docs/ImageReference.md)
|
176
|
+
- [IbmCloudPower::ImageSpecifications](docs/ImageSpecifications.md)
|
177
|
+
- [IbmCloudPower::ImageVolume](docs/ImageVolume.md)
|
178
|
+
- [IbmCloudPower::Images](docs/Images.md)
|
179
|
+
- [IbmCloudPower::MinMaxDefault](docs/MinMaxDefault.md)
|
180
|
+
- [IbmCloudPower::MultiVolumesCreate](docs/MultiVolumesCreate.md)
|
181
|
+
- [IbmCloudPower::Network](docs/Network.md)
|
182
|
+
- [IbmCloudPower::NetworkCreate](docs/NetworkCreate.md)
|
183
|
+
- [IbmCloudPower::NetworkIpAddressMetrics](docs/NetworkIpAddressMetrics.md)
|
184
|
+
- [IbmCloudPower::NetworkPort](docs/NetworkPort.md)
|
185
|
+
- [IbmCloudPower::NetworkPortCreate](docs/NetworkPortCreate.md)
|
186
|
+
- [IbmCloudPower::NetworkPortPvmInstance](docs/NetworkPortPvmInstance.md)
|
187
|
+
- [IbmCloudPower::NetworkPortUpdate](docs/NetworkPortUpdate.md)
|
188
|
+
- [IbmCloudPower::NetworkPorts](docs/NetworkPorts.md)
|
189
|
+
- [IbmCloudPower::NetworkReference](docs/NetworkReference.md)
|
190
|
+
- [IbmCloudPower::NetworkUpdate](docs/NetworkUpdate.md)
|
191
|
+
- [IbmCloudPower::Networks](docs/Networks.md)
|
192
|
+
- [IbmCloudPower::Operations](docs/Operations.md)
|
193
|
+
- [IbmCloudPower::PVMInstance](docs/PVMInstance.md)
|
194
|
+
- [IbmCloudPower::PVMInstanceAction](docs/PVMInstanceAction.md)
|
195
|
+
- [IbmCloudPower::PVMInstanceAddNetwork](docs/PVMInstanceAddNetwork.md)
|
196
|
+
- [IbmCloudPower::PVMInstanceCapture](docs/PVMInstanceCapture.md)
|
197
|
+
- [IbmCloudPower::PVMInstanceClone](docs/PVMInstanceClone.md)
|
198
|
+
- [IbmCloudPower::PVMInstanceConsole](docs/PVMInstanceConsole.md)
|
199
|
+
- [IbmCloudPower::PVMInstanceCreate](docs/PVMInstanceCreate.md)
|
200
|
+
- [IbmCloudPower::PVMInstanceFault](docs/PVMInstanceFault.md)
|
201
|
+
- [IbmCloudPower::PVMInstanceHealth](docs/PVMInstanceHealth.md)
|
202
|
+
- [IbmCloudPower::PVMInstanceMultiCreate](docs/PVMInstanceMultiCreate.md)
|
203
|
+
- [IbmCloudPower::PVMInstanceNetwork](docs/PVMInstanceNetwork.md)
|
204
|
+
- [IbmCloudPower::PVMInstanceNetworks](docs/PVMInstanceNetworks.md)
|
205
|
+
- [IbmCloudPower::PVMInstanceOperation](docs/PVMInstanceOperation.md)
|
206
|
+
- [IbmCloudPower::PVMInstanceReference](docs/PVMInstanceReference.md)
|
207
|
+
- [IbmCloudPower::PVMInstanceRemoveNetwork](docs/PVMInstanceRemoveNetwork.md)
|
208
|
+
- [IbmCloudPower::PVMInstanceUpdate](docs/PVMInstanceUpdate.md)
|
209
|
+
- [IbmCloudPower::PVMInstanceUpdateResponse](docs/PVMInstanceUpdateResponse.md)
|
210
|
+
- [IbmCloudPower::PVMInstanceVolumeUpdate](docs/PVMInstanceVolumeUpdate.md)
|
211
|
+
- [IbmCloudPower::PVMInstances](docs/PVMInstances.md)
|
212
|
+
- [IbmCloudPower::PeeringNetwork](docs/PeeringNetwork.md)
|
213
|
+
- [IbmCloudPower::PinPolicy](docs/PinPolicy.md)
|
214
|
+
- [IbmCloudPower::SAPCreate](docs/SAPCreate.md)
|
215
|
+
- [IbmCloudPower::SAPProfile](docs/SAPProfile.md)
|
216
|
+
- [IbmCloudPower::SAPProfileReference](docs/SAPProfileReference.md)
|
217
|
+
- [IbmCloudPower::SAPProfiles](docs/SAPProfiles.md)
|
218
|
+
- [IbmCloudPower::SRC](docs/SRC.md)
|
219
|
+
- [IbmCloudPower::SSHKey](docs/SSHKey.md)
|
220
|
+
- [IbmCloudPower::SSHKeys](docs/SSHKeys.md)
|
221
|
+
- [IbmCloudPower::Snapshot](docs/Snapshot.md)
|
222
|
+
- [IbmCloudPower::SnapshotCreate](docs/SnapshotCreate.md)
|
223
|
+
- [IbmCloudPower::SnapshotCreateResponse](docs/SnapshotCreateResponse.md)
|
224
|
+
- [IbmCloudPower::SnapshotRestore](docs/SnapshotRestore.md)
|
225
|
+
- [IbmCloudPower::SnapshotUpdate](docs/SnapshotUpdate.md)
|
226
|
+
- [IbmCloudPower::Snapshots](docs/Snapshots.md)
|
227
|
+
- [IbmCloudPower::SoftwareLicenses](docs/SoftwareLicenses.md)
|
228
|
+
- [IbmCloudPower::StockImage](docs/StockImage.md)
|
229
|
+
- [IbmCloudPower::System](docs/System.md)
|
230
|
+
- [IbmCloudPower::SystemPool](docs/SystemPool.md)
|
231
|
+
- [IbmCloudPower::Task](docs/Task.md)
|
232
|
+
- [IbmCloudPower::TaskReference](docs/TaskReference.md)
|
233
|
+
- [IbmCloudPower::Tenant](docs/Tenant.md)
|
234
|
+
- [IbmCloudPower::TenantUpdate](docs/TenantUpdate.md)
|
235
|
+
- [IbmCloudPower::UpdateVolume](docs/UpdateVolume.md)
|
236
|
+
- [IbmCloudPower::VirtualCores](docs/VirtualCores.md)
|
237
|
+
- [IbmCloudPower::Volume](docs/Volume.md)
|
238
|
+
- [IbmCloudPower::VolumeInfo](docs/VolumeInfo.md)
|
239
|
+
- [IbmCloudPower::VolumeReference](docs/VolumeReference.md)
|
240
|
+
- [IbmCloudPower::Volumes](docs/Volumes.md)
|
241
|
+
- [IbmCloudPower::VolumesClone](docs/VolumesClone.md)
|
242
|
+
- [IbmCloudPower::VolumesCloneAsyncRequest](docs/VolumesCloneAsyncRequest.md)
|
243
|
+
- [IbmCloudPower::VolumesCloneCancel](docs/VolumesCloneCancel.md)
|
244
|
+
- [IbmCloudPower::VolumesCloneCreate](docs/VolumesCloneCreate.md)
|
245
|
+
- [IbmCloudPower::VolumesCloneDetail](docs/VolumesCloneDetail.md)
|
246
|
+
- [IbmCloudPower::VolumesCloneExecute](docs/VolumesCloneExecute.md)
|
247
|
+
- [IbmCloudPower::VolumesCloneRequest](docs/VolumesCloneRequest.md)
|
248
|
+
- [IbmCloudPower::VolumesCloneResponse](docs/VolumesCloneResponse.md)
|
249
|
+
- [IbmCloudPower::VolumesClones](docs/VolumesClones.md)
|
250
|
+
|
251
|
+
|
252
|
+
## Documentation for Authorization
|
253
|
+
|
254
|
+
All endpoints do not require authorization.
|
255
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
# IbmCloudPower::CloneTaskReference
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**clone_task_id** | **String** | ID of a long running PowerVC clone task |
|
8
|
+
**href** | **String** | Link to PowerVC clone task resource |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'IbmCloudPower'
|
14
|
+
|
15
|
+
instance = IbmCloudPower::CloneTaskReference.new(clone_task_id: null,
|
16
|
+
href: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# IbmCloudPower::CloneTaskStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**status** | **String** | Status of the clone volumes task |
|
8
|
+
**percent_complete** | **Integer** | Snapshot completion percentage |
|
9
|
+
**cloned_volumes** | [**Array<ClonedVolume>**](ClonedVolume.md) | List of cloned volumes created from the clone volumes task | [optional]
|
10
|
+
**failed_reason** | **String** | The reason the clone volumes task has failed | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'IbmCloudPower'
|
16
|
+
|
17
|
+
instance = IbmCloudPower::CloneTaskStatus.new(status: null,
|
18
|
+
percent_complete: null,
|
19
|
+
cloned_volumes: null,
|
20
|
+
failed_reason: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# IbmCloudPower::ClonedVolume
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**source_volume_id** | **String** | ID of the source volume to be cloned | [optional]
|
8
|
+
**cloned_volume_id** | **String** | ID of the new cloned volume | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'IbmCloudPower'
|
14
|
+
|
15
|
+
instance = IbmCloudPower::ClonedVolume.new(source_volume_id: null,
|
16
|
+
cloned_volume_id: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# IbmCloudPower::ClonedVolumeDetail
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**source** | [**VolumeInfo**](VolumeInfo.md) | |
|
8
|
+
**clone** | [**VolumeInfo**](VolumeInfo.md) | |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'IbmCloudPower'
|
14
|
+
|
15
|
+
instance = IbmCloudPower::ClonedVolumeDetail.new(source: null,
|
16
|
+
clone: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,37 @@
|
|
1
|
+
# IbmCloudPower::CloudInstance
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**cloud_instance_id** | **String** | Cloud Instance ID |
|
8
|
+
**name** | **String** | Cloud Instance Name |
|
9
|
+
**tenant_id** | **String** | The tenant ID that owns this cloud instance |
|
10
|
+
**openstack_id** | **String** | The open stack ID that controls this cloud instance |
|
11
|
+
**region** | **String** | The region the cloud instance lives |
|
12
|
+
**enabled** | **Boolean** | Indicates if the cloud instance is enabled |
|
13
|
+
**initialized** | **Boolean** | Indicates if the cloud instance is initialized and ready for use |
|
14
|
+
**limits** | [**CloudInstanceUsageLimits**](CloudInstanceUsageLimits.md) | |
|
15
|
+
**usage** | [**CloudInstanceUsageLimits**](CloudInstanceUsageLimits.md) | |
|
16
|
+
**capabilities** | **Array<String>** | Cloud Instance Capabilities | [optional]
|
17
|
+
**pvm_instances** | [**Array<PVMInstanceReference>**](PVMInstanceReference.md) | PVM instances owned by the Cloud Instance |
|
18
|
+
|
19
|
+
## Code Sample
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'IbmCloudPower'
|
23
|
+
|
24
|
+
instance = IbmCloudPower::CloudInstance.new(cloud_instance_id: null,
|
25
|
+
name: null,
|
26
|
+
tenant_id: null,
|
27
|
+
openstack_id: null,
|
28
|
+
region: null,
|
29
|
+
enabled: null,
|
30
|
+
initialized: null,
|
31
|
+
limits: null,
|
32
|
+
usage: null,
|
33
|
+
capabilities: null,
|
34
|
+
pvm_instances: null)
|
35
|
+
```
|
36
|
+
|
37
|
+
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# IbmCloudPower::CloudInstanceCreate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**tenant_id** | **String** | The tenant ID that owns this cloud instance |
|
8
|
+
**region** | **String** | The region the cloud instance lives |
|
9
|
+
**processors** | **Float** | Number of processors allowed |
|
10
|
+
**proc_units** | **Float** | Number of processor units allowed |
|
11
|
+
**memory** | **Float** | Amount of memory allowed |
|
12
|
+
**instances** | **Float** | Number of power instances allowed | [optional]
|
13
|
+
**storage** | **Float** | Amount of storage allowed (TB) | [optional]
|
14
|
+
|
15
|
+
## Code Sample
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'IbmCloudPower'
|
19
|
+
|
20
|
+
instance = IbmCloudPower::CloudInstanceCreate.new(tenant_id: null,
|
21
|
+
region: null,
|
22
|
+
processors: null,
|
23
|
+
proc_units: null,
|
24
|
+
memory: null,
|
25
|
+
instances: null,
|
26
|
+
storage: null)
|
27
|
+
```
|
28
|
+
|
29
|
+
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# IbmCloudPower::CloudInstanceReference
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**cloud_instance_id** | **String** | Cloud Instance ID |
|
8
|
+
**name** | **String** | Cloud Instance Name |
|
9
|
+
**region** | **String** | The region the cloud instance lives |
|
10
|
+
**enabled** | **Boolean** | Indicates if the cloud instance is enabled |
|
11
|
+
**initialized** | **Boolean** | Indicates if the cloud instance is initialized and ready for use |
|
12
|
+
**limits** | [**CloudInstanceUsageLimits**](CloudInstanceUsageLimits.md) | |
|
13
|
+
**capabilities** | **Array<String>** | Cloud Instance Capabilities | [optional]
|
14
|
+
**href** | **String** | Link to Cloud Instance resource |
|
15
|
+
|
16
|
+
## Code Sample
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'IbmCloudPower'
|
20
|
+
|
21
|
+
instance = IbmCloudPower::CloudInstanceReference.new(cloud_instance_id: null,
|
22
|
+
name: null,
|
23
|
+
region: null,
|
24
|
+
enabled: null,
|
25
|
+
initialized: null,
|
26
|
+
limits: null,
|
27
|
+
capabilities: null,
|
28
|
+
href: null)
|
29
|
+
```
|
30
|
+
|
31
|
+
|