Added 'version_added' attributes for new fields.
Also added missing fields to documentation and added some more examples.
This commit is contained in:
parent
7c34399630
commit
cd1722b743
1 changed files with 25 additions and 2 deletions
|
@ -39,6 +39,15 @@ options:
|
||||||
default: null
|
default: null
|
||||||
choices: []
|
choices: []
|
||||||
aliases: []
|
aliases: []
|
||||||
|
token:
|
||||||
|
description:
|
||||||
|
- A pagerduty token, generated on the pagerduty site. Can be used instead of
|
||||||
|
user/passwd combination.
|
||||||
|
required: true
|
||||||
|
default: null
|
||||||
|
choices: []
|
||||||
|
aliases: []
|
||||||
|
version_added: '1.6'
|
||||||
requester_id:
|
requester_id:
|
||||||
description:
|
description:
|
||||||
- ID of user making the request. Only needed when using a token and creating a maintenance_window.
|
- ID of user making the request. Only needed when using a token and creating a maintenance_window.
|
||||||
|
@ -46,6 +55,7 @@ options:
|
||||||
default: null
|
default: null
|
||||||
choices: []
|
choices: []
|
||||||
aliases: []
|
aliases: []
|
||||||
|
version_added: '1.6'
|
||||||
service:
|
service:
|
||||||
description:
|
description:
|
||||||
- PagerDuty service ID.
|
- PagerDuty service ID.
|
||||||
|
@ -67,6 +77,7 @@ options:
|
||||||
default: 0
|
default: 0
|
||||||
choices: []
|
choices: []
|
||||||
aliases: []
|
aliases: []
|
||||||
|
version_added: '1.6'
|
||||||
desc:
|
desc:
|
||||||
description:
|
description:
|
||||||
- Short description of maintenance window.
|
- Short description of maintenance window.
|
||||||
|
@ -79,16 +90,28 @@ notes:
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES='''
|
EXAMPLES='''
|
||||||
# List ongoing maintenance windows.
|
# List ongoing maintenance windows using a user/passwd
|
||||||
- pagerduty: name=companyabc user=example@example.com passwd=password123 state=ongoing
|
- pagerduty: name=companyabc user=example@example.com passwd=password123 state=ongoing
|
||||||
|
|
||||||
# Create a 1 hour maintenance window for service FOO123.
|
# List ongoing maintenance windows using a token
|
||||||
|
- pagerduty: name=companyabc token=xxxxxxxxxxxxxx state=ongoing
|
||||||
|
|
||||||
|
# Create a 1 hour maintenance window for service FOO123, using a user/passwd
|
||||||
- pagerduty: name=companyabc
|
- pagerduty: name=companyabc
|
||||||
user=example@example.com
|
user=example@example.com
|
||||||
passwd=password123
|
passwd=password123
|
||||||
state=running
|
state=running
|
||||||
service=FOO123
|
service=FOO123
|
||||||
|
|
||||||
|
# Create a 5 minute maintenance window for service FOO123, using a token
|
||||||
|
- 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".
|
# Create a 4 hour maintenance window for service FOO123 with the description "deployment".
|
||||||
- pagerduty: name=companyabc
|
- pagerduty: name=companyabc
|
||||||
user=example@example.com
|
user=example@example.com
|
||||||
|
|
Loading…
Reference in a new issue