ibm_cloud_power 2.1.0 → 3.0.0

data/docs/CapabilitiesDetails.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::CapabilitiesDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **disaster_recovery** | [**DisasterRecovery**](DisasterRecovery.md) |  |  |
+| **supported_systems** | [**SupportedSystems**](SupportedSystems.md) |  |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::CapabilitiesDetails.new(
+  disaster_recovery: null,
+  supported_systems: null
+)
+```
+

data/docs/CloudConnectionEndpointVPC.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **enabled** | **Boolean** | enable vpc for this cloud connection (default=false) | [optional] |
-| **vpcs** | [**Array<CloudConnectionVPC>**](CloudConnectionVPC.md) | vpc connections | [optional] |
+| **vpcs** | [**Array<CloudConnectionVpc>**](CloudConnectionVpc.md) | vpc connections | [optional] |
 
 ## Example
 

data/docs/CloudConnectionVirtualPrivateClouds.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **virtual_private_clouds** | [**Array<CloudConnectionVirtualPrivateCloudsVirtualPrivateCloudsInner>**](CloudConnectionVirtualPrivateCloudsVirtualPrivateCloudsInner.md) | list of available virtual private clouds |  |
+| **virtual_private_clouds** | [**Array<CloudConnectionVirtualPrivateCloudsVirtualPrivateClouds>**](CloudConnectionVirtualPrivateCloudsVirtualPrivateClouds.md) | list of available virtual private clouds |  |
 
 ## Example
 

data/docs/CloudConnectionVirtualPrivateCloudsVirtualPrivateClouds.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**classic_access** | **Boolean** | indicates if vpc uses classic architecture | 
-**vpc_id** | **String** | CRN of the specific service | 
-**name** | **String** | name for the vpc | 
-**status** | **String** | status of this vpc | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **classic_access** | **Boolean** | indicates if vpc uses classic architecture |  |
+| **name** | **String** | name for the vpc |  |
+| **status** | **String** | status of this vpc |  |
+| **vpc_id** | **String** | virtual private cloud id |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::CloudConnectionVirtualPrivateCloudsVirtualPrivateClouds.new(classic_access: null,
-                                 vpc_id: null,
-                                 name: null,
-                                 status: null)
+instance = IbmCloudPower::CloudConnectionVirtualPrivateCloudsVirtualPrivateClouds.new(
+  classic_access: null,
+  name: null,
+  status: null,
+  vpc_id: null
+)
 ```
 
-

data/docs/CloudConnectionVpc.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::CloudConnectionVpc
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | vpc name | [optional] |
+| **vpc_id** | **String** | vpc id |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::CloudConnectionVpc.new(
+  name: null,
+  vpc_id: null
+)
+```
+

data/docs/CreateCosImageImportJob.md

@@ -9,12 +9,14 @@
 | **bucket_name** | **String** | Cloud Object Storage bucket name; bucket-name[/optional/folder] |  |
 | **image_filename** | **String** | Cloud Object Storage image filename |  |
 | **image_name** | **String** | Name for the image that will be loaded into the boot image catalog |  |
+| **import_details** | [**ImageImportDetails**](ImageImportDetails.md) |  | [optional] |
 | **os_type** | **String** | Image OS Type, required if importing a raw image; raw images can only be imported using the command line interface | [optional] |
 | **region** | **String** | Cloud Object Storage region |  |
 | **secret_key** | **String** | Cloud Object Storage secret key; required for buckets with private access | [optional] |
 | **storage_affinity** | [**StorageAffinity**](StorageAffinity.md) |  | [optional] |
-| **storage_pool** | **String** | Storage pool where the image will be loaded, if provided then storageType and storageAffinity will be ignored | [optional] |
-| **storage_type** | **String** | Type of storage; will be ignored if storagePool or storageAffinity is provided. If only using storageType for storage selection then the storage pool with the most available space will be selected | [optional] |
+| **storage_pool** | **String** | Storage pool where the image will be loaded, if provided then storageAffinity will be ignored | [optional] |
+| **storage_type** | **String** | Type of storage; If only using storageType for storage selection then the storage pool with the most available space will be selected if storageType is not provided the storage type will default to 'tier3'. | [optional] |
+| **user_tags** | **Array** |  | [optional] |
 
 ## Example
 
@@ -27,12 +29,14 @@ instance = IbmCloudPower::CreateCosImageImportJob.new(
   bucket_name: null,
   image_filename: null,
   image_name: null,
+  import_details: null,
   os_type: null,
   region: null,
   secret_key: null,
   storage_affinity: null,
   storage_pool: null,
-  storage_type: null
+  storage_type: null,
+  user_tags: null
 )
 ```
 

