Error data type

Sections

An Error object contains a non-empty message. It can also contain additional context about why the error occurred.

Parameters

The full signature for Error is:
Error[<MESSAGE>, <KIND>, <DETAILS>, <ISSUE CODE>]

The following table shows the available parameters. Note that the message parameter is required and the others are optional.

Position Parameter Data type Default value Description
1 Message String[1] The error message of length greater than 0.
2 Kind Optional[String[1]] undef The kind or category of error.
3 Details Optional[Hash[String[1],Data]] undef Additional details about the error.
4 Issue code Optional[String[1]] undef A unique code identifying the issue which can be used to translate error messages into different locales.

Accessing values

The Error object implements methods for retrieving additional information. For example:
notice($err.msg)
notice($err.kind)
notice($err.issue_code)
notice($err.details)
How helpful was this page?

If you leave us your email, we may contact you regarding your feedback. For more information on how Puppet uses your personal information, see our privacy policy.

Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.