cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Fix return value documentation (2/2) (#63478)

Browse source 
* Fix return value documentation (2/2).
* Avoid validation errors for missing 'contains:'.
* Convert JSON text to JSON dict.
* example -> sample.
* Fix YAML.
This commit is contained in:
Felix Fontein 2019-10-15 22:53:46 +02:00 committed by Alicia Cozine
parent 20be8693ba
commit 4bc298af83
50 changed files with 427 additions and 400 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
lib/ansible/modules/cloud/vultr/_vultr_block_storage_facts.py
View file

@ -72,7 +72,7 @@ vultr_block_storage_facts:
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_block_storage_facts": [
{
"attached_to_id": null,

2
lib/ansible/modules/cloud/vultr/_vultr_dns_domain_facts.py
View file

@ -72,7 +72,7 @@ vultr_dns_domain_facts:
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_dns_domain_facts": [
{
"date_created": "2018-07-19 07:14:21",

2
lib/ansible/modules/cloud/vultr/_vultr_firewall_group_facts.py
View file

@ -72,7 +72,7 @@ vultr_firewall_group_facts:
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_firewall_group_facts": [
{
"date_created": "2018-07-12 10:27:14",

2
lib/ansible/modules/cloud/vultr/_vultr_network_facts.py
View file

@ -72,7 +72,7 @@ vultr_network_facts:
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_network_facts": [
{
"date_created": "2018-08-02 11:18:49",

2
lib/ansible/modules/cloud/vultr/_vultr_os_facts.py
View file

@ -73,7 +73,7 @@ ansible_facts:
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_os_facts": [
{
"arch": "x64",

2
lib/ansible/modules/cloud/vultr/_vultr_region_facts.py
View file

@ -73,7 +73,7 @@ vultr_region_facts:
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_region_facts": [
{
"block_storage": false,

2
lib/ansible/modules/cloud/vultr/_vultr_server_facts.py
View file

@ -73,7 +73,7 @@ vultr_server_facts:
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_server_facts": [
{
"allowed_bandwidth_gb": 1000,

2
lib/ansible/modules/cloud/vultr/_vultr_ssh_key_facts.py
View file

@ -73,7 +73,7 @@ ansible_facts:
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_ssh_key_facts": [
{
"date_created": "2018-02-24 15:04:01",

2
lib/ansible/modules/cloud/vultr/_vultr_startup_script_facts.py
View file

@ -73,7 +73,7 @@ vultr_startup_script_facts:
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_startup_script_facts": [
{
"date_created": "2018-07-19 08:38:36",

2
lib/ansible/modules/cloud/vultr/_vultr_user_facts.py
View file

@ -72,7 +72,7 @@ vultr_user_facts:
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_user_facts": [
{
"acls": [],

2
lib/ansible/modules/cloud/vultr/vultr_block_storage_info.py
View file

@ -102,7 +102,7 @@ vultr_block_storage_info:
description: Date created of the block storage.
returned: success
type: str
sample: 2018-07-24 12:59:59
sample: "2018-07-24 12:59:59"
status:
description: Status of the block storage.
returned: success

2
lib/ansible/modules/cloud/vultr/vultr_dns_domain_info.py
View file

@ -69,7 +69,7 @@ vultr_dns_domain_info:
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_dns_domain_info": [
{
"date_created": "2018-07-19 07:14:21",

2
lib/ansible/modules/cloud/vultr/vultr_firewall_group_info.py
View file

@ -69,7 +69,7 @@ vultr_firewall_group_info:
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_firewall_group_info": [
{
"date_created": "2018-07-12 10:27:14",

2
lib/ansible/modules/cloud/vultr/vultr_network_info.py
View file

@ -69,7 +69,7 @@ vultr_network_info:
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_network_info": [
{
"date_created": "2018-08-02 11:18:49",

2
lib/ansible/modules/cloud/vultr/vultr_region_info.py
View file

@ -70,7 +70,7 @@ vultr_region_info:
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_region_info": [
{
"block_storage": false,

2
lib/ansible/modules/cloud/vultr/vultr_server_info.py
View file

@ -70,7 +70,7 @@ vultr_server_info:
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_server_info": [
{
"allowed_bandwidth_gb": 1000,

2
lib/ansible/modules/cloud/vultr/vultr_startup_script_info.py
View file

@ -70,7 +70,7 @@ vultr_startup_script_info:
description: Response from Vultr API
returned: success
type: complex
contains:
sample:
"vultr_startup_script_info": [
{
"date_created": "2018-07-19 08:38:36",

4
lib/ansible/modules/net_tools/cloudflare_dns.py
View file

@ -288,7 +288,7 @@ record:
description: The record creation date.
returned: success
type: str
sample: 2016-03-25T19:09:42.516553Z
sample: "2016-03-25T19:09:42.516553Z"
data:
description: Additional record data.
returned: success, if type is SRV, DS, SSHFP or TLSA
@ -321,7 +321,7 @@ record:
description: Record modification date.
returned: success
type: str
sample: 2016-03-25T19:09:42.516553Z
sample: "2016-03-25T19:09:42.516553Z"
name:
description: The record name as FQDN (including _service and _proto for SRV).
returned: success

4
lib/ansible/modules/network/f5/bigip_device_info.py
View file

@ -3225,7 +3225,7 @@ ltm_pools:
type: str
sample: pass-through
current_sessions:
descriptions:
description:
- Current sessions.
returned: queried
type: int
@ -5586,7 +5586,7 @@ tcp_profiles:
type: bool
sample: no
mptcp_rto_max:
decription:
description:
- Specifies the number of RTOs (retransmission timeouts) before declaring
the subflow dead.
returned: queried

26
lib/ansible/modules/network/ingate/ig_config.py
View file

@ -268,7 +268,7 @@ add:
href:
description: The REST API URL to the added row
returned: success
type: string
type: str
sample: http://192.168.1.1/api/v1/misc/dns_servers/2
data:
description: Column names/values
@ -288,7 +288,7 @@ delete:
table:
description: The name of the table
returned: success
type: string
type: str
sample: misc.dns_servers
data:
description: Column names/values
@ -308,12 +308,12 @@ get:
table:
description: The name of the table
returned: success
type: string
type: str
sample: Testname
href:
description: The REST API URL to the row
returned: success
type: string
type: str
sample: http://192.168.1.1/api/v1/misc/dns_servers/1
data:
description: Column names/values
@ -333,18 +333,18 @@ modify:
table:
description: The name of the table
returned: success
type: string
type: str
sample: Testname
href:
description: The REST API URL to the modified row
returned: success
type: string
type: str
sample: http://192.168.1.1/api/v1/misc/dns_servers/1
data:
description: Column names/values
returned: success
type: complex
gsample: {'number': '2', 'server': '10.48.254.33'}
sample: {'number': '2', 'server': '10.48.254.33'}
id:
description: The row id
returned: success
@ -358,7 +358,7 @@ revert:
msg:
description: The command status message
returned: success
type: string
type: str
sample: reverted the configuration to the last applied configuration.
factory:
description: A command status message
@ -368,7 +368,7 @@ factory:
msg:
description: The command status message
returned: success
type: string
type: str
sample: reverted the configuration to the factory configuration.
store:
description: A command status message
@ -378,7 +378,7 @@ store:
msg:
description: The command status message
returned: success
type: string
type: str
sample: Successfully applied and saved the configuration.
return_rowid:
description: The matched row id(s).
@ -393,16 +393,16 @@ download:
config:
description: The configuration database
returned: success
type: string
type: str
filename:
description: A suggested name for the configuration
returned: success
type: string
type: str
sample: testname_2018-10-01T214040.cfg
mimetype:
description: The mimetype
returned: success
type: string
type: str
sample: application/x-config-database
'''

24
lib/ansible/modules/network/meraki/meraki_mx_l7_firewall.py
View file

@ -173,12 +173,12 @@ data:
policy:
description: Action to apply when rule is hit.
returned: success
type: string
type: str
sample: deny
type:
description: Type of rule category.
returned: success
type: string
type: str
sample: applications
applications:
description: List of applications within a category.
@ -187,12 +187,12 @@ data:
id:
description: URI of application.
returned: success
type: string
type: str
sample: Gmail
name:
description: Descriptive name of application.
returned: success
type: string
type: str
sample: meraki:layer7/application/4
applicationCategory:
description: List of application categories within a category.
@ -201,32 +201,32 @@ data:
id:
description: URI of application.
returned: success
type: string
type: str
sample: Gmail
name:
description: Descriptive name of application.
returned: success
type: string
type: str
sample: meraki:layer7/application/4
port:
description: Port number in rule.
returned: success
type: string
type: str
sample: 23
ipRange:
description: Range of IP addresses in rule.
returned: success
type: string
type: str
sample: 1.1.1.0/23
whitelistedCountries:
description: Countries to be whitelisted.
returned: success
type: string
type: str
sample: CA
blacklistedCountries:
description: Countries to be blacklisted.
returned: success
type: string
type: str
sample: RU
application_categories:
description: List of application categories and applications.
@ -240,12 +240,12 @@ data:
id:
description: URI of application.
returned: success
type: string
type: str
sample: Gmail
name:
description: Descriptive name of application.
returned: success
type: string
type: str
sample: meraki:layer7/application/4
id:
description: URI of application category.

30
lib/ansible/modules/network/meraki/meraki_nat.py
View file

@ -266,22 +266,22 @@ data:
name:
description: Name of NAT object.
returned: success, when 1:1 NAT object is in task
type: string
type: str
example: Web server behind NAT
lanIp:
description: Local IP address to be mapped.
returned: success, when 1:1 NAT object is in task
type: string
type: str
example: 192.168.128.22
publicIp:
description: Public IP address to be mapped.
returned: success, when 1:1 NAT object is in task
type: string
type: str
example: 148.2.5.100
uplink:
description: Internet port where rule is applied.
returned: success, when 1:1 NAT object is in task
type: string
type: str
example: internet1
allowedInbound:
description: List of inbound forwarding rules.
@ -291,12 +291,12 @@ data:
protocol:
description: Protocol to apply NAT rule to.
returned: success, when 1:1 NAT object is in task
type: string
type: str
example: tcp
destinationPorts:
description: Ports to apply NAT rule to.
returned: success, when 1:1 NAT object is in task
type: string
type: str
example: 80
allowedIps:
description: List of IP addresses to be forwarded.
@ -316,12 +316,12 @@ data:
publicIp:
description: Public IP address to be mapped.
returned: success, when 1:many NAT object is in task
type: string
type: str
example: 148.2.5.100
uplink:
description: Internet port where rule is applied.
returned: success, when 1:many NAT object is in task
type: string
type: str
example: internet1
portRules:
description: List of NAT port rules.
@ -331,12 +331,12 @@ data:
name:
description: Name of NAT object.
returned: success, when 1:many NAT object is in task
type: string
type: str
example: Web server behind NAT
protocol:
description: Protocol to apply NAT rule to.
returned: success, when 1:1 NAT object is in task
type: string
type: str
example: tcp
publicPort:
description: Destination port of the traffic that is arriving on WAN.
@ -346,7 +346,7 @@ data:
localIp:
description: Local IP address traffic will be forwarded.
returned: success, when 1:1 NAT object is in task
type: string
type: str
example: 192.0.2.10
localPort:
description: Destination port to be forwarded to.
@ -371,7 +371,7 @@ data:
lanIp:
description: Local IP address to be mapped.
returned: success, when port forwarding is in task
type: string
type: str
example: 192.168.128.22
allowedIps:
description: List of IP addresses to be forwarded.
@ -381,12 +381,12 @@ data:
name:
description: Name of NAT object.
returned: success, when port forwarding is in task
type: string
type: str
example: Web server behind NAT
protocol:
description: Protocol to apply NAT rule to.
returned: success, when port forwarding is in task
type: string
type: str
example: tcp
publicPort:
description: Destination port of the traffic that is arriving on WAN.
@ -401,7 +401,7 @@ data:
uplink:
description: Internet port where rule is applied.
returned: success, when port forwarding is in task
type: string
type: str
example: internet1
'''

20
lib/ansible/modules/network/meraki/meraki_static_route.py
View file

@ -149,27 +149,27 @@ data:
id:
description: Unique identification string assigned to each static route.
returned: success
type: string
type: str
sample: d6fa4821-1234-4dfa-af6b-ae8b16c20c39
net_id:
description: Identification string of network.
returned: query or update
type: string
type: str
sample: N_12345
name:
description: Name of static route.
returned: success
type: string
type: str
sample: Data Center static route
subnet:
description: CIDR notation subnet for static route.
returned: success
type: string
type: str
sample: 192.0.1.0/24
gatewayIp:
description: Next hop IP address.
returned: success
type: string
type: str
sample: 192.1.1.1
enabled:
description: Enabled state of static route.
@ -184,17 +184,17 @@ data:
start:
description: First address in reservation range, inclusive.
returned: query or update
type: string
type: str
sample: 192.0.1.2
end:
description: Last address in reservation range, inclusive.
returned: query or update
type: string
type: str
sample: 192.0.1.10
comment:
description: Human readable description of range.
returned: query or update
type: string
type: str
sample: Server range
fixedIpAssignments:
description: List of static MAC to IP address bindings.
@ -209,12 +209,12 @@ data:
ip:
description: IP address to be bound to the endpoint.
returned: query or update
type: string
type: str
sample: 192.0.1.11
name:
description: Hostname given to the endpoint.
returned: query or update
type: string
type: str
sample: JimLaptop
'''

4
lib/ansible/modules/network/meraki/meraki_syslog.py
View file

@ -122,12 +122,12 @@ data:
host:
description: Hostname or IP address of syslog server.
returned: success
type: string
type: str
sample: 192.0.1.1
port:
description: Port number for syslog communication.
returned: success
type: string
type: str
sample: 443
roles:
description: List of roles assigned to syslog server.

2
lib/ansible/modules/packaging/os/redhat_subscription.py
View file

@ -251,7 +251,7 @@ subscribed_pool_ids:
description: List of pool IDs to which system is now subscribed
returned: success
type: complex
contains: {
sample: {
"8a85f9815ab905d3015ab928c7005de4": "1"
}
'''

4
lib/ansible/modules/remote_management/manageiq/manageiq_group.py
View file

@ -201,12 +201,12 @@ group:
description: Group creation date
returned: success
type: str
example: 2018-08-12T08:37:55+00:00
sample: "2018-08-12T08:37:55+00:00"
updated_on:
description: Group update date
returned: success
type: int
example: 2018-08-12T08:37:55+00:00
sample: "2018-08-12T08:37:55+00:00"
'''
from ansible.module_utils.basic import AnsibleModule

31
lib/ansible/modules/storage/purestorage/_purefa_facts.py
View file

@ -69,8 +69,8 @@ ansible_facts:
description: Returns the facts collected from the FlashArray
returned: always
type: complex
contains:
"capacity": {}
sample: {
"capacity": {},
"config": {
"directory_service": {
"array_admin_group": null,
@ -135,7 +135,7 @@ ansible_facts:
"valid_to": "2027-08-09T23:09:06Z"
},
"syslog": []
}
},
"default": {
"array_name": "flasharray1",
"connected_arrays": 1,
@ -146,8 +146,8 @@ ansible_facts:
"purity_version": "5.0.4",
"snapshots": 1,
"volume_groups": 2
}
"hgroups": {}
},
"hgroups": {},
"hosts": {
"host1": {
"hgroup": null,
@ -180,13 +180,13 @@ ansible_facts:
"10000000C96C48D2"
]
}
}
},
"interfaces": {
"CT0.ETH4": "iqn.2010-06.com.purestorage:flasharray.2111b767484e4682",
"CT0.ETH5": "iqn.2010-06.com.purestorage:flasharray.2111b767484e4682",
"CT1.ETH4": "iqn.2010-06.com.purestorage:flasharray.2111b767484e4682",
"CT1.ETH5": "iqn.2010-06.com.purestorage:flasharray.2111b767484e4682"
}
},
"network": {
"ct0.eth0": {
"address": "10.10.10.10",
@ -254,7 +254,7 @@ ansible_facts:
],
"speed": 1000000000
}
}
},
"offload": {
"nfstarget": {
"address": "10.0.2.53",
@ -263,7 +263,7 @@ ansible_facts:
"protocol": "nfs",
"status": "scanning"
}
}
},
"performance": {
"input_per_sec": 8191,
"output_per_sec": 0,
@ -273,7 +273,7 @@ ansible_facts:
"usec_per_read_op": 0,
"usec_per_write_op": 642,
"writes_per_sec": 2
}
},
"pgroups": {
"consisgroup-07b6b983-986e-46f5-bdc3-deaa3dbb299e-cinder": {
"hgroups": null,
@ -284,7 +284,7 @@ ansible_facts:
"volume-1"
]
}
}
},
"pods": {
"srm-pod": {
"arrays": [
@ -303,22 +303,22 @@ ansible_facts:
],
"source": null
}
}
},
"snapshots": {
"consisgroup.cgsnapshot": {
"created": "2018-03-28T09:34:02Z",
"size": 13958643712,
"source": "volume-1"
}
}
"subnet": {}
},
"subnet": {},
"vgroups": {
"vvol--vSphere-HA-0ffc7dd1-vg": {
"volumes": [
"vvol--vSphere-HA-0ffc7dd1-vg/Config-aad5d7c6"
]
}
}
},
"volumes": {
"ansible_data": {
"bandwidth": null,
@ -333,6 +333,7 @@ ansible_facts:
"source": null
}
}
}
'''

19
lib/ansible/modules/storage/purestorage/_purefb_facts.py
View file

@ -69,7 +69,7 @@ ansible_facts:
description: Returns the facts collected from the FlashBlade
returned: always
type: complex
contains:
sample: {
"capacity": {
"aggregate": {
"data_reduction": 1.1179228,
@ -93,7 +93,7 @@ ansible_facts:
"virtual": 6477716992
},
"total": 83359896948925
}
},
"config": {
"alert_watchers": {
"enabled": true,
@ -188,7 +188,7 @@ ansible_facts:
"valid_from": "1508433967000",
"valid_to": "2458833967000"
}
}
},
"default": {
"blades": 15,
"buckets": 7,
@ -199,7 +199,7 @@ ansible_facts:
"purity_version": "2.2.0",
"snapshots": 1,
"total_capacity": 83359896948925
}
},
"filesystems": {
"k8s-pvc-d24b1357-579e-11e8-811f-ecf4bbc88f54": {
"destroyed": false,
@ -216,7 +216,7 @@ ansible_facts:
"provisioned": 1073741824,
"snapshot_enabled": false
}
}
},
"lag": {
"uplink": {
"lag_speed": 0,
@ -231,7 +231,7 @@ ansible_facts:
],
"status": "healthy"
}
}
},
"network": {
"fm1.admin0": {
"address": "10.10.100.6",
@ -277,7 +277,7 @@ ansible_facts:
"type": "vip",
"vlan": 2200
}
}
},
"performance": {
"aggregate": {
"bytes_per_op": 0,
@ -327,7 +327,7 @@ ansible_facts:
"write_bytes_per_sec": 0,
"writes_per_sec": 0
}
}
},
"snapshots": {
"z.188": {
"destroyed": false,
@ -335,7 +335,7 @@ ansible_facts:
"source_destroyed": false,
"suffix": "188"
}
}
},
"subnet": {
"new-mgmt": {
"gateway": "10.10.100.1",
@ -364,6 +364,7 @@ ansible_facts:
"vlan": 2200
}
}
}
'''

39
lib/ansible/modules/storage/purestorage/purefa_info.py
View file

@ -76,21 +76,21 @@ purefa_info:
description: Returns the information collected from the FlashArray
returned: always
type: complex
contains:
sample: {
"admins": {
"pureuser": {
"role": "array_admin",
"type": "local"
}
}
},
"apps": {
"offload": {
"description": "Snapshot offload to NFS or Amazon S3",
"status": "healthy",
"version": "5.2.1"
}
}
"arrays": {}
},
"arrays": {},
"capacity": {
"data_reduction": 11.664774599686346,
"free_space": 6995782867042,
@ -102,7 +102,7 @@ purefa_info:
"total_capacity": 7002920315199,
"total_reduction": 64.86821472825108,
"volume_space": 3781932919
}
},
"config": {
"directory_service": {
"base_dn": null,
@ -176,7 +176,7 @@ purefa_info:
"syslog": [
"udp://prod-ntp2.puretec.purestorage.com:333"
]
}
},
"default": {
"admins": 1,
"array_model": "FA-405",
@ -190,8 +190,8 @@ purefa_info:
"purity_version": "5.2.1",
"snapshots": 2,
"volume_groups": 1
}
"hgroups": {}
},
"hgroups": {},
"hosts": {
"@offload": {
"hgroup": null,
@ -216,11 +216,11 @@ purefa_info:
],
"wwn": []
}
}
},
"interfaces": {
"CT0.ETH4": "iqn.2010-06.com.purestorage:flasharray.2111b767484e4682",
"CT1.ETH4": "iqn.2010-06.com.purestorage:flasharray.2111b767484e4682",
}
},
"network": {
"@offload.data0": {
"address": "10.21.200.222",
@ -310,8 +310,8 @@ purefa_info:
],
"speed": 1000000000
}
}
"nfs_offload": {}
},
"nfs_offload": {},
"performance": {
"input_per_sec": 0,
"local_queue_usec_per_op": 0,
@ -328,7 +328,7 @@ purefa_info:
"usec_per_read_op": 0,
"usec_per_write_op": 0,
"writes_per_sec": 0
}
},
"pgroups": {
"test_pg": {
"hgroups": null,
@ -337,7 +337,7 @@ purefa_info:
"targets": null,
"volumes": null
}
}
},
"pods": {
"test": {
"arrays": [
@ -350,7 +350,7 @@ purefa_info:
],
"source": null
}
}
},
"s3_offload": {
"s3-offload": {
"access_key_id": "AKIAILNVEPWZTV4FGWZQ",
@ -358,15 +358,15 @@ purefa_info:
"protocol": "s3",
"status": "connected"
}
}
},
"snapshots": {
"@offload_boot.1": {
"created": "2019-03-14T15:29:20Z",
"size": 68719476736,
"source": "@offload_boot"
}
}
"subnet": {}
},
"subnet": {},
"vgroups": {
"test": {
"volumes": [
@ -374,7 +374,7 @@ purefa_info:
"test/test1"
]
}
}
},
"volumes": {
"@offload_boot": {
"bandwidth": null,
@ -401,6 +401,7 @@ purefa_info:
"source": null
}
}
}
'''

19
lib/ansible/modules/storage/purestorage/purefb_info.py
View file

@ -76,7 +76,7 @@ purefb_info:
description: Returns the information collected from the FlashBlade
returned: always
type: complex
contains:
sample: {
"capacity": {
"aggregate": {
"data_reduction": 1.1179228,
@ -100,7 +100,7 @@ purefb_info:
"virtual": 6477716992
},
"total": 83359896948925
}
},
"config": {
"alert_watchers": {
"enabled": true,
@ -195,7 +195,7 @@ purefb_info:
"valid_from": "1508433967000",
"valid_to": "2458833967000"
}
}
},
"default": {
"blades": 15,
"buckets": 7,
@ -206,7 +206,7 @@ purefb_info:
"purity_version": "2.2.0",
"snapshots": 1,
"total_capacity": 83359896948925
}
},
"filesystems": {
"k8s-pvc-d24b1357-579e-11e8-811f-ecf4bbc88f54": {
"destroyed": false,
@ -223,7 +223,7 @@ purefb_info:
"provisioned": 1073741824,
"snapshot_enabled": false
}
}
},
"lag": {
"uplink": {
"lag_speed": 0,
@ -238,7 +238,7 @@ purefb_info:
],
"status": "healthy"
}
}
},
"network": {
"fm1.admin0": {
"address": "10.10.100.6",
@ -284,7 +284,7 @@ purefb_info:
"type": "vip",
"vlan": 2200
}
}
},
"performance": {
"aggregate": {
"bytes_per_op": 0,
@ -334,7 +334,7 @@ purefb_info:
"write_bytes_per_sec": 0,
"writes_per_sec": 0
}
}
},
"snapshots": {
"z.188": {
"destroyed": false,
@ -342,7 +342,7 @@ purefb_info:
"source_destroyed": false,
"suffix": "188"
}
}
},
"subnet": {
"new-mgmt": {
"gateway": "10.10.100.1",
@ -371,6 +371,7 @@ purefb_info:
"vlan": 2200
}
}
}
'''

3
lib/ansible/modules/system/parted.py
View file

@ -115,8 +115,7 @@ partition_info:
partitions:
description: List of device partitions.
type: list
sample: >
{
sample: {
"disk": {
"dev": "/dev/sdb",
"logical_block": 512,

2
lib/ansible/modules/system/service_facts.py
View file

@ -67,7 +67,7 @@ ansible_facts:
status:
description: State of the service. Either C(enabled), C(disabled), or C(unknown).
returned: systemd systems or RedHat/SUSE flavored sysvinit/upstart
type: string
type: str
sample: enabled
name:
description: Name of the service.

2
lib/ansible/modules/system/systemd.py
View file

@ -137,7 +137,7 @@ status:
description: A dictionary with the key=value pairs returned from `systemctl show`
returned: success
type: complex
contains: {
sample: {
"ActiveEnterTimestamp": "Sun 2016-05-15 18:28:49 EDT",
"ActiveEnterTimestampMonotonic": "8135942",
"ActiveExitTimestampMonotonic": "0",

11
lib/ansible/modules/system/sysvinit.py
View file

@ -87,15 +87,15 @@ EXAMPLES = '''
- 5
'''
RETURN = '''
RETURN = r'''
results:
description: results from actions taken
returned: always
type: complex
contains:
"attempts": 1
"changed": true
"name": "apache2"
sample: {
"attempts": 1,
"changed": true,
"name": "apache2",
"status": {
"enabled": {
"changed": true,
@ -110,6 +110,7 @@ results:
"stdout": "Stopping web server: apache2.\n"
}
}
}
'''
import re

