You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.newrelic_deployment module – Notify New Relic about app deployments

Note

This module is part of the community.general collection (version 6.6.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.newrelic_deployment.

Synopsis

• Notify New Relic about app deployments (see https://docs.newrelic.com/docs/apm/new-relic-apm/maintenance/record-monitor-deployments/)

Parameters

Parameter	Comments
app_name string	The value of app_name in the newrelic.yml file used by the application. One of app_name or application_id is required.
application_id string	The application ID found in the metadata of the application in APM. One of app_name or application_id is required.
appname string	Name of the application. This option has been deprecated and will be removed in community.general 7.0.0. Please do not use.
changelog string	A list of changes for this deployment
description string	Text annotation for the deployment - notes for you
environment string	The environment for this deployment. This option has been deprecated and will be removed community.general 7.0.0. Please do not use.
revision string / required	A revision number (e.g., git commit SHA)
token string / required	API token to place in the Api-Key header.
user string	The name of the user/process that triggered this deployment
validate_certs boolean	If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Choices: false true ← (default)

Attributes

Attribute	Support	Description
check_mode	Support: full	Can run in check_mode and return changed status prediction without modifying target.
diff_mode	Support: none	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Examples

- name:  Notify New Relic about an app deployment
  community.general.newrelic_deployment:
    token: AAAAAA
    app_name: myapp
    user: ansible deployment
    revision: '1.0'

Authors

• Matt Coddington (@mcodd)

Collection links

Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication