ansible.builtin.meraki_malware (v2.9.24) — module

Install Ansible via pip

Install with pip install ansible==2.9.24

Description

Fully configure malware protection in a Meraki environment.

Usage examples

Scanned by Steampunk Spotter

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

  - name: Enable malware protection
    meraki_malware:
      auth_key: abc123
      state: present
      org_name: YourOrg
      net_name: YourNet
      mode: enabled
    delegate_to: localhost

Scanned by Steampunk Spotter

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

  - name: Set whitelisted url
    meraki_malware:
      auth_key: abc123
      state: present
      org_name: YourOrg
      net_name: YourNet
      mode: enabled
      allowed_urls:
        - url: www.google.com
          comment: Google
    delegate_to: localhost

Scanned by Steampunk Spotter

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

  - name: Set whitelisted file
    meraki_malware:
      auth_key: abc123
      state: present
      org_name: YourOrg
      net_name: YourNet
      mode: enabled
      allowed_files:
        - sha256: e82c5f7d75004727e1f3b94426b9a11c8bc4c312a9170ac9a73abace40aef503
          comment: random zip
    delegate_to: localhost

Scanned by Steampunk Spotter

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

  - name: Get malware settings
    meraki_malware:
      auth_key: abc123
      state: query
      org_name: YourNet
      net_name: YourOrg
    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

mode:
    choices:
    - disabled
    - enabled
    description:
    - Enabled or disabled state of malware protection.

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 configuration is applied to.
    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:
    - network
    description:
    - Name of network which configuration is applied to.
    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

allowed_urls:
    description:
    - List of URLs to whitelist.
    suboptions:
      comment:
        description:
        - Human readable information about URL.
        type: str
      url:
        description:
        - URL string to allow.
        type: str

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

allowed_files:
    description:
    - List of files to whitelist.
    suboptions:
      comment:
        description:
        - Human readable information about file.
        type: str
      sha256:
        aliases:
        - hash
        description:
        - 256-bit hash of file.
        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:
    allowed_files:
      contains:
        comment:
          description: Comment about the whitelisted entity
          returned: success
          sample: TPS report
          type: str
        sha256:
          description: sha256 hash of whitelisted file.
          returned: success
          sample: e82c5f7d75004727e1f3b94426b9a11c8bc4c312a9170ac9a73abace40aef503
          type: str
      description: List of files which are whitelisted.
      returned: success
      type: complex
    allowed_urls:
      contains:
        comment:
          description: Comment about the whitelisted entity
          returned: success
          sample: Corporate HQ
          type: str
        url:
          description: URL of whitelisted site.
          returned: success
          sample: site.com
          type: str
      description: List of URLs which are whitelisted.
      returned: success
      type: complex
    mode:
      description: Mode to enable or disable malware scanning.
      returned: success
      sample: enabled
      type: str
  description: List of administrators.
  returned: success
  type: complex