Avi APICLifsRuntime Object API

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

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

APICLifsRuntimeApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "subnet" : "aeiou",
    "tenant_name" : "aeiou",
    "transaction_uuid" : [ "aeiou" ],
    "uuid" : "aeiou",
    "url" : "aeiou",
    "lif_label" : "aeiou",
    "network" : "aeiou",
    "multi_vrf" : true,
    "vs_uuid" : [ "aeiou" ],
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "auto_allocated" : true,
    "cifs" : [ {
      "cif" : "aeiou",
      "adapter" : "aeiou",
      "mac_address" : "aeiou",
      "resources" : [ "aeiou" ],
      "se_uuid" : "aeiou"
    } ],
    "se_uuid" : [ "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 APICLifsRuntimeApiResponse

401

log in failed

Up
post /apiclifsruntime
( apiclifsruntimePost)

Consumes

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

Request body

body (required)
Body Parameter — APICLifsRuntime object creation

Return type

APICLifsRuntime

Example data

Content-Type: application/json
{
  "subnet" : "aeiou",
  "tenant_name" : "aeiou",
  "transaction_uuid" : [ "aeiou" ],
  "uuid" : "aeiou",
  "url" : "aeiou",
  "lif_label" : "aeiou",
  "network" : "aeiou",
  "multi_vrf" : true,
  "vs_uuid" : [ "aeiou" ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "auto_allocated" : true,
  "cifs" : [ {
    "cif" : "aeiou",
    "adapter" : "aeiou",
    "mac_address" : "aeiou",
    "resources" : [ "aeiou" ],
    "se_uuid" : "aeiou"
  } ],
  "se_uuid" : [ "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 APICLifsRuntime

401

log in failed

Up
delete /apiclifsruntime/{uuid}
( apiclifsruntimeUuidDelete)

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 /apiclifsruntime/{uuid}
( apiclifsruntimeUuidGet)

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

APICLifsRuntime

Example data

Content-Type: application/json
{
  "subnet" : "aeiou",
  "tenant_name" : "aeiou",
  "transaction_uuid" : [ "aeiou" ],
  "uuid" : "aeiou",
  "url" : "aeiou",
  "lif_label" : "aeiou",
  "network" : "aeiou",
  "multi_vrf" : true,
  "vs_uuid" : [ "aeiou" ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "auto_allocated" : true,
  "cifs" : [ {
    "cif" : "aeiou",
    "adapter" : "aeiou",
    "mac_address" : "aeiou",
    "resources" : [ "aeiou" ],
    "se_uuid" : "aeiou"
  } ],
  "se_uuid" : [ "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 APICLifsRuntime

401

log in failed

Up
patch /apiclifsruntime/{uuid}
( apiclifsruntimeUuidPatch)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

APICLifsRuntime

Example data

Content-Type: application/json
{
  "subnet" : "aeiou",
  "tenant_name" : "aeiou",
  "transaction_uuid" : [ "aeiou" ],
  "uuid" : "aeiou",
  "url" : "aeiou",
  "lif_label" : "aeiou",
  "network" : "aeiou",
  "multi_vrf" : true,
  "vs_uuid" : [ "aeiou" ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "auto_allocated" : true,
  "cifs" : [ {
    "cif" : "aeiou",
    "adapter" : "aeiou",
    "mac_address" : "aeiou",
    "resources" : [ "aeiou" ],
    "se_uuid" : "aeiou"
  } ],
  "se_uuid" : [ "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 APICLifsRuntime

401

log in failed

Up
put /apiclifsruntime/{uuid}
( apiclifsruntimeUuidPut)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

APICLifsRuntime

Example data

Content-Type: application/json
{
  "subnet" : "aeiou",
  "tenant_name" : "aeiou",
  "transaction_uuid" : [ "aeiou" ],
  "uuid" : "aeiou",
  "url" : "aeiou",
  "lif_label" : "aeiou",
  "network" : "aeiou",
  "multi_vrf" : true,
  "vs_uuid" : [ "aeiou" ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "auto_allocated" : true,
  "cifs" : [ {
    "cif" : "aeiou",
    "adapter" : "aeiou",
    "mac_address" : "aeiou",
    "resources" : [ "aeiou" ],
    "se_uuid" : "aeiou"
  } ],
  "se_uuid" : [ "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 APICLifsRuntime

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. APICLifsRuntime
  2. APICLifsRuntimeApiResponse
  3. Cif

APICLifsRuntime Up

auto_allocated (optional)
Boolean Placeholder for description of property auto_allocated of obj type APICLifsRuntime field type str type boolean
cifs (optional)
array[Cif] Placeholder for description of property cifs of obj type APICLifsRuntime field type str type object
lif_label
String lif_label of APICLifsRuntime.
multi_vrf (optional)
Boolean Placeholder for description of property multi_vrf of obj type APICLifsRuntime field type str type boolean
name
String Name of the object.
network (optional)
String network of APICLifsRuntime.
se_uuid (optional)
array[String] Unique object identifier of se.
subnet (optional)
String subnet of APICLifsRuntime.
tenant_name
String tenant_name of APICLifsRuntime.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
transaction_uuid (optional)
array[String] Unique object identifier of transaction.
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.
vs_uuid (optional)
array[String] Unique object identifier of vs.

APICLifsRuntimeApiResponse Up

count
Integer format: int32
results

Cif Up

adapter (optional)
String adapter of Cif.
cif (optional)
String cif of Cif.
mac_address (optional)
String mac_address of Cif.
resources (optional)
array[String] resources of Cif.
se_uuid (optional)
String Unique object identifier of se.