community.general.avi_actiongroupconfig (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

This module is used to configure ActionGroupConfig object

more examples at U(https://github.com/avinetworks/devops)

Requirements

• avisdk

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Example to create ActionGroupConfig object
  avi_actiongroupconfig:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_actiongroupconfig

Inputs

    
url:
    description:
    - Avi controller URL of the object.

name:
    description:
    - Name of the object.
    required: true

uuid:
    description:
    - Unique object identifier of the object.

level:
    description:
    - 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.
    required: true

state:
    choices:
    - absent
    - present
    default: present
    description:
    - The state that should be applied on the entity.

tenant:
    default: admin
    description:
    - Name of tenant used for all Avi API calls and context of object.
    type: str

password:
    default: ''
    description:
    - Password of Avi user in Avi controller. The default value is the environment variable
      C(AVI_PASSWORD).
    type: str

username:
    default: ''
    description:
    - Username used for accessing Avi controller. The default value is the environment
      variable C(AVI_USERNAME).
    type: str

controller:
    default: ''
    description:
    - IP address or hostname of the controller. The default value is the environment variable
      C(AVI_CONTROLLER).
    type: str

tenant_ref:
    description:
    - It is a reference to an object of type tenant.

api_context:
    description:
    - Avi API context that includes current session ID and CSRF Token.
    - This allows user to perform single login and re-use the session.
    type: dict

api_version:
    default: 16.4.4
    description:
    - Avi API version of to use for Avi API and objects.
    type: str

description:
    description:
    - User defined description for the object.

tenant_uuid:
    default: ''
    description:
    - UUID of tenant used for all Avi API calls and context of object.
    type: str

external_only:
    description:
    - Generate alert only to external destinations.
    - Default value when not specified in API or module is interpreted by Avi Controller
      as False.
    required: true
    type: bool

avi_credentials:
    description:
    - Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller
      login details.
    suboptions:
      api_version:
        default: 16.4.4
        description:
        - Avi controller version
      controller:
        description:
        - Avi controller IP or SQDN
      csrftoken:
        description:
        - Avi controller API csrftoken to reuse existing session with session id
      password:
        description:
        - Avi controller password
      port:
        description:
        - Avi controller port
      session_id:
        description:
        - Avi controller API session id to reuse existing session with csrftoken
      tenant:
        default: admin
        description:
        - Avi controller tenant
      tenant_uuid:
        description:
        - Avi controller tenant UUID
      timeout:
        default: 300
        description:
        - Avi controller request timeout
      token:
        description:
        - Avi controller API token
      username:
        description:
        - Avi controller username
    type: dict

avi_api_patch_op:
    choices:
    - add
    - replace
    - delete
    description:
    - Patch operation to use when using avi_api_update_method as patch.

email_config_ref:
    description:
    - Select the email notification configuration to use when sending alerts via email.
    - It is a reference to an object of type alertemailconfig.

syslog_config_ref:
    description:
    - Select the syslog notification configuration to use when sending alerts via syslog.
    - It is a reference to an object of type alertsyslogconfig.

avi_api_update_method:
    choices:
    - put
    - patch
    default: put
    description:
    - Default method for object update is HTTP PUT.
    - Setting to patch will override that behavior to use HTTP PATCH.

snmp_trap_profile_ref:
    description:
    - Select the snmp trap notification to use when sending alerts via snmp trap.
    - It is a reference to an object of type snmptrapprofile.

action_script_config_ref:
    description:
    - Reference of the action script configuration to be used.
    - It is a reference to an object of type alertscriptconfig.

autoscale_trigger_notification:
    description:
    - Trigger notification to autoscale manager.
    - Default value when not specified in API or module is interpreted by Avi Controller
      as False.
    type: bool

avi_disable_session_cache_as_fact:
    description:
    - It disables avi session information to be cached as a fact.
    type: bool

Outputs

obj:
  description: ActionGroupConfig (api/actiongroupconfig) object
  returned: success, changed
  type: dict