Avi IpAddrGroup Object API

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

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

IpAddrGroupApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "marathon_service_port" : 123,
    "ranges" : [ {
      "end" : "",
      "begin" : ""
    } ],
    "marathon_app_name" : "aeiou",
    "addrs" : [ {
      "addr" : "aeiou",
      "type" : "aeiou"
    } ],
    "description" : "aeiou",
    "ip_ports" : [ {
      "hostname" : "aeiou",
      "port" : 123,
      "ip" : "",
      "name" : "aeiou"
    } ],
    "uuid" : "aeiou",
    "url" : "aeiou",
    "prefixes" : [ {
      "ip_addr" : "",
      "mask" : 123
    } ],
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "country_codes" : [ "aeiou" ],
    "apic_epg_name" : "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 IpAddrGroupApiResponse

401

log in failed

Up
post /ipaddrgroup
( ipaddrgroupPost)

Consumes

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

Request body

body (required)
Body Parameter — IpAddrGroup object creation

Return type

IpAddrGroup

Example data

Content-Type: application/json
{
  "marathon_service_port" : 123,
  "ranges" : [ {
    "end" : "",
    "begin" : ""
  } ],
  "marathon_app_name" : "aeiou",
  "addrs" : [ {
    "addr" : "aeiou",
    "type" : "aeiou"
  } ],
  "description" : "aeiou",
  "ip_ports" : [ {
    "hostname" : "aeiou",
    "port" : 123,
    "ip" : "",
    "name" : "aeiou"
  } ],
  "uuid" : "aeiou",
  "url" : "aeiou",
  "prefixes" : [ {
    "ip_addr" : "",
    "mask" : 123
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "country_codes" : [ "aeiou" ],
  "apic_epg_name" : "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 IpAddrGroup

401

log in failed

Up
delete /ipaddrgroup/{uuid}
( ipaddrgroupUuidDelete)

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 /ipaddrgroup/{uuid}
( ipaddrgroupUuidGet)

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

IpAddrGroup

Example data

Content-Type: application/json
{
  "marathon_service_port" : 123,
  "ranges" : [ {
    "end" : "",
    "begin" : ""
  } ],
  "marathon_app_name" : "aeiou",
  "addrs" : [ {
    "addr" : "aeiou",
    "type" : "aeiou"
  } ],
  "description" : "aeiou",
  "ip_ports" : [ {
    "hostname" : "aeiou",
    "port" : 123,
    "ip" : "",
    "name" : "aeiou"
  } ],
  "uuid" : "aeiou",
  "url" : "aeiou",
  "prefixes" : [ {
    "ip_addr" : "",
    "mask" : 123
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "country_codes" : [ "aeiou" ],
  "apic_epg_name" : "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 IpAddrGroup

401

log in failed

Up
patch /ipaddrgroup/{uuid}
( ipaddrgroupUuidPatch)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

IpAddrGroup

Example data

Content-Type: application/json
{
  "marathon_service_port" : 123,
  "ranges" : [ {
    "end" : "",
    "begin" : ""
  } ],
  "marathon_app_name" : "aeiou",
  "addrs" : [ {
    "addr" : "aeiou",
    "type" : "aeiou"
  } ],
  "description" : "aeiou",
  "ip_ports" : [ {
    "hostname" : "aeiou",
    "port" : 123,
    "ip" : "",
    "name" : "aeiou"
  } ],
  "uuid" : "aeiou",
  "url" : "aeiou",
  "prefixes" : [ {
    "ip_addr" : "",
    "mask" : 123
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "country_codes" : [ "aeiou" ],
  "apic_epg_name" : "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 IpAddrGroup

401

log in failed

Up
put /ipaddrgroup/{uuid}
( ipaddrgroupUuidPut)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

IpAddrGroup

Example data

Content-Type: application/json
{
  "marathon_service_port" : 123,
  "ranges" : [ {
    "end" : "",
    "begin" : ""
  } ],
  "marathon_app_name" : "aeiou",
  "addrs" : [ {
    "addr" : "aeiou",
    "type" : "aeiou"
  } ],
  "description" : "aeiou",
  "ip_ports" : [ {
    "hostname" : "aeiou",
    "port" : 123,
    "ip" : "",
    "name" : "aeiou"
  } ],
  "uuid" : "aeiou",
  "url" : "aeiou",
  "prefixes" : [ {
    "ip_addr" : "",
    "mask" : 123
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "country_codes" : [ "aeiou" ],
  "apic_epg_name" : "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 IpAddrGroup

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. IpAddr
  2. IpAddrGroup
  3. IpAddrGroupApiResponse
  4. IpAddrPort
  5. IpAddrPrefix
  6. IpAddrRange

IpAddr Up

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

IpAddrGroup Up

addrs (optional)
array[IpAddr] Configure IP address(es).
apic_epg_name (optional)
String Populate IP addresses from members of this Cisco APIC EPG.
country_codes (optional)
array[String] Populate the IP address ranges from the geo database for this country.
description (optional)
String User defined description for the object.
ip_ports (optional)
array[IpAddrPort] Configure (IP address, port) tuple(s).
marathon_app_name (optional)
String Populate IP addresses from tasks of this Marathon app.
marathon_service_port (optional)
Integer Task port associated with marathon service port. If Marathon app has multiple service ports, this is required. Else, the first task port is used. format: int32
name
String Name of the IP address group.
prefixes (optional)
array[IpAddrPrefix] Configure IP address prefix(es).
ranges (optional)
array[IpAddrRange] Configure IP address range(s).
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
String url
uuid (optional)
String UUID of the IP address group.

IpAddrGroupApiResponse Up

count
Integer format: int32
results

IpAddrPort Up

hostname (optional)
String Hostname of server. One of IP address or hostname should be set.
ip (optional)
IpAddr IP Address of host. One of IP address or hostname should be set.
name (optional)
String Name of the object.
port
Integer Port number of server. Allowed values are 1-65535. format: int32

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

IpAddrRange Up

begin
IpAddr Starting IP address of the range.
end
IpAddr Ending IP address of the range.