Class/Module Index [+]

Quicksearch

ForemanApi::Resources::Medium

Public Class Methods

doc() click to toggle source
# File lib/foreman_api/resources/medium.rb, line 4
def self.doc
  @doc ||= ForemanApi.doc['resources']["media"]
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 [Hash, nil] medium

allowed keys are:
* operatingsystem_ids [Array, nil]
* name [String]  name of media 
* os_family [String, nil]  the family that the operating system belongs to.  available families:   aix  archlinux  debian  freebsd  gentoo  junos  redhat  solaris  suse  windows  
* path [String]  the path to the medium, can be a url or a valid nfs server (exclusive of the architecture).  for example http://mirror.centos.org/centos/$version/os/$arch where $arch will be substituted for the host’s actual os architecture and $version, $major and $minor will be substituted for the version of the operating system.  solaris and debian media may also use $release.

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

# File lib/foreman_api/resources/medium.rb, line 39
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

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

# File lib/foreman_api/resources/medium.rb, line 63
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] order for example, name asc, or name desc @option params [String] page paginate results @option params [String] per_page number of entries per request @option params [String] search filter results

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

# File lib/foreman_api/resources/medium.rb, line 16
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

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

# File lib/foreman_api/resources/medium.rb, line 25
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 [String] id @option params [Hash, nil] medium

allowed keys are:
* operatingsystem_ids [Array, nil]
* name [String]  name of media 
* os_family [String, nil]  the family that the operating system belongs to.  available families:   aix  archlinux  debian  freebsd  gentoo  junos  redhat  solaris  suse  windows  
* path [String]  the path to the medium, can be a url or a valid nfs server (exclusive of the architecture).  for example http://mirror.centos.org/centos/$version/os/$arch where $arch will be substituted for the host’s actual os architecture and $version, $major and $minor will be substituted for the version of the operating system.  solaris and debian media may also use $release.

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

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

[Validate]

Generated with the Darkfish Rdoc Generator 2.