pnap_bmc_api 1.0.0 → 1.1.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 +8 -4
- data/VERSION +1 -1
- data/docs/NetworkConfiguration.md +5 -1
- data/docs/OsConfiguration.md +3 -1
- data/docs/PrivateNetworkConfiguration.md +1 -1
- data/docs/PublicNetworkConfiguration.md +18 -0
- data/docs/Quota.md +2 -2
- data/docs/Server.md +2 -2
- data/docs/ServerCreate.md +3 -3
- data/docs/ServerPrivateNetwork.md +1 -1
- data/docs/ServerPublicNetwork.md +22 -0
- data/docs/ServersApi.md +156 -10
- data/lib/pnap_bmc_api/api/quotas_api.rb +1 -1
- data/lib/pnap_bmc_api/api/servers_api.rb +154 -15
- data/lib/pnap_bmc_api/api/ssh_keys_api.rb +1 -1
- data/lib/pnap_bmc_api/api_client.rb +1 -1
- data/lib/pnap_bmc_api/api_error.rb +1 -1
- data/lib/pnap_bmc_api/configuration.rb +1 -1
- data/lib/pnap_bmc_api/models/action_result.rb +1 -1
- data/lib/pnap_bmc_api/models/delete_result.rb +1 -1
- data/lib/pnap_bmc_api/models/delete_ssh_key_result.rb +1 -1
- data/lib/pnap_bmc_api/models/error.rb +1 -1
- data/lib/pnap_bmc_api/models/ip_blocks_configuration.rb +1 -1
- data/lib/pnap_bmc_api/models/network_configuration.rb +24 -5
- data/lib/pnap_bmc_api/models/os_configuration.rb +17 -5
- data/lib/pnap_bmc_api/models/os_configuration_map.rb +1 -1
- data/lib/pnap_bmc_api/models/os_configuration_map_esxi.rb +1 -1
- data/lib/pnap_bmc_api/models/os_configuration_map_proxmox.rb +1 -1
- data/lib/pnap_bmc_api/models/os_configuration_windows.rb +1 -1
- data/lib/pnap_bmc_api/models/private_network_configuration.rb +2 -2
- data/lib/pnap_bmc_api/models/public_network_configuration.rb +222 -0
- data/lib/pnap_bmc_api/models/quota.rb +2 -14
- data/lib/pnap_bmc_api/models/quota_edit_limit_request.rb +1 -1
- data/lib/pnap_bmc_api/models/quota_edit_limit_request_details.rb +1 -1
- data/lib/pnap_bmc_api/models/quota_edit_limit_request_details_all_of.rb +1 -1
- data/lib/pnap_bmc_api/models/relinquish_ip_block.rb +1 -1
- data/lib/pnap_bmc_api/models/reset_result.rb +1 -1
- data/lib/pnap_bmc_api/models/server.rb +3 -3
- data/lib/pnap_bmc_api/models/server_create.rb +4 -4
- data/lib/pnap_bmc_api/models/server_ip_block.rb +2 -2
- data/lib/pnap_bmc_api/models/server_patch.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 +271 -0
- data/lib/pnap_bmc_api/models/server_reserve.rb +1 -1
- data/lib/pnap_bmc_api/models/server_reset.rb +1 -1
- data/lib/pnap_bmc_api/models/ssh_key.rb +1 -1
- data/lib/pnap_bmc_api/models/ssh_key_create.rb +1 -1
- data/lib/pnap_bmc_api/models/ssh_key_update.rb +1 -1
- data/lib/pnap_bmc_api/models/tag_assignment.rb +1 -1
- data/lib/pnap_bmc_api/models/tag_assignment_request.rb +1 -1
- data/lib/pnap_bmc_api/version.rb +1 -1
- data/lib/pnap_bmc_api.rb +3 -1
- data/pnap_bmc_api.gemspec +2 -2
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/public_network_configuration_spec.rb +34 -0
- data/spec/models/server_public_network_spec.rb +46 -0
- data/spec/spec_helper.rb +1 -1
- metadata +32 -24
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Bare Metal Cloud API
|
3
3
|
|
4
|
-
#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API.
|
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
5
|
|
6
6
|
The version of the OpenAPI document: 0.1
|
7
7
|
Contact: support@phoenixnap.com
|
@@ -20,7 +20,7 @@ module BmcApi
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# Removes the server from private network.
|
23
|
-
# Removes the server from private network. <b>No actual configuration is performed on the operating system.</b> BMC configures exclusively the networking devices in the datacenter infrastructure.
|
23
|
+
# Removes the server from 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. <b>This is an advanced network action that can make your server completely unavailable over any network. Make sure this server is reachable over remote console for guaranteed access in case of misconfiguration.</b>
|
24
24
|
# @param server_id [String] The server's ID.
|
25
25
|
# @param private_network_id [String] The private network identifier.
|
26
26
|
# @param [Hash] opts the optional parameters
|
@@ -31,7 +31,7 @@ module BmcApi
|
|
31
31
|
end
|
32
32
|
|
33
33
|
# Removes the server from private network.
|
34
|
-
# Removes the server from private network. <b>No actual configuration is performed on the operating system.</b> BMC configures exclusively the networking devices in the datacenter infrastructure.
|
34
|
+
# Removes the server from 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. <b>This is an advanced network action that can make your server completely unavailable over any network. Make sure this server is reachable over remote console for guaranteed access in case of misconfiguration.</b>
|
35
35
|
# @param server_id [String] The server's ID.
|
36
36
|
# @param private_network_id [String] The private network identifier.
|
37
37
|
# @param [Hash] opts the optional parameters
|
@@ -542,7 +542,7 @@ module BmcApi
|
|
542
542
|
end
|
543
543
|
|
544
544
|
# Reset server.
|
545
|
-
# Reset specific server.
|
545
|
+
# Deprecated: Reset specific server. Reset only supports network configurations of type 'private network' or 'IP blocks'. As an alternative, the suggested action is to deprovision the server and provision a new one with the same configuration.
|
546
546
|
# @param server_id [String] The server's ID.
|
547
547
|
# @param [Hash] opts the optional parameters
|
548
548
|
# @option opts [ServerReset] :server_reset
|
@@ -553,7 +553,7 @@ module BmcApi
|
|
553
553
|
end
|
554
554
|
|
555
555
|
# Reset server.
|
556
|
-
# Reset specific server.
|
556
|
+
# Deprecated: Reset specific server. Reset only supports network configurations of type 'private network' or 'IP blocks'. As an alternative, the suggested action is to deprovision the server and provision a new one with the same configuration.
|
557
557
|
# @param server_id [String] The server's ID.
|
558
558
|
# @param [Hash] opts the optional parameters
|
559
559
|
# @option opts [ServerReset] :server_reset
|
@@ -801,7 +801,7 @@ module BmcApi
|
|
801
801
|
end
|
802
802
|
|
803
803
|
# Unassign IP Block from Server.
|
804
|
-
# Removes the IP block from the server. <b>No actual configuration is performed on the operating system.</b> BMC configures exclusively the networking devices in the datacenter infrastructure.
|
804
|
+
# Removes the IP block from the server. <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. <b>This is an advanced network action that can make your server completely unavailable over any network. Make sure this server is reachable over remote console for guaranteed access in case of misconfiguration.</b>
|
805
805
|
# @param server_id [String] The server's ID.
|
806
806
|
# @param ip_block_id [String] The IP Block identifier.
|
807
807
|
# @param [Hash] opts the optional parameters
|
@@ -813,7 +813,7 @@ module BmcApi
|
|
813
813
|
end
|
814
814
|
|
815
815
|
# Unassign IP Block from Server.
|
816
|
-
# Removes the IP block from the server. <b>No actual configuration is performed on the operating system.</b> BMC configures exclusively the networking devices in the datacenter infrastructure.
|
816
|
+
# Removes the IP block from the server. <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. <b>This is an advanced network action that can make your server completely unavailable over any network. Make sure this server is reachable over remote console for guaranteed access in case of misconfiguration.</b>
|
817
817
|
# @param server_id [String] The server's ID.
|
818
818
|
# @param ip_block_id [String] The IP Block identifier.
|
819
819
|
# @param [Hash] opts the optional parameters
|
@@ -877,7 +877,7 @@ module BmcApi
|
|
877
877
|
end
|
878
878
|
|
879
879
|
# Assign IP Block to Server.
|
880
|
-
# Adds an IP block to this server. <b>No actual configuration is performed on the operating system.</b> BMC configures exclusively the networking devices in the datacenter infrastructure.
|
880
|
+
# Adds an IP block to this server. <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-server-with-public-ip-block#ftoc-heading-2' target='_blank'>here</a>.
|
881
881
|
# @param server_id [String] The server's ID.
|
882
882
|
# @param [Hash] opts the optional parameters
|
883
883
|
# @option opts [ServerIpBlock] :server_ip_block
|
@@ -888,7 +888,7 @@ module BmcApi
|
|
888
888
|
end
|
889
889
|
|
890
890
|
# Assign IP Block to Server.
|
891
|
-
# Adds an IP block to this server. <b>No actual configuration is performed on the operating system.</b> BMC configures exclusively the networking devices in the datacenter infrastructure.
|
891
|
+
# Adds an IP block to this server. <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-server-with-public-ip-block#ftoc-heading-2' target='_blank'>here</a>.
|
892
892
|
# @param server_id [String] The server's ID.
|
893
893
|
# @param [Hash] opts the optional parameters
|
894
894
|
# @option opts [ServerIpBlock] :server_ip_block
|
@@ -1017,7 +1017,7 @@ module BmcApi
|
|
1017
1017
|
end
|
1018
1018
|
|
1019
1019
|
# Adds the server to a private network.
|
1020
|
-
# 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. If the network contains a membership of type 'storage', the first twelve IPs are already reserved by BMC and not usable. These will return a Bad Request (400) if selected. Knowledge base article to help you can be found <a href='https://phoenixnap.com/kb/configure-bmc-server-after-adding-to-network#ftoc-heading-3' target='_blank'>here</a>.
|
1021
1021
|
# @param server_id [String] The server's ID.
|
1022
1022
|
# @param [Hash] opts the optional parameters
|
1023
1023
|
# @option opts [ServerPrivateNetwork] :server_private_network
|
@@ -1028,7 +1028,7 @@ module BmcApi
|
|
1028
1028
|
end
|
1029
1029
|
|
1030
1030
|
# Adds the server to a private network.
|
1031
|
-
# 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. If the network contains a membership of type 'storage', the first twelve IPs are already reserved by BMC and not usable. These will return a Bad Request (400) if selected. Knowledge base article to help you can be found <a href='https://phoenixnap.com/kb/configure-bmc-server-after-adding-to-network#ftoc-heading-3' target='_blank'>here</a>.
|
1032
1032
|
# @param server_id [String] The server's ID.
|
1033
1033
|
# @param [Hash] opts the optional parameters
|
1034
1034
|
# @option opts [ServerPrivateNetwork] :server_private_network
|
@@ -1086,8 +1086,147 @@ module BmcApi
|
|
1086
1086
|
return data, status_code, headers
|
1087
1087
|
end
|
1088
1088
|
|
1089
|
-
#
|
1090
|
-
#
|
1089
|
+
# Removes the server from the Public Network
|
1090
|
+
# Removes the server from the 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. <b>This is an advanced network action that can make your server completely unavailable over any network. Make sure this server is reachable over remote console for guaranteed access in case of misconfiguration.</b>
|
1091
|
+
# @param server_id [String] The server's ID.
|
1092
|
+
# @param public_network_id [String] The Public Network identifier.
|
1093
|
+
# @param [Hash] opts the optional parameters
|
1094
|
+
# @return [String]
|
1095
|
+
def servers_server_id_public_networks_delete(server_id, public_network_id, opts = {})
|
1096
|
+
data, _status_code, _headers = servers_server_id_public_networks_delete_with_http_info(server_id, public_network_id, opts)
|
1097
|
+
data
|
1098
|
+
end
|
1099
|
+
|
1100
|
+
# Removes the server from the Public Network
|
1101
|
+
# Removes the server from the 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. <b>This is an advanced network action that can make your server completely unavailable over any network. Make sure this server is reachable over remote console for guaranteed access in case of misconfiguration.</b>
|
1102
|
+
# @param server_id [String] The server's ID.
|
1103
|
+
# @param public_network_id [String] The Public Network identifier.
|
1104
|
+
# @param [Hash] opts the optional parameters
|
1105
|
+
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
1106
|
+
def servers_server_id_public_networks_delete_with_http_info(server_id, public_network_id, opts = {})
|
1107
|
+
if @api_client.config.debugging
|
1108
|
+
@api_client.config.logger.debug 'Calling API: ServersApi.servers_server_id_public_networks_delete ...'
|
1109
|
+
end
|
1110
|
+
# verify the required parameter 'server_id' is set
|
1111
|
+
if @api_client.config.client_side_validation && server_id.nil?
|
1112
|
+
fail ArgumentError, "Missing the required parameter 'server_id' when calling ServersApi.servers_server_id_public_networks_delete"
|
1113
|
+
end
|
1114
|
+
# verify the required parameter 'public_network_id' is set
|
1115
|
+
if @api_client.config.client_side_validation && public_network_id.nil?
|
1116
|
+
fail ArgumentError, "Missing the required parameter 'public_network_id' when calling ServersApi.servers_server_id_public_networks_delete"
|
1117
|
+
end
|
1118
|
+
# resource path
|
1119
|
+
local_var_path = '/servers/{serverId}/network-configuration/public-network-configuration/public-networks/{publicNetworkId}'.sub('{' + 'serverId' + '}', CGI.escape(server_id.to_s)).sub('{' + 'publicNetworkId' + '}', CGI.escape(public_network_id.to_s))
|
1120
|
+
|
1121
|
+
# query parameters
|
1122
|
+
query_params = opts[:query_params] || {}
|
1123
|
+
|
1124
|
+
# header parameters
|
1125
|
+
header_params = opts[:header_params] || {}
|
1126
|
+
# HTTP header 'Accept' (if needed)
|
1127
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1128
|
+
|
1129
|
+
# form parameters
|
1130
|
+
form_params = opts[:form_params] || {}
|
1131
|
+
|
1132
|
+
# http body (model)
|
1133
|
+
post_body = opts[:debug_body]
|
1134
|
+
|
1135
|
+
# return_type
|
1136
|
+
return_type = opts[:debug_return_type] || 'String'
|
1137
|
+
|
1138
|
+
# auth_names
|
1139
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
1140
|
+
|
1141
|
+
new_options = opts.merge(
|
1142
|
+
:operation => :"ServersApi.servers_server_id_public_networks_delete",
|
1143
|
+
:header_params => header_params,
|
1144
|
+
:query_params => query_params,
|
1145
|
+
:form_params => form_params,
|
1146
|
+
:body => post_body,
|
1147
|
+
:auth_names => auth_names,
|
1148
|
+
:return_type => return_type
|
1149
|
+
)
|
1150
|
+
|
1151
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
1152
|
+
if @api_client.config.debugging
|
1153
|
+
@api_client.config.logger.debug "API called: ServersApi#servers_server_id_public_networks_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1154
|
+
end
|
1155
|
+
return data, status_code, headers
|
1156
|
+
end
|
1157
|
+
|
1158
|
+
# Adds the server to a Public Network.
|
1159
|
+
# 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
|
+
# @param server_id [String] The server's ID.
|
1161
|
+
# @param [Hash] opts the optional parameters
|
1162
|
+
# @option opts [ServerPublicNetwork] :server_public_network
|
1163
|
+
# @return [ServerPublicNetwork]
|
1164
|
+
def servers_server_id_public_networks_post(server_id, opts = {})
|
1165
|
+
data, _status_code, _headers = servers_server_id_public_networks_post_with_http_info(server_id, opts)
|
1166
|
+
data
|
1167
|
+
end
|
1168
|
+
|
1169
|
+
# Adds the server to a Public Network.
|
1170
|
+
# 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
|
+
# @param server_id [String] The server's ID.
|
1172
|
+
# @param [Hash] opts the optional parameters
|
1173
|
+
# @option opts [ServerPublicNetwork] :server_public_network
|
1174
|
+
# @return [Array<(ServerPublicNetwork, Integer, Hash)>] ServerPublicNetwork data, response status code and response headers
|
1175
|
+
def servers_server_id_public_networks_post_with_http_info(server_id, opts = {})
|
1176
|
+
if @api_client.config.debugging
|
1177
|
+
@api_client.config.logger.debug 'Calling API: ServersApi.servers_server_id_public_networks_post ...'
|
1178
|
+
end
|
1179
|
+
# verify the required parameter 'server_id' is set
|
1180
|
+
if @api_client.config.client_side_validation && server_id.nil?
|
1181
|
+
fail ArgumentError, "Missing the required parameter 'server_id' when calling ServersApi.servers_server_id_public_networks_post"
|
1182
|
+
end
|
1183
|
+
# resource path
|
1184
|
+
local_var_path = '/servers/{serverId}/network-configuration/public-network-configuration/public-networks'.sub('{' + 'serverId' + '}', CGI.escape(server_id.to_s))
|
1185
|
+
|
1186
|
+
# query parameters
|
1187
|
+
query_params = opts[:query_params] || {}
|
1188
|
+
|
1189
|
+
# header parameters
|
1190
|
+
header_params = opts[:header_params] || {}
|
1191
|
+
# HTTP header 'Accept' (if needed)
|
1192
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1193
|
+
# HTTP header 'Content-Type'
|
1194
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
1195
|
+
if !content_type.nil?
|
1196
|
+
header_params['Content-Type'] = content_type
|
1197
|
+
end
|
1198
|
+
|
1199
|
+
# form parameters
|
1200
|
+
form_params = opts[:form_params] || {}
|
1201
|
+
|
1202
|
+
# http body (model)
|
1203
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'server_public_network'])
|
1204
|
+
|
1205
|
+
# return_type
|
1206
|
+
return_type = opts[:debug_return_type] || 'ServerPublicNetwork'
|
1207
|
+
|
1208
|
+
# auth_names
|
1209
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2']
|
1210
|
+
|
1211
|
+
new_options = opts.merge(
|
1212
|
+
:operation => :"ServersApi.servers_server_id_public_networks_post",
|
1213
|
+
:header_params => header_params,
|
1214
|
+
:query_params => query_params,
|
1215
|
+
:form_params => form_params,
|
1216
|
+
:body => post_body,
|
1217
|
+
:auth_names => auth_names,
|
1218
|
+
:return_type => return_type
|
1219
|
+
)
|
1220
|
+
|
1221
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
1222
|
+
if @api_client.config.debugging
|
1223
|
+
@api_client.config.logger.debug "API called: ServersApi#servers_server_id_public_networks_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1224
|
+
end
|
1225
|
+
return data, status_code, headers
|
1226
|
+
end
|
1227
|
+
|
1228
|
+
# Overwrite tags assigned for Server.
|
1229
|
+
# Overwrites tags assigned for Server and unassigns any tags not part of the request.
|
1091
1230
|
# @param server_id [String] The server's ID.
|
1092
1231
|
# @param [Hash] opts the optional parameters
|
1093
1232
|
# @option opts [Array<TagAssignmentRequest>] :tag_assignment_request
|
@@ -1097,8 +1236,8 @@ module BmcApi
|
|
1097
1236
|
data
|
1098
1237
|
end
|
1099
1238
|
|
1100
|
-
#
|
1101
|
-
#
|
1239
|
+
# Overwrite tags assigned for Server.
|
1240
|
+
# Overwrites tags assigned for Server and unassigns any tags not part of the request.
|
1102
1241
|
# @param server_id [String] The server's ID.
|
1103
1242
|
# @param [Hash] opts the optional parameters
|
1104
1243
|
# @option opts [Array<TagAssignmentRequest>] :tag_assignment_request
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Bare Metal Cloud API
|
3
3
|
|
4
|
-
#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API.
|
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
5
|
|
6
6
|
The version of the OpenAPI document: 0.1
|
7
7
|
Contact: support@phoenixnap.com
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Bare Metal Cloud API
|
3
3
|
|
4
|
-
#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API.
|
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
5
|
|
6
6
|
The version of the OpenAPI document: 0.1
|
7
7
|
Contact: support@phoenixnap.com
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Bare Metal Cloud API
|
3
3
|
|
4
|
-
#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API.
|
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
5
|
|
6
6
|
The version of the OpenAPI document: 0.1
|
7
7
|
Contact: support@phoenixnap.com
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Bare Metal Cloud API
|
3
3
|
|
4
|
-
#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API.
|
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
5
|
|
6
6
|
The version of the OpenAPI document: 0.1
|
7
7
|
Contact: support@phoenixnap.com
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Bare Metal Cloud API
|
3
3
|
|
4
|
-
#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API.
|
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
5
|
|
6
6
|
The version of the OpenAPI document: 0.1
|
7
7
|
Contact: support@phoenixnap.com
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Bare Metal Cloud API
|
3
3
|
|
4
|
-
#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API.
|
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
5
|
|
6
6
|
The version of the OpenAPI document: 0.1
|
7
7
|
Contact: support@phoenixnap.com
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Bare Metal Cloud API
|
3
3
|
|
4
|
-
#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API.
|
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
5
|
|
6
6
|
The version of the OpenAPI document: 0.1
|
7
7
|
Contact: support@phoenixnap.com
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Bare Metal Cloud API
|
3
3
|
|
4
|
-
#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API.
|
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
5
|
|
6
6
|
The version of the OpenAPI document: 0.1
|
7
7
|
Contact: support@phoenixnap.com
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Bare Metal Cloud API
|
3
3
|
|
4
|
-
#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API.
|
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
5
|
|
6
6
|
The version of the OpenAPI document: 0.1
|
7
7
|
Contact: support@phoenixnap.com
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Bare Metal Cloud API
|
3
3
|
|
4
|
-
#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API.
|
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
5
|
|
6
6
|
The version of the OpenAPI document: 0.1
|
7
7
|
Contact: support@phoenixnap.com
|
@@ -16,15 +16,22 @@ 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. When used as part of request body, IP address has to be part of private/public network assigned to this server.
|
20
|
+
attr_accessor :gateway_address
|
21
|
+
|
19
22
|
attr_accessor :private_network_configuration
|
20
23
|
|
21
24
|
attr_accessor :ip_blocks_configuration
|
22
25
|
|
26
|
+
attr_accessor :public_network_configuration
|
27
|
+
|
23
28
|
# Attribute mapping from ruby-style variable name to JSON key.
|
24
29
|
def self.attribute_map
|
25
30
|
{
|
31
|
+
:'gateway_address' => :'gatewayAddress',
|
26
32
|
:'private_network_configuration' => :'privateNetworkConfiguration',
|
27
|
-
:'ip_blocks_configuration' => :'ipBlocksConfiguration'
|
33
|
+
:'ip_blocks_configuration' => :'ipBlocksConfiguration',
|
34
|
+
:'public_network_configuration' => :'publicNetworkConfiguration'
|
28
35
|
}
|
29
36
|
end
|
30
37
|
|
@@ -36,8 +43,10 @@ module BmcApi
|
|
36
43
|
# Attribute type mapping.
|
37
44
|
def self.openapi_types
|
38
45
|
{
|
46
|
+
:'gateway_address' => :'String',
|
39
47
|
:'private_network_configuration' => :'PrivateNetworkConfiguration',
|
40
|
-
:'ip_blocks_configuration' => :'IpBlocksConfiguration'
|
48
|
+
:'ip_blocks_configuration' => :'IpBlocksConfiguration',
|
49
|
+
:'public_network_configuration' => :'PublicNetworkConfiguration'
|
41
50
|
}
|
42
51
|
end
|
43
52
|
|
@@ -62,6 +71,10 @@ module BmcApi
|
|
62
71
|
h[k.to_sym] = v
|
63
72
|
}
|
64
73
|
|
74
|
+
if attributes.key?(:'gateway_address')
|
75
|
+
self.gateway_address = attributes[:'gateway_address']
|
76
|
+
end
|
77
|
+
|
65
78
|
if attributes.key?(:'private_network_configuration')
|
66
79
|
self.private_network_configuration = attributes[:'private_network_configuration']
|
67
80
|
end
|
@@ -69,6 +82,10 @@ module BmcApi
|
|
69
82
|
if attributes.key?(:'ip_blocks_configuration')
|
70
83
|
self.ip_blocks_configuration = attributes[:'ip_blocks_configuration']
|
71
84
|
end
|
85
|
+
|
86
|
+
if attributes.key?(:'public_network_configuration')
|
87
|
+
self.public_network_configuration = attributes[:'public_network_configuration']
|
88
|
+
end
|
72
89
|
end
|
73
90
|
|
74
91
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -89,8 +106,10 @@ module BmcApi
|
|
89
106
|
def ==(o)
|
90
107
|
return true if self.equal?(o)
|
91
108
|
self.class == o.class &&
|
109
|
+
gateway_address == o.gateway_address &&
|
92
110
|
private_network_configuration == o.private_network_configuration &&
|
93
|
-
ip_blocks_configuration == o.ip_blocks_configuration
|
111
|
+
ip_blocks_configuration == o.ip_blocks_configuration &&
|
112
|
+
public_network_configuration == o.public_network_configuration
|
94
113
|
end
|
95
114
|
|
96
115
|
# @see the `==` method
|
@@ -102,7 +121,7 @@ module BmcApi
|
|
102
121
|
# Calculates hash code according to all attributes.
|
103
122
|
# @return [Integer] Hash code
|
104
123
|
def hash
|
105
|
-
[private_network_configuration, ip_blocks_configuration].hash
|
124
|
+
[gateway_address, private_network_configuration, ip_blocks_configuration, public_network_configuration].hash
|
106
125
|
end
|
107
126
|
|
108
127
|
# Builds the object from hash
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Bare Metal Cloud API
|
3
3
|
|
4
|
-
#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API.
|
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
5
|
|
6
6
|
The version of the OpenAPI document: 0.1
|
7
7
|
Contact: support@phoenixnap.com
|
@@ -27,13 +27,17 @@ 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.
|
31
|
+
attr_accessor :install_os_to_ram
|
32
|
+
|
30
33
|
# Attribute mapping from ruby-style variable name to JSON key.
|
31
34
|
def self.attribute_map
|
32
35
|
{
|
33
36
|
:'windows' => :'windows',
|
34
37
|
:'root_password' => :'rootPassword',
|
35
38
|
:'management_ui_url' => :'managementUiUrl',
|
36
|
-
:'management_access_allowed_ips' => :'managementAccessAllowedIps'
|
39
|
+
:'management_access_allowed_ips' => :'managementAccessAllowedIps',
|
40
|
+
:'install_os_to_ram' => :'installOsToRam'
|
37
41
|
}
|
38
42
|
end
|
39
43
|
|
@@ -48,7 +52,8 @@ module BmcApi
|
|
48
52
|
:'windows' => :'OsConfigurationWindows',
|
49
53
|
:'root_password' => :'String',
|
50
54
|
:'management_ui_url' => :'String',
|
51
|
-
:'management_access_allowed_ips' => :'Array<String>'
|
55
|
+
:'management_access_allowed_ips' => :'Array<String>',
|
56
|
+
:'install_os_to_ram' => :'Boolean'
|
52
57
|
}
|
53
58
|
end
|
54
59
|
|
@@ -90,6 +95,12 @@ module BmcApi
|
|
90
95
|
self.management_access_allowed_ips = value
|
91
96
|
end
|
92
97
|
end
|
98
|
+
|
99
|
+
if attributes.key?(:'install_os_to_ram')
|
100
|
+
self.install_os_to_ram = attributes[:'install_os_to_ram']
|
101
|
+
else
|
102
|
+
self.install_os_to_ram = false
|
103
|
+
end
|
93
104
|
end
|
94
105
|
|
95
106
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -128,7 +139,8 @@ module BmcApi
|
|
128
139
|
windows == o.windows &&
|
129
140
|
root_password == o.root_password &&
|
130
141
|
management_ui_url == o.management_ui_url &&
|
131
|
-
management_access_allowed_ips == o.management_access_allowed_ips
|
142
|
+
management_access_allowed_ips == o.management_access_allowed_ips &&
|
143
|
+
install_os_to_ram == o.install_os_to_ram
|
132
144
|
end
|
133
145
|
|
134
146
|
# @see the `==` method
|
@@ -140,7 +152,7 @@ module BmcApi
|
|
140
152
|
# Calculates hash code according to all attributes.
|
141
153
|
# @return [Integer] Hash code
|
142
154
|
def hash
|
143
|
-
[windows, root_password, management_ui_url, management_access_allowed_ips].hash
|
155
|
+
[windows, root_password, management_ui_url, management_access_allowed_ips, install_os_to_ram].hash
|
144
156
|
end
|
145
157
|
|
146
158
|
# Builds the object from hash
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Bare Metal Cloud API
|
3
3
|
|
4
|
-
#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API.
|
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
5
|
|
6
6
|
The version of the OpenAPI document: 0.1
|
7
7
|
Contact: support@phoenixnap.com
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Bare Metal Cloud API
|
3
3
|
|
4
|
-
#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API.
|
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
5
|
|
6
6
|
The version of the OpenAPI document: 0.1
|
7
7
|
Contact: support@phoenixnap.com
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Bare Metal Cloud API
|
3
3
|
|
4
|
-
#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API.
|
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
5
|
|
6
6
|
The version of the OpenAPI document: 0.1
|
7
7
|
Contact: support@phoenixnap.com
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Bare Metal Cloud API
|
3
3
|
|
4
|
-
#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API.
|
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
5
|
|
6
6
|
The version of the OpenAPI document: 0.1
|
7
7
|
Contact: support@phoenixnap.com
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Bare Metal Cloud API
|
3
3
|
|
4
|
-
#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API.
|
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
5
|
|
6
6
|
The version of the OpenAPI document: 0.1
|
7
7
|
Contact: support@phoenixnap.com
|
@@ -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
|
+
# The address of the gateway assigned / to assign to the server. When used as part of request body, it has to match one of the IP addresses used in the existing assigned private networks for the relevant location. Deprecated in favour of a common gateway address across all networks available under NetworkConfiguration.
|
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`.
|