ibm_cloud_power 1.0.1

data/docs/PVMInstance.md

@@ -0,0 +1,77 @@
+# IbmCloudPower::PVMInstance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pvm_instance_id** | **String** | PCloud PVM Instance ID | 
+**server_name** | **String** | Name of the server | 
+**image_id** | **String** | The ImageID used by the server | 
+**processors** | **Float** | Number of processors allocated | 
+**minproc** | **Float** | Minimum number of processors that can be allocated (for resize) | [optional] 
+**maxproc** | **Float** | Maximum number of processors that can be allocated (for resize) | [optional] 
+**proc_type** | **String** | Processor type (dedicated, shared, capped) | [default to 'dedicated']
+**memory** | **Float** | Amount of memory allocated (in GB) | 
+**minmem** | **Float** | Minimum amount of memory that can be allocated (in GB, for resize) | [optional] 
+**maxmem** | **Float** | Maximum amount of memory that can be allocated (in GB, for resize) | [optional] 
+**disk_size** | **Float** | Size of allocated disk (in GB) | 
+**network_i_ds** | **Array<String>** | (deprecated - replaced by networks) List of Network IDs | 
+**volume_i_ds** | **Array<String>** | List of volume IDs | 
+**addresses** | [**Array<PVMInstanceNetwork>**](PVMInstanceNetwork.md) | (deprecated - replaced by networks) The list of addresses and their network information | [optional] 
+**networks** | [**Array<PVMInstanceNetwork>**](PVMInstanceNetwork.md) | The pvm instance networks information | [optional] 
+**status** | **String** | The status of the instance | 
+**progress** | **Float** | The progress of an operation | [optional] 
+**fault** | [**PVMInstanceFault**](PVMInstanceFault.md) |  | [optional] 
+**creation_date** | **DateTime** | Date/Time of PVM creation | [optional] 
+**updated_date** | **DateTime** | Date/Time of PVM last update | [optional] 
+**sys_type** | **String** | System type used to host the instance | [optional] 
+**health** | [**PVMInstanceHealth**](PVMInstanceHealth.md) |  | [optional] 
+**migratable** | **Boolean** | whether the instance can be migrated | [optional] [default to true]
+**storage_type** | **String** | Storage type where server is deployed | 
+**software_licenses** | [**SoftwareLicenses**](SoftwareLicenses.md) |  | [optional] 
+**srcs** | **Array<Array<SRC>>** | The pvm instance SRC lists | [optional] 
+**pin_policy** | **String** | VM pinning policy to use [none, soft, hard] | [optional] 
+**os_type** | **String** | Type of the OS [aix, ibmi, redhat, sles] | 
+**operating_system** | **String** | OS system information (usually version and build) | [optional] 
+**sap_profile** | [**SAPProfileReference**](SAPProfileReference.md) |  | [optional] 
+**virtual_cores** | [**VirtualCores**](VirtualCores.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudPower'
+
+instance = IbmCloudPower::PVMInstance.new(pvm_instance_id: null,
+                                 server_name: null,
+                                 image_id: null,
+                                 processors: null,
+                                 minproc: null,
+                                 maxproc: null,
+                                 proc_type: null,
+                                 memory: null,
+                                 minmem: null,
+                                 maxmem: null,
+                                 disk_size: null,
+                                 network_i_ds: null,
+                                 volume_i_ds: null,
+                                 addresses: null,
+                                 networks: null,
+                                 status: null,
+                                 progress: null,
+                                 fault: null,
+                                 creation_date: null,
+                                 updated_date: null,
+                                 sys_type: null,
+                                 health: null,
+                                 migratable: null,
+                                 storage_type: null,
+                                 software_licenses: null,
+                                 srcs: null,
+                                 pin_policy: null,
+                                 os_type: null,
+                                 operating_system: null,
+                                 sap_profile: null,
+                                 virtual_cores: null)
+```
+
+

data/docs/PVMInstanceAction.md

@@ -0,0 +1,17 @@
+# IbmCloudPower::PVMInstanceAction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action** | **String** | Name of the action to take; can be start, stop, hard-reboot, soft-reboot, immediate-shutdown, reset-state | 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudPower'
+
+instance = IbmCloudPower::PVMInstanceAction.new(action: null)
+```
+
+

data/docs/PVMInstanceAddNetwork.md

@@ -0,0 +1,19 @@
+# IbmCloudPower::PVMInstanceAddNetwork
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**network_id** | **String** | ID of the network | 
+**ip_address** | **String** | The requested ip address of this network interface | [optional] 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudPower'
+
+instance = IbmCloudPower::PVMInstanceAddNetwork.new(network_id: null,
+                                 ip_address: null)
+```
+
+

data/docs/PVMInstanceCapture.md

@@ -0,0 +1,29 @@
+# IbmCloudPower::PVMInstanceCapture
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**capture_name** | **String** | Name of the deployable image created for the captured PVMInstance | 
+**capture_volume_i_ds** | **Array<String>** | List of Data volume IDs to include in the captured PVMInstance | [optional] 
+**capture_destination** | **String** | Destination for the deployable image | [default to 'cloud-storage']
+**cloud_storage_image_path** | **String** | Cloud Storage Image Path (bucket-name [/folder/../..]) | [optional] 
+**cloud_storage_region** | **String** | Cloud Storage Region | [optional] 
+**cloud_storage_access_key** | **String** | Cloud Storage Access key | [optional] 
+**cloud_storage_secret_key** | **String** | Cloud Storage Secret key | [optional] 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudPower'
+
+instance = IbmCloudPower::PVMInstanceCapture.new(capture_name: null,
+                                 capture_volume_i_ds: null,
+                                 capture_destination: null,
+                                 cloud_storage_image_path: null,
+                                 cloud_storage_region: null,
+                                 cloud_storage_access_key: null,
+                                 cloud_storage_secret_key: null)
+```
+
+

data/docs/PVMInstanceClone.md

@@ -0,0 +1,31 @@
+# IbmCloudPower::PVMInstanceClone
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the server to create | 
+**processors** | **Float** | Number of processors allocated | [optional] 
+**proc_type** | **String** | Processor type (dedicated, shared, capped) | [optional] [default to 'dedicated']
+**memory** | **Float** | Amount of memory allocated (in GB) | [optional] 
+**networks** | [**Array<PVMInstanceAddNetwork>**](PVMInstanceAddNetwork.md) | The pvm instance networks information | 
+**volume_i_ds** | **Array<String>** | List of volume IDs | [optional] 
+**key_pair_name** | **String** | The name of the SSH key pair provided to the server for authenticating users (looked up in the tenant's list of keys) | [optional] 
+**software_licenses** | [**SoftwareLicenses**](SoftwareLicenses.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudPower'
+
+instance = IbmCloudPower::PVMInstanceClone.new(name: null,
+                                 processors: null,
+                                 proc_type: null,
+                                 memory: null,
+                                 networks: null,
+                                 volume_i_ds: null,
+                                 key_pair_name: null,
+                                 software_licenses: null)
+```
+
+

data/docs/PVMInstanceConsole.md

@@ -0,0 +1,17 @@
+# IbmCloudPower::PVMInstanceConsole
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**console_url** | **String** | The URL to the noVNC console for the PVM instance | 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudPower'
+
+instance = IbmCloudPower::PVMInstanceConsole.new(console_url: null)
+```
+
+

data/docs/PVMInstanceCreate.md

@@ -0,0 +1,53 @@
+# IbmCloudPower::PVMInstanceCreate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**server_name** | **String** | Name of the server to create | 
+**replicants** | **Float** | Number of duplicate instances to create in this request | [optional] 
+**replicant_naming_scheme** | **String** | How to name the created vms | [optional] [default to 'suffix']
+**replicant_affinity_policy** | **String** | Affinity policy for replicants being created; affinity for the same host, anti-affinity for different hosts, none for no preference | [optional] [default to 'none']
+**image_id** | **String** | Image ID of the image to use for the server | 
+**processors** | **Float** | Number of processors allocated | 
+**proc_type** | **String** | Processor type (dedicated, shared, capped) | [default to 'dedicated']
+**memory** | **Float** | Amount of memory allocated (in GB) | 
+**network_i_ds** | **Array<String>** | (deprecated - replaced by networks) List of Network IDs | [optional] 
+**networks** | [**Array<PVMInstanceAddNetwork>**](PVMInstanceAddNetwork.md) | The pvm instance networks information | [optional] 
+**volume_i_ds** | **Array<String>** | List of volume IDs | [optional] 
+**key_pair_name** | **String** | The name of the SSH key pair provided to the server for authenticating users (looked up in the tenant's list of keys) | [optional] 
+**sys_type** | **String** | System type used to host the instance | [optional] 
+**migratable** | **Boolean** | Indicates if the server is allowed to migrate between hosts | [optional] [default to true]
+**user_data** | **String** | Cloud init user defined data | [optional] 
+**storage_type** | **String** | Storage type for server deployment | [optional] 
+**software_licenses** | [**SoftwareLicenses**](SoftwareLicenses.md) |  | [optional] 
+**pin_policy** | [**PinPolicy**](PinPolicy.md) |  | [optional] 
+**virtual_cores** | [**VirtualCores**](VirtualCores.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudPower'
+
+instance = IbmCloudPower::PVMInstanceCreate.new(server_name: null,
+                                 replicants: null,
+                                 replicant_naming_scheme: null,
+                                 replicant_affinity_policy: null,
+                                 image_id: null,
+                                 processors: null,
+                                 proc_type: null,
+                                 memory: null,
+                                 network_i_ds: null,
+                                 networks: null,
+                                 volume_i_ds: null,
+                                 key_pair_name: null,
+                                 sys_type: null,
+                                 migratable: null,
+                                 user_data: null,
+                                 storage_type: null,
+                                 software_licenses: null,
+                                 pin_policy: null,
+                                 virtual_cores: null)
+```
+
+

data/docs/PVMInstanceFault.md

@@ -0,0 +1,23 @@
+# IbmCloudPower::PVMInstanceFault
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **Float** | The fault status of the server, if any | [optional] 
+**details** | **String** | The fault details of the server, if any | [optional] 
+**message** | **String** | The fault message of the server, if any | [optional] 
+**created** | **DateTime** | The date and time the fault occurred | [optional] 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudPower'
+
+instance = IbmCloudPower::PVMInstanceFault.new(code: null,
+                                 details: null,
+                                 message: null,
+                                 created: null)
+```
+
+

data/docs/PVMInstanceHealth.md

@@ -0,0 +1,21 @@
+# IbmCloudPower::PVMInstanceHealth
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | The PVM's health status value | [optional] 
+**last_update** | **String** | Date/Time of PVM last health status change | [optional] 
+**reason** | **String** | The health status reason, if any | [optional] 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudPower'
+
+instance = IbmCloudPower::PVMInstanceHealth.new(status: null,
+                                 last_update: null,
+                                 reason: null)
+```
+
+

data/docs/PVMInstanceMultiCreate.md

@@ -0,0 +1,21 @@
+# IbmCloudPower::PVMInstanceMultiCreate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** | Number of pvm-instances to create | [optional] 
+**affinity_policy** | **String** | Affinity policy for pvm-instances being created; affinity for the same host, anti-affinity for different hosts, none for no preference | [optional] [default to 'none']
+**numerical** | **String** | Where to place the numerical number of the multi-created instance | [optional] [default to 'suffix']
+
+## Code Sample
+
+```ruby
+require 'IbmCloudPower'
+
+instance = IbmCloudPower::PVMInstanceMultiCreate.new(count: null,
+                                 affinity_policy: null,
+                                 numerical: null)
+```
+
+

data/docs/PVMInstanceNetwork.md

@@ -0,0 +1,33 @@
+# IbmCloudPower::PVMInstanceNetwork
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**version** | **Float** | The version of the information provided | [optional] 
+**network_id** | **String** | ID of the network | [optional] 
+**network_name** | **String** | The name of the network the address is on | [optional] 
+**mac_address** | **String** | The mac address of the network interface | [optional] 
+**type** | **String** | The address type (fixed or dynamic) | [optional] 
+**ip** | **String** | (deprecated - replaced by ipAddress) | [optional] 
+**ip_address** | **String** | The ip address of this network interface | [optional] 
+**external_ip** | **String** | The external ip address (for pub-vlan networks) | [optional] 
+**href** | **String** | Link to PVM Instance Network | [optional] 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudPower'
+
+instance = IbmCloudPower::PVMInstanceNetwork.new(version: null,
+                                 network_id: null,
+                                 network_name: null,
+                                 mac_address: null,
+                                 type: null,
+                                 ip: null,
+                                 ip_address: null,
+                                 external_ip: null,
+                                 href: null)
+```
+
+

data/docs/PVMInstanceNetworks.md

@@ -0,0 +1,17 @@
+# IbmCloudPower::PVMInstanceNetworks
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**networks** | [**Array<PVMInstanceNetwork>**](PVMInstanceNetwork.md) | PVM Instance Networks | 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudPower'
+
+instance = IbmCloudPower::PVMInstanceNetworks.new(networks: null)
+```
+
+

data/docs/PVMInstanceOperation.md

@@ -0,0 +1,19 @@
+# IbmCloudPower::PVMInstanceOperation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**operation_type** | **String** | Name of the operation to execute; can be job or boot | 
+**operation** | [**Operations**](Operations.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudPower'
+
+instance = IbmCloudPower::PVMInstanceOperation.new(operation_type: null,
+                                 operation: null)
+```
+
+

data/docs/PVMInstanceReference.md

@@ -0,0 +1,71 @@
+# IbmCloudPower::PVMInstanceReference
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pvm_instance_id** | **String** | PCloud PVM Instance ID | 
+**server_name** | **String** | Name of the server | 
+**image_id** | **String** | The ImageID used by the server | 
+**processors** | **Float** | Number of processors allocated | 
+**minproc** | **Float** | Minimum number of processors that can be allocated (for resize) | [optional] 
+**maxproc** | **Float** | Maximum number of processors that can be allocated (for resize) | [optional] 
+**proc_type** | **String** | Processor type (dedicated, shared, capped) | [default to 'dedicated']
+**memory** | **Float** | Amount of memory allocated (in GB) | 
+**minmem** | **Float** | Minimum amount of memory that can be allocated (in GB, for resize) | [optional] 
+**maxmem** | **Float** | Maximum amount of memory that can be allocated (in GB, for resize) | [optional] 
+**disk_size** | **Float** | Size of allocated disk (in GB) | 
+**addresses** | [**Array<PVMInstanceNetwork>**](PVMInstanceNetwork.md) | (deprecated - replaced by networks) The list of addresses and their network information | [optional] 
+**networks** | [**Array<PVMInstanceNetwork>**](PVMInstanceNetwork.md) | The list of addresses and their network information | [optional] 
+**status** | **String** | The status of the instance | 
+**progress** | **Float** | The progress of an operation | [optional] 
+**fault** | [**PVMInstanceFault**](PVMInstanceFault.md) |  | [optional] 
+**creation_date** | **DateTime** | Date/Time of PVM creation | [optional] 
+**updated_date** | **DateTime** | Date/Time of PVM last update | [optional] 
+**sys_type** | **String** | System type used to host the instance | [optional] 
+**health** | [**PVMInstanceHealth**](PVMInstanceHealth.md) |  | [optional] 
+**href** | **String** | Link to Cloud Instance resource | 
+**software_licenses** | [**SoftwareLicenses**](SoftwareLicenses.md) |  | [optional] 
+**srcs** | **Array<Array<SRC>>** | The pvm instance SRC lists | [optional] 
+**pin_policy** | **String** | VM pinning policy to use [none, soft, hard] | [optional] 
+**os_type** | **String** | Type of the OS [aix, ibmi, redhat, sles] | 
+**operating_system** | **String** | OS system information (usually version and build) | [optional] 
+**sap_profile** | [**SAPProfileReference**](SAPProfileReference.md) |  | [optional] 
+**virtual_cores** | [**VirtualCores**](VirtualCores.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'IbmCloudPower'
+
+instance = IbmCloudPower::PVMInstanceReference.new(pvm_instance_id: null,
+                                 server_name: null,
+                                 image_id: null,
+                                 processors: null,
+                                 minproc: null,
+                                 maxproc: null,
+                                 proc_type: null,
+                                 memory: null,
+                                 minmem: null,
+                                 maxmem: null,
+                                 disk_size: null,
+                                 addresses: null,
+                                 networks: null,
+                                 status: null,
+                                 progress: null,
+                                 fault: null,
+                                 creation_date: null,
+                                 updated_date: null,
+                                 sys_type: null,
+                                 health: null,
+                                 href: null,
+                                 software_licenses: null,
+                                 srcs: null,
+                                 pin_policy: null,
+                                 os_type: null,
+                                 operating_system: null,
+                                 sap_profile: null,
+                                 virtual_cores: null)
+```
+
+