class ForemanApi::Resources::Interface

Public Class Methods

doc() click to toggle source
# File lib/foreman_api/resources/interface.rb, line 4
def self.doc
  @doc ||= ForemanApi.doc['resources']["interfaces"]
end

Public Instance Methods

create(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] host_id id or name of host @option params [Hash] interface interface information

allowed keys are:
* domain_id [Numeric]  foreman domain id of interface 
* subnet_id [Numeric]  foreman subnet id of interface 
* ip [String]  ip address of interface 
* mac [String]  mac address of interface 
* name [String]  interface name 
* password [String]
* provider [String]  interface provider, i.e: ipmi 
* type [String]  interface type, i.e: nic::bmc 
* username [String]

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/interface.rb, line 43
def create(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
destroy(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] id id of interface @option params [Object] host_id Part of +/api/hosts/:host_id/interfaces/:id+ path

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/interface.rb, line 74
def destroy(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
index(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] host_id id or name of host

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/interface.rb, line 13
def index(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
show(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [String] id id or name of interface @option params [String] host_id id or name of nested host

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/interface.rb, line 23
def show(params = {}, headers = {})
  perform_call(__method__, params, headers)
end
update(params = {}, headers = {}) click to toggle source

@param [Hash] params a hash of params to be passed to the service @option params [Object] id Part of +/api/hosts/:host_id/interfaces/:id+ path @option params [String] host_id id or name of host @option params [Hash] interface interface information

allowed keys are:
* domain_id [Numeric]  foreman domain id of interface 
* subnet_id [Numeric]  foreman subnet id of interface 
* ip [String]  ip address of interface 
* mac [String]  mac address of interface 
* name [String]  interface name 
* password [String]
* provider [String]  interface provider, i.e: ipmi 
* type [String]  interface type, i.e: nic::bmc 
* username [String]

@param [Hash] headers additional http headers @return [Array] First item: parsed data; second item: raw body

# File lib/foreman_api/resources/interface.rb, line 64
def update(params = {}, headers = {})
  perform_call(__method__, params, headers)
end