foreman_api 0.1.9 → 0.1.10

data/lib/foreman_api/resources/hostgroup_class.rb

@@ -25,9 +25,8 @@ module ForemanApi
       end
 
       # @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] 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

@@ -30,7 +30,7 @@ module ForemanApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] compute_resource_id
-      # @option params [Hash] image
+      # @option params [Hash, nil] image
       #   allowed keys are:
       #   * architecture_id [String]
       #   * compute_resource_id [String]
@@ -48,7 +48,7 @@ module ForemanApi
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] id
       # @option params [String] compute_resource_id
-      # @option params [Hash] image
+      # @option params [Hash, nil] image
       #   allowed keys are:
       #   * architecture_id [String]
       #   * compute_resource_id [String]

data/lib/foreman_api/resources/interface.rb

@@ -26,17 +26,17 @@ module ForemanApi
 
       # @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 
+      # @option params [Hash, nil] interface  interface information 
       #   allowed keys are:
-      #   * domain_id [Numeric]  foreman domain id of interface 
-      #   * subnet_id [Numeric]  foreman subnet id of interface 
+      #   * 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]
-      #   * provider [String]  interface provider, i.e: ipmi 
+      #   * password [String, nil]
+      #   * provider [String, nil]  interface provider, i.e: ipmi 
       #   * type [String]  interface type, i.e: nic::bmc 
-      #   * username [String]
+      #   * username [String, nil]
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -45,19 +45,19 @@ module ForemanApi
       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] id
       # @option params [String] host_id  id or name of host 
-      # @option params [Hash] interface  interface information 
+      # @option params [Hash, nil] interface  interface information 
       #   allowed keys are:
-      #   * domain_id [Numeric]  foreman domain id of interface 
-      #   * subnet_id [Numeric]  foreman subnet id of interface 
+      #   * 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]
-      #   * provider [String]  interface provider, i.e: ipmi 
+      #   * password [String, nil]
+      #   * provider [String, nil]  interface provider, i.e: ipmi 
       #   * type [String]  interface type, i.e: nic::bmc 
-      #   * username [String]
+      #   * username [String, nil]
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body

data/lib/foreman_api/resources/location.rb

@@ -27,7 +27,7 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [Hash] location
+      # @option params [Hash, nil] location
       #   allowed keys are:
       #   * name [String]
       #
@@ -39,7 +39,7 @@ module ForemanApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [Object] id Part of +/api/locations/:id+ path
-      # @option params [Hash] location
+      # @option params [Hash, nil] location
       #   allowed keys are:
       #   * name [String]
       #

data/lib/foreman_api/resources/medium.rb

@@ -27,11 +27,11 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [Hash] medium
+      # @option params [Hash, nil] medium
       #   allowed keys are:
-      #   * operatingsystem_ids [Array]
+      #   * operatingsystem_ids [Array, nil]
       #   * name [String]  name of media 
-      #   * os_family [String]  the family that the operating system belongs to.  available families:   archlinux  debian  freebsd  gentoo  redhat  solaris  suse  windows  
+      #   * 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
@@ -42,11 +42,11 @@ module ForemanApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] id
-      # @option params [Hash] medium
+      # @option params [Hash, nil] medium
       #   allowed keys are:
-      #   * operatingsystem_ids [Array]
+      #   * operatingsystem_ids [Array, nil]
       #   * name [String]  name of media 
-      #   * os_family [String, nil]  the family that the operating system belongs to.  available families:   archlinux  debian  freebsd  gentoo  redhat  solaris  suse  windows  
+      #   * 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

data/lib/foreman_api/resources/model.rb

@@ -27,12 +27,12 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [Hash] model
+      # @option params [Hash, nil] model
       #   allowed keys are:
-      #   * hardware_model [String]
-      #   * info [String]
+      #   * hardware_model [String, nil]
+      #   * info [String, nil]
       #   * name [String]
-      #   * vendor_class [String]
+      #   * vendor_class [String, nil]
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -42,12 +42,12 @@ module ForemanApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] id
-      # @option params [Hash] model
+      # @option params [Hash, nil] model
       #   allowed keys are:
-      #   * hardware_model [String]
-      #   * info [String]
+      #   * hardware_model [String, nil]
+      #   * info [String, nil]
       #   * name [String]
-      #   * vendor_class [String]
+      #   * vendor_class [String, nil]
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body

data/lib/foreman_api/resources/operating_system.rb

@@ -27,14 +27,14 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [Hash] operatingsystem
+      # @option params [Hash, nil] operatingsystem
       #   allowed keys are:
-      #   * description [String]
-      #   * family [String]
+      #   * description [String, nil]
+      #   * family [String, nil]
       #   * major [String]
       #   * minor [String]
       #   * name [String]
-      #   * release_name [String]
+      #   * release_name [String, nil]
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -44,14 +44,14 @@ module ForemanApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] id
-      # @option params [Hash] operatingsystem
+      # @option params [Hash, nil] operatingsystem
       #   allowed keys are:
-      #   * description [String]
-      #   * family [String]
+      #   * description [String, nil]
+      #   * family [String, nil]
       #   * major [String]
       #   * minor [String]
       #   * name [String]
-      #   * release_name [String]
+      #   * release_name [String, nil]
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body

data/lib/foreman_api/resources/organization.rb

@@ -27,7 +27,7 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [Hash] organization
+      # @option params [Hash, nil] organization
       #   allowed keys are:
       #   * name [String]
       #
@@ -39,7 +39,7 @@ module ForemanApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [Object] id Part of +/api/organizations/:id+ path
-      # @option params [Hash] organization
+      # @option params [Hash, nil] organization
       #   allowed keys are:
       #   * name [String]
       #

