ibm_cloud_power 2.1.1 → 3.0.0

data/docs/VolumeGroup.md

@@ -4,12 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **auxiliary** | **Boolean** | Indicates whether the volume group is for auxiliary volumes or master volumes | [optional] |
 | **consistency_group_name** | **String** | The name of consistencyGroup at storage host level | [optional] |
 | **id** | **String** | The ID of the volume group |  |
 | **name** | **String** | The name of the volume group |  |
+| **replication_sites** | **Array<String>** | Indicates the replication site of the volume group | [optional] |
 | **replication_status** | **String** | Replication status of volume group | [optional] |
 | **status** | **String** | Status of the volume group | [optional] |
 | **status_description** | [**StatusDescription**](StatusDescription.md) |  | [optional] |
+| **storage_pool** | **String** | Indicates the storage pool of the volume group | [optional] |
 
 ## Example
 
@@ -17,12 +20,15 @@
 require 'ibm_cloud_power'
 
 instance = IbmCloudPower::VolumeGroup.new(
+  auxiliary: null,
   consistency_group_name: null,
   id: null,
   name: null,
+  replication_sites: null,
   replication_status: null,
   status: null,
-  status_description: null
+  status_description: null,
+  storage_pool: null
 )
 ```
 

data/docs/VolumeGroupDetails.md

@@ -4,12 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **auxiliary** | **Boolean** | Indicates whether the volume group is for auxiliary volumes or master volumes | [optional] |
 | **consistency_group_name** | **String** | The name of volume group at storage host level | [optional] |
 | **id** | **String** | The ID of the volume group |  |
 | **name** | **String** | The name of the volume group |  |
+| **replication_sites** | **Array<String>** | Indicates the replication site of the volume group | [optional] |
 | **replication_status** | **String** | Replication status of volume group | [optional] |
 | **status** | **String** | Status of the volume group | [optional] |
 | **status_description** | [**StatusDescription**](StatusDescription.md) |  | [optional] |
+| **storage_pool** | **String** | Indicates the storage pool of the volume group | [optional] |
 | **volume_ids** | **Array<String>** | List of volume IDs,member of VolumeGroup | [optional] |
 
 ## Example
@@ -18,12 +21,15 @@
 require 'ibm_cloud_power'
 
 instance = IbmCloudPower::VolumeGroupDetails.new(
+  auxiliary: null,
   consistency_group_name: null,
   id: null,
   name: null,
+  replication_sites: null,
   replication_status: null,
   status: null,
   status_description: null,
+  storage_pool: null,
   volume_ids: null
 )
 ```

data/docs/VolumeInfo.md

@@ -4,6 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **crn** | **String** |  | [optional] |
 | **name** | **String** | Name of the volume | [optional] |
 | **volume_id** | **String** | ID of the volume | [optional] |
 
@@ -13,6 +14,7 @@
 require 'ibm_cloud_power'
 
 instance = IbmCloudPower::VolumeInfo.new(
+  crn: null,
   name: null,
   volume_id: null
 )

data/docs/VolumeOnboardingCreate.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **volumes** | [**Array<AuxiliaryVolumesForOnboarding>**](AuxiliaryVolumesForOnboarding.md) |  |  |
 | **description** | **String** | Description of the volume onboarding operation | [optional] |
+| **user_tags** | **Array** |  | [optional] |
 
 ## Example
 
@@ -14,7 +15,8 @@ require 'ibm_cloud_power'
 
 instance = IbmCloudPower::VolumeOnboardingCreate.new(
   volumes: null,
-  description: null
+  description: null,
+  user_tags: null
 )
 ```
 

data/docs/VolumeReference.md

@@ -6,14 +6,17 @@
 | ---- | ---- | ----------- | ----- |
 | **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 |  |
 | **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] |
+| **delete_on_termination** | **Boolean** | Indicates if the volume should be deleted when the server terminates. Only returned when querying a server's attached volumes | [optional] |
 | **disk_type** | **String** | Type of Disk |  |
+| **freeze_time** | **Time** | Freeze time of remote copy relationship | [optional] |
 | **group_id** | **String** | Volume Group ID | [optional] |
 | **href** | **String** | Link to Volume resource |  |
+| **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] |
@@ -27,6 +30,7 @@
 | **shareable** | **Boolean** | Indicates if the volume is shareable between VMs |  |
 | **size** | **Float** | Volume Size |  |
 | **state** | **String** | Volume State |  |
+| **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] |
@@ -44,10 +48,13 @@ instance = IbmCloudPower::VolumeReference.new(
   bootable: null,
   consistency_group_name: null,
   creation_date: null,
+  crn: null,
   delete_on_termination: null,
   disk_type: null,
+  freeze_time: null,
   group_id: null,
   href: null,
+  io_throttle_rate: null,
   last_update_date: null,
   master_volume_name: null,
   mirroring_state: null,
@@ -61,6 +68,7 @@ instance = IbmCloudPower::VolumeReference.new(
   shareable: null,
   size: null,
   state: null,
+  user_tags: null,
   volume_id: null,
   volume_pool: null,
   volume_type: null,

data/docs/VolumeSnapshotList.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::VolumeSnapshotList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **volume_snapshots** | [**Array<SnapshotV1>**](SnapshotV1.md) | The list of volume snapshots. | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::VolumeSnapshotList.new(
+  volume_snapshots: null
+)
+```
+

