pnap_bmc_api 1.0.0

data/docs/ServerCreate.md

@@ -0,0 +1,44 @@
+# BmcApi::ServerCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **hostname** | **String** | Hostname of server. |  |
+| **description** | **String** | Description of server. | [optional] |
+| **os** | **String** | The server’s OS ID used when the server was created. Currently this field should be set to either `ubuntu/bionic`, `ubuntu/focal`, `centos/centos7`, `windows/srv2019std`, `windows/srv2019dc`, `esxi/esxi70u2`, `debian/bullseye` or `proxmox/bullseye`. |  |
+| **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.c3.medium`, `d2.c4.medium`, `d2.c5.medium`, `d2.c3.large`, `d2.c4.large`, `d2.c5.large`, `d2.m2.medium`, `d2.m2.large` or `d2.m2.xlarge`. |  |
+| **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`. |  |
+| **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] |
+| **ssh_keys** | **Array<String>** | A list of SSH keys that will be installed on the server. | [optional] |
+| **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] |
+| **reservation_id** | **String** | Server reservation ID. | [optional] |
+| **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'] |
+| **network_type** | **String** | The type of network configuration for this server. Currently this field should be set to `PUBLIC_AND_PRIVATE` or `PRIVATE_ONLY`. | [optional][default to 'PUBLIC_AND_PRIVATE'] |
+| **os_configuration** | [**OsConfiguration**](OsConfiguration.md) |  | [optional] |
+| **tags** | [**Array<TagAssignmentRequest>**](TagAssignmentRequest.md) | Tags to set to server, if any. | [optional] |
+| **network_configuration** | [**NetworkConfiguration**](NetworkConfiguration.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::ServerCreate.new(
+  hostname: my-server-1,
+  description: Server #1 used for computing.,
+  os: ubuntu/bionic,
+  type: s1.c1.small,
+  location: PHX,
+  install_default_ssh_keys: false,
+  ssh_keys: ["ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDF9LdAFElNCi7JoWh6KUcchrJ2Gac1aqGRPpdZNowObpRtmiRCecAMb7bUgNAaNfcmwiQi7tos9TlnFgprIcfMWb8MSs3ABYHmBgqEEt3RWYf0fAc9CsIpJdMCUG28TPGTlRXCEUVNKgLMdcseAlJoGp1CgbHWIN65fB3he3kAZcfpPn5mapV0tsl2p+ZyuAGRYdn5dJv2RZDHUZBkOeUobwsij+weHCKAFmKQKtCP7ybgVHaQjAPrj8MGnk1jBbjDt5ws+Be+9JNjQJee9zCKbAOsIo3i+GcUIkrw5jxPU/RTGlWBcemPaKHdciSzGcjWboapzIy49qypQhZe1U75 user@my_ip"],
+  ssh_key_ids: ["5fa942e71c16abcfbead275f","5fa94303cc6dc49346404fca","5fa943127bda760ad80c237e"],
+  reservation_id: 5f622c8032b458306b40d824,
+  pricing_model: ONE_MONTH_RESERVATION,
+  network_type: PUBLIC_AND_PRIVATE,
+  os_configuration: null,
+  tags: null,
+  network_configuration: null
+)
+```
+

data/docs/ServerIpBlock.md

@@ -0,0 +1,20 @@
+# BmcApi::ServerIpBlock
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The IP block's ID. |  |
+| **vlan_id** | **Integer** | The VLAN on which this IP block has been configured within the network switch. | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::ServerIpBlock.new(
+  id: 60473a6115e34466c9f8f083,
+  vlan_id: 10
+)
+```
+

data/docs/ServerPatch.md

@@ -0,0 +1,20 @@
+# BmcApi::ServerPatch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | Description of server. | [optional] |
+| **hostname** | **String** | Hostname of server | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::ServerPatch.new(
+  description: Server #1 used for computing.,
+  hostname: my-server
+)
+```
+

data/docs/ServerPrivateNetwork.md

@@ -0,0 +1,24 @@
+# BmcApi::ServerPrivateNetwork
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The network identifier. |  |
+| **ips** | **Array<String>** | IPs to configure/configured on the server. Should be null or empty list if DHCP is true. | [optional] |
+| **dhcp** | **Boolean** | Determines whether DHCP is enabled for this server. Should be false if ips is not an empty list. Not supported for proxmox OS. | [optional][default to false] |
+| **status_description** | **String** | The status of the network. | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::ServerPrivateNetwork.new(
+  id: 603f3b2cfcaf050643b89a4b,
+  ips: ["10.1.1.1","10.1.1.2"],
+  dhcp: false,
+  status_description: assigned
+)
+```
+

data/docs/ServerReserve.md

@@ -0,0 +1,18 @@
+# BmcApi::ServerReserve
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pricing_model** | **String** | Server pricing model. Currently this field should be set to `ONE_MONTH_RESERVATION`, `TWELVE_MONTHS_RESERVATION`, `TWENTY_FOUR_MONTHS_RESERVATION` or `THIRTY_SIX_MONTHS_RESERVATION`. |  |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::ServerReserve.new(
+  pricing_model: ONE_MONTH_RESERVATION
+)
+```
+

data/docs/ServerReset.md

@@ -0,0 +1,24 @@
+# BmcApi::ServerReset
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **ssh_keys** | **Array<String>** | A list of SSH keys that will be installed on the server. | [optional] |
+| **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] |
+| **os_configuration** | [**OsConfigurationMap**](OsConfigurationMap.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pnap_bmc_api'
+
+instance = BmcApi::ServerReset.new(
+  install_default_ssh_keys: false,
+  ssh_keys: ["ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDF9LdAFElNCi7JoWh6KUcchrJ2Gac1aqGRPpdZNowObpRtmiRCecAMb7bUgNAaNfcmwiQi7tos9TlnFgprIcfMWb8MSs3ABYHmBgqEEt3RWYf0fAc9CsIpJdMCUG28TPGTlRXCEUVNKgLMdcseAlJoGp1CgbHWIN65fB3he3kAZcfpPn5mapV0tsl2p+ZyuAGRYdn5dJv2RZDHUZBkOeUobwsij+weHCKAFmKQKtCP7ybgVHaQjAPrj8MGnk1jBbjDt5ws+Be+9JNjQJee9zCKbAOsIo3i+GcUIkrw5jxPU/RTGlWBcemPaKHdciSzGcjWboapzIy49qypQhZe1U75 user@my_ip"],
+  ssh_key_ids: ["5fa942e71c16abcfbead275f","5fa94303cc6dc49346404fca","5fa943127bda760ad80c237e"],
+  os_configuration: null
+)
+```
+