/ home / ansible / ansible.builtin / v2.9.27 / module / purefa_syslog

ansible.builtin.purefa_syslog (v2.9.27) — module

Configure Pure Storage FlashArray syslog settings

| "added in version" 2.9 of ansible.builtin"

Authors: Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>

preview | supported by community

Install Ansible via `pip`

Install with pip install ansible==2.9.27

Description

Configure syslog configuration for Pure Storage FlashArrays.

Add or delete an individual syslog server to the existing list of serves.

Requirements

python >= 2.7
purestorage

Usage examples

Scanned by Steampunk Spotter

- name: Delete existing syslog server entries
  purefa_syslog:
    address: syslog1.com
    protocol: tcp
    state: absent
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Scanned by Steampunk Spotter

- name: Set array syslog servers
  purefa_syslog:
    state: present
    address: syslog1.com
    protocol: udp
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Inputs

    
port:
    description:
    - Port at which the server is listening. If no port is specified the system will use
      514
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Create or delete syslog servers configuration
    type: str

fa_url:
    description:
    - FlashArray management IPv4 address or Hostname.
    required: true
    type: str

address:
    description:
    - Syslog server address. This field supports IPv4, IPv6 or FQDN. An invalid IP addresses
      will cause the module to fail. No validation is performed for FQDNs.
    required: true
    type: str

protocol:
    choices:
    - tcp
    - tls
    - udp
    description:
    - Protocol which server uses
    required: true
    type: str

api_token:
    description:
    - FlashArray API token for admin privileged user.
    required: true
    type: str