30
lib/ansible/modules/web_infrastructure/sophos_utm/utm_aaa_group.py
View file

@ -137,55 +137,55 @@ result:
contains:
_ref:
description: The reference name of the object.
type: string
type: str
_locked:
description: Whether or not the object is currently locked.
type: boolean
type: bool
_type:
description: The type of the object.
type: string
type: str
name:
description: The name of the object.
type: string
type: str
adirectory_groups:
description: List of Active Directory Groups.
type: string
type: str
adirectory_groups_sids:
description: List of Active Directory Groups SIDS.
type: list
backend_match:
description: The backend to use.
type: string
type: str
comment:
description: The comment string.
type: string
type: str
dynamic:
description: Whether the group match is ipsec_dn or directory_group.
type: string
type: str
edirectory_groups:
description: List of eDirectory Groups.
type: string
type: str
ipsec_dn:
description: ipsec_dn identifier to match.
type: string
type: str
ldap_attribute:
description: The LDAP Attribute to match against.
type: string
type: str
ldap_attribute_value:
description: The LDAP Attribute Value to match against.
type: string
type: str
members:
description: List of member identifiers of the group.
type: list
network:
description: The identifier of the network (network/aaa).
type: string
type: str
radius_group:
description: The radius group identifier.
type: string
type: str
tacacs_group:
description: The tacacs group identifier.
type: string
type: str
"""
from ansible.module_utils.utm_utils import UTM, UTMModule

30
lib/ansible/modules/web_infrastructure/sophos_utm/utm_aaa_group_info.py
View file

@ -54,55 +54,55 @@ result:
contains:
_ref:
description: The reference name of the object
type: string
type: str
_locked:
description: Whether or not the object is currently locked
type: boolean
type: bool
_type:
description: The type of the object
type: string
type: str
name:
description: The name of the object
type: string
type: str
adirectory_groups:
description: List of Active Directory Groups
type: string
type: str
adirectory_groups_sids:
description: List of Active Directory Groups SIDS
type: list
backend_match:
description: The backend to use
type: string
type: str
comment:
description: The comment string
type: string
type: str
dynamic:
description: Whether the group match is ipsec_dn or directory_group
type: string
type: str
edirectory_groups:
description: List of eDirectory Groups
type: string
type: str
ipsec_dn:
description: ipsec_dn identifier to match
type: string
type: str
ldap_attribute:
description: The LDAP Attribute to match against
type: string
type: str
ldap_attribute_value:
description: The LDAP Attribute Value to match against
type: string
type: str
members:
description: List of member identifiers of the group
type: list
network:
description: The identifier of the network (network/aaa)
type: string
type: str
radius_group:
description: The radius group identifier
type: string
type: str
tacacs_group:
description: The tacacs group identifier
type: string
type: str
"""
from ansible.module_utils.utm_utils import UTM, UTMModule

