Class: OneviewSDK::API200::Interconnect

Inherits:
Resource show all
Defined in:
lib/oneview-sdk/resource/api200/interconnect.rb

Overview

Interconnect resource implementation

Constant Summary collapse

BASE_URI = 
'/rest/interconnects'.freeze
TYPE_URI = 
'/rest/interconnect-types'.freeze
UNIQUE_IDENTIFIERS = 
%w[name uri serialNumber].freeze

Constants inherited from Resource

Resource::DEFAULT_REQUEST_HEADER

Instance Attribute Summary

Attributes inherited from Resource

#api_version, #client, #data, #logger

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Resource

#==, #[], #[]=, build_query, #create!, #deep_merge!, #each, #eql?, #exists?, find_by, find_with_pagination, from_file, get_all, get_all_with_query, #like?, #refresh, #retrieve!, #schema, schema, #set, #set_all, #to_file

Constructor Details

#initialize(client, params = {}, api_ver = nil) ⇒ Interconnect

Create a resource object, associate it with a client, and set its properties.

Parameters:

  • client (OneviewSDK::Client) —

    The client object for the OneView appliance

  • params (Hash) (defaults to: {}) —

    The options for this resource (key-value pairs)

  • api_ver (Integer) (defaults to: nil) —

    The api version to use when interracting with this resource.



26
27
28
29
30
 
# File 'lib/oneview-sdk/resource/api200/interconnect.rb', line 26

def initialize(client, params = {}, api_ver = nil)
  super
  # Default values:
  @data['type'] ||= 'InterconnectV3'
end

Class Method Details

.get_type(client, name) ⇒ Array

Retrieves the interconnect type with name

Parameters:

  • client (OneviewSDK::Client) —

    The client object for the OneView appliance

  • name (String) —

    Interconnect type name

Returns:

  • (Array) —

    Interconnect type



62
63
64
65
 
# File 'lib/oneview-sdk/resource/api200/interconnect.rb', line 62

def self.get_type(client, name)
  results = get_types(client)
  results.find { |interconnect_type| interconnect_type['name'] == name }
end

.get_types(client) ⇒ Object

Retrieves interconnect types

Parameters:



52
53
54
55
56
 
# File 'lib/oneview-sdk/resource/api200/interconnect.rb', line 52

def self.get_types(client)
  response = client.rest_get(TYPE_URI)
  response = client.response_handler(response)
  response['members']
end

Instance Method Details

#create ⇒ Object

Method is not available

Raises:



34
35
36
 
# File 'lib/oneview-sdk/resource/api200/interconnect.rb', line 34

def create(*)
  unavailable_method
end

#delete ⇒ Object

Method is not available

Raises:



46
47
48
 
# File 'lib/oneview-sdk/resource/api200/interconnect.rb', line 46

def delete(*)
  unavailable_method
end

#name_servers ⇒ Object

Retrieves the named servers for this interconnect



68
69
70
71
 
# File 'lib/oneview-sdk/resource/api200/interconnect.rb', line 68

def name_servers
  response = @client.rest_get(@data['uri'] + '/nameServers')
  response.body
end

#patch(operation, path, value) ⇒ Object

Updates specific attributes for a given interconnect resource

Parameters:

  • operation (String) —

    operation to be performed

  • path (String) —

    path

  • value (String) —

    value



108
109
110
111
 
# File 'lib/oneview-sdk/resource/api200/interconnect.rb', line 108

def patch(operation, path, value)
  response = @client.rest_patch(@data['uri'], 'body' => [{ op: operation, path: path, value: value }])
  @client.response_handler(response)
end

#reset_port_protection ⇒ Object

Triggers the reset port protection action



99
100
101
102
 
# File 'lib/oneview-sdk/resource/api200/interconnect.rb', line 99

def reset_port_protection
  response = @client.rest_put(@data['uri'] + '/resetportprotection')
  @client.response_handler(response)
end

#statistics(portName = nil, subportNumber = nil) ⇒ Object

Get statistics for an interconnect, for the specified port or subport

Parameters:

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

    port to retrieve statistics

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

    subport to retrieve statistics



88
89
90
91
92
93
94
95
96
 
# File 'lib/oneview-sdk/resource/api200/interconnect.rb', line 88

def statistics(portName = nil, subportNumber = nil)
  uri = if subportNumber.nil?
          "#{@data['uri']}/statistics/#{portName}"
        else
          "#{@data['uri']}/statistics/#{portName}/subport/#{subportNumber}"
        end
  response = @client.rest_get(uri)
  response.body
end

#update ⇒ Object

Method is not available

Raises:



40
41
42
 
# File 'lib/oneview-sdk/resource/api200/interconnect.rb', line 40

def update(*)
  unavailable_method
end

#update_port(portName, attributes) ⇒ Object

Updates an interconnect port

Parameters:

  • portName (String) —

    port name

  • attributes (Hash) —

    hash with attributes and values to be changed



76
77
78
79
80
81
82
83
 
# File 'lib/oneview-sdk/resource/api200/interconnect.rb', line 76

def update_port(portName, attributes)
  @data['ports'].each do |port|
    next unless port['name'] == portName
    attributes.each { |key, value| port[key.to_s] = value }
    response = @client.rest_put(@data['uri'] + '/ports', 'body' => port)
    @client.response_handler(response)
  end
end