The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
desc | Default: Created by Ansible | Short description of maintenance window. |
hours | Default: 1 | Length of maintenance window in hours. |
minutes (added in 1.8) | Default: 0 | Maintenance window in minutes (this is added to the hours). |
name | PagerDuty unique subdomain. Obsolete. It is not used with PagerDuty REST v2 API. | |
requester_id (added in 1.8) | ID of user making the request. Only needed when creating a maintenance_window. | |
service | A comma separated list of PagerDuty service IDs. aliases: services | |
state required |
| Create a maintenance window or get a list of ongoing windows. |
token required (added in 1.8) | A pagerduty token, generated on the pagerduty site. It is used for authorization. | |
user | PagerDuty user ID. Obsolete. Please, use token for authorization. | |
validate_certs bool (added in 1.5.1) |
| If no , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
window_id (added in 2.7) | ID of maintenance window. Only needed when absent a maintenance_window. |
# List ongoing maintenance windows using a token - pagerduty: name: companyabc token: xxxxxxxxxxxxxx state: ongoing # Create a 1 hour maintenance window for service FOO123 - pagerduty: name: companyabc user: [email protected] token: yourtoken state: running service: FOO123 # Create a 5 minute maintenance window for service FOO123 - pagerduty: name: companyabc token: xxxxxxxxxxxxxx hours: 0 minutes: 5 state: running service: FOO123 # Create a 4 hour maintenance window for service FOO123 with the description "deployment". - pagerduty: name: companyabc user: [email protected] state: running service: FOO123 hours: 4 desc: deployment register: pd_window # Delete the previous maintenance window - pagerduty: name: companyabc user: [email protected] state: absent window_id: '{{ pd_window.result.maintenance_window.id }}'
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/pagerduty_module.html