REFERENCE.md

Reference

Table of Contents

Resource types

• shellvar: Manages variables in simple shell scripts.

Resource types

shellvar

Manages variables in simple shell scripts.

Properties

The following properties are available in the shellvar type.

comment

Text to be stored in a comment immediately above the entry. It will be automatically prepended with the name of the variable in order for the provider to know whether it controls the comment or not.

ensure

Valid values: present, absent, unset, exported

Create or remove the shellvar entry

Default value: present

value

Value to change the variable to.

Parameters

The following parameters are available in the shellvar type.

• array_append
• array_type
• name
• provider
• quoted
• target
• uncomment
• variable

array_append

Valid values: false, true

Whether to add to existing array values or replace all values.

Default value: false

array_type

Valid values: auto, string, array

Type of array mapping to use, defaults to auto.

• auto will detect the current type, and default to string
• string will render the array as a string and use space-separated values
• array will render the array as a shell array

Default value: auto

name

namevar

The default namevar

provider

The specific backend to use for this shellvar resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

quoted

Valid values: auto, double, single, none, false, true

Quoting method to use, defaults to auto.

• auto will quote only if necessary, leaving existing quotes as-is
• double and single will always quotes
• none will remove quotes, which may result in save failures

Default value: auto

target

namevar

The file in which to store the variable.

uncomment

Valid values: true, false

Whether to remove commented value when found.

Default value: false

variable

namevar

The name of the variable, e.g. OPTIONS