ibm_cloud_power 1.1.1 → 2.0.0

data/docs/ImageReference.md

@@ -2,34 +2,35 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**image_id** | **String** | Image ID | 
-**name** | **String** | Image Name | 
-**state** | **String** | Image State | 
-**description** | **String** | Description | 
-**storage_type** | **String** | Storage type for image | 
-**storage_pool** | **String** | Storage pool where the image is located | 
-**creation_date** | **DateTime** | Creation Date | 
-**last_update_date** | **DateTime** | Last Update Date | 
-**specifications** | [**ImageSpecifications**](ImageSpecifications.md) |  | 
-**href** | **String** | Link to Image resource | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **image_id** | **String** | Image ID |  |
+| **name** | **String** | Image Name |  |
+| **state** | **String** | Image State |  |
+| **description** | **String** | Description |  |
+| **storage_type** | **String** | Storage type for image |  |
+| **storage_pool** | **String** | Storage pool where the image is located |  |
+| **creation_date** | **Time** | Creation Date |  |
+| **last_update_date** | **Time** | Last Update Date |  |
+| **specifications** | [**ImageSpecifications**](ImageSpecifications.md) |  |  |
+| **href** | **String** | Link to Image resource |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::ImageReference.new(image_id: null,
-                                 name: null,
-                                 state: null,
-                                 description: null,
-                                 storage_type: null,
-                                 storage_pool: null,
-                                 creation_date: null,
-                                 last_update_date: null,
-                                 specifications: null,
-                                 href: null)
+instance = IbmCloudPower::ImageReference.new(
+  image_id: null,
+  name: null,
+  state: null,
+  description: null,
+  storage_type: null,
+  storage_pool: null,
+  creation_date: null,
+  last_update_date: null,
+  specifications: null,
+  href: null
+)
 ```
 
-

data/docs/ImageSpecifications.md

@@ -2,28 +2,29 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**image_type** | **String** | Image Type | [optional] 
-**container_format** | **String** | Container Format | [optional] 
-**disk_format** | **String** | Disk Format | [optional] 
-**operating_system** | **String** | Operating System | [optional] 
-**hypervisor_type** | **String** | Hypervisor Type | [optional] 
-**architecture** | **String** | Architecture | [optional] 
-**endianness** | **String** | Endianness | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **image_type** | **String** | Image Type | [optional] |
+| **container_format** | **String** | Container Format | [optional] |
+| **disk_format** | **String** | Disk Format | [optional] |
+| **operating_system** | **String** | Operating System | [optional] |
+| **hypervisor_type** | **String** | Hypervisor Type | [optional] |
+| **architecture** | **String** | Architecture | [optional] |
+| **endianness** | **String** | Endianness | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::ImageSpecifications.new(image_type: null,
-                                 container_format: null,
-                                 disk_format: null,
-                                 operating_system: null,
-                                 hypervisor_type: null,
-                                 architecture: null,
-                                 endianness: null)
+instance = IbmCloudPower::ImageSpecifications.new(
+  image_type: null,
+  container_format: null,
+  disk_format: null,
+  operating_system: null,
+  hypervisor_type: null,
+  architecture: null,
+  endianness: null
+)
 ```
 
-

data/docs/ImageVolume.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**volume_id** | **String** | Volume ID | 
-**name** | **String** | Volume Name | 
-**size** | **Float** | Volume Size | 
-**bootable** | **Boolean** | Indicates if the volume is boot capable | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **volume_id** | **String** | Volume ID |  |
+| **name** | **String** | Volume Name |  |
+| **size** | **Float** | Volume Size |  |
+| **bootable** | **Boolean** | Indicates if the volume is boot capable |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::ImageVolume.new(volume_id: null,
-                                 name: null,
-                                 size: null,
-                                 bootable: null)
+instance = IbmCloudPower::ImageVolume.new(
+  volume_id: null,
+  name: null,
+  size: null,
+  bootable: null
+)
 ```
 
-

data/docs/Images.md

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

data/docs/Job.md

@@ -0,0 +1,24 @@
+# IbmCloudPower::Job
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_timestamp** | **Time** | create timestamp for the job | [optional] |
+| **id** | **String** | id of a job |  |
+| **operation** | [**Operation**](Operation.md) |  |  |
+| **status** | [**Status**](Status.md) |  |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::Job.new(
+  create_timestamp: null,
+  id: null,
+  operation: null,
+  status: null
+)
+```
+

