archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Improve module return values (#63541) (#63644)

Browse Source 
* Remove lists from contains:, fix types, some more details.

* Adjust types.

* Add new type.

* Re-add meraki_mx_l7_firewall docs at right indentation level.

(cherry picked from commit a129499cf4)
pull/64756/head
Felix Fontein 6 years ago committed by Matt Davis
parent 2822744c68
commit f440c23dd7
15 changed files with 184 additions and 175 deletions
Show Stats Download Patch File Download Diff File

22
lib/ansible/modules/cloud/alicloud/ali_instance.py
Unescape Escape View File

@ -468,18 +468,18 @@ instances:
security_groups: security_groups:
description: One or more security groups for the instance. description: One or more security groups for the instance.
returned: always returned: always
type: complex type: list of complex
contains: contains:
- group_id: group_id:
description: The ID of the security group. description: The ID of the security group.
returned: always returned: always
type: str type: str
sample: sg-0123456 sample: sg-0123456
- group_name: group_name:
description: The name of the security group. description: The name of the security group.
returned: always returned: always
type: str type: str
sample: my-security-group sample: my-security-group
status: status:
description: The current status of the instance. description: The current status of the instance.
returned: always returned: always

22
lib/ansible/modules/cloud/alicloud/ali_instance_info.py
Unescape Escape View File

@ -309,18 +309,18 @@ instances:
security_groups: security_groups:
description: One or more security groups for the instance. description: One or more security groups for the instance.
returned: always returned: always
type: complex type: list of complex
contains: contains:
- group_id: group_id:
description: The ID of the security group. description: The ID of the security group.
returned: always returned: always
type: str type: str
sample: sg-0123456 sample: sg-0123456
- group_name: group_name:
description: The name of the security group. description: The name of the security group.
returned: always returned: always
type: str type: str
sample: my-security-group sample: my-security-group
status: status:
description: The current status of the instance. description: The current status of the instance.
returned: always returned: always

4
lib/ansible/modules/cloud/amazon/aws_codebuild.py
Unescape Escape View File

@ -257,11 +257,11 @@ project:
cache: cache:
description: Cache settings for the build project. description: Cache settings for the build project.
returned: when configured returned: when configured
type: complex type: dict
environment: environment:
description: Environment settings for the build description: Environment settings for the build
returned: always returned: always
type: complex type: dict
service_role: service_role:
description: IAM role to be used during build to access other AWS services. description: IAM role to be used during build to access other AWS services.
returned: always returned: always

4
lib/ansible/modules/cloud/amazon/aws_codecommit.py
Unescape Escape View File

@ -71,7 +71,7 @@ repository_metadata:
creation_date: creation_date:
description: "The date and time the repository was created, in timestamp format." description: "The date and time the repository was created, in timestamp format."
returned: when state is present returned: when state is present
type: datetime type: str
sample: "2018-10-16T13:21:41.261000+09:00" sample: "2018-10-16T13:21:41.261000+09:00"
last_modified_date: last_modified_date:
description: "The date and time the repository was last modified, in timestamp format." description: "The date and time the repository was last modified, in timestamp format."
@ -102,7 +102,7 @@ response_metadata:
http_headers: http_headers:
description: "http headers of http response" description: "http headers of http response"
returned: always returned: always
type: complex type: dict
http_status_code: http_status_code:
description: "http status code of http response" description: "http status code of http response"
returned: always returned: always

2
lib/ansible/modules/cloud/amazon/aws_secret.py
Unescape Escape View File

@ -119,7 +119,7 @@ secret:
version_ids_to_stages: version_ids_to_stages:
description: Provide the secret version ids and the associated secret stage. description: Provide the secret version ids and the associated secret stage.
returned: always returned: always
type: complex type: dict
sample: { "dc1ed59b-6d8e-4450-8b41-536dfe4600a9": [ "AWSCURRENT" ] } sample: { "dc1ed59b-6d8e-4450-8b41-536dfe4600a9": [ "AWSCURRENT" ] }
''' '''

128
lib/ansible/modules/cloud/amazon/ec2_instance.py
Unescape Escape View File

@ -477,18 +477,18 @@ instances:
groups: groups:
description: One or more security groups. description: One or more security groups.
returned: always returned: always
type: complex type: list of complex
contains: contains:
- group_id: group_id:
description: The ID of the security group. description: The ID of the security group.
returned: always returned: always
type: str type: str
sample: sg-abcdef12 sample: sg-abcdef12
group_name: group_name:
description: The name of the security group. description: The name of the security group.
returned: always returned: always
type: str type: str
sample: mygroup sample: mygroup
ipv6_addresses: ipv6_addresses:
description: One or more IPv6 addresses associated with the network interface. description: One or more IPv6 addresses associated with the network interface.
returned: always returned: always
@ -522,38 +522,38 @@ instances:
private_ip_addresses: private_ip_addresses:
description: The private IPv4 addresses associated with the network interface. description: The private IPv4 addresses associated with the network interface.
returned: always returned: always
type: complex type: list of complex
contains: contains:
- association: association:
description: The association information for an Elastic IP address (IPv4) associated with the network interface. description: The association information for an Elastic IP address (IPv4) associated with the network interface.
returned: always returned: always
type: complex type: complex
contains: contains:
ip_owner_id: ip_owner_id:
description: The ID of the owner of the Elastic IP address. description: The ID of the owner of the Elastic IP address.
returned: always returned: always
type: str type: str
sample: amazon sample: amazon
public_dns_name: public_dns_name:
description: The public DNS name. description: The public DNS name.
returned: always returned: always
type: str type: str
sample: "" sample: ""
public_ip: public_ip:
description: The public IP address or Elastic IP address bound to the network interface. description: The public IP address or Elastic IP address bound to the network interface.
returned: always returned: always
type: str type: str
sample: 1.2.3.4 sample: 1.2.3.4
primary: primary:
description: Indicates whether this IPv4 address is the primary private IP address of the network interface. description: Indicates whether this IPv4 address is the primary private IP address of the network interface.
returned: always returned: always
type: bool type: bool
sample: true sample: true
private_ip_address: private_ip_address:
description: The private IPv4 address of the network interface. description: The private IPv4 address of the network interface.
returned: always returned: always
type: str type: str
sample: 10.0.0.1 sample: 10.0.0.1
source_dest_check: source_dest_check:
description: Indicates whether source/destination checking is enabled. description: Indicates whether source/destination checking is enabled.
returned: always returned: always
@ -607,18 +607,18 @@ instances:
product_codes: product_codes:
description: One or more product codes. description: One or more product codes.
returned: always returned: always
type: complex type: list of complex
contains: contains:
- product_code_id: product_code_id:
description: The product code. description: The product code.
returned: always returned: always
type: str type: str
sample: aw0evgkw8ef3n2498gndfgasdfsd5cce sample: aw0evgkw8ef3n2498gndfgasdfsd5cce
product_code_type: product_code_type:
description: The type of product code. description: The type of product code.
returned: always returned: always
type: str type: str
sample: marketplace sample: marketplace
public_dns_name: public_dns_name:
description: The public DNS name assigned to the instance. description: The public DNS name assigned to the instance.
returned: always returned: always
@ -642,18 +642,18 @@ instances:
security_groups: security_groups:
description: One or more security groups for the instance. description: One or more security groups for the instance.
returned: always returned: always
type: complex type: list of complex
contains: contains:
- group_id: group_id:
description: The ID of the security group. description: The ID of the security group.
returned: always returned: always
type: str type: str
sample: sg-0123456 sample: sg-0123456
- group_name: group_name:
description: The name of the security group. description: The name of the security group.
returned: always returned: always
type: str type: str
sample: my-security-group sample: my-security-group
network.source_dest_check: network.source_dest_check:
description: Indicates whether source/destination checking is enabled. description: Indicates whether source/destination checking is enabled.
returned: always returned: always

128
lib/ansible/modules/cloud/amazon/ec2_instance_info.py
Unescape Escape View File

@ -263,18 +263,18 @@ instances:
groups: groups:
description: One or more security groups. description: One or more security groups.
returned: always returned: always
type: complex type: list of complex
contains: contains:
- group_id: group_id:
description: The ID of the security group. description: The ID of the security group.
returned: always returned: always
type: str type: str
sample: sg-abcdef12 sample: sg-abcdef12
group_name: group_name:
description: The name of the security group. description: The name of the security group.
returned: always returned: always
type: str type: str
sample: mygroup sample: mygroup
ipv6_addresses: ipv6_addresses:
description: One or more IPv6 addresses associated with the network interface. description: One or more IPv6 addresses associated with the network interface.
returned: always returned: always
@ -308,38 +308,38 @@ instances:
private_ip_addresses: private_ip_addresses:
description: The private IPv4 addresses associated with the network interface. description: The private IPv4 addresses associated with the network interface.
returned: always returned: always
type: complex type: list of complex
contains: contains:
- association: association:
description: The association information for an Elastic IP address (IPv4) associated with the network interface. description: The association information for an Elastic IP address (IPv4) associated with the network interface.
returned: always returned: always
type: complex type: complex
contains: contains:
ip_owner_id: ip_owner_id:
description: The ID of the owner of the Elastic IP address. description: The ID of the owner of the Elastic IP address.
returned: always returned: always
type: str type: str
sample: amazon sample: amazon
public_dns_name: public_dns_name:
description: The public DNS name. description: The public DNS name.
returned: always returned: always
type: str type: str
sample: "" sample: ""
public_ip: public_ip:
description: The public IP address or Elastic IP address bound to the network interface. description: The public IP address or Elastic IP address bound to the network interface.
returned: always returned: always
type: str type: str
sample: 1.2.3.4 sample: 1.2.3.4
primary: primary:
description: Indicates whether this IPv4 address is the primary private IP address of the network interface. description: Indicates whether this IPv4 address is the primary private IP address of the network interface.
returned: always returned: always
type: bool type: bool
sample: true sample: true
private_ip_address: private_ip_address:
description: The private IPv4 address of the network interface. description: The private IPv4 address of the network interface.
returned: always returned: always
type: str type: str
sample: 10.0.0.1 sample: 10.0.0.1
source_dest_check: source_dest_check:
description: Indicates whether source/destination checking is enabled. description: Indicates whether source/destination checking is enabled.
returned: always returned: always
@ -393,18 +393,18 @@ instances:
product_codes: product_codes:
description: One or more product codes. description: One or more product codes.
returned: always returned: always
type: complex type: list of complex
contains: contains:
- product_code_id: product_code_id:
description: The product code. description: The product code.
returned: always returned: always
type: str type: str
sample: aw0evgkw8ef3n2498gndfgasdfsd5cce sample: aw0evgkw8ef3n2498gndfgasdfsd5cce
product_code_type: product_code_type:
description: The type of product code. description: The type of product code.
returned: always returned: always
type: str type: str
sample: marketplace sample: marketplace
public_dns_name: public_dns_name:
description: The public DNS name assigned to the instance. description: The public DNS name assigned to the instance.
returned: always returned: always
@ -428,18 +428,18 @@ instances:
security_groups: security_groups:
description: One or more security groups for the instance. description: One or more security groups for the instance.
returned: always returned: always
type: complex type: list of complex
contains: contains:
- group_id: group_id:
description: The ID of the security group. description: The ID of the security group.
returned: always returned: always
type: str type: str
sample: sg-0123456 sample: sg-0123456
- group_name: group_name:
description: The name of the security group. description: The name of the security group.
returned: always returned: always
type: str type: str
sample: my-security-group sample: my-security-group
source_dest_check: source_dest_check:
description: Indicates whether source/destination checking is enabled. description: Indicates whether source/destination checking is enabled.
returned: always returned: always

4
lib/ansible/modules/cloud/amazon/ec2_vpc_nacl_info.py
Unescape Escape View File

@ -89,14 +89,14 @@ nacls:
ingress: ingress:
description: description:
- A list of NACL ingress rules with the following format. - A list of NACL ingress rules with the following format.
- [rule no, protocol, allow/deny, v4 or v6 cidr, icmp_type, icmp_code, port from, port to] - "C([rule no, protocol, allow/deny, v4 or v6 cidr, icmp_type, icmp_code, port from, port to])"
returned: always returned: always
type: list of list type: list of list
sample: [[100, 'tcp', 'allow', '0.0.0.0/0', null, null, 22, 22]] sample: [[100, 'tcp', 'allow', '0.0.0.0/0', null, null, 22, 22]]
egress: egress:
description: description:
- A list of NACL egress rules with the following format. - A list of NACL egress rules with the following format.
- [rule no, protocol, allow/deny, v4 or v6 cidr, icmp_type, icmp_code, port from, port to] - "C([rule no, protocol, allow/deny, v4 or v6 cidr, icmp_type, icmp_code, port from, port to])"
returned: always returned: always
type: list of list type: list of list
sample: [[100, 'all', 'allow', '0.0.0.0/0', null, null, null, null]] sample: [[100, 'all', 'allow', '0.0.0.0/0', null, null, null, null]]

7
lib/ansible/modules/cloud/amazon/ec2_vpc_vpn_info.py
Unescape Escape View File

@ -123,7 +123,7 @@ vpn_connections:
last_status_change: last_status_change:
description: The date and time of the last change in status. description: The date and time of the last change in status.
returned: always returned: always
type: datetime type: str
sample: "2018-02-09T14:35:27+00:00" sample: "2018-02-09T14:35:27+00:00"
outside_ip_address: outside_ip_address:
description: The Internet-routable IP address of the virtual private gateway's outside interface. description: The Internet-routable IP address of the virtual private gateway's outside interface.
@ -140,6 +140,11 @@ vpn_connections:
returned: always returned: always
type: str type: str
sample: IPSEC IS DOWN sample: IPSEC IS DOWN
certificate_arn:
description: The Amazon Resource Name of the virtual private gateway tunnel endpoint certificate.
returned: when a private certificate is used for authentication
type: str
sample: "arn:aws:acm:us-east-1:123456789101:certificate/c544d8ce-20b8-4fff-98b0-example"
vpn_connection_id: vpn_connection_id:
description: The ID of the VPN connection. description: The ID of the VPN connection.
returned: always returned: always

2
lib/ansible/modules/cloud/openstack/os_coe_cluster.py
Unescape Escape View File

@ -105,7 +105,7 @@ cluster:
created_at: created_at:
description: description:
- The time in UTC at which the cluster is created - The time in UTC at which the cluster is created
type: datetime type: str
sample: "2018-08-16T10:29:45+00:00" sample: "2018-08-16T10:29:45+00:00"
create_timeout: create_timeout:
description: description:

2
lib/ansible/modules/cloud/ovirt/ovirt_auth.py
Unescape Escape View File

@ -169,7 +169,7 @@ ovirt_auth:
ca_file: ca_file:
description: CA file, which is used to verify SSL/TLS connection. description: CA file, which is used to verify SSL/TLS connection.
returned: success returned: success
type: path type: str
sample: "ca.pem" sample: "ca.pem"
insecure: insecure:
description: Flag indicating if insecure connection is used. description: Flag indicating if insecure connection is used.

8
lib/ansible/modules/cloud/vmware/vcenter_folder.py
Unescape Escape View File

@ -132,8 +132,12 @@ result:
returned: On success returned: On success
type: complex type: complex
contains: contains:
path: the full path of the new folder path:
msg: string stating about result description: the full path of the new folder
type: str
msg:
description: string stating about result
type: str
''' '''
try: try:

4
lib/ansible/modules/files/stat.py
Unescape Escape View File

@ -142,9 +142,9 @@ stat:
type: str type: str
sample: '/path/to/file' sample: '/path/to/file'
mode: mode:
description: Unix permissions of the file in octal description: Unix permissions of the file in octal representation as a string
returned: success, path exists and user can read stats returned: success, path exists and user can read stats
type: octal type: str
sample: 1755 sample: 1755
isdir: isdir:
description: Tells you if the path is a directory description: Tells you if the path is a directory

20
lib/ansible/modules/network/meraki/meraki_mx_l7_firewall.py
Unescape Escape View File

@ -247,16 +247,16 @@ data:
returned: success returned: success
type: str type: str
sample: meraki:layer7/application/4 sample: meraki:layer7/application/4
id: id:
description: URI of application category. description: URI of application category.
returned: success returned: success
type: string type: string
sample: Email sample: Email
name: name:
description: Descriptive name of application category. description: Descriptive name of application category.
returned: success returned: success
type: string type: string
sample: layer7/category/1 sample: layer7/category/1
''' '''
import copy import copy

2
lib/ansible/modules/windows/win_updates.py
Unescape Escape View File

@ -221,7 +221,7 @@ updates:
id: id:
description: Internal Windows Update GUID. description: Internal Windows Update GUID.
returned: always returned: always
type: str (guid) type: str
sample: "fb95c1c8-de23-4089-ae29-fd3351d55421" sample: "fb95c1c8-de23-4089-ae29-fd3351d55421"
installed: installed:
description: Was the update successfully installed. description: Was the update successfully installed.

Write Preview
Loading…
Cancel
Save