class SoftLayer::Server

Server is the base class for VirtualServer and BareMetalServer. It implements some functionality common to both those classes.

Server is an abstract class and you should not create them directly.

While VirtualServer and BareMetalServer each have analogs in the SoftLayer API, those analogs do not share a direct ancestry. As a result there is no SoftLayer API analog to this class.

Attributes

datacenter[R]

The data center where the server is located

domain[R]

The domain name SoftLayer has stored for the server

fqdn[R]

A convenience attribute that combines the hostname and domain name

fullyQualifiedDomainName[R]

A convenience attribute that combines the hostname and domain name

DEPRECATION WARNING: This attribute is deprecated in favor of fqdn and will be removed in the next major release.

hostname[R]

The host name SoftLayer has stored for the server

notes[R]

Notes about these server (for use by the customer)

notified_network_monitor_users[R]

The list of user customers notified on monitoring failures :call-seq:

notified_network_monitor_users(force_update=false)
primary_private_ip[R]

The IP address of the primary private interface for the server

primary_public_ip[R]

The IP address of the primary public interface for the server

Public Class Methods

new(softlayer_client, network_hash) click to toggle source

Construct a server from the given client using the network data found in network_hash

Most users should not have to call this method directly. Instead you should access the servers property of an Account object, or use methods like BareMetalServer#find_servers or VirtualServer#find_servers

Calls superclass method SoftLayer::ModelBase.new
# File lib/softlayer/Server.rb, line 160
def initialize(softlayer_client, network_hash)
  if self.class == Server
    raise RuntimeError, "The Server class is an abstract base class and should not be instantiated directly"
  else
    super
  end
end

Protected Class Methods

default_object_mask() click to toggle source

returns the default object mask for all servers structured as a hash so that the classes BareMetalServer and VirtualServer can use hash construction techniques to specialize the mask for their use.

# File lib/softlayer/Server.rb, line 326
def self.default_object_mask
  { "mask" => [
      'id',
      'globalIdentifier',
      'notes',
      'hostname',
      'domain',
      'fullyQualifiedDomainName',
      'datacenter',
      'primaryIpAddress',
      'primaryBackendIpAddress',
      { 'operatingSystem' => {
          'softwareLicense.softwareDescription' => ['manufacturer', 'name', 'version','referenceCode'],
          'passwords' => ['username','password']
        }
      },
      'privateNetworkOnlyFlag',
      'userData',
      'networkComponents.primarySubnet[id, netmask, broadcastAddress, networkIdentifier, gateway]',
      'billingItem[id,recurringFee]',
      'hourlyBillingFlag',
      'tagReferences[id,tag[name,id]]',
      'networkVlans[id,vlanNumber,networkSpace]',
      'postInstallScriptUri'
    ]
  }
end

Public Instance Methods

change_port_speed(new_speed, public = true) click to toggle source

Change the current port speed of the server

new_speed is expressed Mbps and should be 0, 10, 100, or 1000. Ports have a maximum speed that will limit the actual speed set on the port.

Set public to false in order to change the speed of the private network interface.

# File lib/softlayer/Server.rb, line 278
def change_port_speed(new_speed, public = true)
  if public
    self.service.setPublicNetworkInterfaceSpeed(new_speed)
  else
    self.service.setPrivateNetworkInterfaceSpeed(new_speed)
  end

  self.refresh_details()
  self
end
firewall_port_speed() click to toggle source

Returns the max port speed of the public network interfaces of the server taking into account bound interface pairs (redundant network cards).

# File lib/softlayer/Server.rb, line 262
def firewall_port_speed
  network_components = self.service.object_mask("mask[id,maxSpeed]").getFrontendNetworkComponents()
  max_speeds = network_components.collect { |component| component['maxSpeed'] }

  max_speeds.empty? ? 0 : max_speeds.max
end
network_monitor_levels(force_update=false) click to toggle source

The maximum network monitor query/response levels currently supported by the server

# File lib/softlayer/Server.rb, line 68
sl_dynamic_attr :network_monitor_levels do |resource|
  resource.should_update? do
    @network_monitor_levels == nil
  end

  resource.to_update do
    NetworkMonitorLevels.new(self.service.getAvailableMonitoring)
  end
end
network_monitors(force_update=false) click to toggle source

A lsst of configured network monitors.

# File lib/softlayer/Server.rb, line 82
sl_dynamic_attr :network_monitors do |resource|
  resource.should_update? do
    @network_monitors == nil
  end

  resource.to_update do
    network_monitors_data = self.service.object_mask(NetworkMonitor.default_object_mask).getNetworkMonitors

    network_monitors_data.map! do |network_monitor|
      NetworkMonitor.new(softlayer_client, network_monitor) unless network_monitor.empty?
    end

    network_monitors_data.compact
  end
end
notes=(new_notes) click to toggle source

Change the notes of the server raises ArgumentError if you pass nil as the notes

# File lib/softlayer/Server.rb, line 205
def notes=(new_notes)
  raise ArgumentError, "The new notes cannot be nil" unless new_notes

  edit_template = {
    "notes" => new_notes
  }

  self.service.editObject(edit_template)
  self.refresh_details()
end
primary_network_component(force_update=false) click to toggle source

Retrieve the primary network component

# File lib/softlayer/Server.rb, line 127
sl_dynamic_attr :primary_network_component do |primary_component|
  primary_component.should_update? do
    return @primary_network_component == nil
  end

  primary_component.to_update do
    component_data = self.service.getPrimaryNetworkComponent();
    SoftLayer::NetworkComponent.new(self.softlayer_client, component_data)
  end
end
reboot!(reboot_technique = :default_reboot) click to toggle source

Reboot the server. This action is taken immediately. Servers can be rebooted in three different ways: :default_reboot - (Try soft, then hard) Attempts to reboot a server using the :os_reboot technique then, if that is not successful, tries the :power_cycle method :os_reboot - (aka. soft reboot) instructs the server's host operating system to reboot :power_cycle - (aka. hard reboot) The actual (for hardware) or metaphorical (for virtual servers) equivalent to pulling the plug on the server then plugging it back in.

# File lib/softlayer/Server.rb, line 174
def reboot!(reboot_technique = :default_reboot)
  case reboot_technique
  when :default_reboot
    self.service.rebootDefault
  when :os_reboot
    self.service.rebootSoft
  when :power_cycle
    self.service.rebootHard
  else
    raise ArgumentError, "Unrecognized reboot technique in SoftLayer::Server#reboot!}"
  end
end
reload_os!(token = '', provisioning_script_uri = nil, ssh_keys = nil) click to toggle source

Begins an OS reload on this server.

The OS reload can wipe out the data on your server so this method uses a confirmation mechanism built into the underlying SoftLayer API. If you call this method once without a token, it will not actually start the reload. Instead it will return a token to you. That token is good for 10 minutes. If you call this method again and pass that token *then* the OS reload will actually begin.

If you wish to force the OS Reload and bypass the token safety mechanism pass the token 'FORCE' as the first parameter. If you do so the reload will proceed immediately.

# File lib/softlayer/Server.rb, line 303
def reload_os!(token = '', provisioning_script_uri = nil, ssh_keys = nil)
  configuration = {}

  configuration['customProvisionScriptUri'] = provisioning_script_uri if provisioning_script_uri
  configuration['sshKeyIds'] = ssh_keys if ssh_keys

  self.service.reloadOperatingSystem(token, configuration)
end
set_domain!(new_domain) click to toggle source

Change the domain of this server

Raises an ArgumentError if the new domain is nil or empty no further validation is done on the domain name

# File lib/softlayer/Server.rb, line 247
def set_domain!(new_domain)
  raise ArgumentError, "The new hostname cannot be nil" unless new_domain
  raise ArgumentError, "The new hostname cannot be empty" if new_domain.empty?

  edit_template = {
    "domain" => new_domain
  }

  self.service.editObject(edit_template)
  self.refresh_details()
end
set_hostname!(new_hostname) click to toggle source

Change the hostname of this server Raises an ArgumentError if the new hostname is nil or empty

# File lib/softlayer/Server.rb, line 229
def set_hostname!(new_hostname)
  raise ArgumentError, "The new hostname cannot be nil" unless new_hostname
  raise ArgumentError, "The new hostname cannot be empty" if new_hostname.empty?

  edit_template = {
    "hostname" => new_hostname
  }

  self.service.editObject(edit_template)
  self.refresh_details()
end
softlayer_properties(object_mask = nil) click to toggle source

Make an API request to SoftLayer and return the latest properties hash for this object.

# File lib/softlayer/Server.rb, line 190
def softlayer_properties(object_mask = nil)
  my_service = self.service

  if(object_mask)
    my_service = my_service.object_mask(object_mask)
  else
    my_service = my_service.object_mask(self.class.default_object_mask.to_sl_object_mask)
  end

  my_service.getObject()
end
software(force_update=false) click to toggle source

Retrieve all software installed on current server

# File lib/softlayer/Server.rb, line 142
sl_dynamic_attr :software do |software|
  software.should_update? do
    @software == nil
  end

  software.to_update do
    software_data = self.service.object_mask(Software.default_object_mask).getSoftwareComponents
    software_data.collect { |sw| Software.new(self.softlayer_client, sw) unless sw.empty? }.compact
  end
end
to_s() click to toggle source
Calls superclass method
# File lib/softlayer/Server.rb, line 312
def to_s
  result = super
  if respond_to?(:hostname) then
    result.sub!('>', ", #{hostname}>")
  end
  result
end
user_metadata=(new_metadata) click to toggle source

Change the user metadata for the server.

# File lib/softlayer/Server.rb, line 219
def user_metadata=(new_metadata)
  raise ArgumentError, "Cannot set user metadata to nil" unless new_metadata
  self.service.setUserMetadata([new_metadata])
  self.refresh_details()
end