ibm_cloud_power 2.1.1 → 3.0.0

data/docs/SnapshotV1.md

@@ -0,0 +1,30 @@
+# IbmCloudPower::SnapshotV1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **creation_date** | **Time** | The date and time when the volume snapshot was created. | [optional] |
+| **id** | **String** | The volume snapshot UUID. |  |
+| **name** | **String** | The volume snapshot name. |  |
+| **size** | **Float** | The size of the volume snapshot, in gibibytes (GiB). |  |
+| **status** | **String** | The status for the volume snapshot. |  |
+| **updated_date** | **Time** | The date and time when the volume snapshot was last updated. | [optional] |
+| **volume_id** | **String** | The volume UUID associated with the snapshot. |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::SnapshotV1.new(
+  creation_date: null,
+  id: null,
+  name: null,
+  size: null,
+  status: null,
+  updated_date: null,
+  volume_id: null
+)
+```
+

data/docs/SnapshotsApi.md

@@ -0,0 +1,261 @@
+# IbmCloudPower::SnapshotsApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v1_snapshots_get**](SnapshotsApi.md#v1_snapshots_get) | **GET** /v1/snapshots/{snapshot_id} | Get the detail of a snapshot |
+| [**v1_snapshots_getall**](SnapshotsApi.md#v1_snapshots_getall) | **GET** /v1/snapshots | Get a list of all the snapshots on a workspace |
+| [**v1_volume_snapshots_get**](SnapshotsApi.md#v1_volume_snapshots_get) | **GET** /v1/volume-snapshots | Get the list of volume snapshots on a workspace |
+| [**v1_volume_snapshots_getall**](SnapshotsApi.md#v1_volume_snapshots_getall) | **GET** /v1/volume-snapshots/{volume_snapshot_uuid} | Get the detail of a volume snapshot |
+
+
+## v1_snapshots_get
+
+> <SnapshotV1> v1_snapshots_get(snapshot_id)
+
+Get the detail of a snapshot
+
+This API is deprecated for /v1/snapshots. The API v1/volume-snapshots has replaced this endpoint.  View the usage of a snapshot. The snapshot may take time sync because the data is cached. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::SnapshotsApi.new
+snapshot_id = 'snapshot_id_example' # String | PVM Instance snapshot id
+
+begin
+  # Get the detail of a snapshot
+  result = api_instance.v1_snapshots_get(snapshot_id)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling SnapshotsApi->v1_snapshots_get: #{e}"
+end
+```
+
+#### Using the v1_snapshots_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SnapshotV1>, Integer, Hash)> v1_snapshots_get_with_http_info(snapshot_id)
+
+```ruby
+begin
+  # Get the detail of a snapshot
+  data, status_code, headers = api_instance.v1_snapshots_get_with_http_info(snapshot_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SnapshotV1>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling SnapshotsApi->v1_snapshots_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **snapshot_id** | **String** | PVM Instance snapshot id |  |
+
+### Return type
+
+[**SnapshotV1**](SnapshotV1.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_snapshots_getall
+
+> <SnapshotList> v1_snapshots_getall
+
+Get a list of all the snapshots on a workspace
+
+This API is deprecated for /v1/snapshots. The API v1/volume-snapshots has replaced this endpoint.  View the usage of snapshots on the workspace. The snapshots may take time sync because the data is cached. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::SnapshotsApi.new
+
+begin
+  # Get a list of all the snapshots on a workspace
+  result = api_instance.v1_snapshots_getall
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling SnapshotsApi->v1_snapshots_getall: #{e}"
+end
+```
+
+#### Using the v1_snapshots_getall_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SnapshotList>, Integer, Hash)> v1_snapshots_getall_with_http_info
+
+```ruby
+begin
+  # Get a list of all the snapshots on a workspace
+  data, status_code, headers = api_instance.v1_snapshots_getall_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SnapshotList>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling SnapshotsApi->v1_snapshots_getall_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**SnapshotList**](SnapshotList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_volume_snapshots_get
+
+> <VolumeSnapshotList> v1_volume_snapshots_get
+
+Get the list of volume snapshots on a workspace
+
+View the usage of volume snapshots on the workspace. The volume snapshots may take time sync because the data is cached.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::SnapshotsApi.new
+
+begin
+  # Get the list of volume snapshots on a workspace
+  result = api_instance.v1_volume_snapshots_get
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling SnapshotsApi->v1_volume_snapshots_get: #{e}"
+end
+```
+
+#### Using the v1_volume_snapshots_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VolumeSnapshotList>, Integer, Hash)> v1_volume_snapshots_get_with_http_info
+
+```ruby
+begin
+  # Get the list of volume snapshots on a workspace
+  data, status_code, headers = api_instance.v1_volume_snapshots_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VolumeSnapshotList>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling SnapshotsApi->v1_volume_snapshots_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**VolumeSnapshotList**](VolumeSnapshotList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_volume_snapshots_getall
+
+> <SnapshotV1> v1_volume_snapshots_getall(volume_snapshot_uuid)
+
+Get the detail of a volume snapshot
+
+View the usage of a snapshot. The snapshot may take time sync because the data is cached.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::SnapshotsApi.new
+volume_snapshot_uuid = 'volume_snapshot_uuid_example' # String | The volume snapshot UUID
+
+begin
+  # Get the detail of a volume snapshot
+  result = api_instance.v1_volume_snapshots_getall(volume_snapshot_uuid)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling SnapshotsApi->v1_volume_snapshots_getall: #{e}"
+end
+```
+
+#### Using the v1_volume_snapshots_getall_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SnapshotV1>, Integer, Hash)> v1_volume_snapshots_getall_with_http_info(volume_snapshot_uuid)
+
+```ruby
+begin
+  # Get the detail of a volume snapshot
+  data, status_code, headers = api_instance.v1_volume_snapshots_getall_with_http_info(volume_snapshot_uuid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SnapshotV1>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling SnapshotsApi->v1_volume_snapshots_getall_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **volume_snapshot_uuid** | **String** | The volume snapshot UUID |  |
+
+### Return type
+
+[**SnapshotV1**](SnapshotV1.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/StorageController.md

@@ -0,0 +1,26 @@
+# IbmCloudPower::StorageController
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **display_name** | **String** | Display Name of the Storage Controller |  |
+| **health** | **String** | Health status of this storage controller |  |
+| **pool_storage** | **Float** | Free storage in user pools on this storage controller (GB) |  |
+| **pool_total_storage** | **Float** | Total storage capacity of user pools in this storage controller (GB) |  |
+| **pools** | [**Hash<String, StoragePoolCombined>**](StoragePoolCombined.md) | List of storage pools within this storage controller |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::StorageController.new(
+  display_name: null,
+  health: null,
+  pool_storage: null,
+  pool_total_storage: null,
+  pools: null
+)
+```
+

