Resource Type: notify

Open source Puppet documentation

Welcome to Puppet 6 documentation
- Puppet architecture
- Puppet packages and versions
Release notes
- Puppet release notes
- Puppet known issues
- Agent release notes
Getting started with Puppet
- Managing NTP
- Managing DNS
- Managing sudo
- Manage firewall rules
Installing and upgrading
- System requirements
- Using the Puppet platform
- Installing Puppet
- Installing agents
- Upgrading
Configuring Puppet
- Puppet settings
- Key configuration settings
- Puppet's configuration files
- Configuring Puppet Server
- Checking the values of settings
- Editing settings on the command line
- Complete list of settings (configuration reference)
- Settings that differ under Puppet Server
Important directories and files
- Code and data directory (codedir)
- Config directory (confdir)
- Main manifest directory
- The modulepath
- SSL directory (ssldir)
- Cache directory (vardir)
Environments
- About environments
- Creating environments
- Environment isolation
Modules
- Module fundamentals
- Plug-ins in modules
- Module cheat sheet
- Installing and managing modules from the command line
- Beginner's guide to writing modules
- Module metadata
- Documenting modules
- Documenting modules with Puppet Strings
- Puppet Strings style guide
- Publishing modules
- Contributing to Puppet modules
Puppet services and tools
- Puppet commands
- Running Puppet commands on Windows
- Puppet master
  - Puppet Server
- Puppet agent on *nix systems
- Puppet agent on Windows
- Puppet apply
- Puppet device
Puppet Server
- Index
- About Puppet Server
- Release notes
- Deprecated features
- Compatibility with Puppet agent
- Installing Puppet Server
- Configuring Puppet Server
- Differing behavior in puppet.conf
- Using and extending Puppet Server
- Known issues and workarounds
  - Known issues
  - SSL problems with load-balanced PuppetDB servers (“Server Certificate Change” error)
- Administrative API endpoints
  - Environment cache
  - JRuby pool
- CA v1 API
- Server-specific Puppet API endpoints
- Status API endpoints
  - Status services
- Metrics API endpoints
  - v1 metrics
  - v2 (Jolokia) metrics
- Developer information
The Puppet language
- Visual index
- Basics
- The Puppet language style guide
- Handling file paths on Windows
- Variables
- Resources
- Resources (advanced)
- Relationships and ordering
- Classes
- Defined resource types
- Bolt tasks
- Type aliases
- Expressions and operators
- Conditional statements and expressions
- Function calls
- Docs for built-in functions
- Node definitions
- Comments
- Facts and built-in variables
- Reserved words and acceptable names
- Writing functions (Puppet language)
- Custom resources
  - Develop types and providers with the Resource API
  - Resource API reference
  - Low-level method for developing types and providers
    - Type development
    - Provider development
- Values and data types
  - Strings
  - Numbers
  - Booleans
  - Arrays
  - Hashes
  - Regular expressions
  - Sensitive
  - Time-related data types
  - Undef
  - Default
  - Resource and class references
  - Resource types
  - Data type syntax
  - Abstract data types
- Templates
  - Creating templates using Embedded Puppet
  - Creating templates using Embedded Ruby
- Advanced constructs
  - Iteration and loops
  - Lambdas
  - Resource default statements
  - Resource collectors
  - Virtual resources
  - Exported resources
  - Tags
  - Run stages
- Details of complex behaviors
  - Containment of resources
  - Scope
  - Namespaces and autoloading
Writing custom functions
- Custom functions
- Custom Puppet functions
- Writing custom functions in Ruby
- Secrets store integrations and agent-side data retrieval
- Write a Puppet function to store secrets
Hiera
- About Hiera
- Getting started with Hiera
- Configuring Hiera
- Creating and editing data
- Looking up data with Hiera
- Writing new data backends
- Upgrading to Hiera 5
Facter
- Facter release notes
- Core facts
- Custom facts
- Custom facts walkthrough
- External facts
- Configuring Facter with facter.conf
Resource types
- All resource types
- Core types cheat sheet
- Optional resource types for Windows
- exec
- Exec tips and examples for Windows
- file
- File tips and examples for Windows
- filebucket
- group
- User and group tips and examples for Windows
- index
- notify
- package
- Package tips and examples for Windows
- resources
- schedule
- service
- Service tips and examples
- stage
- tidy
- user
- User and group tips and examples for Windows
Reports: Tracking Puppet's activity
- About reporting
- Built-in report processors
- Writing custom report processors
- Puppet::Transaction::Report object format
Extensions for assigning classes to nodes
- External node classifiers
Misc. references (settings, functions, etc.)
- Settings (configuration reference)
- Functions
- Metaparameters
- Built-in report processors
- Ruby API for developing extensions
Man pages
- Index
- Core tools
- Occasionally useful
- Niche
HTTP API
- Index
- PSON
- Puppet v3 API
- CA v1 API
- Schemas (JSON)
Certificate authority and SSL
- Puppet Server CA commands
- Intermediate CA
- Autosigning certificate requests
- CSR attributes and certificate extensions
- Regenerating certificates in a Puppet deployment
- External CA
- External SSL termination with Puppet Server
Adding file server mount points
Puppet's internals
- Agent-master HTTPS communications
- Catalog compilation
Experimental features
- Msgpack support

Expand menu Collapse menu

notify
1. Description
2. Attributes

NOTE: This page was generated from the Puppet source code on 2018-12-20 09:14:50 -0800

notify

Attributes

Description

Sends an arbitrary message to the agent run-time log.

Attributes

notify { 'resource title':
  name     => # (namevar) An arbitrary tag for your own reference; the...
  message  => # The message to be sent to the...
  withpath => # Whether to show the full object path.  Default...
  # ...plus any applicable metaparameters.
}

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)

message

(Property: This attribute represents concrete state on the target system.)

The message to be sent to the log.

(↑ Back to notify attributes)

withpath

Whether to show the full object path.

Default: false

Allowed values:

true
false

(↑ Back to notify attributes)

NOTE: This page was generated from the Puppet source code on 2018-12-20 09:14:50 -0800