mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 21:00:22 -07: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
|
@ -106,7 +106,7 @@ options:
|
|||
EXAMPLES = '''
|
||||
# check for migrations on local node
|
||||
- name: Wait for migrations on local node before proceeding
|
||||
aerospike_migrations:
|
||||
community.general.aerospike_migrations:
|
||||
host: "localhost"
|
||||
connect_timeout: 2000
|
||||
consecutive_good_checks: 5
|
||||
|
@ -138,7 +138,7 @@ EXAMPLES = '''
|
|||
# Maximum runtime before giving up in this case will be:
|
||||
# Tries Limit * Sleep Between Checks * delay * retries
|
||||
- name: Wait for aerospike migrations
|
||||
aerospike_migrations:
|
||||
community.general.aerospike_migrations:
|
||||
local_only: True
|
||||
sleep_between_checks: 1
|
||||
tries_limit: 5
|
||||
|
|
|
@ -38,18 +38,18 @@ extends_documentation_fragment:
|
|||
EXAMPLES = r'''
|
||||
# Example influxdb_database command from Ansible Playbooks
|
||||
- name: Create database
|
||||
influxdb_database:
|
||||
community.general.influxdb_database:
|
||||
hostname: "{{influxdb_ip_address}}"
|
||||
database_name: "{{influxdb_database_name}}"
|
||||
|
||||
- name: Destroy database
|
||||
influxdb_database:
|
||||
community.general.influxdb_database:
|
||||
hostname: "{{influxdb_ip_address}}"
|
||||
database_name: "{{influxdb_database_name}}"
|
||||
state: absent
|
||||
|
||||
- name: Create database using custom credentials
|
||||
influxdb_database:
|
||||
community.general.influxdb_database:
|
||||
hostname: "{{influxdb_ip_address}}"
|
||||
username: "{{influxdb_username}}"
|
||||
password: "{{influxdb_password}}"
|
||||
|
|
|
@ -35,14 +35,14 @@ extends_documentation_fragment:
|
|||
|
||||
EXAMPLES = r'''
|
||||
- name: Query connections
|
||||
influxdb_query:
|
||||
community.general.influxdb_query:
|
||||
hostname: "{{ influxdb_ip_address }}"
|
||||
database_name: "{{ influxdb_database_name }}"
|
||||
query: "select mean(value) from connections"
|
||||
register: connection
|
||||
|
||||
- name: Query connections with tags filters
|
||||
influxdb_query:
|
||||
community.general.influxdb_query:
|
||||
hostname: "{{ influxdb_ip_address }}"
|
||||
database_name: "{{ influxdb_database_name }}"
|
||||
query: "select mean(value) from connections where region='zue01' and host='server01'"
|
||||
|
|
|
@ -50,7 +50,7 @@ extends_documentation_fragment:
|
|||
EXAMPLES = r'''
|
||||
# Example influxdb_retention_policy command from Ansible Playbooks
|
||||
- name: Create 1 hour retention policy
|
||||
influxdb_retention_policy:
|
||||
community.general.influxdb_retention_policy:
|
||||
hostname: "{{influxdb_ip_address}}"
|
||||
database_name: "{{influxdb_database_name}}"
|
||||
policy_name: test
|
||||
|
@ -60,7 +60,7 @@ EXAMPLES = r'''
|
|||
validate_certs: yes
|
||||
|
||||
- name: Create 1 day retention policy
|
||||
influxdb_retention_policy:
|
||||
community.general.influxdb_retention_policy:
|
||||
hostname: "{{influxdb_ip_address}}"
|
||||
database_name: "{{influxdb_database_name}}"
|
||||
policy_name: test
|
||||
|
@ -68,7 +68,7 @@ EXAMPLES = r'''
|
|||
replication: 1
|
||||
|
||||
- name: Create 1 week retention policy
|
||||
influxdb_retention_policy:
|
||||
community.general.influxdb_retention_policy:
|
||||
hostname: "{{influxdb_ip_address}}"
|
||||
database_name: "{{influxdb_database_name}}"
|
||||
policy_name: test
|
||||
|
@ -76,7 +76,7 @@ EXAMPLES = r'''
|
|||
replication: 1
|
||||
|
||||
- name: Create infinite retention policy
|
||||
influxdb_retention_policy:
|
||||
community.general.influxdb_retention_policy:
|
||||
hostname: "{{influxdb_ip_address}}"
|
||||
database_name: "{{influxdb_database_name}}"
|
||||
policy_name: test
|
||||
|
|
|
@ -56,19 +56,19 @@ extends_documentation_fragment:
|
|||
|
||||
EXAMPLES = r'''
|
||||
- name: Create a user on localhost using default login credentials
|
||||
influxdb_user:
|
||||
community.general.influxdb_user:
|
||||
user_name: john
|
||||
user_password: s3cr3t
|
||||
|
||||
- name: Create a user on localhost using custom login credentials
|
||||
influxdb_user:
|
||||
community.general.influxdb_user:
|
||||
user_name: john
|
||||
user_password: s3cr3t
|
||||
login_username: "{{ influxdb_username }}"
|
||||
login_password: "{{ influxdb_password }}"
|
||||
|
||||
- name: Create an admin user on a remote host using custom login credentials
|
||||
influxdb_user:
|
||||
community.general.influxdb_user:
|
||||
user_name: john
|
||||
user_password: s3cr3t
|
||||
admin: yes
|
||||
|
@ -77,7 +77,7 @@ EXAMPLES = r'''
|
|||
login_password: "{{ influxdb_password }}"
|
||||
|
||||
- name: Create a user on localhost with privileges
|
||||
influxdb_user:
|
||||
community.general.influxdb_user:
|
||||
user_name: john
|
||||
user_password: s3cr3t
|
||||
login_username: "{{ influxdb_username }}"
|
||||
|
@ -89,7 +89,7 @@ EXAMPLES = r'''
|
|||
privilege: 'READ'
|
||||
|
||||
- name: Destroy a user using custom login credentials
|
||||
influxdb_user:
|
||||
community.general.influxdb_user:
|
||||
user_name: john
|
||||
login_username: "{{ influxdb_username }}"
|
||||
login_password: "{{ influxdb_password }}"
|
||||
|
|
|
@ -36,7 +36,7 @@ extends_documentation_fragment:
|
|||
|
||||
EXAMPLES = r'''
|
||||
- name: Write points into database
|
||||
influxdb_write:
|
||||
community.general.influxdb_write:
|
||||
hostname: "{{influxdb_ip_address}}"
|
||||
database_name: "{{influxdb_database_name}}"
|
||||
data_points:
|
||||
|
|
|
@ -75,27 +75,27 @@ options:
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Install Elasticsearch Head plugin in Elasticsearch 2.x
|
||||
elasticsearch_plugin:
|
||||
community.general.elasticsearch_plugin:
|
||||
name: mobz/elasticsearch-head
|
||||
state: present
|
||||
|
||||
- name: Install a specific version of Elasticsearch Head in Elasticsearch 2.x
|
||||
elasticsearch_plugin:
|
||||
community.general.elasticsearch_plugin:
|
||||
name: mobz/elasticsearch-head
|
||||
version: 2.0.0
|
||||
|
||||
- name: Uninstall Elasticsearch head plugin in Elasticsearch 2.x
|
||||
elasticsearch_plugin:
|
||||
community.general.elasticsearch_plugin:
|
||||
name: mobz/elasticsearch-head
|
||||
state: absent
|
||||
|
||||
- name: Install a specific plugin in Elasticsearch >= 5.0
|
||||
elasticsearch_plugin:
|
||||
community.general.elasticsearch_plugin:
|
||||
name: analysis-icu
|
||||
state: present
|
||||
|
||||
- name: Install the ingest-geoip plugin with a forced installation
|
||||
elasticsearch_plugin:
|
||||
community.general.elasticsearch_plugin:
|
||||
name: ingest-geoip
|
||||
state: present
|
||||
force: yes
|
||||
|
|
|
@ -56,18 +56,18 @@ options:
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Install Elasticsearch head plugin
|
||||
kibana_plugin:
|
||||
community.general.kibana_plugin:
|
||||
state: present
|
||||
name: elasticsearch/marvel
|
||||
|
||||
- name: Install specific version of a plugin
|
||||
kibana_plugin:
|
||||
community.general.kibana_plugin:
|
||||
state: present
|
||||
name: elasticsearch/marvel
|
||||
version: '2.3.3'
|
||||
|
||||
- name: Uninstall Elasticsearch head plugin
|
||||
kibana_plugin:
|
||||
community.general.kibana_plugin:
|
||||
state: absent
|
||||
name: elasticsearch/marvel
|
||||
'''
|
||||
|
|
|
@ -77,41 +77,41 @@ author: "Xabier Larrakoetxea (@slok)"
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Set local redis instance to be slave of melee.island on port 6377
|
||||
redis:
|
||||
community.general.redis:
|
||||
command: slave
|
||||
master_host: melee.island
|
||||
master_port: 6377
|
||||
|
||||
- name: Deactivate slave mode
|
||||
redis:
|
||||
community.general.redis:
|
||||
command: slave
|
||||
slave_mode: master
|
||||
|
||||
- name: Flush all the redis db
|
||||
redis:
|
||||
community.general.redis:
|
||||
command: flush
|
||||
flush_mode: all
|
||||
|
||||
- name: Flush only one db in a redis instance
|
||||
redis:
|
||||
community.general.redis:
|
||||
command: flush
|
||||
db: 1
|
||||
flush_mode: db
|
||||
|
||||
- name: Configure local redis to have 10000 max clients
|
||||
redis:
|
||||
community.general.redis:
|
||||
command: config
|
||||
name: maxclients
|
||||
value: 10000
|
||||
|
||||
- name: Configure local redis maxmemory to 4GB
|
||||
redis:
|
||||
community.general.redis:
|
||||
command: config
|
||||
name: maxmemory
|
||||
value: 4GB
|
||||
|
||||
- name: Configure local redis to have lua time limit of 100 ms
|
||||
redis:
|
||||
community.general.redis:
|
||||
command: config
|
||||
name: lua-time-limit
|
||||
value: 100
|
||||
|
|
|
@ -55,16 +55,16 @@ options:
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: "Join's a Riak node to another node"
|
||||
riak:
|
||||
community.general.riak:
|
||||
command: join
|
||||
target_node: riak@10.1.1.1
|
||||
|
||||
- name: Wait for handoffs to finish. Use with async and poll.
|
||||
riak:
|
||||
community.general.riak:
|
||||
wait_for_handoffs: yes
|
||||
|
||||
- name: Wait for riak_kv service to startup
|
||||
riak:
|
||||
community.general.riak:
|
||||
wait_for_service: kv
|
||||
'''
|
||||
|
||||
|
|
|
@ -60,7 +60,7 @@ author: Vedit Firat Arig (@vedit)
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Create a new database with name 'jackdata'
|
||||
mssql_db:
|
||||
community.general.mssql_db:
|
||||
name: jackdata
|
||||
state: present
|
||||
|
||||
|
@ -71,7 +71,7 @@ EXAMPLES = '''
|
|||
dest: /tmp
|
||||
|
||||
- name: Restore the dump file to database 'my_db'
|
||||
mssql_db:
|
||||
community.general.mssql_db:
|
||||
name: my_db
|
||||
state: import
|
||||
target: /tmp/dump.sql
|
||||
|
|
|
@ -56,7 +56,7 @@ author: "Dariusz Owczarek (@dareko)"
|
|||
|
||||
EXAMPLES = """
|
||||
- name: Updating load_balance_policy
|
||||
vertica_configuration: name=failovertostandbyafter value='8 hours'
|
||||
community.general.vertica_configuration: name=failovertostandbyafter value='8 hours'
|
||||
"""
|
||||
import traceback
|
||||
|
||||
|
|
|
@ -50,7 +50,7 @@ author: "Dariusz Owczarek (@dareko)"
|
|||
|
||||
EXAMPLES = """
|
||||
- name: Gathering vertica facts
|
||||
vertica_info: db=db_name
|
||||
community.general.vertica_info: db=db_name
|
||||
register: result
|
||||
|
||||
- name: Print schemas
|
||||
|
|
|
@ -61,10 +61,10 @@ author: "Dariusz Owczarek (@dareko)"
|
|||
|
||||
EXAMPLES = """
|
||||
- name: Creating a new vertica role
|
||||
vertica_role: name=role_name db=db_name state=present
|
||||
community.general.vertica_role: name=role_name db=db_name state=present
|
||||
|
||||
- name: Creating a new vertica role with other role assigned
|
||||
vertica_role: name=role_name assigned_role=other_role_name state=present
|
||||
community.general.vertica_role: name=role_name assigned_role=other_role_name state=present
|
||||
"""
|
||||
import traceback
|
||||
|
||||
|
|
|
@ -73,13 +73,13 @@ author: "Dariusz Owczarek (@dareko)"
|
|||
|
||||
EXAMPLES = """
|
||||
- name: Creating a new vertica schema
|
||||
vertica_schema: name=schema_name db=db_name state=present
|
||||
community.general.vertica_schema: name=schema_name db=db_name state=present
|
||||
|
||||
- name: Creating a new schema with specific schema owner
|
||||
vertica_schema: name=schema_name owner=dbowner db=db_name state=present
|
||||
community.general.vertica_schema: name=schema_name owner=dbowner db=db_name state=present
|
||||
|
||||
- name: Creating a new schema with roles
|
||||
vertica_schema:
|
||||
community.general.vertica_schema:
|
||||
name=schema_name
|
||||
create_roles=schema_name_all
|
||||
usage_roles=schema_name_ro,schema_name_rw
|
||||
|
|
|
@ -84,10 +84,10 @@ author: "Dariusz Owczarek (@dareko)"
|
|||
|
||||
EXAMPLES = """
|
||||
- name: Creating a new vertica user with password
|
||||
vertica_user: name=user_name password=md5<encrypted_password> db=db_name state=present
|
||||
community.general.vertica_user: name=user_name password=md5<encrypted_password> db=db_name state=present
|
||||
|
||||
- name: Creating a new vertica user authenticated via ldap with roles assigned
|
||||
vertica_user:
|
||||
community.general.vertica_user:
|
||||
name=user_name
|
||||
ldap=true
|
||||
db=db_name
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue