modules: fix examples to use FQCN (#644)

* modules: fix examples to use FQCN

* fix

* fix

* fix
This commit is contained in:
Andrew Klychkov 2020-07-13 22:50:31 +03:00 committed by GitHub
commit 41cfdda6a3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
533 changed files with 2130 additions and 2130 deletions

View file

@ -81,7 +81,7 @@ requirements: []
EXAMPLES = '''
- name: Notify airbrake about an app deployment
airbrake_deployment:
community.general.airbrake_deployment:
project_id: '12345'
project_key: 'AAAAAA'
environment: staging
@ -89,7 +89,7 @@ EXAMPLES = '''
revision: '4.2'
- name: Notify airbrake about an app deployment, using git hash as revision
airbrake_deployment:
community.general.airbrake_deployment:
project_id: '12345'
project_key: 'AAAAAA'
environment: staging

View file

@ -76,14 +76,14 @@ requirements: [ ]
EXAMPLES = '''
- name: Notify BigPanda about a deployment
bigpanda:
community.general.bigpanda:
component: myapp
version: '1.3'
token: '{{ bigpanda_token }}'
state: started
- name: Notify BigPanda about a deployment
bigpanda:
community.general.bigpanda:
component: myapp
version: '1.3'
token: '{{ bigpanda_token }}'
@ -91,7 +91,7 @@ EXAMPLES = '''
# If outside servers aren't reachable from your machine, use delegate_to and override hosts:
- name: Notify BigPanda about a deployment
bigpanda:
community.general.bigpanda:
component: myapp
version: '1.3'
token: '{{ bigpanda_token }}'
@ -101,7 +101,7 @@ EXAMPLES = '''
register: deployment
- name: Notify BigPanda about a deployment
bigpanda:
community.general.bigpanda:
component: '{{ deployment.component }}'
version: '{{ deployment.version }}'
token: '{{ deployment.token }}'

View file

@ -51,14 +51,14 @@ options:
'''
EXAMPLES = '''
- name: Create a simple annotation event with a source, defaults to start and end time of now
circonus_annotation:
community.general.circonus_annotation:
api_key: XXXXXXXXXXXXXXXXX
title: App Config Change
description: This is a detailed description of the config change
category: This category groups like annotations
- name: Create an annotation with a duration of 5 minutes and a default start time of now
circonus_annotation:
community.general.circonus_annotation:
api_key: XXXXXXXXXXXXXXXXX
title: App Config Change
description: This is a detailed description of the config change
@ -66,7 +66,7 @@ EXAMPLES = '''
duration: 300
- name: Create an annotation with a start_time and end_time
circonus_annotation:
community.general.circonus_annotation:
api_key: XXXXXXXXXXXXXXXXX
title: App Config Change
description: This is a detailed description of the config change

View file

@ -65,7 +65,7 @@ options:
EXAMPLES = '''
- name: Post an event with low priority
datadog_event:
community.general.datadog_event:
title: Testing from ansible
text: Test
priority: low
@ -73,7 +73,7 @@ EXAMPLES = '''
app_key: j4JyCYfefWHhgFgiZUqRm63AXHNZQyPGBfJtAzmN
- name: Post an event with several tags
datadog_event:
community.general.datadog_event:
title: Testing from ansible
text: Test
api_key: 9775a026f1ca7d1c6c5af9d94d9595a4

View file

@ -139,7 +139,7 @@ options:
EXAMPLES = '''
- name: Create a metric monitor
datadog_monitor:
community.general.datadog_monitor:
type: "metric alert"
name: "Test monitor"
state: "present"
@ -149,14 +149,14 @@ EXAMPLES = '''
app_key: "87ce4a24b5553d2e482ea8a8500e71b8ad4554ff"
- name: Deletes a monitor
datadog_monitor:
community.general.datadog_monitor:
name: "Test monitor"
state: "absent"
api_key: "9775a026f1ca7d1c6c5af9d94d9595a4"
app_key: "87ce4a24b5553d2e482ea8a8500e71b8ad4554ff"
- name: Mutes a monitor
datadog_monitor:
community.general.datadog_monitor:
name: "Test monitor"
state: "mute"
silenced: '{"*":None}'
@ -164,14 +164,14 @@ EXAMPLES = '''
app_key: "87ce4a24b5553d2e482ea8a8500e71b8ad4554ff"
- name: Unmutes a monitor
datadog_monitor:
community.general.datadog_monitor:
name: "Test monitor"
state: "unmute"
api_key: "9775a026f1ca7d1c6c5af9d94d9595a4"
app_key: "87ce4a24b5553d2e482ea8a8500e71b8ad4554ff"
- name: Use datadoghq.eu platform instead of datadoghq.com
datadog_monitor:
community.general.datadog_monitor:
name: "Test monitor"
state: "absent"
api_host: https://api.datadoghq.eu

View file

@ -47,7 +47,7 @@ options:
EXAMPLES = '''
- name: Notify Honeybadger.io about an app deployment
honeybadger_deployment:
community.general.honeybadger_deployment:
token: AAAAAA
environment: staging
user: ansible

View file

@ -37,12 +37,12 @@ options:
EXAMPLES = '''
- name: Enable ido-pgsql feature
icinga2_feature:
community.general.icinga2_feature:
name: ido-pgsql
state: present
- name: Disable api feature
icinga2_feature:
community.general.icinga2_feature:
name: api
state: absent
'''

View file

@ -95,7 +95,7 @@ options:
EXAMPLES = '''
- name: Add host to icinga
icinga2_host:
community.general.icinga2_host:
url: "https://icinga2.example.com"
url_username: "ansible"
url_password: "a_secret"

View file

@ -61,7 +61,7 @@ options:
EXAMPLES = '''
- name: Create a simple annotation event with a source
librato_annotation:
community.general.librato_annotation:
user: user@example.com
api_key: XXXXXXXXXXXXXXXXX
title: App Config Change
@ -69,7 +69,7 @@ EXAMPLES = '''
description: This is a detailed description of the config change
- name: Create an annotation that includes a link
librato_annotation:
community.general.librato_annotation:
user: user@example.com
api_key: XXXXXXXXXXXXXXXXXX
name: code.deploy
@ -80,7 +80,7 @@ EXAMPLES = '''
href: http://www.example.com/deploy
- name: Create an annotation with a start_time and end_time
librato_annotation:
community.general.librato_annotation:
user: user@example.com
api_key: XXXXXXXXXXXXXXXXXX
name: maintenance

View file

@ -40,13 +40,13 @@ notes:
'''
EXAMPLES = '''
- name: Track nginx logs
logentries:
community.general.logentries:
path: /var/log/nginx/access.log
state: present
name: nginx-access-log
- name: Stop tracking nginx logs
logentries:
community.general.logentries:
path: /var/log/nginx/error.log
state: absent
'''

View file

@ -42,23 +42,23 @@ options:
EXAMPLES = '''
- name: Install Logstash beats input plugin
logstash_plugin:
community.general.logstash_plugin:
state: present
name: logstash-input-beats
- name: Install specific version of a plugin
logstash_plugin:
community.general.logstash_plugin:
state: present
name: logstash-input-syslog
version: '3.2.0'
- name: Uninstall Logstash plugin
logstash_plugin:
community.general.logstash_plugin:
state: absent
name: logstash-filter-multiline
- name: Install Logstash plugin with alternate heap size
logstash_plugin:
community.general.logstash_plugin:
state: present
name: logstash-input-beats
environment:

View file

@ -35,7 +35,7 @@ author: "Darryl Stoflet (@dstoflet)"
EXAMPLES = '''
- name: Manage the state of program httpd to be in started state
monit:
community.general.monit:
name: httpd
state: started
'''

View file

@ -87,21 +87,21 @@ author: "Tim Bielawa (@tbielawa)"
EXAMPLES = '''
- name: Set 30 minutes of apache downtime
nagios:
community.general.nagios:
action: downtime
minutes: 30
service: httpd
host: '{{ inventory_hostname }}'
- name: Schedule an hour of HOST downtime
nagios:
community.general.nagios:
action: downtime
minutes: 60
service: host
host: '{{ inventory_hostname }}'
- name: Schedule an hour of HOST downtime starting at 2019-04-23T02:00:00+00:00
nagios:
community.general.nagios:
action: downtime
start: 1555984800
minutes: 60
@ -109,7 +109,7 @@ EXAMPLES = '''
host: '{{ inventory_hostname }}'
- name: Schedule an hour of HOST downtime, with a comment describing the reason
nagios:
community.general.nagios:
action: downtime
minutes: 60
service: host
@ -117,83 +117,83 @@ EXAMPLES = '''
comment: Rebuilding machine
- name: Schedule downtime for ALL services on HOST
nagios:
community.general.nagios:
action: downtime
minutes: 45
service: all
host: '{{ inventory_hostname }}'
- name: Schedule downtime for a few services
nagios:
community.general.nagios:
action: downtime
services: frob,foobar,qeuz
host: '{{ inventory_hostname }}'
- name: Set 30 minutes downtime for all services in servicegroup foo
nagios:
community.general.nagios:
action: servicegroup_service_downtime
minutes: 30
servicegroup: foo
host: '{{ inventory_hostname }}'
- name: Set 30 minutes downtime for all host in servicegroup foo
nagios:
community.general.nagios:
action: servicegroup_host_downtime
minutes: 30
servicegroup: foo
host: '{{ inventory_hostname }}'
- name: Delete all downtime for a given host
nagios:
community.general.nagios:
action: delete_downtime
host: '{{ inventory_hostname }}'
service: all
- name: Delete all downtime for HOST with a particular comment
nagios:
community.general.nagios:
action: delete_downtime
host: '{{ inventory_hostname }}'
service: host
comment: Planned maintenance
- name: Enable SMART disk alerts
nagios:
community.general.nagios:
action: enable_alerts
service: smart
host: '{{ inventory_hostname }}'
- name: Disable httpd and nfs alerts
nagios:
community.general.nagios:
action: disable_alerts
service: httpd,nfs
host: '{{ inventory_hostname }}'
- name: Disable HOST alerts
nagios:
community.general.nagios:
action: disable_alerts
service: host
host: '{{ inventory_hostname }}'
- name: Silence ALL alerts
nagios:
community.general.nagios:
action: silence
host: '{{ inventory_hostname }}'
- name: Unsilence all alerts
nagios:
community.general.nagios:
action: unsilence
host: '{{ inventory_hostname }}'
- name: Shut up nagios
nagios:
community.general.nagios:
action: silence_nagios
- name: Annoy me negios
nagios:
community.general.nagios:
action: unsilence_nagios
- name: Command something
nagios:
community.general.nagios:
action: command
command: DISABLE_FAILURE_PREDICTION
'''

View file

@ -65,7 +65,7 @@ requirements: []
EXAMPLES = '''
- name: Notify newrelic about an app deployment
newrelic_deployment:
community.general.newrelic_deployment:
token: AAAAAA
app_name: myapp
user: ansible deployment

View file

@ -69,13 +69,13 @@ options:
EXAMPLES = '''
- name: List ongoing maintenance windows using a token
pagerduty:
community.general.pagerduty:
name: companyabc
token: xxxxxxxxxxxxxx
state: ongoing
- name: Create a 1 hour maintenance window for service FOO123
pagerduty:
community.general.pagerduty:
name: companyabc
user: example@example.com
token: yourtoken
@ -83,7 +83,7 @@ EXAMPLES = '''
service: FOO123
- name: Create a 5 minute maintenance window for service FOO123
pagerduty:
community.general.pagerduty:
name: companyabc
token: xxxxxxxxxxxxxx
hours: 0
@ -93,7 +93,7 @@ EXAMPLES = '''
- name: Create a 4 hour maintenance window for service FOO123 with the description "deployment"
pagerduty:
community.general.pagerduty:
name: companyabc
user: example@example.com
state: running
@ -103,7 +103,7 @@ EXAMPLES = '''
register: pd_window
- name: Delete the previous maintenance window
pagerduty:
community.general.pagerduty:
name: companyabc
user: example@example.com
state: absent
@ -112,14 +112,14 @@ EXAMPLES = '''
# Delete a maintenance window from a separate playbook than its creation,
# and if it is the only existing maintenance window
- name: Check
pagerduty:
community.general.pagerduty:
requester_id: XXXXXXX
token: yourtoken
state: ongoing
register: pd_window
- name: Delete
pagerduty:
community.general.pagerduty:
requester_id: XXXXXXX
token: yourtoken
state: absent

View file

@ -74,7 +74,7 @@ options:
EXAMPLES = '''
- name: Trigger an incident with just the basic options
pagerduty_alert:
community.general.pagerduty_alert:
name: companyabc
integration_key: xxx
api_key: yourapikey
@ -83,7 +83,7 @@ EXAMPLES = '''
desc: problem that led to this trigger
- name: Trigger an incident with more options
pagerduty_alert:
community.general.pagerduty_alert:
integration_key: xxx
api_key: yourapikey
service_id: PDservice
@ -94,7 +94,7 @@ EXAMPLES = '''
client_url: http://service.example.com
- name: Acknowledge an incident based on incident_key
pagerduty_alert:
community.general.pagerduty_alert:
integration_key: xxx
api_key: yourapikey
service_id: PDservice
@ -103,7 +103,7 @@ EXAMPLES = '''
desc: "some text for incident's log"
- name: Resolve an incident based on incident_key
pagerduty_alert:
community.general.pagerduty_alert:
integration_key: xxx
api_key: yourapikey
service_id: PDservice

View file

@ -46,7 +46,7 @@ notes:
EXAMPLES = '''
- name: Pause the check with the ID of 12345
pingdom:
community.general.pingdom:
uid: example@example.com
passwd: password123
key: apipassword123
@ -54,7 +54,7 @@ EXAMPLES = '''
state: paused
- name: Unpause the check with the ID of 12345
pingdom:
community.general.pingdom:
uid: example@example.com
passwd: password123
key: apipassword123

View file

@ -58,7 +58,7 @@ options:
EXAMPLES = '''
- name: Rollbar deployment notification
rollbar_deployment:
community.general.rollbar_deployment:
token: AAAAAA
environment: staging
user: ansible
@ -67,7 +67,7 @@ EXAMPLES = '''
comment: Test Deploy
- name: Notify rollbar about current git revision deployment by current user
rollbar_deployment:
community.general.rollbar_deployment:
token: "{{ rollbar_access_token }}"
environment: production
revision: "{{ lookup('pipe', 'git rev-parse HEAD') }}"

View file

@ -130,7 +130,7 @@ EXAMPLES = '''
# Fetch metrics about the CPU load every 60 seconds,
# the sensu server has a handler called 'relay' which forwards stats to graphite
- name: Get cpu metrics
sensu_check:
community.general.sensu_check:
name: cpu_load
command: /etc/sensu/plugins/system/cpu-mpstat-metrics.rb
metric: yes
@ -140,7 +140,7 @@ EXAMPLES = '''
# Check whether nginx is running
- name: Check nginx process
sensu_check:
community.general.sensu_check:
name: nginx_running
command: /etc/sensu/plugins/processes/check-procs.rb -f /var/run/nginx.pid
handlers: default
@ -151,7 +151,7 @@ EXAMPLES = '''
# Note that the check will still show up in the sensu dashboard,
# to remove it completely you need to issue a DELETE request to the sensu api.
- name: Check disk
sensu_check:
community.general.sensu_check:
name: check_disk_capacity
state: absent
'''

View file

@ -83,13 +83,13 @@ notes:
EXAMPLES = '''
# Minimum possible configuration
- name: Configure Sensu client
sensu_client:
community.general.sensu_client:
subscriptions:
- default
# With customization
- name: Configure Sensu client
sensu_client:
community.general.sensu_client:
name: "{{ ansible_fqdn }}"
address: "{{ ansible_default_ipv4['address'] }}"
subscriptions:
@ -121,7 +121,7 @@ EXAMPLES = '''
mode: "0600"
- name: Delete the Sensu client configuration
sensu_client:
community.general.sensu_client:
state: "absent"
'''

View file

@ -84,7 +84,7 @@ notes:
EXAMPLES = '''
# Configure a handler that sends event data as STDIN (pipe)
- name: Configure IRC Sensu handler
sensu_handler:
community.general.sensu_handler:
name: "irc_handler"
type: "pipe"
command: "/usr/local/bin/notify-irc.sh"
@ -100,13 +100,13 @@ EXAMPLES = '''
# Delete a handler
- name: Delete IRC Sensu handler
sensu_handler:
community.general.sensu_handler:
name: "irc_handler"
state: "absent"
# Example of a TCP handler
- name: Configure TCP Sensu handler
sensu_handler:
community.general.sensu_handler:
name: "tcp_handler"
type: "tcp"
timeout: 30

View file

@ -59,14 +59,14 @@ options:
EXAMPLES = '''
# Silence ALL checks for a given client
- name: Silence server1.example.dev
sensu_silence:
community.general.sensu_silence:
subscription: client:server1.example.dev
creator: "{{ ansible_user_id }}"
reason: Performing maintenance
# Silence specific check for a client
- name: Silence CPU_Usage check for server1.example.dev
sensu_silence:
community.general.sensu_silence:
subscription: client:server1.example.dev
check: CPU_Usage
creator: "{{ ansible_user_id }}"
@ -80,7 +80,7 @@ EXAMPLES = '''
reason: 'Deployment in progress'
- name: Silence several clients from a dict
sensu_silence:
community.general.sensu_silence:
subscription: "client:{{ item.key }}"
reason: "{{ item.value.reason }}"
creator: "{{ ansible_user_id }}"

View file

@ -52,11 +52,11 @@ reasons:
EXAMPLES = '''
# Subscribe to the nginx channel
- name: Subscribe to nginx checks
sensu_subscription: name=nginx
community.general.sensu_subscription: name=nginx
# Unsubscribe from the common checks channel
- name: Unsubscribe from common checks
sensu_subscription: name=common state=absent
community.general.sensu_subscription: name=common state=absent
'''
import json

View file

@ -58,7 +58,7 @@ options:
EXAMPLES = '''
- name: Send a code deploy event to stackdriver
stackdriver:
community.general.stackdriver:
key: AAAAAA
event: deploy
deployed_to: production
@ -67,7 +67,7 @@ EXAMPLES = '''
revision_id: abcd123
- name: Send an annotation event to stackdriver
stackdriver:
community.general.stackdriver:
key: AAAAAA
event: annotation
msg: Greetings from Ansible

View file

@ -108,7 +108,7 @@ options:
EXAMPLES = '''
- name: Create a maintenance window for 10 minutes on server1, with automation to stop the maintenance
statusio_maintenance:
community.general.statusio_maintenance:
title: Router Upgrade from ansible
desc: Performing a Router Upgrade
components: server1.example.com
@ -119,7 +119,7 @@ EXAMPLES = '''
automation: True
- name: Create a maintenance window for 60 minutes on server1 and server2
statusio_maintenance:
community.general.statusio_maintenance:
title: Routine maintenance
desc: Some security updates
components:
@ -134,7 +134,7 @@ EXAMPLES = '''
delegate_to: localhost
- name: Create a future maintenance window for 24 hours to all hosts inside the Primary Data Center
statusio_maintenance:
community.general.statusio_maintenance:
title: Data center downtime
desc: Performing a Upgrade to our data center
components: Primary Data Center
@ -146,7 +146,7 @@ EXAMPLES = '''
minutes: 1440
- name: Delete a maintenance window
statusio_maintenance:
community.general.statusio_maintenance:
title: Remove a maintenance window
maintenance_id: 561f90faf74bc94a4700087b
statuspage: statuspage_id

View file

@ -36,13 +36,13 @@ notes:
EXAMPLES = '''
- name: Pause the monitor with an ID of 12345
uptimerobot:
community.general.uptimerobot:
monitorid: 12345
apikey: 12345-1234512345
state: paused
- name: Start the monitor with an ID of 12345
uptimerobot:
community.general.uptimerobot:
monitorid: 12345
apikey: 12345-1234512345
state: started