pnap_bmc_api 1.2.0 → 1.4.0

data/lib/pnap_bmc_api/api/servers_api.rb

@@ -151,6 +151,7 @@ module BmcApi
     # Create new server.
     # Create (request) new server for account. Server DNS will be configured to access Google's public DNS at 8.8.8.8 .
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :force Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. (default to false)
     # @option opts [ServerCreate] :server_create 
     # @return [Server]
     def servers_post(opts = {})
@@ -161,6 +162,7 @@ module BmcApi
     # Create new server.
     # Create (request) new server for account. Server DNS will be configured to access Google's public DNS at 8.8.8.8 .
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :force Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. (default to false)
     # @option opts [ServerCreate] :server_create 
     # @return [Array<(Server, Integer, Hash)>] Server data, response status code and response headers
     def servers_post_with_http_info(opts = {})
@@ -172,6 +174,7 @@ module BmcApi
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'force'] = opts[:'force'] if !opts[:'force'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -1016,10 +1019,90 @@ module BmcApi
       return data, status_code, headers
     end
 
+    # Updates the server's private network's IP addresses
+    # IP address changes intended to keep the BMC data up to date with server's operating system. We do not have access to the server's operating system and therefore manual configuration is required to apply the changes on the host. Knowledge base article to help you can be found <a href='https://phoenixnap.com/kb/bmc-server-management-via-api#ftoc-heading-6' target='_blank'>here</a>
+    # @param server_id [String] The server&#39;s ID.
+    # @param private_network_id [String] The private network identifier.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :force Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. (default to false)
+    # @option opts [ServerNetworkUpdate] :server_network_update 
+    # @return [ServerPrivateNetwork]
+    def servers_server_id_private_networks_patch(server_id, private_network_id, opts = {})
+      data, _status_code, _headers = servers_server_id_private_networks_patch_with_http_info(server_id, private_network_id, opts)
+      data
+    end
+
+    # Updates the server&#39;s private network&#39;s IP addresses
+    # IP address changes intended to keep the BMC data up to date with server&#39;s operating system. We do not have access to the server&#39;s operating system and therefore manual configuration is required to apply the changes on the host. Knowledge base article to help you can be found &lt;a href&#x3D;&#39;https://phoenixnap.com/kb/bmc-server-management-via-api#ftoc-heading-6&#39; target&#x3D;&#39;_blank&#39;&gt;here&lt;/a&gt;
+    # @param server_id [String] The server&#39;s ID.
+    # @param private_network_id [String] The private network identifier.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :force Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. (default to false)
+    # @option opts [ServerNetworkUpdate] :server_network_update 
+    # @return [Array<(ServerPrivateNetwork, Integer, Hash)>] ServerPrivateNetwork data, response status code and response headers
+    def servers_server_id_private_networks_patch_with_http_info(server_id, private_network_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ServersApi.servers_server_id_private_networks_patch ...'
+      end
+      # verify the required parameter 'server_id' is set
+      if @api_client.config.client_side_validation && server_id.nil?
+        fail ArgumentError, "Missing the required parameter 'server_id' when calling ServersApi.servers_server_id_private_networks_patch"
+      end
+      # verify the required parameter 'private_network_id' is set
+      if @api_client.config.client_side_validation && private_network_id.nil?
+        fail ArgumentError, "Missing the required parameter 'private_network_id' when calling ServersApi.servers_server_id_private_networks_patch"
+      end
+      # resource path
+      local_var_path = '/servers/{serverId}/network-configuration/private-network-configuration/private-networks/{privateNetworkId}'.sub('{' + 'serverId' + '}', CGI.escape(server_id.to_s)).sub('{' + 'privateNetworkId' + '}', CGI.escape(private_network_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'force'] = opts[:'force'] if !opts[:'force'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'server_network_update'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ServerPrivateNetwork'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"ServersApi.servers_server_id_private_networks_patch",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ServersApi#servers_server_id_private_networks_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Adds the server to a private network.
-    # Adds the server to a private network. <b>No actual configuration is performed on the operating system.</b> BMC configures exclusively the networking devices in the datacenter infrastructure. Manual network configuration changes in the operating system of this server are required. If the network contains a membership of type 'storage', the first twelve IPs are already reserved by BMC and not usable. These will return a Bad Request (400) if selected. Knowledge base article to help you can be found <a href='https://phoenixnap.com/kb/configure-bmc-server-after-adding-to-network#ftoc-heading-3' target='_blank'>here</a>.
+    # Adds the server to a private network. <b>No actual configuration is performed on the operating system.</b> BMC configures exclusively the networking devices in the datacenter infrastructure. Manual network configuration changes in the operating system of this server are required. Knowledge base article to help you can be found <a href='https://phoenixnap.com/kb/configure-bmc-server-after-adding-to-network#ftoc-heading-3' target='_blank'>here</a>.
     # @param server_id [String] The server&#39;s ID.
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :force Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. (default to false)
     # @option opts [ServerPrivateNetwork] :server_private_network 
     # @return [ServerPrivateNetwork]
     def servers_server_id_private_networks_post(server_id, opts = {})
@@ -1028,9 +1111,10 @@ module BmcApi
     end
 
     # Adds the server to a private network.
-    # Adds the server to a private network. &lt;b&gt;No actual configuration is performed on the operating system.&lt;/b&gt; BMC configures exclusively the networking devices in the datacenter infrastructure. Manual network configuration changes in the operating system of this server are required. If the network contains a membership of type &#39;storage&#39;, the first twelve IPs are already reserved by BMC and not usable. These will return a Bad Request (400) if selected. Knowledge base article to help you can be found &lt;a href&#x3D;&#39;https://phoenixnap.com/kb/configure-bmc-server-after-adding-to-network#ftoc-heading-3&#39; target&#x3D;&#39;_blank&#39;&gt;here&lt;/a&gt;.
+    # Adds the server to a private network. &lt;b&gt;No actual configuration is performed on the operating system.&lt;/b&gt; 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 &lt;a href&#x3D;&#39;https://phoenixnap.com/kb/configure-bmc-server-after-adding-to-network#ftoc-heading-3&#39; target&#x3D;&#39;_blank&#39;&gt;here&lt;/a&gt;.
     # @param server_id [String] The server&#39;s ID.
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :force Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. (default to false)
     # @option opts [ServerPrivateNetwork] :server_private_network 
     # @return [Array<(ServerPrivateNetwork, Integer, Hash)>] ServerPrivateNetwork data, response status code and response headers
     def servers_server_id_private_networks_post_with_http_info(server_id, opts = {})
@@ -1046,6 +1130,7 @@ module BmcApi
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'force'] = opts[:'force'] if !opts[:'force'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -1155,10 +1240,90 @@ module BmcApi
       return data, status_code, headers
     end
 
+    # Updates the server's public network's IP addresses.
+    # IP address changes intended to keep the BMC data up to date with server's operating system. We do not have access to the server's operating system and therefore manual configuration is required to apply the changes on the host. Knowledge base article to help you can be found <a href='https://phoenixnap.com/kb/bmc-server-management-via-api#ftoc-heading-6' target='_blank'>here</a>
+    # @param server_id [String] The server&#39;s ID.
+    # @param public_network_id [String] The Public Network identifier.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :force Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. (default to false)
+    # @option opts [ServerNetworkUpdate] :server_network_update 
+    # @return [ServerPublicNetwork]
+    def servers_server_id_public_networks_patch(server_id, public_network_id, opts = {})
+      data, _status_code, _headers = servers_server_id_public_networks_patch_with_http_info(server_id, public_network_id, opts)
+      data
+    end
+
+    # Updates the server&#39;s public network&#39;s IP addresses.
+    # IP address changes intended to keep the BMC data up to date with server&#39;s operating system. We do not have access to the server&#39;s operating system and therefore manual configuration is required to apply the changes on the host. Knowledge base article to help you can be found &lt;a href&#x3D;&#39;https://phoenixnap.com/kb/bmc-server-management-via-api#ftoc-heading-6&#39; target&#x3D;&#39;_blank&#39;&gt;here&lt;/a&gt;
+    # @param server_id [String] The server&#39;s ID.
+    # @param public_network_id [String] The Public Network identifier.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :force Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. (default to false)
+    # @option opts [ServerNetworkUpdate] :server_network_update 
+    # @return [Array<(ServerPublicNetwork, Integer, Hash)>] ServerPublicNetwork data, response status code and response headers
+    def servers_server_id_public_networks_patch_with_http_info(server_id, public_network_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ServersApi.servers_server_id_public_networks_patch ...'
+      end
+      # verify the required parameter 'server_id' is set
+      if @api_client.config.client_side_validation && server_id.nil?
+        fail ArgumentError, "Missing the required parameter 'server_id' when calling ServersApi.servers_server_id_public_networks_patch"
+      end
+      # verify the required parameter 'public_network_id' is set
+      if @api_client.config.client_side_validation && public_network_id.nil?
+        fail ArgumentError, "Missing the required parameter 'public_network_id' when calling ServersApi.servers_server_id_public_networks_patch"
+      end
+      # resource path
+      local_var_path = '/servers/{serverId}/network-configuration/public-network-configuration/public-networks/{publicNetworkId}'.sub('{' + 'serverId' + '}', CGI.escape(server_id.to_s)).sub('{' + 'publicNetworkId' + '}', CGI.escape(public_network_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'force'] = opts[:'force'] if !opts[:'force'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'server_network_update'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ServerPublicNetwork'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"ServersApi.servers_server_id_public_networks_patch",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ServersApi#servers_server_id_public_networks_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Adds the server to a Public Network.
     # Adds the server to a Public Network. <b>No actual configuration is performed on the operating system.</b> BMC configures exclusively the networking devices in the datacenter infrastructure. Manual network configuration changes in the operating system of this server are required. Knowledge base article to help you can be found <a href='https://phoenixnap.com/kb/configure-bmc-server-after-adding-to-network#ftoc-heading-3' target='_blank'>here</a>.
     # @param server_id [String] The server&#39;s ID.
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :force Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. (default to false)
     # @option opts [ServerPublicNetwork] :server_public_network 
     # @return [ServerPublicNetwork]
     def servers_server_id_public_networks_post(server_id, opts = {})
@@ -1170,6 +1335,7 @@ module BmcApi
     # Adds the server to a Public Network. &lt;b&gt;No actual configuration is performed on the operating system.&lt;/b&gt; 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 &lt;a href&#x3D;&#39;https://phoenixnap.com/kb/configure-bmc-server-after-adding-to-network#ftoc-heading-3&#39; target&#x3D;&#39;_blank&#39;&gt;here&lt;/a&gt;.
     # @param server_id [String] The server&#39;s ID.
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :force Query parameter controlling advanced features availability. Currently applicable for networking. It is advised to use with caution since it might lead to unhealthy setups. (default to false)
     # @option opts [ServerPublicNetwork] :server_public_network 
     # @return [Array<(ServerPublicNetwork, Integer, Hash)>] ServerPublicNetwork data, response status code and response headers
     def servers_server_id_public_networks_post_with_http_info(server_id, opts = {})
@@ -1185,6 +1351,7 @@ module BmcApi
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'force'] = opts[:'force'] if !opts[:'force'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/pnap_bmc_api/models/ip_blocks_configuration.rb

@@ -16,7 +16,7 @@ require 'time'
 module BmcApi
   # The IP blocks to assign to this server. <b>This is an exclusive allocation</b>, i.e. the IP blocks cannot be shared with other servers. If IpBlocksConfiguration is not defined, the purchase of a new IP block is determined by the networkType field.
   class IpBlocksConfiguration
-    # Determines the approach for configuring IP blocks for the server being provisioned. If PURCHASE_NEW is selected, the smallest supported range, depending on the operating system, is allocated to the server.
+    # (Write-only) Determines the approach for configuring IP blocks for the server being provisioned. If PURCHASE_NEW is selected, the smallest supported range, depending on the operating system, is allocated to the server.
     attr_accessor :configuration_type
 
     # Used to specify the previously purchased IP blocks to assign to this server upon provisioning. Used alongside the USER_DEFINED configurationType.

data/lib/pnap_bmc_api/models/network_configuration.rb

@@ -16,7 +16,7 @@ require 'time'
 module BmcApi
   # Entire network details of bare metal server.
   class NetworkConfiguration
-    # The address of the gateway assigned / to assign to the server. When used as part of request body, IP address has to be part of private/public network assigned to this server.
+    # 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 a private/public network or an IP block assigned to this server.<br> Gateway address also has to be assigned on an already deployed resource unless the address matches the BMC gateway address in a public network/IP block or the `force` query parameter is true.
     attr_accessor :gateway_address
 
     attr_accessor :private_network_configuration

data/lib/pnap_bmc_api/models/os_configuration.rb

@@ -16,18 +16,22 @@ require 'time'
 module BmcApi
   # OS specific configuration properties.
   class OsConfiguration
+    attr_accessor :netris_controller
+
+    attr_accessor :netris_softgate
+
     attr_accessor :windows
 
-    # Password set for user root on an ESXi server which will only be returned in response to provisioning a server.
+    # (Read-only) Auto-generated password set for user 'root' on an ESXi or Proxmox server.<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.
     attr_accessor :root_password
 
-    # The URL of the management UI which will only be returned in response to provisioning a server.
+    # (Read-only) The URL of the management UI which will only be returned in response to provisioning a server.
     attr_accessor :management_ui_url
 
     # 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.
     attr_accessor :management_access_allowed_ips
 
-    # If true, OS will be installed to and booted from the server's RAM. On restart RAM OS will be lost and the server will not be reachable unless a custom bootable OS has been deployed. Only supported for ubuntu/focal.
+    # 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.
     attr_accessor :install_os_to_ram
 
     attr_accessor :cloud_init
@@ -35,6 +39,8 @@ module BmcApi
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'netris_controller' => :'netrisController',
+        :'netris_softgate' => :'netrisSoftgate',
         :'windows' => :'windows',
         :'root_password' => :'rootPassword',
         :'management_ui_url' => :'managementUiUrl',
@@ -52,6 +58,8 @@ module BmcApi
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'netris_controller' => :'OsConfigurationNetrisController',
+        :'netris_softgate' => :'OsConfigurationNetrisSoftgate',
         :'windows' => :'OsConfigurationWindows',
         :'root_password' => :'String',
         :'management_ui_url' => :'String',
@@ -82,6 +90,14 @@ module BmcApi
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'netris_controller')
+        self.netris_controller = attributes[:'netris_controller']
+      end
+
+      if attributes.key?(:'netris_softgate')
+        self.netris_softgate = attributes[:'netris_softgate']
+      end
+
       if attributes.key?(:'windows')
         self.windows = attributes[:'windows']
       end
@@ -144,6 +160,8 @@ module BmcApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          netris_controller == o.netris_controller &&
+          netris_softgate == o.netris_softgate &&
           windows == o.windows &&
           root_password == o.root_password &&
           management_ui_url == o.management_ui_url &&
@@ -161,7 +179,7 @@ module BmcApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [windows, root_password, management_ui_url, management_access_allowed_ips, install_os_to_ram, cloud_init].hash
+      [netris_controller, netris_softgate, windows, root_password, management_ui_url, management_access_allowed_ips, install_os_to_ram, cloud_init].hash
     end
 
     # Builds the object from hash

data/lib/pnap_bmc_api/models/os_configuration_cloud_init.rb

@@ -16,7 +16,7 @@ require 'time'
 module BmcApi
   # Cloud-init configuration details.
   class OsConfigurationCloudInit
-    # 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 and ubuntu/focal are supported. User data will not be stored and cannot be retrieved once you deploy the server. Copy and save it for future reference.
+    # 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.
     attr_accessor :user_data
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/pnap_bmc_api/models/os_configuration_map_esxi.rb

@@ -16,10 +16,10 @@ require 'time'
 module BmcApi
   # VMWare ESXi configuration properties.
   class OsConfigurationMapEsxi
-    # Password set for user root on an ESXi server which will only be returned in response to provisioning a server.
+    # (Read-only) Password set for user root on an ESXi server which will only be returned in response to provisioning a server.
     attr_accessor :root_password
 
-    # The URL of the management UI which will only be returned in response to provisioning a server.
+    # (Read-only) The URL of the management UI which will only be returned in response to provisioning a server.
     attr_accessor :management_ui_url
 
     # 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.

data/lib/pnap_bmc_api/models/os_configuration_map_proxmox.rb

@@ -16,10 +16,10 @@ require 'time'
 module BmcApi
   # Proxmox VE configuration properties.
   class OsConfigurationMapProxmox
-    # Password set for user root on a Proxmox server which will only be returned in response to provisioning a server.
+    # (Read-only) Password set for user root on a Proxmox server which will only be returned in response to provisioning a server.
     attr_accessor :root_password
 
-    # The URL of the management UI which will only be returned in response to provisioning a server.
+    # (Read-only) The URL of the management UI which will only be returned in response to provisioning a server.
     attr_accessor :management_ui_url
 
     # 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.

data/lib/pnap_bmc_api/models/os_configuration_netris_controller.rb

@@ -0,0 +1,241 @@
+=begin
+#Bare Metal Cloud API
+
+#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> 
+
+The version of the OpenAPI document: 0.1
+Contact: support@phoenixnap.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module BmcApi
+  # Netris Controller configuration properties.
+  class OsConfigurationNetrisController
+    # (Read-only) Host OS on which the Netris Controller is installed.
+    attr_accessor :host_os
+
+    # (Read-only) The URL for the Netris Controller web console. Will only be returned in response to provisioning a server.
+    attr_accessor :netris_web_console_url
+
+    # (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.
+    attr_accessor :netris_user_password
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'host_os' => :'hostOs',
+        :'netris_web_console_url' => :'netrisWebConsoleUrl',
+        :'netris_user_password' => :'netrisUserPassword'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'host_os' => :'String',
+        :'netris_web_console_url' => :'String',
+        :'netris_user_password' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `BmcApi::OsConfigurationNetrisController` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `BmcApi::OsConfigurationNetrisController`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'host_os')
+        self.host_os = attributes[:'host_os']
+      end
+
+      if attributes.key?(:'netris_web_console_url')
+        self.netris_web_console_url = attributes[:'netris_web_console_url']
+      end
+
+      if attributes.key?(:'netris_user_password')
+        self.netris_user_password = attributes[:'netris_user_password']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          host_os == o.host_os &&
+          netris_web_console_url == o.netris_web_console_url &&
+          netris_user_password == o.netris_user_password
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [host_os, netris_web_console_url, netris_user_password].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = BmcApi.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end