pnap_bmc_api 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c963cbc0d6e9a73b1d20d9fc4ebdae4f26841905700f25cd1d4194b3f5389622
-  data.tar.gz: 2cdf867849e85e583276bc0403f3556eedc7bdc94d69fed2bbea52475d386a13
+  metadata.gz: aa4d1bec07d68b4f7508fa1745002c2d5fb9d2b4dbe18c27f6910bbfbec95777
+  data.tar.gz: 3ec5e3c0b99597bba369f7524ce2ab219b069bcdac66f6bddc440b22366f136a
 SHA512:
-  metadata.gz: 39130877d89b21a46619f58fc59549a9ff56f7d4d2f93f078c6bf13cb6a36619aab4f4cd544fc977c3ab1d7f294fa051aacaa30c56f903e4d95db2b6a4ca7808
-  data.tar.gz: ad7384db61dd6d4dd691b61b7f251c203dc106c92ffb75d95817c815e0113362a68486a6be92ccaa4ab7252c69ff9980559f5621e2ca215eea85fa8a5179f100
+  metadata.gz: b4ebda75738a7a72d220501bf3b3f897717c97e0d30f6292047a6b464308062681d2d79f601d16d205b71f7f5b16cdc269df939134c7570201630dbaa84f4f70
+  data.tar.gz: 7e6b1ba8cf1473638d269b5f15069bec6207b952197b258ee3dfdce4c5f4fb6809c647c887879d72cdd4dbf43395a80c83ddec444cd1067999c830cbf03ffe77

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.0

data/docs/NetworkConfiguration.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **gateway_address** | **String** | The address of the gateway assigned / to assign to the server. When used as part of request body, IP address has to be part of private/public network assigned to this server. | [optional] |
+| **gateway_address** | **String** | The address of the gateway assigned / to assign to the server.<br> When used as part of request body, IP address has to be part of a private/public network or an IP block assigned to this server.<br> Gateway address also has to be assigned on an already deployed resource unless the address matches the BMC gateway address in a public network/IP block or the `force` query parameter is true. | [optional] |
 | **private_network_configuration** | [**PrivateNetworkConfiguration**](PrivateNetworkConfiguration.md) |  | [optional] |
 | **ip_blocks_configuration** | [**IpBlocksConfiguration**](IpBlocksConfiguration.md) |  | [optional] |
 | **public_network_configuration** | [**PublicNetworkConfiguration**](PublicNetworkConfiguration.md) |  | [optional] |

data/docs/OsConfiguration.md

@@ -8,7 +8,7 @@
 | **root_password** | **String** | Password set for user root on an ESXi server which will only be returned in response to provisioning a server. | [optional][readonly] |
 | **management_ui_url** | **String** | The URL of the management UI which will only be returned in response to provisioning a server. | [optional][readonly] |
 | **management_access_allowed_ips** | **Array<String>** | List of IPs allowed to access the Management UI. Supported in single IP, CIDR and range format. When undefined, Management UI is disabled. This will only be returned in response to provisioning a server. | [optional] |
-| **install_os_to_ram** | **Boolean** | If true, OS will be installed to and booted from the server's RAM. On restart RAM OS will be lost and the server will not be reachable unless a custom bootable OS has been deployed. Only supported for ubuntu/focal. | [optional][default to false] |
+| **install_os_to_ram** | **Boolean** | If true, OS will be installed to and booted from the server's RAM. On restart RAM OS will be lost and the server will not be reachable unless a custom bootable OS has been deployed. Only supported for ubuntu/focal and ubuntu/jammy. | [optional][default to false] |
 | **cloud_init** | [**OsConfigurationCloudInit**](OsConfigurationCloudInit.md) |  | [optional] |
 
 ## Example

data/docs/OsConfigurationCloudInit.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **user_data** | **String** | User data for the <a href='https://cloudinit.readthedocs.io/en/latest/' target='_blank'>cloud-init</a> configuration in base64 encoding. NoCloud format is supported. Follow the <a href='https://phoenixnap.com/kb/bmc-cloud-init' target='_blank'>instructions</a> on how to provision a server using cloud-init. Only ubuntu/bionic and ubuntu/focal are supported. User data will not be stored and cannot be retrieved once you deploy the server. Copy and save it for future reference. | [optional] |
+| **user_data** | **String** | User data for the <a href='https://cloudinit.readthedocs.io/en/latest/' target='_blank'>cloud-init</a> configuration in base64 encoding. NoCloud format is supported. Follow the <a href='https://phoenixnap.com/kb/bmc-cloud-init' target='_blank'>instructions</a> on how to provision a server using cloud-init. Only ubuntu/bionic, ubuntu/focal and ubuntu/jammy are supported. User data will not be stored and cannot be retrieved once you deploy the server. Copy and save it for future reference. | [optional] |
 
 ## Example
 

