mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-25 14:20:22 -07:00
Meraki/doc response vlan (#43669)
* Add proper response documentation to meraki_vlan * Add fixed IP assignemnts and reserved IP range response docs * Fix syntax error * Remove duplicate reservedIpRanges documentation
This commit is contained in:
parent
22b921d47f
commit
3750c3a4d9
1 changed files with 75 additions and 14 deletions
|
@ -131,21 +131,82 @@ EXAMPLES = r'''
|
||||||
'''
|
'''
|
||||||
|
|
||||||
RETURN = r'''
|
RETURN = r'''
|
||||||
|
|
||||||
response:
|
response:
|
||||||
description: Data returned from Meraki dashboard about VLAN.
|
description: Information about the organization which was created or modified
|
||||||
type: dict
|
returned: success
|
||||||
returned: success
|
type: complex
|
||||||
example:
|
contains:
|
||||||
{
|
applianceIp:
|
||||||
"applianceIp": "192.0.1.1",
|
description: IP address of Meraki appliance in the VLAN
|
||||||
"dnsNameservers": "upstream_dns",
|
returned: success
|
||||||
"fixedIpAssignments": {},
|
type: string
|
||||||
"id": 2,
|
sample: 192.0.1.1
|
||||||
"name": "TestVLAN",
|
dnsnamservers:
|
||||||
"networkId": "N_12345",
|
description: IP address or Meraki defined DNS servers which VLAN should use by default
|
||||||
"reservedIpRanges": [],
|
returned: success
|
||||||
"subnet": "192.0.1.0/24"
|
type: string
|
||||||
}
|
sample: upstream_dns
|
||||||
|
fixedIpAssignments:
|
||||||
|
description: List of MAC addresses which have IP addresses assigned.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
macaddress:
|
||||||
|
description: MAC address which has IP address assigned to it. Key value is the actual MAC address.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
ip:
|
||||||
|
description: IP address which is assigned to the MAC address.
|
||||||
|
returned: success
|
||||||
|
type: string
|
||||||
|
sample: 192.0.1.4
|
||||||
|
name:
|
||||||
|
description: Descriptive name for binding.
|
||||||
|
returned: success
|
||||||
|
type: string
|
||||||
|
sample: fixed_ip
|
||||||
|
reservedIpRanges:
|
||||||
|
description: List of IP address ranges which are reserved for static assignment.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
comment:
|
||||||
|
description: Description for IP address reservation.
|
||||||
|
returned: success
|
||||||
|
type: string
|
||||||
|
sample: reserved_range
|
||||||
|
end:
|
||||||
|
description: Last IP address in reservation range.
|
||||||
|
returned: success
|
||||||
|
type: string
|
||||||
|
sample: 192.0.1.10
|
||||||
|
start:
|
||||||
|
description: First IP address in reservation range.
|
||||||
|
returned: success
|
||||||
|
type: string
|
||||||
|
sample: 192.0.1.5
|
||||||
|
id:
|
||||||
|
description: VLAN ID number.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
sample: 2
|
||||||
|
name:
|
||||||
|
description: Descriptive name of VLAN
|
||||||
|
returned: success
|
||||||
|
type: string
|
||||||
|
sample: TestVLAN
|
||||||
|
networkId:
|
||||||
|
description: ID number of Meraki network which VLAN is associated to.
|
||||||
|
returned: success
|
||||||
|
type: string
|
||||||
|
sample: N_12345
|
||||||
|
subnet:
|
||||||
|
description: CIDR notation IP subnet of VLAN.
|
||||||
|
returned: success
|
||||||
|
type: string
|
||||||
|
sample: 192.0.1.0/24
|
||||||
'''
|
'''
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue