pnap_bmc_api 2.2.2 → 2.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.
- checksums.yaml +4 -4
- data/README.md +6 -0
- data/VERSION +1 -1
- data/docs/IpBlocksConfiguration.md +1 -1
- data/docs/OsConfiguration.md +3 -1
- data/docs/OsConfigurationCloudInit.md +1 -1
- data/docs/OsConfigurationIPXE.md +20 -0
- data/docs/OsConfigurationIPXENativeVlanConfiguration.md +22 -0
- data/docs/OsConfigurationWindows.md +3 -1
- data/docs/PrivateNetworkConfiguration.md +1 -1
- data/docs/PublicNetworkConfiguration.md +1 -1
- data/docs/RebootRequest.md +20 -0
- data/docs/ReservationTransferDetails.md +18 -0
- data/docs/Server.md +4 -4
- data/docs/ServerCreate.md +3 -3
- data/docs/ServerNetworkUpdate.md +1 -1
- data/docs/ServerPrivateNetwork.md +3 -1
- data/docs/ServerProvision.md +1 -1
- data/docs/ServerPublicNetwork.md +5 -3
- data/docs/ServersApi.md +157 -7
- data/lib/pnap_bmc_api/api/quotas_api.rb +4 -4
- data/lib/pnap_bmc_api/api/servers_api.rb +182 -24
- data/lib/pnap_bmc_api/api/ssh_keys_api.rb +6 -6
- data/lib/pnap_bmc_api/api_client.rb +17 -14
- data/lib/pnap_bmc_api/api_error.rb +1 -1
- data/lib/pnap_bmc_api/api_model_base.rb +88 -0
- data/lib/pnap_bmc_api/configuration.rb +11 -1
- data/lib/pnap_bmc_api/models/action_result.rb +21 -78
- data/lib/pnap_bmc_api/models/delete_result.rb +31 -78
- data/lib/pnap_bmc_api/models/delete_ssh_key_result.rb +31 -78
- data/lib/pnap_bmc_api/models/error.rb +21 -78
- data/lib/pnap_bmc_api/models/esxi_datastore_configuration.rb +13 -80
- data/lib/pnap_bmc_api/models/esxi_os_configuration.rb +11 -78
- data/lib/pnap_bmc_api/models/gpu_configuration.rb +11 -78
- data/lib/pnap_bmc_api/models/ip_blocks_configuration.rb +12 -79
- data/lib/pnap_bmc_api/models/network_configuration.rb +11 -78
- data/lib/pnap_bmc_api/models/os_configuration.rb +24 -82
- data/lib/pnap_bmc_api/models/os_configuration_cloud_init.rb +11 -78
- data/lib/pnap_bmc_api/models/os_configuration_ipxe.rb +186 -0
- data/lib/pnap_bmc_api/models/os_configuration_ipxe_native_vlan_configuration.rb +224 -0
- data/lib/pnap_bmc_api/models/os_configuration_map.rb +11 -78
- data/lib/pnap_bmc_api/models/os_configuration_map_esxi.rb +11 -78
- data/lib/pnap_bmc_api/models/os_configuration_map_proxmox.rb +11 -78
- data/lib/pnap_bmc_api/models/os_configuration_netris_controller.rb +11 -78
- data/lib/pnap_bmc_api/models/os_configuration_netris_softgate.rb +11 -78
- data/lib/pnap_bmc_api/models/os_configuration_windows.rb +27 -82
- data/lib/pnap_bmc_api/models/private_network_configuration.rb +12 -79
- data/lib/pnap_bmc_api/models/public_network_configuration.rb +12 -79
- data/lib/pnap_bmc_api/models/quota.rb +61 -78
- data/lib/pnap_bmc_api/models/quota_edit_limit_request.rb +14 -81
- data/lib/pnap_bmc_api/models/quota_edit_limit_request_details.rb +25 -86
- data/lib/pnap_bmc_api/models/reboot_request.rb +212 -0
- data/lib/pnap_bmc_api/models/relinquish_ip_block.rb +11 -78
- data/lib/pnap_bmc_api/models/reservation_transfer_details.rb +166 -0
- data/lib/pnap_bmc_api/models/reset_result.rb +21 -78
- data/lib/pnap_bmc_api/models/server.rb +117 -84
- data/lib/pnap_bmc_api/models/server_create.rb +46 -83
- data/lib/pnap_bmc_api/models/server_ip_block.rb +21 -78
- data/lib/pnap_bmc_api/models/server_network_update.rb +12 -79
- data/lib/pnap_bmc_api/models/server_patch.rb +13 -80
- data/lib/pnap_bmc_api/models/server_private_network.rb +35 -82
- data/lib/pnap_bmc_api/models/server_provision.rb +24 -81
- data/lib/pnap_bmc_api/models/server_public_network.rb +53 -83
- data/lib/pnap_bmc_api/models/server_reserve.rb +21 -78
- data/lib/pnap_bmc_api/models/server_reset.rb +11 -78
- data/lib/pnap_bmc_api/models/ssh_key.rb +81 -78
- data/lib/pnap_bmc_api/models/ssh_key_create.rb +23 -80
- data/lib/pnap_bmc_api/models/ssh_key_update.rb +23 -80
- data/lib/pnap_bmc_api/models/storage_configuration.rb +11 -78
- data/lib/pnap_bmc_api/models/storage_configuration_root_partition.rb +11 -78
- data/lib/pnap_bmc_api/models/tag_assignment.rb +41 -78
- data/lib/pnap_bmc_api/models/tag_assignment_request.rb +21 -78
- data/lib/pnap_bmc_api/version.rb +1 -2
- data/lib/pnap_bmc_api.rb +6 -1
- data/pnap_bmc_api.gemspec +6 -6
- data/spec/api/quotas_api_spec.rb +1 -1
- data/spec/api/servers_api_spec.rb +29 -1
- data/spec/api/ssh_keys_api_spec.rb +1 -1
- data/spec/models/action_result_spec.rb +2 -2
- data/spec/models/delete_result_spec.rb +2 -2
- data/spec/models/delete_ssh_key_result_spec.rb +2 -2
- data/spec/models/error_spec.rb +2 -2
- data/spec/models/esxi_datastore_configuration_spec.rb +2 -2
- data/spec/models/esxi_os_configuration_spec.rb +2 -2
- data/spec/models/gpu_configuration_spec.rb +2 -2
- data/spec/models/ip_blocks_configuration_spec.rb +2 -2
- data/spec/models/network_configuration_spec.rb +2 -2
- data/spec/models/os_configuration_cloud_init_spec.rb +2 -2
- data/spec/models/os_configuration_ipxe_native_vlan_configuration_spec.rb +52 -0
- data/spec/models/os_configuration_ipxe_spec.rb +42 -0
- data/spec/models/os_configuration_map_esxi_spec.rb +2 -2
- data/spec/models/os_configuration_map_proxmox_spec.rb +2 -2
- data/spec/models/os_configuration_map_spec.rb +2 -2
- data/spec/models/os_configuration_netris_controller_spec.rb +2 -2
- data/spec/models/os_configuration_netris_softgate_spec.rb +2 -2
- data/spec/models/os_configuration_spec.rb +8 -2
- data/spec/models/os_configuration_windows_spec.rb +8 -2
- data/spec/models/private_network_configuration_spec.rb +2 -2
- data/spec/models/public_network_configuration_spec.rb +2 -2
- data/spec/models/quota_edit_limit_request_details_spec.rb +2 -2
- data/spec/models/quota_edit_limit_request_spec.rb +2 -2
- data/spec/models/quota_spec.rb +2 -2
- data/spec/models/reboot_request_spec.rb +46 -0
- data/spec/models/relinquish_ip_block_spec.rb +2 -2
- data/spec/models/reservation_transfer_details_spec.rb +36 -0
- data/spec/models/reset_result_spec.rb +2 -2
- data/spec/models/server_create_spec.rb +2 -2
- data/spec/models/server_ip_block_spec.rb +2 -2
- data/spec/models/server_network_update_spec.rb +2 -2
- data/spec/models/server_patch_spec.rb +2 -2
- data/spec/models/server_private_network_spec.rb +8 -2
- data/spec/models/server_provision_spec.rb +2 -2
- data/spec/models/server_public_network_spec.rb +8 -2
- data/spec/models/server_reserve_spec.rb +2 -2
- data/spec/models/server_reset_spec.rb +2 -2
- data/spec/models/server_spec.rb +2 -2
- data/spec/models/ssh_key_create_spec.rb +2 -2
- data/spec/models/ssh_key_spec.rb +2 -2
- data/spec/models/ssh_key_update_spec.rb +2 -2
- data/spec/models/storage_configuration_root_partition_spec.rb +2 -2
- data/spec/models/storage_configuration_spec.rb +2 -2
- data/spec/models/tag_assignment_request_spec.rb +2 -2
- data/spec/models/tag_assignment_spec.rb +2 -2
- data/spec/spec_helper.rb +1 -1
- metadata +60 -39
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c40d5754b80dd8b56a440afba771ed5b727537b77521e531830ba1debf83831f
|
|
4
|
+
data.tar.gz: b240c6e9af5f12bb693680368fd28a5ce9115084d2ae150775a21268480e15eb
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8936b33dadfb9f0ee3fd75da9423231871bb4b64363a7feb392c744719047b19438b59e46904c8091e6678d11bd013f4adf22e33f6bfb029ee4b92de5ba436bb
|
|
7
|
+
data.tar.gz: '086d24133b190f31d75f98e19670b58664f1643e1bd381a089a2a6118ea83153f05c6454e773723970459faf2a783be17669faf63ad7d0b2b216947865e1edb4'
|
data/README.md
CHANGED
|
@@ -141,10 +141,12 @@ Class | Method | HTTP request | Description
|
|
|
141
141
|
*BmcApi::ServersApi* | [**servers_server_id_actions_reserve_post**](docs/ServersApi.md#servers_server_id_actions_reserve_post) | **POST** /servers/{serverId}/actions/reserve | Reserve server.
|
|
142
142
|
*BmcApi::ServersApi* | [**servers_server_id_actions_reset_post**](docs/ServersApi.md#servers_server_id_actions_reset_post) | **POST** /servers/{serverId}/actions/reset | Reset server.
|
|
143
143
|
*BmcApi::ServersApi* | [**servers_server_id_actions_shutdown_post**](docs/ServersApi.md#servers_server_id_actions_shutdown_post) | **POST** /servers/{serverId}/actions/shutdown | Shutdown server.
|
|
144
|
+
*BmcApi::ServersApi* | [**servers_server_id_actions_transfer_reservation**](docs/ServersApi.md#servers_server_id_actions_transfer_reservation) | **POST** /servers/{serverId}/actions/transfer-reservation | Transfer server reservation.
|
|
144
145
|
*BmcApi::ServersApi* | [**servers_server_id_delete**](docs/ServersApi.md#servers_server_id_delete) | **DELETE** /servers/{serverId} | Delete server.
|
|
145
146
|
*BmcApi::ServersApi* | [**servers_server_id_get**](docs/ServersApi.md#servers_server_id_get) | **GET** /servers/{serverId} | Get server.
|
|
146
147
|
*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.
|
|
147
148
|
*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.
|
|
149
|
+
*BmcApi::ServersApi* | [**servers_server_id_os_configuration_ipxe_put**](docs/ServersApi.md#servers_server_id_os_configuration_ipxe_put) | **PUT** /servers/{serverId}/os-configuration/ipxe | Updates the iPXE OS configuration.
|
|
148
150
|
*BmcApi::ServersApi* | [**servers_server_id_patch**](docs/ServersApi.md#servers_server_id_patch) | **PATCH** /servers/{serverId} | Patch a Server.
|
|
149
151
|
*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
|
|
150
152
|
*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.
|
|
@@ -167,6 +169,8 @@ Class | Method | HTTP request | Description
|
|
|
167
169
|
- [BmcApi::NetworkConfiguration](docs/NetworkConfiguration.md)
|
|
168
170
|
- [BmcApi::OsConfiguration](docs/OsConfiguration.md)
|
|
169
171
|
- [BmcApi::OsConfigurationCloudInit](docs/OsConfigurationCloudInit.md)
|
|
172
|
+
- [BmcApi::OsConfigurationIPXE](docs/OsConfigurationIPXE.md)
|
|
173
|
+
- [BmcApi::OsConfigurationIPXENativeVlanConfiguration](docs/OsConfigurationIPXENativeVlanConfiguration.md)
|
|
170
174
|
- [BmcApi::OsConfigurationMap](docs/OsConfigurationMap.md)
|
|
171
175
|
- [BmcApi::OsConfigurationMapEsxi](docs/OsConfigurationMapEsxi.md)
|
|
172
176
|
- [BmcApi::OsConfigurationMapProxmox](docs/OsConfigurationMapProxmox.md)
|
|
@@ -178,7 +182,9 @@ Class | Method | HTTP request | Description
|
|
|
178
182
|
- [BmcApi::Quota](docs/Quota.md)
|
|
179
183
|
- [BmcApi::QuotaEditLimitRequest](docs/QuotaEditLimitRequest.md)
|
|
180
184
|
- [BmcApi::QuotaEditLimitRequestDetails](docs/QuotaEditLimitRequestDetails.md)
|
|
185
|
+
- [BmcApi::RebootRequest](docs/RebootRequest.md)
|
|
181
186
|
- [BmcApi::RelinquishIpBlock](docs/RelinquishIpBlock.md)
|
|
187
|
+
- [BmcApi::ReservationTransferDetails](docs/ReservationTransferDetails.md)
|
|
182
188
|
- [BmcApi::ResetResult](docs/ResetResult.md)
|
|
183
189
|
- [BmcApi::Server](docs/Server.md)
|
|
184
190
|
- [BmcApi::ServerCreate](docs/ServerCreate.md)
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
2.
|
|
1
|
+
2.4.0
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
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
|
-
| **ip_blocks** | [**Array<ServerIpBlock>**](ServerIpBlock.md) | Used
|
|
8
|
+
| **ip_blocks** | [**Array<ServerIpBlock>**](ServerIpBlock.md) | Used for specifying the previously purchased IPv4 blocks to assign to this server upon provisioning. Used alongside the USER_DEFINED configurationType. | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
data/docs/OsConfiguration.md
CHANGED
|
@@ -13,6 +13,7 @@
|
|
|
13
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] |
|
|
14
14
|
| **esxi** | [**EsxiOsConfiguration**](EsxiOsConfiguration.md) | | [optional] |
|
|
15
15
|
| **cloud_init** | [**OsConfigurationCloudInit**](OsConfigurationCloudInit.md) | | [optional] |
|
|
16
|
+
| **i_pxe** | [**OsConfigurationIPXE**](OsConfigurationIPXE.md) | | [optional] |
|
|
16
17
|
|
|
17
18
|
## Example
|
|
18
19
|
|
|
@@ -28,7 +29,8 @@ instance = BmcApi::OsConfiguration.new(
|
|
|
28
29
|
management_access_allowed_ips: ["172.217.22.14","10.111.14.40/29","10.111.14.66 - 10.111.14.71"],
|
|
29
30
|
install_os_to_ram: true,
|
|
30
31
|
esxi: null,
|
|
31
|
-
cloud_init: null
|
|
32
|
+
cloud_init: null,
|
|
33
|
+
i_pxe: null
|
|
32
34
|
)
|
|
33
35
|
```
|
|
34
36
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# BmcApi::OsConfigurationIPXE
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **url** | **String** | The URL of the iPXE boot script used to start the server. | |
|
|
8
|
+
| **native_vlan_configuration** | [**OsConfigurationIPXENativeVlanConfiguration**](OsConfigurationIPXENativeVlanConfiguration.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'pnap_bmc_api'
|
|
14
|
+
|
|
15
|
+
instance = BmcApi::OsConfigurationIPXE.new(
|
|
16
|
+
url: https://example.com/boot.ipxe,
|
|
17
|
+
native_vlan_configuration: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# BmcApi::OsConfigurationIPXENativeVlanConfiguration
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **vlan_id** | **Integer** | The VLAN ID of the network to be used as the native VLAN. The value must reference a public network with IP V4 block(s) or a public IP V4 block network to which the server is (or will be) attached. If omitted during provisioning, the native VLAN is matched to the configured/auto-purchased public IP V4 block. If no public IP block is available, a VLAN ID must be provided. The VLAN ID must belong to one of the public networks for any of the specified servers. During post-provisioning, if Native VLAN is omitted, the server will be configured with no native VLAN. If provided, the VLAN ID must be specified and must belong to any of the existing server public networks or IP block networks attached to the server. | [optional] |
|
|
8
|
+
| **static_dhcp_address_v4** | **String** | The static IP V4 address assigned to the server within the native VLAN. This address is set as the DHCP reservation and used for the iPXE boot process. Value must be an available/unused IP V4 address within the native network usable IP range. If omitted, the first available IP in the native network will be automatically assigned. Therefore, at least one IP must be available within the native network. | [optional] |
|
|
9
|
+
| **status** | **String** | (Read-only) The status of the native VLAN configuration. | [optional][readonly] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'pnap_bmc_api'
|
|
15
|
+
|
|
16
|
+
instance = BmcApi::OsConfigurationIPXENativeVlanConfiguration.new(
|
|
17
|
+
vlan_id: 10,
|
|
18
|
+
static_dhcp_address_v4: 185.74.213.56,
|
|
19
|
+
status: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **rdp_allowed_ips** | **Array<String>** | List of IPs allowed for RDP access to Windows OS. Supported in single IP, CIDR and range format. When undefined, RDP is disabled. To allow RDP access from any IP use 0.0.0.0/0. This will only be returned in response to provisioning a server. | [optional] |
|
|
8
|
+
| **bring_your_own_license** | **Boolean** | Use a Bring Your Own (BYO) Windows license. If true, the server is provisioned in trial mode, and you must activate your own license. If false (default), the server includes a managed Windows license billed by the platform. | [optional][default to false] |
|
|
8
9
|
|
|
9
10
|
## Example
|
|
10
11
|
|
|
@@ -12,7 +13,8 @@
|
|
|
12
13
|
require 'pnap_bmc_api'
|
|
13
14
|
|
|
14
15
|
instance = BmcApi::OsConfigurationWindows.new(
|
|
15
|
-
rdp_allowed_ips: ["172.217.22.14","10.111.14.40/29","10.111.14.66 - 10.111.14.71"]
|
|
16
|
+
rdp_allowed_ips: ["172.217.22.14","10.111.14.40/29","10.111.14.66 - 10.111.14.71"],
|
|
17
|
+
bring_your_own_license: false
|
|
16
18
|
)
|
|
17
19
|
```
|
|
18
20
|
|
|
@@ -6,7 +6,7 @@
|
|
|
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
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`, `USER_DEFINED` or `NONE`. | [optional][default to 'USE_OR_CREATE_DEFAULT'] |
|
|
9
|
-
| **private_networks** | [**Array<ServerPrivateNetwork>**](ServerPrivateNetwork.md) | The list of private networks this server
|
|
9
|
+
| **private_networks** | [**Array<ServerPrivateNetwork>**](ServerPrivateNetwork.md) | The list of private networks this server belongs to. If this field is part of a request body, it will be used for specifying the private networks to assign to this server upon provisioning. Used alongside the USER_DEFINED configurationType. | [optional] |
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **public_networks** | [**Array<ServerPublicNetwork>**](ServerPublicNetwork.md) | The list of public networks this server
|
|
7
|
+
| **public_networks** | [**Array<ServerPublicNetwork>**](ServerPublicNetwork.md) | The list of public networks this server belongs to. If this field is part of a request body, it will be used for specifying the public networks to assign to this server on provision. Only IPv4 addresses can be specified. | [optional] |
|
|
8
8
|
|
|
9
9
|
## Example
|
|
10
10
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# BmcApi::RebootRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **boot_type** | **String** | Specifies whether to boot via `IPXE` (requires script) or `STANDARD` (default mechanism, incompatible with `ipxeUrl`). | [optional][default to 'STANDARD'] |
|
|
8
|
+
| **ipxe_url** | **String** | The URL for the iPXE script, used only with `IPXE` boot type. If provided, it updates and replaces the existing stored URL; if not provided, the existing URL will be used. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'pnap_bmc_api'
|
|
14
|
+
|
|
15
|
+
instance = BmcApi::RebootRequest.new(
|
|
16
|
+
boot_type: null,
|
|
17
|
+
ipxe_url: https://example.com/boot.ipxe
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# BmcApi::ReservationTransferDetails
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **target_server_id** | **String** | ID of target server to transfer reservation to. | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'pnap_bmc_api'
|
|
13
|
+
|
|
14
|
+
instance = BmcApi::ReservationTransferDetails.new(
|
|
15
|
+
target_server_id: 54a21648dasda4s9843a17
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/Server.md
CHANGED
|
@@ -8,9 +8,9 @@
|
|
|
8
8
|
| **status** | **String** | The status of the server. Can have one of the following values: `creating` , `powered-on` , `powered-off` , `rebooting` , `resetting` , `deleting` , `reserved` , `error` or `reinstating`. | |
|
|
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`, `ubuntu/jammy+pytorch`, `ubuntu/noble`, `centos/centos7`, `centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `windows/srv2022std`, `windows/srv2022dc`, `windows/srv2025std`, `windows/srv2025dc`, `esxi/esxi70`, `esxi/esxi80`, `almalinux/almalinux8`, `rockylinux/rockylinux8`, `almalinux/almalinux9`, `rockylinux/rockylinux9`, `virtuozzo/virtuozzo7`, `oraclelinux/oraclelinux9`, `debian/bullseye`, `debian/bookworm`, `proxmox/bullseye`, `proxmox/proxmox8`, `netris/controller`, `netris/softgate_1g`, `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.
|
|
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`
|
|
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`, `ubuntu/jammy+pytorch`, `ubuntu/noble`, `centos/centos7`, `centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `windows/srv2022std`, `windows/srv2022dc`, `windows/srv2025std`, `windows/srv2025dc`, `esxi/esxi70`, `esxi/esxi80`, `almalinux/almalinux8`, `rockylinux/rockylinux8`, `almalinux/almalinux9`, `rockylinux/rockylinux9`, `virtuozzo/virtuozzo7`, `oraclelinux/oraclelinux9`, `debian/bullseye`, `debian/bookworm`, `debian/trixie`, `proxmox/bullseye`, `proxmox/proxmox8`, `proxmox/proxmox9`, `netris/controller`, `netris/softgate_1g`, `netris/softgate_10g` , `netris/softgate_25g` or `ipxe`. | [optional] |
|
|
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.c4.small`, `d1.c4.medium`, `d1.c4.large`, `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.xlarge`, `d2.m2.xxlarge`, `d2.m3.xlarge`, `d2.m4.xlarge`, `d2.m5.xlarge`, `d2.c4.db1.pliops1`, `d3.m4.xlarge`, `d3.m5.xlarge`, `d3.m6.xlarge`, `a1.c5.large`, `a1.c5.xlarge`, `d3.s5.xlarge`, `d3.m4.xxlarge`, `d3.m5.xxlarge`, `d3.m6.xxlarge`, `s3.c3.medium`, `s3.c3.large`, `d3.c4.medium`, `d3.c5.medium`, `d3.c6.medium`, `d3.c1.large`, `d3.c2.large`, `d3.c3.large`, `d3.m1.xlarge`, `d3.m2.xlarge`, `d3.m3.xlarge`, `d3.g2.c1.xlarge`, `d3.g2.c2.xlarge`, `d3.g2.c3.xlarge`, `d3.g3.c2.medium`, `s4.x6.c6.large`, `s4.x6.m6.xlarge`, `s5.x6.c3.medium`, `s5.x6.c3.large`, `s5.x6.c8.medium`, `s5.x6.c9.medium`, `s5.x6.c8.large`, `s5.x6.c9.large`, `s5.x6.m8.xlarge`, `s5.x6.m9.xlarge`, `s4.c3.medium`, `s4.c6.medium`, `s4.c6.large`, `s4.c6.xlarge`, `s4.s2.large`, `a2.c9.large` or `a2.c9.xlarge`. | |
|
|
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` or `SEA`. | |
|
|
14
14
|
| **cpu** | **String** | A description of the machine CPU. | |
|
|
15
15
|
| **cpu_count** | **Integer** | The number of CPUs available in the system. | |
|
|
16
16
|
| **cores_per_cpu** | **Integer** | The number of physical cores present on each CPU. | |
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
| **private_ip_addresses** | **Array<String>** | Private IP addresses assigned to server. | |
|
|
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
|
-
| **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 `
|
|
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`, `THIRTY_SIX_MONTHS_RESERVATION` or `CUSTOM_TERM_RESERVATION`. | [default to 'HOURLY'] |
|
|
24
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`, `PRIVATE_ONLY`, `PUBLIC_ONLY` or `NONE`. | [optional][default to 'PUBLIC_AND_PRIVATE'] |
|
|
26
26
|
| **cluster_id** | **String** | The cluster reference id if any. | [optional] |
|
data/docs/ServerCreate.md
CHANGED
|
@@ -6,9 +6,9 @@
|
|
|
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`, `ubuntu/jammy+pytorch`, `ubuntu/noble`, `centos/centos7`, `centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `windows/srv2022std`, `windows/srv2022dc`, `windows/srv2025std`, `windows/srv2025dc`, `esxi/esxi70`, `esxi/esxi80`, `almalinux/almalinux8`, `rockylinux/rockylinux8`, `almalinux/almalinux9`, `rockylinux/rockylinux9`, `virtuozzo/virtuozzo7`, `oraclelinux/oraclelinux9`, `debian/bullseye`, `debian/bookworm`, `proxmox/bullseye`, `proxmox/proxmox8`, `netris/controller`, `netris/softgate_1g`, `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.
|
|
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`
|
|
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`, `ubuntu/jammy+pytorch`, `ubuntu/noble`, `centos/centos7`, `centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `windows/srv2022std`, `windows/srv2022dc`, `windows/srv2025std`, `windows/srv2025dc`, `esxi/esxi70`, `esxi/esxi80`, `almalinux/almalinux8`, `rockylinux/rockylinux8`, `almalinux/almalinux9`, `rockylinux/rockylinux9`, `virtuozzo/virtuozzo7`, `oraclelinux/oraclelinux9`, `debian/bullseye`, `debian/bookworm`, `debian/trixie`, `proxmox/bullseye`, `proxmox/proxmox8`, `proxmox/proxmox9`, `netris/controller`, `netris/softgate_1g`, `netris/softgate_10g`, `netris/softgate_25g` or `ipxe`. | |
|
|
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.c4.small`, `d1.c4.medium`, `d1.c4.large`, `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.xlarge`, `d2.m2.xxlarge`, `d2.m3.xlarge`, `d2.m4.xlarge`, `d2.m5.xlarge`, `d2.c4.db1.pliops1`, `d3.m4.xlarge`, `d3.m5.xlarge`, `d3.m6.xlarge`, `a1.c5.large`, `a1.c5.xlarge`, `d3.s5.xlarge`, `d3.m4.xxlarge`, `d3.m5.xxlarge`, `d3.m6.xxlarge`, `s3.c3.medium`, `s3.c3.large`, `d3.c4.medium`, `d3.c5.medium`, `d3.c6.medium`, `d3.c1.large`, `d3.c2.large`, `d3.c3.large`, `d3.m1.xlarge`, `d3.m2.xlarge`, `d3.m3.xlarge`, `d3.g2.c1.xlarge`, `d3.g2.c2.xlarge`, `d3.g2.c3.xlarge`,`d3.g3.c2.medium`, `s4.x6.c6.large`, `s4.x6.m6.xlarge`, `s5.x6.c3.medium`, `s5.x6.c3.large`, `s5.x6.c8.medium`, `s5.x6.c9.medium`, `s5.x6.c8.large`, `s5.x6.c9.large`, `s5.x6.m8.xlarge`, `s5.x6.m9.xlarge`, `s4.c3.medium`, `s4.c6.medium`, `s4.c6.large`, `s4.c6.xlarge`, `s4.s2.large`, `a2.c9.large` or `a2.c9.xlarge`. | |
|
|
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` or `SEA`. | |
|
|
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] |
|
|
14
14
|
| **ssh_key_ids** | **Array<String>** | A list of SSH key IDs that will be installed on the server in addition to any SSH keys specified in this request. | [optional] |
|
data/docs/ServerNetworkUpdate.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **ips** | **Array<String>** | List of IPs to be associated to the server.<br> Valid IP formats include single IP addresses or IP ranges (IPv4 or IPv6). 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. <li> Assign one or more IP addresses which are already configured on other resource(s) in network. <li> Assign IP addresses which are considered as reserved in network.</ul> | [optional] |
|
|
7
|
+
| **ips** | **Array<String>** | List of IPs to be associated to the server.<br> Valid IP formats include single IP addresses or IP ranges (IPv4 or IPv6). 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. <li> Assign one or more IP addresses which are already configured on other resource(s) in network. <li> Assign IP addresses which are considered as reserved in network.</ul> | [optional] |
|
|
8
8
|
|
|
9
9
|
## Example
|
|
10
10
|
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
| **ips** | **Array<String>** | IPs to configure/configured on the server.<br> Valid IP formats are single IPv4 addresses or IPv4 ranges. IPs must be within the network's range. Should be null or empty list if DHCP is true. <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. <li> Assign IP addresses which are considered as reserved in network.</ul> | [optional] |
|
|
9
9
|
| **dhcp** | **Boolean** | Determines whether DHCP is enabled for this server.<br> The following restrictions apply when enabling DHCP:<ul> <li> DHCP support is limited to servers configured exclusively with private networks (PRIVATE_ONLY). <li> DHCP value needs to be consistent across all server-configured private networks. <li> The server does not support manual gateway address configuration. <li> Private IP addresses for network cannot be specified.</ul> Note: Not supported on Proxmox OS. | [optional][default to false] |
|
|
10
10
|
| **status_description** | **String** | (Read-only) The status of the network. | [optional][readonly] |
|
|
11
|
+
| **vlan_id** | **Integer** | (Read-only) The VLAN on which this network has been configured within the network switch. | [optional][readonly] |
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,7 +19,8 @@ instance = BmcApi::ServerPrivateNetwork.new(
|
|
|
18
19
|
id: 603f3b2cfcaf050643b89a4b,
|
|
19
20
|
ips: ["10.1.1.1","10.1.1.20 - 10.1.1.25"],
|
|
20
21
|
dhcp: false,
|
|
21
|
-
status_description: assigned
|
|
22
|
+
status_description: assigned,
|
|
23
|
+
vlan_id: 10
|
|
22
24
|
)
|
|
23
25
|
```
|
|
24
26
|
|
data/docs/ServerProvision.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
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`, `ubuntu/jammy+pytorch`, `ubuntu/noble`, `centos/centos7`, `centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `windows/srv2022std`, `windows/srv2022dc`, `windows/srv2025std`, `windows/srv2025dc`, `esxi/esxi70`, `esxi/esxi80`, `almalinux/almalinux8`, `almalinux/almalinux9`, `rockylinux/rockylinux8`, `rockylinux/rockylinux9`, `virtuozzo/virtuozzo7`, `oraclelinux/oraclelinux9`, `debian/bullseye`, `debian/bookworm`, `proxmox/bullseye`, `proxmox/proxmox8`, `netris/controller`, `netris/softgate_1g`, `netris/softgate_10g`
|
|
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`, `ubuntu/jammy+pytorch`, `ubuntu/noble`, `centos/centos7`, `centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `windows/srv2022std`, `windows/srv2022dc`, `windows/srv2025std`, `windows/srv2025dc`, `esxi/esxi70`, `esxi/esxi80`, `almalinux/almalinux8`, `almalinux/almalinux9`, `rockylinux/rockylinux8`, `rockylinux/rockylinux9`, `virtuozzo/virtuozzo7`, `oraclelinux/oraclelinux9`, `debian/bullseye`, `debian/bookworm`, `debian/trixie`, `proxmox/bullseye`, `proxmox/proxmox8`, `proxmox/proxmox9`,`netris/controller`, `netris/softgate_1g`, `netris/softgate_10g`, `netris/softgate_25g` or `ipxe`. | |
|
|
10
10
|
| **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] |
|
|
11
11
|
| **ssh_keys** | **Array<String>** | A list of SSH keys that will be installed on the server. | [optional] |
|
|
12
12
|
| **ssh_key_ids** | **Array<String>** | A list of SSH key IDs that will be installed on the server in addition to any SSH keys specified in this request. | [optional] |
|
data/docs/ServerPublicNetwork.md
CHANGED
|
@@ -5,9 +5,10 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | The network identifier. | |
|
|
8
|
-
| **ips** | **Array<String>** | Configurable/configured IPs on the server.<br> At least 1 IP address is required. Valid IP
|
|
8
|
+
| **ips** | **Array<String>** | Configurable/configured IPs on the server.<br> At least 1 IP address is required. Valid IP formats include single IP addresses or IP ranges (IPv4 or IPv6). All IPs must be within the network's range.<br> Setting the `computeSlaacIp` field to `true` allows you to provide an empty array of IPs.<br> Referencing network as OS native network allows you to provide an empty array of IPs.<br> Additionally, 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> | |
|
|
9
9
|
| **status_description** | **String** | (Read-only) The status of the assignment to the network. | [optional][readonly] |
|
|
10
10
|
| **compute_slaac_ip** | **Boolean** | (Write-only) Requests Stateless Address Autoconfiguration (SLAAC). Applicable for Network which contains IPv6 block(s). | [optional] |
|
|
11
|
+
| **vlan_id** | **Integer** | (Read-only) The VLAN on which this network has been configured within the network switch. | [optional][readonly] |
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -16,9 +17,10 @@ require 'pnap_bmc_api'
|
|
|
16
17
|
|
|
17
18
|
instance = BmcApi::ServerPublicNetwork.new(
|
|
18
19
|
id: 60473c2509268bc77fd06d29,
|
|
19
|
-
ips: ["182.16.0.146","2001:db8::b"],
|
|
20
|
+
ips: ["182.16.0.146","10.1.1.20 - 10.1.1.25","2001:db8::f","2001:db8::b - 2001:db8::d"],
|
|
20
21
|
status_description: assigned,
|
|
21
|
-
compute_slaac_ip: true
|
|
22
|
+
compute_slaac_ip: true,
|
|
23
|
+
vlan_id: 10
|
|
22
24
|
)
|
|
23
25
|
```
|
|
24
26
|
|
data/docs/ServersApi.md
CHANGED
|
@@ -15,10 +15,12 @@ All URIs are relative to *https://api.phoenixnap.com/bmc/v1*
|
|
|
15
15
|
| [**servers_server_id_actions_reserve_post**](ServersApi.md#servers_server_id_actions_reserve_post) | **POST** /servers/{serverId}/actions/reserve | Reserve server. |
|
|
16
16
|
| [**servers_server_id_actions_reset_post**](ServersApi.md#servers_server_id_actions_reset_post) | **POST** /servers/{serverId}/actions/reset | Reset server. |
|
|
17
17
|
| [**servers_server_id_actions_shutdown_post**](ServersApi.md#servers_server_id_actions_shutdown_post) | **POST** /servers/{serverId}/actions/shutdown | Shutdown server. |
|
|
18
|
+
| [**servers_server_id_actions_transfer_reservation**](ServersApi.md#servers_server_id_actions_transfer_reservation) | **POST** /servers/{serverId}/actions/transfer-reservation | Transfer server reservation. |
|
|
18
19
|
| [**servers_server_id_delete**](ServersApi.md#servers_server_id_delete) | **DELETE** /servers/{serverId} | Delete server. |
|
|
19
20
|
| [**servers_server_id_get**](ServersApi.md#servers_server_id_get) | **GET** /servers/{serverId} | Get server. |
|
|
20
21
|
| [**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. |
|
|
21
22
|
| [**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. |
|
|
23
|
+
| [**servers_server_id_os_configuration_ipxe_put**](ServersApi.md#servers_server_id_os_configuration_ipxe_put) | **PUT** /servers/{serverId}/os-configuration/ipxe | Updates the iPXE OS configuration. |
|
|
22
24
|
| [**servers_server_id_patch**](ServersApi.md#servers_server_id_patch) | **PATCH** /servers/{serverId} | Patch a Server. |
|
|
23
25
|
| [**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 |
|
|
24
26
|
| [**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. |
|
|
@@ -120,7 +122,8 @@ end
|
|
|
120
122
|
|
|
121
123
|
api_instance = BmcApi::ServersApi.new
|
|
122
124
|
opts = {
|
|
123
|
-
tag: ['inner_example'] # Array<String> | A list of query parameters related to tags in the form of tagName.tagValue
|
|
125
|
+
tag: ['inner_example'], # Array<String> | A list of query parameters related to tags in the form of tagName.tagValue
|
|
126
|
+
location: ['inner_example'] # Array<String> | Filters servers by server location
|
|
124
127
|
}
|
|
125
128
|
|
|
126
129
|
begin
|
|
@@ -155,6 +158,7 @@ end
|
|
|
155
158
|
| Name | Type | Description | Notes |
|
|
156
159
|
| ---- | ---- | ----------- | ----- |
|
|
157
160
|
| **tag** | [**Array<String>**](String.md) | A list of query parameters related to tags in the form of tagName.tagValue | [optional] |
|
|
161
|
+
| **location** | [**Array<String>**](String.md) | Filters servers by server location | [optional] |
|
|
158
162
|
|
|
159
163
|
### Return type
|
|
160
164
|
|
|
@@ -529,7 +533,7 @@ end
|
|
|
529
533
|
|
|
530
534
|
## servers_server_id_actions_reboot_post
|
|
531
535
|
|
|
532
|
-
> <ActionResult> servers_server_id_actions_reboot_post(server_id)
|
|
536
|
+
> <ActionResult> servers_server_id_actions_reboot_post(server_id, opts)
|
|
533
537
|
|
|
534
538
|
Reboot server.
|
|
535
539
|
|
|
@@ -548,10 +552,13 @@ end
|
|
|
548
552
|
|
|
549
553
|
api_instance = BmcApi::ServersApi.new
|
|
550
554
|
server_id = '60473a6115e34466c9f8f083' # String | The server's ID.
|
|
555
|
+
opts = {
|
|
556
|
+
reboot_request: BmcApi::RebootRequest.new # RebootRequest | Configuration option to specify the reboot type: STANDARD or IPXE (default: STANDARD).
|
|
557
|
+
}
|
|
551
558
|
|
|
552
559
|
begin
|
|
553
560
|
# Reboot server.
|
|
554
|
-
result = api_instance.servers_server_id_actions_reboot_post(server_id)
|
|
561
|
+
result = api_instance.servers_server_id_actions_reboot_post(server_id, opts)
|
|
555
562
|
p result
|
|
556
563
|
rescue BmcApi::ApiError => e
|
|
557
564
|
puts "Error when calling ServersApi->servers_server_id_actions_reboot_post: #{e}"
|
|
@@ -562,12 +569,12 @@ end
|
|
|
562
569
|
|
|
563
570
|
This returns an Array which contains the response data, status code and headers.
|
|
564
571
|
|
|
565
|
-
> <Array(<ActionResult>, Integer, Hash)> servers_server_id_actions_reboot_post_with_http_info(server_id)
|
|
572
|
+
> <Array(<ActionResult>, Integer, Hash)> servers_server_id_actions_reboot_post_with_http_info(server_id, opts)
|
|
566
573
|
|
|
567
574
|
```ruby
|
|
568
575
|
begin
|
|
569
576
|
# Reboot server.
|
|
570
|
-
data, status_code, headers = api_instance.servers_server_id_actions_reboot_post_with_http_info(server_id)
|
|
577
|
+
data, status_code, headers = api_instance.servers_server_id_actions_reboot_post_with_http_info(server_id, opts)
|
|
571
578
|
p status_code # => 2xx
|
|
572
579
|
p headers # => { ... }
|
|
573
580
|
p data # => <ActionResult>
|
|
@@ -581,6 +588,7 @@ end
|
|
|
581
588
|
| Name | Type | Description | Notes |
|
|
582
589
|
| ---- | ---- | ----------- | ----- |
|
|
583
590
|
| **server_id** | **String** | The server's ID. | |
|
|
591
|
+
| **reboot_request** | [**RebootRequest**](RebootRequest.md) | Configuration option to specify the reboot type: STANDARD or IPXE (default: STANDARD). | [optional] |
|
|
584
592
|
|
|
585
593
|
### Return type
|
|
586
594
|
|
|
@@ -592,7 +600,7 @@ end
|
|
|
592
600
|
|
|
593
601
|
### HTTP request headers
|
|
594
602
|
|
|
595
|
-
- **Content-Type**:
|
|
603
|
+
- **Content-Type**: application/json
|
|
596
604
|
- **Accept**: application/json
|
|
597
605
|
|
|
598
606
|
|
|
@@ -807,6 +815,77 @@ end
|
|
|
807
815
|
- **Accept**: application/json
|
|
808
816
|
|
|
809
817
|
|
|
818
|
+
## servers_server_id_actions_transfer_reservation
|
|
819
|
+
|
|
820
|
+
> <Server> servers_server_id_actions_transfer_reservation(server_id, reservation_transfer_details)
|
|
821
|
+
|
|
822
|
+
Transfer server reservation.
|
|
823
|
+
|
|
824
|
+
Transfer server reservation. An active (READY) reservation can be transferred from a server in ERROR or RESERVED status to another HOURLY provisioned server of the same location and type.
|
|
825
|
+
|
|
826
|
+
### Examples
|
|
827
|
+
|
|
828
|
+
```ruby
|
|
829
|
+
require 'time'
|
|
830
|
+
require 'pnap_bmc_api'
|
|
831
|
+
# setup authorization
|
|
832
|
+
BmcApi.configure do |config|
|
|
833
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
834
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
835
|
+
end
|
|
836
|
+
|
|
837
|
+
api_instance = BmcApi::ServersApi.new
|
|
838
|
+
server_id = '60473a6115e34466c9f8f083' # String | The server's ID.
|
|
839
|
+
reservation_transfer_details = BmcApi::ReservationTransferDetails.new({target_server_id: '54a21648dasda4s9843a17'}) # ReservationTransferDetails |
|
|
840
|
+
|
|
841
|
+
begin
|
|
842
|
+
# Transfer server reservation.
|
|
843
|
+
result = api_instance.servers_server_id_actions_transfer_reservation(server_id, reservation_transfer_details)
|
|
844
|
+
p result
|
|
845
|
+
rescue BmcApi::ApiError => e
|
|
846
|
+
puts "Error when calling ServersApi->servers_server_id_actions_transfer_reservation: #{e}"
|
|
847
|
+
end
|
|
848
|
+
```
|
|
849
|
+
|
|
850
|
+
#### Using the servers_server_id_actions_transfer_reservation_with_http_info variant
|
|
851
|
+
|
|
852
|
+
This returns an Array which contains the response data, status code and headers.
|
|
853
|
+
|
|
854
|
+
> <Array(<Server>, Integer, Hash)> servers_server_id_actions_transfer_reservation_with_http_info(server_id, reservation_transfer_details)
|
|
855
|
+
|
|
856
|
+
```ruby
|
|
857
|
+
begin
|
|
858
|
+
# Transfer server reservation.
|
|
859
|
+
data, status_code, headers = api_instance.servers_server_id_actions_transfer_reservation_with_http_info(server_id, reservation_transfer_details)
|
|
860
|
+
p status_code # => 2xx
|
|
861
|
+
p headers # => { ... }
|
|
862
|
+
p data # => <Server>
|
|
863
|
+
rescue BmcApi::ApiError => e
|
|
864
|
+
puts "Error when calling ServersApi->servers_server_id_actions_transfer_reservation_with_http_info: #{e}"
|
|
865
|
+
end
|
|
866
|
+
```
|
|
867
|
+
|
|
868
|
+
### Parameters
|
|
869
|
+
|
|
870
|
+
| Name | Type | Description | Notes |
|
|
871
|
+
| ---- | ---- | ----------- | ----- |
|
|
872
|
+
| **server_id** | **String** | The server's ID. | |
|
|
873
|
+
| **reservation_transfer_details** | [**ReservationTransferDetails**](ReservationTransferDetails.md) | | |
|
|
874
|
+
|
|
875
|
+
### Return type
|
|
876
|
+
|
|
877
|
+
[**Server**](Server.md)
|
|
878
|
+
|
|
879
|
+
### Authorization
|
|
880
|
+
|
|
881
|
+
[OAuth2](../README.md#OAuth2)
|
|
882
|
+
|
|
883
|
+
### HTTP request headers
|
|
884
|
+
|
|
885
|
+
- **Content-Type**: application/json
|
|
886
|
+
- **Accept**: application/json
|
|
887
|
+
|
|
888
|
+
|
|
810
889
|
## servers_server_id_delete
|
|
811
890
|
|
|
812
891
|
> <DeleteResult> servers_server_id_delete(server_id)
|
|
@@ -1089,6 +1168,77 @@ end
|
|
|
1089
1168
|
- **Accept**: application/json
|
|
1090
1169
|
|
|
1091
1170
|
|
|
1171
|
+
## servers_server_id_os_configuration_ipxe_put
|
|
1172
|
+
|
|
1173
|
+
> <OsConfigurationIPXE> servers_server_id_os_configuration_ipxe_put(server_id, os_configuration_ipxe)
|
|
1174
|
+
|
|
1175
|
+
Updates the iPXE OS configuration.
|
|
1176
|
+
|
|
1177
|
+
Updates the iPXE OS configuration by updating the URL and the native VLAN configuration.
|
|
1178
|
+
|
|
1179
|
+
### Examples
|
|
1180
|
+
|
|
1181
|
+
```ruby
|
|
1182
|
+
require 'time'
|
|
1183
|
+
require 'pnap_bmc_api'
|
|
1184
|
+
# setup authorization
|
|
1185
|
+
BmcApi.configure do |config|
|
|
1186
|
+
# Configure OAuth2 access token for authorization: OAuth2
|
|
1187
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1188
|
+
end
|
|
1189
|
+
|
|
1190
|
+
api_instance = BmcApi::ServersApi.new
|
|
1191
|
+
server_id = '60473a6115e34466c9f8f083' # String | The server's ID.
|
|
1192
|
+
os_configuration_ipxe = BmcApi::OsConfigurationIPXE.new({url: 'https://example.com/boot.ipxe'}) # OsConfigurationIPXE |
|
|
1193
|
+
|
|
1194
|
+
begin
|
|
1195
|
+
# Updates the iPXE OS configuration.
|
|
1196
|
+
result = api_instance.servers_server_id_os_configuration_ipxe_put(server_id, os_configuration_ipxe)
|
|
1197
|
+
p result
|
|
1198
|
+
rescue BmcApi::ApiError => e
|
|
1199
|
+
puts "Error when calling ServersApi->servers_server_id_os_configuration_ipxe_put: #{e}"
|
|
1200
|
+
end
|
|
1201
|
+
```
|
|
1202
|
+
|
|
1203
|
+
#### Using the servers_server_id_os_configuration_ipxe_put_with_http_info variant
|
|
1204
|
+
|
|
1205
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1206
|
+
|
|
1207
|
+
> <Array(<OsConfigurationIPXE>, Integer, Hash)> servers_server_id_os_configuration_ipxe_put_with_http_info(server_id, os_configuration_ipxe)
|
|
1208
|
+
|
|
1209
|
+
```ruby
|
|
1210
|
+
begin
|
|
1211
|
+
# Updates the iPXE OS configuration.
|
|
1212
|
+
data, status_code, headers = api_instance.servers_server_id_os_configuration_ipxe_put_with_http_info(server_id, os_configuration_ipxe)
|
|
1213
|
+
p status_code # => 2xx
|
|
1214
|
+
p headers # => { ... }
|
|
1215
|
+
p data # => <OsConfigurationIPXE>
|
|
1216
|
+
rescue BmcApi::ApiError => e
|
|
1217
|
+
puts "Error when calling ServersApi->servers_server_id_os_configuration_ipxe_put_with_http_info: #{e}"
|
|
1218
|
+
end
|
|
1219
|
+
```
|
|
1220
|
+
|
|
1221
|
+
### Parameters
|
|
1222
|
+
|
|
1223
|
+
| Name | Type | Description | Notes |
|
|
1224
|
+
| ---- | ---- | ----------- | ----- |
|
|
1225
|
+
| **server_id** | **String** | The server's ID. | |
|
|
1226
|
+
| **os_configuration_ipxe** | [**OsConfigurationIPXE**](OsConfigurationIPXE.md) | | |
|
|
1227
|
+
|
|
1228
|
+
### Return type
|
|
1229
|
+
|
|
1230
|
+
[**OsConfigurationIPXE**](OsConfigurationIPXE.md)
|
|
1231
|
+
|
|
1232
|
+
### Authorization
|
|
1233
|
+
|
|
1234
|
+
[OAuth2](../README.md#OAuth2)
|
|
1235
|
+
|
|
1236
|
+
### HTTP request headers
|
|
1237
|
+
|
|
1238
|
+
- **Content-Type**: application/json
|
|
1239
|
+
- **Accept**: application/json
|
|
1240
|
+
|
|
1241
|
+
|
|
1092
1242
|
## servers_server_id_patch
|
|
1093
1243
|
|
|
1094
1244
|
> <Server> servers_server_id_patch(server_id, server_patch)
|
|
@@ -1481,7 +1631,7 @@ end
|
|
|
1481
1631
|
|
|
1482
1632
|
api_instance = BmcApi::ServersApi.new
|
|
1483
1633
|
server_id = '60473a6115e34466c9f8f083' # String | The server's ID.
|
|
1484
|
-
server_public_network = BmcApi::ServerPublicNetwork.new({id: '60473c2509268bc77fd06d29'}) # ServerPublicNetwork |
|
|
1634
|
+
server_public_network = BmcApi::ServerPublicNetwork.new({id: '60473c2509268bc77fd06d29', ips: ["182.16.0.146", "10.1.1.20 - 10.1.1.25", "2001: db8: : f", "2001: db8: : b - 2001: db8: : d"]}) # ServerPublicNetwork |
|
|
1485
1635
|
opts = {
|
|
1486
1636
|
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.
|
|
1487
1637
|
}
|