data/docs/StoragePoolCapacity.md

@@ -4,8 +4,11 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **available_capacity** | **Integer** | Available/Unused pool capacity (GB) | [optional] |
 | **max_allocation_size** | **Integer** | Maximum allocation storage size (GB) |  |
 | **pool_name** | **String** | Pool name | [optional] |
+| **replication_enabled** | **Boolean** | true if storage-pool is replication enabled and can be used to manage replication enabled volumes | [optional] |
+| **storage_host** | **String** | Storage host/controller for this storage pool | [optional] |
 | **storage_type** | **String** | Storage type of the storage pool | [optional] |
 | **total_capacity** | **Integer** | Total pool capacity (GB) | [optional] |
 
@@ -15,8 +18,11 @@
 require 'ibm_cloud_power'
 
 instance = IbmCloudPower::StoragePoolCapacity.new(
+  available_capacity: null,
   max_allocation_size: null,
   pool_name: null,
+  replication_enabled: null,
+  storage_host: null,
   storage_type: null,
   total_capacity: null
 )

data/docs/StoragePoolCombined.md

@@ -0,0 +1,22 @@
+# IbmCloudPower::StoragePoolCombined
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pool_name** | **String** | Pool name |  |
+| **storage** | **Integer** | Available/Unused pool capacity (GB) |  |
+| **total_storage** | **Integer** | Total pool capacity (GB) |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::StoragePoolCombined.new(
+  pool_name: null,
+  storage: null,
+  total_storage: null
+)
+```
+

data/docs/StoragePoolMap.md

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

data/docs/StorageTier.md

@@ -0,0 +1,22 @@
+# IbmCloudPower::StorageTier
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | Description, storage tier label | [optional] |
+| **name** | **String** | Name of the storage tier | [optional] |
+| **state** | **String** | State of the storage tier (active or inactive) | [optional][default to 'active'] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::StorageTier.new(
+  description: null,
+  name: null,
+  state: null
+)
+```
+

