meraki_syslog – Manage syslog server settings in the Meraki cloud

From Get docs
Ansible/docs/2.8/modules/meraki syslog module


meraki_syslog – Manage syslog server settings in the Meraki cloud

New in version 2.8.


Synopsis

  • Allows for creation and management of Syslog servers within Meraki.

Parameters

Parameter Choices/Defaults Comments

auth_key

string

Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set.

host

string

Default:

"api.meraki.com"

Hostname for Meraki dashboard.

Can be used to access regional Meraki environments, such as China.

net_id

string

ID number of a network.

net_name

string

Name of a network.


aliases: name, network

org_id

string

ID of organization associated to a network.

org_name

string

Name of organization associated to a network.


aliases: organization

output_level

string

  • debug
  • normal

Set amount of debug output during module execution.

servers

-

List of syslog server settings

host

-

IP address or hostname of Syslog server.

port

-

Default:

"514"

Port number Syslog server is listening on.

roles

-

  • Wireless event log
  • Appliance event log
  • Switch event log
  • Air Marshal events
  • Flows
  • URLs
  • IDS alerts
  • Security events

List of applicable Syslog server roles.

state

string

  • present

  • query

Query or edit syslog servers

To delete a syslog server, do not include server in list of servers

timeout

integer

Default:

30

Time to timeout for HTTP requests.

use_https

boolean

  • no
  • yes

If no, it will use HTTP. Otherwise it will use HTTPS.

Only useful for internal Meraki developers.

use_proxy

boolean

  • no
  • yes

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

validate_certs

boolean

  • no
  • yes

Whether to validate HTTP certificates.



Notes

Note

  • Changes to existing syslog servers replaces existing configuration. If you need to add to an existing configuration set state to query to gather the existing configuration and then modify or add.
  • More information about the Meraki API can be found at https://dashboard.meraki.com/api_docs.
  • Some of the options are likely only used for developers within Meraki.


Examples

- name: Query syslog configurations on network named MyNet in the YourOrg organization
  meraki_syslog:
    auth_key: abc12345
    status: query
    org_name: YourOrg
    net_name: MyNet
  delegate_to: localhost

- name: Add single syslog server with Appliance event log role
  meraki_syslog:
    auth_key: abc12345
    status: query
    org_name: YourOrg
    net_name: MyNet
    servers:
      - host: 192.0.1.2
        port: 514
        roles:
          - Appliance event log
  delegate_to: localhost

- name: Add multiple syslog servers
  meraki_syslog:
    auth_key: abc12345
    status: query
    org_name: YourOrg
    net_name: MyNet
    servers:
      - host: 192.0.1.2
        port: 514
        roles:
          - Appliance event log
      - host: 192.0.1.3
        port: 514
        roles:
          - Appliance event log
          - Flows
  delegate_to: localhost

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

data

complex

info

Information about the created or manipulated object.


host

string

success

Hostname or IP address of syslog server.


Sample:

192.0.1.1

port

string

success

Port number for syslog communication.


Sample:

443

roles

list

success

List of roles assigned to syslog server.


Sample:

Wireless event log, URLs




Status

Authors

  • Kevin Breit (@kbreit)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/meraki_syslog_module.html