New in version 2.8.
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
|
|
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
-
|
|
List of applicable Syslog server roles.
|
|
state
string
|
|
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
|
|
If
no , it will use HTTP. Otherwise it will use HTTPS.Only useful for internal Meraki developers.
|
|
use_proxy
boolean
|
|
If
no , it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
|
validate_certs
boolean
|
|
Whether to validate HTTP certificates.
|
Note
- 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
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
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.