data/docs/JobReference.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::JobReference
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **href** | **String** | Link to job resource |  |
+| **id** | **String** | id of a job used to get status of long running operation |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::JobReference.new(
+  href: null,
+  id: null
+)
+```
+

data/docs/Jobs.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::Jobs
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **jobs** | [**Array<Job>**](Job.md) | Jobs |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::Jobs.new(
+  jobs: null
+)
+```
+

data/docs/MaximumStorageAllocation.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**storage_type** | **String** | Storage type | 
-**storage_pool** | **String** | Storage pool | 
-**max_allocation_size** | **Integer** | Maximum allocation storage size (GB) | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **storage_type** | **String** | Storage type |  |
+| **storage_pool** | **String** | Storage pool |  |
+| **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 |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::MaximumStorageAllocation.new(storage_type: null,
-                                 storage_pool: null,
-                                 max_allocation_size: null)
+instance = IbmCloudPower::MaximumStorageAllocation.new(
+  storage_type: null,
+  storage_pool: null,
+  max_allocation_size: null
+)
 ```
 
-

data/docs/MinMaxDefault.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**min** | **Float** | min value | 
-**max** | **Float** | max value | 
-**default** | **Float** | default value | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **min** | **Float** | min value |  |
+| **max** | **Float** | max value |  |
+| **default** | **Float** | default value |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::MinMaxDefault.new(min: null,
-                                 max: null,
-                                 default: null)
+instance = IbmCloudPower::MinMaxDefault.new(
+  min: null,
+  max: null,
+  default: null
+)
 ```
 
-

data/docs/MultiVolumesCreate.md

