cisco.meraki.meraki_mx_uplink_bandwidth (2.18.0) — module

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

Configure and query information about uplinks on Meraki MX appliances.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Set MX uplink settings
  meraki_mx_uplink_bandwidth:
    auth_key: '{{auth_key}}'
    state: present
    org_name: '{{test_org_name}}'
    net_name: '{{test_net_name}} - Uplink'
    wan1:
      bandwidth_limits:
        limit_down: 1000000
        limit_up: 1000
    cellular:
      bandwidth_limits:
        limit_down: 0
        limit_up: 0
  delegate_to: localhost

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Query MX uplink settings
  meraki_mx_uplink_bandwidth:
    auth_key: '{{auth_key}}'
    state: query
    org_name: '{{test_org_name}}'
    net_name: '{{test_net_name}} - Uplink'
  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:
    description:
    - Configuration of WAN1 uplink
    suboptions:
      bandwidth_limits:
        description:
        - Structure for configuring bandwidth limits
        suboptions:
          limit_down:
            description:
            - Maximum download speed for interface
            type: int
          limit_up:
            description:
            - Maximum upload speed for interface
            type: int
        type: dict
    type: dict

wan2:
    description:
    - Configuration of WAN2 uplink
    suboptions:
      bandwidth_limits:
        description:
        - Structure for configuring bandwidth limits
        suboptions:
          limit_down:
            description:
            - Maximum download speed for interface
            type: int
          limit_up:
            description:
            - Maximum upload speed for interface
            type: int
        type: dict
    type: dict

state:
    choices:
    - absent
    - present
    - query
    default: query
    description:
    - Specifies whether object should be queried, created/modified, or removed.
    type: str

net_id:
    description:
    - ID of network which VLAN is in or should be in.
    type: str

org_id:
    description:
    - ID of organization associated to a network.
    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

cellular:
    description:
    - Configuration of cellular uplink
    suboptions:
      bandwidth_limits:
        description:
        - Structure for configuring bandwidth limits
        suboptions:
          limit_down:
            description:
            - Maximum download speed for interface
            type: int
          limit_up:
            description:
            - Maximum upload speed for interface
            type: int
        type: dict
    type: dict

net_name:
    aliases:
    - network
    description:
    - Name of network which VLAN is in or should be in.
    type: str

org_name:
    aliases:
    - organization
    description:
    - Name of organization associated to a network.
    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:
    cellular:
      contains:
        bandwidth_limits:
          contains:
            limit_down:
              description: Download bandwidth limit
              returned: success
              type: int
            limit_up:
              description: Upload bandwidth limit
              returned: success
              type: int
          description: Structure for uplink bandwidth limits
          returned: success
          type: complex
      description: cellular interface
      returned: success
      type: complex
    wan1:
      contains:
        bandwidth_limits:
          contains:
            limit_down:
              description: Download bandwidth limit
              returned: success
              type: int
            limit_up:
              description: Upload bandwidth limit
              returned: success
              type: int
          description: Structure for uplink bandwidth limits
          returned: success
          type: complex
      description: WAN1 interface
      returned: success
      type: complex
    wan2:
      contains:
        bandwidth_limits:
          contains:
            limit_down:
              description: Download bandwidth limit
              returned: success
              type: int
            limit_up:
              description: Upload bandwidth limit
              returned: success
              type: int
          description: Structure for uplink bandwidth limits
          returned: success
          type: complex
      description: WAN2 interface
      returned: success
      type: complex
  description: Information about the organization which was created or modified
  returned: success
  type: complex