avi_actiongroupconfig - Module for setup of ActionGroupConfig Avi RESTful Object
New in version 2.4.
Synopsis
- This module is used to configure ActionGroupConfig object
- more examples at https://github.com/avinetworks/devops
Requirements (on host that executes module)
- avisdk
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| action_script_config_ref |
no |
Reference of the action script configuration to be used.
It is a reference to an object of type alertscriptconfig.
|
||
| api_version |
no |
Avi API version of to use for Avi API and objects.
|
||
| autoscale_trigger_notification |
no |
Trigger notification to autoscale manager.
Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||
| controller |
no |
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
|
||
| description |
no |
User defined description for the object.
|
||
| email_config_ref |
no |
Select the email notification configuration to use when sending alerts via email.
It is a reference to an object of type alertemailconfig.
|
||
| external_only |
yes |
Generate alert only to external destinations.
Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||
| level |
yes |
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 |
yes |
Name of the object.
|
||
| password |
no |
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
|
||
| snmp_trap_profile_ref |
no |
Select the snmp trap notification to use when sending alerts via snmp trap.
It is a reference to an object of type snmptrapprofile.
|
||
| state |
no | present |
|
The state that should be applied on the entity.
|
| syslog_config_ref |
no |
Select the syslog notification configuration to use when sending alerts via syslog.
It is a reference to an object of type alertsyslogconfig.
|
||
| 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: 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 Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| obj |
ActionGroupConfig (api/actiongroupconfig) 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_actiongroupconfig_module.html