ibm_cloud_power 1.1.1 → 2.1.0

data/docs/VolumeGroupActionStop.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::VolumeGroupActionStop
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access** | **Boolean** | Indicates the access mode of aux volumes |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::VolumeGroupActionStop.new(
+  access: null
+)
+```
+

data/docs/VolumeGroupCreate.md

@@ -0,0 +1,22 @@
+# IbmCloudPower::VolumeGroupCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **consistency_group_name** | **String** | The name of consistencyGroup at storage controller level. This is required to onboard existing volume group on the target site for DR set up; name and consistencyGroupName are mutually exclusive. | [optional] |
+| **name** | **String** | The name of the volume group. This field is required for creation of new volume group; name and consistencyGroupName are mutually exclusive. | [optional] |
+| **volume_ids** | **Array<String>** | List of volume IDs,members of VolumeGroup |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::VolumeGroupCreate.new(
+  consistency_group_name: null,
+  name: null,
+  volume_ids: null
+)
+```
+

data/docs/VolumeGroupCreateResponse.md

@@ -0,0 +1,24 @@
+# IbmCloudPower::VolumeGroupCreateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the volume group |  |
+| **name** | **String** | The name of the volume group |  |
+| **status** | **String** | Status of the volume group |  |
+| **status_detail** | **String** | Status details of the volume group | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::VolumeGroupCreateResponse.new(
+  id: null,
+  name: null,
+  status: null,
+  status_detail: null
+)
+```
+

data/docs/VolumeGroupDetails.md

@@ -0,0 +1,30 @@
+# IbmCloudPower::VolumeGroupDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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_status** | **String** | Replication status of volume group | [optional] |
+| **status** | **String** | Status of the volume group | [optional] |
+| **status_description** | [**StatusDescription**](StatusDescription.md) |  | [optional] |
+| **volume_ids** | **Array<String>** | List of volume IDs,member of VolumeGroup | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::VolumeGroupDetails.new(
+  consistency_group_name: null,
+  id: null,
+  name: null,
+  replication_status: null,
+  status: null,
+  status_description: null,
+  volume_ids: null
+)
+```
+

data/docs/VolumeGroupRemoteCopyRelationships.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::VolumeGroupRemoteCopyRelationships
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the volume group | [optional] |
+| **remote_copy_relationships** | [**Array<RemoteCopyRelationship>**](RemoteCopyRelationship.md) | List of remote copy relationships | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::VolumeGroupRemoteCopyRelationships.new(
+  id: null,
+  remote_copy_relationships: null
+)
+```
+

data/docs/VolumeGroupStorageDetails.md

@@ -0,0 +1,34 @@
+# IbmCloudPower::VolumeGroupStorageDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **consistency_group_name** | **String** | The name of consistency group at storage controller level |  |
+| **cycle_period_seconds** | **Integer** | Indicates the minimum period in seconds between multiple cycles | [optional] |
+| **cycling_mode** | **String** | Indicates the type of cycling mode used | [optional] |
+| **num_ofvols** | **Integer** | Number of volumes in volume group | [optional] |
+| **primary_role** | **String** | Indicates whether master/aux volume is playing the primary role | [optional] |
+| **remote_copy_relationship_names** | **Array<String>** | List of remote-copy relationship names in a volume group | [optional] |
+| **replication_type** | **String** | Type of replication(metro,global) | [optional] |
+| **state** | **String** | Indicates the relationship state | [optional] |
+| **sync** | **String** | Indicates whether the relationship is synchronized | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::VolumeGroupStorageDetails.new(
+  consistency_group_name: null,
+  cycle_period_seconds: null,
+  cycling_mode: null,
+  num_ofvols: null,
+  primary_role: null,
+  remote_copy_relationship_names: null,
+  replication_type: null,
+  state: null,
+  sync: null
+)
+```
+

data/docs/VolumeGroupUpdate.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::VolumeGroupUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **add_volumes** | **Array<String>** | List of volume IDs to add to the volume-group | [optional] |
+| **remove_volumes** | **Array<String>** | List of volume IDs to remove from the volume-group | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::VolumeGroupUpdate.new(
+  add_volumes: null,
+  remove_volumes: null
+)
+```
+

data/docs/VolumeGroups.md

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

data/docs/VolumeGroupsDetails.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::VolumeGroupsDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **volume_groups** | [**Array<VolumeGroupDetails>**](VolumeGroupDetails.md) | The list of volume groups with details |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::VolumeGroupsDetails.new(
+  volume_groups: null
+)
+```
+

