foreman_api 0.1.6 → 0.1.7

data/lib/foreman_api/resources/host_class.rb

@@ -15,8 +15,8 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] host_id Id of host
-      # @option params [String] puppetclass_id Id of puppetclass
+      # @option params [String] host_id  id of host 
+      # @option params [String] puppetclass_id  id of puppetclass 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -25,8 +25,8 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] id Id of puppetclass
-      # @option params [String] host_id Id of host
+      # @option params [String] id  id of puppetclass 
+      # @option params [String] host_id  id of host 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body

data/lib/foreman_api/resources/hostgroup.rb

@@ -6,10 +6,10 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] order Sort results
-      # @option params [String] page Paginate results
-      # @option params [String] per_page Number of entries per request
-      # @option params [String] search Filter results
+      # @option params [String] order  sort results 
+      # @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

data/lib/foreman_api/resources/hostgroup_class.rb

@@ -15,8 +15,8 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] hostgroup_id Id of hostgroup
-      # @option params [String] puppetclass_id Id of puppetclass
+      # @option params [String] hostgroup_id  id of hostgroup 
+      # @option params [String] puppetclass_id  id of puppetclass 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -26,8 +26,8 @@ module ForemanApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [Object] id Part of +/api/hostgroups/:hostgroup_id/puppetclass_ids/:id+ path
-      # @option params [String] hostgroup_id Id of hostgroup
-      # @option params [String] puppetclass_id Id of puppetclass
+      # @option params [String] hostgroup_id  id of hostgroup 
+      # @option params [String] puppetclass_id  id of puppetclass 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body

data/lib/foreman_api/resources/image.rb

@@ -7,10 +7,10 @@ module ForemanApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] compute_resource_id
-      # @option params [String] order Sort results
-      # @option params [String] page Paginate results
-      # @option params [String] per_page Number of entries per request
-      # @option params [String] search Filter results
+      # @option params [String] order  sort results 
+      # @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

data/lib/foreman_api/resources/interface.rb