data/docs/CreateDataVolume.md

@@ -9,12 +9,13 @@
 | **affinity_volume** | **String** | Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and affinityPVMInstance is not provided | [optional] |
 | **anti_affinity_pvm_instances** | **Array<String>** | List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and antiAffinityVolumes is not provided | [optional] |
 | **anti_affinity_volumes** | **Array<String>** | List of volumes to base volume anti-affinity policy against; required if requesting anti-affinity and antiAffinityPVMInstances is not provided | [optional] |
-| **disk_type** | **String** | Type of Disk, required if affinityPolicy and volumePool not provided, otherwise ignored | [optional] |
+| **disk_type** | **String** | Type of Disk; if diskType is not provided the disk type will default to 'tier3'. | [optional] |
 | **name** | **String** | Volume Name |  |
 | **replication_enabled** | **Boolean** | Indicates if the volume should be replication enabled or not | [optional] |
 | **shareable** | **Boolean** | Indicates if the volume is shareable between VMs | [optional] |
 | **size** | **Float** | Volume Size (GB) |  |
-| **volume_pool** | **String** | Volume pool where the volume will be created; if provided then diskType and affinityPolicy values will be ignored | [optional] |
+| **user_tags** | **Array** |  | [optional] |
+| **volume_pool** | **String** | Volume pool where the volume will be created; if provided then affinityPolicy value will be ignored | [optional] |
 
 ## Example
 
@@ -32,6 +33,7 @@ instance = IbmCloudPower::CreateDataVolume.new(
   replication_enabled: null,
   shareable: null,
   size: null,
+  user_tags: null,
   volume_pool: null
 )
 ```

data/docs/CreateImage.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **access_key** | **String** | Cloud Storage access key; required for import image | [optional] |
 | **bucket_name** | **String** | Cloud Storage bucket name; bucket-name[/optional/folder]; required for import image | [optional] |
-| **disk_type** | **String** | Type of Disk; will be ignored if storagePool or affinityPolicy is provided; Used only when importing an image from cloud storage. | [optional] |
+| **disk_type** | **String** | Type of Disk; if diskType is not provided the disk type will default to 'tier3'. Used only when importing an image from cloud storage. | [optional] |
 | **image_filename** | **String** | Cloud Storage image filename; required for import image | [optional] |
 | **image_id** | **String** | Image ID of existing source image; required for copy image | [optional] |
 | **image_name** | **String** | Name to give created image; required for import image | [optional] |
@@ -14,9 +14,10 @@
 | **os_type** | **String** | Image OS Type, required if importing a raw image; raw images can only be imported using the command line interface | [optional] |
 | **region** | **String** | Cloud Storage Region; only required to access IBM Cloud Storage | [optional] |
 | **secret_key** | **String** | Cloud Storage secret key; required for import image | [optional] |
-| **source** | **String** | Source of the image |  |
+| **source** | **String** | Source of the image >*Note*: url option is deprecated, this option is supported till Oct 2022  |  |
 | **storage_affinity** | [**StorageAffinity**](StorageAffinity.md) |  | [optional] |
-| **storage_pool** | **String** | Storage pool where the image will be loaded; if provided then storageAffinity and diskType will be ignored; Used only when importing an image from cloud storage. | [optional] |
+| **storage_pool** | **String** | Storage pool where the image will be loaded; if provided then storageAffinity will be ignored; Used only when importing an image from cloud storage. | [optional] |
+| **user_tags** | **Array** |  | [optional] |
 
 ## Example
 
@@ -36,7 +37,8 @@ instance = IbmCloudPower::CreateImage.new(
   secret_key: null,
   source: null,
   storage_affinity: null,
-  storage_pool: null
+  storage_pool: null,
+  user_tags: null
 )
 ```
 

