Avi NetworkRuntime Object API

CLI ``` - show network runtime ```
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 /networkruntime
  2. post /networkruntime
  3. delete /networkruntime/{uuid}
  4. get /networkruntime/{uuid}
  5. patch /networkruntime/{uuid}
  6. put /networkruntime/{uuid}
Up 
get /networkruntime
(networkruntimeGet)

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

NetworkRuntimeApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "subnet_runtime" : [ {
      "ip_alloced" : [ {
        "ip" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "mac" : "aeiou",
        "se_uuid" : "aeiou"
      } ],
      "used_ip_count" : 123,
      "prefix" : {
        "ip_addr" : "",
        "mask" : 123
      },
      "ip_range_runtimes" : [ {
        "free_ip_count" : 123,
        "allocated_ips" : [ {
          "obj_info" : "aeiou",
          "ip" : "",
          "obj_uuid" : "aeiou"
        } ],
        "type" : "aeiou",
        "total_ip_count" : 123
      } ],
      "free_ip_count" : 123,
      "total_ip_count" : 123
    } ],
    "obj_uuids" : [ "aeiou" ],
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "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 NetworkRuntimeApiResponse

401

log in failed
Up 
post /networkruntime
(networkruntimePost)

Consumes

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

Request body

body (required)
Body Parameter — NetworkRuntime object creation

Return type

NetworkRuntime

Example data

Content-Type: application/json
{
  "subnet_runtime" : [ {
    "ip_alloced" : [ {
      "ip" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "mac" : "aeiou",
      "se_uuid" : "aeiou"
    } ],
    "used_ip_count" : 123,
    "prefix" : {
      "ip_addr" : "",
      "mask" : 123
    },
    "ip_range_runtimes" : [ {
      "free_ip_count" : 123,
      "allocated_ips" : [ {
        "obj_info" : "aeiou",
        "ip" : "",
        "obj_uuid" : "aeiou"
      } ],
      "type" : "aeiou",
      "total_ip_count" : 123
    } ],
    "free_ip_count" : 123,
    "total_ip_count" : 123
  } ],
  "obj_uuids" : [ "aeiou" ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "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 NetworkRuntime

401

log in failed
Up 
delete /networkruntime/{uuid}
(networkruntimeUuidDelete)

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 /networkruntime/{uuid}
(networkruntimeUuidGet)

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

NetworkRuntime

Example data

Content-Type: application/json
{
  "subnet_runtime" : [ {
    "ip_alloced" : [ {
      "ip" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "mac" : "aeiou",
      "se_uuid" : "aeiou"
    } ],
    "used_ip_count" : 123,
    "prefix" : {
      "ip_addr" : "",
      "mask" : 123
    },
    "ip_range_runtimes" : [ {
      "free_ip_count" : 123,
      "allocated_ips" : [ {
        "obj_info" : "aeiou",
        "ip" : "",
        "obj_uuid" : "aeiou"
      } ],
      "type" : "aeiou",
      "total_ip_count" : 123
    } ],
    "free_ip_count" : 123,
    "total_ip_count" : 123
  } ],
  "obj_uuids" : [ "aeiou" ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "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 NetworkRuntime

401

log in failed
Up 
patch /networkruntime/{uuid}
(networkruntimeUuidPatch)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

NetworkRuntime

Example data

Content-Type: application/json
{
  "subnet_runtime" : [ {
    "ip_alloced" : [ {
      "ip" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "mac" : "aeiou",
      "se_uuid" : "aeiou"
    } ],
    "used_ip_count" : 123,
    "prefix" : {
      "ip_addr" : "",
      "mask" : 123
    },
    "ip_range_runtimes" : [ {
      "free_ip_count" : 123,
      "allocated_ips" : [ {
        "obj_info" : "aeiou",
        "ip" : "",
        "obj_uuid" : "aeiou"
      } ],
      "type" : "aeiou",
      "total_ip_count" : 123
    } ],
    "free_ip_count" : 123,
    "total_ip_count" : 123
  } ],
  "obj_uuids" : [ "aeiou" ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "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 NetworkRuntime

401

log in failed
Up 
put /networkruntime/{uuid}
(networkruntimeUuidPut)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

NetworkRuntime

Example data

Content-Type: application/json
{
  "subnet_runtime" : [ {
    "ip_alloced" : [ {
      "ip" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "mac" : "aeiou",
      "se_uuid" : "aeiou"
    } ],
    "used_ip_count" : 123,
    "prefix" : {
      "ip_addr" : "",
      "mask" : 123
    },
    "ip_range_runtimes" : [ {
      "free_ip_count" : 123,
      "allocated_ips" : [ {
        "obj_info" : "aeiou",
        "ip" : "",
        "obj_uuid" : "aeiou"
      } ],
      "type" : "aeiou",
      "total_ip_count" : 123
    } ],
    "free_ip_count" : 123,
    "total_ip_count" : 123
  } ],
  "obj_uuids" : [ "aeiou" ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "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 NetworkRuntime

401

log in failed
Up

Models

[ Jump to Methods ]

Table of Contents

  1. IpAddr
  2. IpAddrPrefix
  3. IpAllocInfo
  4. NetworkRuntime
  5. NetworkRuntimeApiResponse
  6. StaticIpAllocInfo
  7. StaticIpRangeRuntime
  8. SubnetRuntime

IpAddr Up

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

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

IpAllocInfo Up

ip
IpAddr Placeholder for description of property ip of obj type IpAllocInfo field type str type object
mac
String mac of IpAllocInfo.
se_uuid
String Unique object identifier of se.

NetworkRuntime Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
name
String Name of the object.
obj_uuids (optional)
array[String] Objects using static IPs in this network. Field introduced in 20.1.3.
se_uuid (optional)
array[String] Use obj_uuids. Field deprecated in 20.1.3.
subnet_runtime (optional)
array[SubnetRuntime] Placeholder for description of property subnet_runtime of obj type NetworkRuntime field type str type object
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.

NetworkRuntimeApiResponse Up

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

StaticIpAllocInfo Up

ip
IpAddr IP address. Field introduced in 20.1.3.
obj_info (optional)
String Object metadata. Field introduced in 20.1.3.
obj_uuid (optional)
String Object which this IP address is allocated to. Field introduced in 20.1.3.

StaticIpRangeRuntime Up

allocated_ips (optional)
array[StaticIpAllocInfo] Allocated IPs. Field introduced in 20.1.3.
free_ip_count (optional)
Integer Free IP count. Field introduced in 20.1.3. format: int32
total_ip_count (optional)
Integer Total IP count. Field introduced in 20.1.3. format: int32
type (optional)
String Object type (VIP only, Service Engine only, or both) which is using this IP group. Enum options - STATIC_IPS_FOR_SE, STATIC_IPS_FOR_VIP, STATIC_IPS_FOR_VIP_AND_SE. Field introduced in 20.1.3.

SubnetRuntime Up

free_ip_count (optional)
Integer Moved to StaticIpRangeRuntime. Field deprecated in 20.1.3. format: int32
ip_alloced (optional)
array[IpAllocInfo] Use allocated_ips in StaticIpRangeRuntime. Field deprecated in 20.1.3.
ip_range_runtimes (optional)
array[StaticIpRangeRuntime] Static IP range runtime. Field introduced in 20.1.3.
prefix
IpAddrPrefix Placeholder for description of property prefix of obj type SubnetRuntime field type str type object
total_ip_count (optional)
Integer Moved to StaticIpRangeRuntime. Field deprecated in 20.1.3. format: int32
used_ip_count (optional)
Integer Can be derived from total - free in StaticIpRangeRuntime. Field deprecated in 20.1.3. format: int32