data/docs/VolumeInfo.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**volume_id** | **String** | ID of the volume | [optional] 
-**name** | **String** | Name of the volume | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the volume | [optional] |
+| **volume_id** | **String** | ID of the volume | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::VolumeInfo.new(volume_id: null,
-                                 name: null)
+instance = IbmCloudPower::VolumeInfo.new(
+  name: null,
+  volume_id: null
+)
 ```
 
-

data/docs/VolumeOnboarding.md

@@ -0,0 +1,30 @@
+# IbmCloudPower::VolumeOnboarding
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **creation_timestamp** | **Time** | Indicates the create-time of volume onboarding operation | [optional] |
+| **progress** | **Float** | Indicates the progress of volume onboarding operation | [optional] |
+| **results** | **Object** |  | [optional] |
+| **description** | **String** | Description of the volume onboarding operation | [optional] |
+| **id** | **String** | Indicates the volume onboarding operation id |  |
+| **input_volumes** | **Array<String>** | List of volumes requested to be onboarded | [optional] |
+| **status** | **String** | Indicates the status of volume onboarding operation | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::VolumeOnboarding.new(
+  creation_timestamp: null,
+  progress: null,
+  results: null,
+  description: null,
+  id: null,
+  input_volumes: null,
+  status: null
+)
+```
+

data/docs/VolumeOnboardingCommon.md

@@ -0,0 +1,24 @@
+# IbmCloudPower::VolumeOnboardingCommon
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | Description of the volume onboarding operation | [optional] |
+| **id** | **String** | Indicates the volume onboarding operation id |  |
+| **input_volumes** | **Array<String>** | List of volumes requested to be onboarded | [optional] |
+| **status** | **String** | Indicates the status of volume onboarding operation | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::VolumeOnboardingCommon.new(
+  description: null,
+  id: null,
+  input_volumes: null,
+  status: null
+)
+```
+

data/docs/VolumeOnboardingCreate.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::VolumeOnboardingCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **volumes** | [**Array<AuxiliaryVolumesForOnboarding>**](AuxiliaryVolumesForOnboarding.md) |  |  |
+| **description** | **String** | Description of the volume onboarding operation | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::VolumeOnboardingCreate.new(
+  volumes: null,
+  description: null
+)
+```
+

data/docs/VolumeOnboardingCreateResponse.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::VolumeOnboardingCreateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | Description of the volume onboarding operation | [optional] |
+| **id** | **String** | Indicates the volume onboarding operation id | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::VolumeOnboardingCreateResponse.new(
+  description: null,
+  id: null
+)
+```
+

data/docs/VolumeOnboardingFailure.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::VolumeOnboardingFailure
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **failure_message** | **String** | The failure reason for the volumes which have failed to be onboarded | [optional] |
+| **volumes** | **Array<String>** | List of volumes which have failed to be onboarded | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::VolumeOnboardingFailure.new(
+  failure_message: null,
+  volumes: null
+)
+```
+

data/docs/VolumeOnboardings.md

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

data/docs/VolumeReference.md

