pnap_bmc_api 1.4.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.
- checksums.yaml +4 -4
- data/README.md +7 -1
- data/VERSION +1 -1
- data/docs/DeleteResult.md +1 -1
- data/docs/OsConfigurationCloudInit.md +1 -1
- data/docs/OsConfigurationNetrisController.md +1 -1
- data/docs/PrivateNetworkConfiguration.md +1 -1
- data/docs/QuotaEditLimitRequest.md +1 -1
- data/docs/QuotaEditLimitRequestDetails.md +1 -1
- data/docs/QuotasApi.md +6 -8
- data/docs/SSHKeysApi.md +12 -16
- data/docs/Server.md +14 -8
- data/docs/ServerCreate.md +7 -5
- data/docs/ServerNetworkUpdate.md +2 -2
- data/docs/ServerPrivateNetwork.md +3 -3
- data/docs/ServerProvision.md +38 -0
- data/docs/ServerPublicNetwork.md +2 -2
- data/docs/ServersApi.md +173 -111
- data/docs/StorageConfiguration.md +18 -0
- data/docs/StorageConfigurationRootPartition.md +20 -0
- data/lib/pnap_bmc_api/api/quotas_api.rb +11 -7
- data/lib/pnap_bmc_api/api/servers_api.rb +200 -75
- data/lib/pnap_bmc_api/api/ssh_keys_api.rb +21 -13
- data/lib/pnap_bmc_api/api_client.rb +24 -21
- data/lib/pnap_bmc_api/api_error.rb +2 -1
- data/lib/pnap_bmc_api/configuration.rb +28 -9
- data/lib/pnap_bmc_api/models/action_result.rb +16 -19
- data/lib/pnap_bmc_api/models/delete_result.rb +18 -19
- data/lib/pnap_bmc_api/models/delete_ssh_key_result.rb +18 -19
- data/lib/pnap_bmc_api/models/error.rb +16 -19
- data/lib/pnap_bmc_api/models/ip_blocks_configuration.rb +19 -20
- data/lib/pnap_bmc_api/models/network_configuration.rb +14 -19
- data/lib/pnap_bmc_api/models/os_configuration.rb +19 -20
- data/lib/pnap_bmc_api/models/os_configuration_cloud_init.rb +15 -20
- data/lib/pnap_bmc_api/models/os_configuration_map.rb +14 -19
- data/lib/pnap_bmc_api/models/os_configuration_map_esxi.rb +19 -20
- data/lib/pnap_bmc_api/models/os_configuration_map_proxmox.rb +19 -20
- data/lib/pnap_bmc_api/models/os_configuration_netris_controller.rb +16 -21
- data/lib/pnap_bmc_api/models/os_configuration_netris_softgate.rb +66 -20
- data/lib/pnap_bmc_api/models/os_configuration_windows.rb +19 -20
- data/lib/pnap_bmc_api/models/private_network_configuration.rb +15 -20
- data/lib/pnap_bmc_api/models/public_network_configuration.rb +14 -19
- data/lib/pnap_bmc_api/models/quota.rb +30 -19
- data/lib/pnap_bmc_api/models/quota_edit_limit_request.rb +40 -20
- data/lib/pnap_bmc_api/models/quota_edit_limit_request_details.rb +43 -22
- data/lib/pnap_bmc_api/models/relinquish_ip_block.rb +14 -19
- data/lib/pnap_bmc_api/models/reset_result.rb +16 -19
- data/lib/pnap_bmc_api/models/server.rb +94 -34
- data/lib/pnap_bmc_api/models/server_create.rb +43 -27
- data/lib/pnap_bmc_api/models/server_ip_block.rb +16 -19
- data/lib/pnap_bmc_api/models/server_network_update.rb +15 -20
- data/lib/pnap_bmc_api/models/server_patch.rb +27 -24
- data/lib/pnap_bmc_api/models/server_private_network.rb +27 -26
- data/lib/pnap_bmc_api/models/server_provision.rb +395 -0
- data/lib/pnap_bmc_api/models/server_public_network.rb +17 -20
- data/lib/pnap_bmc_api/models/server_reserve.rb +16 -19
- data/lib/pnap_bmc_api/models/server_reset.rb +14 -19
- data/lib/pnap_bmc_api/models/ssh_key.rb +28 -19
- data/lib/pnap_bmc_api/models/ssh_key_create.rb +52 -19
- data/lib/pnap_bmc_api/models/ssh_key_update.rb +29 -19
- data/lib/pnap_bmc_api/models/storage_configuration.rb +215 -0
- data/lib/pnap_bmc_api/models/{quota_edit_limit_request_details_all_of.rb → storage_configuration_root_partition.rb} +40 -36
- data/lib/pnap_bmc_api/models/tag_assignment.rb +20 -19
- data/lib/pnap_bmc_api/models/tag_assignment_request.rb +16 -19
- data/lib/pnap_bmc_api/version.rb +1 -1
- data/lib/pnap_bmc_api.rb +4 -2
- data/pnap_bmc_api.gemspec +2 -2
- data/spec/api/quotas_api_spec.rb +6 -6
- data/spec/api/servers_api_spec.rb +109 -36
- data/spec/api/ssh_keys_api_spec.rb +9 -9
- data/spec/models/action_result_spec.rb +6 -4
- data/spec/models/delete_result_spec.rb +7 -5
- data/spec/models/delete_ssh_key_result_spec.rb +7 -5
- data/spec/models/error_spec.rb +7 -5
- data/spec/models/ip_blocks_configuration_spec.rb +7 -5
- data/spec/models/network_configuration_spec.rb +19 -5
- data/spec/models/os_configuration_cloud_init_spec.rb +5 -3
- data/spec/models/os_configuration_map_esxi_spec.rb +8 -6
- data/spec/models/os_configuration_map_proxmox_spec.rb +8 -6
- data/spec/models/os_configuration_map_spec.rb +8 -6
- data/spec/models/os_configuration_netris_controller_spec.rb +7 -5
- data/spec/models/os_configuration_netris_softgate_spec.rb +8 -6
- data/spec/models/os_configuration_spec.rb +33 -7
- data/spec/models/os_configuration_windows_spec.rb +6 -4
- data/spec/models/private_network_configuration_spec.rb +8 -6
- data/spec/models/public_network_configuration_spec.rb +6 -4
- data/spec/models/quota_edit_limit_request_details_spec.rb +8 -6
- data/spec/models/quota_edit_limit_request_spec.rb +7 -5
- data/spec/models/quota_spec.rb +13 -15
- data/spec/models/relinquish_ip_block_spec.rb +6 -4
- data/spec/models/reset_result_spec.rb +8 -6
- data/spec/models/server_create_spec.rb +25 -17
- data/spec/models/server_ip_block_spec.rb +7 -5
- data/spec/models/server_network_update_spec.rb +5 -3
- data/spec/models/server_patch_spec.rb +7 -5
- data/spec/models/server_private_network_spec.rb +9 -7
- data/spec/models/server_provision_spec.rb +96 -0
- data/spec/models/server_public_network_spec.rb +8 -6
- data/spec/models/server_reserve_spec.rb +6 -4
- data/spec/models/server_reset_spec.rb +9 -7
- data/spec/models/server_spec.rb +47 -27
- data/spec/models/ssh_key_create_spec.rb +8 -6
- data/spec/models/ssh_key_spec.rb +12 -10
- data/spec/models/ssh_key_update_spec.rb +7 -5
- data/spec/models/storage_configuration_root_partition_spec.rb +42 -0
- data/spec/models/storage_configuration_spec.rb +36 -0
- data/spec/models/tag_assignment_request_spec.rb +7 -5
- data/spec/models/tag_assignment_spec.rb +10 -8
- data/spec/spec_helper.rb +1 -1
- metadata +41 -37
- data/docs/QuotaEditLimitRequestDetailsAllOf.md +0 -18
- data/spec/api_client_spec.rb +0 -226
- data/spec/configuration_spec.rb +0 -42
- 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:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0b52da1ba5d3cb2cd86fe0f34ad69ec7c758241a7b7e7b7420c6507daa30b667
|
4
|
+
data.tar.gz: 929d0295f55750dba4e24c1445c5bd9280f67fa7197e2166277c61fc78d929c8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
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,12 +183,15 @@ 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)
|
187
190
|
- [BmcApi::SshKey](docs/SshKey.md)
|
188
191
|
- [BmcApi::SshKeyCreate](docs/SshKeyCreate.md)
|
189
192
|
- [BmcApi::SshKeyUpdate](docs/SshKeyUpdate.md)
|
193
|
+
- [BmcApi::StorageConfiguration](docs/StorageConfiguration.md)
|
194
|
+
- [BmcApi::StorageConfigurationRootPartition](docs/StorageConfigurationRootPartition.md)
|
190
195
|
- [BmcApi::TagAssignment](docs/TagAssignment.md)
|
191
196
|
- [BmcApi::TagAssignmentRequest](docs/TagAssignmentRequest.md)
|
192
197
|
|
@@ -194,6 +199,7 @@ Class | Method | HTTP request | Description
|
|
194
199
|
## Documentation for Authorization
|
195
200
|
|
196
201
|
|
202
|
+
Authentication schemes defined for the API:
|
197
203
|
### OAuth2
|
198
204
|
|
199
205
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
|
1
|
+
2.0.0
|
data/docs/DeleteResult.md
CHANGED
@@ -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
|
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **host_os** | **String** | (Read-only) Host OS on which the Netris Controller is installed. | [optional][readonly] |
|
8
|
-
| **netris_web_console_url** | **String** | (Read-only) The URL for the Netris Controller web console.
|
8
|
+
| **netris_web_console_url** | **String** | (Read-only) The URL for the Netris Controller web console. It will only be returned in response to provisioning a server. | [optional][readonly] |
|
9
9
|
| **netris_user_password** | **String** | (Read-only) Auto-generated password set for user 'netris' in the web console.<br> The password is not stored and therefore will only be returned in response to provisioning a server. Copy and save it for future reference. | [optional][readonly] |
|
10
10
|
|
11
11
|
## Example
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **gateway_address** | **String** | Deprecated in favour of a common gateway address across all networks available under NetworkConfiguration.<br> The address of the gateway assigned / to assign to the server.<br> When used as part of request body, IP address has to be part of private network assigned to this server.<br> Gateway address also has to be assigned on an already deployed resource unless the `force` query parameter is true. | [optional] |
|
8
|
-
| **configuration_type** | **String** | (Write-only) Determines the approach for configuring private network(s) for the server being provisioned. Currently this field should be set to `USE_OR_CREATE_DEFAULT` or `
|
8
|
+
| **configuration_type** | **String** | (Write-only) Determines the approach for configuring private network(s) for the server being provisioned. Currently this field should be set to `USE_OR_CREATE_DEFAULT`, `USER_DEFINED` or `NONE`. | [optional][default to 'USE_OR_CREATE_DEFAULT'] |
|
9
9
|
| **private_networks** | [**Array<ServerPrivateNetwork>**](ServerPrivateNetwork.md) | The list of private networks this server is member of. When this field is part of request body, it'll be used to specify the private networks to assign to this server upon provisioning. Used alongside the `USER_DEFINED` configurationType. | [optional] |
|
10
10
|
|
11
11
|
## Example
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **limit** | **Integer** | The new limit that is requested. | |
|
7
|
+
| **limit** | **Integer** | The new limit that is requested. Minimum allowed limit values: - 0 (Server, IPs) - 1000 (Network Storage) | |
|
8
8
|
| **reason** | **String** | The reason for changing the limit. | |
|
9
9
|
|
10
10
|
## Example
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **limit** | **Integer** | The new limit that is requested. | |
|
7
|
+
| **limit** | **Integer** | The new limit that is requested. Minimum allowed limit values: - 0 (Server, IPs) - 1000 (Network Storage) | |
|
8
8
|
| **reason** | **String** | The reason for changing the limit. | |
|
9
9
|
| **requested_on** | **Time** | The point in time the request was submitted. | |
|
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,
|
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
|
-
|
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,
|
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,
|
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,
|
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) | |
|
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(
|
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
|
-
|
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(
|
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(
|
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(
|
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) | |
|
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,
|
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
|
-
|
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,
|
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,
|
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,
|
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's ID. | |
|
346
|
-
| **ssh_key_update** | [**SshKeyUpdate**](SshKeyUpdate.md) | |
|
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: `creating` , `powered-on` , `powered-off` , `rebooting` , `resetting` , `deleting` , `reserved` , `error` or `reinstating`. | |
|
9
9
|
| **hostname** | **String** | Hostname of server. | |
|
10
10
|
| **description** | **String** | Description of server. | [optional] |
|
11
|
-
| **os** | **String** | The server’s OS ID used when the server was created. Currently this field should be set to either `ubuntu/bionic`, `ubuntu/focal`, `ubuntu/jammy`, `centos/centos7`, `centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `esxi/esxi70`, `debian/bullseye`, `proxmox/bullseye`, `netris/controller`, `netris/softgate_1g` or `netris/
|
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.
|
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`, `windows/srv2022std`, `windows/srv2022dc`, `esxi/esxi70`, `esxi/esxi80`, `almalinux/almalinux8`, `rockylinux/rockylinux8`, `almalinux/almalinux9`, `rockylinux/rockylinux9`, `debian/bullseye`, `debian/bookworm`, `proxmox/bullseye`, `netris/controller`, `netris/softgate_1g`, `netris/softgate_10g` or `netris/softgate_25g`. | [optional] |
|
12
|
+
| **type** | **String** | Server type ID. Cannot be changed once a server is created. Currently this field should be set to either `s0.d1.small`, `s0.d1.medium`, `s1.c1.small`, `s1.c1.medium`, `s1.c2.medium`, `s1.c2.large`, `s1.e1.small`, `s1.e1.medium`, `s1.e1.large`, `s2.c1.small`, `s2.c1.medium`, `s2.c1.large`, `s2.c2.small`, `s2.c2.medium`, `s2.c2.large`, `d1.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.xlarge`, `d2.m2.xxlarge`, `d2.m3.xlarge`, `d2.m4.xlarge`, `d2.m5.xlarge`, `d2.c4.db1.pliops1`, `d3.m4.xlarge`, `d3.m5.xlarge`, `d3.m6.xlarge`, `a1.c5.large`, `d3.s5.xlarge`, `d3.m4.xxlarge`, `d3.m5.xxlarge` or `d3.m6.xxlarge`. | |
|
13
13
|
| **location** | **String** | Server location ID. Cannot be changed once a server is created. Currently this field should be set to `PHX`, `ASH`, `SGP`, `NLD`, `CHI`, `SEA` or `AUS`. | |
|
14
14
|
| **cpu** | **String** | A description of the machine CPU. | |
|
15
15
|
| **cpu_count** | **Integer** | The number of CPUs available in the system. | |
|
@@ -22,12 +22,15 @@
|
|
22
22
|
| **reservation_id** | **String** | The reservation reference id if any. | [optional] |
|
23
23
|
| **pricing_model** | **String** | The pricing model this server is being billed. Currently this field should be set to `HOURLY`, `ONE_MONTH_RESERVATION`, `TWELVE_MONTHS_RESERVATION`, `TWENTY_FOUR_MONTHS_RESERVATION` or `THIRTY_SIX_MONTHS_RESERVATION`. | [default to 'HOURLY'] |
|
24
24
|
| **password** | **String** | Auto-generated password set for user `Admin` on Windows server, user `root` on ESXi servers, user `root` on Proxmox server and user `netris` on Netris servers.<br> The password is not stored and therefore will only be returned in response to provisioning a server. Copy and save it for future reference. | [optional] |
|
25
|
-
| **network_type** | **String** | The type of network configuration for this server. Currently this field should be set to `PUBLIC_AND_PRIVATE` or `
|
25
|
+
| **network_type** | **String** | The type of network configuration for this server. Currently this field should be set to `PUBLIC_AND_PRIVATE`, `PRIVATE_ONLY`, `PUBLIC_ONLY` or `NONE`. | [optional][default to 'PUBLIC_AND_PRIVATE'] |
|
26
26
|
| **cluster_id** | **String** | The cluster reference id if any. | [optional] |
|
27
27
|
| **tags** | [**Array<TagAssignment>**](TagAssignment.md) | The tags assigned if any. | [optional] |
|
28
28
|
| **provisioned_on** | **Time** | Date and time when server was provisioned. | [optional] |
|
29
29
|
| **os_configuration** | [**OsConfiguration**](OsConfiguration.md) | | [optional] |
|
30
30
|
| **network_configuration** | [**NetworkConfiguration**](NetworkConfiguration.md) | | |
|
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] |
|
31
34
|
|
32
35
|
## Example
|
33
36
|
|
@@ -35,7 +38,7 @@
|
|
35
38
|
require 'pnap_bmc_api'
|
36
39
|
|
37
40
|
instance = BmcApi::Server.new(
|
38
|
-
id:
|
41
|
+
id: 651bf71fbde0c93e102ab180,
|
39
42
|
status: creating,
|
40
43
|
hostname: my-server-1,
|
41
44
|
description: Server #1 used for computing.,
|
@@ -50,15 +53,18 @@ instance = BmcApi::Server.new(
|
|
50
53
|
storage: 1x 960GB NVMe,
|
51
54
|
private_ip_addresses: ["172.16.0.1"],
|
52
55
|
public_ip_addresses: ["182.16.0.1","183.16.0.1"],
|
53
|
-
reservation_id:
|
56
|
+
reservation_id: fc8bd49a-59cc-4538-a806-5e46228408ec,
|
54
57
|
pricing_model: HOURLY,
|
55
58
|
password: MyP@ssw0rd_01,
|
56
59
|
network_type: PUBLIC_AND_PRIVATE,
|
57
|
-
cluster_id:
|
60
|
+
cluster_id: 65030122f253707f7d196bed,
|
58
61
|
tags: null,
|
59
62
|
provisioned_on: 2021-03-13T20:24:32.491Z,
|
60
63
|
os_configuration: null,
|
61
|
-
network_configuration: null
|
64
|
+
network_configuration: null,
|
65
|
+
storage_configuration: null,
|
66
|
+
superseded_by: 64a539b8d9c2c9ba8424ca31,
|
67
|
+
supersedes: 76915b5c85121d411f26e92f
|
62
68
|
)
|
63
69
|
```
|
64
70
|
|
data/docs/ServerCreate.md
CHANGED
@@ -6,18 +6,19 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **hostname** | **String** | Hostname of server. | |
|
8
8
|
| **description** | **String** | Description of server. | [optional] |
|
9
|
-
| **os** | **String** | The server’s OS ID used when the server was created. Currently this field should be set to either `ubuntu/bionic`, `ubuntu/focal`, `ubuntu/jammy`, `centos/centos7`, `centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `esxi/esxi70`, `debian/bullseye`, `proxmox/bullseye`, `netris/controller`, `netris/softgate_1g` or `netris/
|
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.
|
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`, `windows/srv2022std`, `windows/srv2022dc`, `esxi/esxi70`, `esxi/esxi80`, `almalinux/almalinux8`, `rockylinux/rockylinux8`, `almalinux/almalinux9`, `rockylinux/rockylinux9`, `virtuozzo/virtuozzo7`, `debian/bullseye`, `debian/bookworm`, `proxmox/bullseye`, `netris/controller`, `netris/softgate_1g`, `netris/softgate_10g` or `netris/softgate_25g`. | |
|
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.xlarge`, `d2.m2.xxlarge`, `d2.m3.xlarge`, `d2.m4.xlarge`, `d2.m5.xlarge`, `d2.c4.db1.pliops1`, `d3.m4.xlarge`, `d3.m5.xlarge`, `d3.m6.xlarge`, `a1.c5.large`, `d3.s5.xlarge`, `d3.m4.xxlarge`, `d3.m5.xxlarge` or `d3.m6.xxlarge`. | |
|
11
11
|
| **location** | **String** | Server location ID. Cannot be changed once a server is created. Currently this field should be set to `PHX`, `ASH`, `SGP`, `NLD`, `CHI`, `SEA` or `AUS`. | |
|
12
12
|
| **install_default_ssh_keys** | **Boolean** | Whether or not to install SSH keys marked as default in addition to any SSH keys specified in this request. | [optional][default to true] |
|
13
13
|
| **ssh_keys** | **Array<String>** | A list of SSH keys that will be installed on the server. | [optional] |
|
14
14
|
| **ssh_key_ids** | **Array<String>** | A list of SSH key IDs that will be installed on the server in addition to any SSH keys specified in this request. | [optional] |
|
15
15
|
| **reservation_id** | **String** | Server reservation ID. | [optional] |
|
16
16
|
| **pricing_model** | **String** | Server pricing model. Currently this field should be set to `HOURLY`, `ONE_MONTH_RESERVATION`, `TWELVE_MONTHS_RESERVATION`, `TWENTY_FOUR_MONTHS_RESERVATION` or `THIRTY_SIX_MONTHS_RESERVATION`. | [optional][default to 'HOURLY'] |
|
17
|
-
| **network_type** | **String** | The type of network configuration for this server
|
17
|
+
| **network_type** | **String** | The type of network configuration for this server.<br> Currently this field should be set to `PUBLIC_AND_PRIVATE`, `PRIVATE_ONLY`, `PUBLIC_ONLY` or `USER_DEFINED`.<br> Setting the `force` query parameter to `true` allows you to configure network configuration type as `NONE`. | [optional][default to 'PUBLIC_AND_PRIVATE'] |
|
18
18
|
| **os_configuration** | [**OsConfiguration**](OsConfiguration.md) | | [optional] |
|
19
19
|
| **tags** | [**Array<TagAssignmentRequest>**](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] |
|
20
20
|
| **network_configuration** | [**NetworkConfiguration**](NetworkConfiguration.md) | | [optional] |
|
21
|
+
| **storage_configuration** | [**StorageConfiguration**](StorageConfiguration.md) | | [optional] |
|
21
22
|
|
22
23
|
## Example
|
23
24
|
|
@@ -33,12 +34,13 @@ instance = BmcApi::ServerCreate.new(
|
|
33
34
|
install_default_ssh_keys: false,
|
34
35
|
ssh_keys: ["ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDF9LdAFElNCi7JoWh6KUcchrJ2Gac1aqGRPpdZNowObpRtmiRCecAMb7bUgNAaNfcmwiQi7tos9TlnFgprIcfMWb8MSs3ABYHmBgqEEt3RWYf0fAc9CsIpJdMCUG28TPGTlRXCEUVNKgLMdcseAlJoGp1CgbHWIN65fB3he3kAZcfpPn5mapV0tsl2p+ZyuAGRYdn5dJv2RZDHUZBkOeUobwsij+weHCKAFmKQKtCP7ybgVHaQjAPrj8MGnk1jBbjDt5ws+Be+9JNjQJee9zCKbAOsIo3i+GcUIkrw5jxPU/RTGlWBcemPaKHdciSzGcjWboapzIy49qypQhZe1U75 user@my_ip"],
|
35
36
|
ssh_key_ids: ["5fa942e71c16abcfbead275f","5fa94303cc6dc49346404fca","5fa943127bda760ad80c237e"],
|
36
|
-
reservation_id:
|
37
|
+
reservation_id: fc8bd49a-59cc-4538-a806-5e46228408ec,
|
37
38
|
pricing_model: ONE_MONTH_RESERVATION,
|
38
39
|
network_type: PUBLIC_AND_PRIVATE,
|
39
40
|
os_configuration: null,
|
40
41
|
tags: null,
|
41
|
-
network_configuration: null
|
42
|
+
network_configuration: null,
|
43
|
+
storage_configuration: null
|
42
44
|
)
|
43
45
|
```
|
44
46
|
|
data/docs/ServerNetworkUpdate.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **ips** | **Array<String>** | List of IPs to be associated to the server.<br> Setting the `force` query parameter to `true` allows you to:<ul> <li> Assign no specific IP addresses by designating an empty array of IPs. <li> Assign one or more IP addresses which are already configured on other resource(s) in network.</ul> | [optional] |
|
7
|
+
| **ips** | **Array<String>** | List of IPs to be associated to the server.<br> Valid IP formats are single IPv4 addresses or IPv4 ranges. IPs must be within the network's range.<br> Setting the `force` query parameter to `true` allows you to:<ul> <li> Assign no specific IP addresses by designating an empty array of IPs. <li> Assign one or more IP addresses which are already configured on other resource(s) in network. <li> Assign IP addresses which are considered as reserved in network.</ul> | [optional] |
|
8
8
|
|
9
9
|
## Example
|
10
10
|
|
@@ -12,7 +12,7 @@
|
|
12
12
|
require 'pnap_bmc_api'
|
13
13
|
|
14
14
|
instance = BmcApi::ServerNetworkUpdate.new(
|
15
|
-
ips: ["10.1.1.1","10.1.1.
|
15
|
+
ips: ["10.1.1.1","10.1.1.20 - 10.1.1.25"]
|
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<String>** | IPs to configure/configured on the server.<br>
|
9
|
-
| **dhcp** | **Boolean** | Determines whether DHCP is enabled for this server. Should be false if any IPs are provided. Not supported for Proxmox OS
|
8
|
+
| **ips** | **Array<String>** | IPs to configure/configured on the server.<br> Valid IP formats are single IPv4 addresses or IPv4 ranges. IPs must be within the network's range. Should be null or empty list if DHCP is true. <br> If field is undefined and DHCP is false, next available IP in network will be automatically allocated.<br> If the network contains a membership of type 'storage', the first twelve IPs are already reserved by BMC and not usable.<br> Setting the `force` query parameter to `true` allows you to:<ul> <li> Assign no specific IP addresses by designating an empty array of IPs. Note that at least one IP is required for the gateway address to be selected from this network. <li> Assign one or more IP addresses which are already configured on other resource(s) in network. <li> Assign IP addresses which are considered as reserved in network.</ul> | [optional] |
|
9
|
+
| **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: ["10.1.1.1","10.1.1.
|
19
|
+
ips: ["10.1.1.1","10.1.1.20 - 10.1.1.25"],
|
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 `ubuntu/bionic`, `ubuntu/focal`, `ubuntu/jammy`, `centos/centos7`, `centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `windows/srv2022std`, `windows/srv2022dc`, `esxi/esxi70`, `esxi/esxi80`, `almalinux/almalinux8`, `rockylinux/rockylinux8`, `debian/bullseye`, `debian/bookworm`, `proxmox/bullseye`, `netris/controller`, `netris/softgate_1g`, `netris/softgate_10g` or `netris/softgate_25g`. | |
|
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<String>** | A list of SSH keys that will be installed on the server. | [optional] |
|
12
|
+
| **ssh_key_ids** | **Array<String>** | A list of SSH key IDs that will be installed on the server in addition to any SSH keys specified in this request. | [optional] |
|
13
|
+
| **network_type** | **String** | The type of network configuration for this server.<br> Currently this field should be set to `PUBLIC_AND_PRIVATE`, `PRIVATE_ONLY`, `PUBLIC_ONLY` or `USER_DEFINED`.<br> Setting the `force` query parameter to `true` allows you to configure network configuration type as `NONE`. | [optional][default to 'PUBLIC_AND_PRIVATE'] |
|
14
|
+
| **os_configuration** | [**OsConfiguration**](OsConfiguration.md) | | [optional] |
|
15
|
+
| **tags** | [**Array<TagAssignmentRequest>**](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: ["ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDF9LdAFElNCi7JoWh6KUcchrJ2Gac1aqGRPpdZNowObpRtmiRCecAMb7bUgNAaNfcmwiQi7tos9TlnFgprIcfMWb8MSs3ABYHmBgqEEt3RWYf0fAc9CsIpJdMCUG28TPGTlRXCEUVNKgLMdcseAlJoGp1CgbHWIN65fB3he3kAZcfpPn5mapV0tsl2p+ZyuAGRYdn5dJv2RZDHUZBkOeUobwsij+weHCKAFmKQKtCP7ybgVHaQjAPrj8MGnk1jBbjDt5ws+Be+9JNjQJee9zCKbAOsIo3i+GcUIkrw5jxPU/RTGlWBcemPaKHdciSzGcjWboapzIy49qypQhZe1U75 user@my_ip"],
|
30
|
+
ssh_key_ids: ["5fa942e71c16abcfbead275f","5fa94303cc6dc49346404fca","5fa943127bda760ad80c237e"],
|
31
|
+
network_type: PUBLIC_AND_PRIVATE,
|
32
|
+
os_configuration: null,
|
33
|
+
tags: null,
|
34
|
+
network_configuration: null,
|
35
|
+
storage_configuration: null
|
36
|
+
)
|
37
|
+
```
|
38
|
+
|
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>** | 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] |
|
8
|
+
| **ips** | **Array<String>** | Configurable/configured IPs on the server.<br> At least 1 IP address is required. Valid IP formats are single IPv4 addresses or IPv4 ranges. 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** | (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: ["182.16.0.146","182.16.0.
|
18
|
+
ips: ["182.16.0.146","182.16.0.148 - 182.16.0.150"],
|
19
19
|
status_description: assigned
|
20
20
|
)
|
21
21
|
```
|