data/docs/PrivateNetworkConfiguration.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **gateway_address** | **String** | The address of the gateway assigned / to assign to the server. When used as part of request body, it has to match one of the IP addresses used in the existing assigned private networks for the relevant location. Deprecated in favour of a common gateway address across all networks available under NetworkConfiguration. | [optional] |
+| **gateway_address** | **String** | Deprecated in favour of a common gateway address across all networks available under NetworkConfiguration.<br> The address of the gateway assigned / to assign to the server.<br> When used as part of request body, IP address has to be part of private network assigned to this server.<br> Gateway address also has to be assigned on an already deployed resource unless the `force` query parameter is true. | [optional] |
 | **configuration_type** | **String** | Determines the approach for configuring private network(s) for the server being provisioned. Currently this field should be set to `USE_OR_CREATE_DEFAULT` or `USER_DEFINED`. | [optional][default to 'USE_OR_CREATE_DEFAULT'] |
 | **private_networks** | [**Array<ServerPrivateNetwork>**](ServerPrivateNetwork.md) | The list of private networks this server is member of. When this field is part of request body, it'll be used to specify the private networks to assign to this server upon provisioning. Used alongside the `USER_DEFINED` configurationType. | [optional] |
 

data/docs/Server.md

@@ -8,7 +8,7 @@
 | **status** | **String** | The status of the server. |  |
 | **hostname** | **String** | Hostname of server. |  |
 | **description** | **String** | Description of server. | [optional] |
-| **os** | **String** | The server’s OS ID used when the server was created. Currently this field should be set to either `ubuntu/bionic`, `ubuntu/focal`, `centos/centos7`, `centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `esxi/esxi70u2`, `debian/bullseye` or `proxmox/bullseye`. |  |
+| **os** | **String** | The server’s OS ID used when the server was created. Currently this field should be set to either `ubuntu/bionic`, `ubuntu/focal`, `ubuntu/jammy`, `centos/centos7`, `centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `esxi/esxi70`, `debian/bullseye` or `proxmox/bullseye`. |  |
 | **type** | **String** | Server type ID. Cannot be changed once a server is created. Currently this field should be set to either `s0.d1.small`, `s0.d1.medium`, `s1.c1.small`, `s1.c1.medium`, `s1.c2.medium`, `s1.c2.large`, `s1.e1.small`, `s1.e1.medium`, `s1.e1.large`, `s2.c1.small`, `s2.c1.medium`, `s2.c1.large`, `s2.c2.small`, `s2.c2.medium`, `s2.c2.large`, `d1.c1.small`, `d1.c2.small`, `d1.c3.small`, `d1.c4.small`, `d1.c1.medium`, `d1.c2.medium`, `d1.c3.medium`, `d1.c4.medium`, `d1.c1.large`, `d1.c2.large`, `d1.c3.large`, `d1.c4.large`, `d1.m1.medium`, `d1.m2.medium`, `d1.m3.medium`, `d1.m4.medium`, `d2.c1.medium`, `d2.c2.medium`, `d2.c3.medium`, `d2.c4.medium`, `d2.c5.medium`, `d2.c1.large`, `d2.c2.large`, `d2.c3.large`, `d2.c4.large`, `d2.c5.large`, `d2.m1.medium`, `d2.m1.large`, `d2.m2.medium`, `d2.m2.large`, `d2.m2.xlarge` or `d2.c4.storage.pliops1`. |  |
 | **location** | **String** | Server location ID. Cannot be changed once a server is created. Currently this field should be set to `PHX`, `ASH`, `SGP`, `NLD`, `CHI`, `SEA` or `AUS`. |  |
 | **cpu** | **String** | A description of the machine CPU. |  |

data/docs/ServerCreate.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **hostname** | **String** | Hostname of server. |  |
 | **description** | **String** | Description of server. | [optional] |
