all modules documentation should be valid yaml data (#64838)

This commit is contained in:
Andrew N Golovkov 2019-11-26 20:18:16 +02:00 committed by Sandra McCann
parent 8d0c2cd4d5
commit 12670f5a80
8 changed files with 32 additions and 33 deletions

View file

@ -25,10 +25,10 @@ author:
options: options:
filters: filters:
description: description:
- A dict of filters to apply. Each dict item consists of a filter key and a filter value. See \ - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See
U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html) for \ U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html) for
possible filters. Filter names and values are case sensitive. You can also use underscores (_) \ possible filters. Filter names and values are case sensitive. You can also use underscores (_)
instead of dashes (-) in the filter keys, which will take precedence in case of conflict. instead of dashes (-) in the filter keys, which will take precedence in case of conflict.
required: false required: false
default: {} default: {}
type: dict type: dict

View file

@ -31,31 +31,31 @@ options:
elements: str elements: str
owner_ids: owner_ids:
description: description:
- If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have \ - If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have
access are returned. access are returned.
required: false required: false
default: [] default: []
type: list type: list
elements: str elements: str
restorable_by_user_ids: restorable_by_user_ids:
description: description:
- If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are \ - If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are
returned. returned.
required: false required: false
default: [] default: []
type: list type: list
elements: str elements: str
filters: filters:
description: description:
- A dict of filters to apply. Each dict item consists of a filter key and a filter value. See \ - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See
U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html) for possible filters. Filter \ U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html) for possible filters. Filter
names and values are case sensitive. names and values are case sensitive.
required: false required: false
type: dict type: dict
default: {} default: {}
notes: notes:
- By default, the module will return all snapshots, including public ones. To limit results to snapshots owned by \ - By default, the module will return all snapshots, including public ones. To limit results to snapshots owned by
the account use the filter 'owner-id'. the account use the filter 'owner-id'.
extends_documentation_fragment: extends_documentation_fragment:
- aws - aws

View file

@ -30,9 +30,9 @@ options:
type: list type: list
filters: filters:
description: description:
- A dict of filters to apply. Each dict item consists of a filter key and a filter value. See \ - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See
U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkAcls.html) for possible filters. Filter \ U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeNetworkAcls.html) for possible filters. Filter
names and values are case sensitive. names and values are case sensitive.
required: false required: false
default: {} default: {}
type: dict type: dict

View file

@ -57,7 +57,7 @@ options:
description: description:
- "Name of PubNub account for from which C(application) will be used to - "Name of PubNub account for from which C(application) will be used to
manage blocks." manage blocks."
- "User\'s account will be used if value not set or empty." - "User's account will be used if value not set or empty."
required: false required: false
version_added: '2.4' version_added: '2.4'
application: application:
@ -82,9 +82,9 @@ options:
required: true required: true
description: description:
description: description:
- "Short block description which will be later visible on - Short block description which will be later visible on
admin.pubnub.com. Used only if block doesn\'t exists and won\'t change admin.pubnub.com. Used only if block doesn't exists and won't change
description for existing block." description for existing block.
required: false required: false
default: 'New block' default: 'New block'
event_handlers: event_handlers:

View file

@ -99,8 +99,8 @@ options:
- The maintenance id number when deleting a maintenance window - The maintenance id number when deleting a maintenance window
minutes: minutes:
description: description:
- The length of time in UTC that the maintenance will run \ - The length of time in UTC that the maintenance will run
(starting from playbook runtime) (starting from playbook runtime)
default: 10 default: 10
start_date: start_date:
description: description:

View file

@ -116,11 +116,11 @@ options:
httprequest: httprequest:
description: description:
- "HTTP request to send to the server (for example, C(\\"HEAD /file.html\\"))." - 'HTTP request to send to the server (for example, C("HEAD /file.html")).'
rtsprequest: rtsprequest:
description: description:
- "RTSP request to send to the server (for example, C(\\"OPTIONS *\\"))." - 'RTSP request to send to the server (for example, C("OPTIONS *")).'
customheaders: customheaders:
description: description:

View file

@ -315,7 +315,7 @@ options:
persistence sessions (persistence type RULE). Can be either an expression or the name of a named persistence sessions (persistence type RULE). Can be either an expression or the name of a named
expression. expression.
- "Example:" - "Example:"
- "C(HTTP.RES.HEADER(\\"setcookie\\").VALUE(0).TYPECAST_NVLIST_T('=',';').VALUE(\\"server1\\"))." - 'C(HTTP.RES.HEADER("setcookie").VALUE(0).TYPECAST_NVLIST_T("=",";").VALUE("server1")).'
persistmask: persistmask:
description: description:

View file

@ -13,7 +13,6 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = ''' DOCUMENTATION = '''
module: na_ontap_lun_copy module: na_ontap_lun_copy
short_description: NetApp ONTAP copy LUNs short_description: NetApp ONTAP copy LUNs
@ -23,36 +22,36 @@ version_added: '2.8'
author: NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com> author: NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>
description: description:
- Copy LUNs on NetApp ONTAP. - Copy LUNs on NetApp ONTAP.
options: options:
state: state:
description: description:
- Whether the specified LUN should exist or not. - Whether the specified LUN should exist or not.
choices: ['present'] choices: ['present']
default: present default: present
destination_vserver: destination_vserver:
description: description:
- the name of the Vserver that will host the new LUN. - Specifies the name of the Vserver that will host the new LUN.
required: true required: true
destination_path: destination_path:
description: description:
- Specifies the full path to the new LUN. - Specifies the full path to the new LUN.
required: true required: true
source_path: source_path:
description: description:
- Specifies the full path to the source LUN. - Specifies the full path to the source LUN.
required: true required: true
source_vserver: source_vserver:
description: description:
- Specifies the name of the vserver hosting the LUN to be copied. - Specifies the name of the vserver hosting the LUN to be copied.
'''
'''
EXAMPLES = """ EXAMPLES = """
- name: Copy LUN - name: Copy LUN
na_ontap_lun_copy: na_ontap_lun_copy: