community.network.pn_admin_syslog module – CLI command to create/modify/delete admin-syslog
Note
This module is part of the community.network collection (version 5.0.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.network
.
To use it in a playbook, specify: community.network.pn_admin_syslog
.
Note
The community.network collection has been deprecated and will be removed from Ansible 12. See the discussion thread for more information.
Synopsis
This module can be used to create the scope and other parameters of syslog event collection.
This module can be used to modify parameters of syslog event collection.
This module can be used to delete the scope and other parameters of syslog event collection.
Aliases: network.netvisor.pn_admin_syslog
Parameters
Parameter |
Comments |
---|---|
Target switch to run the CLI on. |
|
Hostname to log system events. |
|
message-format for log events - structured or legacy. Choices:
|
|
name of the system log. |
|
Host port. |
|
Scope of the system log. Choices:
|
|
Transport for log events - tcp/tls or udp. Choices:
|
|
State the action to perform. Use Choices:
|
Examples
- name: Admin-syslog functionality
community.network.pn_admin_syslog:
pn_cliswitch: "sw01"
state: "absent"
pn_name: "foo"
pn_scope: "local"
- name: Admin-syslog functionality
community.network.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
community.network.pn_admin_syslog:
pn_cliswitch: "sw01"
state: "update"
pn_name: "foo"
pn_host: "166.68.224.10"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
indicates whether the CLI caused changes on the target. Returned: always |
|
the CLI command run on the target node. Returned: always |
|
set of error responses from the admin-syslog command. Returned: on error |
|
set of responses from the admin-syslog command. Returned: always |