PATCH /network/{uuid}

PATCH /network/{uuid}

/network/{uuid}

Request
URI
PATCH
https://{api_host}/api/network/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

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.

Request Body

Network object creation

Network of type(s) application/json
Optional

Show optional properties

{
    "name": "string"
}
{
    "_last_modified": "string",
    "attrs": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "cloud_ref": "string",
    "configpb_attributes": {
        "version": 0
    },
    "configured_subnets": [
        {
            "prefix": {
                "ip_addr": {
                    "addr": "string",
                    "type": "string"
                },
                "mask": 0
            },
            "static_ip_ranges": [
                {
                    "range": {
                        "begin": {
                            "addr": "string",
                            "type": "string"
                        },
                        "end": {
                            "addr": "string",
                            "type": "string"
                        }
                    },
                    "type": "string"
                }
            ]
        }
    ],
    "dhcp_enabled": false,
    "exclude_discovered_subnets": false,
    "ip6_autocfg_enabled": false,
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "name": "string",
    "synced_from_se": false,
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string",
    "vcenter_dvs": false,
    "vimgrnw_ref": "string",
    "vrf_context_ref": "string"
}
Responses
200

OK

Returns Network of type(s) application/json 
"Network Object"
string
_last_modified
Optional

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

array of object
attrs
Optional

Key/value network attributes. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
cloud_ref
Optional

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

object
configpb_attributes
Optional

configpb_attributes

array of object
configured_subnets
Optional

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

boolean
dhcp_enabled
Optional
Constraints: default: true

Select the IP address management scheme for this Network. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
exclude_discovered_subnets
Optional

When selected, excludes all discovered subnets in this network from consideration for virtual service placement. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
ip6_autocfg_enabled
Optional
Constraints: default: true

Enable IPv6 auto configuration. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of object
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

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

boolean
synced_from_se
Optional

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

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

boolean
vcenter_dvs
Optional
Constraints: default: true

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

string
vimgrnw_ref
Optional

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

string
vrf_context_ref
Optional

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


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string"}'
On This Page
Network Operations
GET
GET /network
POST
POST /network
GET
GET /network/{uuid}
PUT
PUT /network/{uuid}
PATCH
PATCH /network/{uuid}
DELETE
DELETE /network/{uuid}