18
lib/ansible/modules/web_infrastructure/sophos_utm/utm_ca_host_key_cert.py
View file

@ -104,34 +104,34 @@ result:
contains:
_ref:
description: The reference name of the object
type: string
type: str
_locked:
description: Whether or not the object is currently locked
type: boolean
type: bool
_type:
description: The type of the object
type: string
type: str
name:
description: The name of the object
type: string
type: str
ca:
description: A reference to an existing utm_ca_signing_ca or utm_ca_verification_ca object.
type: string
type: str
meta:
description: A reference to an existing utm_ca_meta_x509 object.
type: string
type: str
certificate:
description: The certificate in PEM format
type: string
type: str
comment:
description: Comment string (may be empty string)
type: string
type: str
encrypted:
description: If encryption is enabled
type: bool
key:
description: Private key in PEM format (may be empty string)
type: string
type: str
"""
from ansible.module_utils.utm_utils import UTM, UTMModule

18
lib/ansible/modules/web_infrastructure/sophos_utm/utm_ca_host_key_cert_info.py
View file

@ -53,34 +53,34 @@ result:
contains:
_ref:
description: The reference name of the object
type: string
type: str
_locked:
description: Whether or not the object is currently locked
type: boolean
type: bool
_type:
description: The type of the object
type: string
type: str
name:
description: The name of the object
type: string
type: str
ca:
description: A reference to an existing utm_ca_signing_ca or utm_ca_verification_ca object.
type: string
type: str
meta:
description: A reference to an existing utm_ca_meta_x509 object.
type: string
type: str
certificate:
description: The certificate in PEM format
type: string
type: str
comment:
description: Comment string (may be empty string)
type: string
type: str
encrypted:
description: If encryption is enabled
type: bool
key:
description: Private key in PEM format (may be empty string)
type: string
type: str
"""
from ansible.module_utils.utm_utils import UTM, UTMModule

18
lib/ansible/modules/web_infrastructure/sophos_utm/utm_network_interface_address.py
View file

@ -82,31 +82,31 @@ result:
contains:
_ref:
description: The reference name of the object
type: string
type: str
_locked:
description: Whether or not the object is currently locked
type: boolean
type: bool
_type:
description: The type of the object
type: string
type: str
name:
description: The name of the object
type: string
type: str
address:
description: The ip4 address of the network/interface_address object
type: string
type: str
address6:
description: The ip6 address of the network/interface_address object
type: string
type: str
comment:
description: The comment string
type: string
type: str
resolved:
description: Whether or not the object is resolved
type: boolean
type: bool
resolved6:
description: Whether or not the object is resolved
type: boolean
type: bool
"""
from ansible.module_utils.utm_utils import UTM, UTMModule

18
lib/ansible/modules/web_infrastructure/sophos_utm/utm_network_interface_address_info.py
View file

@ -52,31 +52,31 @@ result:
contains:
_ref:
description: The reference name of the object
type: string
type: str
_locked:
description: Whether or not the object is currently locked
type: boolean
type: bool
_type:
description: The type of the object
type: string
type: str
name:
description: The name of the object
type: string
type: str
address:
description: The ip4 address of the network/interface_address object
type: string
type: str
address6:
description: The ip6 address of the network/interface_address object
type: string
type: str
comment:
description: The comment string
type: string
type: str
resolved:
description: Whether or not the object is resolved
type: boolean
type: bool
resolved6:
description: Whether or not the object is resolved
type: boolean
type: bool
"""
from ansible.module_utils.utm_utils import UTM, UTMModule

