ibm_cloud_power 1.0.1

data/docs/PCloudSAPApi.md

@@ -0,0 +1,150 @@
+# IbmCloudPower::PCloudSAPApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**pcloud_sap_get**](PCloudSAPApi.md#pcloud_sap_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/sap/{sap_profile_id} | Get the information on an SAP profile
+[**pcloud_sap_getall**](PCloudSAPApi.md#pcloud_sap_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/sap | Get list of SAP profiles
+[**pcloud_sap_post**](PCloudSAPApi.md#pcloud_sap_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/sap | Create a new SAP PVM Instance
+
+
+
+## pcloud_sap_get
+
+> SAPProfile pcloud_sap_get(cloud_instance_id, sap_profile_id)
+
+Get the information on an SAP profile
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::PCloudSAPApi.new
+cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
+sap_profile_id = 'sap_profile_id_example' # String | SAP Profile ID
+
+begin
+  #Get the information on an SAP profile
+  result = api_instance.pcloud_sap_get(cloud_instance_id, sap_profile_id)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Exception when calling PCloudSAPApi->pcloud_sap_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
+ **sap_profile_id** | **String**| SAP Profile ID | 
+
+### Return type
+
+[**SAPProfile**](SAPProfile.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## pcloud_sap_getall
+
+> SAPProfiles pcloud_sap_getall(cloud_instance_id)
+
+Get list of SAP profiles
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::PCloudSAPApi.new
+cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
+
+begin
+  #Get list of SAP profiles
+  result = api_instance.pcloud_sap_getall(cloud_instance_id)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Exception when calling PCloudSAPApi->pcloud_sap_getall: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
+
+### Return type
+
+[**SAPProfiles**](SAPProfiles.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## pcloud_sap_post
+
+> Array<PVMInstance> pcloud_sap_post(cloud_instance_id, body)
+
+Create a new SAP PVM Instance
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::PCloudSAPApi.new
+cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
+body = IbmCloudPower::SAPCreate.new # SAPCreate | Parameters for the creation of a new SAP PVM Instance
+
+begin
+  #Create a new SAP PVM Instance
+  result = api_instance.pcloud_sap_post(cloud_instance_id, body)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Exception when calling PCloudSAPApi->pcloud_sap_post: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
+ **body** | [**SAPCreate**](SAPCreate.md)| Parameters for the creation of a new SAP PVM Instance | 
+
+### Return type
+
+[**Array<PVMInstance>**](PVMInstance.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PCloudSnapshotsApi.md

@@ -0,0 +1,200 @@
+# IbmCloudPower::PCloudSnapshotsApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**pcloud_cloudinstances_snapshots_delete**](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
+[**pcloud_cloudinstances_snapshots_get**](PCloudSnapshotsApi.md#pcloud_cloudinstances_snapshots_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/snapshots/{snapshot_id} | Get the detail of a snapshot
+[**pcloud_cloudinstances_snapshots_getall**](PCloudSnapshotsApi.md#pcloud_cloudinstances_snapshots_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/snapshots | List all PVM instance snapshots for this cloud instance
+[**pcloud_cloudinstances_snapshots_put**](PCloudSnapshotsApi.md#pcloud_cloudinstances_snapshots_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/snapshots/{snapshot_id} | Update a PVM instance snapshot
+
+
+
+## pcloud_cloudinstances_snapshots_delete
+
+> Object pcloud_cloudinstances_snapshots_delete(cloud_instance_id, snapshot_id)
+
+Delete a PVM instance snapshot of a cloud instance
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::PCloudSnapshotsApi.new
+cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
+snapshot_id = 'snapshot_id_example' # String | PVM Instance snapshot id
+
+begin
+  #Delete a PVM instance snapshot of a cloud instance
+  result = api_instance.pcloud_cloudinstances_snapshots_delete(cloud_instance_id, snapshot_id)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Exception when calling PCloudSnapshotsApi->pcloud_cloudinstances_snapshots_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
+ **snapshot_id** | **String**| PVM Instance snapshot id | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: */*
+
+
+## pcloud_cloudinstances_snapshots_get
+
+> Snapshot pcloud_cloudinstances_snapshots_get(cloud_instance_id, snapshot_id)
+
+Get the detail of a snapshot
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::PCloudSnapshotsApi.new
+cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
+snapshot_id = 'snapshot_id_example' # String | PVM Instance snapshot id
+
+begin
+  #Get the detail of a snapshot
+  result = api_instance.pcloud_cloudinstances_snapshots_get(cloud_instance_id, snapshot_id)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Exception when calling PCloudSnapshotsApi->pcloud_cloudinstances_snapshots_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
+ **snapshot_id** | **String**| PVM Instance snapshot id | 
+
+### Return type
+
+[**Snapshot**](Snapshot.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## pcloud_cloudinstances_snapshots_getall
+
+> Snapshots pcloud_cloudinstances_snapshots_getall(cloud_instance_id)
+
+List all PVM instance snapshots for this cloud instance
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::PCloudSnapshotsApi.new
+cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
+
+begin
+  #List all PVM instance snapshots for this cloud instance
+  result = api_instance.pcloud_cloudinstances_snapshots_getall(cloud_instance_id)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Exception when calling PCloudSnapshotsApi->pcloud_cloudinstances_snapshots_getall: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
+
+### Return type
+
+[**Snapshots**](Snapshots.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## pcloud_cloudinstances_snapshots_put
+
+> Object pcloud_cloudinstances_snapshots_put(cloud_instance_id, snapshot_id, body)
+
+Update a PVM instance snapshot
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::PCloudSnapshotsApi.new
+cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
+snapshot_id = 'snapshot_id_example' # String | PVM Instance snapshot id
+body = IbmCloudPower::SnapshotUpdate.new # SnapshotUpdate | Parameters for the update of a PVM instance snapshot
+
+begin
+  #Update a PVM instance snapshot
+  result = api_instance.pcloud_cloudinstances_snapshots_put(cloud_instance_id, snapshot_id, body)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Exception when calling PCloudSnapshotsApi->pcloud_cloudinstances_snapshots_put: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
+ **snapshot_id** | **String**| PVM Instance snapshot id | 
+ **body** | [**SnapshotUpdate**](SnapshotUpdate.md)| Parameters for the update of a PVM instance snapshot | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PCloudSystemPoolsApi.md

@@ -0,0 +1,54 @@
+# IbmCloudPower::PCloudSystemPoolsApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**pcloud_systempools_get**](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
+
+
+
+## pcloud_systempools_get
+
+> Hash<String, SystemPool> pcloud_systempools_get(cloud_instance_id)
+
+List of available system pools within a particular data center
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::PCloudSystemPoolsApi.new
+cloud_instance_id = 'cloud_instance_id_example' # String | Cloud Instance ID of a PCloud Instance
+
+begin
+  #List of available system pools within a particular data center
+  result = api_instance.pcloud_systempools_get(cloud_instance_id)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Exception when calling PCloudSystemPoolsApi->pcloud_systempools_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cloud_instance_id** | **String**| Cloud Instance ID of a PCloud Instance | 
+
+### Return type
+
+[**Hash<String, SystemPool>**](SystemPool.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PCloudTasksApi.md

@@ -0,0 +1,100 @@
+# IbmCloudPower::PCloudTasksApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**pcloud_tasks_delete**](PCloudTasksApi.md#pcloud_tasks_delete) | **DELETE** /pcloud/v1/tasks/{task_id} | Delete a task
+[**pcloud_tasks_get**](PCloudTasksApi.md#pcloud_tasks_get) | **GET** /pcloud/v1/tasks/{task_id} | Get a task
+
+
+
+## pcloud_tasks_delete
+
+> Object pcloud_tasks_delete(task_id)
+
+Delete a task
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::PCloudTasksApi.new
+task_id = 'task_id_example' # String | PCloud Task ID
+
+begin
+  #Delete a task
+  result = api_instance.pcloud_tasks_delete(task_id)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Exception when calling PCloudTasksApi->pcloud_tasks_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_id** | **String**| PCloud Task ID | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## pcloud_tasks_get
+
+> Task pcloud_tasks_get(task_id)
+
+Get a task
+
+### Example
+
+```ruby
+# load the gem
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::PCloudTasksApi.new
+task_id = 'task_id_example' # String | PCloud Task ID
+
+begin
+  #Get a task
+  result = api_instance.pcloud_tasks_get(task_id)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Exception when calling PCloudTasksApi->pcloud_tasks_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_id** | **String**| PCloud Task ID | 
+
+### Return type
+
+[**Task**](Task.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+