mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Add RETURN docs
This commit is contained in:
parent
7ae8693bda
commit
94d03b6b55
1 changed files with 54 additions and 0 deletions
|
@ -168,6 +168,60 @@ EXAMPLES = '''
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
||||||
|
RETURN = '''
|
||||||
|
interface:
|
||||||
|
description: Network interface attributes
|
||||||
|
returned: when state != absent
|
||||||
|
type: dictionary
|
||||||
|
contains:
|
||||||
|
description:
|
||||||
|
description: interface description
|
||||||
|
type: string
|
||||||
|
sample: Firewall network interface
|
||||||
|
groups:
|
||||||
|
description: list of security groups
|
||||||
|
type: list of dictionaries
|
||||||
|
sample: [ { "sg-f8a8a9da": "default" } ]
|
||||||
|
id:
|
||||||
|
description: network interface id
|
||||||
|
type: string
|
||||||
|
sample: "eni-1d889198"
|
||||||
|
mac_address:
|
||||||
|
description: interface's physical address
|
||||||
|
type: string
|
||||||
|
sample: "06:9a:27:6a:6f:99"
|
||||||
|
owner_id:
|
||||||
|
description: aws account id
|
||||||
|
type: string
|
||||||
|
sample: 812381371
|
||||||
|
private_ip_address:
|
||||||
|
description: primary ip address of this interface
|
||||||
|
type: string
|
||||||
|
sample: 10.20.30.40
|
||||||
|
private_ip_addresses:
|
||||||
|
description: list of all private ip addresses associated to this interface
|
||||||
|
type: list of dictionaries
|
||||||
|
sample: [ { "primary_address": true, "private_ip_address": "10.20.30.40" } ]
|
||||||
|
source_dest_check:
|
||||||
|
description: value of source/dest check flag
|
||||||
|
type: boolean
|
||||||
|
sample: True
|
||||||
|
status:
|
||||||
|
description: network interface status
|
||||||
|
type: string
|
||||||
|
sample: "pending"
|
||||||
|
subnet_id:
|
||||||
|
description: which vpc subnet the interface is bound
|
||||||
|
type: string
|
||||||
|
sample: subnet-b0a0393c
|
||||||
|
vpc_id:
|
||||||
|
description: which vpc this network interface is bound
|
||||||
|
type: string
|
||||||
|
sample: vpc-9a9a9da
|
||||||
|
|
||||||
|
'''
|
||||||
|
|
||||||
import time
|
import time
|
||||||
import re
|
import re
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue