GET /ipaddrgroup/{uuid}

/ipaddrgroup/{uuid}

Request

URI

GET

https://api_host/api/ipaddrgroup/{uuid}

COPY

Path Parameters

string

uuid

Required

UUID of the object to fetch

Query Parameters

string

name

Optional

object name

string

fields

Optional

List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

boolean

include_name

Optional

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.

boolean

skip_default

Optional

Default values are not set.

string

join_subresources

Optional

It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Header Parameters

string

X-Avi-Tenant

Optional

Avi Tenant Header

string

X-Avi-Tenant-UUID

Optional

Avi Tenant Header UUID

string

X-Avi-Version

Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string

X-CSRFToken

Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

Responses

200

Returns IpAddrGroup of type(s) application/json

{
    "_last_modified": "string",
    "addrs": [
        {
            "addr": "string",
            "type": "string"
        }
    ],
    "configpb_attributes": {
        "version": 0
    },
    "country_codes": [
        "string"
    ],
    "description": "string",
    "ip_ports": [
        {
            "hostname": "string",
            "ip": {
                "addr": "string",
                "type": "string"
            },
            "name": "string",
            "port": 0
        }
    ],
    "marathon_app_name": "string",
    "marathon_service_port": 0,
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "name": "string",
    "prefixes": [
        {
            "ip_addr": {
                "addr": "string",
                "type": "string"
            },
            "mask": 0
        }
    ],
    "ranges": [
        {
            "begin": {
                "addr": "string",
                "type": "string"
            },
            "end": {
                "addr": "string",
                "type": "string"
            }
        }
    ],
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}

string

_last_modified

Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

array of IpAddr

addrs

Optional

Configure IP address(es). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ConfigPbAttributes

configpb_attributes

Optional

configpb_attributes

array of string

country_codes

Optional

Populate the IP address ranges from the geo database for this country. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

description

Optional

Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of IpAddrPort

ip_ports

Optional

Configure (IP address, port) tuple(s). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

marathon_app_name

Optional

Populate IP addresses from tasks of this Marathon app. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

marathon_service_port

Optional

Task port associated with marathon service port. If Marathon app has multiple service ports, this is required. Else, the first task port is used. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of RoleFilterMatchLabel

markers

Optional

List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

string

name

Required

Name of the IP address group. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of IpAddrPrefix

prefixes

Optional

Configure IP address prefix(es). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of IpAddrRange

ranges

Optional

Configure IP address range(s). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

tenant_ref

Optional

It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

url

Optional

url

string

uuid

Optional

UUID of the IP address group. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

401

Operation doesn't return any data structure

On This Page

Description