data/docs/VolumesCloneAsyncRequest.md

@@ -4,7 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | Base name of the new cloned volume(s). Cloned Volume names will be prefixed with 'clone-'     and suffixed with '-#####' (where ##### is a 5 digit random number) If multiple volumes cloned they will be further suffixed with an incremental number starting with 1.   Example volume names using name=\"volume-abcdef\"     single volume clone will be named \"clone-volume-abcdef-83081\"     multi volume clone will be named \"clone-volume-abcdef-73721-1\", \"clone-volume-abcdef-73721-2\", ...  |  |
+| **name** | **String** | Base name of the new cloned volume(s). Cloned Volume names will be prefixed with 'clone-'     and suffixed with '-#####' (where ##### is a 5 digit random number) If multiple volumes cloned they will be further suffixed with an incremental number starting with 1.   Example volume names using name=\"volume-abcdef\"     single volume clone will be named \"clone-volume-abcdef-83081\"     multi volume clone will be named \"clone-volume-abcdef-73721-1\", \"clone-volume-abcdef-73721-2\", ... For multiple volume clone, the provided name will be truncated to the first 20 characters.  |  |
+| **target_replication_enabled** | **Boolean** | Cloned volume will be non replication enabled if it is set to false. By default, the replication property of the source volume will be used to determine the replication property of the cloned target volume. | [optional] |
+| **target_storage_tier** | **String** | Target storage tier for the cloned volumes. Use to clone a set of volumes from one storage tier to a different storage tier. Cloned volumes must remain in the same storage pool as the source volumes.  | [optional] |
+| **user_tags** | **Array** |  | [optional] |
 | **volume_ids** | **Array<String>** | List of volumes to be cloned |  |
 
 ## Example
@@ -14,6 +17,9 @@ require 'ibm_cloud_power'
 
 instance = IbmCloudPower::VolumesCloneAsyncRequest.new(
   name: null,
+  target_replication_enabled: null,
+  target_storage_tier: null,
+  user_tags: null,
   volume_ids: null
 )
 ```

data/docs/VolumesCloneExecute.md

@@ -4,8 +4,11 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **name** | **String** | Base name of the new cloned volume(s). Cloned Volume names will be prefixed with 'clone-'     and suffixed with '-#####' (where ##### is a 5 digit random number) If multiple volumes cloned they will be further suffixed with an incremental number starting with 1.   Example volume names using name=\"volume-abcdef\"     single volume clone will be named \"clone-volume-abcdef-83081\"     multi volume clone will be named \"clone-volume-abcdef-73721-1\", \"clone-volume-abcdef-73721-2\", ...  |  |
+| **name** | **String** | Base name of the new cloned volume(s). Cloned Volume names will be prefixed with 'clone-'     and suffixed with '-#####' (where ##### is a 5 digit random number) If multiple volumes cloned they will be further suffixed with an incremental number starting with 1.   Example volume names using name=\"volume-abcdef\"     single volume clone will be named \"clone-volume-abcdef-83081\"     multi volume clone will be named \"clone-volume-abcdef-73721-1\", \"clone-volume-abcdef-73721-2\", ... For multiple volume clone, the provided name will be truncated to the first 20 characters.  |  |
 | **rollback_prepare** | **Boolean** | default False, Execute failure rolls back clone activity but leaves prepared snapshot True, Execute failure rolls back clone activity and removes the prepared snapshot  | [optional] |
+| **target_replication_enabled** | **Boolean** | Cloned volume will be non replication enabled if it is set to false. By default, the replication property of the source volume will be used to determine the replication property of the cloned target volume. | [optional] |
+| **target_storage_tier** | **String** | Target storage tier for the cloned volumes. Use to clone a set of volumes from one storage tier to a different storage tier. Cloned volumes must remain in the same storage pool as the source volumes.  | [optional] |
+| **user_tags** | **Array** |  | [optional] |
 
 ## Example
 
@@ -14,7 +17,10 @@ require 'ibm_cloud_power'
 
 instance = IbmCloudPower::VolumesCloneExecute.new(
   name: null,
-  rollback_prepare: null
+  rollback_prepare: null,
+  target_replication_enabled: null,
+  target_storage_tier: null,
+  user_tags: null
 )
 ```
 

data/docs/VolumesCloneRequest.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **display_name** | **String** | Display name for the new cloned volumes. Cloned Volume names will be prefixed with 'clone-'. If multiple volumes cloned they will be suffix with a '-' and an incremental number starting with 1.   Example volume names using displayName=\"volume-abcdef\"     single volume clone will be named \"clone-volume-abcdef\"     multi volume clone will be named \"clone-volume-abcdef-1\", \"clone-volume-abcdef-2\", ...  |  |
+| **display_name** | **String** | Display name for the new cloned volumes. Cloned Volume names will be prefixed with 'clone-'. If multiple volumes cloned they will be suffix with a '-' and an incremental number starting with 1.   Example volume names using displayName=\"volume-abcdef\"     single volume clone will be named \"clone-volume-abcdef\"     multi volume clone will be named \"clone-volume-abcdef-1\", \"clone-volume-abcdef-2\", ... For multiple volume clone, the provided name will be truncated to the first 20 characters.  |  |
 | **volume_ids** | **Array<String>** | List of volumes to be cloned |  |
 
 ## Example

data/docs/VolumesDelete.md

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

data/docs/VolumesDeleteResponse.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::VolumesDeleteResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **summary** | **String** | status summary for volumes deletion request | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::VolumesDeleteResponse.new(
+  summary: null
+)
+```
+

data/docs/VolumesDetach.md

@@ -0,0 +1,22 @@
+# IbmCloudPower::VolumesDetach
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **detach_all_volumes** | **Boolean** | Indicates if all volumes, except primary boot volume, attached to the PVMInstance should be detached (default=false); required if volumeIDs is not provided | [optional][default to false] |
+| **detach_primary_boot_volume** | **Boolean** | Indicates if primary boot volume attached to the PVMInstance should be detached (default=false) | [optional][default to false] |
+| **volume_ids** | **Array<String>** | List of volumes to be detached from a PVM instance; required if detachAllVolumes is not provided | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::VolumesDetach.new(
+  detach_all_volumes: null,
+  detach_primary_boot_volume: null,
+  volume_ids: null
+)
+```
+

data/docs/VolumesDetachmentResponse.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::VolumesDetachmentResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **summary** | **String** | status summary for volume detachment from a PVM Instance |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::VolumesDetachmentResponse.new(
+  summary: null
+)
+```
+

data/docs/Workspace.md

@@ -0,0 +1,30 @@
+# IbmCloudPower::Workspace
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **capabilities** | **Hash<String, Boolean>** | Workspace Capabilities |  |
+| **details** | [**WorkspaceDetails**](WorkspaceDetails.md) |  |  |
+| **id** | **String** | Workspace ID |  |
+| **location** | [**WorkspaceLocation**](WorkspaceLocation.md) |  |  |
+| **name** | **String** | The Workspace name |  |
+| **status** | **String** | The Workspace status |  |
+| **type** | **String** | The Workspace type |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::Workspace.new(
+  capabilities: null,
+  details: null,
+  id: null,
+  location: null,
+  name: null,
+  status: null,
+  type: null
+)
+```
+

data/docs/WorkspaceDetails.md

@@ -0,0 +1,26 @@
+# IbmCloudPower::WorkspaceDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **creation_date** | **Time** | Workspace creation date |  |
+| **crn** | **String** | The Workspace crn |  |
+| **href** | **String** | Link to Workspace Resource | [optional] |
+| **network_security_groups** | [**WorkspaceNetworkSecurityGroupsDetails**](WorkspaceNetworkSecurityGroupsDetails.md) |  | [optional] |
+| **power_edge_router** | [**WorkspacePowerEdgeRouterDetails**](WorkspacePowerEdgeRouterDetails.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::WorkspaceDetails.new(
+  creation_date: null,
+  crn: null,
+  href: null,
+  network_security_groups: null,
+  power_edge_router: null
+)
+```
+

data/docs/WorkspaceLocation.md

@@ -0,0 +1,22 @@
+# IbmCloudPower::WorkspaceLocation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **region** | **String** | The Workspace location region zone |  |
+| **type** | **String** | The Workspace location region type | [optional] |
+| **url** | **String** | The Workspace location region url | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::WorkspaceLocation.new(
+  region: null,
+  type: null,
+  url: null
+)
+```
+

data/docs/WorkspaceNetworkSecurityGroupsDetails.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::WorkspaceNetworkSecurityGroupsDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **state** | **String** | The state of a Network Security Groups configuration |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::WorkspaceNetworkSecurityGroupsDetails.new(
+  state: null
+)
+```
+

data/docs/WorkspacePowerEdgeRouterDetails.md

@@ -0,0 +1,22 @@
+# IbmCloudPower::WorkspacePowerEdgeRouterDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **migration_status** | **String** | The migration status of a Power Edge Router | [optional] |
+| **state** | **String** | The state of a Power Edge Router |  |
+| **type** | **String** | The Power Edge Router type |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::WorkspacePowerEdgeRouterDetails.new(
+  migration_status: null,
+  state: null,
+  type: null
+)
+```
+

data/docs/Workspaces.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::Workspaces
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspaces** | [**Array<Workspace>**](Workspace.md) | The list of available workspaces |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::Workspaces.new(
+  workspaces: null
+)
+```
+

data/docs/WorkspacesApi.md

@@ -0,0 +1,130 @@
+# IbmCloudPower::WorkspacesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v1_workspaces_get**](WorkspacesApi.md#v1_workspaces_get) | **GET** /v1/workspaces/{workspace_id} | Get a Workspace's information and capabilities |
+| [**v1_workspaces_getall**](WorkspacesApi.md#v1_workspaces_getall) | **GET** /v1/workspaces | Get all Workspaces information and capabilities for a tenant |
+
+
+## v1_workspaces_get
+
+> <Workspace> v1_workspaces_get(workspace_id)
+
+Get a Workspace's information and capabilities
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::WorkspacesApi.new
+workspace_id = 'workspace_id_example' # String | Workspace ID
+
+begin
+  # Get a Workspace's information and capabilities
+  result = api_instance.v1_workspaces_get(workspace_id)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling WorkspacesApi->v1_workspaces_get: #{e}"
+end
+```
+
+#### Using the v1_workspaces_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Workspace>, Integer, Hash)> v1_workspaces_get_with_http_info(workspace_id)
+
+```ruby
+begin
+  # Get a Workspace's information and capabilities
+  data, status_code, headers = api_instance.v1_workspaces_get_with_http_info(workspace_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Workspace>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling WorkspacesApi->v1_workspaces_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **workspace_id** | **String** | Workspace ID |  |
+
+### Return type
+
+[**Workspace**](Workspace.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_workspaces_getall
+
+> <Workspaces> v1_workspaces_getall
+
+Get all Workspaces information and capabilities for a tenant
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::WorkspacesApi.new
+
+begin
+  # Get all Workspaces information and capabilities for a tenant
+  result = api_instance.v1_workspaces_getall
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling WorkspacesApi->v1_workspaces_getall: #{e}"
+end
+```
+
+#### Using the v1_workspaces_getall_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Workspaces>, Integer, Hash)> v1_workspaces_getall_with_http_info
+
+```ruby
+begin
+  # Get all Workspaces information and capabilities for a tenant
+  data, status_code, headers = api_instance.v1_workspaces_getall_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Workspaces>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling WorkspacesApi->v1_workspaces_getall_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Workspaces**](Workspaces.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/ibm_cloud_power.gemspec

@@ -5,10 +5,10 @@
 
 #IBM Power Cloud API for Power Hardware / Infrastructure
 
-The version of the OpenAPI document: 1.0.0
-Contact: kylej@us.ibm.com
+The version of the OpenAPI document: 2.3.1
+Contact: ismirlia@us.ibm.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.2.1
+OpenAPI Generator version: 5.4.0
 
 =end
 
@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.version     = IbmCloudPower::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["IBM Cloud Developers"]
-  s.email       = ["kylej@us.ibm.com"]
+  s.email       = ["ismirlia@us.ibm.com"]
   s.homepage    = "https://openapi-generator.tech"
   s.summary     = "IBM Cloud Power Cloud"
   s.description = "Ruby gem for IBM Cloud Power Cloud"