Avi VSDataScriptSet Object API

##CLI## ``` - configure vsdatascriptset - show vsdatascriptset ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
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 /vsdatascriptset
  2. post /vsdatascriptset
  3. delete /vsdatascriptset/{uuid}
  4. get /vsdatascriptset/{uuid}
  5. patch /vsdatascriptset/{uuid}
  6. put /vsdatascriptset/{uuid}
Up
get /vsdatascriptset
(vsdatascriptsetGet)

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.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

VSDataScriptSetApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "pool_refs" : [ "aeiou" ],
    "string_group_refs" : [ "aeiou" ],
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "description" : "aeiou",
    "pool_group_refs" : [ "aeiou" ],
    "ipgroup_refs" : [ "aeiou" ],
    "created_by" : "aeiou",
    "datascript" : [ {
      "evt" : "aeiou",
      "script" : "aeiou"
    } ],
    "uuid" : "aeiou",
    "url" : "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 VSDataScriptSetApiResponse

401

log in failed

Up
post /vsdatascriptset
(vsdatascriptsetPost)

Consumes

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

Request body

body (required)
Body Parameter — VSDataScriptSet object creation

Return type

VSDataScriptSet

Example data

Content-Type: application/json
{
  "pool_refs" : [ "aeiou" ],
  "string_group_refs" : [ "aeiou" ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "pool_group_refs" : [ "aeiou" ],
  "ipgroup_refs" : [ "aeiou" ],
  "created_by" : "aeiou",
  "datascript" : [ {
    "evt" : "aeiou",
    "script" : "aeiou"
  } ],
  "uuid" : "aeiou",
  "url" : "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 VSDataScriptSet

401

log in failed

Up
delete /vsdatascriptset/{uuid}
(vsdatascriptsetUuidDelete)

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 /vsdatascriptset/{uuid}
(vsdatascriptsetUuidGet)

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.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

VSDataScriptSet

Example data

Content-Type: application/json
{
  "pool_refs" : [ "aeiou" ],
  "string_group_refs" : [ "aeiou" ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "pool_group_refs" : [ "aeiou" ],
  "ipgroup_refs" : [ "aeiou" ],
  "created_by" : "aeiou",
  "datascript" : [ {
    "evt" : "aeiou",
    "script" : "aeiou"
  } ],
  "uuid" : "aeiou",
  "url" : "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 VSDataScriptSet

401

log in failed

Up
patch /vsdatascriptset/{uuid}
(vsdatascriptsetUuidPatch)

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 — VSDataScriptSet object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

VSDataScriptSet

Example data

Content-Type: application/json
{
  "pool_refs" : [ "aeiou" ],
  "string_group_refs" : [ "aeiou" ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "pool_group_refs" : [ "aeiou" ],
  "ipgroup_refs" : [ "aeiou" ],
  "created_by" : "aeiou",
  "datascript" : [ {
    "evt" : "aeiou",
    "script" : "aeiou"
  } ],
  "uuid" : "aeiou",
  "url" : "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 VSDataScriptSet

401

log in failed

Up
put /vsdatascriptset/{uuid}
(vsdatascriptsetUuidPut)

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 — VSDataScriptSet object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

VSDataScriptSet

Example data

Content-Type: application/json
{
  "pool_refs" : [ "aeiou" ],
  "string_group_refs" : [ "aeiou" ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "pool_group_refs" : [ "aeiou" ],
  "ipgroup_refs" : [ "aeiou" ],
  "created_by" : "aeiou",
  "datascript" : [ {
    "evt" : "aeiou",
    "script" : "aeiou"
  } ],
  "uuid" : "aeiou",
  "url" : "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 VSDataScriptSet

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. VSDataScript
  2. VSDataScriptSet
  3. VSDataScriptSetApiResponse

VSDataScript Up

evt
String Event triggering execution of datascript. Enum options - VS_DATASCRIPT_EVT_HTTP_REQ, VS_DATASCRIPT_EVT_HTTP_RESP, VS_DATASCRIPT_EVT_HTTP_RESP_DATA, VS_DATASCRIPT_EVT_HTTP_LB_FAILED, VS_DATASCRIPT_EVT_HTTP_REQ_DATA, VS_DATASCRIPT_EVT_HTTP_RESP_FAILED, VS_DATASCRIPT_EVT_MAX.
script
String Datascript to execute when the event triggers.

VSDataScriptSet Up

created_by (optional)
String Creator name. Field introduced in 17.1.11,17.2.4.
datascript (optional)
array[VSDataScript] DataScripts to execute.
description (optional)
String User defined description for the object.
ipgroup_refs (optional)
array[String] UUID of IP Groups that could be referred by VSDataScriptSet objects. It is a reference to an object of type IpAddrGroup.
name
String Name for the virtual service datascript collection.
pool_group_refs (optional)
array[String] UUID of pool groups that could be referred by VSDataScriptSet objects. It is a reference to an object of type PoolGroup.
pool_refs (optional)
array[String] UUID of pools that could be referred by VSDataScriptSet objects. It is a reference to an object of type Pool.
string_group_refs (optional)
array[String] UUID of String Groups that could be referred by VSDataScriptSet objects. It is a reference to an object of type StringGroup.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
String url
uuid (optional)
String UUID of the virtual service datascript collection.

VSDataScriptSetApiResponse Up

count
Integer format: int32
results