New in version 2.8.
Parameter | Choices/Defaults | Comments |
---|---|---|
pn_cliswitch
string
|
Target switch to run the CLI on.
|
|
pn_host
string
|
Hostname to log system events.
|
|
pn_message_format
string
|
|
message-format for log events - structured or legacy.
|
pn_name
string
|
name of the system log.
|
|
pn_port
string
|
Host port.
|
|
pn_scope
string
|
|
Scope of the system log.
|
pn_transport
string
|
|
Transport for log events - tcp/tls or udp.
|
state
string
/ required
|
|
State the action to perform. Use
present to create admin-syslog and absent to delete admin-syslog update to modify the admin-syslog. |
- name: admin-syslog functionality
pn_admin_syslog:
pn_cliswitch: "sw01"
state: "absent"
pn_name: "foo"
pn_scope: "local"
- name: admin-syslog functionality
pn_admin_syslog:
pn_cliswitch: "sw01"
state: "present"
pn_name: "foo"
pn_scope: "local"
pn_host: "166.68.224.46"
pn_message_format: "structured"
- name: admin-syslog functionality
pn_admin_syslog:
pn_cliswitch: "sw01"
state: "update"
pn_name: "foo"
pn_host: "166.68.224.10"
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
changed
boolean
|
always |
indicates whether the CLI caused changes on the target.
|
command
string
|
always |
the CLI command run on the target node.
|
stderr
list
|
on error |
set of error responses from the admin-syslog command.
|
stdout
list
|
always |
set of responses from the admin-syslog command.
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.