mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
short_description fix batch 2 (#5520)
This commit is contained in:
parent
c604cc5ba9
commit
f683d6a05d
50 changed files with 51 additions and 51 deletions
|
@ -11,7 +11,7 @@ __metaclass__ = type
|
|||
|
||||
DOCUMENTATION = '''
|
||||
module: consul
|
||||
short_description: "Add, modify & delete services within a consul cluster"
|
||||
short_description: Add, modify & delete services within a consul cluster
|
||||
description:
|
||||
- Registers services and checks for an agent with a consul cluster.
|
||||
A service is some process running on the agent node that should be advertised by
|
||||
|
|
|
@ -12,7 +12,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: etcd3
|
||||
short_description: "Set or delete key value pairs from an etcd3 cluster"
|
||||
short_description: Set or delete key value pairs from an etcd3 cluster
|
||||
requirements:
|
||||
- etcd3
|
||||
description:
|
||||
|
|
|
@ -9,7 +9,7 @@ __metaclass__ = type
|
|||
|
||||
DOCUMENTATION = '''
|
||||
module: gitlab_protected_branch
|
||||
short_description: (un)Marking existing branches for protection
|
||||
short_description: Manage protection of existing branches
|
||||
version_added: 3.4.0
|
||||
description:
|
||||
- (un)Marking existing branches for protection.
|
||||
|
@ -25,7 +25,7 @@ extends_documentation_fragment:
|
|||
options:
|
||||
state:
|
||||
description:
|
||||
- Create or delete proteced branch.
|
||||
- Create or delete protected branch.
|
||||
default: present
|
||||
type: str
|
||||
choices: ["present", "absent"]
|
||||
|
|
|
@ -11,7 +11,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: heroku_collaborator
|
||||
short_description: "Add or delete app collaborators on Heroku"
|
||||
short_description: Add or delete app collaborators on Heroku
|
||||
description:
|
||||
- Manages collaborators for Heroku apps.
|
||||
- If set to C(present) and heroku user is already collaborator, then do nothing.
|
||||
|
|
|
@ -12,7 +12,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: ipinfoio_facts
|
||||
short_description: "Retrieve IP geolocation facts of a host's IP address"
|
||||
short_description: Retrieve IP geolocation facts of a host's IP address
|
||||
description:
|
||||
- "Gather IP geolocation facts of a host's IP address using ipinfo.io API"
|
||||
author: "Aleksei Kostiuk (@akostyuk)"
|
||||
|
|
|
@ -13,7 +13,7 @@ DOCUMENTATION = r'''
|
|||
module: launchd
|
||||
author:
|
||||
- Martin Migasiewicz (@martinm82)
|
||||
short_description: Manage macOS services
|
||||
short_description: Manage macOS services
|
||||
version_added: 1.0.0
|
||||
description:
|
||||
- Manage launchd services on target macOS hosts.
|
||||
|
|
|
@ -12,7 +12,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: memset_memstore_info
|
||||
author: "Simon Weald (@glitchcrab)"
|
||||
short_description: Retrieve Memstore product usage information.
|
||||
short_description: Retrieve Memstore product usage information
|
||||
notes:
|
||||
- An API key generated via the Memset customer control panel is needed with the
|
||||
following minimum scope - I(memstore.usage).
|
||||
|
|
|
@ -12,7 +12,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: memset_server_info
|
||||
author: "Simon Weald (@glitchcrab)"
|
||||
short_description: Retrieve server information.
|
||||
short_description: Retrieve server information
|
||||
notes:
|
||||
- An API key generated via the Memset customer control panel is needed with the
|
||||
following minimum scope - I(server.info).
|
||||
|
|
|
@ -12,7 +12,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: memset_zone
|
||||
author: "Simon Weald (@glitchcrab)"
|
||||
short_description: Creates and deletes Memset DNS zones.
|
||||
short_description: Creates and deletes Memset DNS zones
|
||||
notes:
|
||||
- Zones can be thought of as a logical group of domains, all of which share the
|
||||
same DNS records (i.e. they point to the same IP). An API key generated via the
|
||||
|
|
|
@ -12,7 +12,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: memset_zone_domain
|
||||
author: "Simon Weald (@glitchcrab)"
|
||||
short_description: Create and delete domains in Memset DNS zones.
|
||||
short_description: Create and delete domains in Memset DNS zones
|
||||
notes:
|
||||
- Zone domains can be thought of as a collection of domains, all of which share the
|
||||
same DNS records (i.e. they point to the same IP). An API key generated via the
|
||||
|
|
|
@ -12,7 +12,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: memset_zone_record
|
||||
author: "Simon Weald (@glitchcrab)"
|
||||
short_description: Create and delete records in Memset DNS zones.
|
||||
short_description: Create and delete records in Memset DNS zones
|
||||
notes:
|
||||
- Zones can be thought of as a logical group of domains, all of which share the
|
||||
same DNS records (i.e. they point to the same IP). An API key generated via the
|
||||
|
|
|
@ -14,7 +14,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
author: Kairo Araujo (@kairoaraujo)
|
||||
module: mksysb
|
||||
short_description: Generates AIX mksysb rootvg backups.
|
||||
short_description: Generates AIX mksysb rootvg backups
|
||||
description:
|
||||
- This module manages a basic AIX mksysb (image) of rootvg.
|
||||
options:
|
||||
|
|
|
@ -13,7 +13,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: mssql_db
|
||||
short_description: Add or remove MSSQL databases from a remote host.
|
||||
short_description: Add or remove MSSQL databases from a remote host
|
||||
description:
|
||||
- Add or remove MSSQL databases from a remote host.
|
||||
options:
|
||||
|
|
|
@ -17,7 +17,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: nagios
|
||||
short_description: Perform common tasks in Nagios related to downtime and notifications.
|
||||
short_description: Perform common tasks in Nagios related to downtime and notifications
|
||||
description:
|
||||
- "The C(nagios) module has two basic functions: scheduling downtime and toggling alerts for services or hosts."
|
||||
- The C(nagios) module is not idempotent.
|
||||
|
|
|
@ -13,7 +13,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: netcup_dns
|
||||
notes: []
|
||||
short_description: manage Netcup DNS records
|
||||
short_description: Manage Netcup DNS records
|
||||
description:
|
||||
- "Manages DNS records via the Netcup API, see the docs U(https://ccp.netcup.net/run/webservice/servers/endpoint.php)."
|
||||
options:
|
||||
|
|
|
@ -12,7 +12,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: nginx_status_info
|
||||
short_description: Retrieve information on nginx status.
|
||||
short_description: Retrieve information on nginx status
|
||||
description:
|
||||
- Gathers information from nginx from an URL having C(stub_status) enabled.
|
||||
author: "René Moser (@resmo)"
|
||||
|
|
|
@ -14,7 +14,7 @@ DOCUMENTATION = '''
|
|||
module: nosh
|
||||
author:
|
||||
- "Thomas Caravia (@tacatac)"
|
||||
short_description: Manage services with nosh
|
||||
short_description: Manage services with nosh
|
||||
description:
|
||||
- Control running and enabled state for system-wide or user services.
|
||||
- BSD and Linux systems are supported.
|
||||
|
|
|
@ -18,7 +18,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: nsupdate
|
||||
|
||||
short_description: Manage DNS records.
|
||||
short_description: Manage DNS records
|
||||
description:
|
||||
- Create, update and remove DNS records using DDNS updates
|
||||
requirements:
|
||||
|
|
|
@ -13,7 +13,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: omapi_host
|
||||
short_description: Setup OMAPI hosts.
|
||||
short_description: Setup OMAPI hosts
|
||||
description: Manage OMAPI hosts into compatible DHCPd servers
|
||||
requirements:
|
||||
- pypureomapi
|
||||
|
|
|
@ -10,7 +10,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: oneandone_firewall_policy
|
||||
short_description: Configure 1&1 firewall policy.
|
||||
short_description: Configure 1&1 firewall policy
|
||||
description:
|
||||
- Create, remove, reconfigure, update firewall policies.
|
||||
This module has a dependency on 1and1 >= 1.0
|
||||
|
|
|
@ -10,7 +10,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: oneandone_load_balancer
|
||||
short_description: Configure 1&1 load balancer.
|
||||
short_description: Configure 1&1 load balancer
|
||||
description:
|
||||
- Create, remove, update load balancers.
|
||||
This module has a dependency on 1and1 >= 1.0
|
||||
|
|
|
@ -10,7 +10,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: oneandone_monitoring_policy
|
||||
short_description: Configure 1&1 monitoring policy.
|
||||
short_description: Configure 1&1 monitoring policy
|
||||
description:
|
||||
- Create, remove, update monitoring policies
|
||||
(and add/remove ports, processes, and servers).
|
||||
|
|
|
@ -10,7 +10,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: oneandone_private_network
|
||||
short_description: Configure 1&1 private networking.
|
||||
short_description: Configure 1&1 private networking
|
||||
description:
|
||||
- Create, remove, reconfigure, update a private network.
|
||||
This module has a dependency on 1and1 >= 1.0
|
||||
|
|
|
@ -10,7 +10,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: oneandone_public_ip
|
||||
short_description: Configure 1&1 public IPs.
|
||||
short_description: Configure 1&1 public IPs
|
||||
description:
|
||||
- Create, update, and remove public IPs.
|
||||
This module has a dependency on 1and1 >= 1.0
|
||||
|
|
|
@ -10,7 +10,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: oneandone_server
|
||||
short_description: Create, destroy, start, stop, and reboot a 1&1 Host server.
|
||||
short_description: Create, destroy, start, stop, and reboot a 1&1 Host server
|
||||
description:
|
||||
- Create, destroy, update, start, stop, and reboot a 1&1 Host server.
|
||||
When the server is created it can optionally wait for it to be 'running' before returning.
|
||||
|
|
|
@ -10,7 +10,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: oneview_fc_network
|
||||
short_description: Manage OneView Fibre Channel Network resources.
|
||||
short_description: Manage OneView Fibre Channel Network resources
|
||||
description:
|
||||
- Provides an interface to manage Fibre Channel Network resources. Can create, update, and delete.
|
||||
requirements:
|
||||
|
|
|
@ -11,7 +11,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: online_server_info
|
||||
short_description: Gather information about Online servers.
|
||||
short_description: Gather information about Online servers
|
||||
description:
|
||||
- Gather information about the servers.
|
||||
- U(https://www.online.net/en/dedicated-server)
|
||||
|
|
|
@ -9,7 +9,7 @@ __metaclass__ = type
|
|||
|
||||
DOCUMENTATION = r'''
|
||||
module: online_user_info
|
||||
short_description: Gather information about Online user.
|
||||
short_description: Gather information about Online user
|
||||
description:
|
||||
- Gather information about the user.
|
||||
author:
|
||||
|
|
|
@ -11,7 +11,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: opendj_backendprop
|
||||
short_description: Will update the backend configuration of OpenDJ via the dsconfig set-backend-prop command.
|
||||
short_description: Will update the backend configuration of OpenDJ via the dsconfig set-backend-prop command
|
||||
description:
|
||||
- This module will update settings for OpenDJ with the command set-backend-prop.
|
||||
- It will check first via de get-backend-prop if configuration needs to be applied.
|
||||
|
|
|
@ -12,7 +12,7 @@ DOCUMENTATION = '''
|
|||
module: openwrt_init
|
||||
author:
|
||||
- "Andrew Gaffney (@agaffney)"
|
||||
short_description: Manage services on OpenWrt.
|
||||
short_description: Manage services on OpenWrt
|
||||
description:
|
||||
- Controls OpenWrt services on remote hosts.
|
||||
options:
|
||||
|
|
|
@ -14,7 +14,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: packet_device
|
||||
|
||||
short_description: Manage a bare metal server in the Packet Host.
|
||||
short_description: Manage a bare metal server in the Packet Host
|
||||
|
||||
description:
|
||||
- Manage a bare metal server in the Packet Host (a "device" in the API terms).
|
||||
|
|
|
@ -14,7 +14,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: packet_ip_subnet
|
||||
|
||||
short_description: Assign IP subnet to a bare metal server.
|
||||
short_description: Assign IP subnet to a bare metal server
|
||||
|
||||
description:
|
||||
- Assign or unassign IPv4 or IPv6 subnets to or from a device in the Packet host.
|
||||
|
|
|
@ -14,7 +14,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: packet_project
|
||||
|
||||
short_description: Create/delete a project in Packet host.
|
||||
short_description: Create/delete a project in Packet host
|
||||
|
||||
description:
|
||||
- Create/delete a project in Packet host.
|
||||
|
|
|
@ -11,7 +11,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: packet_sshkey
|
||||
short_description: Create/delete an SSH key in Packet host.
|
||||
short_description: Create/delete an SSH key in Packet host
|
||||
description:
|
||||
- Create/delete an SSH key in Packet host.
|
||||
- API is documented at U(https://www.packet.net/help/api/#page:ssh-keys,header:ssh-keys-ssh-keys-post).
|
||||
|
|
|
@ -13,7 +13,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: packet_volume
|
||||
|
||||
short_description: Create/delete a volume in Packet host.
|
||||
short_description: Create/delete a volume in Packet host
|
||||
|
||||
description:
|
||||
- Create/delete a volume in Packet host.
|
||||
|
|
|
@ -14,7 +14,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: packet_volume_attachment
|
||||
|
||||
short_description: Attach/detach a volume to a device in the Packet host.
|
||||
short_description: Attach/detach a volume to a device in the Packet host
|
||||
|
||||
description:
|
||||
- Attach/detach a volume to a device in the Packet host.
|
||||
|
|
|
@ -10,7 +10,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
module: pids
|
||||
description: "Retrieves a list of PIDs of given process name in Ansible controller/controlled machines.Returns an empty list if no process in that name exists."
|
||||
short_description: "Retrieves process IDs list if the process is running otherwise return empty list"
|
||||
short_description: Retrieves process IDs list if the process is running otherwise return empty list
|
||||
author:
|
||||
- Saranya Sridharan (@saranyasridharan)
|
||||
requirements:
|
||||
|
|
|
@ -11,7 +11,7 @@ __metaclass__ = type
|
|||
|
||||
DOCUMENTATION = '''
|
||||
module: pip_package_info
|
||||
short_description: pip package information
|
||||
short_description: Pip package information
|
||||
description:
|
||||
- Return information about installed pip packages
|
||||
extends_documentation_fragment:
|
||||
|
|
|
@ -19,7 +19,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: pkgin
|
||||
short_description: Package manager for SmartOS, NetBSD, et al.
|
||||
short_description: Package manager for SmartOS, NetBSD, et al
|
||||
description:
|
||||
- "The standard package manager for SmartOS, but also usable on NetBSD
|
||||
or any OS that uses C(pkgsrc). (Home: U(http://pkgin.net/))"
|
||||
|
|
|
@ -11,7 +11,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: profitbricks
|
||||
short_description: Create, destroy, start, stop, and reboot a ProfitBricks virtual machine.
|
||||
short_description: Create, destroy, start, stop, and reboot a ProfitBricks virtual machine
|
||||
description:
|
||||
- Create, destroy, update, start, stop, and reboot a ProfitBricks virtual machine. When the virtual machine is created it can optionally wait
|
||||
for it to be 'running' before returning. This module has a dependency on profitbricks >= 1.0.0
|
||||
|
|
|
@ -11,7 +11,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: profitbricks_datacenter
|
||||
short_description: Create or destroy a ProfitBricks Virtual Datacenter.
|
||||
short_description: Create or destroy a ProfitBricks Virtual Datacenter
|
||||
description:
|
||||
- This is a simple module that supports creating or removing vDCs. A vDC is required before you can create servers. This module has a dependency
|
||||
on profitbricks >= 1.0.0
|
||||
|
|
|
@ -11,7 +11,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: profitbricks_nic
|
||||
short_description: Create or Remove a NIC.
|
||||
short_description: Create or Remove a NIC
|
||||
description:
|
||||
- This module allows you to create or restore a volume snapshot. This module has a dependency on profitbricks >= 1.0.0
|
||||
options:
|
||||
|
|
|
@ -11,7 +11,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: profitbricks_volume
|
||||
short_description: Create or destroy a volume.
|
||||
short_description: Create or destroy a volume
|
||||
description:
|
||||
- Allows you to create or remove a volume from a ProfitBricks datacenter. This module has a dependency on profitbricks >= 1.0.0
|
||||
options:
|
||||
|
|
|
@ -11,7 +11,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: profitbricks_volume_attachments
|
||||
short_description: Attach or detach a volume.
|
||||
short_description: Attach or detach a volume
|
||||
description:
|
||||
- Allows you to attach or detach a volume from a ProfitBricks server. This module has a dependency on profitbricks >= 1.0.0
|
||||
options:
|
||||
|
|
|
@ -11,7 +11,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: proxmox
|
||||
short_description: management of instances in Proxmox VE cluster
|
||||
short_description: Management of instances in Proxmox VE cluster
|
||||
description:
|
||||
- allows you to create/delete/stop instances in Proxmox VE cluster
|
||||
- Starting in Ansible 2.1, it automatically detects containerization type (lxc for PVE 4, openvz for older)
|
||||
|
|
|
@ -11,7 +11,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: proxmox_disk
|
||||
short_description: Management of a disk of a Qemu(KVM) VM in a Proxmox VE cluster.
|
||||
short_description: Management of a disk of a Qemu(KVM) VM in a Proxmox VE cluster
|
||||
version_added: 5.7.0
|
||||
description:
|
||||
- Allows you to perform some supported operations on a disk in Qemu(KVM) Virtual Machines in a Proxmox VE cluster.
|
||||
|
|
|
@ -11,7 +11,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: proxmox_kvm
|
||||
short_description: Management of Qemu(KVM) Virtual Machines in Proxmox VE cluster.
|
||||
short_description: Management of Qemu(KVM) Virtual Machines in Proxmox VE cluster
|
||||
description:
|
||||
- Allows you to create/delete/stop Qemu(KVM) Virtual Machines in Proxmox VE cluster.
|
||||
- Since community.general 4.0.0 on, there are no more default values, see I(proxmox_default_behavior).
|
||||
|
|
|
@ -11,7 +11,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: proxmox_nic
|
||||
short_description: Management of a NIC of a Qemu(KVM) VM in a Proxmox VE cluster.
|
||||
short_description: Management of a NIC of a Qemu(KVM) VM in a Proxmox VE cluster
|
||||
version_added: 3.1.0
|
||||
description:
|
||||
- Allows you to create/update/delete a NIC on Qemu(KVM) Virtual Machines in a Proxmox VE cluster.
|
||||
|
|
|
@ -12,7 +12,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: proxmox_template
|
||||
short_description: management of OS templates in Proxmox VE cluster
|
||||
short_description: Management of OS templates in Proxmox VE cluster
|
||||
description:
|
||||
- allows you to upload/delete templates in Proxmox VE cluster
|
||||
options:
|
||||
|
|
|
@ -17,7 +17,7 @@ __metaclass__ = type
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: pubnub_blocks
|
||||
short_description: PubNub blocks management module.
|
||||
short_description: PubNub blocks management module
|
||||
description:
|
||||
- "This module allows Ansible to interface with the PubNub BLOCKS
|
||||
infrastructure by providing the following operations: create / remove,
|
||||
|
|
Loading…
Reference in a new issue