pnap_bmc_api 2.0.0 → 2.2.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 +3 -0
- data/VERSION +1 -1
- data/docs/EsxiDatastoreConfiguration.md +18 -0
- data/docs/EsxiOsConfiguration.md +18 -0
- data/docs/GpuConfiguration.md +20 -0
- data/docs/OsConfiguration.md +2 -0
- data/docs/OsConfigurationCloudInit.md +2 -2
- data/docs/Quota.md +1 -1
- data/docs/RelinquishIpBlock.md +1 -1
- data/docs/Server.md +4 -2
- data/docs/ServerCreate.md +2 -2
- data/docs/ServerNetworkUpdate.md +2 -2
- data/docs/ServerProvision.md +1 -1
- data/docs/ServerPublicNetwork.md +5 -3
- data/docs/ServersApi.md +1 -1
- data/lib/pnap_bmc_api/api/servers_api.rb +2 -2
- data/lib/pnap_bmc_api/api_client.rb +2 -2
- data/lib/pnap_bmc_api/models/esxi_datastore_configuration.rb +262 -0
- data/lib/pnap_bmc_api/models/esxi_os_configuration.rb +215 -0
- data/lib/pnap_bmc_api/models/gpu_configuration.rb +226 -0
- data/lib/pnap_bmc_api/models/os_configuration.rb +10 -1
- data/lib/pnap_bmc_api/models/os_configuration_cloud_init.rb +1 -1
- data/lib/pnap_bmc_api/models/quota_edit_limit_request.rb +7 -3
- data/lib/pnap_bmc_api/models/quota_edit_limit_request_details.rb +7 -3
- data/lib/pnap_bmc_api/models/relinquish_ip_block.rb +2 -2
- data/lib/pnap_bmc_api/models/server.rb +12 -3
- data/lib/pnap_bmc_api/models/server_create.rb +2 -2
- data/lib/pnap_bmc_api/models/server_network_update.rb +1 -1
- data/lib/pnap_bmc_api/models/server_provision.rb +1 -1
- data/lib/pnap_bmc_api/models/server_public_network.rb +15 -5
- data/lib/pnap_bmc_api.rb +3 -0
- data/spec/api/servers_api_spec.rb +1 -1
- data/spec/models/esxi_datastore_configuration_spec.rb +36 -0
- data/spec/models/esxi_os_configuration_spec.rb +36 -0
- data/spec/models/gpu_configuration_spec.rb +42 -0
- data/spec/models/os_configuration_spec.rb +6 -0
- data/spec/models/server_public_network_spec.rb +6 -0
- data/spec/models/server_spec.rb +6 -0
- metadata +51 -39
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8be92c7debcb4cc1d0e87324ff90f070de9e84e077f52a029334a9ba0a35ea59
|
4
|
+
data.tar.gz: 9d9b982817253b0e1972e7d4ed66f6f54f34b03bd8e19584bae2217e7ec03ac0
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0ebb07859f3a82fcfffae39b63342aaad7e294b6b495f7e33bdf1cf2f7d823616e3a5faf3e6d3c7682453d64650e04c03b7ba93b7a4488e3e8d81aa6d5257a5f
|
7
|
+
data.tar.gz: 39ba49431093ee91a9b5b4c5e4348f62117fac6393e9c8a5e0a2b8eb9938ace87527477569016d141766a6bb48c1893e32d627422b3bf5e2741eadcb71a65b5b
|
data/README.md
CHANGED
@@ -160,6 +160,9 @@ Class | Method | HTTP request | Description
|
|
160
160
|
- [BmcApi::DeleteResult](docs/DeleteResult.md)
|
161
161
|
- [BmcApi::DeleteSshKeyResult](docs/DeleteSshKeyResult.md)
|
162
162
|
- [BmcApi::Error](docs/Error.md)
|
163
|
+
- [BmcApi::EsxiDatastoreConfiguration](docs/EsxiDatastoreConfiguration.md)
|
164
|
+
- [BmcApi::EsxiOsConfiguration](docs/EsxiOsConfiguration.md)
|
165
|
+
- [BmcApi::GpuConfiguration](docs/GpuConfiguration.md)
|
163
166
|
- [BmcApi::IpBlocksConfiguration](docs/IpBlocksConfiguration.md)
|
164
167
|
- [BmcApi::NetworkConfiguration](docs/NetworkConfiguration.md)
|
165
168
|
- [BmcApi::OsConfiguration](docs/OsConfiguration.md)
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
2.
|
1
|
+
2.2.0
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# BmcApi::EsxiDatastoreConfiguration
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **datastore_name** | **String** | Datastore name | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'pnap_bmc_api'
|
13
|
+
|
14
|
+
instance = BmcApi::EsxiDatastoreConfiguration.new(
|
15
|
+
datastore_name: datastore1
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# BmcApi::EsxiOsConfiguration
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **datastore_configuration** | [**EsxiDatastoreConfiguration**](EsxiDatastoreConfiguration.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'pnap_bmc_api'
|
13
|
+
|
14
|
+
instance = BmcApi::EsxiOsConfiguration.new(
|
15
|
+
datastore_configuration: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# BmcApi::GpuConfiguration
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **long_name** | **String** | The long name of the GPU. | [optional] |
|
8
|
+
| **count** | **Integer** | The number of GPUs. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'pnap_bmc_api'
|
14
|
+
|
15
|
+
instance = BmcApi::GpuConfiguration.new(
|
16
|
+
long_name: Intel Max 1100 GPU,
|
17
|
+
count: 2
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/OsConfiguration.md
CHANGED
@@ -11,6 +11,7 @@
|
|
11
11
|
| **management_ui_url** | **String** | (Read-only) The URL of the management UI which will only be returned in response to provisioning a server. | [optional][readonly] |
|
12
12
|
| **management_access_allowed_ips** | **Array<String>** | List of IPs allowed to access the Management UI. Supported in single IP, CIDR and range format. When undefined, Management UI is disabled. This will only be returned in response to provisioning a server. | [optional] |
|
13
13
|
| **install_os_to_ram** | **Boolean** | If true, OS will be installed to and booted from the server's RAM. On restart RAM OS will be lost and the server will not be reachable unless a custom bootable OS has been deployed. Follow the <a href='https://phoenixnap.com/kb/bmc-custom-os' target='_blank'>instructions</a> on how to install custom OS on BMC. Only supported for ubuntu/focal and ubuntu/jammy. | [optional][default to false] |
|
14
|
+
| **esxi** | [**EsxiOsConfiguration**](EsxiOsConfiguration.md) | | [optional] |
|
14
15
|
| **cloud_init** | [**OsConfigurationCloudInit**](OsConfigurationCloudInit.md) | | [optional] |
|
15
16
|
|
16
17
|
## Example
|
@@ -26,6 +27,7 @@ instance = BmcApi::OsConfiguration.new(
|
|
26
27
|
management_ui_url: https://172.217.22.14,
|
27
28
|
management_access_allowed_ips: ["172.217.22.14","10.111.14.40/29","10.111.14.66 - 10.111.14.71"],
|
28
29
|
install_os_to_ram: true,
|
30
|
+
esxi: null,
|
29
31
|
cloud_init: null
|
30
32
|
)
|
31
33
|
```
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
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
|
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, ubuntu/jammy, debian/bullseye, debian/bookworm, centos/centos7, centos/centos8, almalinux/almalinux8, almalinux/almalinux9, rockylinux/rockylinux8, rockylinux/rockylinux9 and virtuozzo/virtuozzo7 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
|
|
@@ -12,7 +12,7 @@
|
|
12
12
|
require 'pnap_bmc_api'
|
13
13
|
|
14
14
|
instance = BmcApi::OsConfigurationCloudInit.new(
|
15
|
-
user_data:
|
15
|
+
user_data: [B@59838256
|
16
16
|
)
|
17
17
|
```
|
18
18
|
|
data/docs/Quota.md
CHANGED
data/docs/RelinquishIpBlock.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **delete_ip_blocks** | **Boolean** | Determines whether the
|
7
|
+
| **delete_ip_blocks** | **Boolean** | Determines whether the IPv4 and IPv6 blocks assigned to the server should be deleted or not. | [optional][default to false] |
|
8
8
|
|
9
9
|
## Example
|
10
10
|
|
data/docs/Server.md
CHANGED
@@ -8,8 +8,8 @@
|
|
8
8
|
| **status** | **String** | The status of the server. Can have one of the following values: `creating` , `powered-on` , `powered-off` , `rebooting` , `resetting` , `deleting` , `reserved` , `error` or `reinstating`. | |
|
9
9
|
| **hostname** | **String** | Hostname of server. | |
|
10
10
|
| **description** | **String** | Description of server. | [optional] |
|
11
|
-
| **os** | **String** | The server’s OS ID used when the server was created. Currently this field should be set to either `ubuntu/bionic`, `ubuntu/focal`, `ubuntu/jammy`, `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`
|
11
|
+
| **os** | **String** | The server’s OS ID used when the server was created. Currently this field should be set to either `ubuntu/bionic`, `ubuntu/focal`, `ubuntu/jammy`, `ubuntu/jammy+pytorch`, `ubuntu/noble`, `centos/centos7`, `centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `windows/srv2022std`, `windows/srv2022dc`, `esxi/esxi70`, `esxi/esxi80`, `almalinux/almalinux8`, `rockylinux/rockylinux8`, `almalinux/almalinux9`, `rockylinux/rockylinux9`, `oraclelinux/oraclelinux9`, `debian/bullseye`, `debian/bookworm`, `proxmox/bullseye`, `proxmox/proxmox8`, `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`, `a1.c5.xlarge`, `d3.s5.xlarge`, `d3.m4.xxlarge`, `d3.m5.xxlarge`, `d3.m6.xxlarge`, `s3.c3.medium`, `s3.c3.large`, `d3.c4.medium`, `d3.c5.medium`, `d3.c6.medium`, `d3.c1.large`, `d3.c2.large`, `d3.c3.large`, `d3.m1.xlarge`, `d3.m2.xlarge`, `d3.m3.xlarge`, `d3.g2.c1.xlarge`, `d3.g2.c2.xlarge`, `d3.g2.c3.xlarge`, s4.x6.c6.large or s4.x6.m6.xlarge. | |
|
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. | |
|
@@ -29,6 +29,7 @@
|
|
29
29
|
| **os_configuration** | [**OsConfiguration**](OsConfiguration.md) | | [optional] |
|
30
30
|
| **network_configuration** | [**NetworkConfiguration**](NetworkConfiguration.md) | | |
|
31
31
|
| **storage_configuration** | [**StorageConfiguration**](StorageConfiguration.md) | | |
|
32
|
+
| **gpu_configuration** | [**GpuConfiguration**](GpuConfiguration.md) | | [optional] |
|
32
33
|
| **superseded_by** | **String** | Unique identifier of the server to which the reservation has been transferred. | [optional] |
|
33
34
|
| **supersedes** | **String** | Unique identifier of the server from which the reservation has been transferred. | [optional] |
|
34
35
|
|
@@ -63,6 +64,7 @@ instance = BmcApi::Server.new(
|
|
63
64
|
os_configuration: null,
|
64
65
|
network_configuration: null,
|
65
66
|
storage_configuration: null,
|
67
|
+
gpu_configuration: null,
|
66
68
|
superseded_by: 64a539b8d9c2c9ba8424ca31,
|
67
69
|
supersedes: 76915b5c85121d411f26e92f
|
68
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 `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`
|
9
|
+
| **os** | **String** | The server’s OS ID used when the server was created. Currently this field should be set to either `ubuntu/bionic`, `ubuntu/focal`, `ubuntu/jammy`, `ubuntu/jammy+pytorch`, `ubuntu/noble`, `centos/centos7`, `centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `windows/srv2022std`, `windows/srv2022dc`, `esxi/esxi70`, `esxi/esxi80`, `almalinux/almalinux8`, `rockylinux/rockylinux8`, `almalinux/almalinux9`, `rockylinux/rockylinux9`, `virtuozzo/virtuozzo7`, `oraclelinux/oraclelinux9`, `debian/bullseye`, `debian/bookworm`, `proxmox/bullseye`, `proxmox/proxmox8`, `netris/controller`, `netris/softgate_1g`, `netris/softgate_10g` 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`, `a1.c5.xlarge`, `d3.s5.xlarge`, `d3.m4.xxlarge`, `d3.m5.xxlarge`, `d3.m6.xxlarge`, `s3.c3.medium`, `s3.c3.large`, `d3.c4.medium`, `d3.c5.medium`, `d3.c6.medium`, `d3.c1.large`, `d3.c2.large`, `d3.c3.large`, `d3.m1.xlarge`, `d3.m2.xlarge`, `d3.m3.xlarge`, `d3.g2.c1.xlarge`, `d3.g2.c2.xlarge`, `d3.g2.c3.xlarge`, s4.x6.c6.large or s4.x6.m6.xlarge. | |
|
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] |
|
data/docs/ServerNetworkUpdate.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **ips** | **Array<String>** | List of IPs to be associated to the server.<br> Valid IP formats
|
7
|
+
| **ips** | **Array<String>** | List of IPs to be associated to the server.<br> Valid IP formats include single IP addresses or IP ranges (IPv4 or IPv6). IPs must be within the network's range.<br> Setting the `force` query parameter to `true` allows you to:<ul> <li> Assign no specific IP addresses by designating an empty array of IPs. <li> Assign one or more IP addresses which are already configured on other resource(s) in network. <li> Assign IP addresses which are considered as reserved in network.</ul> | [optional] |
|
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.20 - 10.1.1.25"]
|
15
|
+
ips: ["10.1.1.1","10.1.1.20 - 10.1.1.25","2001:db8::f","2001:db8::b - 2001:db8::d"]
|
16
16
|
)
|
17
17
|
```
|
18
18
|
|
data/docs/ServerProvision.md
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **hostname** | **String** | Hostname of server. | |
|
8
8
|
| **description** | **String** | Description of server. | [optional] |
|
9
|
-
| **os** | **String** | The server’s OS ID used when the server was created. Currently this field should be set to either `ubuntu/bionic`, `ubuntu/focal`, `ubuntu/jammy`, `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`. | |
|
9
|
+
| **os** | **String** | The server’s OS ID used when the server was created. Currently this field should be set to either `ubuntu/bionic`, `ubuntu/focal`, `ubuntu/jammy`, `ubuntu/jammy+pytorch`, `ubuntu/noble`, `centos/centos7`, `centos/centos8`, `windows/srv2019std`, `windows/srv2019dc`, `windows/srv2022std`, `windows/srv2022dc`, `esxi/esxi70`, `esxi/esxi80`, `almalinux/almalinux8`, `rockylinux/rockylinux8`, `oraclelinux/oraclelinux9`, `debian/bullseye`, `debian/bookworm`, `proxmox/bullseye`, `proxmox/proxmox8`, `netris/controller`, `netris/softgate_1g`, `netris/softgate_10g` or `netris/softgate_25g`. | |
|
10
10
|
| **install_default_ssh_keys** | **Boolean** | Whether or not to install SSH keys marked as default in addition to any SSH keys specified in this request. | [optional][default to true] |
|
11
11
|
| **ssh_keys** | **Array<String>** | A list of SSH keys that will be installed on the server. | [optional] |
|
12
12
|
| **ssh_key_ids** | **Array<String>** | A list of SSH key IDs that will be installed on the server in addition to any SSH keys specified in this request. | [optional] |
|
data/docs/ServerPublicNetwork.md
CHANGED
@@ -5,8 +5,9 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | The network identifier. | |
|
8
|
-
| **ips** | **Array<String>** | Configurable/configured IPs on the server.<br> At least 1 IP address is required. Valid IP
|
8
|
+
| **ips** | **Array<String>** | Configurable/configured IPs on the server.<br> At least 1 IP address is required. Valid IP format is single IP addresses. All IPs must be within the network's range.<br> Setting the `computeSlaacIp` field to `true` allows you to provide an empty array of IPs.<br> Additionally, setting the `force` query parameter to `true` allows you to:<ul> <li> Assign no specific IP addresses by designating an empty array of IPs. Note that at least one IP is required for the gateway address to be selected from this network. <li> Assign one or more IP addresses which are already configured on other resource(s) in network.</ul> | [optional] |
|
9
9
|
| **status_description** | **String** | (Read-only) The status of the assignment to the network. | [optional][readonly] |
|
10
|
+
| **compute_slaac_ip** | **Boolean** | (Write-only) Requests Stateless Address Autoconfiguration (SLAAC). Applicable for Network which contains IPv6 block(s). | [optional] |
|
10
11
|
|
11
12
|
## Example
|
12
13
|
|
@@ -15,8 +16,9 @@ require 'pnap_bmc_api'
|
|
15
16
|
|
16
17
|
instance = BmcApi::ServerPublicNetwork.new(
|
17
18
|
id: 60473c2509268bc77fd06d29,
|
18
|
-
ips: ["182.16.0.146","
|
19
|
-
status_description: assigned
|
19
|
+
ips: ["182.16.0.146","2001:db8::b"],
|
20
|
+
status_description: assigned,
|
21
|
+
compute_slaac_ip: true
|
20
22
|
)
|
21
23
|
```
|
22
24
|
|
data/docs/ServersApi.md
CHANGED
@@ -1024,7 +1024,7 @@ end
|
|
1024
1024
|
|
1025
1025
|
Assign IP Block to Server.
|
1026
1026
|
|
1027
|
-
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>.
|
1027
|
+
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. A server can have at most one IPv4 block and one IPv6 block assigned simultaneously. Assigning IPv6 to server is only supported post-provision. 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>.
|
1028
1028
|
|
1029
1029
|
### Examples
|
1030
1030
|
|
@@ -977,7 +977,7 @@ module BmcApi
|
|
977
977
|
end
|
978
978
|
|
979
979
|
# Assign IP Block to Server.
|
980
|
-
# 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>.
|
980
|
+
# 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. A server can have at most one IPv4 block and one IPv6 block assigned simultaneously. Assigning IPv6 to server is only supported post-provision. 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>.
|
981
981
|
# @param server_id [String] The server's ID.
|
982
982
|
# @param server_ip_block [ServerIpBlock]
|
983
983
|
# @param [Hash] opts the optional parameters
|
@@ -988,7 +988,7 @@ module BmcApi
|
|
988
988
|
end
|
989
989
|
|
990
990
|
# Assign IP Block to Server.
|
991
|
-
# 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>.
|
991
|
+
# 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. A server can have at most one IPv4 block and one IPv6 block assigned simultaneously. Assigning IPv6 to server is only supported post-provision. 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>.
|
992
992
|
# @param server_id [String] The server's ID.
|
993
993
|
# @param server_ip_block [ServerIpBlock]
|
994
994
|
# @param [Hash] opts the optional parameters
|
@@ -33,8 +33,8 @@ module BmcApi
|
|
33
33
|
def initialize(config = Configuration.default)
|
34
34
|
@config = config
|
35
35
|
@config.params_encoding = :multi
|
36
|
-
@user_agent = "PNAP-ruby-sdk-bmc/#{ BmcApi::VERSION }"
|
37
|
-
@powered_by = "PNAP-ruby-sdk-bmc/#{ BmcApi::VERSION }"
|
36
|
+
@user_agent = "PNAP-ruby-sdk-bmc/BmcApi/#{ BmcApi::VERSION }"
|
37
|
+
@powered_by = "PNAP-ruby-sdk-bmc/BmcApi/#{ BmcApi::VERSION }"
|
38
38
|
@default_headers = {
|
39
39
|
'Content-Type' => 'application/json',
|
40
40
|
'User-Agent' => @user_agent,
|
@@ -0,0 +1,262 @@
|
|
1
|
+
=begin
|
2
|
+
#Bare Metal Cloud API
|
3
|
+
|
4
|
+
#Create, power off, power on, reset, reboot, or shut down your server with the Bare Metal Cloud API. Deprovision servers, get or edit SSH key details, assign public IPs, assign servers to networks and a lot more. Manage your infrastructure more efficiently using just a few simple API calls.<br> <br> <span class='pnap-api-knowledge-base-link'> Knowledge base articles to help you can be found <a href='https://phoenixnap.com/kb/how-to-deploy-bare-metal-cloud-server' target='_blank'>here</a> </span><br> <br> <b>All URLs are relative to (https://api.phoenixnap.com/bmc/v1/)</b>
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 0.1
|
7
|
+
Contact: support@phoenixnap.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 7.2.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'time'
|
15
|
+
|
16
|
+
module BmcApi
|
17
|
+
# Esxi data storage configuration.
|
18
|
+
class EsxiDatastoreConfiguration
|
19
|
+
# Datastore name
|
20
|
+
attr_accessor :datastore_name
|
21
|
+
|
22
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
23
|
+
def self.attribute_map
|
24
|
+
{
|
25
|
+
:'datastore_name' => :'datastoreName'
|
26
|
+
}
|
27
|
+
end
|
28
|
+
|
29
|
+
# Returns all the JSON keys this model knows about
|
30
|
+
def self.acceptable_attributes
|
31
|
+
attribute_map.values
|
32
|
+
end
|
33
|
+
|
34
|
+
# Attribute type mapping.
|
35
|
+
def self.openapi_types
|
36
|
+
{
|
37
|
+
:'datastore_name' => :'String'
|
38
|
+
}
|
39
|
+
end
|
40
|
+
|
41
|
+
# List of attributes with nullable: true
|
42
|
+
def self.openapi_nullable
|
43
|
+
Set.new([
|
44
|
+
])
|
45
|
+
end
|
46
|
+
|
47
|
+
# Initializes the object
|
48
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
49
|
+
def initialize(attributes = {})
|
50
|
+
if (!attributes.is_a?(Hash))
|
51
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `BmcApi::EsxiDatastoreConfiguration` initialize method"
|
52
|
+
end
|
53
|
+
|
54
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
55
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
56
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
57
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `BmcApi::EsxiDatastoreConfiguration`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
58
|
+
end
|
59
|
+
h[k.to_sym] = v
|
60
|
+
}
|
61
|
+
|
62
|
+
if attributes.key?(:'datastore_name')
|
63
|
+
self.datastore_name = attributes[:'datastore_name']
|
64
|
+
else
|
65
|
+
self.datastore_name = nil
|
66
|
+
end
|
67
|
+
end
|
68
|
+
|
69
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
70
|
+
# @return Array for valid properties with the reasons
|
71
|
+
def list_invalid_properties
|
72
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
73
|
+
invalid_properties = Array.new
|
74
|
+
if @datastore_name.nil?
|
75
|
+
invalid_properties.push('invalid value for "datastore_name", datastore_name cannot be nil.')
|
76
|
+
end
|
77
|
+
|
78
|
+
if @datastore_name.to_s.length > 42
|
79
|
+
invalid_properties.push('invalid value for "datastore_name", the character length must be smaller than or equal to 42.')
|
80
|
+
end
|
81
|
+
|
82
|
+
if @datastore_name.to_s.length < 1
|
83
|
+
invalid_properties.push('invalid value for "datastore_name", the character length must be great than or equal to 1.')
|
84
|
+
end
|
85
|
+
|
86
|
+
pattern = Regexp.new(/^[a-zA-Z0-9]+$/)
|
87
|
+
if @datastore_name !~ pattern
|
88
|
+
invalid_properties.push("invalid value for \"datastore_name\", must conform to the pattern #{pattern}.")
|
89
|
+
end
|
90
|
+
|
91
|
+
invalid_properties
|
92
|
+
end
|
93
|
+
|
94
|
+
# Check to see if the all the properties in the model are valid
|
95
|
+
# @return true if the model is valid
|
96
|
+
def valid?
|
97
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
98
|
+
return false if @datastore_name.nil?
|
99
|
+
return false if @datastore_name.to_s.length > 42
|
100
|
+
return false if @datastore_name.to_s.length < 1
|
101
|
+
return false if @datastore_name !~ Regexp.new(/^[a-zA-Z0-9]+$/)
|
102
|
+
true
|
103
|
+
end
|
104
|
+
|
105
|
+
# Custom attribute writer method with validation
|
106
|
+
# @param [Object] datastore_name Value to be assigned
|
107
|
+
def datastore_name=(datastore_name)
|
108
|
+
if datastore_name.nil?
|
109
|
+
fail ArgumentError, 'datastore_name cannot be nil'
|
110
|
+
end
|
111
|
+
|
112
|
+
if datastore_name.to_s.length > 42
|
113
|
+
fail ArgumentError, 'invalid value for "datastore_name", the character length must be smaller than or equal to 42.'
|
114
|
+
end
|
115
|
+
|
116
|
+
if datastore_name.to_s.length < 1
|
117
|
+
fail ArgumentError, 'invalid value for "datastore_name", the character length must be great than or equal to 1.'
|
118
|
+
end
|
119
|
+
|
120
|
+
pattern = Regexp.new(/^[a-zA-Z0-9]+$/)
|
121
|
+
if datastore_name !~ pattern
|
122
|
+
fail ArgumentError, "invalid value for \"datastore_name\", must conform to the pattern #{pattern}."
|
123
|
+
end
|
124
|
+
|
125
|
+
@datastore_name = datastore_name
|
126
|
+
end
|
127
|
+
|
128
|
+
# Checks equality by comparing each attribute.
|
129
|
+
# @param [Object] Object to be compared
|
130
|
+
def ==(o)
|
131
|
+
return true if self.equal?(o)
|
132
|
+
self.class == o.class &&
|
133
|
+
datastore_name == o.datastore_name
|
134
|
+
end
|
135
|
+
|
136
|
+
# @see the `==` method
|
137
|
+
# @param [Object] Object to be compared
|
138
|
+
def eql?(o)
|
139
|
+
self == o
|
140
|
+
end
|
141
|
+
|
142
|
+
# Calculates hash code according to all attributes.
|
143
|
+
# @return [Integer] Hash code
|
144
|
+
def hash
|
145
|
+
[datastore_name].hash
|
146
|
+
end
|
147
|
+
|
148
|
+
# Builds the object from hash
|
149
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
150
|
+
# @return [Object] Returns the model itself
|
151
|
+
def self.build_from_hash(attributes)
|
152
|
+
return nil unless attributes.is_a?(Hash)
|
153
|
+
attributes = attributes.transform_keys(&:to_sym)
|
154
|
+
transformed_hash = {}
|
155
|
+
openapi_types.each_pair do |key, type|
|
156
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
157
|
+
transformed_hash["#{key}"] = nil
|
158
|
+
elsif type =~ /\AArray<(.*)>/i
|
159
|
+
# check to ensure the input is an array given that the attribute
|
160
|
+
# is documented as an array but the input is not
|
161
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
162
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
163
|
+
end
|
164
|
+
elsif !attributes[attribute_map[key]].nil?
|
165
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
166
|
+
end
|
167
|
+
end
|
168
|
+
new(transformed_hash)
|
169
|
+
end
|
170
|
+
|
171
|
+
# Deserializes the data based on type
|
172
|
+
# @param string type Data type
|
173
|
+
# @param string value Value to be deserialized
|
174
|
+
# @return [Object] Deserialized data
|
175
|
+
def self._deserialize(type, value)
|
176
|
+
case type.to_sym
|
177
|
+
when :Time
|
178
|
+
Time.parse(value)
|
179
|
+
when :Date
|
180
|
+
Date.parse(value)
|
181
|
+
when :String
|
182
|
+
value.to_s
|
183
|
+
when :Integer
|
184
|
+
value.to_i
|
185
|
+
when :Float
|
186
|
+
value.to_f
|
187
|
+
when :Boolean
|
188
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
189
|
+
true
|
190
|
+
else
|
191
|
+
false
|
192
|
+
end
|
193
|
+
when :Object
|
194
|
+
# generic object (usually a Hash), return directly
|
195
|
+
value
|
196
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
197
|
+
inner_type = Regexp.last_match[:inner_type]
|
198
|
+
value.map { |v| _deserialize(inner_type, v) }
|
199
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
200
|
+
k_type = Regexp.last_match[:k_type]
|
201
|
+
v_type = Regexp.last_match[:v_type]
|
202
|
+
{}.tap do |hash|
|
203
|
+
value.each do |k, v|
|
204
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
205
|
+
end
|
206
|
+
end
|
207
|
+
else # model
|
208
|
+
# models (e.g. Pet) or oneOf
|
209
|
+
klass = BmcApi.const_get(type)
|
210
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
211
|
+
end
|
212
|
+
end
|
213
|
+
|
214
|
+
# Returns the string representation of the object
|
215
|
+
# @return [String] String presentation of the object
|
216
|
+
def to_s
|
217
|
+
to_hash.to_s
|
218
|
+
end
|
219
|
+
|
220
|
+
# to_body is an alias to to_hash (backward compatibility)
|
221
|
+
# @return [Hash] Returns the object in the form of hash
|
222
|
+
def to_body
|
223
|
+
to_hash
|
224
|
+
end
|
225
|
+
|
226
|
+
# Returns the object in the form of hash
|
227
|
+
# @return [Hash] Returns the object in the form of hash
|
228
|
+
def to_hash
|
229
|
+
hash = {}
|
230
|
+
self.class.attribute_map.each_pair do |attr, param|
|
231
|
+
value = self.send(attr)
|
232
|
+
if value.nil?
|
233
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
234
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
235
|
+
end
|
236
|
+
|
237
|
+
hash[param] = _to_hash(value)
|
238
|
+
end
|
239
|
+
hash
|
240
|
+
end
|
241
|
+
|
242
|
+
# Outputs non-array value in the form of hash
|
243
|
+
# For object, use to_hash. Otherwise, just return the value
|
244
|
+
# @param [Object] value Any valid value
|
245
|
+
# @return [Hash] Returns the value in the form of hash
|
246
|
+
def _to_hash(value)
|
247
|
+
if value.is_a?(Array)
|
248
|
+
value.compact.map { |v| _to_hash(v) }
|
249
|
+
elsif value.is_a?(Hash)
|
250
|
+
{}.tap do |hash|
|
251
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
252
|
+
end
|
253
|
+
elsif value.respond_to? :to_hash
|
254
|
+
value.to_hash
|
255
|
+
else
|
256
|
+
value
|
257
|
+
end
|
258
|
+
end
|
259
|
+
|
260
|
+
end
|
261
|
+
|
262
|
+
end
|