pnap_bmc_api 1.5.0 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (110) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -1
  3. data/VERSION +1 -1
  4. data/docs/DeleteResult.md +1 -1
  5. data/docs/OsConfigurationCloudInit.md +1 -1
  6. data/docs/QuotasApi.md +6 -8
  7. data/docs/SSHKeysApi.md +12 -16
  8. data/docs/Server.md +11 -7
  9. data/docs/ServerCreate.md +3 -3
  10. data/docs/ServerNetworkUpdate.md +2 -2
  11. data/docs/ServerPrivateNetwork.md +3 -3
  12. data/docs/ServerProvision.md +38 -0
  13. data/docs/ServerPublicNetwork.md +2 -2
  14. data/docs/ServersApi.md +173 -111
  15. data/docs/StorageConfigurationRootPartition.md +2 -2
  16. data/lib/pnap_bmc_api/api/quotas_api.rb +11 -7
  17. data/lib/pnap_bmc_api/api/servers_api.rb +200 -75
  18. data/lib/pnap_bmc_api/api/ssh_keys_api.rb +21 -13
  19. data/lib/pnap_bmc_api/api_client.rb +24 -21
  20. data/lib/pnap_bmc_api/api_error.rb +2 -1
  21. data/lib/pnap_bmc_api/configuration.rb +28 -9
  22. data/lib/pnap_bmc_api/models/action_result.rb +16 -19
  23. data/lib/pnap_bmc_api/models/delete_result.rb +18 -19
  24. data/lib/pnap_bmc_api/models/delete_ssh_key_result.rb +18 -19
  25. data/lib/pnap_bmc_api/models/error.rb +16 -19
  26. data/lib/pnap_bmc_api/models/ip_blocks_configuration.rb +19 -20
  27. data/lib/pnap_bmc_api/models/network_configuration.rb +14 -19
  28. data/lib/pnap_bmc_api/models/os_configuration.rb +19 -20
  29. data/lib/pnap_bmc_api/models/os_configuration_cloud_init.rb +15 -20
  30. data/lib/pnap_bmc_api/models/os_configuration_map.rb +14 -19
  31. data/lib/pnap_bmc_api/models/os_configuration_map_esxi.rb +19 -20
  32. data/lib/pnap_bmc_api/models/os_configuration_map_proxmox.rb +19 -20
  33. data/lib/pnap_bmc_api/models/os_configuration_netris_controller.rb +14 -19
  34. data/lib/pnap_bmc_api/models/os_configuration_netris_softgate.rb +25 -22
  35. data/lib/pnap_bmc_api/models/os_configuration_windows.rb +19 -20
  36. data/lib/pnap_bmc_api/models/private_network_configuration.rb +14 -19
  37. data/lib/pnap_bmc_api/models/public_network_configuration.rb +14 -19
  38. data/lib/pnap_bmc_api/models/quota.rb +30 -19
  39. data/lib/pnap_bmc_api/models/quota_edit_limit_request.rb +39 -19
  40. data/lib/pnap_bmc_api/models/quota_edit_limit_request_details.rb +42 -21
  41. data/lib/pnap_bmc_api/models/relinquish_ip_block.rb +14 -19
  42. data/lib/pnap_bmc_api/models/reset_result.rb +16 -19
  43. data/lib/pnap_bmc_api/models/server.rb +79 -33
  44. data/lib/pnap_bmc_api/models/server_create.rb +29 -22
  45. data/lib/pnap_bmc_api/models/server_ip_block.rb +16 -19
  46. data/lib/pnap_bmc_api/models/server_network_update.rb +15 -20
  47. data/lib/pnap_bmc_api/models/server_patch.rb +27 -24
  48. data/lib/pnap_bmc_api/models/server_private_network.rb +23 -22
  49. data/lib/pnap_bmc_api/models/server_provision.rb +395 -0
  50. data/lib/pnap_bmc_api/models/server_public_network.rb +17 -20
  51. data/lib/pnap_bmc_api/models/server_reserve.rb +16 -19
  52. data/lib/pnap_bmc_api/models/server_reset.rb +14 -19
  53. data/lib/pnap_bmc_api/models/ssh_key.rb +28 -19
  54. data/lib/pnap_bmc_api/models/ssh_key_create.rb +52 -19
  55. data/lib/pnap_bmc_api/models/ssh_key_update.rb +29 -19
  56. data/lib/pnap_bmc_api/models/storage_configuration.rb +14 -19
  57. data/lib/pnap_bmc_api/models/storage_configuration_root_partition.rb +14 -19
  58. data/lib/pnap_bmc_api/models/tag_assignment.rb +20 -19
  59. data/lib/pnap_bmc_api/models/tag_assignment_request.rb +16 -19
  60. data/lib/pnap_bmc_api/version.rb +1 -1
  61. data/lib/pnap_bmc_api.rb +2 -2
  62. data/pnap_bmc_api.gemspec +2 -2
  63. data/spec/api/quotas_api_spec.rb +6 -6
  64. data/spec/api/servers_api_spec.rb +109 -36
  65. data/spec/api/ssh_keys_api_spec.rb +9 -9
  66. data/spec/models/action_result_spec.rb +6 -4
  67. data/spec/models/delete_result_spec.rb +7 -5
  68. data/spec/models/delete_ssh_key_result_spec.rb +7 -5
  69. data/spec/models/error_spec.rb +7 -5
  70. data/spec/models/ip_blocks_configuration_spec.rb +7 -5
  71. data/spec/models/network_configuration_spec.rb +19 -5
  72. data/spec/models/os_configuration_cloud_init_spec.rb +5 -3
  73. data/spec/models/os_configuration_map_esxi_spec.rb +8 -6
  74. data/spec/models/os_configuration_map_proxmox_spec.rb +8 -6
  75. data/spec/models/os_configuration_map_spec.rb +8 -6
  76. data/spec/models/os_configuration_netris_controller_spec.rb +7 -5
  77. data/spec/models/os_configuration_netris_softgate_spec.rb +8 -6
  78. data/spec/models/os_configuration_spec.rb +33 -7
  79. data/spec/models/os_configuration_windows_spec.rb +6 -4
  80. data/spec/models/private_network_configuration_spec.rb +8 -6
  81. data/spec/models/public_network_configuration_spec.rb +6 -4
  82. data/spec/models/quota_edit_limit_request_details_spec.rb +8 -6
  83. data/spec/models/quota_edit_limit_request_spec.rb +7 -5
  84. data/spec/models/quota_spec.rb +13 -15
  85. data/spec/models/relinquish_ip_block_spec.rb +6 -4
  86. data/spec/models/reset_result_spec.rb +8 -6
  87. data/spec/models/server_create_spec.rb +25 -17
  88. data/spec/models/server_ip_block_spec.rb +7 -5
  89. data/spec/models/server_network_update_spec.rb +5 -3
  90. data/spec/models/server_patch_spec.rb +7 -5
  91. data/spec/models/server_private_network_spec.rb +9 -7
  92. data/spec/models/server_provision_spec.rb +96 -0
  93. data/spec/models/server_public_network_spec.rb +8 -6
  94. data/spec/models/server_reserve_spec.rb +6 -4
  95. data/spec/models/server_reset_spec.rb +9 -7
  96. data/spec/models/server_spec.rb +47 -27
  97. data/spec/models/ssh_key_create_spec.rb +8 -6
  98. data/spec/models/ssh_key_spec.rb +12 -10
  99. data/spec/models/ssh_key_update_spec.rb +7 -5
  100. data/spec/models/storage_configuration_root_partition_spec.rb +6 -4
  101. data/spec/models/storage_configuration_spec.rb +5 -3
  102. data/spec/models/tag_assignment_request_spec.rb +7 -5
  103. data/spec/models/tag_assignment_spec.rb +10 -8
  104. data/spec/spec_helper.rb +1 -1
  105. metadata +38 -42
  106. data/docs/QuotaEditLimitRequestDetailsAllOf.md +0 -18
  107. data/lib/pnap_bmc_api/models/quota_edit_limit_request_details_all_of.rb +0 -226
  108. data/spec/api_client_spec.rb +0 -226
  109. data/spec/configuration_spec.rb +0 -42
  110. data/spec/models/quota_edit_limit_request_details_all_of_spec.rb +0 -34
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ead23be070e780e588d175d96edbcab2f2c0a2ae4c85805b66eec0d3ac8c7d48
4
- data.tar.gz: efff57ff9a1eebc9d0441dc022423ca05252afdc448fb507d3695c7b5e273dbd
3
+ metadata.gz: 0b52da1ba5d3cb2cd86fe0f34ad69ec7c758241a7b7e7b7420c6507daa30b667
4
+ data.tar.gz: 929d0295f55750dba4e24c1445c5bd9280f67fa7197e2166277c61fc78d929c8
5
5
  SHA512:
6
- metadata.gz: 4f92e294fc3dfcb1f1095e692bf6021706bf0dc3af962825fdaa7cd795b5cbce13abdf153a3c12703ec79b080bcefb3d007268a42335279c80885ab2d51892dd
7
- data.tar.gz: 99930beff8399c83533fd1fd0dc9573f3b97ca1fed88f1f58084bdafcde78dec24d6685d17122ca81236943f88eb3f5dfc8765e4e80fed1090a4e9313611fb21
6
+ metadata.gz: b0736faacbd6d40df864701c854e7ab71c626bc3f470c6cf8fbc8f68a3f282958c5982e6e3dfcf8daffde76c64e13709732ea50e2de91183cb38743b20f329ef
7
+ data.tar.gz: 2c949f9bba057a3720fe78a2acce897324a33bac68f0f0ca470d63e07e9dcb6b8b3084c20206a210cd8a705e32666c18349c4b3b87260db51e02c377ce4ed210
data/README.md CHANGED
@@ -75,6 +75,8 @@ require 'pnap_bmc_api'
75
75
  BmcApi.configure do |config|
76
76
  # Configure OAuth2 access token for authorization: OAuth2
77
77
  config.access_token = 'YOUR ACCESS TOKEN'
78
+ # Configure a proc to get access tokens in lieu of the static access_token configuration
79
+ config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
78
80
  end
79
81
 
80
82
  api_instance = BmcApi::QuotasApi.new
