ibm_cloud_power 1.0.2 → 1.1.0

data/docs/PCloudEventsApi.md

@@ -76,7 +76,7 @@ require 'ibm_cloud_power'
 
 api_instance = IbmCloudPower::PCloudEventsApi.new
 cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
-time = 'time_example' # String | A time in either ISO 8601 or unix epoch format
+time = 'time_example' # String | (deprecated - use from_time) A time in either ISO 8601 or unix epoch format
 opts = {
   accept_language: 'accept_language_example' # String | The language requested for the return document
 }
@@ -96,7 +96,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
- **time** | **String**| A time in either ISO 8601 or unix epoch format | 
+ **time** | **String**| (deprecated - use from_time) A time in either ISO 8601 or unix epoch format | 
  **accept_language** | **String**| The language requested for the return document | [optional] 
 
 ### Return type

data/docs/PCloudImagesApi.md

@@ -9,8 +9,10 @@ Method | HTTP request | Description
 [**pcloud_cloudinstances_images_get**](PCloudImagesApi.md#pcloud_cloudinstances_images_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/images/{image_id} | Detailed information of an image
 [**pcloud_cloudinstances_images_getall**](PCloudImagesApi.md#pcloud_cloudinstances_images_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/images | List all of the images for this cloud instance
 [**pcloud_cloudinstances_images_post**](PCloudImagesApi.md#pcloud_cloudinstances_images_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/images | Create a new image from available images
-[**pcloud_images_get**](PCloudImagesApi.md#pcloud_images_get) | **GET** /pcloud/v1/images/{image_id} | Detailed information of an available image
-[**pcloud_images_getall**](PCloudImagesApi.md#pcloud_images_getall) | **GET** /pcloud/v1/images | List all images available for copying into cloud instances
+[**pcloud_cloudinstances_stockimages_get**](PCloudImagesApi.md#pcloud_cloudinstances_stockimages_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images/{image_id} | Detailed info of an available stock image
+[**pcloud_cloudinstances_stockimages_getall**](PCloudImagesApi.md#pcloud_cloudinstances_stockimages_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images | List all available stock images
+[**pcloud_images_get**](PCloudImagesApi.md#pcloud_images_get) | **GET** /pcloud/v1/images/{image_id} | Deprecated for /pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/stock-images/{image_id} - Detailed info of an available stock image
+[**pcloud_images_getall**](PCloudImagesApi.md#pcloud_images_getall) | **GET** /pcloud/v1/images | Deprecated for /pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/stock-images - List all available stock images
 
 
 
@@ -249,11 +251,107 @@ No authorization required
 - **Accept**: application/json
 
 
+## pcloud_cloudinstances_stockimages_get
+
+> Image pcloud_cloudinstances_stockimages_get(cloud_instance_id, image_id)
+
+Detailed info of an available stock image
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::PCloudImagesApi.new
+cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
+image_id = 'image_id_example' # String | Image ID of a image
+
+begin
+  #Detailed info of an available stock image
+  result = api_instance.pcloud_cloudinstances_stockimages_get(cloud_instance_id, image_id)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Exception when calling PCloudImagesApi->pcloud_cloudinstances_stockimages_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
+ **image_id** | **String**| Image ID of a image | 
+
+### Return type
+
+[**Image**](Image.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## pcloud_cloudinstances_stockimages_getall
+
+> Images pcloud_cloudinstances_stockimages_getall(cloud_instance_id, opts)
+
+List all available stock images
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::PCloudImagesApi.new
+cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
+opts = {
+  sap: true # Boolean | Include SAP images with get available stock images
+}
+
+begin
+  #List all available stock images
+  result = api_instance.pcloud_cloudinstances_stockimages_getall(cloud_instance_id, opts)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Exception when calling PCloudImagesApi->pcloud_cloudinstances_stockimages_getall: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
+ **sap** | **Boolean**| Include SAP images with get available stock images | [optional] 
+
+### Return type
+
+[**Images**](Images.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## pcloud_images_get
 
 > Images pcloud_images_get(image_id)
 
-Detailed information of an available image
+Deprecated for /pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/stock-images/{image_id} - Detailed info of an available stock image
 
 ### Example
 
@@ -265,7 +363,7 @@ api_instance = IbmCloudPower::PCloudImagesApi.new
 image_id = 'image_id_example' # String | Image ID of a image
 
 begin
-  #Detailed information of an available image
+  #Deprecated for /pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/stock-images/{image_id} - Detailed info of an available stock image
   result = api_instance.pcloud_images_get(image_id)
   p result
 rescue IbmCloudPower::ApiError => e
@@ -298,7 +396,7 @@ No authorization required
 
 > Images pcloud_images_getall(opts)
 
-List all images available for copying into cloud instances
+Deprecated for /pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/stock-images - List all available stock images
 
 ### Example
 
@@ -312,7 +410,7 @@ opts = {
 }
 
 begin
-  #List all images available for copying into cloud instances
+  #Deprecated for /pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/stock-images - List all available stock images
   result = api_instance.pcloud_images_getall(opts)
   p result
 rescue IbmCloudPower::ApiError => e

data/docs/PCloudPVMInstancesApi.md

@@ -6,6 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**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
 [**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
+[**pcloud_pvminstances_clone_post**](PCloudPVMInstancesApi.md#pcloud_pvminstances_clone_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/clone | Clone a PVMInstance
 [**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
 [**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
 [**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
@@ -121,6 +122,55 @@ No authorization required
 - **Accept**: application/json
 
 
+## pcloud_pvminstances_clone_post
+
+> PVMInstance pcloud_pvminstances_clone_post(cloud_instance_id, pvm_instance_id, body)
+
+Clone a PVMInstance
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
+cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
+pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
+body = IbmCloudPower::PVMInstanceClone.new # PVMInstanceClone | Clone PVM Instance parameters
+
+begin
+  #Clone a PVMInstance
+  result = api_instance.pcloud_pvminstances_clone_post(cloud_instance_id, pvm_instance_id, body)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Exception when calling PCloudPVMInstancesApi->pcloud_pvminstances_clone_post: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
+ **pvm_instance_id** | **String**| PCloud PVM Instance ID | 
+ **body** | [**PVMInstanceClone**](PVMInstanceClone.md)| Clone PVM Instance parameters | 
+
+### Return type
+
+[**PVMInstance**](PVMInstance.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## pcloud_pvminstances_console_post
 
 > PVMInstanceConsole pcloud_pvminstances_console_post(cloud_instance_id, pvm_instance_id)
@@ -170,7 +220,7 @@ No authorization required
 
 ## pcloud_pvminstances_delete
 
-> Object pcloud_pvminstances_delete(cloud_instance_id, pvm_instance_id)
+> Object pcloud_pvminstances_delete(cloud_instance_id, pvm_instance_id, opts)
 
 Delete a PCloud PVM instance
 
@@ -183,10 +233,13 @@ require 'ibm_cloud_power'
 api_instance = IbmCloudPower::PCloudPVMInstancesApi.new
 cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
 pvm_instance_id = 'pvm_instance_id_example' # String | PCloud PVM Instance ID
+opts = {
+  delete_data_volumes: true # Boolean | Indicates whether all data volumes attached to the PVMInstance must be deleted when deleting the PVMInstance. Shared data volumes will be deleted if no other PVMInstances are attached.
+}
 
 begin
   #Delete a PCloud PVM instance
-  result = api_instance.pcloud_pvminstances_delete(cloud_instance_id, pvm_instance_id)
+  result = api_instance.pcloud_pvminstances_delete(cloud_instance_id, pvm_instance_id, opts)
   p result
 rescue IbmCloudPower::ApiError => e
   puts "Exception when calling PCloudPVMInstancesApi->pcloud_pvminstances_delete: #{e}"
@@ -200,6 +253,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
  **pvm_instance_id** | **String**| PCloud PVM Instance ID | 
+ **delete_data_volumes** | **Boolean**| Indicates whether all data volumes attached to the PVMInstance must be deleted when deleting the PVMInstance. Shared data volumes will be deleted if no other PVMInstances are attached. | [optional] 
 
 ### Return type
 
@@ -754,7 +808,7 @@ No authorization required
 
 ## pcloud_pvminstances_snapshots_restore_post
 
-> pcloud_pvminstances_snapshots_restore_post(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts)
+> Snapshot pcloud_pvminstances_snapshots_restore_post(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts)
 
 Restore a PVM Instance snapshot
 
@@ -777,7 +831,8 @@ opts = {
 
 begin
   #Restore a PVM Instance snapshot
-  api_instance.pcloud_pvminstances_snapshots_restore_post(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts)
+  result = api_instance.pcloud_pvminstances_snapshots_restore_post(cloud_instance_id, pvm_instance_id, snapshot_id, body, opts)
+  p result
 rescue IbmCloudPower::ApiError => e
   puts "Exception when calling PCloudPVMInstancesApi->pcloud_pvminstances_snapshots_restore_post: #{e}"
 end
@@ -796,7 +851,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-nil (empty response body)
+[**Snapshot**](Snapshot.md)
 
 ### Authorization
 

data/docs/PCloudPlacementGroupsApi.md

@@ -0,0 +1,298 @@
+# IbmCloudPower::PCloudPlacementGroupsApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**pcloud_placementgroups_delete**](PCloudPlacementGroupsApi.md#pcloud_placementgroups_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/placement-groups/{placement_group_id} | Delete server placement group
+[**pcloud_placementgroups_get**](PCloudPlacementGroupsApi.md#pcloud_placementgroups_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/placement-groups/{placement_group_id} | Get server placement group details
+[**pcloud_placementgroups_getall**](PCloudPlacementGroupsApi.md#pcloud_placementgroups_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/placement-groups | Get all server placement groups
+[**pcloud_placementgroups_members_delete**](PCloudPlacementGroupsApi.md#pcloud_placementgroups_members_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/placement-groups/{placement_group_id}/members | Remove server from placement group
+[**pcloud_placementgroups_members_post**](PCloudPlacementGroupsApi.md#pcloud_placementgroups_members_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/placement-groups/{placement_group_id}/members | Add server to placement group
+[**pcloud_placementgroups_post**](PCloudPlacementGroupsApi.md#pcloud_placementgroups_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/placement-groups | Create a server placement group
+
+
+
+## pcloud_placementgroups_delete
+
+> Object pcloud_placementgroups_delete(cloud_instance_id, placement_group_id)
+
+Delete server placement group
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::PCloudPlacementGroupsApi.new
+cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
+placement_group_id = 'placement_group_id_example' # String | Placement Group ID or Placement Group Name
+
+begin
+  #Delete server placement group
+  result = api_instance.pcloud_placementgroups_delete(cloud_instance_id, placement_group_id)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Exception when calling PCloudPlacementGroupsApi->pcloud_placementgroups_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
+ **placement_group_id** | **String**| Placement Group ID or Placement Group Name | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: */*
+
+
+## pcloud_placementgroups_get
+
+> PlacementGroup pcloud_placementgroups_get(cloud_instance_id, placement_group_id)
+
+Get server placement group details
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::PCloudPlacementGroupsApi.new
+cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
+placement_group_id = 'placement_group_id_example' # String | Placement Group ID or Placement Group Name
+
+begin
+  #Get server placement group details
+  result = api_instance.pcloud_placementgroups_get(cloud_instance_id, placement_group_id)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Exception when calling PCloudPlacementGroupsApi->pcloud_placementgroups_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
+ **placement_group_id** | **String**| Placement Group ID or Placement Group Name | 
+
+### Return type
+
+[**PlacementGroup**](PlacementGroup.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## pcloud_placementgroups_getall
+
+> PlacementGroups pcloud_placementgroups_getall(cloud_instance_id)
+
+Get all server placement groups
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::PCloudPlacementGroupsApi.new
+cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
+
+begin
+  #Get all server placement groups
+  result = api_instance.pcloud_placementgroups_getall(cloud_instance_id)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Exception when calling PCloudPlacementGroupsApi->pcloud_placementgroups_getall: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
+
+### Return type
+
+[**PlacementGroups**](PlacementGroups.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## pcloud_placementgroups_members_delete
+
+> PlacementGroup pcloud_placementgroups_members_delete(cloud_instance_id, placement_group_id, body)
+
+Remove server from placement group
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::PCloudPlacementGroupsApi.new
+cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
+placement_group_id = 'placement_group_id_example' # String | Placement Group ID or Placement Group Name
+body = IbmCloudPower::PlacementGroupServer.new # PlacementGroupServer | Parameters for removing a Server in a Placement Group
+
+begin
+  #Remove server from placement group
+  result = api_instance.pcloud_placementgroups_members_delete(cloud_instance_id, placement_group_id, body)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Exception when calling PCloudPlacementGroupsApi->pcloud_placementgroups_members_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
+ **placement_group_id** | **String**| Placement Group ID or Placement Group Name | 
+ **body** | [**PlacementGroupServer**](PlacementGroupServer.md)| Parameters for removing a Server in a Placement Group | 
+
+### Return type
+
+[**PlacementGroup**](PlacementGroup.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## pcloud_placementgroups_members_post
+
+> PlacementGroup pcloud_placementgroups_members_post(cloud_instance_id, placement_group_id, body)
+
+Add server to placement group
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::PCloudPlacementGroupsApi.new
+cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
+placement_group_id = 'placement_group_id_example' # String | Placement Group ID or Placement Group Name
+body = IbmCloudPower::PlacementGroupServer.new # PlacementGroupServer | Parameters for adding a server to a Placement Group
+
+begin
+  #Add server to placement group
+  result = api_instance.pcloud_placementgroups_members_post(cloud_instance_id, placement_group_id, body)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Exception when calling PCloudPlacementGroupsApi->pcloud_placementgroups_members_post: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
+ **placement_group_id** | **String**| Placement Group ID or Placement Group Name | 
+ **body** | [**PlacementGroupServer**](PlacementGroupServer.md)| Parameters for adding a server to a Placement Group | 
+
+### Return type
+
+[**PlacementGroup**](PlacementGroup.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## pcloud_placementgroups_post
+
+> PlacementGroup pcloud_placementgroups_post(cloud_instance_id, body)
+
+Create a server placement group
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::PCloudPlacementGroupsApi.new
+cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
+body = IbmCloudPower::PlacementGroupCreate.new # PlacementGroupCreate | Parameters for the creating a server placement group
+
+begin
+  #Create a server placement group
+  result = api_instance.pcloud_placementgroups_post(cloud_instance_id, body)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Exception when calling PCloudPlacementGroupsApi->pcloud_placementgroups_post: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
+ **body** | [**PlacementGroupCreate**](PlacementGroupCreate.md)| Parameters for the creating a server placement group | 
+
+### Return type
+
+[**PlacementGroup**](PlacementGroup.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+