ansible / ansible.builtin / v2.8.11 / module / meraki_syslog Manage syslog server settings in the Meraki cloud. | "added in version" 2.8 of ansible.builtin" Authors: Kevin Breit (@kbreit) preview | supported by communityansible.builtin.meraki_syslog (v2.8.11) — module
pip
Install with pip install ansible==2.8.11
Allows for creation and management of Syslog servers within Meraki.
- 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
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: present description: - Query or edit syslog servers - To delete a syslog server, do not include server in list of servers type: str net_id: description: - ID number of a network. type: str org_id: description: - ID of organization associated to a network. type: str servers: description: - List of syslog server settings suboptions: host: description: - IP address or hostname of Syslog server. port: default: '514' description: - Port number Syslog server is listening on. roles: choices: - Wireless event log - Appliance event log - Switch event log - Air Marshal events - Flows - URLs - IDS alerts - Security events description: - List of applicable Syslog server roles. 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 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 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
data: contains: host: description: Hostname or IP address of syslog server. returned: success sample: 192.0.1.1 type: str port: description: Port number for syslog communication. returned: success sample: 443 type: str roles: description: List of roles assigned to syslog server. returned: success sample: Wireless event log, URLs type: list description: Information about the created or manipulated object. returned: info type: complex