avi_actiongroupconfig – Module for setup of ActionGroupConfig Avi RESTful Object

From Get docs
Ansible/docs/2.8/modules/avi actiongroupconfig module


avi_actiongroupconfig – Module for setup of ActionGroupConfig 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

action_script_config_ref

-

Reference of the action script configuration to be used.

It is a reference to an object of type alertscriptconfig.

api_context

dictionary

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

string

Default:

"16.4.4"

Avi API version of to use for Avi API and objects.

autoscale_trigger_notification

boolean

  • no
  • yes

Trigger notification to autoscale manager.

Default value when not specified in API or module is interpreted by Avi Controller as False.

avi_api_patch_op

-

added in 2.5

  • add
  • replace
  • delete

Patch operation to use when using avi_api_update_method as patch.

avi_api_update_method

-

added in 2.5

  • put

  • patch

Default method for object update is HTTP PUT.

Setting to patch will override that behavior to use HTTP PATCH.

avi_credentials

dictionary

added in 2.5

Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.

controller

string

Default:

""

IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.

description

-

User defined description for the object.

email_config_ref

-

Select the email notification configuration to use when sending alerts via email.

It is a reference to an object of type alertemailconfig.

external_only

boolean / required

  • no
  • yes

Generate alert only to external destinations.

Default value when not specified in API or module is interpreted by Avi Controller as False.

level

- / required

When an alert is generated, mark its priority via the alert level.

Enum options - ALERT_LOW, ALERT_MEDIUM, ALERT_HIGH.

Default value when not specified in API or module is interpreted by Avi Controller as ALERT_LOW.

name

- / required

Name of the object.

password

string

Default:

""

Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.

snmp_trap_profile_ref

-

Select the snmp trap notification to use when sending alerts via snmp trap.

It is a reference to an object of type snmptrapprofile.

state

-

  • absent
  • present

The state that should be applied on the entity.

syslog_config_ref

-

Select the syslog notification configuration to use when sending alerts via syslog.

It is a reference to an object of type alertsyslogconfig.

tenant

string

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

string

Default:

""

UUID of tenant used for all Avi API calls and context of object.

url

-

Avi controller URL of the object.

username

string

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: Example to create ActionGroupConfig object
  avi_actiongroupconfig:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_actiongroupconfig

Return Values

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

Key Returned Description

obj

dictionary

success, changed

ActionGroupConfig (api/actiongroupconfig) object





Status

Authors

Hint

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


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