-| **os** | **String** | The server’s OS ID used when the server was created. Currently this field should be set to either `ubuntu/bionic`, `ubuntu/focal`, `centos/centos7`,`centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `esxi/esxi70u2`, `debian/bullseye` or `proxmox/bullseye`. |  |
+| **os** | **String** | The server’s OS ID used when the server was created. Currently this field should be set to either `ubuntu/bionic`, `ubuntu/focal`, `ubuntu/jammy`, `centos/centos7`,`centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `esxi/esxi70`, `debian/bullseye` or `proxmox/bullseye`. |  |
 | **type** | **String** | Server type ID. Cannot be changed once a server is created. Currently this field should be set to either `s0.d1.small`, `s0.d1.medium`, `s1.c1.small`, `s1.c1.medium`, `s1.c2.medium`, `s1.c2.large`, `s1.e1.small`, `s1.e1.medium`, `s1.e1.large`, `s2.c1.small`, `s2.c1.medium`, `s2.c1.large`, `s2.c2.small`, `s2.c2.medium`, `s2.c2.large`, `d1.c1.small`, `d1.c2.small`, `d1.c3.small`, `d1.c4.small`, `d1.c1.medium`, `d1.c2.medium`, `d1.c3.medium`, `d1.c4.medium`, `d1.c1.large`, `d1.c2.large`, `d1.c3.large`, `d1.c4.large`, `d1.m1.medium`, `d1.m2.medium`, `d1.m3.medium`, `d1.m4.medium`, `d2.c1.medium`, `d2.c2.medium`, `d2.c3.medium`, `d2.c4.medium`, `d2.c5.medium`, `d2.c1.large`, `d2.c2.large`, `d2.c3.large`, `d2.c4.large`, `d2.c5.large`, `d2.m1.medium`, `d2.m1.large`, `d2.m2.medium`, `d2.m2.large`, `d2.m2.xlarge` or `d2.c4.storage.pliops1`. |  |
 | **location** | **String** | Server location ID. Cannot be changed once a server is created. Currently this field should be set to `PHX`, `ASH`, `SGP`, `NLD`, `CHI`, `SEA` or `AUS`. |  |
 | **install_default_ssh_keys** | **Boolean** | Whether or not to install SSH keys marked as default in addition to any SSH keys specified in this request. | [optional][default to true] |

data/docs/ServerPrivateNetwork.md

@@ -5,8 +5,8 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | The network identifier. |  |
-| **ips** | **Array<String>** | IPs to configure/configured on the server. Should be null or empty list if DHCP is true. If the network contains a membership of type 'storage', the first twelve IPs are already reserved by BMC and not usable. These will return a Bad Request (400) if selected. | [optional] |
-| **dhcp** | **Boolean** | Determines whether DHCP is enabled for this server. Should be false if ips is not an empty list. Not supported for proxmox OS. | [optional][default to false] |
+| **ips** | **Array<String>** | IPs to configure/configured on the server.<br> Should be null or empty list if DHCP is true. IPs must be within the network's range.<br> If field is undefined and DHCP is false, next available IP in network will be automatically allocated.<br> If the network contains a membership of type 'storage', the first twelve IPs are already reserved by BMC and not usable.<br> Setting the `force` query parameter to `true` allows you to:<ul> <li> Assign no specific IP addresses by designating an empty array of IPs. Note that at least one IP is required for the gateway address to be selected from this network. <li> Assign one or more IP addresses which are already configured on other resource(s) in network.</ul> | [optional] |
+| **dhcp** | **Boolean** | Determines whether DHCP is enabled for this server. Should be false if any IPs are provided. Not supported for Proxmox OS and ESXi OS. | [optional][default to false] |
 | **status_description** | **String** | The status of the network. | [optional][readonly] |
 
 ## Example

data/docs/ServerPublicNetwork.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | The network identifier. |  |
-| **ips** | **Array<String>** | IPs to configure/configured on the server. IPs must be within the network's range. |  |
+| **ips** | **Array<String>** | Configurable/configured IPs on the server.<br> At least 1 IP address is required. All IPs must be within the network's range.<br> Setting the `force` query parameter to `true` allows you to:<ul> <li> Assign no specific IP addresses by designating an empty array of IPs. Note that at least one IP is required for the gateway address to be selected from this network. <li> Assign one or more IP addresses which are already configured on other resource(s) in network.</ul> | [optional] |
 | **status_description** | **String** | The status of the assignment to the network. | [optional][readonly] |
 
 ## Example

data/docs/ServersApi.md

@@ -188,6 +188,7 @@ end
 
 api_instance = BmcApi::ServersApi.new
 opts = {
+  force: true, # Boolean | Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups.
   server_create: BmcApi::ServerCreate.new({hostname: 'my-server-1', os: 'ubuntu/bionic', type: 's1.c1.small', location: 'PHX'}) # ServerCreate | 
 }
 
@@ -222,6 +223,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **force** | **Boolean** | Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. | [optional][default to false] |
 | **server_create** | [**ServerCreate**](ServerCreate.md) |  | [optional] |
 
 ### Return type
@@ -1098,7 +1100,7 @@ end
 
 Adds the server to a private network.
 
-Adds the server to a private network. <b>No actual configuration is performed on the operating system.</b> BMC configures exclusively the networking devices in the datacenter infrastructure. Manual network configuration changes in the operating system of this server are required. If the network contains a membership of type 'storage', the first twelve IPs are already reserved by BMC and not usable. These will return a Bad Request (400) if selected. Knowledge base article to help you can be found <a href='https://phoenixnap.com/kb/configure-bmc-server-after-adding-to-network#ftoc-heading-3' target='_blank'>here</a>.
+Adds the server to a private network. <b>No actual configuration is performed on the operating system.</b> BMC configures exclusively the networking devices in the datacenter infrastructure. Manual network configuration changes in the operating system of this server are required. Knowledge base article to help you can be found <a href='https://phoenixnap.com/kb/configure-bmc-server-after-adding-to-network#ftoc-heading-3' target='_blank'>here</a>.
 
 ### Examples
 
@@ -1114,6 +1116,7 @@ end
 api_instance = BmcApi::ServersApi.new
 server_id = 'e6afba51-7de8-4080-83ab-0f915570659c' # String | The server's ID.
 opts = {
+  force: true, # Boolean | Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups.
   server_private_network: BmcApi::ServerPrivateNetwork.new({id: '603f3b2cfcaf050643b89a4b'}) # ServerPrivateNetwork | 
 }
 
@@ -1149,6 +1152,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **server_id** | **String** | The server&#39;s ID. |  |
+| **force** | **Boolean** | Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. | [optional][default to false] |
 | **server_private_network** | [**ServerPrivateNetwork**](ServerPrivateNetwork.md) |  | [optional] |
 
 ### Return type
@@ -1258,7 +1262,8 @@ end
 api_instance = BmcApi::ServersApi.new
 server_id = 'e6afba51-7de8-4080-83ab-0f915570659c' # String | The server's ID.
 opts = {
-  server_public_network: BmcApi::ServerPublicNetwork.new({id: '60473c2509268bc77fd06d29', ips: ["182.16.0.146", "182.16.0.147"]}) # ServerPublicNetwork | 
+  force: true, # Boolean | Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups.
+  server_public_network: BmcApi::ServerPublicNetwork.new({id: '60473c2509268bc77fd06d29'}) # ServerPublicNetwork | 
 }
 
 begin
@@ -1293,6 +1298,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **server_id** | **String** | The server&#39;s ID. |  |
+| **force** | **Boolean** | Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. | [optional][default to false] |
 | **server_public_network** | [**ServerPublicNetwork**](ServerPublicNetwork.md) |  | [optional] |
 
 ### Return type

data/lib/pnap_bmc_api/api/servers_api.rb

@@ -151,6 +151,7 @@ module BmcApi
     # Create new server.
     # Create (request) new server for account. Server DNS will be configured to access Google's public DNS at 8.8.8.8 .
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :force Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. (default to false)
     # @option opts [ServerCreate] :server_create 
     # @return [Server]
     def servers_post(opts = {})
@@ -161,6 +162,7 @@ module BmcApi
     # Create new server.
     # Create (request) new server for account. Server DNS will be configured to access Google's public DNS at 8.8.8.8 .
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :force Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. (default to false)
     # @option opts [ServerCreate] :server_create 
     # @return [Array<(Server, Integer, Hash)>] Server data, response status code and response headers
     def servers_post_with_http_info(opts = {})
@@ -172,6 +174,7 @@ module BmcApi
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'force'] = opts[:'force'] if !opts[:'force'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -1017,9 +1020,10 @@ module BmcApi
     end
 
     # Adds the server to a private network.
-    # Adds the server to a private network. <b>No actual configuration is performed on the operating system.</b> BMC configures exclusively the networking devices in the datacenter infrastructure. Manual network configuration changes in the operating system of this server are required. If the network contains a membership of type 'storage', the first twelve IPs are already reserved by BMC and not usable. These will return a Bad Request (400) if selected. Knowledge base article to help you can be found <a href='https://phoenixnap.com/kb/configure-bmc-server-after-adding-to-network#ftoc-heading-3' target='_blank'>here</a>.
+    # Adds the server to a private network. <b>No actual configuration is performed on the operating system.</b> BMC configures exclusively the networking devices in the datacenter infrastructure. Manual network configuration changes in the operating system of this server are required. Knowledge base article to help you can be found <a href='https://phoenixnap.com/kb/configure-bmc-server-after-adding-to-network#ftoc-heading-3' target='_blank'>here</a>.
     # @param server_id [String] The server&#39;s ID.
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :force Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. (default to false)
     # @option opts [ServerPrivateNetwork] :server_private_network 
     # @return [ServerPrivateNetwork]
     def servers_server_id_private_networks_post(server_id, opts = {})
@@ -1028,9 +1032,10 @@ module BmcApi
     end
 
     # Adds the server to a private network.
-    # Adds the server to a private network. &lt;b&gt;No actual configuration is performed on the operating system.&lt;/b&gt; BMC configures exclusively the networking devices in the datacenter infrastructure. Manual network configuration changes in the operating system of this server are required. If the network contains a membership of type &#39;storage&#39;, the first twelve IPs are already reserved by BMC and not usable. These will return a Bad Request (400) if selected. Knowledge base article to help you can be found &lt;a href&#x3D;&#39;https://phoenixnap.com/kb/configure-bmc-server-after-adding-to-network#ftoc-heading-3&#39; target&#x3D;&#39;_blank&#39;&gt;here&lt;/a&gt;.
+    # Adds the server to a private network. &lt;b&gt;No actual configuration is performed on the operating system.&lt;/b&gt; BMC configures exclusively the networking devices in the datacenter infrastructure. Manual network configuration changes in the operating system of this server are required. Knowledge base article to help you can be found &lt;a href&#x3D;&#39;https://phoenixnap.com/kb/configure-bmc-server-after-adding-to-network#ftoc-heading-3&#39; target&#x3D;&#39;_blank&#39;&gt;here&lt;/a&gt;.
     # @param server_id [String] The server&#39;s ID.
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :force Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. (default to false)
     # @option opts [ServerPrivateNetwork] :server_private_network 
     # @return [Array<(ServerPrivateNetwork, Integer, Hash)>] ServerPrivateNetwork data, response status code and response headers
     def servers_server_id_private_networks_post_with_http_info(server_id, opts = {})
@@ -1046,6 +1051,7 @@ module BmcApi
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'force'] = opts[:'force'] if !opts[:'force'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -1159,6 +1165,7 @@ module BmcApi
     # Adds the server to a Public Network. <b>No actual configuration is performed on the operating system.</b> BMC configures exclusively the networking devices in the datacenter infrastructure. Manual network configuration changes in the operating system of this server are required. Knowledge base article to help you can be found <a href='https://phoenixnap.com/kb/configure-bmc-server-after-adding-to-network#ftoc-heading-3' target='_blank'>here</a>.
     # @param server_id [String] The server&#39;s ID.
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :force Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. (default to false)
     # @option opts [ServerPublicNetwork] :server_public_network 
     # @return [ServerPublicNetwork]
     def servers_server_id_public_networks_post(server_id, opts = {})
@@ -1170,6 +1177,7 @@ module BmcApi
     # Adds the server to a Public Network. &lt;b&gt;No actual configuration is performed on the operating system.&lt;/b&gt; BMC configures exclusively the networking devices in the datacenter infrastructure. Manual network configuration changes in the operating system of this server are required. Knowledge base article to help you can be found &lt;a href&#x3D;&#39;https://phoenixnap.com/kb/configure-bmc-server-after-adding-to-network#ftoc-heading-3&#39; target&#x3D;&#39;_blank&#39;&gt;here&lt;/a&gt;.
     # @param server_id [String] The server&#39;s ID.
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :force Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. (default to false)
     # @option opts [ServerPublicNetwork] :server_public_network 
     # @return [Array<(ServerPublicNetwork, Integer, Hash)>] ServerPublicNetwork data, response status code and response headers
     def servers_server_id_public_networks_post_with_http_info(server_id, opts = {})
@@ -1185,6 +1193,7 @@ module BmcApi
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'force'] = opts[:'force'] if !opts[:'force'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/pnap_bmc_api/models/network_configuration.rb

@@ -16,7 +16,7 @@ require 'time'
 module BmcApi
   # Entire network details of bare metal server.
   class NetworkConfiguration
-    # The address of the gateway assigned / to assign to the server. When used as part of request body, IP address has to be part of private/public network assigned to this server.
+    # The address of the gateway assigned / to assign to the server.<br> When used as part of request body, IP address has to be part of a private/public network or an IP block assigned to this server.<br> Gateway address also has to be assigned on an already deployed resource unless the address matches the BMC gateway address in a public network/IP block or the `force` query parameter is true.
     attr_accessor :gateway_address
 
     attr_accessor :private_network_configuration

data/lib/pnap_bmc_api/models/os_configuration.rb

@@ -27,7 +27,7 @@ module BmcApi
     # List of IPs allowed to access the Management UI. Supported in single IP, CIDR and range format. When undefined, Management UI is disabled. This will only be returned in response to provisioning a server.
     attr_accessor :management_access_allowed_ips
 
-    # If true, OS will be installed to and booted from the server's RAM. On restart RAM OS will be lost and the server will not be reachable unless a custom bootable OS has been deployed. Only supported for ubuntu/focal.
+    # If true, OS will be installed to and booted from the server's RAM. On restart RAM OS will be lost and the server will not be reachable unless a custom bootable OS has been deployed. Only supported for ubuntu/focal and ubuntu/jammy.
     attr_accessor :install_os_to_ram
 
     attr_accessor :cloud_init

data/lib/pnap_bmc_api/models/os_configuration_cloud_init.rb

@@ -16,7 +16,7 @@ require 'time'
 module BmcApi
   # Cloud-init configuration details.
   class OsConfigurationCloudInit
-    # User data for the <a href='https://cloudinit.readthedocs.io/en/latest/' target='_blank'>cloud-init</a> configuration in base64 encoding. NoCloud format is supported. Follow the <a href='https://phoenixnap.com/kb/bmc-cloud-init' target='_blank'>instructions</a> on how to provision a server using cloud-init. Only ubuntu/bionic and ubuntu/focal are supported. User data will not be stored and cannot be retrieved once you deploy the server. Copy and save it for future reference.
+    # User data for the <a href='https://cloudinit.readthedocs.io/en/latest/' target='_blank'>cloud-init</a> configuration in base64 encoding. NoCloud format is supported. Follow the <a href='https://phoenixnap.com/kb/bmc-cloud-init' target='_blank'>instructions</a> on how to provision a server using cloud-init. Only ubuntu/bionic, ubuntu/focal and ubuntu/jammy are supported. User data will not be stored and cannot be retrieved once you deploy the server. Copy and save it for future reference.
     attr_accessor :user_data
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/pnap_bmc_api/models/private_network_configuration.rb

@@ -16,7 +16,7 @@ require 'time'
 module BmcApi
   # Private network details of bare metal server.
   class PrivateNetworkConfiguration
-    # The address of the gateway assigned / to assign to the server. When used as part of request body, it has to match one of the IP addresses used in the existing assigned private networks for the relevant location. Deprecated in favour of a common gateway address across all networks available under NetworkConfiguration.
+    # Deprecated in favour of a common gateway address across all networks available under NetworkConfiguration.<br> The address of the gateway assigned / to assign to the server.<br> When used as part of request body, IP address has to be part of private network assigned to this server.<br> Gateway address also has to be assigned on an already deployed resource unless the `force` query parameter is true.
     attr_accessor :gateway_address
 
     # Determines the approach for configuring private network(s) for the server being provisioned. Currently this field should be set to `USE_OR_CREATE_DEFAULT` or `USER_DEFINED`.

data/lib/pnap_bmc_api/models/server.rb

@@ -28,7 +28,7 @@ module BmcApi
     # Description of server.
     attr_accessor :description
 
-    # The server’s OS ID used when the server was created. Currently this field should be set to either `ubuntu/bionic`, `ubuntu/focal`, `centos/centos7`, `centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `esxi/esxi70u2`, `debian/bullseye` or `proxmox/bullseye`.
+    # The server’s OS ID used when the server was created. Currently this field should be set to either `ubuntu/bionic`, `ubuntu/focal`, `ubuntu/jammy`, `centos/centos7`, `centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `esxi/esxi70`, `debian/bullseye` or `proxmox/bullseye`.
     attr_accessor :os
 
     # Server type ID. Cannot be changed once a server is created. Currently this field should be set to either `s0.d1.small`, `s0.d1.medium`, `s1.c1.small`, `s1.c1.medium`, `s1.c2.medium`, `s1.c2.large`, `s1.e1.small`, `s1.e1.medium`, `s1.e1.large`, `s2.c1.small`, `s2.c1.medium`, `s2.c1.large`, `s2.c2.small`, `s2.c2.medium`, `s2.c2.large`, `d1.c1.small`, `d1.c2.small`, `d1.c3.small`, `d1.c4.small`, `d1.c1.medium`, `d1.c2.medium`, `d1.c3.medium`, `d1.c4.medium`, `d1.c1.large`, `d1.c2.large`, `d1.c3.large`, `d1.c4.large`, `d1.m1.medium`, `d1.m2.medium`, `d1.m3.medium`, `d1.m4.medium`, `d2.c1.medium`, `d2.c2.medium`, `d2.c3.medium`, `d2.c4.medium`, `d2.c5.medium`, `d2.c1.large`, `d2.c2.large`, `d2.c3.large`, `d2.c4.large`, `d2.c5.large`, `d2.m1.medium`, `d2.m1.large`, `d2.m2.medium`, `d2.m2.large`, `d2.m2.xlarge` or `d2.c4.storage.pliops1`.

data/lib/pnap_bmc_api/models/server_create.rb

@@ -22,7 +22,7 @@ module BmcApi
     # Description of server.
     attr_accessor :description
 
-    # The server’s OS ID used when the server was created. Currently this field should be set to either `ubuntu/bionic`, `ubuntu/focal`, `centos/centos7`,`centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `esxi/esxi70u2`, `debian/bullseye` or `proxmox/bullseye`.
+    # The server’s OS ID used when the server was created. Currently this field should be set to either `ubuntu/bionic`, `ubuntu/focal`, `ubuntu/jammy`, `centos/centos7`,`centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `esxi/esxi70`, `debian/bullseye` or `proxmox/bullseye`.
     attr_accessor :os
 
     # Server type ID. Cannot be changed once a server is created. Currently this field should be set to either `s0.d1.small`, `s0.d1.medium`, `s1.c1.small`, `s1.c1.medium`, `s1.c2.medium`, `s1.c2.large`, `s1.e1.small`, `s1.e1.medium`, `s1.e1.large`, `s2.c1.small`, `s2.c1.medium`, `s2.c1.large`, `s2.c2.small`, `s2.c2.medium`, `s2.c2.large`, `d1.c1.small`, `d1.c2.small`, `d1.c3.small`, `d1.c4.small`, `d1.c1.medium`, `d1.c2.medium`, `d1.c3.medium`, `d1.c4.medium`, `d1.c1.large`, `d1.c2.large`, `d1.c3.large`, `d1.c4.large`, `d1.m1.medium`, `d1.m2.medium`, `d1.m3.medium`, `d1.m4.medium`, `d2.c1.medium`, `d2.c2.medium`, `d2.c3.medium`, `d2.c4.medium`, `d2.c5.medium`, `d2.c1.large`, `d2.c2.large`, `d2.c3.large`, `d2.c4.large`, `d2.c5.large`, `d2.m1.medium`, `d2.m1.large`, `d2.m2.medium`, `d2.m2.large`, `d2.m2.xlarge` or `d2.c4.storage.pliops1`.

data/lib/pnap_bmc_api/models/server_private_network.rb

@@ -19,10 +19,10 @@ module BmcApi
     # The network identifier.
     attr_accessor :id
 
-    # IPs to configure/configured on the server. Should be null or empty list if DHCP is true. If the network contains a membership of type 'storage', the first twelve IPs are already reserved by BMC and not usable. These will return a Bad Request (400) if selected.
+    # IPs to configure/configured on the server.<br> Should be null or empty list if DHCP is true. IPs must be within the network's range.<br> If field is undefined and DHCP is false, next available IP in network will be automatically allocated.<br> If the network contains a membership of type 'storage', the first twelve IPs are already reserved by BMC and not usable.<br> Setting the `force` query parameter to `true` allows you to:<ul> <li> Assign no specific IP addresses by designating an empty array of IPs. Note that at least one IP is required for the gateway address to be selected from this network. <li> Assign one or more IP addresses which are already configured on other resource(s) in network.</ul>
     attr_accessor :ips
 
-    # Determines whether DHCP is enabled for this server. Should be false if ips is not an empty list. Not supported for proxmox OS.
+    # Determines whether DHCP is enabled for this server. Should be false if any IPs are provided. Not supported for Proxmox OS and ESXi OS.
     attr_accessor :dhcp
 
     # The status of the network.

data/lib/pnap_bmc_api/models/server_public_network.rb

@@ -19,7 +19,7 @@ module BmcApi
     # The network identifier.
     attr_accessor :id
 
-    # IPs to configure/configured on the server. IPs must be within the network's range.
+    # Configurable/configured IPs on the server.<br> At least 1 IP address is required. All IPs must be within the network's range.<br> Setting the `force` query parameter to `true` allows you to:<ul> <li> Assign no specific IP addresses by designating an empty array of IPs. Note that at least one IP is required for the gateway address to be selected from this network. <li> Assign one or more IP addresses which are already configured on other resource(s) in network.</ul>
     attr_accessor :ips
 
     # The status of the assignment to the network.
@@ -92,14 +92,6 @@ module BmcApi
         invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
-      if @ips.nil?
-        invalid_properties.push('invalid value for "ips", ips cannot be nil.')
-      end
-
-      if @ips.length < 1
-        invalid_properties.push('invalid value for "ips", number of items must be greater than or equal to 1.')
-      end
-
       invalid_properties
     end
 
@@ -107,25 +99,9 @@ module BmcApi
     # @return true if the model is valid
     def valid?
       return false if @id.nil?
-      return false if @ips.nil?
-      return false if @ips.length < 1
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] ips Value to be assigned
-    def ips=(ips)
-      if ips.nil?
-        fail ArgumentError, 'ips cannot be nil'
-      end
-
-      if ips.length < 1
-        fail ArgumentError, 'invalid value for "ips", number of items must be greater than or equal to 1.'
-      end
-
-      @ips = ips
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pnap_bmc_api
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - PhoenixNAP
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-07 00:00:00.000000000 Z
+date: 2023-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -208,37 +208,37 @@ test_files:
 - spec/api/quotas_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
+- spec/models/os_configuration_map_esxi_spec.rb
 - spec/models/quota_edit_limit_request_details_all_of_spec.rb
-- spec/models/delete_result_spec.rb
 - spec/models/os_configuration_map_proxmox_spec.rb
-- spec/models/server_reset_spec.rb
-- spec/models/server_create_spec.rb
-- spec/models/public_network_configuration_spec.rb
-- spec/models/ssh_key_create_spec.rb
-- spec/models/os_configuration_windows_spec.rb
-- spec/models/tag_assignment_request_spec.rb
-- spec/models/quota_edit_limit_request_details_spec.rb
+- spec/models/server_private_network_spec.rb
+- spec/models/delete_result_spec.rb
 - spec/models/quota_spec.rb
-- spec/models/relinquish_ip_block_spec.rb
+- spec/models/os_configuration_windows_spec.rb
+- spec/models/ssh_key_create_spec.rb
+- spec/models/ssh_key_update_spec.rb
+- spec/models/server_ip_block_spec.rb
+- spec/models/server_reset_spec.rb
 - spec/models/ssh_key_spec.rb
-- spec/models/os_configuration_spec.rb
-- spec/models/quota_edit_limit_request_spec.rb
-- spec/models/server_private_network_spec.rb
-- spec/models/os_configuration_map_spec.rb
 - spec/models/error_spec.rb
-- spec/models/os_configuration_map_esxi_spec.rb
-- spec/models/ssh_key_update_spec.rb
-- spec/models/server_reserve_spec.rb
-- spec/models/os_configuration_cloud_init_spec.rb
 - spec/models/tag_assignment_spec.rb
-- spec/models/server_spec.rb
+- spec/models/quota_edit_limit_request_details_spec.rb
+- spec/models/os_configuration_map_spec.rb
+- spec/models/server_create_spec.rb
 - spec/models/action_result_spec.rb
-- spec/models/server_patch_spec.rb
+- spec/models/server_reserve_spec.rb
+- spec/models/private_network_configuration_spec.rb
+- spec/models/tag_assignment_request_spec.rb
+- spec/models/public_network_configuration_spec.rb
 - spec/models/network_configuration_spec.rb
 - spec/models/ip_blocks_configuration_spec.rb
-- spec/models/server_public_network_spec.rb
-- spec/models/server_ip_block_spec.rb
-- spec/models/private_network_configuration_spec.rb
+- spec/models/relinquish_ip_block_spec.rb
+- spec/models/os_configuration_cloud_init_spec.rb
+- spec/models/server_patch_spec.rb
 - spec/models/delete_ssh_key_result_spec.rb
+- spec/models/os_configuration_spec.rb
+- spec/models/server_public_network_spec.rb
+- spec/models/server_spec.rb
 - spec/models/reset_result_spec.rb
+- spec/models/quota_edit_limit_request_spec.rb
 - spec/spec_helper.rb