Module: BmcApi

Defined in:
lib/pnap_bmc_api/api_error.rb,
lib/pnap_bmc_api.rb,
lib/pnap_bmc_api/version.rb,
lib/pnap_bmc_api/api_client.rb,
lib/pnap_bmc_api/models/error.rb,
lib/pnap_bmc_api/models/quota.rb,
lib/pnap_bmc_api/configuration.rb,
lib/pnap_bmc_api/models/server.rb,
lib/pnap_bmc_api/api/quotas_api.rb,
lib/pnap_bmc_api/models/ssh_key.rb,
lib/pnap_bmc_api/api/servers_api.rb,
lib/pnap_bmc_api/api/ssh_keys_api.rb,
lib/pnap_bmc_api/models/reset_result.rb,
lib/pnap_bmc_api/models/server_patch.rb,
lib/pnap_bmc_api/models/server_reset.rb,
lib/pnap_bmc_api/models/action_result.rb,
lib/pnap_bmc_api/models/delete_result.rb,
lib/pnap_bmc_api/models/server_create.rb,
lib/pnap_bmc_api/models/server_reserve.rb,
lib/pnap_bmc_api/models/ssh_key_create.rb,
lib/pnap_bmc_api/models/ssh_key_update.rb,
lib/pnap_bmc_api/models/tag_assignment.rb,
lib/pnap_bmc_api/models/server_ip_block.rb,
lib/pnap_bmc_api/models/os_configuration.rb,
lib/pnap_bmc_api/models/server_provision.rb,
lib/pnap_bmc_api/models/relinquish_ip_block.rb,
lib/pnap_bmc_api/models/os_configuration_map.rb,
lib/pnap_bmc_api/models/delete_ssh_key_result.rb,
lib/pnap_bmc_api/models/esxi_os_configuration.rb,
lib/pnap_bmc_api/models/network_configuration.rb,
lib/pnap_bmc_api/models/server_network_update.rb,
lib/pnap_bmc_api/models/server_public_network.rb,
lib/pnap_bmc_api/models/storage_configuration.rb,
lib/pnap_bmc_api/models/server_private_network.rb,
lib/pnap_bmc_api/models/tag_assignment_request.rb,
lib/pnap_bmc_api/models/ip_blocks_configuration.rb,
lib/pnap_bmc_api/models/os_configuration_windows.rb,
lib/pnap_bmc_api/models/quota_edit_limit_request.rb,
lib/pnap_bmc_api/models/os_configuration_map_esxi.rb,
lib/pnap_bmc_api/models/os_configuration_cloud_init.rb,
lib/pnap_bmc_api/models/esxi_datastore_configuration.rb,
lib/pnap_bmc_api/models/os_configuration_map_proxmox.rb,
lib/pnap_bmc_api/models/public_network_configuration.rb,
lib/pnap_bmc_api/models/private_network_configuration.rb,
lib/pnap_bmc_api/models/os_configuration_netris_softgate.rb,
lib/pnap_bmc_api/models/quota_edit_limit_request_details.rb,
lib/pnap_bmc_api/models/os_configuration_netris_controller.rb,
lib/pnap_bmc_api/models/storage_configuration_root_partition.rb

Overview

#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.

<span class=‘pnap-api-knowledge-base-link’> Knowledge base articles to help you can be found <a href=‘phoenixnap.com/kb/how-to-deploy-bare-metal-cloud-server’ target=‘_blank’>here</a> </span>

All URLs are relative to (https://api.phoenixnap.com/bmc/v1/)

The version of the OpenAPI document: 0.1 Contact: [email protected] Generated by: openapi-generator.tech OpenAPI Generator version: 7.2.0

Defined Under Namespace

Classes: ActionResult, ApiClient, ApiError, Configuration, DeleteResult, DeleteSshKeyResult, Error, EsxiDatastoreConfiguration, EsxiOsConfiguration, IpBlocksConfiguration, NetworkConfiguration, OsConfiguration, OsConfigurationCloudInit, OsConfigurationMap, OsConfigurationMapEsxi, OsConfigurationMapProxmox, OsConfigurationNetrisController, OsConfigurationNetrisSoftgate, OsConfigurationWindows, PrivateNetworkConfiguration, PublicNetworkConfiguration, Quota, QuotaEditLimitRequest, QuotaEditLimitRequestDetails, QuotasApi, RelinquishIpBlock, ResetResult, SSHKeysApi, Server, ServerCreate, ServerIpBlock, ServerNetworkUpdate, ServerPatch, ServerPrivateNetwork, ServerProvision, ServerPublicNetwork, ServerReserve, ServerReset, ServersApi, SshKey, SshKeyCreate, SshKeyUpdate, StorageConfiguration, StorageConfigurationRootPartition, TagAssignment, TagAssignmentRequest

Constant Summary collapse

VERSION = 
get_version()

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

BmcApi.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



74
75
76
77
78
79
80
 
# File 'lib/pnap_bmc_api.rb', line 74

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end