data/docs/CreateServerVirtualSerialNumber.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::CreateServerVirtualSerialNumber
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | Description of the Virtual Serial Number | [optional] |
+| **serial** | **String** | Provide an existing reserved Virtual Serial Number or specify 'auto-assign' for auto generated Virtual Serial Number. |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::CreateServerVirtualSerialNumber.new(
+  description: null,
+  serial: null
+)
+```
+

data/docs/Datacenter.md

@@ -0,0 +1,28 @@
+# IbmCloudPower::Datacenter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **capabilities** | **Hash<String, Boolean>** | Datacenter Capabilities |  |
+| **capabilities_details** | [**CapabilitiesDetails**](CapabilitiesDetails.md) |  | [optional] |
+| **href** | **String** | Link to Datacenter Region | [optional] |
+| **location** | [**DatacenterLocation**](DatacenterLocation.md) |  |  |
+| **status** | **String** | The Datacenter status |  |
+| **type** | **String** | The Datacenter type |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::Datacenter.new(
+  capabilities: null,
+  capabilities_details: null,
+  href: null,
+  location: null,
+  status: null,
+  type: null
+)
+```
+

data/docs/DatacenterLocation.md

@@ -0,0 +1,24 @@
+# IbmCloudPower::DatacenterLocation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **region** | **String** | The Datacenter location region zone |  |
+| **region_display_name** | **String** | The Datacenter location region display name |  |
+| **type** | **String** | The Datacenter location region type |  |
+| **url** | **String** | The Datacenter location region url |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::DatacenterLocation.new(
+  region: null,
+  region_display_name: null,
+  type: null,
+  url: null
+)
+```
+

data/docs/Datacenters.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::Datacenters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **datacenters** | [**Array<Datacenter>**](Datacenter.md) | Power Systems Virtual Server available Datacenters |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::Datacenters.new(
+  datacenters: null
+)
+```
+

data/docs/DatacentersApi.md

@@ -0,0 +1,253 @@
+# IbmCloudPower::DatacentersApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v1_datacenters_get**](DatacentersApi.md#v1_datacenters_get) | **GET** /v1/datacenters/{datacenter_region} | Get a Datacenter's information and capabilities |
+| [**v1_datacenters_getall**](DatacentersApi.md#v1_datacenters_getall) | **GET** /v1/datacenters | Get all Datacenters information and capabilities |
+| [**v1_datacenters_private_get**](DatacentersApi.md#v1_datacenters_private_get) | **GET** /v1/datacenters/private/{datacenter_region} | Get a private Datacenter's information and capabilities |
+| [**v1_datacenters_private_getall**](DatacentersApi.md#v1_datacenters_private_getall) | **GET** /v1/datacenters/private | Get private Datacenter information and capabilities |
+
+
+## v1_datacenters_get
+
+> <Datacenter> v1_datacenters_get(datacenter_region)
+
+Get a Datacenter's information and capabilities
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::DatacentersApi.new
+datacenter_region = 'datacenter_region_example' # String | Datacenter Region
+
+begin
+  # Get a Datacenter's information and capabilities
+  result = api_instance.v1_datacenters_get(datacenter_region)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling DatacentersApi->v1_datacenters_get: #{e}"
+end
+```
+
+#### Using the v1_datacenters_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Datacenter>, Integer, Hash)> v1_datacenters_get_with_http_info(datacenter_region)
+
+```ruby
+begin
+  # Get a Datacenter's information and capabilities
+  data, status_code, headers = api_instance.v1_datacenters_get_with_http_info(datacenter_region)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Datacenter>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling DatacentersApi->v1_datacenters_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **datacenter_region** | **String** | Datacenter Region |  |
+
+### Return type
+
+[**Datacenter**](Datacenter.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_datacenters_getall
+
+> <Datacenters> v1_datacenters_getall
+
+Get all Datacenters information and capabilities
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::DatacentersApi.new
+
+begin
+  # Get all Datacenters information and capabilities
+  result = api_instance.v1_datacenters_getall
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling DatacentersApi->v1_datacenters_getall: #{e}"
+end
+```
+
+#### Using the v1_datacenters_getall_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Datacenters>, Integer, Hash)> v1_datacenters_getall_with_http_info
+
+```ruby
+begin
+  # Get all Datacenters information and capabilities
+  data, status_code, headers = api_instance.v1_datacenters_getall_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Datacenters>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling DatacentersApi->v1_datacenters_getall_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Datacenters**](Datacenters.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_datacenters_private_get
+
+> <Datacenter> v1_datacenters_private_get(datacenter_region)
+
+Get a private Datacenter's information and capabilities
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::DatacentersApi.new
+datacenter_region = 'datacenter_region_example' # String | Datacenter Region
+
+begin
+  # Get a private Datacenter's information and capabilities
+  result = api_instance.v1_datacenters_private_get(datacenter_region)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling DatacentersApi->v1_datacenters_private_get: #{e}"
+end
+```
+
+#### Using the v1_datacenters_private_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Datacenter>, Integer, Hash)> v1_datacenters_private_get_with_http_info(datacenter_region)
+
+```ruby
+begin
+  # Get a private Datacenter's information and capabilities
+  data, status_code, headers = api_instance.v1_datacenters_private_get_with_http_info(datacenter_region)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Datacenter>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling DatacentersApi->v1_datacenters_private_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **datacenter_region** | **String** | Datacenter Region |  |
+
+### Return type
+
+[**Datacenter**](Datacenter.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_datacenters_private_getall
+
+> <Datacenters> v1_datacenters_private_getall
+
+Get private Datacenter information and capabilities
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::DatacentersApi.new
+
+begin
+  # Get private Datacenter information and capabilities
+  result = api_instance.v1_datacenters_private_getall
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling DatacentersApi->v1_datacenters_private_getall: #{e}"
+end
+```
+
+#### Using the v1_datacenters_private_getall_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Datacenters>, Integer, Hash)> v1_datacenters_private_getall_with_http_info
+
+```ruby
+begin
+  # Get private Datacenter information and capabilities
+  data, status_code, headers = api_instance.v1_datacenters_private_getall_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Datacenters>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling DatacentersApi->v1_datacenters_private_getall_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Datacenters**](Datacenters.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/DeleteServerVirtualSerialNumber.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::DeleteServerVirtualSerialNumber
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **retain_vsn** | **Boolean** | Indicates if the Virtual Serial Number attached to a PVM Instance is retained or not | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::DeleteServerVirtualSerialNumber.new(
+  retain_vsn: null
+)
+```
+

data/docs/DeploymentTarget.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::DeploymentTarget
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The uuid of the host group or host |  |
+| **type** | **String** | specify if deploying to a host group or a host |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::DeploymentTarget.new(
+  id: null,
+  type: null
+)
+```
+

data/docs/DisasterRecovery.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::DisasterRecovery
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **asynchronous_replication** | [**ReplicationService**](ReplicationService.md) |  |  |
+| **synchronous_replication** | [**ReplicationService**](ReplicationService.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::DisasterRecovery.new(
+  asynchronous_replication: null,
+  synchronous_replication: null
+)
+```
+

data/docs/DisasterRecoveryLocation.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **location** | **String** | regionZone of a site | [optional] |
-| **replication_sites** | [**Array<Site>**](Site.md) | list of Replication Sites | [optional] |
+| **replication_sites** | **Array** |  | [optional] |
 
 ## Example
 

data/docs/GetBulkVolume.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::GetBulkVolume
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **volume_list** | **Array<String>** | List of volumes to be fetched |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::GetBulkVolume.new(
+  volume_list: null
+)
+```
+

data/docs/GetServerVirtualSerialNumber.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::GetServerVirtualSerialNumber
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | Description of the Virtual Serial Number |  |
+| **serial** | **String** | Virtual Serial Number |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::GetServerVirtualSerialNumber.new(
+  description: null,
+  serial: null
+)
+```
+