Avi TrafficCloneProfile Object API

##CLI## ``` - configure trafficcloneprofile - show trafficcloneprofile ```
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 /trafficcloneprofile
  2. post /trafficcloneprofile
  3. delete /trafficcloneprofile/{uuid}
  4. get /trafficcloneprofile/{uuid}
  5. patch /trafficcloneprofile/{uuid}
  6. put /trafficcloneprofile/{uuid}
Up
get /trafficcloneprofile
(trafficcloneprofileGet)

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.
cloud_uuid (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_uuid=cloud-xyz.
cloud_ref.name (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud usings its name. This uses cloud name rather than uuid. Eg. cloud_ref.name=Default-Cloud.

Return type

TrafficCloneProfileApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "clone_servers" : [ {
      "subnet" : {
        "ip_addr" : "",
        "mask" : 123
      },
      "ip_address" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "network_ref" : "aeiou",
      "mac" : "aeiou"
    } ],
    "preserve_client_ip" : true,
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "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 TrafficCloneProfileApiResponse

401

log in failed

Up
post /trafficcloneprofile
(trafficcloneprofilePost)

Consumes

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

Request body

body (required)
Body Parameter — TrafficCloneProfile object creation

Return type

TrafficCloneProfile

Example data

Content-Type: application/json
{
  "clone_servers" : [ {
    "subnet" : {
      "ip_addr" : "",
      "mask" : 123
    },
    "ip_address" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "network_ref" : "aeiou",
    "mac" : "aeiou"
  } ],
  "preserve_client_ip" : true,
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "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 TrafficCloneProfile

401

log in failed

Up
delete /trafficcloneprofile/{uuid}
(trafficcloneprofileUuidDelete)

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 /trafficcloneprofile/{uuid}
(trafficcloneprofileUuidGet)

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

TrafficCloneProfile

Example data

Content-Type: application/json
{
  "clone_servers" : [ {
    "subnet" : {
      "ip_addr" : "",
      "mask" : 123
    },
    "ip_address" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "network_ref" : "aeiou",
    "mac" : "aeiou"
  } ],
  "preserve_client_ip" : true,
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "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 TrafficCloneProfile

401

log in failed

Up
patch /trafficcloneprofile/{uuid}
(trafficcloneprofileUuidPatch)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

TrafficCloneProfile

Example data

Content-Type: application/json
{
  "clone_servers" : [ {
    "subnet" : {
      "ip_addr" : "",
      "mask" : 123
    },
    "ip_address" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "network_ref" : "aeiou",
    "mac" : "aeiou"
  } ],
  "preserve_client_ip" : true,
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "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 TrafficCloneProfile

401

log in failed

Up
put /trafficcloneprofile/{uuid}
(trafficcloneprofileUuidPut)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

TrafficCloneProfile

Example data

Content-Type: application/json
{
  "clone_servers" : [ {
    "subnet" : {
      "ip_addr" : "",
      "mask" : 123
    },
    "ip_address" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "network_ref" : "aeiou",
    "mac" : "aeiou"
  } ],
  "preserve_client_ip" : true,
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "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 TrafficCloneProfile

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. CloneServer
  2. IpAddr
  3. IpAddrPrefix
  4. TrafficCloneProfile
  5. TrafficCloneProfileApiResponse

CloneServer Up

ip_address (optional)
IpAddr IP Address of the Clone Server. Field introduced in 17.1.1.
mac (optional)
String MAC Address of the Clone Server. Field introduced in 17.1.1.
network_ref (optional)
String Network to clone the traffic to. It is a reference to an object of type Network. Field introduced in 17.1.1.
subnet (optional)
IpAddrPrefix Subnet of the network to clone the traffic to. Field introduced in 17.1.1.

IpAddr Up

addr
String IP address.
type
String Enum options - V4, DNS.

IpAddrPrefix Up

ip_addr
IpAddr Placeholder for description of property ip_addr of obj type IpAddrPrefix field type str type object
mask
Integer Number of mask. format: int32

TrafficCloneProfile Up

clone_servers (optional)
array[CloneServer] Field introduced in 17.1.1.
cloud_ref (optional)
String It is a reference to an object of type Cloud. Field introduced in 17.1.1.
name
String Name for the Traffic Clone Profile. Field introduced in 17.1.1.
preserve_client_ip (optional)
Boolean Specifies if client IP needs to be preserved to clone destination. Field introduced in 17.1.1.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Field introduced in 17.1.1.
url (optional)
String url
uuid (optional)
String UUID of the Traffic Clone Profile. Field introduced in 17.1.1.

TrafficCloneProfileApiResponse Up

count
Integer format: int32
results