ibm_cloud_power 2.1.1 → 3.1.0

data/docs/RoutesApi.md

@@ -0,0 +1,383 @@
+# IbmCloudPower::RoutesApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v1_routes_delete**](RoutesApi.md#v1_routes_delete) | **DELETE** /v1/routes/{route_id} | Delete a route |
+| [**v1_routes_get**](RoutesApi.md#v1_routes_get) | **GET** /v1/routes/{route_id} | Get a route's information |
+| [**v1_routes_getall**](RoutesApi.md#v1_routes_getall) | **GET** /v1/routes | Get all routes in the workspace |
+| [**v1_routes_post**](RoutesApi.md#v1_routes_post) | **POST** /v1/routes | Perform a route creation |
+| [**v1_routes_put**](RoutesApi.md#v1_routes_put) | **PUT** /v1/routes/{route_id} | Update a route's information |
+| [**v1_routes_report_get**](RoutesApi.md#v1_routes_report_get) | **GET** /v1/routes/report | Get the route report for a workspace |
+
+
+## v1_routes_delete
+
+> Object v1_routes_delete(route_id)
+
+Delete a route
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::RoutesApi.new
+route_id = 'route_id_example' # String | Route ID
+
+begin
+  # Delete a route
+  result = api_instance.v1_routes_delete(route_id)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling RoutesApi->v1_routes_delete: #{e}"
+end
+```
+
+#### Using the v1_routes_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> v1_routes_delete_with_http_info(route_id)
+
+```ruby
+begin
+  # Delete a route
+  data, status_code, headers = api_instance.v1_routes_delete_with_http_info(route_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling RoutesApi->v1_routes_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **route_id** | **String** | Route ID |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_routes_get
+
+> <Route> v1_routes_get(route_id)
+
+Get a route's information
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::RoutesApi.new
+route_id = 'route_id_example' # String | Route ID
+
+begin
+  # Get a route's information
+  result = api_instance.v1_routes_get(route_id)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling RoutesApi->v1_routes_get: #{e}"
+end
+```
+
+#### Using the v1_routes_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Route>, Integer, Hash)> v1_routes_get_with_http_info(route_id)
+
+```ruby
+begin
+  # Get a route's information
+  data, status_code, headers = api_instance.v1_routes_get_with_http_info(route_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Route>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling RoutesApi->v1_routes_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **route_id** | **String** | Route ID |  |
+
+### Return type
+
+[**Route**](Route.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_routes_getall
+
+> <Routes> v1_routes_getall
+
+Get all routes in the workspace
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::RoutesApi.new
+
+begin
+  # Get all routes in the workspace
+  result = api_instance.v1_routes_getall
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling RoutesApi->v1_routes_getall: #{e}"
+end
+```
+
+#### Using the v1_routes_getall_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Routes>, Integer, Hash)> v1_routes_getall_with_http_info
+
+```ruby
+begin
+  # Get all routes in the workspace
+  data, status_code, headers = api_instance.v1_routes_getall_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Routes>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling RoutesApi->v1_routes_getall_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Routes**](Routes.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_routes_post
+
+> <Route> v1_routes_post(opts)
+
+Perform a route creation
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::RoutesApi.new
+opts = {
+  body: IbmCloudPower::RouteCreate.new({destination: 'destination_example', name: 'name_example', next_hop: 'next_hop_example'}) # RouteCreate | Create a route based on the inputs
+}
+
+begin
+  # Perform a route creation
+  result = api_instance.v1_routes_post(opts)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling RoutesApi->v1_routes_post: #{e}"
+end
+```
+
+#### Using the v1_routes_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Route>, Integer, Hash)> v1_routes_post_with_http_info(opts)
+
+```ruby
+begin
+  # Perform a route creation
+  data, status_code, headers = api_instance.v1_routes_post_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Route>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling RoutesApi->v1_routes_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | [**RouteCreate**](RouteCreate.md) | Create a route based on the inputs | [optional] |
+
+### Return type
+
+[**Route**](Route.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## v1_routes_put
+
+> <Route> v1_routes_put(route_id, body)
+
+Update a route's information
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::RoutesApi.new
+route_id = 'route_id_example' # String | Route ID
+body = IbmCloudPower::RouteUpdate.new # RouteUpdate | Parameters for updating a route
+
+begin
+  # Update a route's information
+  result = api_instance.v1_routes_put(route_id, body)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling RoutesApi->v1_routes_put: #{e}"
+end
+```
+
+#### Using the v1_routes_put_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Route>, Integer, Hash)> v1_routes_put_with_http_info(route_id, body)
+
+```ruby
+begin
+  # Update a route's information
+  data, status_code, headers = api_instance.v1_routes_put_with_http_info(route_id, body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Route>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling RoutesApi->v1_routes_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **route_id** | **String** | Route ID |  |
+| **body** | [**RouteUpdate**](RouteUpdate.md) | Parameters for updating a route |  |
+
+### Return type
+
+[**Route**](Route.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## v1_routes_report_get
+
+> <RouteReport> v1_routes_report_get
+
+Get the route report for a workspace
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::RoutesApi.new
+
+begin
+  # Get the route report for a workspace
+  result = api_instance.v1_routes_report_get
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling RoutesApi->v1_routes_report_get: #{e}"
+end
+```
+
+#### Using the v1_routes_report_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RouteReport>, Integer, Hash)> v1_routes_report_get_with_http_info
+
+```ruby
+begin
+  # Get the route report for a workspace
+  data, status_code, headers = api_instance.v1_routes_report_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RouteReport>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling RoutesApi->v1_routes_report_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**RouteReport**](RouteReport.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/SAPCreate.md

@@ -4,21 +4,29 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **allow_remote_restart** | **Boolean** | if set to false, automated remote restart is disabled for the VM | [optional][default to true] |
+| **default_trusted_profile** | [**TrustedProfile**](TrustedProfile.md) | default IAM trusted profile to use for this virtual server instance | [optional] |
+| **deployment_target** | [**DeploymentTarget**](DeploymentTarget.md) | The deployment of a dedicated host | [optional] |
 | **deployment_type** | **String** | Custom SAP Deployment Type Information (For Internal Use Only) | [optional] |
 | **image_id** | **String** | Image ID of the sap image to use for the server |  |
 | **instances** | [**PVMInstanceMultiCreate**](PVMInstanceMultiCreate.md) |  | [optional] |
+| **metadata_service** | [**MetadataService**](MetadataService.md) | The metadata service configuration | [optional] |
 | **name** | **String** | Name of the sap pvm-instance |  |
 | **networks** | [**Array<PVMInstanceAddNetwork>**](PVMInstanceAddNetwork.md) | The pvm instance networks information |  |
 | **pin_policy** | [**PinPolicy**](PinPolicy.md) |  | [optional] |
 | **placement_group** | **String** | The placement group for the server | [optional] |
+| **preferred_processor_compatibility_mode** | **String** | Preferred processor compatibility mode | [optional] |
 | **profile_id** | **String** | SAP Profile ID for the amount of cores and memory |  |
 | **ssh_key_name** | **String** | The name of the SSH Key to provide to the server for authenticating | [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 storageAffinity is provided; 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] |
-| **sys_type** | **String** | System type used to host the instance. Only e880, e980, e1080 are supported | [optional] |
-| **user_data** | **String** | Cloud init user defined data | [optional] |
+| **storage_affinity** | [**StorageAffinity**](StorageAffinity.md) | The storage affinity data; ignored if storagePool is provided; Only valid when you deploy one of the IBM supplied stock images. Storage pool for a custom image (an imported image or an image that is created from a PVMInstance capture) defaults to the storage pool the image was created in | [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 pool for a custom image (an imported image or an image that is created from a PVMInstance capture) defaults to the storage pool the image was created in | [optional] |
+| **storage_pool_affinity** | **Boolean** | Indicates if all volumes attached to the server must reside in the same storage pool; Defaults to true when initially deploying a PVMInstance | [optional][default to true] |
+| **storage_type** | **String** | Storage type for server deployment; if storageType is not provided the storage type will default to 'tier3'. | [optional] |
+| **sys_type** | **String** | System type used to host the instance. Only e980, s1022, e1050, e1080, s1122, e1150, and e1180 are supported | [optional] |
+| **user_data** | **String** | Cloud init user defined data; For FLS, only cloud-config user-data is supported and data must not be compressed or exceed 63K | [optional] |
+| **user_tags** | **Array<String>** | List of user tags | [optional] |
 | **volume_ids** | **Array<String>** | List of Volume IDs to attach to the pvm-instance on creation | [optional] |
+| **vpmem_volumes** | [**Array<VPMemVolumeCreate>**](VPMemVolumeCreate.md) | The vPMEM volumes information. Only one volume is supported at this time. | [optional] |
 
 ## Example
 
@@ -26,21 +34,29 @@
 require 'ibm_cloud_power'
 
 instance = IbmCloudPower::SAPCreate.new(
+  allow_remote_restart: null,
+  default_trusted_profile: null,
+  deployment_target: null,
   deployment_type: null,
   image_id: null,
   instances: null,
+  metadata_service: null,
   name: null,
   networks: null,
   pin_policy: null,
   placement_group: null,
+  preferred_processor_compatibility_mode: null,
   profile_id: null,
   ssh_key_name: null,
   storage_affinity: null,
   storage_pool: null,
+  storage_pool_affinity: null,
   storage_type: null,
   sys_type: null,
   user_data: null,
-  volume_ids: null
+  user_tags: null,
+  volume_ids: null,
+  vpmem_volumes: null
 )
 ```
 

data/docs/SAPProfile.md

@@ -4,11 +4,20 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **asaps** | **Integer** | Accelerated SAP Application Performance Standard | [optional] |
 | **certified** | **Boolean** | Has certification been performed on profile |  |
 | **cores** | **Integer** | Amount of cores |  |
-| **memory** | **Integer** | Amount of memory (in GB) |  |
+| **default_system** | **String** | System to use if not provided | [optional] |
+| **deprecated** | **Boolean** | Profile is deprecated | [optional] |
+| **full_system_profile** | **Boolean** | Requires full system for deployment | [optional] |
+| **memory** | **Integer** | Amount of memory (in GiB) |  |
 | **profile_id** | **String** | SAP Profile ID |  |
+| **saps** | **Integer** | SAP Application Performance Standard | [optional] |
+| **smt_mode** | **Integer** | Required smt mode for that profile | [optional] |
+| **supported_systems** | **Array<String>** | List of supported systems | [optional] |
 | **type** | **String** | Type of profile | [default to 'balanced'] |
+| **vpmem_volume** | [**SAPProfileVpmemVolume**](SAPProfileVpmemVolume.md) |  | [optional] |
+| **workload_types** | **Array<String>** | List of supported workload types | [optional] |
 
 ## Example
 
@@ -16,11 +25,20 @@
 require 'ibm_cloud_power'
 
 instance = IbmCloudPower::SAPProfile.new(
+  asaps: null,
   certified: null,
   cores: null,
+  default_system: null,
+  deprecated: null,
+  full_system_profile: null,
   memory: null,
   profile_id: null,
-  type: null
+  saps: null,
+  smt_mode: null,
+  supported_systems: null,
+  type: null,
+  vpmem_volume: null,
+  workload_types: null
 )
 ```
 

data/docs/SAPProfileVpmemVolume.md

@@ -0,0 +1,20 @@
+# IbmCloudPower::SAPProfileVpmemVolume
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **max_percent** | **Integer** | Maximum percent of memory to be assigned for carved out vPMEM volume | [optional] |
+| **min_percent** | **Integer** | Minimum percent of memory to be assigned for carved out vPMEM volume | [optional] |
+
+## Example
+
+```ruby
+require 'ibm_cloud_power'
+
+instance = IbmCloudPower::SAPProfileVpmemVolume.new(
+  max_percent: null,
+  min_percent: null
+)
+```
+

data/docs/SPPPlacementGroup.md

@@ -4,10 +4,12 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **crn** | **String** | The CRN for this resource | [optional] |
 | **id** | **String** | The id of the Shared Processor Pool Placement Group |  |
 | **member_shared_processor_pools** | **Array<String>** | The list of Shared Processor Pool names that are a member of the Shared Processor Pool Placement Group | [optional] |
 | **name** | **String** | The name of the Shared Processor Pool Placement Group |  |
 | **policy** | **String** | The Shared Processor Pool Placement Group policy |  |
+| **user_tags** | **Array<String>** | List of user tags | [optional] |
 
 ## Example
 
@@ -15,10 +17,12 @@
 require 'ibm_cloud_power'
 
 instance = IbmCloudPower::SPPPlacementGroup.new(
+  crn: null,
   id: null,
   member_shared_processor_pools: null,
   name: null,
-  policy: null
+  policy: null,
+  user_tags: null
 )
 ```
 

data/docs/SPPPlacementGroupCreate.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | The name of the Shared Processor Pool Placement Group; minimum of 2 characters, maximum of 12, the only special character allowed is the underscore '_'. |  |
 | **policy** | **String** | The placement group policy |  |
+| **user_tags** | **Array<String>** | List of user tags | [optional] |
 
 ## Example
 
@@ -14,7 +15,8 @@ require 'ibm_cloud_power'
 
 instance = IbmCloudPower::SPPPlacementGroupCreate.new(
   name: null,
-  policy: null
+  policy: null,
+  user_tags: null
 )
 ```