ibm_cloud_power 2.1.0 → 3.0.0

data/docs/NetworksApi.md

@@ -0,0 +1,334 @@
+# IbmCloudPower::NetworksApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v1_networks_network_interfaces_delete**](NetworksApi.md#v1_networks_network_interfaces_delete) | **DELETE** /v1/networks/{network_id}/network-interfaces/{network_interface_id} | Delete a Network Interface |
+| [**v1_networks_network_interfaces_get**](NetworksApi.md#v1_networks_network_interfaces_get) | **GET** /v1/networks/{network_id}/network-interfaces/{network_interface_id} | Get a Network Interface's information |
+| [**v1_networks_network_interfaces_getall**](NetworksApi.md#v1_networks_network_interfaces_getall) | **GET** /v1/networks/{network_id}/network-interfaces | Get all Network Interfaces for this network |
+| [**v1_networks_network_interfaces_post**](NetworksApi.md#v1_networks_network_interfaces_post) | **POST** /v1/networks/{network_id}/network-interfaces | Perform Network Interface addition, deletion, and listing |
+| [**v1_networks_network_interfaces_put**](NetworksApi.md#v1_networks_network_interfaces_put) | **PUT** /v1/networks/{network_id}/network-interfaces/{network_interface_id} | Update a Network Interface's information |
+
+
+## v1_networks_network_interfaces_delete
+
+> Object v1_networks_network_interfaces_delete(network_id, network_interface_id)
+
+Delete a Network Interface
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::NetworksApi.new
+network_id = 'network_id_example' # String | Network ID
+network_interface_id = 'network_interface_id_example' # String | Network Interface ID
+
+begin
+  # Delete a Network Interface
+  result = api_instance.v1_networks_network_interfaces_delete(network_id, network_interface_id)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling NetworksApi->v1_networks_network_interfaces_delete: #{e}"
+end
+```
+
+#### Using the v1_networks_network_interfaces_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> v1_networks_network_interfaces_delete_with_http_info(network_id, network_interface_id)
+
+```ruby
+begin
+  # Delete a Network Interface
+  data, status_code, headers = api_instance.v1_networks_network_interfaces_delete_with_http_info(network_id, network_interface_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling NetworksApi->v1_networks_network_interfaces_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **network_id** | **String** | Network ID |  |
+| **network_interface_id** | **String** | Network Interface ID |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_networks_network_interfaces_get
+
+> <NetworkInterface> v1_networks_network_interfaces_get(network_id, network_interface_id)
+
+Get a Network Interface's information
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::NetworksApi.new
+network_id = 'network_id_example' # String | Network ID
+network_interface_id = 'network_interface_id_example' # String | Network Interface ID
+
+begin
+  # Get a Network Interface's information
+  result = api_instance.v1_networks_network_interfaces_get(network_id, network_interface_id)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling NetworksApi->v1_networks_network_interfaces_get: #{e}"
+end
+```
+
+#### Using the v1_networks_network_interfaces_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<NetworkInterface>, Integer, Hash)> v1_networks_network_interfaces_get_with_http_info(network_id, network_interface_id)
+
+```ruby
+begin
+  # Get a Network Interface's information
+  data, status_code, headers = api_instance.v1_networks_network_interfaces_get_with_http_info(network_id, network_interface_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NetworkInterface>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling NetworksApi->v1_networks_network_interfaces_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **network_id** | **String** | Network ID |  |
+| **network_interface_id** | **String** | Network Interface ID |  |
+
+### Return type
+
+[**NetworkInterface**](NetworkInterface.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_networks_network_interfaces_getall
+
+> <NetworkInterfaces> v1_networks_network_interfaces_getall(network_id)
+
+Get all Network Interfaces for this network
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::NetworksApi.new
+network_id = 'network_id_example' # String | Network ID
+
+begin
+  # Get all Network Interfaces for this network
+  result = api_instance.v1_networks_network_interfaces_getall(network_id)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling NetworksApi->v1_networks_network_interfaces_getall: #{e}"
+end
+```
+
+#### Using the v1_networks_network_interfaces_getall_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<NetworkInterfaces>, Integer, Hash)> v1_networks_network_interfaces_getall_with_http_info(network_id)
+
+```ruby
+begin
+  # Get all Network Interfaces for this network
+  data, status_code, headers = api_instance.v1_networks_network_interfaces_getall_with_http_info(network_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NetworkInterfaces>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling NetworksApi->v1_networks_network_interfaces_getall_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **network_id** | **String** | Network ID |  |
+
+### Return type
+
+[**NetworkInterfaces**](NetworkInterfaces.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_networks_network_interfaces_post
+
+> <NetworkInterface> v1_networks_network_interfaces_post(network_id, opts)
+
+Perform Network Interface addition, deletion, and listing
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::NetworksApi.new
+network_id = 'network_id_example' # String | Network ID
+opts = {
+  body: IbmCloudPower::NetworkInterfaceCreate.new # NetworkInterfaceCreate | Create a Network Interface
+}
+
+begin
+  # Perform Network Interface addition, deletion, and listing
+  result = api_instance.v1_networks_network_interfaces_post(network_id, opts)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling NetworksApi->v1_networks_network_interfaces_post: #{e}"
+end
+```
+
+#### Using the v1_networks_network_interfaces_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<NetworkInterface>, Integer, Hash)> v1_networks_network_interfaces_post_with_http_info(network_id, opts)
+
+```ruby
+begin
+  # Perform Network Interface addition, deletion, and listing
+  data, status_code, headers = api_instance.v1_networks_network_interfaces_post_with_http_info(network_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NetworkInterface>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling NetworksApi->v1_networks_network_interfaces_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **network_id** | **String** | Network ID |  |
+| **body** | [**NetworkInterfaceCreate**](NetworkInterfaceCreate.md) | Create a Network Interface | [optional] |
+
+### Return type
+
+[**NetworkInterface**](NetworkInterface.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## v1_networks_network_interfaces_put
+
+> <NetworkInterface> v1_networks_network_interfaces_put(network_id, network_interface_id, body)
+
+Update a Network Interface's information
+
+### Examples
+
+```ruby
+require 'time'
+require 'ibm_cloud_power'
+
+api_instance = IbmCloudPower::NetworksApi.new
+network_id = 'network_id_example' # String | Network ID
+network_interface_id = 'network_interface_id_example' # String | Network Interface ID
+body = IbmCloudPower::NetworkInterfaceUpdate.new # NetworkInterfaceUpdate | Parameters for updating a Network Interface
+
+begin
+  # Update a Network Interface's information
+  result = api_instance.v1_networks_network_interfaces_put(network_id, network_interface_id, body)
+  p result
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling NetworksApi->v1_networks_network_interfaces_put: #{e}"
+end
+```
+
+#### Using the v1_networks_network_interfaces_put_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<NetworkInterface>, Integer, Hash)> v1_networks_network_interfaces_put_with_http_info(network_id, network_interface_id, body)
+
+```ruby
+begin
+  # Update a Network Interface's information
+  data, status_code, headers = api_instance.v1_networks_network_interfaces_put_with_http_info(network_id, network_interface_id, body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NetworkInterface>
+rescue IbmCloudPower::ApiError => e
+  puts "Error when calling NetworksApi->v1_networks_network_interfaces_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **network_id** | **String** | Network ID |  |
+| **network_interface_id** | **String** | Network Interface ID |  |
+| **body** | [**NetworkInterfaceUpdate**](NetworkInterfaceUpdate.md) | Parameters for updating a Network Interface |  |
+
+### Return type
+
+[**NetworkInterface**](NetworkInterface.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PCloudCloudConnectionsApi.md

@@ -7,8 +7,8 @@ All URIs are relative to *http://localhost*
 | [**pcloud_cloudconnections_delete**](PCloudCloudConnectionsApi.md#pcloud_cloudconnections_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections/{cloud_connection_id} | Delete a Cloud Connection |
 | [**pcloud_cloudconnections_get**](PCloudCloudConnectionsApi.md#pcloud_cloudconnections_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections/{cloud_connection_id} | Get a cloud connection's state/information |
 | [**pcloud_cloudconnections_getall**](PCloudCloudConnectionsApi.md#pcloud_cloudconnections_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections | Get all cloud connections in this cloud instance |
-| [**pcloud_cloudconnections_networks_delete**](PCloudCloudConnectionsApi.md#pcloud_cloudconnections_networks_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections/{cloud_connection_id}/networks/{network_id} | Delete a network from a Cloud Connection |
-| [**pcloud_cloudconnections_networks_put**](PCloudCloudConnectionsApi.md#pcloud_cloudconnections_networks_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections/{cloud_connection_id}/networks/{network_id} | Add a network to the cloud connection |
+| [**pcloud_cloudconnections_networks_delete**](PCloudCloudConnectionsApi.md#pcloud_cloudconnections_networks_delete) | **DELETE** /pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections/{cloud_connection_id}/networks/{network_id} | Detach a network from a Cloud Connection |
+| [**pcloud_cloudconnections_networks_put**](PCloudCloudConnectionsApi.md#pcloud_cloudconnections_networks_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections/{cloud_connection_id}/networks/{network_id} | Attach a network to the cloud connection |
 | [**pcloud_cloudconnections_post**](PCloudCloudConnectionsApi.md#pcloud_cloudconnections_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections | Create a new cloud connection |
 | [**pcloud_cloudconnections_put**](PCloudCloudConnectionsApi.md#pcloud_cloudconnections_put) | **PUT** /pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections/{cloud_connection_id} | Update a Cloud Connection |
 | [**pcloud_cloudconnections_virtualprivateclouds_getall**](PCloudCloudConnectionsApi.md#pcloud_cloudconnections_virtualprivateclouds_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections-virtual-private-clouds | Get all virtual private cloud connections in this cloud instance |
@@ -75,7 +75,7 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: */*
+- **Accept**: application/json
 
 
 ## pcloud_cloudconnections_get
@@ -208,7 +208,7 @@ No authorization required
 
 > Object pcloud_cloudconnections_networks_delete(cloud_instance_id, cloud_connection_id, network_id)
 
-Delete a network from a Cloud Connection
+Detach a network from a Cloud Connection
 
 ### Examples
 
@@ -222,7 +222,7 @@ cloud_connection_id = 'cloud_connection_id_example' # String | Cloud Connection
 network_id = 'network_id_example' # String | Network ID
 
 begin
-  # Delete a network from a Cloud Connection
+  # Detach a network from a Cloud Connection
   result = api_instance.pcloud_cloudconnections_networks_delete(cloud_instance_id, cloud_connection_id, network_id)
   p result
 rescue IbmCloudPower::ApiError => e
@@ -238,7 +238,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Delete a network from a Cloud Connection
+  # Detach a network from a Cloud Connection
   data, status_code, headers = api_instance.pcloud_cloudconnections_networks_delete_with_http_info(cloud_instance_id, cloud_connection_id, network_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -267,14 +267,14 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: */*
+- **Accept**: application/json
 
 
 ## pcloud_cloudconnections_networks_put
 
 > Object pcloud_cloudconnections_networks_put(cloud_instance_id, cloud_connection_id, network_id)
 
-Add a network to the cloud connection
+Attach a network to the cloud connection
 
 ### Examples
 
@@ -288,7 +288,7 @@ cloud_connection_id = 'cloud_connection_id_example' # String | Cloud Connection
 network_id = 'network_id_example' # String | Network ID
 
 begin
-  # Add a network to the cloud connection
+  # Attach a network to the cloud connection
   result = api_instance.pcloud_cloudconnections_networks_put(cloud_instance_id, cloud_connection_id, network_id)
   p result
 rescue IbmCloudPower::ApiError => e
@@ -304,7 +304,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Add a network to the cloud connection
+  # Attach a network to the cloud connection
   data, status_code, headers = api_instance.pcloud_cloudconnections_networks_put_with_http_info(cloud_instance_id, cloud_connection_id, network_id)
   p status_code # => 2xx
   p headers # => { ... }

data/docs/PCloudImagesApi.md

@@ -11,8 +11,8 @@ All URIs are relative to *http://localhost*
 | [**pcloud_cloudinstances_images_post**](PCloudImagesApi.md#pcloud_cloudinstances_images_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/images | Create a new Image (from available images) |
 | [**pcloud_cloudinstances_stockimages_get**](PCloudImagesApi.md#pcloud_cloudinstances_stockimages_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images/{image_id} | Detailed info of an available stock image |
 | [**pcloud_cloudinstances_stockimages_getall**](PCloudImagesApi.md#pcloud_cloudinstances_stockimages_getall) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images | List all available stock images |
-| [**pcloud_images_get**](PCloudImagesApi.md#pcloud_images_get) | **GET** /pcloud/v1/images/{image_id} | Deprecated for /pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images/{image_id} - Detailed info of an available stock image |
-| [**pcloud_images_getall**](PCloudImagesApi.md#pcloud_images_getall) | **GET** /pcloud/v1/images | Deprecated for /pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images - List all available stock images |
+| [**pcloud_images_get**](PCloudImagesApi.md#pcloud_images_get) | **GET** /pcloud/v1/images/{image_id} | Detailed info of an image in the image-catalog |
+| [**pcloud_images_getall**](PCloudImagesApi.md#pcloud_images_getall) | **GET** /pcloud/v1/images | List all the images in the image-catalog |
 | [**pcloud_v1_cloudinstances_cosimages_get**](PCloudImagesApi.md#pcloud_v1_cloudinstances_cosimages_get) | **GET** /pcloud/v1/cloud-instances/{cloud_instance_id}/cos-images | Get detail of last cos-image import job |
 | [**pcloud_v1_cloudinstances_cosimages_post**](PCloudImagesApi.md#pcloud_v1_cloudinstances_cosimages_post) | **POST** /pcloud/v1/cloud-instances/{cloud_instance_id}/cos-images | Create an cos-image import job |
 | [**pcloud_v2_images_export_get**](PCloudImagesApi.md#pcloud_v2_images_export_get) | **GET** /pcloud/v2/cloud-instances/{cloud_instance_id}/images/{image_id}/export | Get detail of last image export job |
@@ -80,7 +80,7 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: */*
+- **Accept**: application/json
 
 
 ## pcloud_cloudinstances_images_export_post
@@ -89,6 +89,8 @@ No authorization required
 
 Export an image
 
+This API is deprecated for /pcloud/v2/cloud-instances/{cloud_instance_id}/images/{image_id}/export.  >*Note*: Support for this API is available till Oct 2022. 
+
 ### Examples
 
 ```ruby
@@ -475,7 +477,9 @@ No authorization required
 
 > <Image> pcloud_images_get(image_id)
 
-Deprecated for /pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images/{image_id} - Detailed info of an available stock image
+Detailed info of an image in the image-catalog
+
+This API is deprecated for /pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images/{image_id}.  >*Note*: Support for this API will be available till 31st March 2023. 
 
 ### Examples
 
@@ -487,7 +491,7 @@ api_instance = IbmCloudPower::PCloudImagesApi.new
 image_id = 'image_id_example' # String | Image ID of a image
 
 begin
-  # Deprecated for /pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images/{image_id} - Detailed info of an available stock image
+  # Detailed info of an image in the image-catalog
   result = api_instance.pcloud_images_get(image_id)
   p result
 rescue IbmCloudPower::ApiError => e
@@ -503,7 +507,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Deprecated for /pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images/{image_id} - Detailed info of an available stock image
+  # Detailed info of an image in the image-catalog
   data, status_code, headers = api_instance.pcloud_images_get_with_http_info(image_id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -537,7 +541,9 @@ No authorization required
 
 > <Images> pcloud_images_getall(opts)
 
-Deprecated for /pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images - List all available stock images
+List all the images in the image-catalog
+
+This API is deprecated for /pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images.  >*Note*: Support for this API will be available till 31st March 2023. 
 
 ### Examples
 
@@ -552,7 +558,7 @@ opts = {
 }
 
 begin
-  # Deprecated for /pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images - List all available stock images
+  # List all the images in the image-catalog
   result = api_instance.pcloud_images_getall(opts)
   p result
 rescue IbmCloudPower::ApiError => e
@@ -568,7 +574,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Deprecated for /pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images - List all available stock images
+  # List all the images in the image-catalog
   data, status_code, headers = api_instance.pcloud_images_getall_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }

data/docs/PCloudNetworksApi.md

@@ -77,7 +77,7 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: */*
+- **Accept**: application/json
 
 
 ## pcloud_networks_get
@@ -216,6 +216,8 @@ No authorization required
 
 Delete a Network Port
 
+This API is deprecated for /v1/networks/{network_id}/network-interfaces/{network_interface_id}. 
+
 ### Examples
 
 ```ruby
@@ -282,6 +284,8 @@ No authorization required
 
 Get a port's information
 
+This API is deprecated for /v1/networks/{network_id}/network-interfaces/{network_interface_id}. 
+
 ### Examples
 
 ```ruby
@@ -339,7 +343,7 @@ No authorization required
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: application/json, applicaton/json
+- **Accept**: application/json
 
 
 ## pcloud_networks_ports_getall
@@ -348,6 +352,8 @@ No authorization required
 
 Get all ports for this network
 
+This API is deprecated for /v1/networks/{network_id}/network-interfaces. 
+
 ### Examples
 
 ```ruby
@@ -412,6 +418,8 @@ No authorization required
 
 Perform port addition, deletion, and listing
 
+This API is deprecated for /v1/networks/{network_id}/network-interfaces. 
+
 ### Examples
 
 ```ruby
@@ -480,6 +488,8 @@ No authorization required
 
 Update a port's information
 
+This API is deprecated for /v1/networks/{network_id}/network-interfaces/{network_interface_id}. 
+
 ### Examples
 
 ```ruby