wbrawner/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[2.9] Fix return value documentation (#63529)

Browse source 
* Fix return value documentation (1/2) (#63477)
* Avoid validation errors for missing 'contains:'.

(cherry picked from commit 6bea1597cc)

* Fix return value documentation (2/2) (#63478)
* Avoid validation errors for missing 'contains:'.
* Convert JSON text to JSON dict.
* example -> sample.
* Fix YAML.

(cherry picked from commit 4bc298af83)
This commit is contained in:
Felix Fontein 2019-10-16 17:21:50 +02:00 committed by Alicia Cozine
parent 7a326e876b
commit bbc7c2d2ea
97 changed files with 602 additions and 557 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
lib/ansible/modules/cloud/amazon/aws_codebuild.py
View file

@ -195,19 +195,19 @@ project:
type: complex
contains:
name:
descriptoin: Name of the CodeBuild project
description: Name of the CodeBuild project
returned: always
type: string
type: str
sample: my_project
arn:
description: ARN of the CodeBuild project
returned: always
type: string
type: str
sample: arn:aws:codebuild:us-east-1:123123123:project/vod-api-app-builder
description:
description: A description of the build project
returned: always
type: string
type: str
sample: My nice little project
source:
description: Information about the build input source code.
@ -217,12 +217,12 @@ project:
type:
description: The type of the repository
returned: always
type: string
type: str
sample: CODEPIPELINE
location:
description: Location identifier, depending on the source type.
returned: when configured
type: string
type: str
git_clone_depth:
description: The git clone depth
returned: when configured
@ -230,9 +230,9 @@ project:
build_spec:
description: The build spec declaration to use for the builds in this build project.
returned: always
type: string
type: str
auth:
desription: Information about the authorization settings for AWS CodeBuild to access the source code to be built.
description: Information about the authorization settings for AWS CodeBuild to access the source code to be built.
returned: when configured
type: complex
insecure_ssl:
@ -247,12 +247,12 @@ project:
type:
description: The type of build artifact.
returned: always
type: string
type: str
sample: CODEPIPELINE
location:
description: Output location for build artifacts
returned: when configured
type: string
type: str
# and more... see http://boto3.readthedocs.io/en/latest/reference/services/codebuild.html#CodeBuild.Client.create_project
cache:
description: Cache settings for the build project.
@ -265,7 +265,7 @@ project:
service_role:
description: IAM role to be used during build to access other AWS services.
returned: always
type: string
type: str
sample: arn:aws:iam::123123123:role/codebuild-service-role
timeout_in_minutes:
description: The timeout of a build in minutes
@ -279,8 +279,8 @@ project:
created:
description: Timestamp of the create time of the project
returned: always
type: string
sample: 2018-04-17T16:56:03.245000+02:00
type: str
sample: "2018-04-17T16:56:03.245000+02:00"
'''
from ansible.module_utils.aws.core import AnsibleAWSModule, get_boto3_client_method_parameters

10
lib/ansible/modules/cloud/amazon/aws_codepipeline.py
View file

@ -146,12 +146,12 @@ pipeline:
name:
description: Name of the CodePipeline
returned: always
type: string
type: str
sample: my_deploy_pipeline
role_arn:
description: ARN of the IAM role attached to the code pipeline
returned: always
type: string
type: str
sample: arn:aws:iam::123123123:role/codepipeline-service-role
artifact_store:
description: Information about where the build artifacts are stored
@ -161,17 +161,17 @@ pipeline:
type:
description: The type of the artifacts store, such as S3
returned: always
type: string
type: str
sample: S3
location:
description: The location of the artifacts storage (s3 bucket name)
returned: always
type: string
type: str
sample: my_s3_codepipline_bucket
encryption_key:
description: The encryption key used to encrypt the artifacts store, such as an AWS KMS key.
returned: when configured
type: string
type: str
stages:
description: List of stages configured for this pipeline
returned: always

2
lib/ansible/modules/cloud/amazon/aws_kms.py
View file

@ -305,7 +305,7 @@ grants:
description: Date of creation of the grant
type: str
returned: always
sample: 2017-04-18T15:12:08+10:00
sample: "2017-04-18T15:12:08+10:00"
grant_id:
description: The unique ID for the grant
type: str

4
lib/ansible/modules/cloud/amazon/aws_kms_info.py
View file

@ -103,7 +103,7 @@ keys:
description: Date of creation of the key
type: str
returned: always
sample: 2017-04-18T15:12:08.551000+10:00
sample: "2017-04-18T15:12:08.551000+10:00"
description:
description: Description of the key
type: str
@ -179,7 +179,7 @@ keys:
description: Date of creation of the grant
type: str
returned: always
sample: 2017-04-18T15:12:08+10:00
sample: "2017-04-18T15:12:08+10:00"
grant_id:
description: The unique ID for the grant
type: str

8
lib/ansible/modules/cloud/amazon/aws_secret.py
View file

@ -94,22 +94,22 @@ secret:
arn:
description: The ARN of the secret
returned: always
type: string
type: str
sample: arn:aws:secretsmanager:eu-west-1:xxxxxxxxxx:secret:xxxxxxxxxxx
last_accessed_date:
description: The date the secret was last accessed
returned: always
type: string
type: str
sample: '2018-11-20T01:00:00+01:00'
last_changed_date:
description: The date the secret was last modified.
returned: always
type: string
type: str
sample: '2018-11-20T12:16:38.433000+01:00'
name:
description: The secret name.
returned: always
type: string
type: str
sample: my_secret
rotation_enabled:
description: The secret rotation status.

40
lib/ansible/modules/cloud/amazon/ec2_vpc_vpn_info.py
View file

@ -120,26 +120,26 @@ vpn_connections:
returned: always
type: int
sample: 0
last_status_change:
description: The date and time of the last change in status.
returned: always
type: datetime
sample: 2018-02-09T14:35:27+00:00
outside_ip_address:
description: The Internet-routable IP address of the virtual private gateway's outside interface.
returned: always
type: str
sample: 13.127.79.191
status:
description: The status of the VPN tunnel.
returned: always
type: str
sample: DOWN
status_message:
description: If an error occurs, a description of the error.
returned: always
type: str
sample: IPSEC IS DOWN
last_status_change:
description: The date and time of the last change in status.
returned: always
type: datetime
sample: "2018-02-09T14:35:27+00:00"
outside_ip_address:
description: The Internet-routable IP address of the virtual private gateway's outside interface.
returned: always
type: str
sample: 13.127.79.191
status:
description: The status of the VPN tunnel.
returned: always
type: str
sample: DOWN
status_message:
description: If an error occurs, a description of the error.
returned: always
type: str
sample: IPSEC IS DOWN
vpn_connection_id:
description: The ID of the VPN connection.
returned: always

6
lib/ansible/modules/cloud/amazon/elb_target_group_info.py
View file

@ -162,7 +162,7 @@ target_groups:
health_check_port:
description: The port to check target health.
returned: always
type: string
type: str
sample: '80'
target:
description: The target metadata.
@ -172,7 +172,7 @@ target_groups:
id:
description: The ID of the target.
returned: always
type: string
type: str
sample: i-0123456789
port:
description: The port to use to connect with the target.
@ -187,7 +187,7 @@ target_groups:
state:
description: The state of the target health.
returned: always
type: string
type: str
sample: healthy
target_group_name:
description: The name of the target group.

66
lib/ansible/modules/cloud/amazon/rds.py
View file

@ -269,67 +269,67 @@ instance:
engine:
description: the name of the database engine
returned: when RDS instance exists
type: string
type: str
sample: "oracle-se"
engine_version:
description: the version of the database engine
returned: when RDS instance exists
type: string
type: str
sample: "11.2.0.4.v6"
license_model:
description: the license model information
returned: when RDS instance exists
type: string
type: str
sample: "bring-your-own-license"
character_set_name:
description: the name of the character set that this instance is associated with
returned: when RDS instance exists
type: string
type: str
sample: "AL32UTF8"
allocated_storage:
description: the allocated storage size in gigabytes (GB)
returned: when RDS instance exists
type: string
type: str
sample: "100"
publicly_accessible:
description: the accessibility options for the DB instance
returned: when RDS instance exists
type: boolean
type: bool
sample: "true"
latest_restorable_time:
description: the latest time to which a database can be restored with point-in-time restore
returned: when RDS instance exists
type: string
type: str
sample: "1489707802.0"
secondary_availability_zone:
description: the name of the secondary AZ for a DB instance with multi-AZ support
returned: when RDS instance exists and is multy-AZ
type: string
type: str
sample: "eu-west-1b"
backup_window:
description: the daily time range during which automated backups are created if automated backups are enabled
returned: when RDS instance exists and automated backups are enabled
type: string
type: str
sample: "03:00-03:30"
auto_minor_version_upgrade:
description: indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window
returned: when RDS instance exists
type: boolean
type: bool
sample: "true"
read_replica_source_dbinstance_identifier:
description: the identifier of the source DB instance if this RDS instance is a read replica
returned: when read replica RDS instance exists
type: string
type: str
sample: "null"
db_name:
description: the name of the database to create when the DB instance is created
returned: when RDS instance exists
type: string
type: str
sample: "ASERTG"
endpoint:
description: the endpoint uri of the database instance
returned: when RDS instance exists
type: string
type: str
sample: "my-ansible-database.asdfaosdgih.us-east-1.rds.amazonaws.com"
port:
description: the listening port of the database instance
@ -344,12 +344,12 @@ instance:
parameter_apply_status:
description: the status of parameter updates
returned: when RDS instance exists
type: string
type: str
sample: "in-sync"
parameter_group_name:
description: the name of the DP parameter group
returned: when RDS instance exists
type: string
type: str
sample: "testawsrpprodb01spfile-1ujg7nrs7sgyz"
option_groups:
description: the list of option group memberships for this RDS instance
@ -359,12 +359,12 @@ instance:
option_group_name:
description: the option group name for this RDS instance
returned: when RDS instance exists
type: string
type: str
sample: "default:oracle-se-11-2"
status:
description: the status of the RDS instance's option group membership
returned: when RDS instance exists
type: string
type: str
sample: "in-sync"
pending_modified_values:
description: a dictionary of changes to the RDS instance that are pending
@ -374,47 +374,47 @@ instance:
db_instance_class:
description: the new DB instance class for this RDS instance that will be applied or is in progress
returned: when RDS instance exists
type: string
type: str
sample: "null"
db_instance_identifier:
description: the new DB instance identifier this RDS instance that will be applied or is in progress
returned: when RDS instance exists
type: string
type: str
sample: "null"
allocated_storage:
description: the new allocated storage size for this RDS instance that will be applied or is in progress
returned: when RDS instance exists
type: string
type: str
sample: "null"
backup_retention_period:
description: the pending number of days for which automated backups are retained
returned: when RDS instance exists
type: string
type: str
sample: "null"
engine_version:
description: indicates the database engine version
returned: when RDS instance exists
type: string
type: str
sample: "null"
iops:
description: the new provisioned IOPS value for this RDS instance that will be applied or is being applied
returned: when RDS instance exists
type: string
type: str
sample: "null"
master_user_password:
description: the pending or in-progress change of the master credentials for this RDS instance
returned: when RDS instance exists
type: string
type: str
sample: "null"
multi_az:
description: indicates that the single-AZ RDS instance is to change to a multi-AZ deployment
returned: when RDS instance exists
type: string
type: str
sample: "null"
port:
description: specifies the pending port for this RDS instance
returned: when RDS instance exists
type: string
type: str
sample: "null"
db_subnet_groups:
description: information on the subnet group associated with this RDS instance
@ -424,17 +424,17 @@ instance:
description:
description: the subnet group associated with the DB instance
returned: when RDS instance exists
type: string
type: str
sample: "Subnets for the UAT RDS SQL DB Instance"
name:
description: the name of the DB subnet group
returned: when RDS instance exists
type: string
type: str
sample: "samplesubnetgrouprds-j6paiqkxqp4z"
status:
description: the status of the DB subnet group
returned: when RDS instance exists
type: string
type: str
sample: "complete"
subnets:
description: the description of the DB subnet group
@ -449,22 +449,22 @@ instance:
name:
description: availability zone
returned: when RDS instance exists
type: string
type: str
sample: "eu-west-1b"
provisioned_iops_capable:
description: whether provisioned iops are available in AZ subnet
returned: when RDS instance exists
type: boolean
type: bool
sample: "false"
identifier:
description: the identifier of the subnet
returned: when RDS instance exists
type: string
type: str
sample: "subnet-3fdba63e"
status:
description: the status of the subnet
returned: when RDS instance exists
type: string
type: str
sample: "active"
'''

2
lib/ansible/modules/cloud/amazon/rds_subnet_group.py
View file

@ -78,7 +78,7 @@ subnet_group:
subnet_ids:
description: Contains a list of Subnet IDs
returned: I(state=present)
type: array
type: list
status:
description: The status of the DB subnet group
returned: I(state=present)

2
lib/ansible/modules/cloud/amazon/redshift.py
View file

@ -214,7 +214,7 @@ cluster:
enhanced_vpc_routing:
description: status of the enhanced vpc routing feature.
returned: success
type: boolean
type: bool
'''
try:

2
lib/ansible/modules/cloud/azure/azure_rm_automationaccount_info.py
View file

@ -202,7 +202,7 @@ automation_accounts:
limit:
description:
- Max limit, C(-1) for unlimited.
type: long
type: int
returned: always
sample: -1
name:

2
lib/ansible/modules/cloud/azure/azure_rm_containerregistry_info.py
View file

@ -110,7 +110,7 @@ registries:
credentials:
description:
- Credentials, fields will be empty if admin user is not enabled for ACR.
return: when C(retrieve_credentials) is set and C(admin_user_enabled) is set on ACR
returned: when C(retrieve_credentials) is set and C(admin_user_enabled) is set on ACR
type: complex
contains:
username:

2
lib/ansible/modules/cloud/azure/azure_rm_devtestlabvirtualmachine_info.py
View file

@ -106,7 +106,7 @@ virtualmachines:
- Virtual machine expiration date.
returned: always
type: str
sample: 2029-02-22T01:49:12.117974Z
sample: "2029-02-22T01:49:12.117974Z"
image:
description:
- Gallery image reference.

14
lib/ansible/modules/cloud/azure/azure_rm_dnsrecordset.py
View file

@ -187,43 +187,43 @@ state:
fqdn:
description:
- Fully qualified domain name of the record set.
return: always
returned: always
type: str
sample: www.b57dc95985712e4523282.com
etag:
description:
- The etag of the record set.
return: always
returned: always
type: str
sample: 692c3e92-a618-46fc-aecd-8f888807cd6c
provisioning_state:
description:
- The DNS record set state.
return: always
returned: always
type: str
sample: Succeeded
target_resource:
description:
- The target resource of the record set.
return: always
returned: always
type: dict
sample: {}
ttl:
description:
- The TTL(time-to-live) of the records in the records set.
return: always
returned: always
type: int
sample: 3600
type:
description:
- The type of DNS record in this record set.
return: always
returned: always
type: str
sample: A
arecords:
description:
- A list of records in the record set.
return: always
returned: always
type: list
sample: [
{

2
lib/ansible/modules/cloud/azure/azure_rm_hdinsightcluster_info.py
View file

@ -114,7 +114,7 @@ clusters:
description:
- The list of roles in the cluster.
type: list
suboptions:
contains:
name:
description:
- The name of the role.

22
lib/ansible/modules/cloud/azure/azure_rm_publicipaddress.py
View file

@ -131,7 +131,7 @@ state:
dns_settings:
description:
- The FQDN of the DNS record associated with the public IP address.
returns: always
returned: always
type: dict
sample: {
"domain_name_label": "ansible-b57dc95985712e45eb8b9c2e",
@ -141,49 +141,49 @@ state:
etag:
description:
- A unique read-only string that changes whenever the resource is updated.
returns: always
returned: always
type: str
sample: "W/'1905ee13-7623-45b1-bc6b-4a12b2fb9d15'"
idle_timeout_in_minutes:
description:
- The idle timeout of the public IP address.
returns: always
returned: always
type: int
sample: 4
ip_address:
description:
- The Public IP Prefix this Public IP Address should be allocated from.
returns: always
returned: always
type: str
sample: 52.160.103.93
location:
description:
- Resource location.
returns: always
returned: always
type: str
example: eastus
name:
description:
- Name of the Public IP Address.
returns: always
returned: always
type: str
example: publicip002
provisioning_state:
description:
- The provisioning state of the Public IP resource.
returns: always
returned: always
type: str
example: Succeeded
public_ip_allocation_method:
description:
- The public IP allocation method.
returns: always
returned: always
type: str
sample: static
public_ip_address_version:
description:
- The public IP address version.
returns: always
returned: always
type: str
sample: ipv4
sku:
@ -195,7 +195,7 @@ state:
tags:
description:
- The resource tags.
returns: always
returned: always
type: dict
sample: {
"delete": "on-exit",
@ -204,7 +204,7 @@ state:
type:
description:
- Type of the resource.
returns: always
returned: always
type: str
sample: "Microsoft.Network/publicIPAddresses"
'''

2
lib/ansible/modules/cloud/azure/azure_rm_resource.py
View file

@ -203,7 +203,7 @@ response:
"tier": "Standard"
}
tags:
decription:
description:
- Resource tags.
type: dict
returned: always

2
lib/ansible/modules/cloud/azure/azure_rm_roleassignment_info.py
View file

@ -78,7 +78,7 @@ roleassignments:
returned: always
sample: myRoleAssignment
type:
descripition:
description:
- Type of role assignment.
type: str
returned: always

2
lib/ansible/modules/cloud/azure/azure_rm_securitygroup_info.py
View file

@ -209,7 +209,7 @@ securitygroups:
"securityRules": []
}
tags:
descripition:
description:
- Tags to assign to the security group.
returned: always
type: dict

1
lib/ansible/modules/cloud/azure/azure_rm_subnet_info.py
View file

@ -118,7 +118,6 @@ subnets:
- The type of the endpoint service.
returned: always
type: str
required: True
sample: Microsoft.Sql
locations:
description:

2
lib/ansible/modules/cloud/azure/azure_rm_virtualnetwork.py
View file

@ -160,7 +160,7 @@ state:
type: dict
sample: { 'key1':'value1' }
type:
descriptioin:
description:
- Resource type.
returned: always
type: str

2
lib/ansible/modules/cloud/hcloud/hcloud_network.py
View file

@ -88,7 +88,7 @@ hcloud_network:
sample: 12345
name:
description: Name of the Network
type: string
type: str
returned: always
sample: my-volume
ip_range:

2
lib/ansible/modules/cloud/hcloud/hcloud_rdns.py
View file

@ -86,7 +86,7 @@ hcloud_rdns:
sample: my-server
ip_address:
description: The IP address that point to the DNS ptr
type: string
type: str
returned: always
sample: 123.123.123.123
dns_ptr:

6
lib/ansible/modules/cloud/hcloud/hcloud_ssh_key.py
View file

@ -97,17 +97,17 @@ hcloud_ssh_key:
sample: 12345
name:
description: Name of the ssh_key
type: string
type: str
returned: Always
sample: my-ssh-key
fingerprint:
description: Fingerprint of the ssh_key
type: string
type: str
returned: Always
sample: b7:2f:30:a0:2f:6c:58:6c:21:04:58:61:ba:06:3b:2f
public_key:
description: Public key of the ssh_key
type: string
type: str
returned: Always
sample: "ssh-rsa AAAjjk76kgf...Xt"
labels:

6
lib/ansible/modules/cloud/hcloud/hcloud_volume.py
View file

@ -122,7 +122,7 @@ hcloud_volume:
sample: 12345
name:
description: Name of the volume
type: string
type: str
returned: Always
sample: my-volume
size:
@ -132,7 +132,7 @@ hcloud_volume:
sample: 1337
location:
description: Location name where the volume is located at
type: string
type: str
returned: Always
sample: "fsn1"
labels:
@ -144,7 +144,7 @@ hcloud_volume:
mylabel: 123
server:
description: Server name where the volume is attached to
type: string
type: str
returned: Always
sample: "my-server"
"""

2
lib/ansible/modules/cloud/online/_online_server_facts.py
View file

@ -40,7 +40,7 @@ online_server_facts:
description: Response from Online API
returned: success
type: complex
contains:
sample:
"online_server_facts": [
{
"abuse": "abuse@example.com",

2
lib/ansible/modules/cloud/online/_online_user_facts.py
View file

@ -37,7 +37,7 @@ online_user_facts:
description: Response from Online API
returned: success
type: complex
contains:
sample:
"online_user_facts": {
"company": "foobar LLC",
"email": "foobar@example.com",

2
lib/ansible/modules/cloud/online/online_server_info.py
View file

@ -40,7 +40,7 @@ online_server_info:
description: Response from Online API
returned: success
type: complex
contains:
sample:
"online_server_info": [
{
"abuse": "abuse@example.com",

2
lib/ansible/modules/cloud/online/online_user_info.py
View file

@ -37,7 +37,7 @@ online_user_info:
description: Response from Online API
returned: success
type: complex
contains:
sample:
"online_user_info": {
"company": "foobar LLC",
"email": "foobar@example.com",

32
lib/ansible/modules/cloud/openstack/os_coe_cluster.py
View file

@ -86,27 +86,27 @@ cluster:
api_address:
description:
- Api address of cluster master node
type: string
type: str
sample: https://172.24.4.30:6443
cluster_template_id:
description: The cluster_template UUID
type: string
type: str
sample: '7b1418c8-cea8-48fc-995d-52b66af9a9aa'
coe_version:
description:
- Version of the COE software currently running in this cluster
type: string
type: str
sample: v1.11.1
container_version:
description:
- Version of the container software. Example: docker version.
type: string
- "Version of the container software. Example: docker version."
type: str
sample: 1.12.6
created_at:
description:
- The time in UTC at which the cluster is created
type: datetime
sample: 2018-08-16T10:29:45+00:00
sample: "2018-08-16T10:29:45+00:00"
create_timeout:
description:
- Timeout for creating the cluster in minutes. Default to 60 if
@ -116,7 +116,7 @@ cluster:
discovery_url:
description:
- Url used for cluster node discovery
type: string
type: str
sample: https://discovery.etcd.io/a42ee38e7113f31f4d6324f24367aae5
faults:
description:
@ -126,12 +126,12 @@ cluster:
flavor_id:
description:
- The flavor of the minion node for this cluster
type: string
type: str
sample: c1.c1r1
keypair:
description:
- Name of the keypair to use.
type: string
type: str
sample: mykey
labels:
description: One or more key/value pairs
@ -150,12 +150,12 @@ cluster:
master_flavor_id:
description:
- The flavor of the master node for this cluster
type: string
type: str
sample: c1.c1r1
name:
description:
- Name that has to be given to the cluster
type: string
type: str
sample: k8scluster
node_addresses:
description:
@ -170,26 +170,26 @@ cluster:
stack_id:
description:
- Stack id of the Heat stack
type: string
type: str
sample: '07767ec6-85f5-44cb-bd63-242a8e7f0d9d'
status:
description: Status of the cluster from the heat stack
type: string
type: str
sample: 'CREATE_COMLETE'
status_reason:
description:
- Status reason of the cluster from the heat stack
type: string
type: str
sample: 'Stack CREATE completed successfully'
updated_at:
description:
- The time in UTC at which the cluster is updated
type: datetime
type: str
sample: '2018-08-16T10:39:25+00:00'
uuid:
description:
- Unique UUID for this cluster
type: string
type: str
sample: '86246a4d-a16c-4a58-9e96ad7719fe0f9d'
'''

2
lib/ansible/modules/cloud/openstack/os_coe_cluster_template.py
View file

@ -177,7 +177,7 @@ cluster_template:
description:
- Indicates whether created clusters should have a floating ip or not
type: bool
default: true
sample: true
keypair_id:
description:
- Name or ID of the keypair to use.

6
lib/ansible/modules/cloud/openstack/os_group_info.py
View file

@ -92,15 +92,15 @@ openstack_groups:
name:
description: Name given to the group.
returned: success
type: string
type: str
description:
description: Description of the group.
returned: success
type: string
type: str
id:
description: Unique UUID.
returned: success
type: string
type: str
domain_id:
description: Domain ID containing the group (keystone v3 clouds only)
returned: success

2
lib/ansible/modules/cloud/openstack/os_quota.py
View file

@ -180,7 +180,7 @@ openstack_quotas:
description: Dictionary describing the project quota.
returned: Regardless if changes where made or not
type: complex
contains:
sample:
openstack_quotas: {
compute: {
cores: 150,

2
lib/ansible/modules/cloud/scaleway/_scaleway_image_facts.py
View file

@ -53,7 +53,7 @@ scaleway_image_facts:
description: Response from Scaleway API
returned: success
type: complex
contains:
sample:
"scaleway_image_facts": [
{
"arch": "x86_64",

2
lib/ansible/modules/cloud/scaleway/_scaleway_ip_facts.py
View file

@ -51,7 +51,7 @@ scaleway_ip_facts:
description: Response from Scaleway API
returned: success
type: complex
contains:
sample:
"scaleway_ip_facts": [
{
"address": "163.172.170.243",

2
lib/ansible/modules/cloud/scaleway/_scaleway_organization_facts.py
View file

@ -45,7 +45,7 @@ scaleway_organization_facts:
description: Response from Scaleway API
returned: success
type: complex
contains:
sample:
"scaleway_organization_facts": [
{
"address_city_name": "Paris",

2
lib/ansible/modules/cloud/scaleway/_scaleway_security_group_facts.py
View file

@ -51,7 +51,7 @@ scaleway_security_group_facts:
description: Response from Scaleway API
returned: success
type: complex
contains:
sample:
"scaleway_security_group_facts": [
{
"description": "test-ams",

2
lib/ansible/modules/cloud/scaleway/_scaleway_server_facts.py
View file

@ -51,7 +51,7 @@ scaleway_server_facts:
description: Response from Scaleway API
returned: success
type: complex
contains:
sample:
"scaleway_server_facts": [
{
"arch": "x86_64",

2
lib/ansible/modules/cloud/scaleway/_scaleway_snapshot_facts.py
View file

@ -51,7 +51,7 @@ scaleway_snapshot_facts:
description: Response from Scaleway API
returned: success
type: complex
contains:
sample:
"scaleway_snapshot_facts": [
{
"base_volume": {

2
lib/ansible/modules/cloud/scaleway/_scaleway_volume_facts.py
View file

@ -51,7 +51,7 @@ scaleway_volume_facts:
description: Response from Scaleway API
returned: success
type: complex
contains:
sample:
"scaleway_volume_facts": [
{
"creation_date": "2018-08-14T20:56:24.949660+00:00",

2
lib/ansible/modules/cloud/scaleway/scaleway_image_info.py
View file

@ -52,7 +52,7 @@ scaleway_image_info:
description: Response from Scaleway API
returned: success
type: complex
contains:
sample:
"scaleway_image_info": [
{
"arch": "x86_64",

2
lib/ansible/modules/cloud/scaleway/scaleway_ip_info.py
View file

@ -50,7 +50,7 @@ scaleway_ip_info:
description: Response from Scaleway API
returned: success
type: complex
contains:
sample:
"scaleway_ip_info": [
{
"address": "163.172.170.243",

2
lib/ansible/modules/cloud/scaleway/scaleway_organization_info.py
View file

@ -45,7 +45,7 @@ scaleway_organization_info:
description: Response from Scaleway API
returned: success
type: complex
contains:
sample:
"scaleway_organization_info": [
{
"address_city_name": "Paris",

2
lib/ansible/modules/cloud/scaleway/scaleway_security_group_info.py
View file

@ -50,7 +50,7 @@ scaleway_security_group_info:
description: Response from Scaleway API
returned: success
type: complex
contains:
sample:
"scaleway_security_group_info": [
{
"description": "test-ams",

2
lib/ansible/modules/cloud/scaleway/scaleway_server_info.py
View file

@ -50,7 +50,7 @@ scaleway_server_info:
description: Response from Scaleway API
returned: success
type: complex
contains:
sample:
"scaleway_server_info": [
{
"arch": "x86_64",

2
lib/ansible/modules/cloud/scaleway/scaleway_snapshot_info.py
View file

@ -50,7 +50,7 @@ scaleway_snapshot_info:
description: Response from Scaleway API
returned: success
type: complex
contains:
sample:
"scaleway_snapshot_info": [
{
"base_volume": {

2
lib/ansible/modules/cloud/scaleway/scaleway_volume_info.py
View file

@ -50,7 +50,7 @@ scaleway_volume_info:
description: Response from Scaleway API
returned: success
type: complex
contains:
sample:
"scaleway_volume_info": [
{
"creation_date": "2018-08-14T20:56:24.949660+00:00",

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",

20
lib/ansible/modules/database/postgresql/postgresql_info.py
View file

@ -182,16 +182,16 @@ databases:
returned: always
type: dict
contains:
major:
description: Extension major version.
returned: always
type: int
sample: 1
minor:
description: Extension minor version.
returned: always
type: int
sample: 0
major:
description: Extension major version.
returned: always
type: int
sample: 1
minor:
description: Extension minor version.
returned: always
type: int
sample: 0
nspname:
description: Namespace where the extension is.
returned: always

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

@ -270,7 +270,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
@ -303,7 +303,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

136
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
@ -3671,72 +3671,72 @@ ltm_policies:
returned: when conditions are defined in the rule.
type: complex
contains:
case_insensitive:
description:
- The value matched on is case insensitive.
returned: when defined in the condition.
type: bool
sample: no
case_sensitive:
description:
- The value matched on is case sensitive.
returned: when defined in the condition.
type: bool
sample: yes
contains_string:
description:
- The value matches if it contains a certain string.
returned: when defined in the condition.
type: bool
sample: yes
external:
description:
- The value matched on is from the external side of a connection.
returned: when defined in the condition.
type: bool
sample: yes
http_basic_auth:
description:
- This condition matches on basic HTTP authorization.
returned: when defined in the condition.
type: bool
sample: no
http_host:
description:
- This condition matches on an HTTP host.
returned: when defined in the condition.
type: bool
sample: yes
http_uri:
description:
- This condition matches on an HTTP URI.
returned: when defined in the condition.
type: bool
sample: no
request:
description:
- This policy will match on a request.
returned: when defined in the condition.
type: bool
sample: yes
username:
description:
- Matches on a username.
returned: when defined in the condition.
type: bool
sample: yes
all:
description:
- Matches all.
returned: when defined in the condition.
type: bool
sample: yes
values:
description:
- The specified values will be matched on.
returned: when defined in the condition.
type: list
sample: ['foo.bar.com', 'baz.cool.com']
case_insensitive:
description:
- The value matched on is case insensitive.
returned: when defined in the condition.
type: bool
sample: no
case_sensitive:
description:
- The value matched on is case sensitive.
returned: when defined in the condition.
type: bool
sample: yes
contains_string:
description:
- The value matches if it contains a certain string.
returned: when defined in the condition.
type: bool
sample: yes
external:
description:
- The value matched on is from the external side of a connection.
returned: when defined in the condition.
type: bool
sample: yes
http_basic_auth:
description:
- This condition matches on basic HTTP authorization.
returned: when defined in the condition.
type: bool
sample: no
http_host:
description:
- This condition matches on an HTTP host.
returned: when defined in the condition.
type: bool
sample: yes
http_uri:
description:
- This condition matches on an HTTP URI.
returned: when defined in the condition.
type: bool
sample: no
request:
description:
- This policy will match on a request.
returned: when defined in the condition.
type: bool
sample: yes
username:
description:
- Matches on a username.
returned: when defined in the condition.
type: bool
sample: yes
all:
description:
- Matches all.
returned: when defined in the condition.
type: bool
sample: yes
values:
description:
- The specified values will be matched on.
returned: when defined in the condition.
type: list
sample: ['foo.bar.com', 'baz.cool.com']
sample: hash/dictionary of values
sample: hash/dictionary of values
sample: hash/dictionary of values
@ -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
}
}
}
'''

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

@ -115,35 +115,34 @@ partition_info:
partitions:
description: List of device partitions.
type: list
sample: >
{
"disk": {
"dev": "/dev/sdb",
"logical_block": 512,
"model": "VMware Virtual disk",
"physical_block": 512,
"size": 5.0,
"table": "msdos",
"unit": "gib"
},
"partitions": [{
"begin": 0.0,
"end": 1.0,
"flags": ["boot", "lvm"],
"fstype": "",
"name": "",
"num": 1,
"size": 1.0
}, {
"begin": 1.0,
"end": 5.0,
"flags": [],
"fstype": "",
"name": "",
"num": 2,
"size": 4.0
}]
}
sample: {
"disk": {
"dev": "/dev/sdb",
"logical_block": 512,
"model": "VMware Virtual disk",
"physical_block": 512,
"size": 5.0,
"table": "msdos",
"unit": "gib"
},
"partitions": [{
"begin": 0.0,
"end": 1.0,
"flags": ["boot", "lvm"],
"fstype": "",
"name": "",
"num": 1,
"size": 1.0
}, {
"begin": 1.0,
"end": 5.0,
"flags": [],
"fstype": "",
"name": "",
"num": 2,
"size": 4.0
}]
}
'''
EXAMPLES = r'''

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",

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

@ -87,27 +87,28 @@ EXAMPLES = '''
- 5
'''
RETURN = '''
RETURN = r'''
results:
description: results from actions taken
returned: always
type: complex
contains:
"attempts": 1
"changed": true
"name": "apache2"
"status": {
"enabled": {
"changed": true,
"rc": 0,
"stderr": "",
"stdout": ""
},
"stopped": {
"changed": true,
"rc": 0,
"stderr": "",
"stdout": "Stopping web server: apache2.\n"
sample: {
"attempts": 1,
"changed": true,
"name": "apache2",
"status": {
"enabled": {
"changed": true,
"rc": 0,
"stderr": "",
"stdout": ""
},
"stopped": {
"changed": true,
"rc": 0,
"stderr": "",
"stdout": "Stopping web server: apache2.\n"
}
}
}
'''

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

42
test/sanity/ignore.txt
View file

@ -1568,6 +1568,10 @@ lib/ansible/modules/cloud/oneandone/oneandone_public_ip.py validate-modules:doc-
lib/ansible/modules/cloud/oneandone/oneandone_server.py validate-modules:doc-choices-do-not-match-spec
lib/ansible/modules/cloud/oneandone/oneandone_server.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/cloud/oneandone/oneandone_server.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/online/_online_server_facts.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/online/_online_user_facts.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/online/online_server_info.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/online/online_user_info.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/opennebula/one_host.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/cloud/opennebula/one_host.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/opennebula/one_image.py validate-modules:parameter-type-not-in-doc
@ -1642,6 +1646,7 @@ lib/ansible/modules/cloud/openstack/os_quota.py validate-modules:nonexistent-par
lib/ansible/modules/cloud/openstack/os_quota.py validate-modules:doc-choices-do-not-match-spec
lib/ansible/modules/cloud/openstack/os_quota.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/cloud/openstack/os_quota.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/openstack/os_quota.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/openstack/os_recordset.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/cloud/openstack/os_recordset.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/openstack/os_router.py validate-modules:parameter-type-not-in-doc
@ -2000,26 +2005,40 @@ lib/ansible/modules/cloud/rackspace/rax_scaling_policy.py validate-modules:doc-m
lib/ansible/modules/cloud/scaleway/scaleway_compute.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/cloud/scaleway/scaleway_compute.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/scaleway/_scaleway_image_facts.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/scaleway/_scaleway_image_facts.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/scaleway/scaleway_image_info.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/scaleway/scaleway_image_info.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/scaleway/scaleway_ip.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/scaleway/_scaleway_ip_facts.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/scaleway/_scaleway_ip_facts.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/scaleway/scaleway_ip_info.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/scaleway/scaleway_ip_info.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/scaleway/scaleway_lb.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/cloud/scaleway/scaleway_lb.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/scaleway/_scaleway_organization_facts.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/scaleway/scaleway_organization_info.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/scaleway/_scaleway_security_group_facts.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/scaleway/_scaleway_security_group_facts.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/scaleway/scaleway_security_group_info.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/scaleway/scaleway_security_group_info.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/scaleway/scaleway_security_group_rule.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/cloud/scaleway/_scaleway_server_facts.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/scaleway/_scaleway_server_facts.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/scaleway/scaleway_server_info.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/scaleway/scaleway_server_info.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/scaleway/_scaleway_snapshot_facts.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/scaleway/_scaleway_snapshot_facts.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/scaleway/scaleway_snapshot_info.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/scaleway/scaleway_snapshot_info.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/scaleway/scaleway_sshkey.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/scaleway/scaleway_user_data.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/cloud/scaleway/scaleway_user_data.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/scaleway/scaleway_volume.py validate-modules:parameter-type-not-in-doc
lib/ansible/modules/cloud/scaleway/scaleway_volume.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/scaleway/_scaleway_volume_facts.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/scaleway/_scaleway_volume_facts.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/scaleway/scaleway_volume_info.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/scaleway/scaleway_volume_info.py validate-modules:return-syntax-error
lib/ansible/modules/cloud/smartos/imgadm.py validate-modules:no-default-for-required-parameter
lib/ansible/modules/cloud/smartos/imgadm.py validate-modules:doc-missing-type
lib/ansible/modules/cloud/smartos/smartos_image_info.py validate-modules:doc-missing-type
@ -2120,13 +2139,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
@ -5002,6 +5037,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
@ -5442,8 +5478,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
@ -5504,7 +5544,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