54
lib/ansible/modules/web_infrastructure/sophos_utm/utm_proxy_auth_profile.py
View file

@ -205,91 +205,91 @@ result:
contains:
_ref:
description: The reference name of the object
type: string
type: str
_locked:
description: Whether or not the object is currently locked
type: boolean
type: bool
_type:
description: The type of the object
type: string
type: str
name:
description: The name of the object
type: string
type: str
aaa:
description: List of references to utm_aaa objects (allowed users or groups)
type: list
basic_prompt:
description: The message in the basic authentication prompt
type: string
type: str
backend_mode:
description: Specifies if the backend server needs authentication ([Basic|None])
type: string
type: str
backend_strip_basic_auth:
description: Should the login data be stripped when proxying the request to the backend host
type: boolean
type: bool
backend_user_prefix:
description: Prefix string to prepend to the username for backend authentication
type: string
type: str
backend_user_suffix:
description: Suffix string to append to the username for backend authentication
type: string
type: str
comment:
description: Optional comment string
type: string
type: str
frontend_cookie:
description: Frontend cookie name
type: string
type: str
frontend_cookie_secret:
description: Frontend cookie secret
type: string
type: str
frontend_form:
description: Frontend authentication form name
type: string
type: str
frontend_form_template:
description: Frontend authentication form template
type: string
type: str
frontend_login:
description: Frontend login name
type: string
type: str
frontend_logout:
description: Frontend logout name
type: string
type: str
frontend_mode:
description: Frontend authentication mode (Form|Basic)
type: string
type: str
frontend_realm:
description: Frontend authentication realm
type: string
type: str
frontend_session_allow_persistency:
description: Allow session persistency
type: boolean
type: bool
frontend_session_lifetime:
description: session lifetime
type: integer
type: int
frontend_session_lifetime_limited:
description: Specifies if limitation of session lifetime is active
type: boolean
type: bool
frontend_session_lifetime_scope:
description: scope for frontend_session_lifetime (days|hours|minutes)
type: string
type: str
frontend_session_timeout:
description: session timeout
type: integer
type: int
frontend_session_timeout_enabled:
description: Specifies if session timeout is active
type: boolean
type: bool
frontend_session_timeout_scope:
description: scope for frontend_session_timeout (days|hours|minutes)
type: string
type: str
logout_delegation_urls:
description: List of logout URLs that logouts are delegated to
type: list
logout_mode:
description: Mode of logout (None|Delegation)
type: string
type: str
redirect_to_requested_url:
description: Should a redirect to the requested URL be made
type: boolean
type: bool
"""
from ansible.module_utils.utm_utils import UTM, UTMModule

18
lib/ansible/modules/web_infrastructure/sophos_utm/utm_proxy_exception.py
View file

@ -151,30 +151,30 @@ result:
contains:
_ref:
description: The reference name of the object
type: string
type: str
_locked:
description: Whether or not the object is currently locked
type: boolean
type: bool
_type:
description: The type of the object
type: string
type: str
name:
description: The name of the object
type: string
type: str
comment:
description: The optional comment string
op:
description: The operand to be used with the entries of the path parameter
type: string
type: str
path:
description: The paths the exception in the reverse proxy is defined for
type: array
type: list
skip_custom_threats_filters:
description: A list of threats to be skipped
type: array
type: list
skip_threats_filter_categories:
description: Define which categories of threats are skipped
type: array
type: list
skipav:
description: Skip the Antivirus Scanning
type: bool
@ -201,7 +201,7 @@ result:
type: bool
source:
description: Define which categories of threats are skipped
type: array
type: list
"""
from ansible.module_utils.utm_utils import UTM, UTMModule

