Module: MgmtConsole::Client::EngageServers

Included in:
MgmtConsole::Client
Defined in:
lib/mgmt_console/client/engage_servers.rb

Overview

Methods for the EngageServers API

Instance Method Summary collapse

Instance Method Details

#create_engage_server(hostname = nil, options = {}) ⇒ Sawyer::Resource

Create Engage Server

Examples:

Create engage server

@client.create_engage_server('r225.spigit.com')

Parameters:

  • hostname (String) (defaults to: nil) —

    Engage Server hostname

Returns:

  • (Sawyer::Resource) —

    Engage Server

Raises:



22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/mgmt_console/client/engage_servers.rb', line 22

def create_engage_server(hostname=nil, options = {})
  raise MgmtConsole::BadRequest.new('You must provide the Engage Server hostname as the first paramater') unless hostname

  # Optional
  timezone = options.delete(:timezone)

  params = {
    :hostname => hostname,
    :timezone => timezone
  }.reject { |k,v| v.nil? }

  data = post("#{api_endpoint}/engage_servers", options.merge(params))
end

#engage_servers(options = {}) ⇒ Array<Sawyer::Resource>

Get Engage Servers list

Examples:

Get engage servers

@client.engage_servers

Returns:

  • (Array<Sawyer::Resource>) —

    Array of engage servers



12
13
14
 
# File 'lib/mgmt_console/client/engage_servers.rb', line 12

def engage_servers(options = {})
  data = get("#{api_endpoint}/engage_servers", options)
end

#update_engage_server(id = nil, options = {}) ⇒ Sawyer::Resource

Update Engage Server

Examples:

Update engage server

@client.update_engage_server('47d80252-f65e-41bb-b589-7833a1fdd623', server_environment_id: '7ab127a6-1d80-477f-b349-08bfc7e757ac')

Parameters:

  • id (String) (defaults to: nil) —

    Engage Server ID

Returns:

  • (Sawyer::Resource) —

    Engage Server

Raises:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/mgmt_console/client/engage_servers.rb', line 42

def update_engage_server(id=nil, options = {})
  raise MgmtConsole::BadRequest.new('You must provide the Engage Server ID as the first paramater') unless id

  # Optional
  server_environment_id = options.delete(:server_environment_id)
  timezone              = options.delete(:timezone)

  params = {
    server_environment_id: server_environment_id,
    timezone: timezone,
  }.reject { |k,v| v.nil? }

  data = patch("#{api_endpoint}/engage_servers/#{id}", options.merge(params))
end