Class: ForemanApi::Resources::Interface

Inherits:
Base
  • Object
show all
Defined in:
lib/foreman_api/resources/interface.rb

Constant Summary

Constants inherited from Base

Base::API_VERSION

Instance Attribute Summary

Attributes inherited from Base

#client, #config, #logger

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#http_call, #initialize, method_doc, #perform_call, #validate_params!, validation_hash

Constructor Details

This class inherits a constructor from ForemanApi::Base

Class Method Details

.doc ⇒ Object 



4
5
6
 
# File 'lib/foreman_api/resources/interface.rb', line 4

def self.doc
  @doc ||= ForemanApi.doc['resources']["interfaces"]
end

Instance Method Details

#create(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

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

    a hash of params to be passed to the service

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

    additional http headers

Options Hash (params):

  • host_id (String) —

    id or name of host

  • interface (Hash, nil) —

    interface information allowed keys are:

    • domain_id [Numeric, nil] foreman domain id of interface

    • subnet_id [Numeric, nil] foreman subnet id of interface

    • ip [String] ip address of interface

    • mac [String] mac address of interface

    • name [String] interface name

    • password [String, nil]

    • provider [String, nil] interface provider, i.e: ipmi

    • type [String] interface type, i.e: nic::bmc

    • username [String, nil]

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



43
44
45
 
# File 'lib/foreman_api/resources/interface.rb', line 43

def create(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#destroy(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

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

    a hash of params to be passed to the service

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

    additional http headers

Options Hash (params):

  • id (String) —

    id of interface

  • host_id (Object) —

    Part of /api/hosts/:host_id/interfaces/:id path

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



74
75
76
 
# File 'lib/foreman_api/resources/interface.rb', line 74

def destroy(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#index(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

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

    a hash of params to be passed to the service

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

    additional http headers

Options Hash (params):

  • host_id (String) —

    id or name of host

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



13
14
15
 
# File 'lib/foreman_api/resources/interface.rb', line 13

def index(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#show(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

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

    a hash of params to be passed to the service

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

    additional http headers

Options Hash (params):

  • id (String) —

    id or name of interface

  • host_id (String) —

    id or name of nested host

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



23
24
25
 
# File 'lib/foreman_api/resources/interface.rb', line 23

def show(params = {}, headers = {})
  perform_call(__method__, params, headers)
end

#update(params = {}, headers = {}) ⇒ Array

Returns First item: parsed data; second item: raw body.

Parameters:

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

    a hash of params to be passed to the service

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

    additional http headers

Options Hash (params):

  • id (String)
  • host_id (String) —

    id or name of host

  • interface (Hash, nil) —

    interface information allowed keys are:

    • domain_id [Numeric, nil] foreman domain id of interface

    • subnet_id [Numeric, nil] foreman subnet id of interface

    • ip [String] ip address of interface

    • mac [String] mac address of interface

    • name [String] interface name

    • password [String, nil]

    • provider [String, nil] interface provider, i.e: ipmi

    • type [String] interface type, i.e: nic::bmc

    • username [String, nil]

Returns:

  • (Array) —

    First item: parsed data; second item: raw body



64
65
66
 
# File 'lib/foreman_api/resources/interface.rb', line 64

def update(params = {}, headers = {})
  perform_call(__method__, params, headers)
end