Deprecated

Removed in 3.0.0

i

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

cisco.meraki.meraki_management_interface (2.18.0) — module

Configure Meraki management interfaces

| "added in version" 1.1.0 of cisco.meraki"

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 configuration of management interfaces on Meraki MX, MS, and MR devices.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set WAN2 as static IP
  meraki_management_interface:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_id: YourNetId
    serial: AAAA-BBBB-CCCC
    wan2:
      wan_enabled: enabled
      using_static_ip: yes
      static_ip: 192.168.16.195
      static_gateway_ip: 192.168.16.1
      static_subnet_mask: 255.255.255.0
      static_dns:
        - 1.1.1.1
      vlan: 1
  delegate_to: localhost
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Query management information
  meraki_management_interface:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_id: YourNetId
    serial: AAAA-BBBB-CCCC
  delegate_to: localhost

Inputs

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

wan1:
    aliases:
    - mgmt1
    description:
    - Management interface details for management interface.
    suboptions:
      static_dns:
        description:
        - DNS servers to use.
        - Allows for a maximum of 2 addresses.
        elements: str
        type: list
      static_gateway_ip:
        description:
        - IP address for default gateway.
        - Valid only if C(using_static_ip) is C(True).
        type: str
      static_ip:
        description:
        - IP address assigned to Management interface.
        - Valid only if C(using_static_ip) is C(True).
        type: str
      static_subnet_mask:
        description:
        - Netmask for static IP address.
        - Valid only if C(using_static_ip) is C(True).
        type: str
      using_static_ip:
        description:
        - Configures the interface to use static IP or DHCP.
        type: bool
      vlan:
        description:
        - VLAN number to use for the management network.
        type: int
      wan_enabled:
        choices:
        - disabled
        - enabled
        - not configured
        description:
        - States whether the management interface is enabled.
        - Only valid for MX devices.
        type: str
    type: dict

wan2:
    aliases:
    - mgmt2
    description:
    - Management interface details for management interface.
    suboptions:
      static_dns:
        description:
        - DNS servers to use.
        - Allows for a maximum of 2 addresses.
        elements: str
        type: list
      static_gateway_ip:
        description:
        - IP address for default gateway.
        - Valid only if C(using_static_ip) is C(True).
        type: str
      static_ip:
        description:
        - IP address assigned to Management interface.
        - Valid only if C(using_static_ip) is C(True).
        type: str
      static_subnet_mask:
        description:
        - Netmask for static IP address.
        - Valid only if C(using_static_ip) is C(True).
        type: str
      using_static_ip:
        description:
        - Configures the interface to use static IP or DHCP.
        type: bool
      vlan:
        description:
        - VLAN number to use for the management network.
        type: int
      wan_enabled:
        choices:
        - disabled
        - enabled
        - not configured
        description:
        - States whether the management interface is enabled.
        - Only valid for MX devices.
        type: str
    type: dict

state:
    choices:
    - absent
    - query
    - present
    default: query
    description:
    - Specifies whether configuration template information should be queried, modified,
      or deleted.
    type: str

net_id:
    description:
    - ID of the network to bind or unbind configuration template to.
    type: str

org_id:
    description:
    - ID of organization associated to a configuration template.
    type: str

serial:
    description:
    - serial number of the device to configure.
    required: true
    type: str

timeout:
    default: 30
    description:
    - Time to timeout for HTTP requests.
    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:
    description:
    - Name of the network to bind or unbind configuration template to.
    type: str

org_name:
    aliases:
    - organization
    description:
    - Name of organization containing the configuration template.
    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

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

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

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:
    wan1:
      contains:
        static_dns:
          description: List of DNS IP addresses
          returned: only if static IP assignment is used
          sample:
          - 1.1.1.1
          type: list
        static_gateway_ip:
          description: Assigned static gateway IP
          returned: only if static IP assignment is used
          sample: 192.0.1.1
          type: str
        static_ip:
          description: Assigned static IP
          returned: only if static IP assignment is used
          sample: 192.0.1.2
          type: str
        static_subnet_mask:
          description: Assigned netmask for static IP
          returned: only if static IP assignment is used
          sample: 255.255.255.0
          type: str
        using_static_ip:
          description: Boolean value of whether static IP assignment is used on interface
          returned: success
          sample: true
          type: bool
        vlan:
          description: VLAN tag id of management VLAN
          returned: success
          sample: 2
          type: int
        wan_enabled:
          description: Enabled state of interface
          returned: success
          sample: enabled
          type: str
      description: Management configuration for WAN1 interface
      returned: success
      type: complex
    wan2:
      contains:
        static_dns:
          description: List of DNS IP addresses
          returned: only if static IP assignment is used
          sample:
          - 1.1.1.1
          type: list
        static_gateway_ip:
          description: Assigned static gateway IP
          returned: only if static IP assignment is used
          sample: 192.0.1.1
          type: str
        static_ip:
          description: Assigned static IP
          returned: only if static IP assignment is used
          sample: 192.0.1.2
          type: str
        static_subnet_mask:
          description: Assigned netmask for static IP
          returned: only if static IP assignment is used
          sample: 255.255.255.0
          type: str
        using_static_ip:
          description: Boolean value of whether static IP assignment is used on interface
          returned: success
          sample: true
          type: bool
        vlan:
          description: VLAN tag id of management VLAN
          returned: success
          sample: 2
          type: int
        wan_enabled:
          description: Enabled state of interface
          returned: success
          sample: enabled
          type: str
      description: Management configuration for WAN1 interface
      returned: success
      type: complex
  description: Information about queried object.
  returned: success
  type: complex