ibm_cloud_power 1.1.1 → 2.0.0

data/docs/SAPCreate.md

@@ -2,32 +2,39 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | Name of the sap pvm-instance | 
-**image_id** | **String** | Image ID of the sap image to use for the server | 
-**profile_id** | **String** | SAP Profile ID for the amount of cores and memory | 
-**networks** | [**Array<PVMInstanceAddNetwork>**](PVMInstanceAddNetwork.md) | The pvm instance networks information | 
-**volume_i_ds** | **Array<String>** | List of Volume IDs to attach to the pvm-instance on creation | [optional] 
-**instances** | [**PVMInstanceMultiCreate**](PVMInstanceMultiCreate.md) |  | [optional] 
-**ssh_key_name** | **String** | The name of the SSH Key to provide to the server for authenticating | [optional] 
-**user_data** | **String** | Cloud-init user-defined data. The user-defined data is made available to the VM instance as a config drive. | [optional] 
-**pin_policy** | [**PinPolicy**](PinPolicy.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the sap pvm-instance |  |
+| **image_id** | **String** | Image ID of the sap image to use for the server |  |
+| **profile_id** | **String** | SAP Profile ID for the amount of cores and memory |  |
+| **networks** | [**Array<PVMInstanceAddNetwork>**](PVMInstanceAddNetwork.md) | The pvm instance networks information |  |
+| **volume_ids** | **Array<String>** | List of Volume IDs to attach to the pvm-instance on creation | [optional] |
+| **storage_affinity** | [**StorageAffinity**](StorageAffinity.md) |  | [optional] |
+| **storage_pool** | **String** | Storage Pool for server deployment; if provided then storageAffinity and storageType will be ignored; Only valid when you deploy one of the IBM supplied stock images. Storage type and pool for a custom image (an imported image or an image that is created from a PVMInstance capture) defaults to the storage type and pool the image was created in | [optional] |
+| **storage_type** | **String** | Storage type for server deployment; will be ignored if storagePool or storageAffinityPolicy is provided; Only valid when you deploy one of the IBM supplied stock images. Storage type and pool for a custom image (an imported or an image that is created from a PVMInstance capture) defaults to the storage type and pool the image was created in | [optional] |
+| **instances** | [**PVMInstanceMultiCreate**](PVMInstanceMultiCreate.md) |  | [optional] |
+| **ssh_key_name** | **String** | The name of the SSH Key to provide to the server for authenticating | [optional] |
+| **user_data** | **String** | Cloud-init user-defined data. The user-defined data is made available to the VM instance as a config drive. | [optional] |
+| **pin_policy** | [**PinPolicy**](PinPolicy.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::SAPCreate.new(name: null,
-                                 image_id: null,
-                                 profile_id: null,
-                                 networks: null,
-                                 volume_i_ds: null,
-                                 instances: null,
-                                 ssh_key_name: null,
-                                 user_data: null,
-                                 pin_policy: null)
+instance = IbmCloudPower::SAPCreate.new(
+  name: null,
+  image_id: null,
+  profile_id: null,
+  networks: null,
+  volume_ids: null,
+  storage_affinity: null,
+  storage_pool: null,
+  storage_type: null,
+  instances: null,
+  ssh_key_name: null,
+  user_data: null,
+  pin_policy: null
+)
 ```
 
-

data/docs/SAPProfile.md

@@ -2,24 +2,25 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**profile_id** | **String** | SAP Profile ID | 
-**type** | **String** | Type of profile | [default to 'balanced']
-**cores** | **Integer** | Amount of cores | 
-**memory** | **Integer** | Amount of memory (in GB) | 
-**certified** | **Boolean** | Has certification been performed on profile | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **profile_id** | **String** | SAP Profile ID |  |
+| **type** | **String** | Type of profile | [default to 'balanced'] |
+| **cores** | **Integer** | Amount of cores |  |
+| **memory** | **Integer** | Amount of memory (in GB) |  |
+| **certified** | **Boolean** | Has certification been performed on profile |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::SAPProfile.new(profile_id: null,
-                                 type: null,
-                                 cores: null,
-                                 memory: null,
-                                 certified: null)
+instance = IbmCloudPower::SAPProfile.new(
+  profile_id: null,
+  type: null,
+  cores: null,
+  memory: null,
+  certified: null
+)
 ```
 
-

data/docs/SAPProfileReference.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**profile_id** | **String** | SAP Profile ID | 
-**href** | **String** | Link to SAP profile resource | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **profile_id** | **String** | SAP Profile ID |  |
+| **href** | **String** | Link to SAP profile resource |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::SAPProfileReference.new(profile_id: null,
-                                 href: null)
+instance = IbmCloudPower::SAPProfileReference.new(
+  profile_id: null,
+  href: null
+)
 ```
 
-

data/docs/SAPProfiles.md

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

data/docs/SRC.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**timestamp** | **String** | The date stamp of the SRC | [optional] 
-**src** | **String** | The SRC reference code | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **timestamp** | **String** | The date stamp of the SRC | [optional] |
+| **src** | **String** | The SRC reference code | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::SRC.new(timestamp: null,
-                                 src: null)
+instance = IbmCloudPower::SRC.new(
+  timestamp: null,
+  src: null
+)
 ```
 
-

data/docs/SSHKey.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | User defined name for the SSH key | 
-**ssh_key** | **String** | SSH RSA key | 
-**creation_date** | **DateTime** | Date of sshkey creation | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | User defined name for the SSH key |  |
+| **ssh_key** | **String** | SSH RSA key |  |
+| **creation_date** | **Time** | Date of sshkey creation | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::SSHKey.new(name: null,
-                                 ssh_key: null,
-                                 creation_date: null)
+instance = IbmCloudPower::SSHKey.new(
+  name: null,
+  ssh_key: null,
+  creation_date: null
+)
 ```
 
-

data/docs/SSHKeys.md

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

data/docs/Snapshot.md

@@ -2,34 +2,35 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**snapshot_id** | **String** | ID of the PVM instance snapshot | 
-**pvm_instance_id** | **String** | PCloud PVM Instance ID | 
-**name** | **String** | Name of the PVM instance snapshot | 
-**description** | **String** | Description of the PVM instance snapshot | [optional] 
-**status** | **String** | Status of the PVM instancesnapshot | [optional] 
-**volume_snapshots** | **Hash<String, String>** | A map of volume snapshots included in the PVM instance snapshot | 
-**creation_date** | **DateTime** | Creation Date | [optional] 
-**last_update_date** | **DateTime** | Last Update Date | [optional] 
-**action** | **String** | Action performed on the instance snapshot | [optional] 
-**percent_complete** | **Float** | Snapshot completion percentage | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **snapshot_id** | **String** | ID of the PVM instance snapshot |  |
+| **pvm_instance_id** | **String** | PCloud PVM Instance ID |  |
+| **name** | **String** | Name of the PVM instance snapshot |  |
+| **description** | **String** | Description of the PVM instance snapshot | [optional] |
+| **status** | **String** | Status of the PVM instancesnapshot | [optional] |
+| **volume_snapshots** | **Hash<String, String>** | A map of volume snapshots included in the PVM instance snapshot |  |
+| **creation_date** | **Time** | Creation Date | [optional] |
+| **last_update_date** | **Time** | Last Update Date | [optional] |
+| **action** | **String** | Action performed on the instance snapshot | [optional] |
+| **percent_complete** | **Float** | Snapshot completion percentage | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::Snapshot.new(snapshot_id: null,
-                                 pvm_instance_id: null,
-                                 name: null,
-                                 description: null,
-                                 status: null,
-                                 volume_snapshots: null,
-                                 creation_date: null,
-                                 last_update_date: null,
-                                 action: null,
-                                 percent_complete: null)
+instance = IbmCloudPower::Snapshot.new(
+  snapshot_id: null,
+  pvm_instance_id: null,
+  name: null,
+  description: null,
+  status: null,
+  volume_snapshots: null,
+  creation_date: null,
+  last_update_date: null,
+  action: null,
+  percent_complete: null
+)
 ```
 
-

data/docs/SnapshotCreate.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | Name of the PVM instance snapshot to create. | 
-**description** | **String** | Description of the PVM instance snapshot. | [optional] 
-**volume_i_ds** | **Array<String>** | List of volumes to include in the PVM instance snapshot. This parameter is optional. If you do not specify this parameter or if the volumeIDs list is empty, all the volumes that are attached to the PVM instance are included in the snapshot. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the PVM instance snapshot to create. |  |
+| **description** | **String** | Description of the PVM instance snapshot. | [optional] |
+| **volume_ids** | **Array<String>** | List of volumes to include in the PVM instance snapshot. This parameter is optional. If you do not specify this parameter or if the volumeIDs list is empty, all the volumes that are attached to the PVM instance are included in the snapshot. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::SnapshotCreate.new(name: null,
-                                 description: null,
-                                 volume_i_ds: null)
+instance = IbmCloudPower::SnapshotCreate.new(
+  name: null,
+  description: null,
+  volume_ids: null
+)
 ```
 
-

data/docs/SnapshotCreateResponse.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**snapshot_id** | **String** | ID of the PVM instance snapshot | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **snapshot_id** | **String** | ID of the PVM instance snapshot |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::SnapshotCreateResponse.new(snapshot_id: null)
+instance = IbmCloudPower::SnapshotCreateResponse.new(
+  snapshot_id: null
+)
 ```
 
-

data/docs/SnapshotRestore.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**force** | **Boolean** | By default the VM must be shutoff during a snapshot restore, force set to true will relax the VM shutoff pre-condition. | [optional] [default to false]
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **force** | **Boolean** | By default the VM must be shutoff during a snapshot restore, force set to true will relax the VM shutoff pre-condition. | [optional][default to false] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::SnapshotRestore.new(force: null)
+instance = IbmCloudPower::SnapshotRestore.new(
+  force: null
+)
 ```
 
-

data/docs/SnapshotUpdate.md

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

data/docs/Snapshots.md

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

data/docs/SoftwareLicenses.md

@@ -2,24 +2,25 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**ibmi_css** | **Boolean** | IBMi Cloud Storage Solution | [optional] [default to false]
-**ibmi_pha** | **Boolean** | IBMi Power High Availability | [optional] [default to false]
-**ibmi_rds** | **Boolean** | IBMi Rational Dev Studio | [optional] [default to false]
-**ibmi_rds_users** | **Integer** | IBMi Rational Dev Studio Number of User Licenses | [optional] 
-**ibmi_dbq** | **Boolean** | IBMi Cloud Storage Solution | [optional] [default to false]
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ibmi_css** | **Boolean** | IBMi Cloud Storage Solution | [optional][default to false] |
+| **ibmi_pha** | **Boolean** | IBMi Power High Availability | [optional][default to false] |
+| **ibmi_rds** | **Boolean** | IBMi Rational Dev Studio | [optional][default to false] |
+| **ibmi_rds_users** | **Integer** | IBMi Rational Dev Studio Number of User Licenses | [optional] |
+| **ibmi_dbq** | **Boolean** | IBMi Cloud Storage Solution | [optional][default to false] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::SoftwareLicenses.new(ibmi_css: null,
-                                 ibmi_pha: null,
-                                 ibmi_rds: null,
-                                 ibmi_rds_users: null,
-                                 ibmi_dbq: null)
+instance = IbmCloudPower::SoftwareLicenses.new(
+  ibmi_css: null,
+  ibmi_pha: null,
+  ibmi_rds: null,
+  ibmi_rds_users: null,
+  ibmi_dbq: null
+)
 ```
 
-

data/docs/Status.md

@@ -0,0 +1,22 @@
+# IbmCloudPower::Status
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | message detailing current state | [optional] |
+| **progress** | **String** | progress of a job |  |
+| **state** | **String** | state of a job |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::Status.new(
+  message: null,
+  progress: null,
+  state: null
+)
+```
+

data/docs/StockImage.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**storage_type** | **String** | Storage type for a stock image | [optional] 
-**storage_pool** | **String** | Storage pool for a stock image | [optional] 
-**id** | **String** | Image ID | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storage_type** | **String** | Storage type for a stock image | [optional] |
+| **storage_pool** | **String** | Storage pool for a stock image | [optional] |
+| **id** | **String** | Image ID | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::StockImage.new(storage_type: null,
-                                 storage_pool: null,
-                                 id: null)
+instance = IbmCloudPower::StockImage.new(
+  storage_type: null,
+  storage_pool: null,
+  id: null
+)
 ```
 
-

data/docs/StorageAffinity.md

@@ -0,0 +1,26 @@
+# IbmCloudPower::StorageAffinity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **affinity_pvm_instance** | **String** | PVM Instance (ID or Name) to base storage affinity policy against; required if requesting storage affinity and affinityVolume is not provided | [optional] |
+| **affinity_policy** | **String** | Affinity policy for storage pool selection; ignored if storagePool provided; for policy 'affinity' requires one of affinityPVMInstance or affinityVolume to be specified; for policy 'anti-affinity' requires one of antiAffinityPVMInstances or antiAffinityVolumes to be specified | [optional] |
+| **affinity_volume** | **String** | Volume (ID or Name) to base storage affinity policy against; required if requesting storage affinity and AffinityPVMInstance is not provided | [optional] |
+| **anti_affinity_pvm_instances** | **Array<String>** | List of pvmInstances to base storage anti-affinity policy against; required if requesting storage anti-affinity and AntiAffinityVolumes is not provided | [optional] |
+| **anti_affinity_volumes** | **Array<String>** | List of volumes to base storage anti-affinity policy against; required if requesting storage anti-affinity and AntiAffinityPVMInstances is not provided | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::StorageAffinity.new(
+  affinity_pvm_instance: null,
+  affinity_policy: null,
+  affinity_volume: null,
+  anti_affinity_pvm_instances: null,
+  anti_affinity_volumes: null
+)
+```
+

data/docs/StoragePoolCapacity.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pool_name** | **String** | Pool name | [optional] 
-**storage_type** | **String** | Storage type of the storage pool | [optional] 
-**max_allocation_size** | **Integer** | Maximum allocation storage size (GB) | 
-**total_capacity** | **Integer** | Total pool capacity (GB) | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pool_name** | **String** | Pool name | [optional] |
+| **storage_type** | **String** | Storage type of the storage pool | [optional] |
+| **max_allocation_size** | **Integer** | Maximum size (GB) that can be currently requested to allocate storage for a given storage type and pool at the time of creation |  |
+| **total_capacity** | **Integer** | Total pool capacity (GB) | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::StoragePoolCapacity.new(pool_name: null,
-                                 storage_type: null,
-                                 max_allocation_size: null,
-                                 total_capacity: null)
+instance = IbmCloudPower::StoragePoolCapacity.new(
+  pool_name: null,
+  storage_type: null,
+  max_allocation_size: null,
+  total_capacity: null
+)
 ```
 
-

data/docs/StoragePoolsCapacity.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**maximum_storage_allocation** | [**MaximumStorageAllocation**](MaximumStorageAllocation.md) |  | [optional] 
-**storage_pools_capacity** | [**Array<StoragePoolCapacity>**](StoragePoolCapacity.md) |  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **maximum_storage_allocation** | [**MaximumStorageAllocation**](MaximumStorageAllocation.md) |  | [optional] |
+| **storage_pools_capacity** | [**Array<StoragePoolCapacity>**](StoragePoolCapacity.md) |  | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::StoragePoolsCapacity.new(maximum_storage_allocation: null,
-                                 storage_pools_capacity: null)
+instance = IbmCloudPower::StoragePoolsCapacity.new(
+  maximum_storage_allocation: null,
+  storage_pools_capacity: null
+)
 ```
 
-