community.general.pn_admin_syslog (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: admin-syslog functionality
  pn_admin_syslog:
    pn_cliswitch: "sw01"
    state: "absent"
    pn_name: "foo"
    pn_scope: "local"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: admin-syslog functionality
  pn_admin_syslog:
    pn_cliswitch: "sw01"
    state: "update"
    pn_name: "foo"
    pn_host: "166.68.224.10"

Inputs

    
state:
    choices:
    - present
    - absent
    - update
    description:
    - State the action to perform. Use C(present) to create admin-syslog and C(absent)
      to delete admin-syslog C(update) to modify the admin-syslog.
    required: true
    type: str

pn_host:
    description:
    - Hostname to log system events.
    required: false
    type: str

pn_name:
    description:
    - name of the system log.
    required: false
    type: str

pn_port:
    description:
    - Host port.
    required: false
    type: str

pn_scope:
    choices:
    - local
    - fabric
    description:
    - Scope of the system log.
    required: false
    type: str

pn_cliswitch:
    description:
    - Target switch to run the CLI on.
    required: false
    type: str

pn_transport:
    choices:
    - tcp-tls
    - udp
    default: udp
    description:
    - Transport for log events - tcp/tls or udp.
    required: false
    type: str

pn_message_format:
    choices:
    - structured
    - legacy
    description:
    - message-format for log events - structured or legacy.
    required: false
    type: str

Outputs

changed:
  description: indicates whether the CLI caused changes on the target.
  returned: always
  type: bool
command:
  description: the CLI command run on the target node.
  returned: always
  type: str
stderr:
  description: set of error responses from the admin-syslog command.
  returned: on error
  type: list
stdout:
  description: set of responses from the admin-syslog command.
  returned: always
  type: list