Method: Puppet::Type.newparam

Defined in:
lib/puppet/type.rb

.newparam(name, options = {}) {|| ... } ⇒ Class<inherits Puppet::Parameter>

Creates a new parameter.

Parameters:

  • name (Symbol) —

    the name of the parameter

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

    a hash with options.

Options Hash (options):

  • :parent (Class<inherits Puppet::Parameter>) — default: Puppet::Parameter —

    the super class of this parameter

  • :attributes (Hash{String => Object}) —

    a hash that is applied to the generated class by calling setter methods corresponding to this hash’s keys/value pairs. This is done before the given block is evaluated.

  • :boolean (Boolean) — default: false —

    specifies if this is a boolean parameter

  • :namevar (Boolean) — default: false —

    specifies if this parameter is the namevar

  • :required_features (Symbol, Array<Symbol>) —

    specifies required provider features by name

Yields:

  • () —

    a required block that is evaluated in the scope of the new parameter

Returns:



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/puppet/type.rb', line 456

def self.newparam(name, options = {}, &block)
  options[:attributes] ||= {}

  param = genclass(
    name,
    :parent     => options[:parent] || Puppet::Parameter,
    :attributes => options[:attributes],
    :block      => block,
    :prefix     => "Parameter",
    :array      => @parameters,
    :hash       => @paramhash
  )

  handle_param_options(name, options)

  # Grr.
  param.required_features = options[:required_features] if options[:required_features]

  param.isnamevar if options[:namevar]

  param
end