avi_alertsyslogconfig - Module for setup of AlertSyslogConfig Avi RESTful Object

New in version 2.4.

Synopsis

Requirements (on host that executes module)

  • avisdk

Options

parameter required default choices comments
api_version
 no
Avi API version of to use for Avi API and objects.
controller
 no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
description
 no
User defined description for alert syslog config.
name
 yes
A user-friendly name of the syslog notification.
password
 no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
state
 no present
  • absent
  • present
The state that should be applied on the entity.
syslog_servers
 no
The list of syslog servers.
tenant
 no admin
Name of tenant used for all Avi API calls and context of object.
tenant_ref
 no
It is a reference to an object of type tenant.
tenant_uuid
 no
UUID of tenant used for all Avi API calls and context of object.
url
 no
Avi controller URL of the object.
username
 no
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
 no
Unique object identifier of the object.

Examples

- name: Create Alert Syslog object to forward all events to external syslog server
  avi_alertsyslogconfig:
    controller: ''
    name: Roberts-syslog
    password: ''
    syslog_servers:
    - syslog_server: 10.10.0.100
      syslog_server_port: 514
      udp: true
    tenant_ref: admin
    username: ''

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
obj
AlertSyslogConfig (api/alertsyslogconfig) object
 success, changed dict

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/avi_alertsyslogconfig_module.html