Deprecated

Removed in 3.0.0

i

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

cisco.meraki.meraki_network_settings (2.18.0) — module

Manage the settings of networks in the Meraki cloud

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 management of settings of networks within Meraki.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get network settings
    cisco.meraki.meraki_network_settings:
      auth_key: '{{ auth_key }}'
      state: query
      org_name: '{{test_org_name}}'
      net_name: NetworkSettingsTestNet
    delegate_to: localhost
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Update network settings
    cisco.meraki.meraki_network_settings:
      auth_key: '{{ auth_key }}'
      state: present
      org_name: '{{test_org_name}}'
      net_name: NetworkSettingsTestNet
      local_status_page_enabled: false
    delegate_to: localhost
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Enable password on local page
    cisco.meraki.meraki_network_settings:
      auth_key: '{{ auth_key }}'
      state: present
      org_name: '{{test_org_name}}'
      net_name: NetworkSettingsTestNet
      local_status_page_enabled: true
      local_status_page:
        authentication:
          enabled: true
          password: abc123
    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

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

net_id:
    description:
    - ID number of a network.
    type: str

org_id:
    description:
    - ID of organization.
    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:
    aliases:
    - name
    - network
    description:
    - Name of a network.
    type: str

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

secure_port:
    description:
    - Configuration of SecureConnect options applied to the network.
    suboptions:
      enabled:
        description:
        - Set whether SecureConnect is enabled on the network.
        type: bool
    type: dict

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

local_status_page:
    description:
    - Configuration stanza of the local status page.
    suboptions:
      authentication:
        description:
        - Local status page authentication settings.
        suboptions:
          enabled:
            description:
            - Set whether local status page authentication is enabled.
            type: bool
          password:
            description:
            - Set password on local status page.
            type: str
        type: dict
    type: dict

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

local_status_page_enabled:
    description: '- Enables the local device status pages (U[my.meraki.com](my.meraki.com),
      U[ap.meraki.com](ap.meraki.com), U[switch.meraki.com](switch.meraki.com), U[wired.meraki.com](wired.meraki.com)).
      - Only can be specified on its own or with C(remote_status_page_enabled).

      '
    type: bool

remote_status_page_enabled:
    description:
    - Enables access to the device status page (U(http://device LAN IP)).
    - Can only be set if C(local_status_page_enabled:) is set to C(yes).
    - Only can be specified on its own or with C(local_status_page_enabled).
    type: bool

Outputs

data:
  contains:
    expire_data_older_than:
      description: The number of days, weeks, or months in Epoch time to expire the
        data before
      returned: success
      sample: 1234
      type: int
    fips:
      contains:
        enabled:
          description: Enables/disables FIPS on the network.
          returned: success
          sample: true
          type: bool
      description: A hash of FIPS options applied to the Network.
      returned: success
      type: complex
    local_status_page:
      contains:
        authentication:
          contains:
            enabled:
              description: Enables/Disables the authenticaiton on Local Status Pages.
              returned: success
              type: bool
            username:
              description: The username used for Local Status Pages.
              returned: success
              sample: admin
              type: str
          description: A hash of Local Status Pages' authentication options applied
            to the Network.
          sample: true
          type: complex
      description: A hash of Local Status Page(s) authentication options applied to
        the Network.
      returned: success
      type: complex
    local_status_page_enabled:
      description: States whether U(my.meraki.com) and other device portals should
        be enabled.
      returned: success
      sample: true
      type: bool
    named_vlans:
      contains:
        enabled:
          description: Enables/disables Named VLANs on the network.
          returned: success
          sample: true
          type: bool
      description: A hash of Named VLANs options applied to the Network.
      type: complex
    remote_status_page_enabled:
      description: Enables access to the device status page.
      returned: success
      sample: true
      type: bool
    secure_port:
      contains:
        enabled:
          description: Enables/disables SecureConnect on the network.
          returned: success
          sample: true
          type: bool
      description: A hash of SecureConnect options applied to the Network.
      type: complex
  description: Information about the created or manipulated object.
  returned: info
  type: complex