@@ -134,6 +136,7 @@ Class | Method | HTTP request | Description
134
136
  *BmcApi::ServersApi* | [**servers_server_id_actions_deprovision_post**](docs/ServersApi.md#servers_server_id_actions_deprovision_post) | **POST** /servers/{serverId}/actions/deprovision | Deprovision a server.
135
137
  *BmcApi::ServersApi* | [**servers_server_id_actions_power_off_post**](docs/ServersApi.md#servers_server_id_actions_power_off_post) | **POST** /servers/{serverId}/actions/power-off | Power off server.
136
138
  *BmcApi::ServersApi* | [**servers_server_id_actions_power_on_post**](docs/ServersApi.md#servers_server_id_actions_power_on_post) | **POST** /servers/{serverId}/actions/power-on | Power on server.
139
+ *BmcApi::ServersApi* | [**servers_server_id_actions_provision_post**](docs/ServersApi.md#servers_server_id_actions_provision_post) | **POST** /servers/{serverId}/actions/provision | Provision server.
137
140
  *BmcApi::ServersApi* | [**servers_server_id_actions_reboot_post**](docs/ServersApi.md#servers_server_id_actions_reboot_post) | **POST** /servers/{serverId}/actions/reboot | Reboot server.
138
141
  *BmcApi::ServersApi* | [**servers_server_id_actions_reserve_post**](docs/ServersApi.md#servers_server_id_actions_reserve_post) | **POST** /servers/{serverId}/actions/reserve | Reserve server.
139
142
  *BmcApi::ServersApi* | [**servers_server_id_actions_reset_post**](docs/ServersApi.md#servers_server_id_actions_reset_post) | **POST** /servers/{serverId}/actions/reset | Reset server.
@@ -172,7 +175,6 @@ Class | Method | HTTP request | Description
172
175
  - [BmcApi::Quota](docs/Quota.md)
173
176
  - [BmcApi::QuotaEditLimitRequest](docs/QuotaEditLimitRequest.md)
174
177
  - [BmcApi::QuotaEditLimitRequestDetails](docs/QuotaEditLimitRequestDetails.md)
175
- - [BmcApi::QuotaEditLimitRequestDetailsAllOf](docs/QuotaEditLimitRequestDetailsAllOf.md)
176
178
  - [BmcApi::RelinquishIpBlock](docs/RelinquishIpBlock.md)
177
179
  - [BmcApi::ResetResult](docs/ResetResult.md)
178
180
  - [BmcApi::Server](docs/Server.md)
@@ -181,6 +183,7 @@ Class | Method | HTTP request | Description
181
183
  - [BmcApi::ServerNetworkUpdate](docs/ServerNetworkUpdate.md)
182
184
  - [BmcApi::ServerPatch](docs/ServerPatch.md)
183
185
  - [BmcApi::ServerPrivateNetwork](docs/ServerPrivateNetwork.md)
186
+ - [BmcApi::ServerProvision](docs/ServerProvision.md)
184
187
  - [BmcApi::ServerPublicNetwork](docs/ServerPublicNetwork.md)
185
188
  - [BmcApi::ServerReserve](docs/ServerReserve.md)
186
189
  - [BmcApi::ServerReset](docs/ServerReset.md)
@@ -196,6 +199,7 @@ Class | Method | HTTP request | Description
196
199
  ## Documentation for Authorization
197
200
 
198
201
 
202
+ Authentication schemes defined for the API:
199
203
  ### OAuth2
200
204
 
201
205
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.5.0
1
+ 2.0.0
data/docs/DeleteResult.md CHANGED
@@ -14,7 +14,7 @@ require 'pnap_bmc_api'
14
14
 
15
15
  instance = BmcApi::DeleteResult.new(
16
16
  result: Server has been deleted.,
17
- server_id: x78sdkjds879sd7cx8
17
+ server_id: 651bf71fbde0c93e102ab180
18
18
  )
19
19
  ```
20
20
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
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] |
7
+ | **user_data** | **String** | (Write-only) 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
8
 
9
9
  ## Example
10
10
 
data/docs/QuotasApi.md CHANGED
@@ -77,7 +77,7 @@ This endpoint does not need any parameter.
77
77
 
78
78
  ## quotas_quota_id_actions_request_edit_post
79
79
 
80
- > quotas_quota_id_actions_request_edit_post(quota_id, opts)
80
+ > quotas_quota_id_actions_request_edit_post(quota_id, quota_edit_limit_request)
81
81
 
82
82
  Request quota limit change.
83
83
 
@@ -96,13 +96,11 @@ end
96
96
 
97
97
  api_instance = BmcApi::QuotasApi.new
98
98
  quota_id = 'bmc.servers.max_count' # String | The ID of the Quota.
99
- opts = {
100
- quota_edit_limit_request: BmcApi::QuotaEditLimitRequest.new({limit: 10, reason: 'I need more servers for my cluster.'}) # QuotaEditLimitRequest |
101
- }
99
+ quota_edit_limit_request = BmcApi::QuotaEditLimitRequest.new({limit: 10, reason: 'I need more servers for my cluster.'}) # QuotaEditLimitRequest |
102
100
 
103
101
  begin
104
102
  # Request quota limit change.
105
- api_instance.quotas_quota_id_actions_request_edit_post(quota_id, opts)
103
+ api_instance.quotas_quota_id_actions_request_edit_post(quota_id, quota_edit_limit_request)
106
104
  rescue BmcApi::ApiError => e
107
105
  puts "Error when calling QuotasApi->quotas_quota_id_actions_request_edit_post: #{e}"
108
106
  end
@@ -112,12 +110,12 @@ end
112
110
 
113
111
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
114
112
 
115
- > <Array(nil, Integer, Hash)> quotas_quota_id_actions_request_edit_post_with_http_info(quota_id, opts)
113
+ > <Array(nil, Integer, Hash)> quotas_quota_id_actions_request_edit_post_with_http_info(quota_id, quota_edit_limit_request)
116
114
 
117
115
  ```ruby
118
116
  begin
119
117
  # Request quota limit change.
120
- data, status_code, headers = api_instance.quotas_quota_id_actions_request_edit_post_with_http_info(quota_id, opts)
118
+ data, status_code, headers = api_instance.quotas_quota_id_actions_request_edit_post_with_http_info(quota_id, quota_edit_limit_request)
121
119
  p status_code # => 2xx
122
120
  p headers # => { ... }
123
121
  p data # => nil
@@ -131,7 +129,7 @@ end
131
129
  | Name | Type | Description | Notes |
132
130
  | ---- | ---- | ----------- | ----- |
133
131
  | **quota_id** | **String** | The ID of the Quota. | |
134
- | **quota_edit_limit_request** | [**QuotaEditLimitRequest**](QuotaEditLimitRequest.md) | | [optional] |
132
+ | **quota_edit_limit_request** | [**QuotaEditLimitRequest**](QuotaEditLimitRequest.md) | | |
135
133
 
136
134
  ### Return type
137
135
 
data/docs/SSHKeysApi.md CHANGED
@@ -79,7 +79,7 @@ This endpoint does not need any parameter.
79
79
 
80
80
  ## ssh_keys_post
81
81
 
82
- > <SshKey> ssh_keys_post(opts)
82
+ > <SshKey> ssh_keys_post(ssh_key_create)
83
83
 
84
84
  Create SSH Key.
85
85
 
@@ -97,13 +97,11 @@ BmcApi.configure do |config|
97
97
  end
98
98
 
99
99
  api_instance = BmcApi::SSHKeysApi.new
100
- opts = {
101
- ssh_key_create: BmcApi::SshKeyCreate.new({default: true, name: 'sshkey-name-01', key: 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDF9LdAFElNCi7JoWh6KUcchrJ2Gac1aqGRPpdZNowObpRtmiRCecAMb7bUgNAaNfcmwiQi7tos9TlnFgprIcfMWb8MSs3ABYHmBgqEEt3RWYf0fAc9CsIpJdMCUG28TPGTlRXCEUVNKgLMdcseAlJoGp1CgbHWIN65fB3he3kAZcfpPn5mapV0tsl2p+ZyuAGRYdn5dJv2RZDHUZBkOeUobwsij+weHCKAFmKQKtCP7ybgVHaQjAPrj8MGnk1jBbjDt5ws+Be+9JNjQJee9zCKbAOsIo3i+GcUIkrw5jxPU/RTGlWBcemPaKHdciSzGcjWboapzIy49qypQhZe1U75 user@my_ip'}) # SshKeyCreate |
102
- }
100
+ ssh_key_create = BmcApi::SshKeyCreate.new({default: true, name: 'sshkey-name-01', key: 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDF9LdAFElNCi7JoWh6KUcchrJ2Gac1aqGRPpdZNowObpRtmiRCecAMb7bUgNAaNfcmwiQi7tos9TlnFgprIcfMWb8MSs3ABYHmBgqEEt3RWYf0fAc9CsIpJdMCUG28TPGTlRXCEUVNKgLMdcseAlJoGp1CgbHWIN65fB3he3kAZcfpPn5mapV0tsl2p+ZyuAGRYdn5dJv2RZDHUZBkOeUobwsij+weHCKAFmKQKtCP7ybgVHaQjAPrj8MGnk1jBbjDt5ws+Be+9JNjQJee9zCKbAOsIo3i+GcUIkrw5jxPU/RTGlWBcemPaKHdciSzGcjWboapzIy49qypQhZe1U75 user@my_ip'}) # SshKeyCreate |
103
101
 
104
102
  begin
105
103
  # Create SSH Key.
106
- result = api_instance.ssh_keys_post(opts)
104
+ result = api_instance.ssh_keys_post(ssh_key_create)
107
105
  p result
108
106
  rescue BmcApi::ApiError => e
109
107
  puts "Error when calling SSHKeysApi->ssh_keys_post: #{e}"
@@ -114,12 +112,12 @@ end
114
112
 
115
113
  This returns an Array which contains the response data, status code and headers.
116
114
 
117
- > <Array(<SshKey>, Integer, Hash)> ssh_keys_post_with_http_info(opts)
115
+ > <Array(<SshKey>, Integer, Hash)> ssh_keys_post_with_http_info(ssh_key_create)
118
116
 
119
117
  ```ruby
120
118
  begin
121
119
  # Create SSH Key.
122
- data, status_code, headers = api_instance.ssh_keys_post_with_http_info(opts)
120
+ data, status_code, headers = api_instance.ssh_keys_post_with_http_info(ssh_key_create)
123
121
  p status_code # => 2xx
124
122
  p headers # => { ... }
125
123
  p data # => <SshKey>
@@ -132,7 +130,7 @@ end
132
130
 
133
131
  | Name | Type | Description | Notes |
134
132
  | ---- | ---- | ----------- | ----- |
135
- | **ssh_key_create** | [**SshKeyCreate**](SshKeyCreate.md) | | [optional] |
133
+ | **ssh_key_create** | [**SshKeyCreate**](SshKeyCreate.md) | | |
136
134
 
137
135
  ### Return type
138
136
 
@@ -288,7 +286,7 @@ end
288
286
 
289
287
  ## ssh_keys_ssh_key_id_put
290
288
 
291
- > <SshKey> ssh_keys_ssh_key_id_put(ssh_key_id, opts)
289
+ > <SshKey> ssh_keys_ssh_key_id_put(ssh_key_id, ssh_key_update)
292
290
 
293
291
  Edit SSH Key.
294
292
 
@@ -307,13 +305,11 @@ end
307
305
 
308
306
  api_instance = BmcApi::SSHKeysApi.new
309
307
  ssh_key_id = '5fa54d1e91867c03a0a7b4a4' # String | The SSH Key's ID.
310
- opts = {
311
- ssh_key_update: BmcApi::SshKeyUpdate.new({default: true, name: 'sshkey-name-01'}) # SshKeyUpdate |
312
- }
308
+ ssh_key_update = BmcApi::SshKeyUpdate.new({default: true, name: 'sshkey-name-01'}) # SshKeyUpdate |
313
309
 
314
310
  begin
315
311
  # Edit SSH Key.
316
- result = api_instance.ssh_keys_ssh_key_id_put(ssh_key_id, opts)
312
+ result = api_instance.ssh_keys_ssh_key_id_put(ssh_key_id, ssh_key_update)
317
313
  p result
318
314
  rescue BmcApi::ApiError => e
319
315
  puts "Error when calling SSHKeysApi->ssh_keys_ssh_key_id_put: #{e}"
@@ -324,12 +320,12 @@ end
324
320
 
325
321
  This returns an Array which contains the response data, status code and headers.
326
322
 
327
- > <Array(<SshKey>, Integer, Hash)> ssh_keys_ssh_key_id_put_with_http_info(ssh_key_id, opts)
323
+ > <Array(<SshKey>, Integer, Hash)> ssh_keys_ssh_key_id_put_with_http_info(ssh_key_id, ssh_key_update)
328
324
 
329
325
  ```ruby
330
326
  begin
331
327
  # Edit SSH Key.
332
- data, status_code, headers = api_instance.ssh_keys_ssh_key_id_put_with_http_info(ssh_key_id, opts)
328
+ data, status_code, headers = api_instance.ssh_keys_ssh_key_id_put_with_http_info(ssh_key_id, ssh_key_update)
333
329
  p status_code # => 2xx
334
330
  p headers # => { ... }
335
331
  p data # => <SshKey>
@@ -343,7 +339,7 @@ end
343
339
  | Name | Type | Description | Notes |
344
340
  | ---- | ---- | ----------- | ----- |
345
341
  | **ssh_key_id** | **String** | The SSH Key&#39;s ID. | |
346
- | **ssh_key_update** | [**SshKeyUpdate**](SshKeyUpdate.md) | | [optional] |
342
+ | **ssh_key_update** | [**SshKeyUpdate**](SshKeyUpdate.md) | | |
347
343
 
348
344
  ### Return type
349
345
 
data/docs/Server.md CHANGED
@@ -5,11 +5,11 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | The unique identifier of the server. | |
8
- | **status** | **String** | The status of the server. | |
8
+ | **status** | **String** | The status of the server. Can have one of the following values: &#x60;creating&#x60; , &#x60;powered-on&#x60; , &#x60;powered-off&#x60; , &#x60;rebooting&#x60; , &#x60;resetting&#x60; , &#x60;deleting&#x60; , &#x60;reserved&#x60; , &#x60;error&#x60; or &#x60;reinstating&#x60;. | |
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 &#x60;ubuntu/bionic&#x60;, &#x60;ubuntu/focal&#x60;, &#x60;ubuntu/jammy&#x60;, &#x60;centos/centos7&#x60;, &#x60;centos/centos8&#x60;, &#x60;windows/srv2019std&#x60;, &#x60;windows/srv2019dc&#x60;, &#x60;esxi/esxi70&#x60;, &#x60;esxi/esxi80&#x60;, &#x60;debian/bullseye&#x60;, &#x60;proxmox/bullseye&#x60;, &#x60;netris/controller&#x60;, &#x60;netris/softgate_1g&#x60; or &#x60;netris/softgate_10g&#x60;. | |
12
- | **type** | **String** | Server type ID. Cannot be changed once a server is created. Currently this field should be set to either &#x60;s0.d1.small&#x60;, &#x60;s0.d1.medium&#x60;, &#x60;s1.c1.small&#x60;, &#x60;s1.c1.medium&#x60;, &#x60;s1.c2.medium&#x60;, &#x60;s1.c2.large&#x60;, &#x60;s1.e1.small&#x60;, &#x60;s1.e1.medium&#x60;, &#x60;s1.e1.large&#x60;, &#x60;s2.c1.small&#x60;, &#x60;s2.c1.medium&#x60;, &#x60;s2.c1.large&#x60;, &#x60;s2.c2.small&#x60;, &#x60;s2.c2.medium&#x60;, &#x60;s2.c2.large&#x60;, &#x60;d1.c1.small&#x60;, &#x60;d1.c2.small&#x60;, &#x60;d1.c3.small&#x60;, &#x60;d1.c4.small&#x60;, &#x60;d1.c1.medium&#x60;, &#x60;d1.c2.medium&#x60;, &#x60;d1.c3.medium&#x60;, &#x60;d1.c4.medium&#x60;, &#x60;d1.c1.large&#x60;, &#x60;d1.c2.large&#x60;, &#x60;d1.c3.large&#x60;, &#x60;d1.c4.large&#x60;, &#x60;d1.m1.medium&#x60;, &#x60;d1.m2.medium&#x60;, &#x60;d1.m3.medium&#x60;, &#x60;d1.m4.medium&#x60;, &#x60;d2.c1.medium&#x60;, &#x60;d2.c2.medium&#x60;, &#x60;d2.c3.medium&#x60;, &#x60;d2.c4.medium&#x60;, &#x60;d2.c5.medium&#x60;, &#x60;d2.c1.large&#x60;, &#x60;d2.c2.large&#x60;, &#x60;d2.c3.large&#x60;, &#x60;d2.c4.large&#x60;, &#x60;d2.c5.large&#x60;, &#x60;d2.m1.medium&#x60;, &#x60;d2.m1.large&#x60;, &#x60;d2.m2.medium&#x60;, &#x60;d2.m2.large&#x60;, &#x60;d2.m2.xlarge&#x60;, &#x60;d2.c4.db1.pliops1&#x60;, &#x60;d3.m4.xlarge&#x60;, &#x60;d3.m5.xlarge&#x60;, &#x60;d3.m6.xlarge&#x60; or &#x60;a1.c5.large&#x60;. | |
11
+ | **os** | **String** | The server’s OS ID used when the server was created. Currently this field should be set to either &#x60;ubuntu/bionic&#x60;, &#x60;ubuntu/focal&#x60;, &#x60;ubuntu/jammy&#x60;, &#x60;centos/centos7&#x60;, &#x60;centos/centos8&#x60;, &#x60;windows/srv2019std&#x60;, &#x60;windows/srv2019dc&#x60;, &#x60;windows/srv2022std&#x60;, &#x60;windows/srv2022dc&#x60;, &#x60;esxi/esxi70&#x60;, &#x60;esxi/esxi80&#x60;, &#x60;almalinux/almalinux8&#x60;, &#x60;rockylinux/rockylinux8&#x60;, &#x60;almalinux/almalinux9&#x60;, &#x60;rockylinux/rockylinux9&#x60;, &#x60;debian/bullseye&#x60;, &#x60;debian/bookworm&#x60;, &#x60;proxmox/bullseye&#x60;, &#x60;netris/controller&#x60;, &#x60;netris/softgate_1g&#x60;, &#x60;netris/softgate_10g&#x60; or &#x60;netris/softgate_25g&#x60;. | [optional] |
12
+ | **type** | **String** | Server type ID. Cannot be changed once a server is created. Currently this field should be set to either &#x60;s0.d1.small&#x60;, &#x60;s0.d1.medium&#x60;, &#x60;s1.c1.small&#x60;, &#x60;s1.c1.medium&#x60;, &#x60;s1.c2.medium&#x60;, &#x60;s1.c2.large&#x60;, &#x60;s1.e1.small&#x60;, &#x60;s1.e1.medium&#x60;, &#x60;s1.e1.large&#x60;, &#x60;s2.c1.small&#x60;, &#x60;s2.c1.medium&#x60;, &#x60;s2.c1.large&#x60;, &#x60;s2.c2.small&#x60;, &#x60;s2.c2.medium&#x60;, &#x60;s2.c2.large&#x60;, &#x60;d1.c1.small&#x60;, &#x60;d1.c2.small&#x60;, &#x60;d1.c3.small&#x60;, &#x60;d1.c4.small&#x60;, &#x60;d1.c1.medium&#x60;, &#x60;d1.c2.medium&#x60;, &#x60;d1.c3.medium&#x60;, &#x60;d1.c4.medium&#x60;, &#x60;d1.c1.large&#x60;, &#x60;d1.c2.large&#x60;, &#x60;d1.c3.large&#x60;, &#x60;d1.c4.large&#x60;, &#x60;d1.m1.medium&#x60;, &#x60;d1.m2.medium&#x60;, &#x60;d1.m3.medium&#x60;, &#x60;d1.m4.medium&#x60;, &#x60;d2.c1.medium&#x60;, &#x60;d2.c2.medium&#x60;, &#x60;d2.c3.medium&#x60;, &#x60;d2.c4.medium&#x60;, &#x60;d2.c5.medium&#x60;, &#x60;d2.c1.large&#x60;, &#x60;d2.c2.large&#x60;, &#x60;d2.c3.large&#x60;, &#x60;d2.c4.large&#x60;, &#x60;d2.c5.large&#x60;, &#x60;d2.m1.xlarge&#x60;, &#x60;d2.m2.xxlarge&#x60;, &#x60;d2.m3.xlarge&#x60;, &#x60;d2.m4.xlarge&#x60;, &#x60;d2.m5.xlarge&#x60;, &#x60;d2.c4.db1.pliops1&#x60;, &#x60;d3.m4.xlarge&#x60;, &#x60;d3.m5.xlarge&#x60;, &#x60;d3.m6.xlarge&#x60;, &#x60;a1.c5.large&#x60;, &#x60;d3.s5.xlarge&#x60;, &#x60;d3.m4.xxlarge&#x60;, &#x60;d3.m5.xxlarge&#x60; or &#x60;d3.m6.xxlarge&#x60;. | |
13
13
  | **location** | **String** | Server location ID. Cannot be changed once a server is created. Currently this field should be set to &#x60;PHX&#x60;, &#x60;ASH&#x60;, &#x60;SGP&#x60;, &#x60;NLD&#x60;, &#x60;CHI&#x60;, &#x60;SEA&#x60; or &#x60;AUS&#x60;. | |
14
14
  | **cpu** | **String** | A description of the machine CPU. | |
15
15
  | **cpu_count** | **Integer** | The number of CPUs available in the system. | |
@@ -29,6 +29,8 @@
29
29
  | **os_configuration** | [**OsConfiguration**](OsConfiguration.md) | | [optional] |
30
30
  | **network_configuration** | [**NetworkConfiguration**](NetworkConfiguration.md) | | |
31
31
  | **storage_configuration** | [**StorageConfiguration**](StorageConfiguration.md) | | |
32
+ | **superseded_by** | **String** | Unique identifier of the server to which the reservation has been transferred. | [optional] |
33
+ | **supersedes** | **String** | Unique identifier of the server from which the reservation has been transferred. | [optional] |
32
34
 
33
35
  ## Example
34
36
 
@@ -36,7 +38,7 @@
36
38
  require 'pnap_bmc_api'
37
39
 
38
40
  instance = BmcApi::Server.new(
39
- id: x78sdkjds879sd7cx8,
41
+ id: 651bf71fbde0c93e102ab180,
40
42
  status: creating,
41
43
  hostname: my-server-1,
42
44
  description: Server #1 used for computing.,
@@ -51,16 +53,18 @@ instance = BmcApi::Server.new(
51
53
  storage: 1x 960GB NVMe,
52
54
  private_ip_addresses: [&quot;172.16.0.1&quot;],
53
55
  public_ip_addresses: [&quot;182.16.0.1&quot;,&quot;183.16.0.1&quot;],
54
- reservation_id: x78sdkjds879sd7cx8,
56
+ reservation_id: fc8bd49a-59cc-4538-a806-5e46228408ec,
55
57
  pricing_model: HOURLY,
56
58
  password: MyP@ssw0rd_01,
57
59
  network_type: PUBLIC_AND_PRIVATE,
58
- cluster_id: x78sdkjds879sd7cx8,
60
+ cluster_id: 65030122f253707f7d196bed,
59
61
  tags: null,
60
62
  provisioned_on: 2021-03-13T20:24:32.491Z,
61
63
  os_configuration: null,
62
64
  network_configuration: null,
63
- storage_configuration: null
65
+ storage_configuration: null,
66
+ superseded_by: 64a539b8d9c2c9ba8424ca31,
67
+ supersedes: 76915b5c85121d411f26e92f
64
68
  )
65
69
  ```
66
70
 
data/docs/ServerCreate.md CHANGED
@@ -6,8 +6,8 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **hostname** | **String** | Hostname of server. | |
8
8
  | **description** | **String** | Description of server. | [optional] |
9
- | **os** | **String** | The server’s OS ID used when the server was created. Currently this field should be set to either &#x60;ubuntu/bionic&#x60;, &#x60;ubuntu/focal&#x60;, &#x60;ubuntu/jammy&#x60;, &#x60;centos/centos7&#x60;, &#x60;centos/centos8&#x60;, &#x60;windows/srv2019std&#x60;, &#x60;windows/srv2019dc&#x60;, &#x60;esxi/esxi70&#x60;, &#x60;esxi/esxi80&#x60;, &#x60;debian/bullseye&#x60;, &#x60;proxmox/bullseye&#x60;, &#x60;netris/controller&#x60;, &#x60;netris/softgate_1g&#x60; or &#x60;netris/softgate_10g&#x60;. | |
10
- | **type** | **String** | Server type ID. Cannot be changed once a server is created. Currently this field should be set to either &#x60;s0.d1.small&#x60;, &#x60;s0.d1.medium&#x60;, &#x60;s1.c1.small&#x60;, &#x60;s1.c1.medium&#x60;, &#x60;s1.c2.medium&#x60;, &#x60;s1.c2.large&#x60;, &#x60;s1.e1.small&#x60;, &#x60;s1.e1.medium&#x60;, &#x60;s1.e1.large&#x60;, &#x60;s2.c1.small&#x60;, &#x60;s2.c1.medium&#x60;, &#x60;s2.c1.large&#x60;, &#x60;s2.c2.small&#x60;, &#x60;s2.c2.medium&#x60;, &#x60;s2.c2.large&#x60;, &#x60;d1.c1.small&#x60;, &#x60;d1.c2.small&#x60;, &#x60;d1.c3.small&#x60;, &#x60;d1.c4.small&#x60;, &#x60;d1.c1.medium&#x60;, &#x60;d1.c2.medium&#x60;, &#x60;d1.c3.medium&#x60;, &#x60;d1.c4.medium&#x60;, &#x60;d1.c1.large&#x60;, &#x60;d1.c2.large&#x60;, &#x60;d1.c3.large&#x60;, &#x60;d1.c4.large&#x60;, &#x60;d1.m1.medium&#x60;, &#x60;d1.m2.medium&#x60;, &#x60;d1.m3.medium&#x60;, &#x60;d1.m4.medium&#x60;, &#x60;d2.c1.medium&#x60;, &#x60;d2.c2.medium&#x60;, &#x60;d2.c3.medium&#x60;, &#x60;d2.c4.medium&#x60;, &#x60;d2.c5.medium&#x60;, &#x60;d2.c1.large&#x60;, &#x60;d2.c2.large&#x60;, &#x60;d2.c3.large&#x60;, &#x60;d2.c4.large&#x60;, &#x60;d2.c5.large&#x60;, &#x60;d2.m1.medium&#x60;, &#x60;d2.m1.large&#x60;, &#x60;d2.m2.medium&#x60;, &#x60;d2.m2.large&#x60;, &#x60;d2.m2.xlarge&#x60;, &#x60;d2.c4.db1.pliops1&#x60;, &#x60;d3.m4.xlarge&#x60;, &#x60;d3.m5.xlarge&#x60;, &#x60;d3.m6.xlarge&#x60; or &#x60;a1.c5.large&#x60;. | |
9
+ | **os** | **String** | The server’s OS ID used when the server was created. Currently this field should be set to either &#x60;ubuntu/bionic&#x60;, &#x60;ubuntu/focal&#x60;, &#x60;ubuntu/jammy&#x60;, &#x60;centos/centos7&#x60;, &#x60;centos/centos8&#x60;, &#x60;windows/srv2019std&#x60;, &#x60;windows/srv2019dc&#x60;, &#x60;windows/srv2022std&#x60;, &#x60;windows/srv2022dc&#x60;, &#x60;esxi/esxi70&#x60;, &#x60;esxi/esxi80&#x60;, &#x60;almalinux/almalinux8&#x60;, &#x60;rockylinux/rockylinux8&#x60;, &#x60;almalinux/almalinux9&#x60;, &#x60;rockylinux/rockylinux9&#x60;, &#x60;virtuozzo/virtuozzo7&#x60;, &#x60;debian/bullseye&#x60;, &#x60;debian/bookworm&#x60;, &#x60;proxmox/bullseye&#x60;, &#x60;netris/controller&#x60;, &#x60;netris/softgate_1g&#x60;, &#x60;netris/softgate_10g&#x60; or &#x60;netris/softgate_25g&#x60;. | |
10
+ | **type** | **String** | Server type ID. Cannot be changed once a server is created. Currently this field should be set to either &#x60;s0.d1.small&#x60;, &#x60;s0.d1.medium&#x60;, &#x60;s1.c1.small&#x60;, &#x60;s1.c1.medium&#x60;, &#x60;s1.c2.medium&#x60;, &#x60;s1.c2.large&#x60;, &#x60;s1.e1.small&#x60;, &#x60;s1.e1.medium&#x60;, &#x60;s1.e1.large&#x60;, &#x60;s2.c1.small&#x60;, &#x60;s2.c1.medium&#x60;, &#x60;s2.c1.large&#x60;, &#x60;s2.c2.small&#x60;, &#x60;s2.c2.medium&#x60;, &#x60;s2.c2.large&#x60;, &#x60;d1.c1.small&#x60;, &#x60;d1.c2.small&#x60;, &#x60;d1.c3.small&#x60;, &#x60;d1.c4.small&#x60;, &#x60;d1.c1.medium&#x60;, &#x60;d1.c2.medium&#x60;, &#x60;d1.c3.medium&#x60;, &#x60;d1.c4.medium&#x60;, &#x60;d1.c1.large&#x60;, &#x60;d1.c2.large&#x60;, &#x60;d1.c3.large&#x60;, &#x60;d1.c4.large&#x60;, &#x60;d1.m1.medium&#x60;, &#x60;d1.m2.medium&#x60;, &#x60;d1.m3.medium&#x60;, &#x60;d1.m4.medium&#x60;, &#x60;d2.c1.medium&#x60;, &#x60;d2.c2.medium&#x60;, &#x60;d2.c3.medium&#x60;, &#x60;d2.c4.medium&#x60;, &#x60;d2.c5.medium&#x60;, &#x60;d2.c1.large&#x60;, &#x60;d2.c2.large&#x60;, &#x60;d2.c3.large&#x60;, &#x60;d2.c4.large&#x60;, &#x60;d2.c5.large&#x60;, &#x60;d2.m1.xlarge&#x60;, &#x60;d2.m2.xxlarge&#x60;, &#x60;d2.m3.xlarge&#x60;, &#x60;d2.m4.xlarge&#x60;, &#x60;d2.m5.xlarge&#x60;, &#x60;d2.c4.db1.pliops1&#x60;, &#x60;d3.m4.xlarge&#x60;, &#x60;d3.m5.xlarge&#x60;, &#x60;d3.m6.xlarge&#x60;, &#x60;a1.c5.large&#x60;, &#x60;d3.s5.xlarge&#x60;, &#x60;d3.m4.xxlarge&#x60;, &#x60;d3.m5.xxlarge&#x60; or &#x60;d3.m6.xxlarge&#x60;. | |
11
11
  | **location** | **String** | Server location ID. Cannot be changed once a server is created. Currently this field should be set to &#x60;PHX&#x60;, &#x60;ASH&#x60;, &#x60;SGP&#x60;, &#x60;NLD&#x60;, &#x60;CHI&#x60;, &#x60;SEA&#x60; or &#x60;AUS&#x60;. | |
12
12
  | **install_default_ssh_keys** | **Boolean** | Whether or not to install SSH keys marked as default in addition to any SSH keys specified in this request. | [optional][default to true] |
13
13
  | **ssh_keys** | **Array&lt;String&gt;** | A list of SSH keys that will be installed on the server. | [optional] |
@@ -34,7 +34,7 @@ instance = BmcApi::ServerCreate.new(
34
34
  install_default_ssh_keys: false,
35
35
  ssh_keys: [&quot;ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDF9LdAFElNCi7JoWh6KUcchrJ2Gac1aqGRPpdZNowObpRtmiRCecAMb7bUgNAaNfcmwiQi7tos9TlnFgprIcfMWb8MSs3ABYHmBgqEEt3RWYf0fAc9CsIpJdMCUG28TPGTlRXCEUVNKgLMdcseAlJoGp1CgbHWIN65fB3he3kAZcfpPn5mapV0tsl2p+ZyuAGRYdn5dJv2RZDHUZBkOeUobwsij+weHCKAFmKQKtCP7ybgVHaQjAPrj8MGnk1jBbjDt5ws+Be+9JNjQJee9zCKbAOsIo3i+GcUIkrw5jxPU/RTGlWBcemPaKHdciSzGcjWboapzIy49qypQhZe1U75 user@my_ip&quot;],
36
36
  ssh_key_ids: [&quot;5fa942e71c16abcfbead275f&quot;,&quot;5fa94303cc6dc49346404fca&quot;,&quot;5fa943127bda760ad80c237e&quot;],
37
- reservation_id: 5f622c8032b458306b40d824,
37
+ reservation_id: fc8bd49a-59cc-4538-a806-5e46228408ec,
38
38
  pricing_model: ONE_MONTH_RESERVATION,
39
39
  network_type: PUBLIC_AND_PRIVATE,
40
40
  os_configuration: null,
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **ips** | **Array&lt;String&gt;** | List of IPs to be associated to the server.&lt;br&gt; Setting the &#x60;force&#x60; query parameter to &#x60;true&#x60; allows you to:&lt;ul&gt; &lt;li&gt; Assign no specific IP addresses by designating an empty array of IPs. &lt;li&gt; Assign one or more IP addresses which are already configured on other resource(s) in network.&lt;/ul&gt; | [optional] |
7
+ | **ips** | **Array&lt;String&gt;** | List of IPs to be associated to the server.&lt;br&gt; Valid IP formats are single IPv4 addresses or IPv4 ranges. IPs must be within the network&#39;s range.&lt;br&gt; Setting the &#x60;force&#x60; query parameter to &#x60;true&#x60; allows you to:&lt;ul&gt; &lt;li&gt; Assign no specific IP addresses by designating an empty array of IPs. &lt;li&gt; Assign one or more IP addresses which are already configured on other resource(s) in network. &lt;li&gt; Assign IP addresses which are considered as reserved in network.&lt;/ul&gt; | [optional] |
8
8
 
9
9
  ## Example
10
10
 
@@ -12,7 +12,7 @@
12
12
  require 'pnap_bmc_api'
13
13
 
14
14
  instance = BmcApi::ServerNetworkUpdate.new(
15
- ips: [&quot;10.1.1.1&quot;,&quot;10.1.1.2&quot;]
15
+ ips: [&quot;10.1.1.1&quot;,&quot;10.1.1.20 - 10.1.1.25&quot;]
16
16
  )
17
17
  ```
18
18
 
@@ -5,8 +5,8 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | The network identifier. | |
8
- | **ips** | **Array&lt;String&gt;** | IPs to configure/configured on the server.&lt;br&gt; Should be null or empty list if DHCP is true. IPs must be within the network&#39;s range.&lt;br&gt; If field is undefined and DHCP is false, next available IP in network will be automatically allocated.&lt;br&gt; If the network contains a membership of type &#39;storage&#39;, the first twelve IPs are already reserved by BMC and not usable.&lt;br&gt; Setting the &#x60;force&#x60; query parameter to &#x60;true&#x60; allows you to:&lt;ul&gt; &lt;li&gt; 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. &lt;li&gt; Assign one or more IP addresses which are already configured on other resource(s) in network.&lt;/ul&gt; | [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] |
8
+ | **ips** | **Array&lt;String&gt;** | IPs to configure/configured on the server.&lt;br&gt; Valid IP formats are single IPv4 addresses or IPv4 ranges. IPs must be within the network&#39;s range. Should be null or empty list if DHCP is true. &lt;br&gt; If field is undefined and DHCP is false, next available IP in network will be automatically allocated.&lt;br&gt; If the network contains a membership of type &#39;storage&#39;, the first twelve IPs are already reserved by BMC and not usable.&lt;br&gt; Setting the &#x60;force&#x60; query parameter to &#x60;true&#x60; allows you to:&lt;ul&gt; &lt;li&gt; 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. &lt;li&gt; Assign one or more IP addresses which are already configured on other resource(s) in network. &lt;li&gt; Assign IP addresses which are considered as reserved in network.&lt;/ul&gt; | [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. | [optional][default to false] |
10
10
  | **status_description** | **String** | (Read-only) The status of the network. | [optional][readonly] |
11
11
 
12
12
  ## Example
@@ -16,7 +16,7 @@ require 'pnap_bmc_api'
16
16
 
17
17
  instance = BmcApi::ServerPrivateNetwork.new(
18
18
  id: 603f3b2cfcaf050643b89a4b,
19
- ips: [&quot;10.1.1.1&quot;,&quot;10.1.1.2&quot;],
19
+ ips: [&quot;10.1.1.1&quot;,&quot;10.1.1.20 - 10.1.1.25&quot;],
20
20
  dhcp: false,
21
21
  status_description: assigned
22
22
  )
@@ -0,0 +1,38 @@
1
+ # BmcApi::ServerProvision
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **hostname** | **String** | Hostname of server. | |
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 &#x60;ubuntu/bionic&#x60;, &#x60;ubuntu/focal&#x60;, &#x60;ubuntu/jammy&#x60;, &#x60;centos/centos7&#x60;, &#x60;centos/centos8&#x60;, &#x60;windows/srv2019std&#x60;, &#x60;windows/srv2019dc&#x60;, &#x60;windows/srv2022std&#x60;, &#x60;windows/srv2022dc&#x60;, &#x60;esxi/esxi70&#x60;, &#x60;esxi/esxi80&#x60;, &#x60;almalinux/almalinux8&#x60;, &#x60;rockylinux/rockylinux8&#x60;, &#x60;debian/bullseye&#x60;, &#x60;debian/bookworm&#x60;, &#x60;proxmox/bullseye&#x60;, &#x60;netris/controller&#x60;, &#x60;netris/softgate_1g&#x60;, &#x60;netris/softgate_10g&#x60; or &#x60;netris/softgate_25g&#x60;. | |
10
+ | **install_default_ssh_keys** | **Boolean** | Whether or not to install SSH keys marked as default in addition to any SSH keys specified in this request. | [optional][default to true] |
11
+ | **ssh_keys** | **Array&lt;String&gt;** | A list of SSH keys that will be installed on the server. | [optional] |
12
+ | **ssh_key_ids** | **Array&lt;String&gt;** | A list of SSH key IDs that will be installed on the server in addition to any SSH keys specified in this request. | [optional] |
13
+ | **network_type** | **String** | The type of network configuration for this server.&lt;br&gt; Currently this field should be set to &#x60;PUBLIC_AND_PRIVATE&#x60;, &#x60;PRIVATE_ONLY&#x60;, &#x60;PUBLIC_ONLY&#x60; or &#x60;USER_DEFINED&#x60;.&lt;br&gt; Setting the &#x60;force&#x60; query parameter to &#x60;true&#x60; allows you to configure network configuration type as &#x60;NONE&#x60;. | [optional][default to &#39;PUBLIC_AND_PRIVATE&#39;] |
14
+ | **os_configuration** | [**OsConfiguration**](OsConfiguration.md) | | [optional] |
15
+ | **tags** | [**Array&lt;TagAssignmentRequest&gt;**](TagAssignmentRequest.md) | Tags to set to the server. To create a new tag or list all the existing tags that you can use, refer to [Tags API](https://developers.phoenixnap.com/docs/tags/1/overview). | [optional] |
16
+ | **network_configuration** | [**NetworkConfiguration**](NetworkConfiguration.md) | | [optional] |
17
+ | **storage_configuration** | [**StorageConfiguration**](StorageConfiguration.md) | | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'pnap_bmc_api'
23
+
24
+ instance = BmcApi::ServerProvision.new(
25
+ hostname: my-server-1,
26
+ description: Server #1 used for computing.,
27
+ os: ubuntu/bionic,
28
+ install_default_ssh_keys: false,
29
+ ssh_keys: [&quot;ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDF9LdAFElNCi7JoWh6KUcchrJ2Gac1aqGRPpdZNowObpRtmiRCecAMb7bUgNAaNfcmwiQi7tos9TlnFgprIcfMWb8MSs3ABYHmBgqEEt3RWYf0fAc9CsIpJdMCUG28TPGTlRXCEUVNKgLMdcseAlJoGp1CgbHWIN65fB3he3kAZcfpPn5mapV0tsl2p+ZyuAGRYdn5dJv2RZDHUZBkOeUobwsij+weHCKAFmKQKtCP7ybgVHaQjAPrj8MGnk1jBbjDt5ws+Be+9JNjQJee9zCKbAOsIo3i+GcUIkrw5jxPU/RTGlWBcemPaKHdciSzGcjWboapzIy49qypQhZe1U75 user@my_ip&quot;],
30
+ ssh_key_ids: [&quot;5fa942e71c16abcfbead275f&quot;,&quot;5fa94303cc6dc49346404fca&quot;,&quot;5fa943127bda760ad80c237e&quot;],
31
+ network_type: PUBLIC_AND_PRIVATE,
32
+ os_configuration: null,
33
+ tags: null,
34
+ network_configuration: null,
35
+ storage_configuration: null
36
+ )
37
+ ```
38
+
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | The network identifier. | |
8
- | **ips** | **Array&lt;String&gt;** | Configurable/configured IPs on the server.&lt;br&gt; At least 1 IP address is required. All IPs must be within the network&#39;s range.&lt;br&gt; Setting the &#x60;force&#x60; query parameter to &#x60;true&#x60; allows you to:&lt;ul&gt; &lt;li&gt; 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. &lt;li&gt; Assign one or more IP addresses which are already configured on other resource(s) in network.&lt;/ul&gt; | [optional] |
8
+ | **ips** | **Array&lt;String&gt;** | Configurable/configured IPs on the server.&lt;br&gt; At least 1 IP address is required. Valid IP formats are single IPv4 addresses or IPv4 ranges. All IPs must be within the network&#39;s range.&lt;br&gt; Setting the &#x60;force&#x60; query parameter to &#x60;true&#x60; allows you to:&lt;ul&gt; &lt;li&gt; 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. &lt;li&gt; Assign one or more IP addresses which are already configured on other resource(s) in network.&lt;/ul&gt; | [optional] |
9
9
  | **status_description** | **String** | (Read-only) The status of the assignment to the network. | [optional][readonly] |
10
10
 
11
11
  ## Example
@@ -15,7 +15,7 @@ require 'pnap_bmc_api'
15
15
 
16
16
  instance = BmcApi::ServerPublicNetwork.new(
17
17
  id: 60473c2509268bc77fd06d29,
18
- ips: [&quot;182.16.0.146&quot;,&quot;182.16.0.147&quot;],
18
+ ips: [&quot;182.16.0.146&quot;,&quot;182.16.0.148 - 182.16.0.150&quot;],
19
19
  status_description: assigned
20
20
  )
21
21
  ```