Puppet::Parser::Functions.newfunction(:getparam,
:type => :rvalue,
:doc => <<-'DOC'
+ @summary
+ Returns the value of a resource's parameter.
+
+ @return
+ value of a resource's parameter.
+
Takes a resource reference and name of the parameter and
returns value of resource's parameter. Note that user defined
resource types are evaluated lazily.
- *Examples:*
+ @example Example Usage:
- # define a resource type with a parameter
- define example_resource($param) {
- }
+ # define a resource type with a parameter
+ define example_resource($param) {
+ }
- # declare an instance of that type
- example_resource { "example_resource_instance":
- param => "'the value we are getting in this example''"
- }
+ # declare an instance of that type
+ example_resource { "example_resource_instance":
+ param => "'the value we are getting in this example''"
+ }
- # Because of order of evaluation, a second definition is needed
- # that will be evaluated after the first resource has been declared
- #
- define example_get_param {
- # This will notice the value of the parameter
- notice(getparam(Example_resource["example_resource_instance"], "param"))
- }
+ # Because of order of evaluation, a second definition is needed
+ # that will be evaluated after the first resource has been declared
+ #
+ define example_get_param {
+ # This will notice the value of the parameter
+ notice(getparam(Example_resource["example_resource_instance"], "param"))
+ }
- # Declare an instance of the second resource type - this will call notice
- example_get_param { 'show_notify': }
+ # Declare an instance of the second resource type - this will call notice
+ example_get_param { 'show_notify': }
Would notice: 'the value we are getting in this example'
- Note that since Puppet 4.0.0 it is possible to get a parameter value by using its data type
+ > **Note** that since Puppet 4.0.0 it is possible to get a parameter value by using its data type
and the [ ] operator. The example below is equivalent to a call to getparam():
-
- Example_resource['example_resource_instance']['param']
+ ```Example_resource['example_resource_instance']['param']``
DOC
) do |vals|