Try SpotterResource module for devices _switch _routing _interfaces
| "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 operations create, update and delete of the resource devices _switch _routing _interfaces.
Create a layer 3 interface for a switch.
Delete a layer 3 interface from the switch.
Update a layer 3 interface for a switch.
- name: Create
cisco.meraki.devices_switch_routing_interfaces:
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
defaultGateway: 192.168.1.1
interfaceIp: 192.168.1.2
ipv6:
address: 1:2:3:4::1
assignmentMode: static
gateway: 1:2:3:4::2
prefix: 1:2:3:4::/48
multicastRouting: disabled
name: L3 interface
ospfSettings:
area: '0'
cost: 1
isPassiveEnabled: true
ospfV3:
area: '1'
cost: 2
isPassiveEnabled: true
serial: string
subnet: 192.168.1.0/24
vlanId: 100
- name: Delete by id
cisco.meraki.devices_switch_routing_interfaces:
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: absent
interfaceId: string
serial: string
- name: Update by id
cisco.meraki.devices_switch_routing_interfaces:
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
defaultGateway: 192.168.1.1
interfaceId: string
interfaceIp: 192.168.1.2
ipv6:
address: 1:2:3:4::1
assignmentMode: static
gateway: 1:2:3:4::2
prefix: 1:2:3:4::/48
multicastRouting: disabled
name: L3 interface
ospfSettings:
area: '0'
cost: 1
isPassiveEnabled: true
ospfV3:
area: '1'
cost: 2
isPassiveEnabled: true
serial: string
subnet: 192.168.1.0/24
vlanId: 100
ipv6:
description: The IPv6 settings of the interface.
suboptions:
address:
description: The IPv6 address of the interface. Required if assignmentMode is
'static'. Must not be included if assignmentMode is 'eui-64'.
type: str
assignmentMode:
description: The IPv6 assignment mode for the interface. Can be either 'eui-64'
or 'static'.
type: str
gateway:
description: The IPv6 default gateway of the interface. Required if prefix is
defined and this is the first interface with IPv6 configured for the switch.
type: str
prefix:
description: The IPv6 prefix of the interface. Required if IPv6 object is included.
type: str
type: dict
name:
description: A friendly name or description for the interface or VLAN.
type: str
ospfV3:
description: The OSPFv3 routing settings of the interface.
suboptions:
area:
description: The OSPFv3 area to which this interface should belong. Can be either
'disabled' or the identifier of an existing OSPFv3 area. Defaults to 'disabled'.
type: str
cost:
description: The path cost for this interface. Defaults to 1, but can be increased
up to 65535 to give lower priority.
type: int
isPassiveEnabled:
description: When enabled, OSPFv3 will not run on the interface, but the subnet
will still be advertised.
type: bool
type: dict
serial:
description: Serial path parameter.
type: str
subnet:
description: The network that this routed interface is on, in CIDR notation (ex. 10.1.1.0/24).
type: str
vlanId:
description: The VLAN this routed interface is on. VLAN must be between 1 and 4094.
type: int
interfaceId:
description: InterfaceId path parameter. Interface ID.
type: str
interfaceIp:
description: The IP address this switch will use for layer 3 routing on this VLAN
or subnet. This cannot be the same as the switch's management IP.
type: str
ospfSettings:
description: The OSPF routing settings of the interface.
suboptions:
area:
description: The OSPF area to which this interface should belong. Can be either
'disabled' or the identifier of an existing OSPF area. Defaults to 'disabled'.
type: str
cost:
description: The path cost for this interface. Defaults to 1, but can be increased
up to 65535 to give lower priority.
type: int
isPassiveEnabled:
description: When enabled, OSPF will not run on the interface, but the subnet
will still be advertised.
type: bool
type: dict
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
defaultGateway:
description: The next hop for any traffic that isn't going to a directly connected
subnet or over a static route. This IP address must exist in a subnet with a routed
interface. Required if this is the first IPv4 interface.
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
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
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
multicastRouting:
description: Enable multicast support if, multicast routing between VLANs is required.
Options are 'disabled', 'enabled' or 'IGMP snooping querier'. Default is 'disabled'.
type: str
meraki_output_log:
default: true
description:
- meraki_output_log (boolean), create an output log file?
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
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
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 \"defaultGateway\": \"string\",\n \"interfaceId\": \"string\",\n\
\ \"interfaceIp\": \"string\",\n \"ipv6\": {\n \"address\": \"string\",\n\
\ \"assignmentMode\": \"string\",\n \"gateway\": \"string\",\n \"prefix\"\
: \"string\"\n },\n \"multicastRouting\": \"string\",\n \"name\": \"string\"\
,\n \"ospfSettings\": {\n \"area\": \"string\",\n \"cost\": 0,\n \"\
isPassiveEnabled\": true\n },\n \"ospfV3\": {\n \"area\": \"string\",\n \
\ \"cost\": 0,\n \"isPassiveEnabled\": true\n },\n \"subnet\": \"string\"\
,\n \"vlanId\": 0\n}\n"
type: dict