New in version 2.7.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| access_policy_number | Number of the access policy to apply. Only applicable to access port types. | |
| allowed_vlans | Default: all | List of VLAN numbers to be allowed on switchport. |
| auth_key | Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set. | |
| enabled bool |
| Whether a switchport should be enabled or disabled. |
| host string | Default: api.meraki.com | Hostname for Meraki dashboard Only useful for internal Meraki developers |
| isolation_enabled bool |
| Isolation status of switchport. |
| link_negotiation |
| Link speed for the switchport. |
| name | Switchport description. aliases: description | |
| number | Port number. | |
| org_id | ID of organization. | |
| org_name | Name of organization. aliases: organization | |
| output_level |
| Set amount of debug output during module execution |
| poe_enabled bool |
| Enable or disable Power Over Ethernet on a port. |
| rstp_enabled bool |
| Enable or disable Rapid Spanning Tree Protocol on a port. |
| serial | Serial nubmer of the switch. | |
| state |
| Specifies whether a switchport should be queried or modified. |
| stp_guard |
| Set state of STP guard. |
| tags | Space delimited list of tags to assign to a port. | |
| timeout int | Default: 30 | Time to timeout for HTTP requests. |
| type |
| Set port type. |
| use_https bool |
| If no, it will use HTTP. Otherwise it will use HTTPS.Only useful for internal Meraki developers |
| use_proxy bool |
| If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| validate_certs bool |
| Whether to validate HTTP certificates. |
| vlan | VLAN number assigned to port. If a port is of type trunk, the specified VLAN is the native VLAN. | |
| voice_vlan | VLAN number assigned to a port for voice traffic. Only applicable to access port type. |
Note
- name: Query information about all switchports on a switch
meraki_switchport:
auth_key: abc12345
state: query
serial: ABC-123
delegate_to: localhost
- name: Query information about all switchports on a switch
meraki_switchport:
auth_key: abc12345
state: query
serial: ABC-123
number: 2
delegate_to: localhost
- name: Name switchport
meraki_switchport:
auth_key: abc12345
state: present
serial: ABC-123
number: 7
name: Test Port
delegate_to: localhost
- name: Configure access port with voice VLAN
meraki_switchport:
auth_key: abc12345
state: present
serial: ABC-123
number: 7
enabled: true
name: Test Port
tags: desktop
type: access
vlan: 10
voice_vlan: 11
delegate_to: localhost
- name: Check access port for idempotenty
meraki_switchport:
auth_key: abc12345
state: present
serial: ABC-123
number: 7
enabled: true
name: Test Port
tags: desktop
type: access
vlan: 10
voice_vlan: 11
delegate_to: localhost
- name: Configure trunk port with specific VLANs
meraki_switchport:
auth_key: abc12345
state: present
serial: ABC-123
number: 7
enabled: true
name: Server port
tags: server
type: trunk
allowed_vlans:
- 10
- 15
- 20
delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| data list | info | Information about queried or updated object. Sample: {'data': {'peer_ips': None, 'v3_priv_mode': None, 'hostname': 'n110.meraki.com', 'v3_auth_mode': None, 'v3_enabled': False, 'v2c_enabled': False, 'port': 16100}} |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/meraki_switchport_module.html