mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-04-12 15:05:07 +00:00
modules: fix examples to use FQCN (#644)
* modules: fix examples to use FQCN * fix * fix * fix
This commit is contained in:
parent
8b92e0454d
commit
41cfdda6a3
533 changed files with 2130 additions and 2130 deletions
|
|
@ -55,23 +55,23 @@ options:
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Get all current balancer pool members attributes
|
||||
apache2_mod_proxy:
|
||||
community.general.apache2_mod_proxy:
|
||||
balancer_vhost: 10.0.0.2
|
||||
|
||||
- name: Get a specific member attributes
|
||||
apache2_mod_proxy:
|
||||
community.general.apache2_mod_proxy:
|
||||
balancer_vhost: myws.mydomain.org
|
||||
balancer_suffix: /lb/
|
||||
member_host: node1.myws.mydomain.org
|
||||
|
||||
# Enable all balancer pool members:
|
||||
- name: Get attributes
|
||||
apache2_mod_proxy:
|
||||
community.general.apache2_mod_proxy:
|
||||
balancer_vhost: '{{ myloadbalancer_host }}'
|
||||
register: result
|
||||
|
||||
- name: Enable all balancer pool members
|
||||
apache2_mod_proxy:
|
||||
community.general.apache2_mod_proxy:
|
||||
balancer_vhost: '{{ myloadbalancer_host }}'
|
||||
member_host: '{{ item.host }}'
|
||||
state: present
|
||||
|
|
@ -79,7 +79,7 @@ EXAMPLES = '''
|
|||
|
||||
# Gracefully disable a member from a loadbalancer node:
|
||||
- name: Step 1
|
||||
apache2_mod_proxy:
|
||||
community.general.apache2_mod_proxy:
|
||||
balancer_vhost: '{{ vhost_host }}'
|
||||
member_host: '{{ member.host }}'
|
||||
state: drained
|
||||
|
|
@ -93,7 +93,7 @@ EXAMPLES = '''
|
|||
delegate_to: myloadbalancernode
|
||||
|
||||
- name: Step 3
|
||||
apache2_mod_proxy:
|
||||
community.general.apache2_mod_proxy:
|
||||
balancer_vhost: '{{ vhost_host }}'
|
||||
member_host: '{{ member.host }}'
|
||||
state: absent
|
||||
|
|
|
|||
|
|
@ -50,29 +50,29 @@ requirements: ["a2enmod","a2dismod"]
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Enable the Apache2 module wsgi
|
||||
apache2_module:
|
||||
community.general.apache2_module:
|
||||
state: present
|
||||
name: wsgi
|
||||
|
||||
- name: Disables the Apache2 module wsgi
|
||||
apache2_module:
|
||||
community.general.apache2_module:
|
||||
state: absent
|
||||
name: wsgi
|
||||
|
||||
- name: Disable default modules for Debian
|
||||
apache2_module:
|
||||
community.general.apache2_module:
|
||||
state: absent
|
||||
name: autoindex
|
||||
force: True
|
||||
|
||||
- name: Disable mpm_worker and ignore warnings about missing mpm module
|
||||
apache2_module:
|
||||
community.general.apache2_module:
|
||||
state: absent
|
||||
name: mpm_worker
|
||||
ignore_configcheck: True
|
||||
|
||||
- name: Enable dump_io module, which is identified as dumpio_module inside apache2
|
||||
apache2_module:
|
||||
community.general.apache2_module:
|
||||
state: present
|
||||
name: dump_io
|
||||
identifier: dumpio_module
|
||||
|
|
|
|||
|
|
@ -145,7 +145,7 @@ EXAMPLES = '''
|
|||
|
||||
# Typical usage
|
||||
- name: Initialize the deploy root and gather facts
|
||||
deploy_helper:
|
||||
community.general.deploy_helper:
|
||||
path: /path/to/root
|
||||
- name: Clone the project to the new release folder
|
||||
git:
|
||||
|
|
@ -178,83 +178,83 @@ EXAMPLES = '''
|
|||
- path: web/uploads
|
||||
src: uploads
|
||||
- name: Finalize the deploy, removing the unfinished file and switching the symlink
|
||||
deploy_helper:
|
||||
community.general.deploy_helper:
|
||||
path: /path/to/root
|
||||
release: '{{ deploy_helper.new_release }}'
|
||||
state: finalize
|
||||
|
||||
# Retrieving facts before running a deploy
|
||||
- name: Run 'state=query' to gather facts without changing anything
|
||||
deploy_helper:
|
||||
community.general.deploy_helper:
|
||||
path: /path/to/root
|
||||
state: query
|
||||
# Remember to set the 'release' parameter when you actually call 'state=present' later
|
||||
- name: Initialize the deploy root
|
||||
deploy_helper:
|
||||
community.general.deploy_helper:
|
||||
path: /path/to/root
|
||||
release: '{{ deploy_helper.new_release }}'
|
||||
state: present
|
||||
|
||||
# all paths can be absolute or relative (to the 'path' parameter)
|
||||
- deploy_helper:
|
||||
- community.general.deploy_helper:
|
||||
path: /path/to/root
|
||||
releases_path: /var/www/project/releases
|
||||
shared_path: /var/www/shared
|
||||
current_path: /var/www/active
|
||||
|
||||
# Using your own naming strategy for releases (a version tag in this case):
|
||||
- deploy_helper:
|
||||
- community.general.deploy_helper:
|
||||
path: /path/to/root
|
||||
release: v1.1.1
|
||||
state: present
|
||||
- deploy_helper:
|
||||
- community.general.deploy_helper:
|
||||
path: /path/to/root
|
||||
release: '{{ deploy_helper.new_release }}'
|
||||
state: finalize
|
||||
|
||||
# Using a different unfinished_filename:
|
||||
- deploy_helper:
|
||||
- community.general.deploy_helper:
|
||||
path: /path/to/root
|
||||
unfinished_filename: README.md
|
||||
release: '{{ deploy_helper.new_release }}'
|
||||
state: finalize
|
||||
|
||||
# Postponing the cleanup of older builds:
|
||||
- deploy_helper:
|
||||
- community.general.deploy_helper:
|
||||
path: /path/to/root
|
||||
release: '{{ deploy_helper.new_release }}'
|
||||
state: finalize
|
||||
clean: False
|
||||
- deploy_helper:
|
||||
- community.general.deploy_helper:
|
||||
path: /path/to/root
|
||||
state: clean
|
||||
# Or running the cleanup ahead of the new deploy
|
||||
- deploy_helper:
|
||||
- community.general.deploy_helper:
|
||||
path: /path/to/root
|
||||
state: clean
|
||||
- deploy_helper:
|
||||
- community.general.deploy_helper:
|
||||
path: /path/to/root
|
||||
state: present
|
||||
|
||||
# Keeping more old releases:
|
||||
- deploy_helper:
|
||||
- community.general.deploy_helper:
|
||||
path: /path/to/root
|
||||
release: '{{ deploy_helper.new_release }}'
|
||||
state: finalize
|
||||
keep_releases: 10
|
||||
# Or, if you use 'clean=false' on finalize:
|
||||
- deploy_helper:
|
||||
- community.general.deploy_helper:
|
||||
path: /path/to/root
|
||||
state: clean
|
||||
keep_releases: 10
|
||||
|
||||
# Removing the entire project root folder
|
||||
- deploy_helper:
|
||||
- community.general.deploy_helper:
|
||||
path: /path/to/root
|
||||
state: absent
|
||||
|
||||
# Debugging the facts returned by the module
|
||||
- deploy_helper:
|
||||
- community.general.deploy_helper:
|
||||
path: /path/to/root
|
||||
- debug:
|
||||
var: deploy_helper
|
||||
|
|
|
|||
|
|
@ -98,18 +98,18 @@ author: "Scott Anderson (@tastychutney)"
|
|||
|
||||
EXAMPLES = """
|
||||
- name: Run cleanup on the application installed in django_dir
|
||||
django_manage:
|
||||
community.general.django_manage:
|
||||
command: cleanup
|
||||
app_path: "{{ django_dir }}"
|
||||
|
||||
- name: Load the initial_data fixture into the application
|
||||
django_manage:
|
||||
community.general.django_manage:
|
||||
command: loaddata
|
||||
app_path: "{{ django_dir }}"
|
||||
fixtures: "{{ initial_data }}"
|
||||
|
||||
- name: Run syncdb on the application
|
||||
django_manage:
|
||||
community.general.django_manage:
|
||||
command: syncdb
|
||||
app_path: "{{ django_dir }}"
|
||||
settings: "{{ settings_app_name }}"
|
||||
|
|
@ -117,13 +117,13 @@ EXAMPLES = """
|
|||
virtualenv: "{{ virtualenv_dir }}"
|
||||
|
||||
- name: Run the SmokeTest test case from the main app. Useful for testing deploys
|
||||
django_manage:
|
||||
community.general.django_manage:
|
||||
command: test
|
||||
app_path: "{{ django_dir }}"
|
||||
apps: main.SmokeTest
|
||||
|
||||
- name: Create an initial superuser
|
||||
django_manage:
|
||||
community.general.django_manage:
|
||||
command: "createsuperuser --noinput --username=admin --email=admin@example.com"
|
||||
app_path: "{{ django_dir }}"
|
||||
"""
|
||||
|
|
|
|||
|
|
@ -51,13 +51,13 @@ EXAMPLES = '''
|
|||
# Example playbook entries using the ejabberd_user module to manage users state.
|
||||
|
||||
- name: Create a user if it does not exist
|
||||
ejabberd_user:
|
||||
community.general.ejabberd_user:
|
||||
username: test
|
||||
host: server
|
||||
password: password
|
||||
|
||||
- name: Delete a user if it exists
|
||||
ejabberd_user:
|
||||
community.general.ejabberd_user:
|
||||
username: test
|
||||
host: server
|
||||
state: absent
|
||||
|
|
|
|||
|
|
@ -56,24 +56,24 @@ notes:
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Simple gunicorn run example
|
||||
gunicorn:
|
||||
community.general.gunicorn:
|
||||
app: 'wsgi'
|
||||
chdir: '/workspace/example'
|
||||
|
||||
- name: Run gunicorn on a virtualenv
|
||||
gunicorn:
|
||||
community.general.gunicorn:
|
||||
app: 'wsgi'
|
||||
chdir: '/workspace/example'
|
||||
venv: '/workspace/example/venv'
|
||||
|
||||
- name: Run gunicorn with a config file
|
||||
gunicorn:
|
||||
community.general.gunicorn:
|
||||
app: 'wsgi'
|
||||
chdir: '/workspace/example'
|
||||
conf: '/workspace/example/gunicorn.cfg'
|
||||
|
||||
- name: Run gunicorn as ansible user with specified pid and config file
|
||||
gunicorn:
|
||||
community.general.gunicorn:
|
||||
app: 'wsgi'
|
||||
chdir: '/workspace/example'
|
||||
conf: '/workspace/example/gunicorn.cfg'
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ extends_documentation_fragment: files
|
|||
|
||||
EXAMPLES = """
|
||||
- name: Add a user to a password file and ensure permissions are set
|
||||
htpasswd:
|
||||
community.general.htpasswd:
|
||||
path: /etc/nginx/passwdfile
|
||||
name: janedoe
|
||||
password: '9s36?;fyNp'
|
||||
|
|
@ -73,13 +73,13 @@ EXAMPLES = """
|
|||
mode: 0640
|
||||
|
||||
- name: Remove a user from a password file
|
||||
htpasswd:
|
||||
community.general.htpasswd:
|
||||
path: /etc/apache2/passwdfile
|
||||
name: foobar
|
||||
state: absent
|
||||
|
||||
- name: Add a user to a password file suitable for use by libpam-pwdfile
|
||||
htpasswd:
|
||||
community.general.htpasswd:
|
||||
path: /etc/mail/passwords
|
||||
name: alex
|
||||
password: oedu2eGh
|
||||
|
|
|
|||
|
|
@ -51,20 +51,20 @@ author:
|
|||
|
||||
EXAMPLES = r"""
|
||||
- name: Deploy a hello world application to the default deploy_path
|
||||
jboss:
|
||||
community.general.jboss:
|
||||
src: /tmp/hello-1.0-SNAPSHOT.war
|
||||
deployment: hello.war
|
||||
state: present
|
||||
|
||||
- name: Update the hello world application to the non-default deploy_path
|
||||
jboss:
|
||||
community.general.jboss:
|
||||
src: /tmp/hello-1.1-SNAPSHOT.war
|
||||
deploy_path: /opt/wildfly/deployment
|
||||
deployment: hello.war
|
||||
state: present
|
||||
|
||||
- name: Undeploy the hello world application from the default deploy_path
|
||||
jboss:
|
||||
community.general.jboss:
|
||||
deployment: hello.war
|
||||
state: absent
|
||||
"""
|
||||
|
|
|
|||
|
|
@ -62,7 +62,7 @@ options:
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Create a jenkins job using basic authentication
|
||||
jenkins_job:
|
||||
community.general.jenkins_job:
|
||||
config: "{{ lookup('file', 'templates/test.xml') }}"
|
||||
name: test
|
||||
password: admin
|
||||
|
|
@ -70,7 +70,7 @@ EXAMPLES = '''
|
|||
user: admin
|
||||
|
||||
- name: Create a jenkins job using the token
|
||||
jenkins_job:
|
||||
community.general.jenkins_job:
|
||||
config: "{{ lookup('template', 'templates/test.xml.j2') }}"
|
||||
name: test
|
||||
token: asdfasfasfasdfasdfadfasfasdfasdfc
|
||||
|
|
@ -78,7 +78,7 @@ EXAMPLES = '''
|
|||
user: admin
|
||||
|
||||
- name: Delete a jenkins job using basic authentication
|
||||
jenkins_job:
|
||||
community.general.jenkins_job:
|
||||
name: test
|
||||
password: admin
|
||||
state: absent
|
||||
|
|
@ -86,7 +86,7 @@ EXAMPLES = '''
|
|||
user: admin
|
||||
|
||||
- name: Delete a jenkins job using the token
|
||||
jenkins_job:
|
||||
community.general.jenkins_job:
|
||||
name: test
|
||||
token: asdfasfasfasdfasdfadfasfasdfasdfc
|
||||
state: absent
|
||||
|
|
@ -94,7 +94,7 @@ EXAMPLES = '''
|
|||
user: admin
|
||||
|
||||
- name: Disable a jenkins job using basic authentication
|
||||
jenkins_job:
|
||||
community.general.jenkins_job:
|
||||
name: test
|
||||
password: admin
|
||||
enabled: False
|
||||
|
|
@ -102,7 +102,7 @@ EXAMPLES = '''
|
|||
user: admin
|
||||
|
||||
- name: Disable a jenkins job using the token
|
||||
jenkins_job:
|
||||
community.general.jenkins_job:
|
||||
name: test
|
||||
token: asdfasfasfasdfasdfadfasfasdfasdfc
|
||||
enabled: False
|
||||
|
|
|
|||
|
|
@ -53,47 +53,47 @@ author:
|
|||
|
||||
EXAMPLES = '''
|
||||
# Get all Jenkins jobs using basic auth
|
||||
- jenkins_job_info:
|
||||
- community.general.jenkins_job_info:
|
||||
user: admin
|
||||
password: hunter2
|
||||
register: my_jenkins_job_info
|
||||
|
||||
# Get all Jenkins jobs using the token
|
||||
- jenkins_job_info:
|
||||
- community.general.jenkins_job_info:
|
||||
user: admin
|
||||
token: abcdefghijklmnop
|
||||
register: my_jenkins_job_info
|
||||
|
||||
# Get info about a single job using basic auth
|
||||
- jenkins_job_info:
|
||||
- community.general.jenkins_job_info:
|
||||
name: some-job-name
|
||||
user: admin
|
||||
password: hunter2
|
||||
register: my_jenkins_job_info
|
||||
|
||||
# Get info about a single job in a folder using basic auth
|
||||
- jenkins_job_info:
|
||||
- community.general.jenkins_job_info:
|
||||
name: some-folder-name/some-job-name
|
||||
user: admin
|
||||
password: hunter2
|
||||
register: my_jenkins_job_info
|
||||
|
||||
# Get info about jobs matching a shell glob using basic auth
|
||||
- jenkins_job_info:
|
||||
- community.general.jenkins_job_info:
|
||||
glob: some-job-*
|
||||
user: admin
|
||||
password: hunter2
|
||||
register: my_jenkins_job_info
|
||||
|
||||
# Get info about all failing jobs using basic auth
|
||||
- jenkins_job_info:
|
||||
- community.general.jenkins_job_info:
|
||||
color: red
|
||||
user: admin
|
||||
password: hunter2
|
||||
register: my_jenkins_job_info
|
||||
|
||||
# Get info about passing jobs matching a shell glob using basic auth
|
||||
- jenkins_job_info:
|
||||
- community.general.jenkins_job_info:
|
||||
name: some-job-*
|
||||
color: blue
|
||||
user: admin
|
||||
|
|
@ -101,7 +101,7 @@ EXAMPLES = '''
|
|||
register: my_jenkins_job_info
|
||||
|
||||
- name: Get the info from custom URL with token and validate_certs=False
|
||||
jenkins_job_info:
|
||||
community.general.jenkins_job_info:
|
||||
user: admin
|
||||
token: 126df5c60d66c66e3b75b11104a16a8a
|
||||
url: https://jenkins.example.com
|
||||
|
|
|
|||
|
|
@ -103,46 +103,46 @@ extends_documentation_fragment:
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Install plugin
|
||||
jenkins_plugin:
|
||||
community.general.jenkins_plugin:
|
||||
name: build-pipeline-plugin
|
||||
|
||||
- name: Install plugin without its dependencies
|
||||
jenkins_plugin:
|
||||
community.general.jenkins_plugin:
|
||||
name: build-pipeline-plugin
|
||||
with_dependencies: no
|
||||
|
||||
- name: Make sure the plugin is always up-to-date
|
||||
jenkins_plugin:
|
||||
community.general.jenkins_plugin:
|
||||
name: token-macro
|
||||
state: latest
|
||||
|
||||
- name: Install specific version of the plugin
|
||||
jenkins_plugin:
|
||||
community.general.jenkins_plugin:
|
||||
name: token-macro
|
||||
version: "1.15"
|
||||
|
||||
- name: Pin the plugin
|
||||
jenkins_plugin:
|
||||
community.general.jenkins_plugin:
|
||||
name: token-macro
|
||||
state: pinned
|
||||
|
||||
- name: Unpin the plugin
|
||||
jenkins_plugin:
|
||||
community.general.jenkins_plugin:
|
||||
name: token-macro
|
||||
state: unpinned
|
||||
|
||||
- name: Enable the plugin
|
||||
jenkins_plugin:
|
||||
community.general.jenkins_plugin:
|
||||
name: token-macro
|
||||
state: enabled
|
||||
|
||||
- name: Disable the plugin
|
||||
jenkins_plugin:
|
||||
community.general.jenkins_plugin:
|
||||
name: token-macro
|
||||
state: disabled
|
||||
|
||||
- name: Uninstall plugin
|
||||
jenkins_plugin:
|
||||
community.general.jenkins_plugin:
|
||||
name: build-pipeline-plugin
|
||||
state: absent
|
||||
|
||||
|
|
@ -150,7 +150,7 @@ EXAMPLES = '''
|
|||
# Example of how to authenticate
|
||||
#
|
||||
- name: Install plugin
|
||||
jenkins_plugin:
|
||||
community.general.jenkins_plugin:
|
||||
name: build-pipeline-plugin
|
||||
url_username: admin
|
||||
url_password: p4ssw0rd
|
||||
|
|
@ -171,7 +171,7 @@ EXAMPLES = '''
|
|||
enabled: yes
|
||||
tasks:
|
||||
- name: Install plugins without a specific version
|
||||
jenkins_plugin:
|
||||
community.general.jenkins_plugin:
|
||||
name: "{{ item.key }}"
|
||||
register: my_jenkins_plugin_unversioned
|
||||
when: >
|
||||
|
|
@ -179,7 +179,7 @@ EXAMPLES = '''
|
|||
with_dict: "{{ my_jenkins_plugins }}"
|
||||
|
||||
- name: Install plugins with a specific version
|
||||
jenkins_plugin:
|
||||
community.general.jenkins_plugin:
|
||||
name: "{{ item.key }}"
|
||||
version: "{{ item.value['version'] }}"
|
||||
register: my_jenkins_plugin_versioned
|
||||
|
|
@ -229,7 +229,7 @@ EXAMPLES = '''
|
|||
when: jenkins_restart_required
|
||||
|
||||
- name: Plugin pinning
|
||||
jenkins_plugin:
|
||||
community.general.jenkins_plugin:
|
||||
name: "{{ item.key }}"
|
||||
state: "{{ 'pinned' if item.value['pinned'] else 'unpinned'}}"
|
||||
when: >
|
||||
|
|
@ -237,7 +237,7 @@ EXAMPLES = '''
|
|||
with_dict: "{{ my_jenkins_plugins }}"
|
||||
|
||||
- name: Plugin enabling
|
||||
jenkins_plugin:
|
||||
community.general.jenkins_plugin:
|
||||
name: "{{ item.key }}"
|
||||
state: "{{ 'enabled' if item.value['enabled'] else 'disabled'}}"
|
||||
when: >
|
||||
|
|
|
|||
|
|
@ -59,7 +59,7 @@ notes:
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Obtaining a list of plugins
|
||||
jenkins_script:
|
||||
community.general.jenkins_script:
|
||||
script: 'println(Jenkins.instance.pluginManager.plugins)'
|
||||
user: admin
|
||||
password: admin
|
||||
|
|
@ -73,13 +73,13 @@ EXAMPLES = '''
|
|||
instance.save()
|
||||
|
||||
- name: Use the variable as the script
|
||||
jenkins_script:
|
||||
community.general.jenkins_script:
|
||||
script: "{{ setmaster_mode }}"
|
||||
args:
|
||||
jenkins_mode: Node.Mode.EXCLUSIVE
|
||||
|
||||
- name: Interacting with an untrusted HTTPS connection
|
||||
jenkins_script:
|
||||
community.general.jenkins_script:
|
||||
script: "println(Jenkins.instance.pluginManager.plugins)"
|
||||
user: admin
|
||||
password: admin
|
||||
|
|
|
|||
|
|
@ -142,7 +142,7 @@ author:
|
|||
EXAMPLES = """
|
||||
# Create a new issue and add a comment to it:
|
||||
- name: Create an issue
|
||||
jira:
|
||||
community.general.jira:
|
||||
uri: '{{ server }}'
|
||||
username: '{{ user }}'
|
||||
password: '{{ pass }}'
|
||||
|
|
@ -158,7 +158,7 @@ EXAMPLES = """
|
|||
register: issue
|
||||
|
||||
- name: Comment on issue
|
||||
jira:
|
||||
community.general.jira:
|
||||
uri: '{{ server }}'
|
||||
username: '{{ user }}'
|
||||
password: '{{ pass }}'
|
||||
|
|
@ -168,7 +168,7 @@ EXAMPLES = """
|
|||
|
||||
# Assign an existing issue using edit
|
||||
- name: Assign an issue using free-form fields
|
||||
jira:
|
||||
community.general.jira:
|
||||
uri: '{{ server }}'
|
||||
username: '{{ user }}'
|
||||
password: '{{ pass }}'
|
||||
|
|
@ -178,7 +178,7 @@ EXAMPLES = """
|
|||
|
||||
# Create an issue with an existing assignee
|
||||
- name: Create an assigned issue
|
||||
jira:
|
||||
community.general.jira:
|
||||
uri: '{{ server }}'
|
||||
username: '{{ user }}'
|
||||
password: '{{ pass }}'
|
||||
|
|
@ -191,7 +191,7 @@ EXAMPLES = """
|
|||
|
||||
# Edit an issue
|
||||
- name: Set the labels on an issue using free-form fields
|
||||
jira:
|
||||
community.general.jira:
|
||||
uri: '{{ server }}'
|
||||
username: '{{ user }}'
|
||||
password: '{{ pass }}'
|
||||
|
|
@ -205,7 +205,7 @@ EXAMPLES = """
|
|||
|
||||
# Updating a field using operations: add, set & remove
|
||||
- name: Change the value of a Select dropdown
|
||||
jira:
|
||||
community.general.jira:
|
||||
uri: '{{ server }}'
|
||||
username: '{{ user }}'
|
||||
password: '{{ pass }}'
|
||||
|
|
@ -221,7 +221,7 @@ EXAMPLES = """
|
|||
|
||||
# Retrieve metadata for an issue and use it to create an account
|
||||
- name: Get an issue
|
||||
jira:
|
||||
community.general.jira:
|
||||
uri: '{{ server }}'
|
||||
username: '{{ user }}'
|
||||
password: '{{ pass }}'
|
||||
|
|
@ -233,7 +233,7 @@ EXAMPLES = """
|
|||
# Search for an issue
|
||||
# You can limit the search for specific fields by adding optional args. Note! It must be a dict, hence, lastViewed: null
|
||||
- name: Search for an issue
|
||||
jira:
|
||||
community.general.jira:
|
||||
uri: '{{ server }}'
|
||||
username: '{{ user }}'
|
||||
password: '{{ pass }}'
|
||||
|
|
@ -255,7 +255,7 @@ EXAMPLES = """
|
|||
# You can get list of valid linktypes at /rest/api/2/issueLinkType
|
||||
# url of your jira installation.
|
||||
- name: Create link from HSP-1 to MKY-1
|
||||
jira:
|
||||
community.general.jira:
|
||||
uri: '{{ server }}'
|
||||
username: '{{ user }}'
|
||||
password: '{{ pass }}'
|
||||
|
|
@ -266,7 +266,7 @@ EXAMPLES = """
|
|||
|
||||
# Transition an issue by target status
|
||||
- name: Close the issue
|
||||
jira:
|
||||
community.general.jira:
|
||||
uri: '{{ server }}'
|
||||
username: '{{ user }}'
|
||||
password: '{{ pass }}'
|
||||
|
|
|
|||
|
|
@ -37,12 +37,12 @@ notes:
|
|||
EXAMPLES = '''
|
||||
# Gather status facts from nginx on localhost
|
||||
- name: Get current http stats
|
||||
nginx_status_facts:
|
||||
community.general.nginx_status_facts:
|
||||
url: http://localhost/nginx_status
|
||||
|
||||
# Gather status facts from nginx on localhost with a custom timeout of 20 seconds
|
||||
- name: Get current http stats
|
||||
nginx_status_facts:
|
||||
community.general.nginx_status_facts:
|
||||
url: http://localhost/nginx_status
|
||||
timeout: 20
|
||||
'''
|
||||
|
|
|
|||
|
|
@ -35,13 +35,13 @@ notes:
|
|||
EXAMPLES = r'''
|
||||
# Gather status info from nginx on localhost
|
||||
- name: Get current http stats
|
||||
nginx_status_info:
|
||||
community.general.nginx_status_info:
|
||||
url: http://localhost/nginx_status
|
||||
register: result
|
||||
|
||||
# Gather status info from nginx on localhost with a custom timeout of 20 seconds
|
||||
- name: Get current http stats
|
||||
nginx_status_info:
|
||||
community.general.nginx_status_info:
|
||||
url: http://localhost/nginx_status
|
||||
timeout: 20
|
||||
register: result
|
||||
|
|
|
|||
|
|
@ -73,7 +73,7 @@ extends_documentation_fragment: url
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Create or update a rundeck ACL policy in project Ansible
|
||||
rundeck_acl_policy:
|
||||
community.general.rundeck_acl_policy:
|
||||
name: "Project_01"
|
||||
api_version: 18
|
||||
url: "https://rundeck.example.org"
|
||||
|
|
@ -91,7 +91,7 @@ EXAMPLES = '''
|
|||
group: "build"
|
||||
|
||||
- name: Remove a rundeck system policy
|
||||
rundeck_acl_policy:
|
||||
community.general.rundeck_acl_policy:
|
||||
name: "Project_02"
|
||||
url: "https://rundeck.example.org"
|
||||
token: "mytoken"
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ extends_documentation_fragment: url
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Create a rundeck project
|
||||
rundeck_project:
|
||||
community.general.rundeck_project:
|
||||
name: "Project_01"
|
||||
api_version: 18
|
||||
url: "https://rundeck.example.org"
|
||||
|
|
@ -74,7 +74,7 @@ EXAMPLES = '''
|
|||
state: present
|
||||
|
||||
- name: Remove a rundeck project
|
||||
rundeck_project:
|
||||
community.general.rundeck_project:
|
||||
name: "Project_02"
|
||||
url: "https://rundeck.example.org"
|
||||
token: "mytoken"
|
||||
|
|
|
|||
|
|
@ -104,7 +104,7 @@ extends_documentation_fragment:
|
|||
|
||||
EXAMPLES = """
|
||||
- name: Create UTM aaa_group
|
||||
utm_aaa_group:
|
||||
community.general.utm_aaa_group:
|
||||
utm_host: sophos.host.name
|
||||
utm_token: abcdefghijklmno1234
|
||||
name: TestAAAGroupEntry
|
||||
|
|
@ -116,7 +116,7 @@ EXAMPLES = """
|
|||
state: present
|
||||
|
||||
- name: Remove UTM aaa_group
|
||||
utm_aaa_group:
|
||||
community.general.utm_aaa_group:
|
||||
utm_host: sophos.host.name
|
||||
utm_token: abcdefghijklmno1234
|
||||
name: TestAAAGroupEntry
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ extends_documentation_fragment:
|
|||
|
||||
EXAMPLES = """
|
||||
- name: Remove UTM aaa_group
|
||||
utm_aaa_group_info:
|
||||
community.general.utm_aaa_group_info:
|
||||
utm_host: sophos.host.name
|
||||
utm_token: abcdefghijklmno1234
|
||||
name: TestAAAGroupEntry
|
||||
|
|
|
|||
|
|
@ -57,7 +57,7 @@ extends_documentation_fragment:
|
|||
|
||||
EXAMPLES = """
|
||||
- name: Create a ca_host_key_cert entry
|
||||
utm_ca_host_key_cert:
|
||||
community.general.utm_ca_host_key_cert:
|
||||
utm_host: sophos.host.name
|
||||
utm_token: abcdefghijklmno1234
|
||||
name: TestHostKeyCertEntry
|
||||
|
|
@ -72,14 +72,14 @@ EXAMPLES = """
|
|||
state: present
|
||||
|
||||
- name: Remove a ca_host_key_cert entry
|
||||
utm_ca_host_key_cert:
|
||||
community.general.utm_ca_host_key_cert:
|
||||
utm_host: sophos.host.name
|
||||
utm_token: abcdefghijklmno1234
|
||||
name: TestHostKeyCertEntry
|
||||
state: absent
|
||||
|
||||
- name: Read a ca_host_key_cert entry
|
||||
utm_ca_host_key_cert:
|
||||
community.general.utm_ca_host_key_cert:
|
||||
utm_host: sophos.host.name
|
||||
utm_token: abcdefghijklmno1234
|
||||
name: TestHostKeyCertEntry
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ extends_documentation_fragment:
|
|||
|
||||
EXAMPLES = """
|
||||
- name: Get info for a ca host_key_cert entry
|
||||
utm_ca_host_key_cert_info:
|
||||
community.general.utm_ca_host_key_cert_info:
|
||||
utm_host: sophos.host.name
|
||||
utm_token: abcdefghijklmno1234
|
||||
name: TestHostKeyCertEntry
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ extends_documentation_fragment:
|
|||
|
||||
EXAMPLES = """
|
||||
- name: Create UTM dns host entry
|
||||
utm_dns_host:
|
||||
community.general.utm_dns_host:
|
||||
utm_host: sophos.host.name
|
||||
utm_token: abcdefghijklmno1234
|
||||
name: TestDNSEntry
|
||||
|
|
@ -72,7 +72,7 @@ EXAMPLES = """
|
|||
state: present
|
||||
|
||||
- name: Remove UTM dns host entry
|
||||
utm_dns_host:
|
||||
community.general.utm_dns_host:
|
||||
utm_host: sophos.host.name
|
||||
utm_token: abcdefghijklmno1234
|
||||
name: TestDNSEntry
|
||||
|
|
|
|||
|
|
@ -165,7 +165,7 @@ extends_documentation_fragment:
|
|||
|
||||
EXAMPLES = """
|
||||
- name: Create UTM proxy_auth_profile
|
||||
utm_proxy_auth_profile:
|
||||
community.general.utm_proxy_auth_profile:
|
||||
utm_host: sophos.host.name
|
||||
utm_token: abcdefghijklmno1234
|
||||
name: TestAuthProfileEntry
|
||||
|
|
@ -176,14 +176,14 @@ EXAMPLES = """
|
|||
state: present
|
||||
|
||||
- name: Remove UTM proxy_auth_profile
|
||||
utm_proxy_auth_profile:
|
||||
community.general.utm_proxy_auth_profile:
|
||||
utm_host: sophos.host.name
|
||||
utm_token: abcdefghijklmno1234
|
||||
name: TestAuthProfileEntry
|
||||
state: absent
|
||||
|
||||
- name: Read UTM proxy_auth_profile
|
||||
utm_proxy_auth_profile:
|
||||
community.general.utm_proxy_auth_profile:
|
||||
utm_host: sophos.host.name
|
||||
utm_token: abcdefghijklmno1234
|
||||
name: TestAuthProfileEntry
|
||||
|
|
|
|||
|
|
@ -122,7 +122,7 @@ extends_documentation_fragment:
|
|||
|
||||
EXAMPLES = """
|
||||
- name: Create UTM proxy_exception
|
||||
utm_proxy_exception:
|
||||
community.general.utm_proxy_exception:
|
||||
utm_host: sophos.host.name
|
||||
utm_token: abcdefghijklmno1234
|
||||
name: TestExceptionEntry
|
||||
|
|
@ -130,7 +130,7 @@ EXAMPLES = """
|
|||
state: present
|
||||
|
||||
- name: Remove UTM proxy_exception
|
||||
utm_proxy_exception:
|
||||
community.general.utm_proxy_exception:
|
||||
utm_host: sophos.host.name
|
||||
utm_token: abcdefghijklmno1234
|
||||
name: TestExceptionEntry
|
||||
|
|
|
|||
|
|
@ -125,7 +125,7 @@ extends_documentation_fragment:
|
|||
|
||||
EXAMPLES = """
|
||||
- name: Create utm proxy_frontend
|
||||
utm_proxy_frontend:
|
||||
community.general.utm_proxy_frontend:
|
||||
utm_host: sophos.host.name
|
||||
utm_token: abcdefghijklmno1234
|
||||
name: TestFrontendEntry
|
||||
|
|
@ -133,7 +133,7 @@ EXAMPLES = """
|
|||
state: present
|
||||
|
||||
- name: Remove utm proxy_frontend
|
||||
utm_proxy_frontend:
|
||||
community.general.utm_proxy_frontend:
|
||||
utm_host: sophos.host.name
|
||||
utm_token: abcdefghijklmno1234
|
||||
name: TestFrontendEntry
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ extends_documentation_fragment:
|
|||
|
||||
EXAMPLES = """
|
||||
- name: Get utm proxy_frontend
|
||||
utm_proxy_frontend_info:
|
||||
community.general.utm_proxy_frontend_info:
|
||||
utm_host: sophos.host.name
|
||||
utm_token: abcdefghijklmno1234
|
||||
name: TestBackendEntry
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ extends_documentation_fragment:
|
|||
|
||||
EXAMPLES = """
|
||||
- name: Remove UTM proxy_location
|
||||
utm_proxy_location_info:
|
||||
community.general.utm_proxy_location_info:
|
||||
utm_host: sophos.host.name
|
||||
utm_token: abcdefghijklmno1234
|
||||
name: TestLocationEntry
|
||||
|
|
|
|||
|
|
@ -56,23 +56,23 @@ author:
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Manage the state of program to be in started state
|
||||
supervisorctl:
|
||||
community.general.supervisorctl:
|
||||
name: my_app
|
||||
state: started
|
||||
|
||||
- name: Manage the state of program group to be in started state
|
||||
supervisorctl:
|
||||
community.general.supervisorctl:
|
||||
name: 'my_apps:'
|
||||
state: started
|
||||
|
||||
- name: Restart my_app, reading supervisorctl configuration from a specified file
|
||||
supervisorctl:
|
||||
community.general.supervisorctl:
|
||||
name: my_app
|
||||
state: restarted
|
||||
config: /var/opt/my_project/supervisord.conf
|
||||
|
||||
- name: Restart my_app, connecting to supervisord with credentials and server URL
|
||||
supervisorctl:
|
||||
community.general.supervisorctl:
|
||||
name: my_app
|
||||
state: restarted
|
||||
username: test
|
||||
|
|
@ -80,7 +80,7 @@ EXAMPLES = '''
|
|||
server_url: http://localhost:9001
|
||||
|
||||
- name: Send a signal to my_app via supervisorctl
|
||||
supervisorctl:
|
||||
community.general.supervisorctl:
|
||||
name: my_app
|
||||
state: signalled
|
||||
signal: USR1
|
||||
|
|
|
|||
|
|
@ -73,7 +73,7 @@ notes:
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Create an issue in the my hosted Taiga environment and attach an error log
|
||||
taiga_issue:
|
||||
community.general.taiga_issue:
|
||||
taiga_host: https://mytaigahost.example.com
|
||||
project: myproject
|
||||
subject: An error has been found
|
||||
|
|
@ -90,7 +90,7 @@ EXAMPLES = '''
|
|||
state: present
|
||||
|
||||
- name: Deletes the previously created issue
|
||||
taiga_issue:
|
||||
community.general.taiga_issue:
|
||||
taiga_host: https://mytaigahost.example.com
|
||||
project: myproject
|
||||
subject: An error has been found
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue