Try SpotterResource module for organizations _configtemplates _switch _profiles _ports
| "added in version" 2.16.0 of cisco.meraki"
Authors: Francisco Munoz (@fmunoz)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install cisco.meraki:==2.18.0
collections:
- name: cisco.meraki
version: 2.18.0Manage operation update of the resource organizations _configtemplates _switch _profiles _ports.
Update a switch template port.
- name: Update by id
cisco.meraki.organizations_config_templates_switch_profiles_ports:
meraki_api_key: "{{meraki_api_key}}"
meraki_base_url: "{{meraki_base_url}}"
meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
meraki_certificate_path: "{{meraki_certificate_path}}"
meraki_requests_proxy: "{{meraki_requests_proxy}}"
meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
meraki_maximum_retries: "{{meraki_maximum_retries}}"
meraki_output_log: "{{meraki_output_log}}"
meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
meraki_log_path: "{{meraki_log_path}}"
meraki_print_console: "{{meraki_print_console}}"
meraki_suppress_logging: "{{meraki_suppress_logging}}"
meraki_simulate: "{{meraki_simulate}}"
meraki_be_geo_id: "{{meraki_be_geo_id}}"
meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
state: present
accessPolicyNumber: 2
accessPolicyType: Sticky MAC allow list
allowedVlans: 1,3,5-10
configTemplateId: string
daiTrusted: false
enabled: true
flexibleStackingEnabled: true
isolationEnabled: false
linkNegotiation: Auto negotiate
macAllowList:
- 34:56:fe:ce:8e:b0
- 34:56:fe:ce:8e:b1
name: My switch port
organizationId: string
poeEnabled: true
portId: string
portScheduleId: '1234'
profile:
enabled: false
id: '1284392014819'
iname: iname
profileId: string
rstpEnabled: true
stickyMacAllowList:
- 34:56:fe:ce:8e:b0
- 34:56:fe:ce:8e:b1
stickyMacAllowListLimit: 5
stormControlEnabled: true
stpGuard: disabled
tags:
- tag1
- tag2
type: access
udld: Alert only
vlan: 10
voiceVlan: 20
name:
description: The name of the switch template port.
type: str
tags:
description: The list of tags of the switch template port.
elements: str
type: list
type:
description: The type of the switch template port ('trunk' or 'access').
type: str
udld:
description: The action to take when Unidirectional Link is detected (Alert only,
Enforce). Default configuration is Alert only.
type: str
vlan:
description: The VLAN of the switch template port. For a trunk port, this is the native
VLAN. A null value will clear the value set for trunk ports.
type: int
portId:
description: PortId path parameter. Port ID.
type: str
enabled:
description: The status of the switch template port.
type: bool
profile:
description: Profile attributes.
suboptions:
enabled:
description: When enabled, override this port's configuration with a port profile.
type: bool
id:
description: When enabled, the ID of the port profile used to override the port's
configuration.
type: str
iname:
description: When enabled, the IName of the profile.
type: str
type: dict
stpGuard:
description: The state of the STP guard ('disabled', 'root guard', 'bpdu guard' or
'loop guard').
type: str
profileId:
description: ProfileId path parameter. Profile ID.
type: str
voiceVlan:
description: The voice VLAN of the switch template port. Only applicable to access
ports.
type: int
daiTrusted:
description: If true, ARP packets for this port will be considered trusted, and Dynamic
ARP Inspection will allow the traffic.
type: bool
poeEnabled:
description: The PoE status of the switch template port.
type: bool
rstpEnabled:
description: The rapid spanning tree protocol status.
type: bool
allowedVlans:
description: The VLANs allowed on the switch template port. Only applicable to trunk
ports.
type: str
macAllowList:
description: Only devices with MAC addresses specified in this list will have access
to this port. Up to 20 MAC addresses can be defined. Only applicable when 'accessPolicyType'
is 'MAC allow list'.
elements: str
type: list
meraki_caller:
default: ''
description:
- meraki_caller (string), optional identifier for API usage tracking; can also be
set as an environment variable MERAKI_PYTHON_SDK_CALLER
type: str
meraki_api_key:
description:
- meraki_api_key (string), API key generated in dashboard; can also be set as an environment
variable MERAKI_DASHBOARD_API_KEY
required: true
type: str
organizationId:
description: OrganizationId path parameter. Organization ID.
type: str
portScheduleId:
description: The ID of the port schedule. A value of null will clear the port schedule.
type: str
linkNegotiation:
description: The link speed for the switch template port.
type: str
meraki_base_url:
default: https://api.meraki.com/api/v1
description:
- meraki_base_url (string), preceding all endpoint resources
type: str
meraki_log_path:
default: ''
description:
- log_path (string), path to output log; by default, working directory of script if
not specified
type: str
meraki_simulate:
default: false
description:
- meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes?
type: bool
accessPolicyType:
description: The type of the access policy of the switch template port. Only applicable
to access ports. Can be one of 'Open', 'Custom access policy', 'MAC allow list'
or 'Sticky MAC allow list'.
type: str
configTemplateId:
description: ConfigTemplateId path parameter. Config template ID.
type: str
isolationEnabled:
description: The isolation status of the switch template port.
type: bool
meraki_be_geo_id:
default: ''
description:
- meraki_be_geo_id (string), optional partner identifier for API usage tracking; can
also be set as an environment variable BE_GEO_ID
type: str
meraki_output_log:
default: true
description:
- meraki_output_log (boolean), create an output log file?
type: bool
accessPolicyNumber:
description: The number of a custom access policy to configure on the switch template
port. Only applicable when 'accessPolicyType' is 'Custom access policy'.
type: int
stickyMacAllowList:
description: The initial list of MAC addresses for sticky Mac allow list. Only applicable
when 'accessPolicyType' is 'Sticky MAC allow list'.
elements: str
type: list
stormControlEnabled:
description: The storm control status of the switch template port.
type: bool
meraki_print_console:
default: true
description:
- meraki_print_console (boolean), print logging output to console?
type: bool
meraki_requests_proxy:
default: ''
description:
- meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS
type: str
meraki_log_file_prefix:
default: meraki_api_
description:
- meraki_log_file_prefix (string), log file name appended with date and timestamp
type: str
meraki_maximum_retries:
default: 2
description:
- meraki_maximum_retries (integer), retry up to this many times when encountering
429s or other server-side errors
type: int
meraki_retry_4xx_error:
default: false
description:
- meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides
429)?
type: bool
flexibleStackingEnabled:
description: For supported switches (e.g. MS420/MS425), whether or not the port has
flexible stacking enabled.
type: bool
meraki_certificate_path:
default: ''
description:
- meraki_certificate_path (string), path for TLS/SSL certificate verification if behind
local proxy
type: str
meraki_suppress_logging:
default: false
description:
- meraki_suppress_logging (boolean), disable all logging? you're on your own then!
type: bool
stickyMacAllowListLimit:
description: The maximum number of MAC addresses for sticky MAC allow list. Only applicable
when 'accessPolicyType' is 'Sticky MAC allow list'.
type: int
meraki_wait_on_rate_limit:
default: true
description:
- meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered?
type: bool
meraki_inherit_logging_config:
default: false
description:
- meraki_inherit_logging_config (boolean), Inherits your own logger instance
type: bool
meraki_single_request_timeout:
default: 60
description:
- meraki_single_request_timeout (integer), maximum number of seconds for each API
call
type: int
meraki_nginx_429_retry_wait_time:
default: 60
description:
- meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time
type: int
meraki_retry_4xx_error_wait_time:
default: 60
description:
- meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time
type: int
meraki_use_iterator_for_get_pages:
default: false
description:
- meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator
with each object instead of a complete list with all items
type: bool
meraki_action_batch_retry_wait_time:
default: 60
description:
- meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry
wait time
type: int
meraki_response:
description: A dictionary or list with the response returned by the Cisco Meraki
Python SDK
returned: always
sample: "{\n \"accessPolicyNumber\": 0,\n \"accessPolicyType\": \"string\",\n\
\ \"allowedVlans\": \"string\",\n \"daiTrusted\": true,\n \"enabled\": true,\n\
\ \"flexibleStackingEnabled\": true,\n \"isolationEnabled\": true,\n \"linkNegotiation\"\
: \"string\",\n \"linkNegotiationCapabilities\": [\n \"string\"\n ],\n \"\
macAllowList\": [\n \"string\"\n ],\n \"mirror\": {\n \"mode\": \"string\"\
\n },\n \"module\": {\n \"model\": \"string\"\n },\n \"name\": \"string\"\
,\n \"poeEnabled\": true,\n \"portId\": \"string\",\n \"portScheduleId\": \"\
string\",\n \"profile\": {\n \"enabled\": true,\n \"id\": \"string\",\n\
\ \"iname\": \"string\"\n },\n \"rstpEnabled\": true,\n \"stickyMacAllowList\"\
: [\n \"string\"\n ],\n \"stickyMacAllowListLimit\": 0,\n \"stormControlEnabled\"\
: true,\n \"stpGuard\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"\
type\": \"string\",\n \"udld\": \"string\",\n \"vlan\": 0,\n \"voiceVlan\"\
: 0\n}\n"
type: dict