Deprecated

Removed in 3.0.0

i

Reason:Updated modules released with increased functionality | Alternative:cisco.meraki.networks_switch_stacks_routing_interfaces

cisco.meraki.meraki_ms_stack_l3_interface (2.18.0) — module

Manage routed interfaces on MS switches

Authors: Kevin Breit (@kbreit)

deprecated | supported by community

Install collection

Install with ansible-galaxy collection install cisco.meraki:==2.18.0


Add to requirements.yml

  collections:
    - name: cisco.meraki
      version: 2.18.0

Description

Allows for creation, management, and visibility into routed interfaces on Meraki MS switches.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Query all l3 interfaces
  meraki_ms_stack_l3_interface:
    auth_key: abc123
    state: query
    serial: aaa-bbb-ccc
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Query one l3 interface
  meraki_ms_stack_l3_interface:
    auth_key: abc123
    state: query
    serial: aaa-bbb-ccc
    name: Test L3 interface
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create l3 interface
  meraki_ms_stack_l3_interface:
    auth_key: abc123
    state: present
    serial: aaa-bbb-ccc
    name: "Test L3 interface 2"
    subnet: "192.168.3.0/24"
    interface_ip: "192.168.3.2"
    multicast_routing: disabled
    vlan_id: 11
    ospf_settings:
      area: 0
      cost: 1
      is_passive_enabled: true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Update l3 interface
  meraki_ms_stack_l3_interface:
    auth_key: abc123
    state: present
    serial: aaa-bbb-ccc
    name: "Test L3 interface 2"
    subnet: "192.168.3.0/24"
    interface_ip: "192.168.3.2"
    multicast_routing: disabled
    vlan_id: 11
    ospf_settings:
      area: 0
      cost: 2
      is_passive_enabled: true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete l3 interface
  meraki_ms_stack_l3_interface:
    auth_key: abc123
    state: absent
    serial: aaa-bbb-ccc
    interface_id: abc123344566

Inputs

    
host:
    default: api.meraki.com
    description:
    - Hostname for Meraki dashboard.
    - Can be used to access regional Meraki environments, such as China.
    type: str

name:
    description:
    - A friendly name or description for the interface or VLAN.
    type: str

state:
    choices:
    - present
    - query
    - absent
    default: present
    description:
    - Create or modify an organization.
    type: str

net_id:
    description:
    - ID of network which configuration is applied to.
    type: str

org_id:
    description:
    - ID of organization.
    type: str

subnet:
    description:
    - The network that this routed interface is on, in CIDR notation.
    type: str

timeout:
    default: 30
    description:
    - Time to timeout for HTTP requests.
    type: int

vlan_id:
    description:
    - The VLAN this routed interface is on.
    - VLAN must be between 1 and 4094.
    type: int

auth_key:
    description:
    - Authentication key provided by the dashboard. Required if environmental variable
      C(MERAKI_KEY) is not set.
    required: true
    type: str

net_name:
    aliases:
    - network
    description:
    - Name of network which configuration is applied to.
    type: str

org_name:
    aliases:
    - organization
    description:
    - Name of organization.
    type: str

stack_id:
    description:
    - The unique identifier of the stack.
    type: str

use_https:
    default: true
    description:
    - If C(no), it will use HTTP. Otherwise it will use HTTPS.
    - Only useful for internal Meraki developers.
    type: bool

use_proxy:
    default: false
    description:
    - If C(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    type: bool

interface_id:
    description:
    - Uniqiue identification number for layer 3 interface.
    type: str

interface_ip:
    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

output_level:
    choices:
    - debug
    - normal
    default: normal
    description:
    - Set amount of debug output during module execution.
    type: str

ospf_settings:
    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.
        type: str
      cost:
        description:
        - The path cost for this interface.
        type: int
      is_passive_enabled:
        description:
        - When enabled, OSPF will not run on the interface, but the subnet will still
          be advertised.
        type: bool
    type: dict

output_format:
    choices:
    - snakecase
    - camelcase
    default: snakecase
    description:
    - Instructs module whether response keys should be snake case (ex. C(net_id)) or camel
      case (ex. C(netId)).
    type: str

validate_certs:
    default: true
    description:
    - Whether to validate HTTP certificates.
    type: bool

default_gateway:
    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.
    type: str

multicast_routing:
    choices:
    - disabled
    - enabled
    - IGMP snooping querier
    description:
    - Enable multicast support if multicast routing between VLANs is required.
    type: str

rate_limit_retry_time:
    default: 165
    description:
    - Number of seconds to retry if rate limiter is triggered.
    type: int

internal_error_retry_time:
    default: 60
    description:
    - Number of seconds to retry if server returns an internal server error.
    type: int

Outputs

data:
  contains:
    default_gateway:
      description: The next hop for any traffic that isn't going to a directly connected
        subnet or over a static route.
      returned: success
      sample: 192.168.2.1
      type: str
    interface_id:
      description: Uniqiue identification number for layer 3 interface.
      returned: success
      sample: 62487444811111120
      type: str
    interface_ip:
      description: The IP address this switch will use for layer 3 routing on this
        VLAN or subnet.
      returned: success
      sample: 192.168.2.2
      type: str
    multicast_routing:
      description: Enable multicast support if multicast routing between VLANs is
        required.
      returned: success
      sample: disabled
      type: str
    name:
      description: A friendly name or description for the interface or VLAN.
      returned: success
      sample: L3 interface
      type: str
    ospf_settings:
      contains:
        area:
          description: The OSPF area to which this interface should belong.
          returned: success
          sample: 0
          type: str
        cost:
          description: The path cost for this interface.
          returned: success
          sample: 1
          type: int
        is_passive_enabled:
          description: When enabled, OSPF will not run on the interface, but the subnet
            will still be advertised.
          returned: success
          sample: true
          type: bool
      description: The OSPF routing settings of the interface.
      returned: success
      type: complex
    subnet:
      description: The network that this routed interface is on, in CIDR notation.
      returned: success
      sample: 192.168.2.0/24
      type: str
    vlan_id:
      description: The VLAN this routed interface is on.
      returned: success
      sample: 10
      type: int
  description: Information about the layer 3 interfaces.
  returned: success
  type: complex