.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.meraki.meraki_syslog_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.meraki.meraki_syslog module -- Manage syslog server settings in the Meraki cloud. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.meraki collection `_ (version 2.20.6). To install it, use: :code:`ansible-galaxy collection install cisco.meraki`. To use it in a playbook, specify: :code:`cisco.meraki.meraki_syslog`. .. version_added .. contents:: :local: :depth: 1 .. Deprecated DEPRECATED ---------- :Removed in: version 3.0.0 :Why: Updated modules released with increased functionality :Alternative: cisco.meraki.networks\_syslog\_servers Synopsis -------- .. Description - Allows for creation and management of Syslog servers within Meraki. .. Aliases .. Requirements .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-auth_key: .. rst-class:: ansible-option-title **auth_key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Authentication key provided by the dashboard. Required if environmental variable MERAKI\_KEY is not set. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-host: .. rst-class:: ansible-option-title **host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"api.meraki.com"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-internal_error_retry_time: .. rst-class:: ansible-option-title **internal_error_retry_time** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of seconds to retry if server returns an internal server error. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-net_id: .. rst-class:: ansible-option-title **net_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ID number of a network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-name: .. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-net_name: .. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-network: .. rst-class:: ansible-option-title **net_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: name, network` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of a network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-org_id: .. rst-class:: ansible-option-title **org_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ID of organization. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-org_name: .. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-organization: .. rst-class:: ansible-option-title **org_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: organization` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of organization. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-output_format: .. rst-class:: ansible-option-title **output_format** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Instructs module whether response keys should be snake case (ex. \ :literal:`net\_id`\ ) or camel case (ex. \ :literal:`netId`\ ). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"snakecase"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"camelcase"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-output_level: .. rst-class:: ansible-option-title **output_level** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Set amount of debug output during module execution. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"debug"` - :ansible-option-choices-entry-default:`"normal"` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-rate_limit_retry_time: .. rst-class:: ansible-option-title **rate_limit_retry_time** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of seconds to retry if rate limiter is triggered. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`165` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-servers: .. rst-class:: ansible-option-title **servers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
List of syslog server settings .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-servers/host: .. rst-class:: ansible-option-title **host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP address or hostname of Syslog server. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-servers/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Port number Syslog server is listening on. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`514` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-servers/roles: .. rst-class:: ansible-option-title **roles** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
List of applicable Syslog server roles. Choices can be one of Wireless Event log, Appliance event log, Switch event log, Air Marshal events, Flows, URLs, IDS alerts, Security events .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-state: .. rst-class:: ansible-option-title **state** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Query or edit syslog servers To delete a syslog server, do not include server in list of servers .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"query"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-timeout: .. rst-class:: ansible-option-title **timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Time to timeout for HTTP requests. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`30` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-use_https: .. rst-class:: ansible-option-title **use_https** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
If \ :literal:`no`\ , it will use HTTP. Otherwise it will use HTTPS. Only useful for internal Meraki developers. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-use_proxy: .. rst-class:: ansible-option-title **use_proxy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
If \ :literal:`no`\ , it will not use a proxy, even if one is defined in an environment variable on the target hosts. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__parameter-validate_certs: .. rst-class:: ansible-option-title **validate_certs** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Whether to validate HTTP certificates. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes 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. - As of Ansible 2.9, Meraki modules output keys as snake case. To use camel case, set the \ :literal:`ANSIBLE\_MERAKI\_FORMAT`\ environment variable to \ :literal:`camelcase`\ . - Ansible's Meraki modules will stop supporting camel case output in Ansible 2.13. Please update your playbooks. - Check Mode downloads the current configuration from the dashboard, then compares changes against this download. Check Mode will report changed if there are differences in the configurations, but does not submit changes to the API for validation of change. .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - name: Query syslog configurations on network named MyNet in the YourOrg organization meraki_syslog: auth_key: abc12345 state: 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 state: present 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 state: present 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__return-data: .. rst-class:: ansible-option-title **data** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`complex` .. raw:: html
- .. raw:: html
Information about the created or manipulated object. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` info .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__return-data/servers: .. rst-class:: ansible-option-title **servers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`complex` .. raw:: html
- .. raw:: html
List of syslog servers. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` info .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__return-data/servers/host: .. rst-class:: ansible-option-title **host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Hostname or IP address of syslog server. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"192.0.1.1"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__return-data/servers/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Port number for syslog communication. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"443"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_syslog_module__return-data/servers/roles: .. rst-class:: ansible-option-title **roles** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
List of roles assigned to syslog server. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`["Wireless event log", " URLs"]` .. raw:: html
.. Status (Presently only deprecated) Status ------ .. Deprecated note - This module will be removed in version 3.0.0. *[deprecated]* - For more information see `DEPRECATED`_. .. Authors Authors ~~~~~~~ - Kevin Breit (@kbreit) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors