pnap_bmc_api 1.1.1 → 1.3.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 +1 -0
- data/VERSION +1 -1
- data/docs/NetworkConfiguration.md +1 -1
- data/docs/OsConfiguration.md +4 -2
- data/docs/OsConfigurationCloudInit.md +18 -0
- data/docs/PrivateNetworkConfiguration.md +1 -1
- data/docs/Server.md +1 -1
- data/docs/ServerCreate.md +1 -1
- data/docs/ServerPrivateNetwork.md +2 -2
- data/docs/ServerPublicNetwork.md +1 -1
- data/docs/ServersApi.md +8 -2
- data/lib/pnap_bmc_api/api/servers_api.rb +11 -2
- data/lib/pnap_bmc_api/models/network_configuration.rb +1 -1
- data/lib/pnap_bmc_api/models/os_configuration.rb +14 -5
- data/lib/pnap_bmc_api/models/os_configuration_cloud_init.rb +221 -0
- data/lib/pnap_bmc_api/models/private_network_configuration.rb +1 -1
- data/lib/pnap_bmc_api/models/server.rb +1 -1
- data/lib/pnap_bmc_api/models/server_create.rb +1 -1
- data/lib/pnap_bmc_api/models/server_private_network.rb +2 -2
- data/lib/pnap_bmc_api/models/server_public_network.rb +1 -25
- data/lib/pnap_bmc_api.rb +1 -0
- data/spec/models/os_configuration_cloud_init_spec.rb +34 -0
- metadata +32 -28
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: aa4d1bec07d68b4f7508fa1745002c2d5fb9d2b4dbe18c27f6910bbfbec95777
|
4
|
+
data.tar.gz: 3ec5e3c0b99597bba369f7524ce2ab219b069bcdac66f6bddc440b22366f136a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b4ebda75738a7a72d220501bf3b3f897717c97e0d30f6292047a6b464308062681d2d79f601d16d205b71f7f5b16cdc269df939134c7570201630dbaa84f4f70
|
7
|
+
data.tar.gz: 7e6b1ba8cf1473638d269b5f15069bec6207b952197b258ee3dfdce4c5f4fb6809c647c887879d72cdd4dbf43395a80c83ddec444cd1067999c830cbf03ffe77
|
data/README.md
CHANGED
@@ -158,6 +158,7 @@ Class | Method | HTTP request | Description
|
|
158
158
|
- [BmcApi::IpBlocksConfiguration](docs/IpBlocksConfiguration.md)
|
159
159
|
- [BmcApi::NetworkConfiguration](docs/NetworkConfiguration.md)
|
160
160
|
- [BmcApi::OsConfiguration](docs/OsConfiguration.md)
|
161
|
+
- [BmcApi::OsConfigurationCloudInit](docs/OsConfigurationCloudInit.md)
|
161
162
|
- [BmcApi::OsConfigurationMap](docs/OsConfigurationMap.md)
|
162
163
|
- [BmcApi::OsConfigurationMapEsxi](docs/OsConfigurationMapEsxi.md)
|
163
164
|
- [BmcApi::OsConfigurationMapProxmox](docs/OsConfigurationMapProxmox.md)
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.3.0
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **gateway_address** | **String** | The address of the gateway assigned / to assign to the server
|
7
|
+
| **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] |
|
8
8
|
| **private_network_configuration** | [**PrivateNetworkConfiguration**](PrivateNetworkConfiguration.md) | | [optional] |
|
9
9
|
| **ip_blocks_configuration** | [**IpBlocksConfiguration**](IpBlocksConfiguration.md) | | [optional] |
|
10
10
|
| **public_network_configuration** | [**PublicNetworkConfiguration**](PublicNetworkConfiguration.md) | | [optional] |
|
data/docs/OsConfiguration.md
CHANGED
@@ -8,7 +8,8 @@
|
|
8
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
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
10
|
| **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. | [optional][default to false] |
|
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] |
|
12
|
+
| **cloud_init** | [**OsConfigurationCloudInit**](OsConfigurationCloudInit.md) | | [optional] |
|
12
13
|
|
13
14
|
## Example
|
14
15
|
|
@@ -20,7 +21,8 @@ instance = BmcApi::OsConfiguration.new(
|
|
20
21
|
root_password: MyP@ssw0rd_01,
|
21
22
|
management_ui_url: https://172.217.22.14,
|
22
23
|
management_access_allowed_ips: ["172.217.22.14","10.111.14.40/29","10.111.14.66 - 10.111.14.71"],
|
23
|
-
install_os_to_ram: null
|
24
|
+
install_os_to_ram: null,
|
25
|
+
cloud_init: null
|
24
26
|
)
|
25
27
|
```
|
26
28
|
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# BmcApi::OsConfigurationCloudInit
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **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] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'pnap_bmc_api'
|
13
|
+
|
14
|
+
instance = BmcApi::OsConfigurationCloudInit.new(
|
15
|
+
user_data: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **gateway_address** | **String** | The address of the gateway assigned / to assign to the server
|
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** | 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
|
|
data/docs/Server.md
CHANGED
@@ -8,7 +8,7 @@
|
|
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`, `centos/centos7`, `centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `esxi/
|
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
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`. | |
|
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. | |
|
data/docs/ServerCreate.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`, `centos/centos7`,`centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `esxi/
|
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
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`. | |
|
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] |
|
@@ -5,8 +5,8 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | The network identifier. | |
|
8
|
-
| **ips** | **Array<String>** | IPs to configure/configured on the server
|
9
|
-
| **dhcp** | **Boolean** | Determines whether DHCP is enabled for this server. Should be false if
|
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
|
+
| **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
10
|
| **status_description** | **String** | The status of the network. | [optional][readonly] |
|
11
11
|
|
12
12
|
## Example
|
data/docs/ServerPublicNetwork.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | The network identifier. | |
|
8
|
-
| **ips** | **Array<String>** |
|
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
9
|
| **status_description** | **String** | The status of the assignment to the network. | [optional][readonly] |
|
10
10
|
|
11
11
|
## Example
|
data/docs/ServersApi.md
CHANGED
@@ -188,6 +188,7 @@ end
|
|
188
188
|
|
189
189
|
api_instance = BmcApi::ServersApi.new
|
190
190
|
opts = {
|
191
|
+
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.
|
191
192
|
server_create: BmcApi::ServerCreate.new({hostname: 'my-server-1', os: 'ubuntu/bionic', type: 's1.c1.small', location: 'PHX'}) # ServerCreate |
|
192
193
|
}
|
193
194
|
|
@@ -222,6 +223,7 @@ end
|
|
222
223
|
|
223
224
|
| Name | Type | Description | Notes |
|
224
225
|
| ---- | ---- | ----------- | ----- |
|
226
|
+
| **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] |
|
225
227
|
| **server_create** | [**ServerCreate**](ServerCreate.md) | | [optional] |
|
226
228
|
|
227
229
|
### Return type
|
@@ -1098,7 +1100,7 @@ end
|
|
1098
1100
|
|
1099
1101
|
Adds the server to a private network.
|
1100
1102
|
|
1101
|
-
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.
|
1103
|
+
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>.
|
1102
1104
|
|
1103
1105
|
### Examples
|
1104
1106
|
|
@@ -1114,6 +1116,7 @@ end
|
|
1114
1116
|
api_instance = BmcApi::ServersApi.new
|
1115
1117
|
server_id = 'e6afba51-7de8-4080-83ab-0f915570659c' # String | The server's ID.
|
1116
1118
|
opts = {
|
1119
|
+
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.
|
1117
1120
|
server_private_network: BmcApi::ServerPrivateNetwork.new({id: '603f3b2cfcaf050643b89a4b'}) # ServerPrivateNetwork |
|
1118
1121
|
}
|
1119
1122
|
|
@@ -1149,6 +1152,7 @@ end
|
|
1149
1152
|
| Name | Type | Description | Notes |
|
1150
1153
|
| ---- | ---- | ----------- | ----- |
|
1151
1154
|
| **server_id** | **String** | The server's ID. | |
|
1155
|
+
| **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] |
|
1152
1156
|
| **server_private_network** | [**ServerPrivateNetwork**](ServerPrivateNetwork.md) | | [optional] |
|
1153
1157
|
|
1154
1158
|
### Return type
|
@@ -1258,7 +1262,8 @@ end
|
|
1258
1262
|
api_instance = BmcApi::ServersApi.new
|
1259
1263
|
server_id = 'e6afba51-7de8-4080-83ab-0f915570659c' # String | The server's ID.
|
1260
1264
|
opts = {
|
1261
|
-
|
1265
|
+
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.
|
1266
|
+
server_public_network: BmcApi::ServerPublicNetwork.new({id: '60473c2509268bc77fd06d29'}) # ServerPublicNetwork |
|
1262
1267
|
}
|
1263
1268
|
|
1264
1269
|
begin
|
@@ -1293,6 +1298,7 @@ end
|
|
1293
1298
|
| Name | Type | Description | Notes |
|
1294
1299
|
| ---- | ---- | ----------- | ----- |
|
1295
1300
|
| **server_id** | **String** | The server's ID. | |
|
1301
|
+
| **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] |
|
1296
1302
|
| **server_public_network** | [**ServerPublicNetwork**](ServerPublicNetwork.md) | | [optional] |
|
1297
1303
|
|
1298
1304
|
### Return type
|
@@ -151,6 +151,7 @@ module BmcApi
|
|
151
151
|
# Create new server.
|
152
152
|
# Create (request) new server for account. Server DNS will be configured to access Google's public DNS at 8.8.8.8 .
|
153
153
|
# @param [Hash] opts the optional parameters
|
154
|
+
# @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)
|
154
155
|
# @option opts [ServerCreate] :server_create
|
155
156
|
# @return [Server]
|
156
157
|
def servers_post(opts = {})
|
@@ -161,6 +162,7 @@ module BmcApi
|
|
161
162
|
# Create new server.
|
162
163
|
# Create (request) new server for account. Server DNS will be configured to access Google's public DNS at 8.8.8.8 .
|
163
164
|
# @param [Hash] opts the optional parameters
|
165
|
+
# @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)
|
164
166
|
# @option opts [ServerCreate] :server_create
|
165
167
|
# @return [Array<(Server, Integer, Hash)>] Server data, response status code and response headers
|
166
168
|
def servers_post_with_http_info(opts = {})
|
@@ -172,6 +174,7 @@ module BmcApi
|
|
172
174
|
|
173
175
|
# query parameters
|
174
176
|
query_params = opts[:query_params] || {}
|
177
|
+
query_params[:'force'] = opts[:'force'] if !opts[:'force'].nil?
|
175
178
|
|
176
179
|
# header parameters
|
177
180
|
header_params = opts[:header_params] || {}
|
@@ -1017,9 +1020,10 @@ module BmcApi
|
|
1017
1020
|
end
|
1018
1021
|
|
1019
1022
|
# Adds the server to a private network.
|
1020
|
-
# 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.
|
1023
|
+
# 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>.
|
1021
1024
|
# @param server_id [String] The server's ID.
|
1022
1025
|
# @param [Hash] opts the optional parameters
|
1026
|
+
# @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)
|
1023
1027
|
# @option opts [ServerPrivateNetwork] :server_private_network
|
1024
1028
|
# @return [ServerPrivateNetwork]
|
1025
1029
|
def servers_server_id_private_networks_post(server_id, opts = {})
|
@@ -1028,9 +1032,10 @@ module BmcApi
|
|
1028
1032
|
end
|
1029
1033
|
|
1030
1034
|
# Adds the server to a private network.
|
1031
|
-
# 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.
|
1035
|
+
# 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>.
|
1032
1036
|
# @param server_id [String] The server's ID.
|
1033
1037
|
# @param [Hash] opts the optional parameters
|
1038
|
+
# @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)
|
1034
1039
|
# @option opts [ServerPrivateNetwork] :server_private_network
|
1035
1040
|
# @return [Array<(ServerPrivateNetwork, Integer, Hash)>] ServerPrivateNetwork data, response status code and response headers
|
1036
1041
|
def servers_server_id_private_networks_post_with_http_info(server_id, opts = {})
|
@@ -1046,6 +1051,7 @@ module BmcApi
|
|
1046
1051
|
|
1047
1052
|
# query parameters
|
1048
1053
|
query_params = opts[:query_params] || {}
|
1054
|
+
query_params[:'force'] = opts[:'force'] if !opts[:'force'].nil?
|
1049
1055
|
|
1050
1056
|
# header parameters
|
1051
1057
|
header_params = opts[:header_params] || {}
|
@@ -1159,6 +1165,7 @@ module BmcApi
|
|
1159
1165
|
# 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>.
|
1160
1166
|
# @param server_id [String] The server's ID.
|
1161
1167
|
# @param [Hash] opts the optional parameters
|
1168
|
+
# @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)
|
1162
1169
|
# @option opts [ServerPublicNetwork] :server_public_network
|
1163
1170
|
# @return [ServerPublicNetwork]
|
1164
1171
|
def servers_server_id_public_networks_post(server_id, opts = {})
|
@@ -1170,6 +1177,7 @@ module BmcApi
|
|
1170
1177
|
# 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>.
|
1171
1178
|
# @param server_id [String] The server's ID.
|
1172
1179
|
# @param [Hash] opts the optional parameters
|
1180
|
+
# @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)
|
1173
1181
|
# @option opts [ServerPublicNetwork] :server_public_network
|
1174
1182
|
# @return [Array<(ServerPublicNetwork, Integer, Hash)>] ServerPublicNetwork data, response status code and response headers
|
1175
1183
|
def servers_server_id_public_networks_post_with_http_info(server_id, opts = {})
|
@@ -1185,6 +1193,7 @@ module BmcApi
|
|
1185
1193
|
|
1186
1194
|
# query parameters
|
1187
1195
|
query_params = opts[:query_params] || {}
|
1196
|
+
query_params[:'force'] = opts[:'force'] if !opts[:'force'].nil?
|
1188
1197
|
|
1189
1198
|
# header parameters
|
1190
1199
|
header_params = opts[:header_params] || {}
|
@@ -16,7 +16,7 @@ require 'time'
|
|
16
16
|
module BmcApi
|
17
17
|
# Entire network details of bare metal server.
|
18
18
|
class NetworkConfiguration
|
19
|
-
# The address of the gateway assigned / to assign to the server
|
19
|
+
# 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.
|
20
20
|
attr_accessor :gateway_address
|
21
21
|
|
22
22
|
attr_accessor :private_network_configuration
|
@@ -27,9 +27,11 @@ module BmcApi
|
|
27
27
|
# 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.
|
28
28
|
attr_accessor :management_access_allowed_ips
|
29
29
|
|
30
|
-
# 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.
|
30
|
+
# 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.
|
31
31
|
attr_accessor :install_os_to_ram
|
32
32
|
|
33
|
+
attr_accessor :cloud_init
|
34
|
+
|
33
35
|
# Attribute mapping from ruby-style variable name to JSON key.
|
34
36
|
def self.attribute_map
|
35
37
|
{
|
@@ -37,7 +39,8 @@ module BmcApi
|
|
37
39
|
:'root_password' => :'rootPassword',
|
38
40
|
:'management_ui_url' => :'managementUiUrl',
|
39
41
|
:'management_access_allowed_ips' => :'managementAccessAllowedIps',
|
40
|
-
:'install_os_to_ram' => :'installOsToRam'
|
42
|
+
:'install_os_to_ram' => :'installOsToRam',
|
43
|
+
:'cloud_init' => :'cloudInit'
|
41
44
|
}
|
42
45
|
end
|
43
46
|
|
@@ -53,7 +56,8 @@ module BmcApi
|
|
53
56
|
:'root_password' => :'String',
|
54
57
|
:'management_ui_url' => :'String',
|
55
58
|
:'management_access_allowed_ips' => :'Array<String>',
|
56
|
-
:'install_os_to_ram' => :'Boolean'
|
59
|
+
:'install_os_to_ram' => :'Boolean',
|
60
|
+
:'cloud_init' => :'OsConfigurationCloudInit'
|
57
61
|
}
|
58
62
|
end
|
59
63
|
|
@@ -101,6 +105,10 @@ module BmcApi
|
|
101
105
|
else
|
102
106
|
self.install_os_to_ram = false
|
103
107
|
end
|
108
|
+
|
109
|
+
if attributes.key?(:'cloud_init')
|
110
|
+
self.cloud_init = attributes[:'cloud_init']
|
111
|
+
end
|
104
112
|
end
|
105
113
|
|
106
114
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -140,7 +148,8 @@ module BmcApi
|
|
140
148
|
root_password == o.root_password &&
|
141
149
|
management_ui_url == o.management_ui_url &&
|
142
150
|
management_access_allowed_ips == o.management_access_allowed_ips &&
|
143
|
-
install_os_to_ram == o.install_os_to_ram
|
151
|
+
install_os_to_ram == o.install_os_to_ram &&
|
152
|
+
cloud_init == o.cloud_init
|
144
153
|
end
|
145
154
|
|
146
155
|
# @see the `==` method
|
@@ -152,7 +161,7 @@ module BmcApi
|
|
152
161
|
# Calculates hash code according to all attributes.
|
153
162
|
# @return [Integer] Hash code
|
154
163
|
def hash
|
155
|
-
[windows, root_password, management_ui_url, management_access_allowed_ips, install_os_to_ram].hash
|
164
|
+
[windows, root_password, management_ui_url, management_access_allowed_ips, install_os_to_ram, cloud_init].hash
|
156
165
|
end
|
157
166
|
|
158
167
|
# Builds the object from hash
|
@@ -0,0 +1,221 @@
|
|
1
|
+
=begin
|
2
|
+
#Bare Metal Cloud API
|
3
|
+
|
4
|
+
#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API. Deprovision servers, get or edit SSH key details, assign public IPs, assign servers to networks and a lot more. Manage your infrastructure more efficiently using just a few simple API calls.<br> <br> <span class='pnap-api-knowledge-base-link'> Knowledge base articles to help you can be found <a href='https://phoenixnap.com/kb/how-to-deploy-bare-metal-cloud-server' target='_blank'>here</a> </span><br> <br> <b>All URLs are relative to (https://api.phoenixnap.com/bmc/v1/)</b>
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 0.1
|
7
|
+
Contact: support@phoenixnap.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.1.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'time'
|
15
|
+
|
16
|
+
module BmcApi
|
17
|
+
# Cloud-init configuration details.
|
18
|
+
class OsConfigurationCloudInit
|
19
|
+
# 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.
|
20
|
+
attr_accessor :user_data
|
21
|
+
|
22
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
23
|
+
def self.attribute_map
|
24
|
+
{
|
25
|
+
:'user_data' => :'userData'
|
26
|
+
}
|
27
|
+
end
|
28
|
+
|
29
|
+
# Returns all the JSON keys this model knows about
|
30
|
+
def self.acceptable_attributes
|
31
|
+
attribute_map.values
|
32
|
+
end
|
33
|
+
|
34
|
+
# Attribute type mapping.
|
35
|
+
def self.openapi_types
|
36
|
+
{
|
37
|
+
:'user_data' => :'String'
|
38
|
+
}
|
39
|
+
end
|
40
|
+
|
41
|
+
# List of attributes with nullable: true
|
42
|
+
def self.openapi_nullable
|
43
|
+
Set.new([
|
44
|
+
])
|
45
|
+
end
|
46
|
+
|
47
|
+
# Initializes the object
|
48
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
49
|
+
def initialize(attributes = {})
|
50
|
+
if (!attributes.is_a?(Hash))
|
51
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `BmcApi::OsConfigurationCloudInit` initialize method"
|
52
|
+
end
|
53
|
+
|
54
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
55
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
56
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
57
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `BmcApi::OsConfigurationCloudInit`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
58
|
+
end
|
59
|
+
h[k.to_sym] = v
|
60
|
+
}
|
61
|
+
|
62
|
+
if attributes.key?(:'user_data')
|
63
|
+
self.user_data = attributes[:'user_data']
|
64
|
+
end
|
65
|
+
end
|
66
|
+
|
67
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
68
|
+
# @return Array for valid properties with the reasons
|
69
|
+
def list_invalid_properties
|
70
|
+
invalid_properties = Array.new
|
71
|
+
invalid_properties
|
72
|
+
end
|
73
|
+
|
74
|
+
# Check to see if the all the properties in the model are valid
|
75
|
+
# @return true if the model is valid
|
76
|
+
def valid?
|
77
|
+
true
|
78
|
+
end
|
79
|
+
|
80
|
+
# Checks equality by comparing each attribute.
|
81
|
+
# @param [Object] Object to be compared
|
82
|
+
def ==(o)
|
83
|
+
return true if self.equal?(o)
|
84
|
+
self.class == o.class &&
|
85
|
+
user_data == o.user_data
|
86
|
+
end
|
87
|
+
|
88
|
+
# @see the `==` method
|
89
|
+
# @param [Object] Object to be compared
|
90
|
+
def eql?(o)
|
91
|
+
self == o
|
92
|
+
end
|
93
|
+
|
94
|
+
# Calculates hash code according to all attributes.
|
95
|
+
# @return [Integer] Hash code
|
96
|
+
def hash
|
97
|
+
[user_data].hash
|
98
|
+
end
|
99
|
+
|
100
|
+
# Builds the object from hash
|
101
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
102
|
+
# @return [Object] Returns the model itself
|
103
|
+
def self.build_from_hash(attributes)
|
104
|
+
new.build_from_hash(attributes)
|
105
|
+
end
|
106
|
+
|
107
|
+
# Builds the object from hash
|
108
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
109
|
+
# @return [Object] Returns the model itself
|
110
|
+
def build_from_hash(attributes)
|
111
|
+
return nil unless attributes.is_a?(Hash)
|
112
|
+
attributes = attributes.transform_keys(&:to_sym)
|
113
|
+
self.class.openapi_types.each_pair do |key, type|
|
114
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
115
|
+
self.send("#{key}=", nil)
|
116
|
+
elsif type =~ /\AArray<(.*)>/i
|
117
|
+
# check to ensure the input is an array given that the attribute
|
118
|
+
# is documented as an array but the input is not
|
119
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
120
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
121
|
+
end
|
122
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
123
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
124
|
+
end
|
125
|
+
end
|
126
|
+
|
127
|
+
self
|
128
|
+
end
|
129
|
+
|
130
|
+
# Deserializes the data based on type
|
131
|
+
# @param string type Data type
|
132
|
+
# @param string value Value to be deserialized
|
133
|
+
# @return [Object] Deserialized data
|
134
|
+
def _deserialize(type, value)
|
135
|
+
case type.to_sym
|
136
|
+
when :Time
|
137
|
+
Time.parse(value)
|
138
|
+
when :Date
|
139
|
+
Date.parse(value)
|
140
|
+
when :String
|
141
|
+
value.to_s
|
142
|
+
when :Integer
|
143
|
+
value.to_i
|
144
|
+
when :Float
|
145
|
+
value.to_f
|
146
|
+
when :Boolean
|
147
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
148
|
+
true
|
149
|
+
else
|
150
|
+
false
|
151
|
+
end
|
152
|
+
when :Object
|
153
|
+
# generic object (usually a Hash), return directly
|
154
|
+
value
|
155
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
156
|
+
inner_type = Regexp.last_match[:inner_type]
|
157
|
+
value.map { |v| _deserialize(inner_type, v) }
|
158
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
159
|
+
k_type = Regexp.last_match[:k_type]
|
160
|
+
v_type = Regexp.last_match[:v_type]
|
161
|
+
{}.tap do |hash|
|
162
|
+
value.each do |k, v|
|
163
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
164
|
+
end
|
165
|
+
end
|
166
|
+
else # model
|
167
|
+
# models (e.g. Pet) or oneOf
|
168
|
+
klass = BmcApi.const_get(type)
|
169
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
170
|
+
end
|
171
|
+
end
|
172
|
+
|
173
|
+
# Returns the string representation of the object
|
174
|
+
# @return [String] String presentation of the object
|
175
|
+
def to_s
|
176
|
+
to_hash.to_s
|
177
|
+
end
|
178
|
+
|
179
|
+
# to_body is an alias to to_hash (backward compatibility)
|
180
|
+
# @return [Hash] Returns the object in the form of hash
|
181
|
+
def to_body
|
182
|
+
to_hash
|
183
|
+
end
|
184
|
+
|
185
|
+
# Returns the object in the form of hash
|
186
|
+
# @return [Hash] Returns the object in the form of hash
|
187
|
+
def to_hash
|
188
|
+
hash = {}
|
189
|
+
self.class.attribute_map.each_pair do |attr, param|
|
190
|
+
value = self.send(attr)
|
191
|
+
if value.nil?
|
192
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
193
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
194
|
+
end
|
195
|
+
|
196
|
+
hash[param] = _to_hash(value)
|
197
|
+
end
|
198
|
+
hash
|
199
|
+
end
|
200
|
+
|
201
|
+
# Outputs non-array value in the form of hash
|
202
|
+
# For object, use to_hash. Otherwise, just return the value
|
203
|
+
# @param [Object] value Any valid value
|
204
|
+
# @return [Hash] Returns the value in the form of hash
|
205
|
+
def _to_hash(value)
|
206
|
+
if value.is_a?(Array)
|
207
|
+
value.compact.map { |v| _to_hash(v) }
|
208
|
+
elsif value.is_a?(Hash)
|
209
|
+
{}.tap do |hash|
|
210
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
211
|
+
end
|
212
|
+
elsif value.respond_to? :to_hash
|
213
|
+
value.to_hash
|
214
|
+
else
|
215
|
+
value
|
216
|
+
end
|
217
|
+
end
|
218
|
+
|
219
|
+
end
|
220
|
+
|
221
|
+
end
|
@@ -16,7 +16,7 @@ require 'time'
|
|
16
16
|
module BmcApi
|
17
17
|
# Private network details of bare metal server.
|
18
18
|
class PrivateNetworkConfiguration
|
19
|
-
# The address of the gateway assigned / to assign to the server
|
19
|
+
# 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.
|
20
20
|
attr_accessor :gateway_address
|
21
21
|
|
22
22
|
# 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`.
|
@@ -28,7 +28,7 @@ module BmcApi
|
|
28
28
|
# Description of server.
|
29
29
|
attr_accessor :description
|
30
30
|
|
31
|
-
# 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/
|
31
|
+
# 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`.
|
32
32
|
attr_accessor :os
|
33
33
|
|
34
34
|
# 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`.
|
@@ -22,7 +22,7 @@ module BmcApi
|
|
22
22
|
# Description of server.
|
23
23
|
attr_accessor :description
|
24
24
|
|
25
|
-
# 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/
|
25
|
+
# 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`.
|
26
26
|
attr_accessor :os
|
27
27
|
|
28
28
|
# 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`.
|
@@ -19,10 +19,10 @@ module BmcApi
|
|
19
19
|
# The network identifier.
|
20
20
|
attr_accessor :id
|
21
21
|
|
22
|
-
# IPs to configure/configured on the server
|
22
|
+
# 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>
|
23
23
|
attr_accessor :ips
|
24
24
|
|
25
|
-
# Determines whether DHCP is enabled for this server. Should be false if
|
25
|
+
# Determines whether DHCP is enabled for this server. Should be false if any IPs are provided. Not supported for Proxmox OS and ESXi OS.
|
26
26
|
attr_accessor :dhcp
|
27
27
|
|
28
28
|
# The status of the network.
|
@@ -19,7 +19,7 @@ module BmcApi
|
|
19
19
|
# The network identifier.
|
20
20
|
attr_accessor :id
|
21
21
|
|
22
|
-
#
|
22
|
+
# 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>
|
23
23
|
attr_accessor :ips
|
24
24
|
|
25
25
|
# The status of the assignment to the network.
|
@@ -92,14 +92,6 @@ module BmcApi
|
|
92
92
|
invalid_properties.push('invalid value for "id", id cannot be nil.')
|
93
93
|
end
|
94
94
|
|
95
|
-
if @ips.nil?
|
96
|
-
invalid_properties.push('invalid value for "ips", ips cannot be nil.')
|
97
|
-
end
|
98
|
-
|
99
|
-
if @ips.length < 1
|
100
|
-
invalid_properties.push('invalid value for "ips", number of items must be greater than or equal to 1.')
|
101
|
-
end
|
102
|
-
|
103
95
|
invalid_properties
|
104
96
|
end
|
105
97
|
|
@@ -107,25 +99,9 @@ module BmcApi
|
|
107
99
|
# @return true if the model is valid
|
108
100
|
def valid?
|
109
101
|
return false if @id.nil?
|
110
|
-
return false if @ips.nil?
|
111
|
-
return false if @ips.length < 1
|
112
102
|
true
|
113
103
|
end
|
114
104
|
|
115
|
-
# Custom attribute writer method with validation
|
116
|
-
# @param [Object] ips Value to be assigned
|
117
|
-
def ips=(ips)
|
118
|
-
if ips.nil?
|
119
|
-
fail ArgumentError, 'ips cannot be nil'
|
120
|
-
end
|
121
|
-
|
122
|
-
if ips.length < 1
|
123
|
-
fail ArgumentError, 'invalid value for "ips", number of items must be greater than or equal to 1.'
|
124
|
-
end
|
125
|
-
|
126
|
-
@ips = ips
|
127
|
-
end
|
128
|
-
|
129
105
|
# Checks equality by comparing each attribute.
|
130
106
|
# @param [Object] Object to be compared
|
131
107
|
def ==(o)
|
data/lib/pnap_bmc_api.rb
CHANGED
@@ -24,6 +24,7 @@ require 'pnap_bmc_api/models/error'
|
|
24
24
|
require 'pnap_bmc_api/models/ip_blocks_configuration'
|
25
25
|
require 'pnap_bmc_api/models/network_configuration'
|
26
26
|
require 'pnap_bmc_api/models/os_configuration'
|
27
|
+
require 'pnap_bmc_api/models/os_configuration_cloud_init'
|
27
28
|
require 'pnap_bmc_api/models/os_configuration_map'
|
28
29
|
require 'pnap_bmc_api/models/os_configuration_map_esxi'
|
29
30
|
require 'pnap_bmc_api/models/os_configuration_map_proxmox'
|
@@ -0,0 +1,34 @@
|
|
1
|
+
=begin
|
2
|
+
#Bare Metal Cloud API
|
3
|
+
|
4
|
+
#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API. Deprovision servers, get or edit SSH key details, assign public IPs, assign servers to networks and a lot more. Manage your infrastructure more efficiently using just a few simple API calls.<br> <br> <span class='pnap-api-knowledge-base-link'> Knowledge base articles to help you can be found <a href='https://phoenixnap.com/kb/how-to-deploy-bare-metal-cloud-server' target='_blank'>here</a> </span><br> <br> <b>All URLs are relative to (https://api.phoenixnap.com/bmc/v1/)</b>
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 0.1
|
7
|
+
Contact: support@phoenixnap.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.1.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
require 'date'
|
16
|
+
|
17
|
+
# Unit tests for BmcApi::OsConfigurationCloudInit
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
19
|
+
# Please update as you see appropriate
|
20
|
+
describe BmcApi::OsConfigurationCloudInit do
|
21
|
+
let(:instance) { BmcApi::OsConfigurationCloudInit.new }
|
22
|
+
|
23
|
+
describe 'test an instance of OsConfigurationCloudInit' do
|
24
|
+
it 'should create an instance of OsConfigurationCloudInit' do
|
25
|
+
expect(instance).to be_instance_of(BmcApi::OsConfigurationCloudInit)
|
26
|
+
end
|
27
|
+
end
|
28
|
+
describe 'test attribute "user_data"' do
|
29
|
+
it 'should work' do
|
30
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: pnap_bmc_api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.3.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- PhoenixNAP
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2023-03-08 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -68,6 +68,7 @@ files:
|
|
68
68
|
- docs/IpBlocksConfiguration.md
|
69
69
|
- docs/NetworkConfiguration.md
|
70
70
|
- docs/OsConfiguration.md
|
71
|
+
- docs/OsConfigurationCloudInit.md
|
71
72
|
- docs/OsConfigurationMap.md
|
72
73
|
- docs/OsConfigurationMapEsxi.md
|
73
74
|
- docs/OsConfigurationMapProxmox.md
|
@@ -110,6 +111,7 @@ files:
|
|
110
111
|
- lib/pnap_bmc_api/models/ip_blocks_configuration.rb
|
111
112
|
- lib/pnap_bmc_api/models/network_configuration.rb
|
112
113
|
- lib/pnap_bmc_api/models/os_configuration.rb
|
114
|
+
- lib/pnap_bmc_api/models/os_configuration_cloud_init.rb
|
113
115
|
- lib/pnap_bmc_api/models/os_configuration_map.rb
|
114
116
|
- lib/pnap_bmc_api/models/os_configuration_map_esxi.rb
|
115
117
|
- lib/pnap_bmc_api/models/os_configuration_map_proxmox.rb
|
@@ -148,6 +150,7 @@ files:
|
|
148
150
|
- spec/models/error_spec.rb
|
149
151
|
- spec/models/ip_blocks_configuration_spec.rb
|
150
152
|
- spec/models/network_configuration_spec.rb
|
153
|
+
- spec/models/os_configuration_cloud_init_spec.rb
|
151
154
|
- spec/models/os_configuration_map_esxi_spec.rb
|
152
155
|
- spec/models/os_configuration_map_proxmox_spec.rb
|
153
156
|
- spec/models/os_configuration_map_spec.rb
|
@@ -195,46 +198,47 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
195
198
|
- !ruby/object:Gem::Version
|
196
199
|
version: '0'
|
197
200
|
requirements: []
|
198
|
-
rubygems_version: 3.
|
201
|
+
rubygems_version: 3.3.5
|
199
202
|
signing_key:
|
200
203
|
specification_version: 4
|
201
204
|
summary: Bare Metal Cloud API Ruby Gem
|
202
205
|
test_files:
|
203
|
-
- spec/api/quotas_api_spec.rb
|
204
|
-
- spec/api/servers_api_spec.rb
|
205
206
|
- spec/api/ssh_keys_api_spec.rb
|
207
|
+
- spec/api/servers_api_spec.rb
|
208
|
+
- spec/api/quotas_api_spec.rb
|
206
209
|
- spec/api_client_spec.rb
|
207
210
|
- spec/configuration_spec.rb
|
208
|
-
- spec/models/ssh_key_create_spec.rb
|
209
|
-
- spec/models/network_configuration_spec.rb
|
210
|
-
- spec/models/server_spec.rb
|
211
|
-
- spec/models/quota_edit_limit_request_spec.rb
|
212
211
|
- spec/models/os_configuration_map_esxi_spec.rb
|
213
|
-
- spec/models/
|
214
|
-
- spec/models/public_network_configuration_spec.rb
|
215
|
-
- spec/models/action_result_spec.rb
|
216
|
-
- spec/models/quota_edit_limit_request_details_spec.rb
|
217
|
-
- spec/models/server_reset_spec.rb
|
212
|
+
- spec/models/quota_edit_limit_request_details_all_of_spec.rb
|
218
213
|
- spec/models/os_configuration_map_proxmox_spec.rb
|
219
|
-
- spec/models/
|
220
|
-
- spec/models/ip_blocks_configuration_spec.rb
|
221
|
-
- spec/models/error_spec.rb
|
214
|
+
- spec/models/server_private_network_spec.rb
|
222
215
|
- spec/models/delete_result_spec.rb
|
223
|
-
- spec/models/
|
216
|
+
- spec/models/quota_spec.rb
|
217
|
+
- spec/models/os_configuration_windows_spec.rb
|
218
|
+
- spec/models/ssh_key_create_spec.rb
|
219
|
+
- spec/models/ssh_key_update_spec.rb
|
220
|
+
- spec/models/server_ip_block_spec.rb
|
221
|
+
- spec/models/server_reset_spec.rb
|
224
222
|
- spec/models/ssh_key_spec.rb
|
223
|
+
- spec/models/error_spec.rb
|
225
224
|
- spec/models/tag_assignment_spec.rb
|
226
|
-
- spec/models/
|
227
|
-
- spec/models/server_reserve_spec.rb
|
228
|
-
- spec/models/reset_result_spec.rb
|
229
|
-
- spec/models/server_private_network_spec.rb
|
230
|
-
- spec/models/server_create_spec.rb
|
225
|
+
- spec/models/quota_edit_limit_request_details_spec.rb
|
231
226
|
- spec/models/os_configuration_map_spec.rb
|
232
|
-
- spec/models/
|
233
|
-
- spec/models/
|
227
|
+
- spec/models/server_create_spec.rb
|
228
|
+
- spec/models/action_result_spec.rb
|
229
|
+
- spec/models/server_reserve_spec.rb
|
234
230
|
- spec/models/private_network_configuration_spec.rb
|
235
|
-
- spec/models/
|
236
|
-
- spec/models/
|
231
|
+
- spec/models/tag_assignment_request_spec.rb
|
232
|
+
- spec/models/public_network_configuration_spec.rb
|
233
|
+
- spec/models/network_configuration_spec.rb
|
234
|
+
- spec/models/ip_blocks_configuration_spec.rb
|
237
235
|
- spec/models/relinquish_ip_block_spec.rb
|
236
|
+
- spec/models/os_configuration_cloud_init_spec.rb
|
238
237
|
- spec/models/server_patch_spec.rb
|
239
|
-
- spec/models/
|
238
|
+
- spec/models/delete_ssh_key_result_spec.rb
|
239
|
+
- spec/models/os_configuration_spec.rb
|
240
|
+
- spec/models/server_public_network_spec.rb
|
241
|
+
- spec/models/server_spec.rb
|
242
|
+
- spec/models/reset_result_spec.rb
|
243
|
+
- spec/models/quota_edit_limit_request_spec.rb
|
240
244
|
- spec/spec_helper.rb
|