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

Fix return value documentation (1/2) (#63477)

Browse source 
* Fix return value documentation (1/2).
* Avoid validation errors for missing 'contains:'.
This commit is contained in:
Felix Fontein 2019-10-15 17:03:08 +02:00 • committed by Alicia Cozine
parent 16e49fdd44
commit 6bea1597cc
50 changed files with 183 additions and 165 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

12
lib/ansible/modules/cloud/hcloud/hcloud_floating_ip.py
View file

@ -123,32 +123,32 @@ hcloud_floating_ip:
sample: 12345
name:
description: Name of the Floating IP
type: string
type: str
returned: Always
sample: my-floating-ip
description:
description: Description of the Floating IP
type: string
type: str
returned: Always
sample: my-floating-ip
ip:
description: IP Address of the Floating IP
type: string
type: str
returned: Always
sample: 116.203.104.109
type:
description: Type of the Floating IP
type: string
type: str
returned: Always
sample: ipv4
home_location:
description: Name of the home location of the Floating IP
type: string
type: str
returned: Always
sample: fsn1
server:
description: Name of the server the Floating IP is assigned to.
type: string
type: str
returned: Always
sample: "my-server"
labels:

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:

8
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:
@ -133,12 +133,12 @@ hcloud_volume:
linux_device:
description: Path to the device that contains the volume.
returned: always
type: src
type: str
sample: /dev/disk/by-id/scsi-0HC_Volume_12345
version_added: "2.10"
location:
description: Location name where the volume is located at
type: string
type: str
returned: Always
sample: "fsn1"
labels:
@ -150,7 +150,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/hcloud/hcloud_volume_info.py
View file

@ -76,7 +76,7 @@ hcloud_volume_info:
linux_device:
description: Path to the device that contains the volume.
returned: always
type: src
type: str
sample: /dev/disk/by-id/scsi-0HC_Volume_12345
version_added: "2.10"
location:

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

19
test/sanity/ignore.txt
View file

@ -1559,6 +1559,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
@ -1633,6 +1637,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
@ -1991,26 +1996,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