@@ -0,0 +1,80 @@
+module ForemanApi
+  module Resources
+    class Interface < ForemanApi::Base
+      def self.doc
+        @doc ||= ForemanApi.doc['resources']["interfaces"]
+      end
+
+      # @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
+      def index(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+      # @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
+      def show(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+      # @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
+      def create(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+      # @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
+      def update(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+      # @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
+      def destroy(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+    end
+  end
+end

data/lib/foreman_api/resources/location.rb

@@ -6,10 +6,10 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] order Sort results
-      # @option params [String] page Paginate results
-      # @option params [String] per_page Number of entries per request
-      # @option params [String] search Filter results
+      # @option params [String] order  sort results 
+      # @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

data/lib/foreman_api/resources/lookup_key.rb

@@ -6,10 +6,10 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] order Sort results
-      # @option params [String] page Paginate results
-      # @option params [String] per_page Number of entries per request
-      # @option params [String] search Filter results
+      # @option params [String] order  sort results 
+      # @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
@@ -32,14 +32,9 @@ module ForemanApi
       #   * puppetclass_id [String]
       #   * default_value [String]
       #   * description [String]
-      #   * is_param [String]
       #   * key [String]
-      #   * key_type [String]
-      #   * override [String]
+      #   * lookup_values_count [String]
       #   * path [String]
-      #   * required [String]
-      #   * validator_rule [String]
-      #   * validator_type [String]
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -54,14 +49,9 @@ module ForemanApi
       #   * puppetclass_id [String]
       #   * default_value [String]
       #   * description [String]
-      #   * is_param [String]
       #   * key [String]
-      #   * key_type [String]
-      #   * override [String]
+      #   * lookup_values_count [String]
       #   * path [String]
-      #   * required [String]
-      #   * validator_rule [String]
-      #   * validator_type [String]
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -78,55 +68,6 @@ module ForemanApi
         perform_call(__method__, params, headers)
       end
 
-      # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] host_id
-      # @option params [String] hostgroup_id
-      # @option params [String] page Paginate results
-      # @option params [String] per_page Number of entries per request
-      #
-      # @param [Hash] headers additional http headers
-      # @return [Array] First item: parsed data; second item: raw body
-      def host_or_hostgroup_smart_parameters(params = {}, headers = {})
-        perform_call(__method__, params, headers)
-      end
-
-      # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] host_id
-      # @option params [String] hostgroup_id
-      # @option params [String] page Paginate results
-      # @option params [String] per_page Number of entries per request
-      #
-      # @param [Hash] headers additional http headers
-      # @return [Array] First item: parsed data; second item: raw body
-      def host_or_hostgroup_smart_class_parameters(params = {}, headers = {})
-        perform_call(__method__, params, headers)
-      end
-
-      # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] puppetclass_id
-      # @option params [String] order Sort results
-      # @option params [String] page Paginate results
-      # @option params [String] per_page Number of entries per request
-      #
-      # @param [Hash] headers additional http headers
-      # @return [Array] First item: parsed data; second item: raw body
-      def puppet_smart_parameters(params = {}, headers = {})
-        perform_call(__method__, params, headers)
-      end
-
-      # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] environment_id
-      # @option params [String] puppetclass_id
-      # @option params [String] order Sort results
-      # @option params [String] page Paginate results
-      # @option params [String] per_page Number of entries per request
-      #
-      # @param [Hash] headers additional http headers
-      # @return [Array] First item: parsed data; second item: raw body
-      def puppet_smart_class_parameters(params = {}, headers = {})
-        perform_call(__method__, params, headers)
-      end
-
     end
   end
 end

data/lib/foreman_api/resources/medium.rb

@@ -6,10 +6,10 @@ module ForemanApi
       end
 
       # @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
+      # @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
@@ -30,9 +30,9 @@ module ForemanApi
       # @option params [Hash] medium
       #   allowed keys are:
       #   * operatingsystem_ids [Array]
-      #   * name [String] Name of media
-      #   * os_family [String] The family that the operating system belongs to.  available families:   archlinux  debian  gentoo  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.averse.net/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.
+      #   * name [String]  name of media 
+      #   * os_family [String]  the family that the operating system belongs to.  available families:   archlinux  debian  gentoo  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
@@ -45,9 +45,9 @@ module ForemanApi
       # @option params [Hash] medium
       #   allowed keys are:
       #   * operatingsystem_ids [Array]
-      #   * name [String] Name of media
-      #   * os_family [String, nil] The family that the operating system belongs to.  available families:   archlinux  debian  gentoo  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.averse.net/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.
+      #   * name [String]  name of media 
+      #   * os_family [String, nil]  the family that the operating system belongs to.  available families:   archlinux  debian  gentoo  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

data/lib/foreman_api/resources/model.rb

@@ -6,10 +6,10 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] order Sort results
-      # @option params [String] page Paginate results
-      # @option params [String] per_page Number of entries per request
-      # @option params [String] search Filter results
+      # @option params [String] order  sort results 
+      # @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

data/lib/foreman_api/resources/operating_system.rb

@@ -6,10 +6,10 @@ module ForemanApi
       end
 
       # @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
+      # @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

data/lib/foreman_api/resources/organization.rb

@@ -6,10 +6,10 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] order Sort results
-      # @option params [String] page Paginate results
-      # @option params [String] per_page Number of entries per request
-      # @option params [String] search Filter results
+      # @option params [String] order  sort results 
+      # @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

data/lib/foreman_api/resources/override_value.rb

@@ -0,0 +1,73 @@
+module ForemanApi
+  module Resources
+    class OverrideValue < ForemanApi::Base
+      def self.doc
+        @doc ||= ForemanApi.doc['resources']["override_values"]
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] smart_class_parameter_id
+      # @option params [String] smart_variable_id
+      # @option params [String] page  paginate results 
+      # @option params [String] per_page  number of entries per request 
+      #
+      # @param [Hash] headers additional http headers
+      # @return [Array] First item: parsed data; second item: raw body
+      def index(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id
+      # @option params [String] smart_class_parameter_id
+      # @option params [String] smart_variable_id
+      #
+      # @param [Hash] headers additional http headers
+      # @return [Array] First item: parsed data; second item: raw body
+      def show(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] smart_class_parameter_id
+      # @option params [String] smart_variable_id
+      # @option params [Hash] override_value
+      #   allowed keys are:
+      #   * match [String]
+      #   * value [String]
+      #
+      # @param [Hash] headers additional http headers
+      # @return [Array] First item: parsed data; second item: raw body
+      def create(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [Object] id Part of +/api/smart_variables/:smart_variable_id/override_values/:id+ path
+      # @option params [String] smart_class_parameter_id
+      # @option params [String] smart_variable_id
+      # @option params [Hash] override_value
+      #   allowed keys are:
+      #   * match [String]
+      #   * value [String]
+      #
+      # @param [Hash] headers additional http headers
+      # @return [Array] First item: parsed data; second item: raw body
+      def update(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @option params [String] id
+      # @option params [String] smart_class_parameter_id
+      # @option params [String] smart_variable_id
+      #
+      # @param [Hash] headers additional http headers
+      # @return [Array] First item: parsed data; second item: raw body
+      def destroy(params = {}, headers = {})
+        perform_call(__method__, params, headers)
+      end
+
+    end
+  end
+end

data/lib/foreman_api/resources/parameter.rb

@@ -6,12 +6,12 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] domain_id Id of domain
-      # @option params [String] host_id Id of host
-      # @option params [String] hostgroup_id Id of hostgroup
-      # @option params [String] operatingsystem_id Id of operating system
-      # @option params [String] page Paginate results
-      # @option params [String] per_page Number of entries per request
+      # @option params [String] domain_id  id of domain 
+      # @option params [String] host_id  id of host 
+      # @option params [String] hostgroup_id  id of hostgroup 
+      # @option params [String] operatingsystem_id  id of operating system 
+      # @option params [String] page  paginate results 
+      # @option params [String] per_page  number of entries per request 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -20,11 +20,11 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] id Id of parameter
-      # @option params [String] domain_id Id of domain
-      # @option params [String] host_id Id of host
-      # @option params [String] hostgroup_id Id of hostgroup
-      # @option params [String] operatingsystem_id Id of operating system
+      # @option params [String] id  id of parameter 
+      # @option params [String] domain_id  id of domain 
+      # @option params [String] host_id  id of host 
+      # @option params [String] hostgroup_id  id of hostgroup 
+      # @option params [String] operatingsystem_id  id of operating system 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -33,10 +33,10 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] domain_id Id of domain
-      # @option params [String] host_id Id of host
-      # @option params [String] hostgroup_id Id of hostgroup
-      # @option params [String] operatingsystem_id Id of operating system
+      # @option params [String] domain_id  id of domain 
+      # @option params [String] host_id  id of host 
+      # @option params [String] hostgroup_id  id of hostgroup 
+      # @option params [String] operatingsystem_id  id of operating system 
       # @option params [Hash] parameter
       #   allowed keys are:
       #   * name [String]
@@ -49,11 +49,11 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] id Id of parameter
-      # @option params [String] domain_id Id of domain
-      # @option params [String] host_id Id of host
-      # @option params [String] hostgroup_id Id of hostgroup
-      # @option params [String] operatingsystem_id Id of operating system
+      # @option params [String] id  id of parameter 
+      # @option params [String] domain_id  id of domain 
+      # @option params [String] host_id  id of host 
+      # @option params [String] hostgroup_id  id of hostgroup 
+      # @option params [String] operatingsystem_id  id of operating system 
       # @option params [Hash] parameter
       #   allowed keys are:
       #   * name [String]
@@ -66,11 +66,11 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] id Id of parameter
-      # @option params [String] domain_id Id of domain
-      # @option params [String] host_id Id of host
-      # @option params [String] hostgroup_id Id of hostgroup
-      # @option params [String] operatingsystem_id Id of operating system
+      # @option params [String] id  id of parameter 
+      # @option params [String] domain_id  id of domain 
+      # @option params [String] host_id  id of host 
+      # @option params [String] hostgroup_id  id of hostgroup 
+      # @option params [String] operatingsystem_id  id of operating system 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body