@@ -2,44 +2,69 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**volume_id** | **String** | Volume ID | 
-**name** | **String** | Volume Name | 
-**state** | **String** | Volume State | 
-**size** | **Float** | Volume Size | 
-**shareable** | **Boolean** | Indicates if the volume is shareable between VMs | 
-**bootable** | **Boolean** | Indicates if the volume is boot capable | 
-**boot_volume** | **Boolean** | Indicates if the volume is the server's boot volume | [optional] 
-**delete_on_termination** | **Boolean** | Indicates if the volume should be deleted when the server terminates | [optional] 
-**disk_type** | **String** | Type of Disk | 
-**volume_type** | **String** | Volume type, name of storage template used to create the volume | [optional] 
-**wwn** | **String** | Volume world wide name | 
-**creation_date** | **DateTime** | Creation Date | 
-**last_update_date** | **DateTime** | Last Update Date | 
-**href** | **String** | Link to Volume resource | 
-**pvm_instance_i_ds** | **Array<String>** | List of PCloud PVM Instance attached to the volume | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **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] |
+| **disk_type** | **String** | Type of Disk |  |
+| **group_id** | **String** | Volume Group ID | [optional] |
+| **href** | **String** | Link to Volume resource |  |
+| **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] |
+| **name** | **String** | Volume Name |  |
+| **out_of_band_deleted** | **Boolean** | true if volume does not exist on storage controller, as volume has been deleted by deleting its paired volume from the mapped replication site. | [optional] |
+| **primary_role** | **String** | indicates whether master/aux volume is playing the primary role | [optional] |
+| **pvm_instance_ids** | **Array<String>** | List of PCloud PVM Instance attached to the volume | [optional] |
+| **replication_enabled** | **Boolean** | True if volume is replication enabled otherwise false | [optional] |
+| **replication_status** | **String** | shows the replication status of a volume | [optional] |
+| **replication_type** | **String** | type of replication(metro, global)s | [optional] |
+| **shareable** | **Boolean** | Indicates if the volume is shareable between VMs |  |
+| **size** | **Float** | Volume Size |  |
+| **state** | **String** | Volume State |  |
+| **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] |
+| **wwn** | **String** | Volume world wide name |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::VolumeReference.new(volume_id: null,
-                                 name: null,
-                                 state: null,
-                                 size: null,
-                                 shareable: null,
-                                 bootable: null,
-                                 boot_volume: null,
-                                 delete_on_termination: null,
-                                 disk_type: null,
-                                 volume_type: null,
-                                 wwn: null,
-                                 creation_date: null,
-                                 last_update_date: null,
-                                 href: null,
-                                 pvm_instance_i_ds: null)
+instance = IbmCloudPower::VolumeReference.new(
+  aux_volume_name: null,
+  auxiliary: null,
+  boot_volume: null,
+  bootable: null,
+  consistency_group_name: null,
+  creation_date: null,
+  delete_on_termination: null,
+  disk_type: null,
+  group_id: null,
+  href: null,
+  last_update_date: null,
+  master_volume_name: null,
+  mirroring_state: null,
+  name: null,
+  out_of_band_deleted: null,
+  primary_role: null,
+  pvm_instance_ids: null,
+  replication_enabled: null,
+  replication_status: null,
+  replication_type: null,
+  shareable: null,
+  size: null,
+  state: null,
+  volume_id: null,
+  volume_pool: null,
+  volume_type: null,
+  wwn: null
+)
 ```
 
-

data/docs/VolumeRemoteCopyRelationship.md

@@ -0,0 +1,48 @@
+# IbmCloudPower::VolumeRemoteCopyRelationship
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cycle_period_seconds** | **Integer** | Indicates the minimum period in seconds between multiple cycles | [optional] |
+| **id** | **String** | Volume ID | [optional] |
+| **aux_changed_volume_name** | **String** | Name of the volume that is acting as the auxiliary change volume for the relationship | [optional] |
+| **aux_volume_name** | **String** | Auxiliary volume name at storage host level | [optional] |
+| **consistency_group_name** | **String** | Consistency Group Name if volume is a part of volume group | [optional] |
+| **copy_type** | **String** | Indicates the copy type. | [optional] |
+| **cycling_mode** | **String** | Indicates the type of cycling mode used. | [optional] |
+| **freeze_time** | **Time** | Freeze time of remote copy relationship | [optional] |
+| **master_changed_volume_name** | **String** | Name of the volume that is acting as the master change volume for the relationship | [optional] |
+| **master_volume_name** | **String** | Master volume name at storage host level | [optional] |
+| **name** | **String** | Remote copy relationship name |  |
+| **primary_role** | **String** | Indicates whether master/aux volume is playing the primary role | [optional] |
+| **progress** | **Integer** | Indicates the relationship progress | [optional] |
+| **remote_copy_id** | **String** | Remote copy relationship ID |  |
+| **state** | **String** | Indicates the relationship state | [optional] |
+| **sync** | **String** | Indicates whether the relationship is synchronized | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::VolumeRemoteCopyRelationship.new(
+  cycle_period_seconds: null,
+  id: null,
+  aux_changed_volume_name: null,
+  aux_volume_name: null,
+  consistency_group_name: null,
+  copy_type: null,
+  cycling_mode: null,
+  freeze_time: null,
+  master_changed_volume_name: null,
+  master_volume_name: null,
+  name: null,
+  primary_role: null,
+  progress: null,
+  remote_copy_id: null,
+  state: null,
+  sync: null
+)
+```
+

data/docs/Volumes.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**volumes** | [**Array<VolumeReference>**](VolumeReference.md) | Volumes | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **volumes** | [**Array<VolumeReference>**](VolumeReference.md) | Volumes |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::Volumes.new(volumes: null)
+instance = IbmCloudPower::Volumes.new(
+  volumes: null
+)
 ```
 
-

data/docs/VolumesAttach.md

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

data/docs/VolumesAttachmentResponse.md

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

data/docs/VolumesClone.md

@@ -2,30 +2,31 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**volumes_clone_id** | **String** | ID assigned to a volumes-clone request | [optional] 
-**name** | **String** | Name assigned to a volumes-clone request | [optional] 
-**status** | **String** | Current status of the volumes-clone request | [optional] 
-**action** | **String** | Current action performed for the volumes-clone request | [optional] 
-**percent_complete** | **Integer** | The percent completion for the current action | 
-**failure_message** | **String** | Failure reason for a failed volumes-clone request | [optional] 
-**creation_date** | **DateTime** | Creation Date | [optional] 
-**last_update_date** | **DateTime** | Last Update Date | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** | Current action performed for the volumes-clone request | [optional] |
+| **creation_date** | **Time** | Creation Date | [optional] |
+| **failure_message** | **String** | Failure reason for a failed volumes-clone request | [optional] |
+| **last_update_date** | **Time** | Last Update Date | [optional] |
+| **name** | **String** | Name assigned to a volumes-clone request | [optional] |
+| **percent_complete** | **Integer** | The percent completion for the current action |  |
+| **status** | **String** | Current status of the volumes-clone request | [optional] |
+| **volumes_clone_id** | **String** | ID assigned to a volumes-clone request | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::VolumesClone.new(volumes_clone_id: null,
-                                 name: null,
-                                 status: null,
-                                 action: null,
-                                 percent_complete: null,
-                                 failure_message: null,
-                                 creation_date: null,
-                                 last_update_date: null)
+instance = IbmCloudPower::VolumesClone.new(
+  action: null,
+  creation_date: null,
+  failure_message: null,
+  last_update_date: null,
+  name: null,
+  percent_complete: null,
+  status: null,
+  volumes_clone_id: null
+)
 ```
 
-