Avi ActionGroupConfig Object API

CLI ``` - configure actiongroupconfig - show actiongroupconfig ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 20.1.9
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /actiongroupconfig
  2. post /actiongroupconfig
  3. delete /actiongroupconfig/{uuid}
  4. get /actiongroupconfig/{uuid}
  5. patch /actiongroupconfig/{uuid}
  6. put /actiongroupconfig/{uuid}
Up 
get /actiongroupconfig
(actiongroupconfigGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

ActionGroupConfigApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "syslog_config_ref" : "aeiou",
    "external_only" : true,
    "level" : "aeiou",
    "action_script_config_ref" : "aeiou",
    "description" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "autoscale_trigger_notification" : true,
    "snmp_trap_profile_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "email_config_ref" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ActionGroupConfigApiResponse

401

log in failed
Up 
post /actiongroupconfig
(actiongroupconfigPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — ActionGroupConfig object creation

Return type

ActionGroupConfig

Example data

Content-Type: application/json
{
  "syslog_config_ref" : "aeiou",
  "external_only" : true,
  "level" : "aeiou",
  "action_script_config_ref" : "aeiou",
  "description" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "autoscale_trigger_notification" : true,
  "snmp_trap_profile_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "email_config_ref" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ActionGroupConfig

401

log in failed
Up 
delete /actiongroupconfig/{uuid}
(actiongroupconfigUuidDelete)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found
Up 
get /actiongroupconfig/{uuid}
(actiongroupconfigUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

ActionGroupConfig

Example data

Content-Type: application/json
{
  "syslog_config_ref" : "aeiou",
  "external_only" : true,
  "level" : "aeiou",
  "action_script_config_ref" : "aeiou",
  "description" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "autoscale_trigger_notification" : true,
  "snmp_trap_profile_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "email_config_ref" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ActionGroupConfig

401

log in failed
Up 
patch /actiongroupconfig/{uuid}
(actiongroupconfigUuidPatch)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — ActionGroupConfig object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

ActionGroupConfig

Example data

Content-Type: application/json
{
  "syslog_config_ref" : "aeiou",
  "external_only" : true,
  "level" : "aeiou",
  "action_script_config_ref" : "aeiou",
  "description" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "autoscale_trigger_notification" : true,
  "snmp_trap_profile_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "email_config_ref" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ActionGroupConfig

401

log in failed
Up 
put /actiongroupconfig/{uuid}
(actiongroupconfigUuidPut)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — ActionGroupConfig object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

ActionGroupConfig

Example data

Content-Type: application/json
{
  "syslog_config_ref" : "aeiou",
  "external_only" : true,
  "level" : "aeiou",
  "action_script_config_ref" : "aeiou",
  "description" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "autoscale_trigger_notification" : true,
  "snmp_trap_profile_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "email_config_ref" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ActionGroupConfig

401

log in failed
Up

Models

[ Jump to Methods ]

Table of Contents

  1. ActionGroupConfig
  2. ActionGroupConfigApiResponse

ActionGroupConfig Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
action_script_config_ref (optional)
String reference of the action script configuration to be used. It is a reference to an object of type AlertScriptConfig.
autoscale_trigger_notification (optional)
Boolean Trigger Notification to AutoScale Manager. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
description (optional)
String User defined description for the object.
email_config_ref (optional)
String 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 Generate Alert only to external destinations. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition.
level
String When an alert is generated, mark its priority via the Alert Level. Enum options - ALERT_LOW, ALERT_MEDIUM, ALERT_HIGH.
name
String Name of the object.
snmp_trap_profile_ref (optional)
String Select the SNMP Trap Notification to use when sending alerts via SNMP Trap. It is a reference to an object of type SnmpTrapProfile.
syslog_config_ref (optional)
String Select the Syslog Notification configuration to use when sending alerts via Syslog. It is a reference to an object of type AlertSyslogConfig.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.

ActionGroupConfigApiResponse Up

count
Integer format: int32
results
array[ActionGroupConfig]
next (optional)
String