Documentation

avi_alertsyslogconfig - Module for setup of AlertSyslogConfig Avi RESTful Object

New in version 2.4.

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • avisdk

Parameters

Parameter Choices/Defaults Comments
api_context
(added in 2.5)
Avi API context that includes current session ID and CSRF Token.
This allows user to perform single login and re-use the session.
api_version Default:
16.4.4
Avi API version of to use for Avi API and objects.
avi_api_patch_op
(added in 2.5)
    Choices:
  • add
  • replace
  • delete
Patch operation to use when using avi_api_update_method as patch.
avi_api_update_method
(added in 2.5)
    Choices:
  • put ←
  • patch
Default method for object update is HTTP PUT.
Setting to patch will override that behavior to use HTTP PATCH.
avi_credentials
(added in 2.5)
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
controller Default:
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
description
User defined description for alert syslog config.
name
required
A user-friendly name of the syslog notification.
password Default:
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
state
    Choices:
  • absent
  • present ←
The state that should be applied on the entity.
syslog_servers
The list of syslog servers.
tenant Default:
admin
Name of tenant used for all Avi API calls and context of object.
tenant_ref
It is a reference to an object of type tenant.
tenant_uuid Default:
UUID of tenant used for all Avi API calls and context of object.
url
Avi controller URL of the object.
username Default:
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
Unique object identifier of the object.

Notes

Note

Examples

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

Return Values

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

Key Returned Description
obj
dict
success, changed
AlertSyslogConfig (api/alertsyslogconfig) object



Status

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

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

Author

Hint

If you notice any issues in this documentation you can edit this document to improve it.