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
@@ -0,0 +1,809 @@
|
|
1
|
+
# IbmCloudPower::PCloudPVMInstancesApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**pcloud_pvminstances_action_post**](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
|
8
|
+
[**pcloud_pvminstances_capture_post**](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
|
9
|
+
[**pcloud_pvminstances_console_post**](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
|
10
|
+
[**pcloud_pvminstances_delete**](PCloudPVMInstancesApi.md#pcloud_pvminstances_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id} | Delete a PCloud PVM instance
|
11
|
+
[**pcloud_pvminstances_get**](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
|
12
|
+
[**pcloud_pvminstances_getall**](PCloudPVMInstancesApi.md#pcloud_pvminstances_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances | Get all the PVM instances for this cloud instance
|
13
|
+
[**pcloud_pvminstances_networks_delete**](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
|
14
|
+
[**pcloud_pvminstances_networks_get**](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
|
15
|
+
[**pcloud_pvminstances_networks_getall**](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
|
16
|
+
[**pcloud_pvminstances_networks_post**](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
|
17
|
+
[**pcloud_pvminstances_operations_post**](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
|
18
|
+
[**pcloud_pvminstances_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances | Create a new PVM instance
|
19
|
+
[**pcloud_pvminstances_put**](PCloudPVMInstancesApi.md#pcloud_pvminstances_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id} | Update a PCloud PVM instance
|
20
|
+
[**pcloud_pvminstances_snapshots_getall**](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
|
21
|
+
[**pcloud_pvminstances_snapshots_post**](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
|
22
|
+
[**pcloud_pvminstances_snapshots_restore_post**](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
|
23
|
+
|
24
|
+
|
25
|
+
|
26
|
+
## pcloud_pvminstances_action_post
|
27
|
+
|
28
|
+
> Object pcloud_pvminstances_action_post(cloud_instance_id, pvm_instance_id, body)
|
29
|
+
|
30
|
+
Perform an action (start stop reboot immediate-shutdown reset) on a PVMInstance
|
31
|
+
|
32
|
+
### Example
|
33
|
+
|
34
|
+
```ruby
|
35
|
+
# load the gem
|
36
|
+
require 'ibm_cloud_power'
|
37
|
+
|
38
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
39
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
40
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
41
|
+
body = IbmCloudPower::PVMInstanceAction.new # PVMInstanceAction | Parameters for the desired action
|
42
|
+
|
43
|
+
begin
|
44
|
+
#Perform an action (start stop reboot immediate-shutdown reset) on a PVMInstance
|
45
|
+
result = api_instance.pcloud_pvminstances_action_post(cloud_instance_id, pvm_instance_id, body)
|
46
|
+
p result
|
47
|
+
rescue IbmCloudPower::ApiError => e
|
48
|
+
puts "Exception when calling PCloudPVMInstancesApi->pcloud_pvminstances_action_post: #{e}"
|
49
|
+
end
|
50
|
+
```
|
51
|
+
|
52
|
+
### Parameters
|
53
|
+
|
54
|
+
|
55
|
+
Name | Type | Description | Notes
|
56
|
+
------------- | ------------- | ------------- | -------------
|
57
|
+
**cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
|
58
|
+
**pvm_instance_id** | **String**| PCloud PVM Instance ID |
|
59
|
+
**body** | [**PVMInstanceAction**](PVMInstanceAction.md)| Parameters for the desired action |
|
60
|
+
|
61
|
+
### Return type
|
62
|
+
|
63
|
+
**Object**
|
64
|
+
|
65
|
+
### Authorization
|
66
|
+
|
67
|
+
No authorization required
|
68
|
+
|
69
|
+
### HTTP request headers
|
70
|
+
|
71
|
+
- **Content-Type**: application/json
|
72
|
+
- **Accept**: application/json
|
73
|
+
|
74
|
+
|
75
|
+
## pcloud_pvminstances_capture_post
|
76
|
+
|
77
|
+
> Object pcloud_pvminstances_capture_post(cloud_instance_id, pvm_instance_id, body)
|
78
|
+
|
79
|
+
Capture a PVM instance and create a deployable image
|
80
|
+
|
81
|
+
### Example
|
82
|
+
|
83
|
+
```ruby
|
84
|
+
# load the gem
|
85
|
+
require 'ibm_cloud_power'
|
86
|
+
|
87
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
88
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
89
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
90
|
+
body = IbmCloudPower::PVMInstanceCapture.new # PVMInstanceCapture | Parameters for the capture PVMInstance
|
91
|
+
|
92
|
+
begin
|
93
|
+
#Capture a PVM instance and create a deployable image
|
94
|
+
result = api_instance.pcloud_pvminstances_capture_post(cloud_instance_id, pvm_instance_id, body)
|
95
|
+
p result
|
96
|
+
rescue IbmCloudPower::ApiError => e
|
97
|
+
puts "Exception when calling PCloudPVMInstancesApi->pcloud_pvminstances_capture_post: #{e}"
|
98
|
+
end
|
99
|
+
```
|
100
|
+
|
101
|
+
### Parameters
|
102
|
+
|
103
|
+
|
104
|
+
Name | Type | Description | Notes
|
105
|
+
------------- | ------------- | ------------- | -------------
|
106
|
+
**cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
|
107
|
+
**pvm_instance_id** | **String**| PCloud PVM Instance ID |
|
108
|
+
**body** | [**PVMInstanceCapture**](PVMInstanceCapture.md)| Parameters for the capture PVMInstance |
|
109
|
+
|
110
|
+
### Return type
|
111
|
+
|
112
|
+
**Object**
|
113
|
+
|
114
|
+
### Authorization
|
115
|
+
|
116
|
+
No authorization required
|
117
|
+
|
118
|
+
### HTTP request headers
|
119
|
+
|
120
|
+
- **Content-Type**: application/json
|
121
|
+
- **Accept**: application/json
|
122
|
+
|
123
|
+
|
124
|
+
## pcloud_pvminstances_console_post
|
125
|
+
|
126
|
+
> PVMInstanceConsole pcloud_pvminstances_console_post(cloud_instance_id, pvm_instance_id)
|
127
|
+
|
128
|
+
Generate the noVNC console URL
|
129
|
+
|
130
|
+
### Example
|
131
|
+
|
132
|
+
```ruby
|
133
|
+
# load the gem
|
134
|
+
require 'ibm_cloud_power'
|
135
|
+
|
136
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
137
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
138
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
139
|
+
|
140
|
+
begin
|
141
|
+
#Generate the noVNC console URL
|
142
|
+
result = api_instance.pcloud_pvminstances_console_post(cloud_instance_id, pvm_instance_id)
|
143
|
+
p result
|
144
|
+
rescue IbmCloudPower::ApiError => e
|
145
|
+
puts "Exception when calling PCloudPVMInstancesApi->pcloud_pvminstances_console_post: #{e}"
|
146
|
+
end
|
147
|
+
```
|
148
|
+
|
149
|
+
### Parameters
|
150
|
+
|
151
|
+
|
152
|
+
Name | Type | Description | Notes
|
153
|
+
------------- | ------------- | ------------- | -------------
|
154
|
+
**cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
|
155
|
+
**pvm_instance_id** | **String**| PCloud PVM Instance ID |
|
156
|
+
|
157
|
+
### Return type
|
158
|
+
|
159
|
+
[**PVMInstanceConsole**](PVMInstanceConsole.md)
|
160
|
+
|
161
|
+
### Authorization
|
162
|
+
|
163
|
+
No authorization required
|
164
|
+
|
165
|
+
### HTTP request headers
|
166
|
+
|
167
|
+
- **Content-Type**: Not defined
|
168
|
+
- **Accept**: application/json
|
169
|
+
|
170
|
+
|
171
|
+
## pcloud_pvminstances_delete
|
172
|
+
|
173
|
+
> Object pcloud_pvminstances_delete(cloud_instance_id, pvm_instance_id)
|
174
|
+
|
175
|
+
Delete a PCloud PVM instance
|
176
|
+
|
177
|
+
### Example
|
178
|
+
|
179
|
+
```ruby
|
180
|
+
# load the gem
|
181
|
+
require 'ibm_cloud_power'
|
182
|
+
|
183
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
184
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
185
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
186
|
+
|
187
|
+
begin
|
188
|
+
#Delete a PCloud PVM instance
|
189
|
+
result = api_instance.pcloud_pvminstances_delete(cloud_instance_id, pvm_instance_id)
|
190
|
+
p result
|
191
|
+
rescue IbmCloudPower::ApiError => e
|
192
|
+
puts "Exception when calling PCloudPVMInstancesApi->pcloud_pvminstances_delete: #{e}"
|
193
|
+
end
|
194
|
+
```
|
195
|
+
|
196
|
+
### Parameters
|
197
|
+
|
198
|
+
|
199
|
+
Name | Type | Description | Notes
|
200
|
+
------------- | ------------- | ------------- | -------------
|
201
|
+
**cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
|
202
|
+
**pvm_instance_id** | **String**| PCloud PVM Instance ID |
|
203
|
+
|
204
|
+
### Return type
|
205
|
+
|
206
|
+
**Object**
|
207
|
+
|
208
|
+
### Authorization
|
209
|
+
|
210
|
+
No authorization required
|
211
|
+
|
212
|
+
### HTTP request headers
|
213
|
+
|
214
|
+
- **Content-Type**: Not defined
|
215
|
+
- **Accept**: */*
|
216
|
+
|
217
|
+
|
218
|
+
## pcloud_pvminstances_get
|
219
|
+
|
220
|
+
> PVMInstance pcloud_pvminstances_get(cloud_instance_id, pvm_instance_id)
|
221
|
+
|
222
|
+
Get a PVM instance's current state or information
|
223
|
+
|
224
|
+
### Example
|
225
|
+
|
226
|
+
```ruby
|
227
|
+
# load the gem
|
228
|
+
require 'ibm_cloud_power'
|
229
|
+
|
230
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
231
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
232
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
233
|
+
|
234
|
+
begin
|
235
|
+
#Get a PVM instance's current state or information
|
236
|
+
result = api_instance.pcloud_pvminstances_get(cloud_instance_id, pvm_instance_id)
|
237
|
+
p result
|
238
|
+
rescue IbmCloudPower::ApiError => e
|
239
|
+
puts "Exception when calling PCloudPVMInstancesApi->pcloud_pvminstances_get: #{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
|
+
**pvm_instance_id** | **String**| PCloud PVM Instance ID |
|
250
|
+
|
251
|
+
### Return type
|
252
|
+
|
253
|
+
[**PVMInstance**](PVMInstance.md)
|
254
|
+
|
255
|
+
### Authorization
|
256
|
+
|
257
|
+
No authorization required
|
258
|
+
|
259
|
+
### HTTP request headers
|
260
|
+
|
261
|
+
- **Content-Type**: Not defined
|
262
|
+
- **Accept**: application/json
|
263
|
+
|
264
|
+
|
265
|
+
## pcloud_pvminstances_getall
|
266
|
+
|
267
|
+
> PVMInstances pcloud_pvminstances_getall(cloud_instance_id)
|
268
|
+
|
269
|
+
Get all the PVM instances for this cloud instance
|
270
|
+
|
271
|
+
### Example
|
272
|
+
|
273
|
+
```ruby
|
274
|
+
# load the gem
|
275
|
+
require 'ibm_cloud_power'
|
276
|
+
|
277
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
278
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
279
|
+
|
280
|
+
begin
|
281
|
+
#Get all the PVM instances for this cloud instance
|
282
|
+
result = api_instance.pcloud_pvminstances_getall(cloud_instance_id)
|
283
|
+
p result
|
284
|
+
rescue IbmCloudPower::ApiError => e
|
285
|
+
puts "Exception when calling PCloudPVMInstancesApi->pcloud_pvminstances_getall: #{e}"
|
286
|
+
end
|
287
|
+
```
|
288
|
+
|
289
|
+
### Parameters
|
290
|
+
|
291
|
+
|
292
|
+
Name | Type | Description | Notes
|
293
|
+
------------- | ------------- | ------------- | -------------
|
294
|
+
**cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
|
295
|
+
|
296
|
+
### Return type
|
297
|
+
|
298
|
+
[**PVMInstances**](PVMInstances.md)
|
299
|
+
|
300
|
+
### Authorization
|
301
|
+
|
302
|
+
No authorization required
|
303
|
+
|
304
|
+
### HTTP request headers
|
305
|
+
|
306
|
+
- **Content-Type**: Not defined
|
307
|
+
- **Accept**: application/json
|
308
|
+
|
309
|
+
|
310
|
+
## pcloud_pvminstances_networks_delete
|
311
|
+
|
312
|
+
> Object pcloud_pvminstances_networks_delete(cloud_instance_id, pvm_instance_id, network_id, opts)
|
313
|
+
|
314
|
+
Remove all addresses of network from a PVM instance
|
315
|
+
|
316
|
+
### Example
|
317
|
+
|
318
|
+
```ruby
|
319
|
+
# load the gem
|
320
|
+
require 'ibm_cloud_power'
|
321
|
+
|
322
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
323
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
324
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
325
|
+
network_id = 'network_id_example' # String | Network ID
|
326
|
+
opts = {
|
327
|
+
body: IbmCloudPower::PVMInstanceRemoveNetwork.new # PVMInstanceRemoveNetwork | Remove a network from PVM Instance parameters
|
328
|
+
}
|
329
|
+
|
330
|
+
begin
|
331
|
+
#Remove all addresses of network from a PVM instance
|
332
|
+
result = api_instance.pcloud_pvminstances_networks_delete(cloud_instance_id, pvm_instance_id, network_id, opts)
|
333
|
+
p result
|
334
|
+
rescue IbmCloudPower::ApiError => e
|
335
|
+
puts "Exception when calling PCloudPVMInstancesApi->pcloud_pvminstances_networks_delete: #{e}"
|
336
|
+
end
|
337
|
+
```
|
338
|
+
|
339
|
+
### Parameters
|
340
|
+
|
341
|
+
|
342
|
+
Name | Type | Description | Notes
|
343
|
+
------------- | ------------- | ------------- | -------------
|
344
|
+
**cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
|
345
|
+
**pvm_instance_id** | **String**| PCloud PVM Instance ID |
|
346
|
+
**network_id** | **String**| Network ID |
|
347
|
+
**body** | [**PVMInstanceRemoveNetwork**](PVMInstanceRemoveNetwork.md)| Remove a network from PVM Instance parameters | [optional]
|
348
|
+
|
349
|
+
### Return type
|
350
|
+
|
351
|
+
**Object**
|
352
|
+
|
353
|
+
### Authorization
|
354
|
+
|
355
|
+
No authorization required
|
356
|
+
|
357
|
+
### HTTP request headers
|
358
|
+
|
359
|
+
- **Content-Type**: application/json
|
360
|
+
- **Accept**: application/json
|
361
|
+
|
362
|
+
|
363
|
+
## pcloud_pvminstances_networks_get
|
364
|
+
|
365
|
+
> PVMInstanceNetworks pcloud_pvminstances_networks_get(cloud_instance_id, pvm_instance_id, network_id)
|
366
|
+
|
367
|
+
Get a PVM instance's network information
|
368
|
+
|
369
|
+
### Example
|
370
|
+
|
371
|
+
```ruby
|
372
|
+
# load the gem
|
373
|
+
require 'ibm_cloud_power'
|
374
|
+
|
375
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
376
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
377
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
378
|
+
network_id = 'network_id_example' # String | Network ID
|
379
|
+
|
380
|
+
begin
|
381
|
+
#Get a PVM instance's network information
|
382
|
+
result = api_instance.pcloud_pvminstances_networks_get(cloud_instance_id, pvm_instance_id, network_id)
|
383
|
+
p result
|
384
|
+
rescue IbmCloudPower::ApiError => e
|
385
|
+
puts "Exception when calling PCloudPVMInstancesApi->pcloud_pvminstances_networks_get: #{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
|
+
**network_id** | **String**| Network ID |
|
397
|
+
|
398
|
+
### Return type
|
399
|
+
|
400
|
+
[**PVMInstanceNetworks**](PVMInstanceNetworks.md)
|
401
|
+
|
402
|
+
### Authorization
|
403
|
+
|
404
|
+
No authorization required
|
405
|
+
|
406
|
+
### HTTP request headers
|
407
|
+
|
408
|
+
- **Content-Type**: Not defined
|
409
|
+
- **Accept**: application/json
|
410
|
+
|
411
|
+
|
412
|
+
## pcloud_pvminstances_networks_getall
|
413
|
+
|
414
|
+
> PVMInstanceNetworks pcloud_pvminstances_networks_getall(cloud_instance_id, pvm_instance_id)
|
415
|
+
|
416
|
+
Get all networks for this PVM instance
|
417
|
+
|
418
|
+
### Example
|
419
|
+
|
420
|
+
```ruby
|
421
|
+
# load the gem
|
422
|
+
require 'ibm_cloud_power'
|
423
|
+
|
424
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
425
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
426
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
427
|
+
|
428
|
+
begin
|
429
|
+
#Get all networks for this PVM instance
|
430
|
+
result = api_instance.pcloud_pvminstances_networks_getall(cloud_instance_id, pvm_instance_id)
|
431
|
+
p result
|
432
|
+
rescue IbmCloudPower::ApiError => e
|
433
|
+
puts "Exception when calling PCloudPVMInstancesApi->pcloud_pvminstances_networks_getall: #{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
|
+
|
445
|
+
### Return type
|
446
|
+
|
447
|
+
[**PVMInstanceNetworks**](PVMInstanceNetworks.md)
|
448
|
+
|
449
|
+
### Authorization
|
450
|
+
|
451
|
+
No authorization required
|
452
|
+
|
453
|
+
### HTTP request headers
|
454
|
+
|
455
|
+
- **Content-Type**: Not defined
|
456
|
+
- **Accept**: application/json
|
457
|
+
|
458
|
+
|
459
|
+
## pcloud_pvminstances_networks_post
|
460
|
+
|
461
|
+
> PVMInstanceNetwork pcloud_pvminstances_networks_post(cloud_instance_id, pvm_instance_id, body)
|
462
|
+
|
463
|
+
Perform network addition, deletion, and listing
|
464
|
+
|
465
|
+
### Example
|
466
|
+
|
467
|
+
```ruby
|
468
|
+
# load the gem
|
469
|
+
require 'ibm_cloud_power'
|
470
|
+
|
471
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
472
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
473
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
474
|
+
body = IbmCloudPower::PVMInstanceAddNetwork.new # PVMInstanceAddNetwork | Add network to PVM Instance parameters
|
475
|
+
|
476
|
+
begin
|
477
|
+
#Perform network addition, deletion, and listing
|
478
|
+
result = api_instance.pcloud_pvminstances_networks_post(cloud_instance_id, pvm_instance_id, body)
|
479
|
+
p result
|
480
|
+
rescue IbmCloudPower::ApiError => e
|
481
|
+
puts "Exception when calling PCloudPVMInstancesApi->pcloud_pvminstances_networks_post: #{e}"
|
482
|
+
end
|
483
|
+
```
|
484
|
+
|
485
|
+
### Parameters
|
486
|
+
|
487
|
+
|
488
|
+
Name | Type | Description | Notes
|
489
|
+
------------- | ------------- | ------------- | -------------
|
490
|
+
**cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
|
491
|
+
**pvm_instance_id** | **String**| PCloud PVM Instance ID |
|
492
|
+
**body** | [**PVMInstanceAddNetwork**](PVMInstanceAddNetwork.md)| Add network to PVM Instance parameters |
|
493
|
+
|
494
|
+
### Return type
|
495
|
+
|
496
|
+
[**PVMInstanceNetwork**](PVMInstanceNetwork.md)
|
497
|
+
|
498
|
+
### Authorization
|
499
|
+
|
500
|
+
No authorization required
|
501
|
+
|
502
|
+
### HTTP request headers
|
503
|
+
|
504
|
+
- **Content-Type**: application/json
|
505
|
+
- **Accept**: application/json
|
506
|
+
|
507
|
+
|
508
|
+
## pcloud_pvminstances_operations_post
|
509
|
+
|
510
|
+
> Object pcloud_pvminstances_operations_post(cloud_instance_id, pvm_instance_id, body)
|
511
|
+
|
512
|
+
Perform an operation on a PVMInstance
|
513
|
+
|
514
|
+
### Example
|
515
|
+
|
516
|
+
```ruby
|
517
|
+
# load the gem
|
518
|
+
require 'ibm_cloud_power'
|
519
|
+
|
520
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
521
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
522
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
523
|
+
body = IbmCloudPower::PVMInstanceOperation.new # PVMInstanceOperation | Parameters for the desired operations
|
524
|
+
|
525
|
+
begin
|
526
|
+
#Perform an operation on a PVMInstance
|
527
|
+
result = api_instance.pcloud_pvminstances_operations_post(cloud_instance_id, pvm_instance_id, body)
|
528
|
+
p result
|
529
|
+
rescue IbmCloudPower::ApiError => e
|
530
|
+
puts "Exception when calling PCloudPVMInstancesApi->pcloud_pvminstances_operations_post: #{e}"
|
531
|
+
end
|
532
|
+
```
|
533
|
+
|
534
|
+
### Parameters
|
535
|
+
|
536
|
+
|
537
|
+
Name | Type | Description | Notes
|
538
|
+
------------- | ------------- | ------------- | -------------
|
539
|
+
**cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
|
540
|
+
**pvm_instance_id** | **String**| PCloud PVM Instance ID |
|
541
|
+
**body** | [**PVMInstanceOperation**](PVMInstanceOperation.md)| Parameters for the desired operations |
|
542
|
+
|
543
|
+
### Return type
|
544
|
+
|
545
|
+
**Object**
|
546
|
+
|
547
|
+
### Authorization
|
548
|
+
|
549
|
+
No authorization required
|
550
|
+
|
551
|
+
### HTTP request headers
|
552
|
+
|
553
|
+
- **Content-Type**: application/json
|
554
|
+
- **Accept**: application/json
|
555
|
+
|
556
|
+
|
557
|
+
## pcloud_pvminstances_post
|
558
|
+
|
559
|
+
> Array<PVMInstance> pcloud_pvminstances_post(cloud_instance_id, body, opts)
|
560
|
+
|
561
|
+
Create a new PVM instance
|
562
|
+
|
563
|
+
The order of network IDs passed in will be the order of interfaces defined to the VM.
|
564
|
+
|
565
|
+
### Example
|
566
|
+
|
567
|
+
```ruby
|
568
|
+
# load the gem
|
569
|
+
require 'ibm_cloud_power'
|
570
|
+
|
571
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
572
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
573
|
+
body = IbmCloudPower::PVMInstanceCreate.new # PVMInstanceCreate | Parameters for the creation of a new tenant
|
574
|
+
opts = {
|
575
|
+
skip_host_validation: true # Boolean | Option to skip host validation on PVMInstance Create API
|
576
|
+
}
|
577
|
+
|
578
|
+
begin
|
579
|
+
#Create a new PVM instance
|
580
|
+
result = api_instance.pcloud_pvminstances_post(cloud_instance_id, body, opts)
|
581
|
+
p result
|
582
|
+
rescue IbmCloudPower::ApiError => e
|
583
|
+
puts "Exception when calling PCloudPVMInstancesApi->pcloud_pvminstances_post: #{e}"
|
584
|
+
end
|
585
|
+
```
|
586
|
+
|
587
|
+
### Parameters
|
588
|
+
|
589
|
+
|
590
|
+
Name | Type | Description | Notes
|
591
|
+
------------- | ------------- | ------------- | -------------
|
592
|
+
**cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
|
593
|
+
**body** | [**PVMInstanceCreate**](PVMInstanceCreate.md)| Parameters for the creation of a new tenant |
|
594
|
+
**skip_host_validation** | **Boolean**| Option to skip host validation on PVMInstance Create API | [optional]
|
595
|
+
|
596
|
+
### Return type
|
597
|
+
|
598
|
+
[**Array<PVMInstance>**](PVMInstance.md)
|
599
|
+
|
600
|
+
### Authorization
|
601
|
+
|
602
|
+
No authorization required
|
603
|
+
|
604
|
+
### HTTP request headers
|
605
|
+
|
606
|
+
- **Content-Type**: application/json
|
607
|
+
- **Accept**: application/json
|
608
|
+
|
609
|
+
|
610
|
+
## pcloud_pvminstances_put
|
611
|
+
|
612
|
+
> PVMInstanceUpdateResponse pcloud_pvminstances_put(cloud_instance_id, pvm_instance_id, body)
|
613
|
+
|
614
|
+
Update a PCloud PVM instance
|
615
|
+
|
616
|
+
### Example
|
617
|
+
|
618
|
+
```ruby
|
619
|
+
# load the gem
|
620
|
+
require 'ibm_cloud_power'
|
621
|
+
|
622
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
623
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
624
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
625
|
+
body = IbmCloudPower::PVMInstanceUpdate.new # PVMInstanceUpdate | Parameters to update a PCloud PVM instance
|
626
|
+
|
627
|
+
begin
|
628
|
+
#Update a PCloud PVM instance
|
629
|
+
result = api_instance.pcloud_pvminstances_put(cloud_instance_id, pvm_instance_id, body)
|
630
|
+
p result
|
631
|
+
rescue IbmCloudPower::ApiError => e
|
632
|
+
puts "Exception when calling PCloudPVMInstancesApi->pcloud_pvminstances_put: #{e}"
|
633
|
+
end
|
634
|
+
```
|
635
|
+
|
636
|
+
### Parameters
|
637
|
+
|
638
|
+
|
639
|
+
Name | Type | Description | Notes
|
640
|
+
------------- | ------------- | ------------- | -------------
|
641
|
+
**cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
|
642
|
+
**pvm_instance_id** | **String**| PCloud PVM Instance ID |
|
643
|
+
**body** | [**PVMInstanceUpdate**](PVMInstanceUpdate.md)| Parameters to update a PCloud PVM instance |
|
644
|
+
|
645
|
+
### Return type
|
646
|
+
|
647
|
+
[**PVMInstanceUpdateResponse**](PVMInstanceUpdateResponse.md)
|
648
|
+
|
649
|
+
### Authorization
|
650
|
+
|
651
|
+
No authorization required
|
652
|
+
|
653
|
+
### HTTP request headers
|
654
|
+
|
655
|
+
- **Content-Type**: application/json
|
656
|
+
- **Accept**: application/json
|
657
|
+
|
658
|
+
|
659
|
+
## pcloud_pvminstances_snapshots_getall
|
660
|
+
|
661
|
+
> Snapshots pcloud_pvminstances_snapshots_getall(cloud_instance_id, pvm_instance_id)
|
662
|
+
|
663
|
+
Get all snapshots for this PVM instance
|
664
|
+
|
665
|
+
### Example
|
666
|
+
|
667
|
+
```ruby
|
668
|
+
# load the gem
|
669
|
+
require 'ibm_cloud_power'
|
670
|
+
|
671
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
672
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
673
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
674
|
+
|
675
|
+
begin
|
676
|
+
#Get all snapshots for this PVM instance
|
677
|
+
result = api_instance.pcloud_pvminstances_snapshots_getall(cloud_instance_id, pvm_instance_id)
|
678
|
+
p result
|
679
|
+
rescue IbmCloudPower::ApiError => e
|
680
|
+
puts "Exception when calling PCloudPVMInstancesApi->pcloud_pvminstances_snapshots_getall: #{e}"
|
681
|
+
end
|
682
|
+
```
|
683
|
+
|
684
|
+
### Parameters
|
685
|
+
|
686
|
+
|
687
|
+
Name | Type | Description | Notes
|
688
|
+
------------- | ------------- | ------------- | -------------
|
689
|
+
**cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
|
690
|
+
**pvm_instance_id** | **String**| PCloud PVM Instance ID |
|
691
|
+
|
692
|
+
### Return type
|
693
|
+
|
694
|
+
[**Snapshots**](Snapshots.md)
|
695
|
+
|
696
|
+
### Authorization
|
697
|
+
|
698
|
+
No authorization required
|
699
|
+
|
700
|
+
### HTTP request headers
|
701
|
+
|
702
|
+
- **Content-Type**: Not defined
|
703
|
+
- **Accept**: application/json
|
704
|
+
|
705
|
+
|
706
|
+
## pcloud_pvminstances_snapshots_post
|
707
|
+
|
708
|
+
> SnapshotCreateResponse pcloud_pvminstances_snapshots_post(cloud_instance_id, pvm_instance_id, body)
|
709
|
+
|
710
|
+
Create a PVM instance snapshot
|
711
|
+
|
712
|
+
### Example
|
713
|
+
|
714
|
+
```ruby
|
715
|
+
# load the gem
|
716
|
+
require 'ibm_cloud_power'
|
717
|
+
|
718
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
719
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
720
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
721
|
+
body = IbmCloudPower::SnapshotCreate.new # SnapshotCreate | PVM Instance snapshot create parameters
|
722
|
+
|
723
|
+
begin
|
724
|
+
#Create a PVM instance snapshot
|
725
|
+
result = api_instance.pcloud_pvminstances_snapshots_post(cloud_instance_id, pvm_instance_id, body)
|
726
|
+
p result
|
727
|
+
rescue IbmCloudPower::ApiError => e
|
728
|
+
puts "Exception when calling PCloudPVMInstancesApi->pcloud_pvminstances_snapshots_post: #{e}"
|
729
|
+
end
|
730
|
+
```
|
731
|
+
|
732
|
+
### Parameters
|
733
|
+
|
734
|
+
|
735
|
+
Name | Type | Description | Notes
|
736
|
+
------------- | ------------- | ------------- | -------------
|
737
|
+
**cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
|
738
|
+
**pvm_instance_id** | **String**| PCloud PVM Instance ID |
|
739
|
+
**body** | [**SnapshotCreate**](SnapshotCreate.md)| PVM Instance snapshot create parameters |
|
740
|
+
|
741
|
+
### Return type
|
742
|
+
|
743
|
+
[**SnapshotCreateResponse**](SnapshotCreateResponse.md)
|
744
|
+
|
745
|
+
### Authorization
|
746
|
+
|
747
|
+
No authorization required
|
748
|
+
|
749
|
+
### HTTP request headers
|
750
|
+
|
751
|
+
- **Content-Type**: application/json
|
752
|
+
- **Accept**: application/json
|
753
|
+
|
754
|
+
|
755
|
+
## pcloud_pvminstances_snapshots_restore_post
|
756
|
+
|
757
|
+
> pcloud_pvminstances_snapshots_restore_post(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts)
|
758
|
+
|
759
|
+
Restore a PVM Instance snapshot
|
760
|
+
|
761
|
+
To roll back the clone operation, append '?restore_fail_action=rollback' to the cURL URL. If you'd like to try the clone operation again, append '?restore_fail_action=retry' to the cURL URL.
|
762
|
+
|
763
|
+
### Example
|
764
|
+
|
765
|
+
```ruby
|
766
|
+
# load the gem
|
767
|
+
require 'ibm_cloud_power'
|
768
|
+
|
769
|
+
api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
|
770
|
+
cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
|
771
|
+
pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
|
772
|
+
snapshot_id = 'snapshot_id_example' # String | PVM Instance snapshot id
|
773
|
+
body = IbmCloudPower::SnapshotRestore.new # SnapshotRestore | PVM Instance snapshot restore parameters
|
774
|
+
opts = {
|
775
|
+
restore_fail_action: 'restore_fail_action_example' # String | Action to take on a failed snapshot restore
|
776
|
+
}
|
777
|
+
|
778
|
+
begin
|
779
|
+
#Restore a PVM Instance snapshot
|
780
|
+
api_instance.pcloud_pvminstances_snapshots_restore_post(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts)
|
781
|
+
rescue IbmCloudPower::ApiError => e
|
782
|
+
puts "Exception when calling PCloudPVMInstancesApi->pcloud_pvminstances_snapshots_restore_post: #{e}"
|
783
|
+
end
|
784
|
+
```
|
785
|
+
|
786
|
+
### Parameters
|
787
|
+
|
788
|
+
|
789
|
+
Name | Type | Description | Notes
|
790
|
+
------------- | ------------- | ------------- | -------------
|
791
|
+
**cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance |
|
792
|
+
**pvm_instance_id** | **String**| PCloud PVM Instance ID |
|
793
|
+
**snapshot_id** | **String**| PVM Instance snapshot id |
|
794
|
+
**body** | [**SnapshotRestore**](SnapshotRestore.md)| PVM Instance snapshot restore parameters |
|
795
|
+
**restore_fail_action** | **String**| Action to take on a failed snapshot restore | [optional]
|
796
|
+
|
797
|
+
### Return type
|
798
|
+
|
799
|
+
nil (empty response body)
|
800
|
+
|
801
|
+
### Authorization
|
802
|
+
|
803
|
+
No authorization required
|
804
|
+
|
805
|
+
### HTTP request headers
|
806
|
+
|
807
|
+
- **Content-Type**: application/json
|
808
|
+
- **Accept**: application/json
|
809
|
+
|