Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

meraki_ssid - Add response documentation #54276

Merged
merged 1 commit into from
Mar 25, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
83 changes: 76 additions & 7 deletions lib/ansible/modules/network/meraki/meraki_ssid.py
Original file line number Diff line number Diff line change
Expand Up @@ -220,13 +220,82 @@

RETURN = r'''
data:
description: Information about queried or updated object.
type: list
returned: info
sample:
"data": {

}
description: List of wireless SSIDs.
returned: success
type: complex
contains:
number:
description: Zero-based index number for SSIDs.
returned: success
type: int
sample: 0
name:
description:
- Name of wireless SSID.
- This value is what is broadcasted.
returned: success
type: str
sample: CorpWireless
enabled:
description: Enabled state of wireless network.
returned: success
type: bool
sample: true
splashPage:
description: Splash page to show when user authenticates.
returned: success
type: str
sample: Click-through splash page
ssidAdminAccessible:
description: Whether SSID is administratively accessible.
returned: success
type: bool
sample: true
authMode:
description: Authentication method.
returned: success
type: str
sample: psk
psk:
description: Secret wireless password.
returned: success
type: str
sample: SecretWiFiPass
encryptionMode:
description: Wireless traffic encryption method.
returned: success
type: str
sample: wpa
wpaEncryptionMode:
description: Enabled WPA versions.
returned: success
type: str
sample: WPA2 only
ipAssignmentMode:
description: Wireless client IP assignment method.
returned: success
type: str
sample: NAT mode
minBitrate:
description: Minimum bitrate a wireless client can connect at.
returned: success
type: int
sample: 11
bandSelection:
description: Wireless RF frequency wireless network will be broadcast on.
returned: success
type: str
sample: 5 GHz band only
perClientBandwidthLimitUp:
description: Maximum upload bandwidth a client can use.
returned: success
type: int
sample: 1000
perClientBandwidthLimitDown:
description: Maximum download bandwidth a client can use.
returned: success
type: int
sample: 0
'''

import os
Expand Down