community.network.pn_admin_syslog – CLI command to create/modify/delete admin-syslog

From Get docs
Ansible/docs/2.11/collections/community/network/pn admin syslog module


community.network.pn_admin_syslog – CLI command to create/modify/delete admin-syslog

Note

This plugin is part of the community.network collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.pn_admin_syslog.


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.

Parameters

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

  • structured
  • legacy

message-format for log events - structured or legacy.

pn_name

string

name of the system log.

pn_port

string

Host port.

pn_scope

string

  • local
  • fabric

Scope of the system log.

pn_transport

string

  • tcp-tls
  • udp

Transport for log events - tcp/tls or udp.

state

string / required

  • present
  • absent
  • update

State the action to perform. Use present to create admin-syslog and absent to delete admin-syslog update to modify the admin-syslog.



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 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 / elements=string

on error

set of error responses from the admin-syslog command.


stdout

list / elements=string

always

set of responses from the admin-syslog command.





Authors

  • Pluribus Networks (@rajaspachipulusu17)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/pn_admin_syslog_module.html