@@ -2,30 +2,37 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | Base name of the volume(s) | 
-**size** | **Integer** | Volume Size (GB) | 
-**count** | **Integer** | Number of volumes to create | [optional] 
-**shareable** | **Boolean** | Indicates if the volume is shareable between VMs | [optional] 
-**disk_type** | **String** | Type of Disk; required if affinityPolicy is not provided, otherwise ignored | [optional] 
-**affinity_policy** | **String** | Affinity policy for data volume being created; requires affinityPVMInstance or affinityVolume to be specified; | [optional] 
-**affinity_volume** | **String** | Volume (ID or Name) to base volume affinity policy against; required if affinityPolicy is provided and affinityPVMInstance is not provided | [optional] 
-**affinity_pvm_instance** | **String** | PVM Instance (ID or Name)to base volume affinity policy against; required if affinityPolicy is provided and affinityVolume is not provided | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Base name of the volume(s) |  |
+| **size** | **Integer** | Volume Size (GB) |  |
+| **count** | **Integer** | Number of volumes to create | [optional] |
+| **shareable** | **Boolean** | Indicates if the volume is shareable between VMs | [optional] |
+| **disk_type** | **String** | Type of Disk; required if affinityPolicy is not provided, otherwise ignored | [optional] |
+| **volume_pool** | **String** | Volume pool where the volume will be created; if provided then diskType and affinityPolicy values are ignored | [optional] |
+| **affinity_policy** | **String** | Affinity policy for data volume being created; requires affinityPVMInstance or affinityVolume to be specified; | [optional] |
+| **affinity_volume** | **String** | Volume (ID or Name) to base volume affinity policy against; required if affinityPolicy is provided and affinityPVMInstance is not provided | [optional] |
+| **affinity_pvm_instance** | **String** | PVM Instance (ID or Name)to base volume affinity policy against; required if affinityPolicy is provided and affinityVolume 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 storageAntiAffinityPVMInstances is not provided | [optional] |
+| **anti_affinity_pvm_instances** | **Array<String>** | List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and antiAffinityVolumes is not provided | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::MultiVolumesCreate.new(name: null,
-                                 size: null,
-                                 count: null,
-                                 shareable: null,
-                                 disk_type: null,
-                                 affinity_policy: null,
-                                 affinity_volume: null,
-                                 affinity_pvm_instance: null)
+instance = IbmCloudPower::MultiVolumesCreate.new(
+  name: null,
+  size: null,
+  count: null,
+  shareable: null,
+  disk_type: null,
+  volume_pool: null,
+  affinity_policy: null,
+  affinity_volume: null,
+  affinity_pvm_instance: null,
+  anti_affinity_volumes: null,
+  anti_affinity_pvm_instances: null
+)
 ```
 
-

data/docs/Network.md

@@ -2,36 +2,37 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**network_id** | **String** | Unique Network ID | 
-**name** | **String** | Network Name | 
-**type** | **String** | Type of Network {vlan, pub-vlan} | [default to 'vlan']
-**vlan_id** | **Float** | VLAN ID | 
-**cidr** | **String** | Network in CIDR notation (192.168.0.0/24) | 
-**gateway** | **String** | Gateway IP Address | [optional] 
-**dns_servers** | **Array<String>** | DNS Servers | 
-**ip_address_ranges** | [**Array<IPAddressRange>**](IPAddressRange.md) | IP Address Ranges | 
-**ip_address_metrics** | [**NetworkIpAddressMetrics**](NetworkIpAddressMetrics.md) |  | 
-**public_ip_address_ranges** | [**Array<IPAddressRange>**](IPAddressRange.md) | Public IP Address Ranges (for pub-vlan networks) | [optional] 
-**jumbo** | **Boolean** | MTU Jumbo Network enabled | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **network_id** | **String** | Unique Network ID |  |
+| **name** | **String** | Network Name |  |
+| **type** | **String** | Type of Network {vlan, pub-vlan} | [default to 'vlan'] |
+| **vlan_id** | **Float** | VLAN ID |  |
+| **cidr** | **String** | Network in CIDR notation (192.168.0.0/24) |  |
+| **gateway** | **String** | Gateway IP Address | [optional] |
+| **dns_servers** | **Array<String>** | DNS Servers |  |
+| **ip_address_ranges** | [**Array<IPAddressRange>**](IPAddressRange.md) | IP Address Ranges |  |
+| **ip_address_metrics** | [**NetworkIpAddressMetrics**](NetworkIpAddressMetrics.md) |  |  |
+| **public_ip_address_ranges** | [**Array<IPAddressRange>**](IPAddressRange.md) | Public IP Address Ranges (for pub-vlan networks) | [optional] |
+| **jumbo** | **Boolean** | MTU Jumbo Network enabled |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::Network.new(network_id: null,
-                                 name: null,
-                                 type: null,
-                                 vlan_id: null,
-                                 cidr: null,
-                                 gateway: null,
-                                 dns_servers: null,
-                                 ip_address_ranges: null,
-                                 ip_address_metrics: null,
-                                 public_ip_address_ranges: null,
-                                 jumbo: null)
+instance = IbmCloudPower::Network.new(
+  network_id: null,
+  name: null,
+  type: null,
+  vlan_id: null,
+  cidr: null,
+  gateway: null,
+  dns_servers: null,
+  ip_address_ranges: null,
+  ip_address_metrics: null,
+  public_ip_address_ranges: null,
+  jumbo: null
+)
 ```
 
-

data/docs/NetworkCreate.md

@@ -2,28 +2,29 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | Network Name | [optional] 
-**type** | **String** | Type of Network - 'vlan' (private network) 'pub-vlan' (public network) | [default to 'vlan']
-**cidr** | **String** | Network in CIDR notation (192.168.0.0/24) | [optional] 
-**gateway** | **String** | Gateway IP Address | [optional] 
-**dns_servers** | **Array<String>** | DNS Servers | [optional] 
-**ip_address_ranges** | [**Array<IPAddressRange>**](IPAddressRange.md) | IP Address Ranges | [optional] 
-**jumbo** | **Boolean** | Enable MTU Jumbo Network | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Network Name | [optional] |
+| **type** | **String** | Type of Network - 'vlan' (private network) 'pub-vlan' (public network) | [default to 'vlan'] |
+| **cidr** | **String** | Network in CIDR notation (192.168.0.0/24) | [optional] |
+| **gateway** | **String** | Gateway IP Address | [optional] |
+| **dns_servers** | **Array<String>** | DNS Servers | [optional] |
+| **ip_address_ranges** | [**Array<IPAddressRange>**](IPAddressRange.md) | IP Address Ranges | [optional] |
+| **jumbo** | **Boolean** | Enable MTU Jumbo Network | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::NetworkCreate.new(name: null,
-                                 type: null,
-                                 cidr: null,
-                                 gateway: null,
-                                 dns_servers: null,
-                                 ip_address_ranges: null,
-                                 jumbo: null)
+instance = IbmCloudPower::NetworkCreate.new(
+  name: null,
+  type: null,
+  cidr: null,
+  gateway: null,
+  dns_servers: null,
+  ip_address_ranges: null,
+  jumbo: null
+)
 ```
 
-

data/docs/NetworkID.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::NetworkID
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **network_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkID.new(
+  network_id: 7f950c76-8582-11qeb-8dcd-0242ac172
+)
+```
+