20
lib/ansible/modules/web_infrastructure/sophos_utm/utm_proxy_frontend.py
View file

@ -154,31 +154,31 @@ result:
contains:
_ref:
description: The reference name of the object
type: string
type: str
_locked:
description: Whether or not the object is currently locked
type: boolean
type: bool
_type:
description: The type of the object
type: string
type: str
name:
description: The name of the object
type: string
type: str
add_content_type_header:
description: Whether to add the content type header
type: bool
address:
description: The reference name of the address
type: string
type: str
allowed_networks:
description: List of reference names of networks associated
type: list
certificate:
description: Reference name of certificate (ca/host_key_cert)
type: string
type: str
comment:
description: The comment string
type: string
type: str
disable_compression:
description: State of compression support
type: bool
@ -199,7 +199,7 @@ result:
type: bool
lbmethod:
description: The method of loadbalancer to use
type: string
type: str
locations:
description: The reference names of reverse_proxy/locations associated with the object
type: list
@ -211,13 +211,13 @@ result:
type: bool
profile:
description: The associated reverse_proxy/profile
type: string
type: str
status:
description: Whether the frontend object is active or not
type: bool
type:
description: The connection type
type: string
type: str
xheaders:
description: The xheaders state
type: bool

20
lib/ansible/modules/web_infrastructure/sophos_utm/utm_proxy_frontend_info.py
View file

@ -55,31 +55,31 @@ result:
contains:
_ref:
description: The reference name of the object
type: string
type: str
_locked:
description: Whether or not the object is currently locked
type: boolean
type: bool
_type:
description: The type of the object
type: string
type: str
name:
description: The name of the object
type: string
type: str
add_content_type_header:
description: Whether to add the content type header
type: bool
address:
description: The reference name of the address
type: string
type: str
allowed_networks:
description: List of reference names of networks associated
type: list
certificate:
description: Reference name of certificate (ca/host_key_cert)
type: string
type: str
comment:
description: The comment string
type: string
type: str
disable_compression:
description: State of compression support
type: bool
@ -100,7 +100,7 @@ result:
type: bool
lbmethod:
description: The method of loadbalancer to use
type: string
type: str
locations:
description: The reference names of reverse_proxy/locations associated with the object
type: list
@ -112,13 +112,13 @@ result:
type: bool
profile:
description: The associated reverse_proxy/profile
type: string
type: str
status:
description: Whether the frontend object is active or not
type: bool
type:
description: The connection type
type: string
type: str
xheaders:
description: The xheaders state
type: bool

24
lib/ansible/modules/web_infrastructure/sophos_utm/utm_proxy_location.py
View file

@ -121,34 +121,34 @@ result:
contains:
_ref:
description: The reference name of the object
type: string
type: str
_locked:
description: Whether or not the object is currently locked
type: boolean
type: bool
_type:
description: The type of the object
type: string
type: str
name:
description: The name of the object
type: string
type: str
access_control:
description: Whether to use access control state
type: string
type: str
allowed_networks:
description: List of allowed network reference names
type: list
auth_profile:
description: The auth profile reference name
type: string
type: str
backend:
description: The backend reference name
type: string
type: str
be_path:
description: The backend path
type: string
type: str
comment:
description: The comment string
type: string
type: str
denied_networks:
description: The list of the denied network names
type: list
@ -157,13 +157,13 @@ result:
type: bool
path:
description: Path name
type: string
type: str
status:
description: Whether the object is active or not
type: boolean
type: bool
stickysession_id:
description: The identifier of the stickysession
type: string
type: str
stickysession_status:
description: Whether to use stickysession or not
type: bool

