ibm_cloud_power 2.1.1 → 3.1.0

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) | Additional Datacenter Capabilities Details | [optional] |
+| **href** | **String** | Link to Datacenter Region | [optional] |
+| **location** | [**DatacenterLocation**](DatacenterLocation.md) | The Datacenter location |  |
+| **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** | [**DisasterRecoveryAsynchronousReplication**](DisasterRecoveryAsynchronousReplication.md) |  |  |
+| **synchronous_replication** | [**DisasterRecoveryAsynchronousReplication**](DisasterRecoveryAsynchronousReplication.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::DisasterRecovery.new(
+  asynchronous_replication: null,
+  synchronous_replication: null
+)
+```
+

data/docs/DisasterRecoveryAsynchronousReplication.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::DisasterRecoveryAsynchronousReplication
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** | Service Enabled |  |
+| **target_locations** | [**Array<ReplicationTargetLocation>**](ReplicationTargetLocation.md) | List of all replication targets |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::DisasterRecoveryAsynchronousReplication.new(
+  enabled: null,
+  target_locations: 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<Site>**](Site.md) | The list of replication sites has mapped for the given location | [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,22 @@
+# IbmCloudPower::GetServerVirtualSerialNumber
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | Description of the Virtual Serial Number |  |
+| **serial** | **String** | Virtual Serial Number |  |
+| **software_tier** | [**SoftwareTier**](SoftwareTier.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::GetServerVirtualSerialNumber.new(
+  description: null,
+  serial: null,
+  software_tier: null
+)
+```
+

data/docs/Host.md

@@ -0,0 +1,34 @@
+# IbmCloudPower::Host
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **capacity** | [**HostCapacity**](HostCapacity.md) |  | [optional] |
+| **crn** | **String** | The CRN for this resource | [optional] |
+| **display_name** | **String** | Name of the host (chosen by the user) | [optional] |
+| **host_group** | [**HostHostGroup**](HostHostGroup.md) |  | [optional] |
+| **id** | **String** | ID of the host | [optional] |
+| **state** | **String** | State of the host (up/down) | [optional] |
+| **status** | **String** | Status of the host (enabled/disabled) | [optional] |
+| **sys_type** | **String** | System type | [optional] |
+| **user_tags** | **Array<String>** | List of user tags | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::Host.new(
+  capacity: null,
+  crn: null,
+  display_name: null,
+  host_group: null,
+  id: null,
+  state: null,
+  status: null,
+  sys_type: null,
+  user_tags: null
+)
+```
+

data/docs/HostCapacity.md

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

data/docs/HostCapacityCores.md

@@ -0,0 +1,24 @@
+# IbmCloudPower::HostCapacityCores
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **available** | **Float** |  |  |
+| **reserved** | **Float** |  |  |
+| **total** | **Float** |  |  |
+| **used** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::HostCapacityCores.new(
+  available: null,
+  reserved: null,
+  total: null,
+  used: null
+)
+```
+

data/docs/HostCreate.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::HostCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **host_group_id** | **String** | ID of the host group to which the host should be added |  |
+| **hosts** | [**Array<AddHost>**](AddHost.md) | Hosts to be added |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::HostCreate.new(
+  host_group_id: null,
+  hosts: null
+)
+```
+

data/docs/HostGroup.md

@@ -0,0 +1,28 @@
+# IbmCloudPower::HostGroup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **creation_date** | **Time** | Date/Time of host group creation | [optional] |
+| **hosts** | **Array<String>** | List of hosts | [optional] |
+| **id** | **String** | Host group ID | [optional] |
+| **name** | **String** | Name of the host group | [optional] |
+| **primary** | **String** | ID of the workspace owning the host group | [optional] |
+| **secondaries** | **Array<String>** | IDs of workspaces the host group has been shared with | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::HostGroup.new(
+  creation_date: null,
+  hosts: null,
+  id: null,
+  name: null,
+  primary: null,
+  secondaries: null
+)
+```
+

data/docs/HostGroupCreate.md

@@ -0,0 +1,22 @@
+# IbmCloudPower::HostGroupCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **hosts** | [**Array<AddHost>**](AddHost.md) | List of hosts to add to the host group |  |
+| **name** | **String** | Name of the host group to create |  |
+| **secondaries** | [**Array<Secondary>**](Secondary.md) | List of workspaces to share the host group with (optional) | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::HostGroupCreate.new(
+  hosts: null,
+  name: null,
+  secondaries: null
+)
+```
+

data/docs/HostGroupShareOp.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::HostGroupShareOp
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **add** | [**Array<Secondary>**](Secondary.md) | List of workspaces to share the host group with | [optional] |
+| **remove** | **String** | A workspace ID to stop sharing the host group with | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::HostGroupShareOp.new(
+  add: null,
+  remove: null
+)
+```
+

data/docs/HostGroupSummary.md

@@ -0,0 +1,22 @@
+# IbmCloudPower::HostGroupSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access** | **String** | Whether the host group is a primary or secondary host group | [optional] |
+| **href** | **String** | Link to the host group resource | [optional] |
+| **name** | **String** | Name of the host group | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::HostGroupSummary.new(
+  access: null,
+  href: null,
+  name: null
+)
+```
+