data/docs/SupportedSystems.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::SupportedSystems
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dedicated** | **Array<String>** | List of all available dedicated host types |  |
+| **general** | **Array<String>** | List of all available host types |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::SupportedSystems.new(
+  dedicated: null,
+  general: null
+)
+```
+

data/docs/System.md

@@ -4,9 +4,16 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **available_cores** | **Float** | The host available Processor units | [optional] |
+| **available_memory** | **Integer** | The host available RAM memory in GiB | [optional] |
 | **cores** | **Float** | The host available Processor units |  |
+| **host_mtms_name** | **String** | The host MTMS name | [optional] |
 | **id** | **Integer** | The host identifier | [optional] |
-| **memory** | **Integer** | The host available RAM memory in GiB |  |
+| **memory** | **Integer** | The host total RAM memory in GiB |  |
+| **total_cores** | **Float** | The host total usable Processor units | [optional] |
+| **total_memory** | **Integer** | The host total usable RAM memory in GiB | [optional] |
+| **total_phys_cores** | **Float** | Total number of physical cores in the Pod | [optional] |
+| **total_phys_memory** | **Integer** | Total amount of physical memory in the Pod (GB) | [optional] |
 
 ## Example
 
@@ -14,9 +21,16 @@
 require 'ibm_cloud_power'
 
 instance = IbmCloudPower::System.new(
+  available_cores: null,
+  available_memory: null,
   cores: null,
+  host_mtms_name: null,
   id: null,
-  memory: null
+  memory: null,
+  total_cores: null,
+  total_memory: null,
+  total_phys_cores: null,
+  total_phys_memory: null
 )
 ```
 

data/docs/SystemPool.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **capacity** | [**System**](System.md) |  | [optional] |
+| **core_increment** | **Float** | Core allocation increment | [optional] |
 | **core_memory_ratio** | **Float** | Processor to Memory (GB) Ratio | [optional] |
 | **max_available** | [**System**](System.md) |  | [optional] |
 | **max_cores_available** | [**System**](System.md) |  | [optional] |
