1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
---
layout: default
built_from_commit: 942adce0b1b70f696b0f09d7109ded7559f0fa33
title: 'Resource Type: notify'
canonical: "/puppet/latest/types/notify.html"
---
# Resource Type: notify
> **NOTE:** This page was generated from the Puppet source code on 2024-08-28 16:45:59 -0700
## notify
* [Attributes](#notify-attributes)
### Description {#notify-description}
Sends an arbitrary message, specified as a string, to the agent run-time log. It's important to note that the notify resource type is not idempotent. As a result, notifications are shown as a change on every Puppet run.
### Attributes {#notify-attributes}
<pre><code>notify { 'resource title':
<a href="#notify-attribute-name">name</a> => <em># <strong>(namevar)</strong> An arbitrary tag for your own reference; the...</em>
<a href="#notify-attribute-message">message</a> => <em># The message to be sent to the log. Note that the </em>
<a href="#notify-attribute-withpath">withpath</a> => <em># Whether to show the full object path. Default...</em>
# ...plus any applicable <a href="https://puppet.com/docs/puppet/latest/metaparameter.html">metaparameters</a>.
}</code></pre>
#### name {#notify-attribute-name}
_(**Namevar:** If omitted, this attribute's value defaults to the resource's title.)_
An arbitrary tag for your own reference; the name of the message.
([↑ Back to notify attributes](#notify-attributes))
#### message {#notify-attribute-message}
_(**Property:** This attribute represents concrete state on the target system.)_
The message to be sent to the log. Note that the value specified must be a string.
([↑ Back to notify attributes](#notify-attributes))
#### withpath {#notify-attribute-withpath}
Whether to show the full object path.
Default: `false`
Allowed values:
* `true`
* `false`
([↑ Back to notify attributes](#notify-attributes))
|