data/docs/NetworkIDs.md

@@ -0,0 +1,18 @@
+# IbmCloudPower::NetworkIDs
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **network_ids** | **Array<String>** | an array of network IDs | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::NetworkIDs.new(
+  network_ids: ["7f950c76-8582-11qeb-8dcd-0242ac143","7f950c76-8582-11veb-8dcd-0242ac153","7f950c76-8582-11deb-8dcd-0242ac163"]
+)
+```
+

data/docs/NetworkIpAddressMetrics.md

@@ -2,22 +2,23 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**available** | **Float** | Number of available IP addresses | 
-**used** | **Float** | Number of IP addresses currently in use | 
-**total** | **Float** | Total number of all IP addresses in all ipAddressRanges | 
-**utilization** | **Float** | Utilization of IP addresses in percent form (used / total) [0 - 100] | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **available** | **Float** | Number of available IP addresses |  |
+| **used** | **Float** | Number of IP addresses currently in use |  |
+| **total** | **Float** | Total number of all IP addresses in all ipAddressRanges |  |
+| **utilization** | **Float** | Utilization of IP addresses in percent form (used / total) [0 - 100] |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::NetworkIpAddressMetrics.new(available: null,
-                                 used: null,
-                                 total: null,
-                                 utilization: null)
+instance = IbmCloudPower::NetworkIpAddressMetrics.new(
+  available: null,
+  used: null,
+  total: null,
+  utilization: null
+)
 ```
 
-

data/docs/NetworkPort.md

@@ -2,30 +2,31 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**port_id** | **String** | The unique Port ID | 
-**description** | **String** | The description of the port (not unique or indexable) | 
-**status** | **String** | Te | 
-**mac_address** | **String** | The mac address of the network interface | 
-**ip_address** | **String** | The ip address of this port | 
-**external_ip** | **String** | The external ip address (for pub-vlan networks) | [optional] 
-**pvm_instance** | [**NetworkPortPvmInstance**](NetworkPortPvmInstance.md) |  | [optional] 
-**href** | **String** | Link to port resource | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **port_id** | **String** | The unique Port ID |  |
+| **description** | **String** | The description of the port (not unique or indexable) |  |
+| **status** | **String** | Te |  |
+| **mac_address** | **String** | The mac address of the network interface |  |
+| **ip_address** | **String** | The ip address of this port |  |
+| **external_ip** | **String** | The external ip address (for pub-vlan networks) | [optional] |
+| **pvm_instance** | [**NetworkPortPvmInstance**](NetworkPortPvmInstance.md) |  | [optional] |
+| **href** | **String** | Link to port resource | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::NetworkPort.new(port_id: null,
-                                 description: null,
-                                 status: null,
-                                 mac_address: null,
-                                 ip_address: null,
-                                 external_ip: null,
-                                 pvm_instance: null,
-                                 href: null)
+instance = IbmCloudPower::NetworkPort.new(
+  port_id: null,
+  description: null,
+  status: null,
+  mac_address: null,
+  ip_address: null,
+  external_ip: null,
+  pvm_instance: null,
+  href: null
+)
 ```
 
-

data/docs/NetworkPortCreate.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**description** | **String** | Description of the port (not unique or indexable) | [optional] 
-**ip_address** | **String** | The requested ip address of this port | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | Description of the port (not unique or indexable) | [optional] |
+| **ip_address** | **String** | The requested ip address of this port | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'IbmCloudPower'
+require 'ibm_cloud_power'
 
-instance = IbmCloudPower::NetworkPortCreate.new(description: null,
-                                 ip_address: null)
+instance = IbmCloudPower::NetworkPortCreate.new(
+  description: null,
+  ip_address: null
+)
 ```
 
-