@@ -20,6 +21,7 @@ require 'ibm_cloud_power'
 
 instance = IbmCloudPower::SystemPool.new(
   capacity: null,
+  core_increment: null,
   core_memory_ratio: null,
   max_available: null,
   max_cores_available: null,

data/docs/SystemPoolCapacity.md

@@ -0,0 +1,30 @@
+# IbmCloudPower::SystemPoolCapacity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cores** | **Float** | Number of available cores in the System Pool |  |
+| **memory** | **Integer** | Amount of available memory in the System Pool (GB) |  |
+| **systems** | [**Array<SystemResources>**](SystemResources.md) | The DataCenter list of servers and their available resources | [optional] |
+| **total_cores** | **Float** | Total number of cores in the System Pool |  |
+| **total_memory** | **Integer** | Total amount of memory in the System Pool (GB) |  |
+| **total_phys_cores** | **Float** | Total number of physical cores in the Pod |  |
+| **total_phys_memory** | **Integer** | Total amount of physical memory in the Pod (GB) |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::SystemPoolCapacity.new(
+  cores: null,
+  memory: null,
+  systems: null,
+  total_cores: null,
+  total_memory: null,
+  total_phys_cores: null,
+  total_phys_memory: null
+)
+```
+

data/docs/SystemResources.md

@@ -0,0 +1,32 @@
+# IbmCloudPower::SystemResources
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cores** | **Float** | The host available Processor units |  |
+| **host_mtms_name** | **String** | The host MTMS name | [optional] |
+| **id** | **Integer** | The host identifier |  |
+| **memory** | **Integer** | The host available RAM memory in GiB |  |
+| **total_cores** | **Float** | The host total usable Processor units |  |
+| **total_memory** | **Integer** | The host total usable RAM memory in GiB |  |
+| **total_phys_cores** | **Float** | Total number of physical cores in the Pod |  |
+| **total_phys_memory** | **Integer** | Total amount of physical memory in the Pod (GB) |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::SystemResources.new(
+  cores: null,
+  host_mtms_name: null,
+  id: null,
+  memory: null,
+  total_cores: null,
+  total_memory: null,
+  total_phys_cores: null,
+  total_phys_memory: null
+)
+```
+

data/docs/UpdateServerVirtualSerialNumber.md

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

data/docs/UpdateVirtualSerialNumber.md

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

data/docs/VirtualSerialNumber.md

@@ -0,0 +1,22 @@
+# IbmCloudPower::VirtualSerialNumber
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | Description of the Virtual Serial Number |  |
+| **pvm_instance_id** | **String** | ID of the PVM Instance Virtual Serial Number is attached to. |  |
+| **serial** | **String** | Virtual Serial Number assigned to the PVM Instance |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::VirtualSerialNumber.new(
+  description: null,
+  pvm_instance_id: null,
+  serial: null
+)
+```
+

data/docs/Volume.md

@@ -6,13 +6,15 @@
 | ---- | ---- | ----------- | ----- |
 | **aux_volume_name** | **String** | Auxiliary volume name at storage host level | [optional] |
 | **auxiliary** | **Boolean** | true if volume is auxiliary otherwise false | [optional] |
-| **boot_volume** | **Boolean** | Indicates if the volume is the server's boot volume | [optional] |
+| **boot_volume** | **Boolean** | Indicates if the volume is the server's boot volume. Only returned when querying a server's attached volumes | [optional] |
 | **bootable** | **Boolean** | Indicates if the volume is boot capable | [optional] |
 | **consistency_group_name** | **String** | Consistency Group Name if volume is a part of volume group | [optional] |
 | **creation_date** | **Time** | Creation Date |  |
-| **delete_on_termination** | **Boolean** | Indicates if the volume should be deleted when the server terminates | [optional] |
+| **crn** | **String** |  | [optional] |
 | **disk_type** | **String** | Type of Disk | [optional] |
+| **freeze_time** | **Time** | Freeze time of remote copy relationship | [optional] |
 | **group_id** | **String** | Volume Group ID | [optional] |
+| **io_throttle_rate** | **String** | Amount of iops assigned to the volume | [optional] |
 | **last_update_date** | **Time** | Last Update Date |  |
 | **master_volume_name** | **String** | Master volume name at storage host level | [optional] |
 | **mirroring_state** | **String** | Mirroring state for replication enabled volume | [optional] |
@@ -26,6 +28,7 @@
 | **shareable** | **Boolean** | Indicates if the volume is shareable between VMs | [optional] |
 | **size** | **Float** | Volume Size |  |
 | **state** | **String** | Volume State | [optional] |
+| **user_tags** | **Array** |  | [optional] |
 | **volume_id** | **String** | Volume ID |  |
 | **volume_pool** | **String** | Volume pool, name of storage pool where the volume is located | [optional] |
 | **volume_type** | **String** | Volume type, name of storage template used to create the volume | [optional] |
@@ -43,9 +46,11 @@ instance = IbmCloudPower::Volume.new(
   bootable: null,
   consistency_group_name: null,
   creation_date: null,
-  delete_on_termination: null,
+  crn: null,
   disk_type: null,
+  freeze_time: null,
   group_id: null,
+  io_throttle_rate: null,
   last_update_date: null,
   master_volume_name: null,
   mirroring_state: null,
@@ -59,6 +64,7 @@ instance = IbmCloudPower::Volume.new(
   shareable: null,
   size: null,
   state: null,
+  user_tags: null,
   volume_id: null,
   volume_pool: null,
   volume_type: null,

data/docs/VolumeAction.md

@@ -4,7 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **replication_enabled** | **Boolean** | Indicates if the volume should be replication enabled or not |  |
+| **replication_enabled** | **Boolean** | Indicates if the volume should be replication enabled or not | [optional] |
+| **target_storage_tier** | **String** | Target storage tier; used to change a volume's storage tier | [optional] |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'ibm_cloud_power'
 
 instance = IbmCloudPower::VolumeAction.new(
-  replication_enabled: null
+  replication_enabled: null,
+  target_storage_tier: null
 )
 ```