data/lib/foreman_api/resources/os_default_template.rb

@@ -0,0 +1,68 @@
+module ForemanApi
+  module Resources
+    class OsDefaultTemplate < ForemanApi::Base
+      def self.doc
+        @doc ||= ForemanApi.doc['resources']["os_default_templates"]
+      end
+
+      # @param [Hash] params a hash of params to be passed to the service
+      # @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
+      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] operatingsystem_id  id of operating system 
+      #
+      # @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] operatingsystem_id  id of operating system 
+      # @option params [Hash, nil] os_default_template
+      #   allowed keys are:
+      #   * config_template_id [String, nil]
+      #   * template_kind_id [String, nil]
+      #
+      # @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 [String] id
+      # @option params [String] operatingsystem_id  id of operating system 
+      # @option params [Hash, nil] os_default_template
+      #   allowed keys are:
+      #   * config_template_id [String, nil]
+      #   * template_kind_id [String, nil]
+      #
+      # @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] operatingsystem_id  id of operating system 
+      #
+      # @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/override_value.rb

@@ -29,12 +29,12 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [String] smart_class_parameter_id
+      # @option params [Object] smart_class_parameter_id Part of +/api/smart_class_parameters/:smart_class_parameter_id/override_values+ path
       # @option params [String] smart_variable_id
-      # @option params [Hash] override_value
+      # @option params [Hash, nil] override_value
       #   allowed keys are:
-      #   * match [String]
-      #   * value [String]
+      #   * match [String, nil]
+      #   * value [String, nil]
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -44,12 +44,12 @@ module ForemanApi
 
       # @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
+      # @option params [Object] smart_class_parameter_id Part of +/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id+ path
+      # @option params [Object] smart_variable_id Part of +/api/smart_variables/:smart_variable_id/override_values/:id+ path
+      # @option params [Hash, nil] override_value
       #   allowed keys are:
-      #   * match [String]
-      #   * value [String]
+      #   * match [String, nil]
+      #   * value [String, nil]
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -59,8 +59,8 @@ module ForemanApi
 
       # @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
+      # @option params [Object] smart_class_parameter_id Part of +/api/smart_class_parameters/:smart_class_parameter_id/override_values/:id+ path
+      # @option params [Object] smart_variable_id Part of +/api/smart_variables/:smart_variable_id/override_values/:id+ path
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body

data/lib/foreman_api/resources/parameter.rb

@@ -9,7 +9,9 @@ module ForemanApi
       # @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] location_id  id of location 
       # @option params [String] operatingsystem_id  id of operating system 
+      # @option params [String] organization_id  id of organization 
       # @option params [String] page  paginate results 
       # @option params [String] per_page  number of entries per request 
       #
@@ -24,7 +26,9 @@ module ForemanApi
       # @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] location_id  id of location 
       # @option params [String] operatingsystem_id  id of operating system 
+      # @option params [String] organization_id  id of organization 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -36,8 +40,10 @@ module ForemanApi
       # @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] location_id  id of location 
       # @option params [String] operatingsystem_id  id of operating system 
-      # @option params [Hash] parameter
+      # @option params [String] organization_id  id of organization 
+      # @option params [Hash, nil] parameter
       #   allowed keys are:
       #   * name [String]
       #   * value [String]
@@ -53,8 +59,10 @@ module ForemanApi
       # @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] location_id  id of location 
       # @option params [String] operatingsystem_id  id of operating system 
-      # @option params [Hash] parameter
+      # @option params [String] organization_id  id of organization 
+      # @option params [Hash, nil] parameter
       #   allowed keys are:
       #   * name [String]
       #   * value [String]
@@ -70,7 +78,9 @@ module ForemanApi
       # @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] location_id  id of location 
       # @option params [String] operatingsystem_id  id of operating system 
+      # @option params [String] organization_id  id of organization 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -79,10 +89,12 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [Object] domain_id Part of +/api/domains/:domain_id/parameters+ path
-      # @option params [Object] host_id Part of +/api/hosts/:host_id/parameters+ path
-      # @option params [Object] hostgroup_id Part of +/api/hostgroups/:hostgroup_id/parameters+ path
-      # @option params [Object] operatingsystem_id Part of +/api/operatingsystems/:operatingsystem_id/parameters+ path
+      # @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] location_id  id of location 
+      # @option params [String] operatingsystem_id  id of operating system 
+      # @option params [String] organization_id  id of organization 
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body

data/lib/foreman_api/resources/ptable.rb

@@ -27,11 +27,11 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [Hash] ptable
+      # @option params [Hash, nil] ptable
       #   allowed keys are:
       #   * layout [String]
       #   * name [String]
-      #   * os_family [String]
+      #   * os_family [String, nil]
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body
@@ -41,11 +41,11 @@ module ForemanApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] id
-      # @option params [Hash] ptable
+      # @option params [Hash, nil] ptable
       #   allowed keys are:
       #   * layout [String]
       #   * name [String]
-      #   * os_family [String]
+      #   * os_family [String, nil]
       #
       # @param [Hash] headers additional http headers
       # @return [Array] First item: parsed data; second item: raw body

data/lib/foreman_api/resources/puppetclass.rb

@@ -33,7 +33,7 @@ module ForemanApi
       end
 
       # @param [Hash] params a hash of params to be passed to the service
-      # @option params [Hash] puppetclass
+      # @option params [Hash, nil] puppetclass
       #   allowed keys are:
       #   * name [String]
       #
@@ -45,7 +45,7 @@ module ForemanApi
 
       # @param [Hash] params a hash of params to be passed to the service
       # @option params [String] id
-      # @option params [Hash] puppetclass
+      # @option params [Hash, nil] puppetclass
       #   allowed keys are:
       #   * name [String]
       #