24
lib/ansible/modules/web_infrastructure/sophos_utm/utm_proxy_location_info.py
View file

@ -54,34 +54,34 @@ result:
contains:
_ref:
description: The reference name of the object
type: string
type: str
_locked:
description: Whether or not the object is currently locked
type: boolean
type: bool
_type:
description: The type of the object
type: string
type: str
name:
description: The name of the object
type: string
type: str
access_control:
description: Whether to use access control state
type: string
type: str
allowed_networks:
description: List of allowed network reference names
type: list
auth_profile:
description: The auth profile reference name
type: string
type: str
backend:
description: The backend reference name
type: string
type: str
be_path:
description: The backend path
type: string
type: str
comment:
description: The comment string
type: string
type: str
denied_networks:
description: The list of the denied network names
type: list
@ -90,13 +90,13 @@ result:
type: bool
path:
description: Path name
type: string
type: str
status:
description: Whether the object is active or not
type: boolean
type: bool
stickysession_id:
description: The identifier of the stickysession
type: string
type: str
stickysession_status:
description: Whether to use stickysession or not
type: bool

2
lib/ansible/modules/windows/win_find.py
View file

@ -287,7 +287,7 @@ files:
sample: 1477984205.15
lnk_source:
description: The target of the symbolic link, will return null if not a link or the link is broken.
return: success, path exists, path is a symbolic link
returned: success, path exists, path is a symbolic link
type: str
sample: C:\temp
owner:

2
lib/ansible/modules/windows/win_stat.py
View file

@ -152,7 +152,7 @@ stat:
description: The name of the file (without path).
returned: success, path exists, path is a file
type: str
sammple: foo.ini
sample: foo.ini
hlnk_targets:
description: List of other files pointing to the same file (hard links), excludes the current file.
returned: success, path exists

23
test/sanity/ignore.txt
View file

@ -2130,13 +2130,29 @@ lib/ansible/modules/cloud/vmware/vsphere_copy.py validate-modules:undocumented-p
lib/ansible/modules/cloud/vmware/vsphere_copy.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/vultr/vultr_block_storage.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/cloud/vultr/vultr_block_storage.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/vultr/_vultr_block_storage_facts.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/vultr/vultr_dns_domain.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/vultr/_vultr_dns_domain_facts.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/vultr/vultr_dns_domain_info.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/vultr/vultr_dns_record.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/cloud/vultr/vultr_dns_record.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/vultr/vultr_firewall_group.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/vultr/_vultr_firewall_group_facts.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/vultr/vultr_firewall_group_info.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/vultr/vultr_firewall_rule.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/cloud/vultr/vultr_firewall_rule.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/vultr/vultr_network.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/vultr/_vultr_network_facts.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/vultr/vultr_network_info.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/vultr/_vultr_os_facts.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/vultr/_vultr_region_facts.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/vultr/vultr_region_info.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/vultr/_vultr_server_facts.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/vultr/vultr_server_info.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/vultr/_vultr_ssh_key_facts.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/vultr/_vultr_startup_script_facts.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/vultr/vultr_startup_script_info.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/vultr/_vultr_user_facts.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/webfaction/webfaction_app.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/webfaction/webfaction_db.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/webfaction/webfaction_domain.py validate-modules:parameter-type-not-in-doc
@ -4988,6 +5004,7 @@ lib/ansible/modules/packaging/os/pulp_repo.py validate-modules:doc-default-does-
lib/ansible/modules/packaging/os/pulp_repo.py validate-modules:doc-missing-type
lib/ansible/modules/packaging/os/redhat_subscription.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/packaging/os/redhat_subscription.py validate-modules:doc-missing-type
lib/ansible/modules/packaging/os/redhat_subscription.py validate-modules:return-syntax-error
lib/ansible/modules/packaging/os/rhn_channel.py validate-modules:undocumented-parameter
lib/ansible/modules/packaging/os/rhn_channel.py validate-modules:doc-choices-do-not-match-spec
lib/ansible/modules/packaging/os/rhn_channel.py validate-modules:parameter-type-not-in-doc
@ -5428,8 +5445,12 @@ lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py validate-modules:doc-
lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py validate-modules:implied-parameter-type-mismatch
lib/ansible/modules/storage/netapp/netapp_e_volume_copy.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/storage/purestorage/purefa_dsrole.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/storage/purestorage/_purefa_facts.py validate-modules:return-syntax-error
lib/ansible/modules/storage/purestorage/purefa_info.py validate-modules:return-syntax-error
lib/ansible/modules/storage/purestorage/purefa_pgsnap.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/storage/purestorage/_purefb_facts.py validate-modules:return-syntax-error
lib/ansible/modules/storage/purestorage/purefb_fs.py validate-modules:doc-default-does-not-match-spec
lib/ansible/modules/storage/purestorage/purefb_info.py validate-modules:return-syntax-error
lib/ansible/modules/storage/zfs/zfs.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/storage/zfs/zfs_delegate_admin.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/storage/zfs/zfs_facts.py validate-modules:nonexistent-parameter-documented
@ -5490,7 +5511,9 @@ lib/ansible/modules/system/sysctl.py validate-modules:doc-missing-type
lib/ansible/modules/system/syspatch.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/system/systemd.py validate-modules:parameter-invalid
lib/ansible/modules/system/systemd.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/system/systemd.py validate-modules:return-syntax-error
lib/ansible/modules/system/sysvinit.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/system/sysvinit.py validate-modules:return-syntax-error
lib/ansible/modules/system/timezone.py pylint:blacklisted-name
lib/ansible/modules/system/user.py validate-modules:use-run-command-not-popen
lib/ansible/modules/system/user.py validate-modules:doc-default-does-not-match-spec