mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Add response documentation (#51647)
This commit is contained in:
parent
1e4d2b1001
commit
4493ba86ec
1 changed files with 69 additions and 13 deletions
|
@ -168,19 +168,75 @@ EXAMPLES = r'''
|
||||||
|
|
||||||
RETURN = r'''
|
RETURN = r'''
|
||||||
data:
|
data:
|
||||||
description: Information about queried or updated object.
|
description: Information queried or updated switchports.
|
||||||
type: list
|
returned: success
|
||||||
returned: info
|
type: complex
|
||||||
sample:
|
contains:
|
||||||
"data": {
|
number:
|
||||||
"hostname": "n110.meraki.com",
|
description: Number of port.
|
||||||
"peer_ips": null,
|
returned: success
|
||||||
"port": 16100,
|
type: int
|
||||||
"v2c_enabled": false,
|
sample: 1
|
||||||
"v3_auth_mode": null,
|
name:
|
||||||
"v3_enabled": false,
|
description: Human friendly description of port.
|
||||||
"v3_priv_mode": null
|
returned: success
|
||||||
}
|
type: str
|
||||||
|
sample: "Jim Phone Port"
|
||||||
|
tags:
|
||||||
|
description: Space delimited list of tags assigned to port.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
sample: phone marketing
|
||||||
|
enabled:
|
||||||
|
description: Enabled state of port.
|
||||||
|
returned: success
|
||||||
|
type: bool
|
||||||
|
sample: true
|
||||||
|
poeEnabled:
|
||||||
|
description: Power Over Ethernet enabled state of port.
|
||||||
|
returned: success
|
||||||
|
type: bool
|
||||||
|
sample: true
|
||||||
|
type:
|
||||||
|
description: Type of switchport.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
sample: trunk
|
||||||
|
vlan:
|
||||||
|
description: VLAN assigned to port.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
sample: 10
|
||||||
|
voiceVlan:
|
||||||
|
description: VLAN assigned to port with voice VLAN enabled devices.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
sample: 20
|
||||||
|
isolationEnabled:
|
||||||
|
description: Port isolation status of port.
|
||||||
|
returned: success
|
||||||
|
type: bool
|
||||||
|
sample: true
|
||||||
|
rstpEnabled:
|
||||||
|
description: Enabled or disabled state of Rapid Spanning Tree Protocol (RSTP)
|
||||||
|
returned: success
|
||||||
|
type: bool
|
||||||
|
sample: true
|
||||||
|
stpGuard:
|
||||||
|
description: State of STP guard
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
sample: "Root Guard"
|
||||||
|
accessPolicyNumber:
|
||||||
|
description: Number of assigned access policy. Only applicable to access ports.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
sample: 1234
|
||||||
|
linkNegotiation:
|
||||||
|
description: Link speed for the port.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
sample: "Auto negotiate"
|
||||||
'''
|
'''
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
|
Loading…
Reference in a new issue