pnap_bmc_api 1.3.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -0
  3. data/VERSION +1 -1
  4. data/docs/IpBlocksConfiguration.md +1 -1
  5. data/docs/OsConfiguration.md +8 -4
  6. data/docs/OsConfigurationMapEsxi.md +2 -2
  7. data/docs/OsConfigurationMapProxmox.md +2 -2
  8. data/docs/OsConfigurationNetrisController.md +22 -0
  9. data/docs/OsConfigurationNetrisSoftgate.md +24 -0
  10. data/docs/PrivateNetworkConfiguration.md +1 -1
  11. data/docs/Server.md +3 -3
  12. data/docs/ServerCreate.md +2 -2
  13. data/docs/ServerIpBlock.md +1 -1
  14. data/docs/ServerNetworkUpdate.md +18 -0
  15. data/docs/ServerPrivateNetwork.md +1 -1
  16. data/docs/ServerPublicNetwork.md +1 -1
  17. data/docs/ServersApi.md +156 -0
  18. data/lib/pnap_bmc_api/api/servers_api.rb +158 -0
  19. data/lib/pnap_bmc_api/models/ip_blocks_configuration.rb +1 -1
  20. data/lib/pnap_bmc_api/models/os_configuration.rb +22 -4
  21. data/lib/pnap_bmc_api/models/os_configuration_map_esxi.rb +2 -2
  22. data/lib/pnap_bmc_api/models/os_configuration_map_proxmox.rb +2 -2
  23. data/lib/pnap_bmc_api/models/os_configuration_netris_controller.rb +241 -0
  24. data/lib/pnap_bmc_api/models/os_configuration_netris_softgate.rb +251 -0
  25. data/lib/pnap_bmc_api/models/private_network_configuration.rb +1 -1
  26. data/lib/pnap_bmc_api/models/server.rb +3 -3
  27. data/lib/pnap_bmc_api/models/server_create.rb +2 -2
  28. data/lib/pnap_bmc_api/models/server_ip_block.rb +1 -1
  29. data/lib/pnap_bmc_api/models/server_network_update.rb +223 -0
  30. data/lib/pnap_bmc_api/models/server_private_network.rb +1 -1
  31. data/lib/pnap_bmc_api/models/server_public_network.rb +1 -1
  32. data/lib/pnap_bmc_api.rb +3 -0
  33. data/spec/models/os_configuration_netris_controller_spec.rb +46 -0
  34. data/spec/models/os_configuration_netris_softgate_spec.rb +52 -0
  35. data/spec/models/server_network_update_spec.rb +34 -0
  36. metadata +42 -30
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: aa4d1bec07d68b4f7508fa1745002c2d5fb9d2b4dbe18c27f6910bbfbec95777
4
- data.tar.gz: 3ec5e3c0b99597bba369f7524ce2ab219b069bcdac66f6bddc440b22366f136a
3
+ metadata.gz: dc446c3dbf5416901774b7eb5bbee10203fe82417b063b3a0f86bae48d4fbdb1
4
+ data.tar.gz: ec60ce1ec4a59fa38475488f7ba75aa679b6988bcbef732f2b2681ecff4a3e30
5
5
  SHA512:
6
- metadata.gz: b4ebda75738a7a72d220501bf3b3f897717c97e0d30f6292047a6b464308062681d2d79f601d16d205b71f7f5b16cdc269df939134c7570201630dbaa84f4f70
7
- data.tar.gz: 7e6b1ba8cf1473638d269b5f15069bec6207b952197b258ee3dfdce4c5f4fb6809c647c887879d72cdd4dbf43395a80c83ddec444cd1067999c830cbf03ffe77
6
+ metadata.gz: 26715c33499f3c756f6b9370907f34b22d07cb33983d170307704def18170a22af10b8afa5b82ece8a618ec76763b91fcab49a4252920e1f442094e62bf0fe14
7
+ data.tar.gz: 0acbe42ae8e9b71549d5c02ab3815b28c45aebaef56b61a404d24d3dc7e17f746a5dcfca2ff88f7da483e8b546441fc38f8560d5d43e481804cfa4ee2171e904
data/README.md CHANGED
@@ -143,8 +143,10 @@ Class | Method | HTTP request | Description
143
143
  *BmcApi::ServersApi* | [**servers_server_id_ip_blocks_ip_block_id_delete**](docs/ServersApi.md#servers_server_id_ip_blocks_ip_block_id_delete) | **DELETE** /servers/{serverId}/network-configuration/ip-block-configurations/ip-blocks/{ipBlockId} | Unassign IP Block from Server.
144
144
  *BmcApi::ServersApi* | [**servers_server_id_ip_blocks_post**](docs/ServersApi.md#servers_server_id_ip_blocks_post) | **POST** /servers/{serverId}/network-configuration/ip-block-configurations/ip-blocks | Assign IP Block to Server.
145
145
  *BmcApi::ServersApi* | [**servers_server_id_patch**](docs/ServersApi.md#servers_server_id_patch) | **PATCH** /servers/{serverId} | Patch a Server.
146
+ *BmcApi::ServersApi* | [**servers_server_id_private_networks_patch**](docs/ServersApi.md#servers_server_id_private_networks_patch) | **PATCH** /servers/{serverId}/network-configuration/private-network-configuration/private-networks/{privateNetworkId} | Updates the server's private network's IP addresses
146
147
  *BmcApi::ServersApi* | [**servers_server_id_private_networks_post**](docs/ServersApi.md#servers_server_id_private_networks_post) | **POST** /servers/{serverId}/network-configuration/private-network-configuration/private-networks | Adds the server to a private network.
147
148
  *BmcApi::ServersApi* | [**servers_server_id_public_networks_delete**](docs/ServersApi.md#servers_server_id_public_networks_delete) | **DELETE** /servers/{serverId}/network-configuration/public-network-configuration/public-networks/{publicNetworkId} | Removes the server from the Public Network
149
+ *BmcApi::ServersApi* | [**servers_server_id_public_networks_patch**](docs/ServersApi.md#servers_server_id_public_networks_patch) | **PATCH** /servers/{serverId}/network-configuration/public-network-configuration/public-networks/{publicNetworkId} | Updates the server's public network's IP addresses.
148
150
  *BmcApi::ServersApi* | [**servers_server_id_public_networks_post**](docs/ServersApi.md#servers_server_id_public_networks_post) | **POST** /servers/{serverId}/network-configuration/public-network-configuration/public-networks | Adds the server to a Public Network.
149
151
  *BmcApi::ServersApi* | [**servers_server_id_tags_put**](docs/ServersApi.md#servers_server_id_tags_put) | **PUT** /servers/{serverId}/tags | Overwrite tags assigned for Server.
150
152
 
@@ -162,6 +164,8 @@ Class | Method | HTTP request | Description
162
164
  - [BmcApi::OsConfigurationMap](docs/OsConfigurationMap.md)
163
165
  - [BmcApi::OsConfigurationMapEsxi](docs/OsConfigurationMapEsxi.md)
164
166
  - [BmcApi::OsConfigurationMapProxmox](docs/OsConfigurationMapProxmox.md)
167
+ - [BmcApi::OsConfigurationNetrisController](docs/OsConfigurationNetrisController.md)
168
+ - [BmcApi::OsConfigurationNetrisSoftgate](docs/OsConfigurationNetrisSoftgate.md)
165
169
  - [BmcApi::OsConfigurationWindows](docs/OsConfigurationWindows.md)
166
170
  - [BmcApi::PrivateNetworkConfiguration](docs/PrivateNetworkConfiguration.md)
167
171
  - [BmcApi::PublicNetworkConfiguration](docs/PublicNetworkConfiguration.md)
@@ -174,6 +178,7 @@ Class | Method | HTTP request | Description
174
178
  - [BmcApi::Server](docs/Server.md)
175
179
  - [BmcApi::ServerCreate](docs/ServerCreate.md)
176
180
  - [BmcApi::ServerIpBlock](docs/ServerIpBlock.md)
181
+ - [BmcApi::ServerNetworkUpdate](docs/ServerNetworkUpdate.md)
177
182
  - [BmcApi::ServerPatch](docs/ServerPatch.md)
178
183
  - [BmcApi::ServerPrivateNetwork](docs/ServerPrivateNetwork.md)
179
184
  - [BmcApi::ServerPublicNetwork](docs/ServerPublicNetwork.md)
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.3.0
1
+ 1.4.0
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **configuration_type** | **String** | Determines the approach for configuring IP blocks for the server being provisioned. If PURCHASE_NEW is selected, the smallest supported range, depending on the operating system, is allocated to the server. | [optional][default to 'PURCHASE_NEW'] |
7
+ | **configuration_type** | **String** | (Write-only) Determines the approach for configuring IP blocks for the server being provisioned. If PURCHASE_NEW is selected, the smallest supported range, depending on the operating system, is allocated to the server. | [optional][default to 'PURCHASE_NEW'] |
8
8
  | **ip_blocks** | [**Array<ServerIpBlock>**](ServerIpBlock.md) | Used to specify the previously purchased IP blocks to assign to this server upon provisioning. Used alongside the USER_DEFINED configurationType. | [optional] |
9
9
 
10
10
  ## Example
@@ -4,11 +4,13 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **netris_controller** | [**OsConfigurationNetrisController**](OsConfigurationNetrisController.md) | | [optional] |
8
+ | **netris_softgate** | [**OsConfigurationNetrisSoftgate**](OsConfigurationNetrisSoftgate.md) | | [optional] |
7
9
  | **windows** | [**OsConfigurationWindows**](OsConfigurationWindows.md) | | [optional] |
8
- | **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] |
9
- | **management_ui_url** | **String** | The URL of the management UI which will only be returned in response to provisioning a server. | [optional][readonly] |
10
+ | **root_password** | **String** | (Read-only) Auto-generated password set for user 'root' on an ESXi or Proxmox server.<br> The password is not stored and therefore will only be returned in response to provisioning a server. Copy and save it for future reference. | [optional][readonly] |
11
+ | **management_ui_url** | **String** | (Read-only) The URL of the management UI which will only be returned in response to provisioning a server. | [optional][readonly] |
10
12
  | **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] |
11
- | **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] |
13
+ | **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. Follow the <a href='https://phoenixnap.com/kb/bmc-custom-os' target='_blank'>instructions</a> on how to install custom OS on BMC. Only supported for ubuntu/focal and ubuntu/jammy. | [optional][default to false] |
12
14
  | **cloud_init** | [**OsConfigurationCloudInit**](OsConfigurationCloudInit.md) | | [optional] |
13
15
 
14
16
  ## Example
@@ -17,11 +19,13 @@
17
19
  require 'pnap_bmc_api'
18
20
 
19
21
  instance = BmcApi::OsConfiguration.new(
22
+ netris_controller: null,
23
+ netris_softgate: null,
20
24
  windows: null,
21
25
  root_password: MyP@ssw0rd_01,
22
26
  management_ui_url: https://172.217.22.14,
23
27
  management_access_allowed_ips: ["172.217.22.14","10.111.14.40/29","10.111.14.66 - 10.111.14.71"],
24
- install_os_to_ram: null,
28
+ install_os_to_ram: true,
25
29
  cloud_init: null
26
30
  )
27
31
  ```
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
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] |
8
- | **management_ui_url** | **String** | The URL of the management UI which will only be returned in response to provisioning a server. | [optional][readonly] |
7
+ | **root_password** | **String** | (Read-only) Password set for user root on an ESXi server which will only be returned in response to provisioning a server. | [optional][readonly] |
8
+ | **management_ui_url** | **String** | (Read-only) The URL of the management UI which will only be returned in response to provisioning a server. | [optional][readonly] |
9
9
  | **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] |
10
10
 
11
11
  ## Example
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **root_password** | **String** | Password set for user root on a Proxmox server which will only be returned in response to provisioning a server. | [optional][readonly] |
8
- | **management_ui_url** | **String** | The URL of the management UI which will only be returned in response to provisioning a server. | [optional][readonly] |
7
+ | **root_password** | **String** | (Read-only) Password set for user root on a Proxmox server which will only be returned in response to provisioning a server. | [optional][readonly] |
8
+ | **management_ui_url** | **String** | (Read-only) The URL of the management UI which will only be returned in response to provisioning a server. | [optional][readonly] |
9
9
  | **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] |
10
10
 
11
11
  ## Example
@@ -0,0 +1,22 @@
1
+ # BmcApi::OsConfigurationNetrisController
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **host_os** | **String** | (Read-only) Host OS on which the Netris Controller is installed. | [optional][readonly] |
8
+ | **netris_web_console_url** | **String** | (Read-only) The URL for the Netris Controller web console. Will only be returned in response to provisioning a server. | [optional][readonly] |
9
+ | **netris_user_password** | **String** | (Read-only) Auto-generated password set for user 'netris' in the web console.<br> The password is not stored and therefore will only be returned in response to provisioning a server. Copy and save it for future reference. | [optional][readonly] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'pnap_bmc_api'
15
+
16
+ instance = BmcApi::OsConfigurationNetrisController.new(
17
+ host_os: ubuntu/jammy,
18
+ netris_web_console_url: https://172.217.22.14,
19
+ netris_user_password: cNC1jPFXG2h7f
20
+ )
21
+ ```
22
+
@@ -0,0 +1,24 @@
1
+ # BmcApi::OsConfigurationNetrisSoftgate
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **host_os** | **String** | (Read-only) Host OS on which the Netris Softgate is installed. | [optional][readonly] |
8
+ | **controller_address** | **String** | (Write-only) IP address or hostname through which to reach the Netris Controller. | [optional] |
9
+ | **controller_version** | **String** | (Write-only) The version of the Netris Controller to connect to. | [optional] |
10
+ | **controller_auth_key** | **String** | (Write-only) The authentication key of the Netris Controller to connect to. Required for the softgate agent to be able to interact with the Netris Controller. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'pnap_bmc_api'
16
+
17
+ instance = BmcApi::OsConfigurationNetrisSoftgate.new(
18
+ host_os: ubuntu/jammy,
19
+ controller_address: 120.153.203.227,
20
+ controller_version: 3.4.0-003,
21
+ controller_auth_key: w0OP8TjZaHO17DTwxtN5VYh5Bh1ZVH2s3WK1JRTw
22
+ )
23
+ ```
24
+
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **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] |
8
- | **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'] |
8
+ | **configuration_type** | **String** | (Write-only) 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'] |
9
9
  | **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] |
10
10
 
11
11
  ## Example
data/docs/Server.md CHANGED
@@ -8,8 +8,8 @@
8
8
  | **status** | **String** | The status of the server. | |
9
9
  | **hostname** | **String** | Hostname of server. | |
10
10
  | **description** | **String** | Description of server. | [optional] |
11
- | **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`. | |
12
- | **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`. | |
11
+ | **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`, `proxmox/bullseye`, `netris/controller`, `netris/softgate_1g` or `netris/softgate_10g`. | |
12
+ | **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`, `d2.c4.storage.pliops1`, `d3.m4.xlarge`, `d3.m5.xlarge` or `d3.m6.xlarge`. | |
13
13
  | **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`. | |
14
14
  | **cpu** | **String** | A description of the machine CPU. | |
15
15
  | **cpu_count** | **Integer** | The number of CPUs available in the system. | |
@@ -21,7 +21,7 @@
21
21
  | **public_ip_addresses** | **Array<String>** | Public IP addresses assigned to server. | [optional] |
22
22
  | **reservation_id** | **String** | The reservation reference id if any. | [optional] |
23
23
  | **pricing_model** | **String** | The pricing model this server is being billed. Currently this field should be set to `HOURLY`, `ONE_MONTH_RESERVATION`, `TWELVE_MONTHS_RESERVATION`, `TWENTY_FOUR_MONTHS_RESERVATION` or `THIRTY_SIX_MONTHS_RESERVATION`. | [default to 'HOURLY'] |
24
- | **password** | **String** | Password set for user Admin on Windows server or user root on ESXi server which will only be returned in response to provisioning a server. | [optional] |
24
+ | **password** | **String** | Auto-generated password set for user `Admin` on Windows server, user `root` on ESXi servers, user `root` on Proxmox server and user `netris` on Netris servers.<br> The password is not stored and therefore will only be returned in response to provisioning a server. Copy and save it for future reference. | [optional] |
25
25
  | **network_type** | **String** | The type of network configuration for this server. Currently this field should be set to `PUBLIC_AND_PRIVATE` or `PRIVATE_ONLY`. | [optional][default to 'PUBLIC_AND_PRIVATE'] |
26
26
  | **cluster_id** | **String** | The cluster reference id if any. | [optional] |
27
27
  | **tags** | [**Array<TagAssignment>**](TagAssignment.md) | The tags assigned if any. | [optional] |
data/docs/ServerCreate.md CHANGED
@@ -6,8 +6,8 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **hostname** | **String** | Hostname of server. | |
8
8
  | **description** | **String** | Description of server. | [optional] |
9
- | **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`. | |
10
- | **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`. | |
9
+ | **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`, `proxmox/bullseye`, `netris/controller`, `netris/softgate_1g` or `netris/softgate_10g`. | |
10
+ | **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`, `d2.c4.storage.pliops1`, `d3.m4.xlarge`, `d3.m5.xlarge` or `d3.m6.xlarge`. | |
11
11
  | **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`. | |
12
12
  | **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] |
13
13
  | **ssh_keys** | **Array<String>** | A list of SSH keys that will be installed on the server. | [optional] |
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | The IP block's ID. | |
8
- | **vlan_id** | **Integer** | The VLAN on which this IP block has been configured within the network switch. | [optional][readonly] |
8
+ | **vlan_id** | **Integer** | (Read-only) The VLAN on which this IP block has been configured within the network switch. | [optional][readonly] |
9
9
 
10
10
  ## Example
11
11
 
@@ -0,0 +1,18 @@
1
+ # BmcApi::ServerNetworkUpdate
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **ips** | **Array<String>** | List of IPs to be associated to the server.<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. <li> Assign one or more IP addresses which are already configured on other resource(s) in network.</ul> | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'pnap_bmc_api'
13
+
14
+ instance = BmcApi::ServerNetworkUpdate.new(
15
+ ips: ["10.1.1.1","10.1.1.2"]
16
+ )
17
+ ```
18
+
@@ -7,7 +7,7 @@
7
7
  | **id** | **String** | The network identifier. | |
8
8
  | **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] |
9
9
  | **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] |
10
- | **status_description** | **String** | The status of the network. | [optional][readonly] |
10
+ | **status_description** | **String** | (Read-only) The status of the network. | [optional][readonly] |
11
11
 
12
12
  ## Example
13
13
 
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | The network identifier. | |
8
8
  | **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] |
9
- | **status_description** | **String** | The status of the assignment to the network. | [optional][readonly] |
9
+ | **status_description** | **String** | (Read-only) The status of the assignment to the network. | [optional][readonly] |
10
10
 
11
11
  ## Example
12
12
 
data/docs/ServersApi.md CHANGED
@@ -19,8 +19,10 @@ All URIs are relative to *https://api.phoenixnap.com/bmc/v1*
19
19
  | [**servers_server_id_ip_blocks_ip_block_id_delete**](ServersApi.md#servers_server_id_ip_blocks_ip_block_id_delete) | **DELETE** /servers/{serverId}/network-configuration/ip-block-configurations/ip-blocks/{ipBlockId} | Unassign IP Block from Server. |
20
20
  | [**servers_server_id_ip_blocks_post**](ServersApi.md#servers_server_id_ip_blocks_post) | **POST** /servers/{serverId}/network-configuration/ip-block-configurations/ip-blocks | Assign IP Block to Server. |
21
21
  | [**servers_server_id_patch**](ServersApi.md#servers_server_id_patch) | **PATCH** /servers/{serverId} | Patch a Server. |
22
+ | [**servers_server_id_private_networks_patch**](ServersApi.md#servers_server_id_private_networks_patch) | **PATCH** /servers/{serverId}/network-configuration/private-network-configuration/private-networks/{privateNetworkId} | Updates the server's private network's IP addresses |
22
23
  | [**servers_server_id_private_networks_post**](ServersApi.md#servers_server_id_private_networks_post) | **POST** /servers/{serverId}/network-configuration/private-network-configuration/private-networks | Adds the server to a private network. |
23
24
  | [**servers_server_id_public_networks_delete**](ServersApi.md#servers_server_id_public_networks_delete) | **DELETE** /servers/{serverId}/network-configuration/public-network-configuration/public-networks/{publicNetworkId} | Removes the server from the Public Network |
25
+ | [**servers_server_id_public_networks_patch**](ServersApi.md#servers_server_id_public_networks_patch) | **PATCH** /servers/{serverId}/network-configuration/public-network-configuration/public-networks/{publicNetworkId} | Updates the server's public network's IP addresses. |
24
26
  | [**servers_server_id_public_networks_post**](ServersApi.md#servers_server_id_public_networks_post) | **POST** /servers/{serverId}/network-configuration/public-network-configuration/public-networks | Adds the server to a Public Network. |
25
27
  | [**servers_server_id_tags_put**](ServersApi.md#servers_server_id_tags_put) | **PUT** /servers/{serverId}/tags | Overwrite tags assigned for Server. |
26
28
 
@@ -1094,6 +1096,83 @@ end
1094
1096
  - **Accept**: application/json
1095
1097
 
1096
1098
 
1099
+ ## servers_server_id_private_networks_patch
1100
+
1101
+ > <ServerPrivateNetwork> servers_server_id_private_networks_patch(server_id, private_network_id, opts)
1102
+
1103
+ Updates the server's private network's IP addresses
1104
+
1105
+ IP address changes intended to keep the BMC data up to date with server's operating system. We do not have access to the server's operating system and therefore manual configuration is required to apply the changes on the host. Knowledge base article to help you can be found <a href='https://phoenixnap.com/kb/bmc-server-management-via-api#ftoc-heading-6' target='_blank'>here</a>
1106
+
1107
+ ### Examples
1108
+
1109
+ ```ruby
1110
+ require 'time'
1111
+ require 'pnap_bmc_api'
1112
+ # setup authorization
1113
+ BmcApi.configure do |config|
1114
+ # Configure OAuth2 access token for authorization: OAuth2
1115
+ config.access_token = 'YOUR ACCESS TOKEN'
1116
+ end
1117
+
1118
+ api_instance = BmcApi::ServersApi.new
1119
+ server_id = 'e6afba51-7de8-4080-83ab-0f915570659c' # String | The server's ID.
1120
+ private_network_id = '603f3b2cfcaf050643b89a4b' # String | The private network identifier.
1121
+ opts = {
1122
+ 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.
1123
+ server_network_update: BmcApi::ServerNetworkUpdate.new # ServerNetworkUpdate |
1124
+ }
1125
+
1126
+ begin
1127
+ # Updates the server's private network's IP addresses
1128
+ result = api_instance.servers_server_id_private_networks_patch(server_id, private_network_id, opts)
1129
+ p result
1130
+ rescue BmcApi::ApiError => e
1131
+ puts "Error when calling ServersApi->servers_server_id_private_networks_patch: #{e}"
1132
+ end
1133
+ ```
1134
+
1135
+ #### Using the servers_server_id_private_networks_patch_with_http_info variant
1136
+
1137
+ This returns an Array which contains the response data, status code and headers.
1138
+
1139
+ > <Array(<ServerPrivateNetwork>, Integer, Hash)> servers_server_id_private_networks_patch_with_http_info(server_id, private_network_id, opts)
1140
+
1141
+ ```ruby
1142
+ begin
1143
+ # Updates the server's private network's IP addresses
1144
+ data, status_code, headers = api_instance.servers_server_id_private_networks_patch_with_http_info(server_id, private_network_id, opts)
1145
+ p status_code # => 2xx
1146
+ p headers # => { ... }
1147
+ p data # => <ServerPrivateNetwork>
1148
+ rescue BmcApi::ApiError => e
1149
+ puts "Error when calling ServersApi->servers_server_id_private_networks_patch_with_http_info: #{e}"
1150
+ end
1151
+ ```
1152
+
1153
+ ### Parameters
1154
+
1155
+ | Name | Type | Description | Notes |
1156
+ | ---- | ---- | ----------- | ----- |
1157
+ | **server_id** | **String** | The server&#39;s ID. | |
1158
+ | **private_network_id** | **String** | The private network identifier. | |
1159
+ | **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] |
1160
+ | **server_network_update** | [**ServerNetworkUpdate**](ServerNetworkUpdate.md) | | [optional] |
1161
+
1162
+ ### Return type
1163
+
1164
+ [**ServerPrivateNetwork**](ServerPrivateNetwork.md)
1165
+
1166
+ ### Authorization
1167
+
1168
+ [OAuth2](../README.md#OAuth2)
1169
+
1170
+ ### HTTP request headers
1171
+
1172
+ - **Content-Type**: application/json
1173
+ - **Accept**: application/json
1174
+
1175
+
1097
1176
  ## servers_server_id_private_networks_post
1098
1177
 
1099
1178
  > <ServerPrivateNetwork> servers_server_id_private_networks_post(server_id, opts)
@@ -1240,6 +1319,83 @@ end
1240
1319
  - **Accept**: application/json
1241
1320
 
1242
1321
 
1322
+ ## servers_server_id_public_networks_patch
1323
+
1324
+ > <ServerPublicNetwork> servers_server_id_public_networks_patch(server_id, public_network_id, opts)
1325
+
1326
+ Updates the server's public network's IP addresses.
1327
+
1328
+ IP address changes intended to keep the BMC data up to date with server's operating system. We do not have access to the server's operating system and therefore manual configuration is required to apply the changes on the host. Knowledge base article to help you can be found <a href='https://phoenixnap.com/kb/bmc-server-management-via-api#ftoc-heading-6' target='_blank'>here</a>
1329
+
1330
+ ### Examples
1331
+
1332
+ ```ruby
1333
+ require 'time'
1334
+ require 'pnap_bmc_api'
1335
+ # setup authorization
1336
+ BmcApi.configure do |config|
1337
+ # Configure OAuth2 access token for authorization: OAuth2
1338
+ config.access_token = 'YOUR ACCESS TOKEN'
1339
+ end
1340
+
1341
+ api_instance = BmcApi::ServersApi.new
1342
+ server_id = 'e6afba51-7de8-4080-83ab-0f915570659c' # String | The server's ID.
1343
+ public_network_id = '603f3b2cfcaf050643b89a4b' # String | The Public Network identifier.
1344
+ opts = {
1345
+ 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.
1346
+ server_network_update: BmcApi::ServerNetworkUpdate.new # ServerNetworkUpdate |
1347
+ }
1348
+
1349
+ begin
1350
+ # Updates the server's public network's IP addresses.
1351
+ result = api_instance.servers_server_id_public_networks_patch(server_id, public_network_id, opts)
1352
+ p result
1353
+ rescue BmcApi::ApiError => e
1354
+ puts "Error when calling ServersApi->servers_server_id_public_networks_patch: #{e}"
1355
+ end
1356
+ ```
1357
+
1358
+ #### Using the servers_server_id_public_networks_patch_with_http_info variant
1359
+
1360
+ This returns an Array which contains the response data, status code and headers.
1361
+
1362
+ > <Array(<ServerPublicNetwork>, Integer, Hash)> servers_server_id_public_networks_patch_with_http_info(server_id, public_network_id, opts)
1363
+
1364
+ ```ruby
1365
+ begin
1366
+ # Updates the server's public network's IP addresses.
1367
+ data, status_code, headers = api_instance.servers_server_id_public_networks_patch_with_http_info(server_id, public_network_id, opts)
1368
+ p status_code # => 2xx
1369
+ p headers # => { ... }
1370
+ p data # => <ServerPublicNetwork>
1371
+ rescue BmcApi::ApiError => e
1372
+ puts "Error when calling ServersApi->servers_server_id_public_networks_patch_with_http_info: #{e}"
1373
+ end
1374
+ ```
1375
+
1376
+ ### Parameters
1377
+
1378
+ | Name | Type | Description | Notes |
1379
+ | ---- | ---- | ----------- | ----- |
1380
+ | **server_id** | **String** | The server&#39;s ID. | |
1381
+ | **public_network_id** | **String** | The Public Network identifier. | |
1382
+ | **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] |
1383
+ | **server_network_update** | [**ServerNetworkUpdate**](ServerNetworkUpdate.md) | | [optional] |
1384
+
1385
+ ### Return type
1386
+
1387
+ [**ServerPublicNetwork**](ServerPublicNetwork.md)
1388
+
1389
+ ### Authorization
1390
+
1391
+ [OAuth2](../README.md#OAuth2)
1392
+
1393
+ ### HTTP request headers
1394
+
1395
+ - **Content-Type**: application/json
1396
+ - **Accept**: application/json
1397
+
1398
+
1243
1399
  ## servers_server_id_public_networks_post
1244
1400
 
1245
1401
  > <ServerPublicNetwork> servers_server_id_public_networks_post(server_id, opts)