diff options
| author | Kevin Breit <kevin.breit@kevinbreit.net> | 2019-02-01 20:08:09 -0800 |
|---|---|---|
| committer | Dag Wieers <dag@wieers.com> | 2019-02-02 05:08:09 +0100 |
| commit | 4493ba86ec7a4c1db0159687467223cf8a53a1fa (patch) | |
| tree | bf92eb211b4a653777c8a4d337debea2ec5fdb12 /lib | |
| parent | 1e4d2b10010653fb49976f9d7a85a6d3642e5412 (diff) | |
| download | ansible-4493ba86ec7a4c1db0159687467223cf8a53a1fa.tar.gz | |
Add response documentation (#51647)
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/ansible/modules/network/meraki/meraki_switchport.py | 82 |
1 files changed, 69 insertions, 13 deletions
diff --git a/lib/ansible/modules/network/meraki/meraki_switchport.py b/lib/ansible/modules/network/meraki/meraki_switchport.py index d604571603..9a7b9ae047 100644 --- a/lib/ansible/modules/network/meraki/meraki_switchport.py +++ b/lib/ansible/modules/network/meraki/meraki_switchport.py @@ -168,19 +168,75 @@ EXAMPLES = r''' RETURN = r''' data: - description: Information about queried or updated object. - type: list - returned: info - sample: - "data": { - "hostname": "n110.meraki.com", - "peer_ips": null, - "port": 16100, - "v2c_enabled": false, - "v3_auth_mode": null, - "v3_enabled": false, - "v3_priv_mode": null - } + description: Information queried or updated switchports. + returned: success + type: complex + contains: + number: + description: Number of port. + returned: success + type: int + sample: 1 + name: + description: Human friendly description of port. + 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 |