POST /network-inventory

POST /network-inventory

/network-inventory

Request
URI
POST
https://{api_host}/api/network-inventory
COPY
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

NetworkInventory object creation

NetworkInventory of type(s) application/json
Optional 
{
    "_last_modified": "string",
    "config": {
        "cloud_ref": "string",
        "dhcp_enabled": false,
        "exclude_discovered_subnets": false,
        "ip6_autocfg_enabled": false,
        "name": "string",
        "synced_from_se": false,
        "tenant_ref": "string",
        "url": "string",
        "uuid": "string",
        "vcenter_dvs": false,
        "vimgrnw_ref": "string",
        "vrf_context_ref": "string"
    },
    "discovery": {
        "_last_modified": "string",
        "auto_expand": false,
        "availability_zone": "string",
        "cloud_ref": "string",
        "datacenter_uuid": "string",
        "dvs": false,
        "host_refs": [
            "string"
        ],
        "interested_nw": false,
        "ip_subnet": [
            {
                "fip_available": false,
                "fip_subnet_uuids": [
                    "string"
                ],
                "floatingip_subnets": [
                    {
                        "name": "string",
                        "prefix": {
                            "ip_addr": {
                                "addr": "string",
                                "type": "string"
                            },
                            "mask": 0
                        },
                        "uuid": "string"
                    }
                ],
                "ip_subnet": "string",
                "name": "string",
                "prefix": {
                    "ip_addr": {
                        "addr": "string",
                        "type": "string"
                    },
                    "mask": 0
                },
                "primary": false,
                "ref_count": 0,
                "se_ref_count": 0,
                "uuid": "string"
            }
        ],
        "logical_switch_id": "string",
        "managed_object_id": "string",
        "MgmtNW": false,
        "name": "string",
        "num_ports": 0,
        "switch_name": "string",
        "tenant_name": "string",
        "tenant_ref": "string",
        "type": "string",
        "url": "string",
        "uuid": "string",
        "vlan": 0,
        "vlan_range": [
            {
                "end": 0,
                "start": 0
            }
        ],
        "vm_refs": [
            "string"
        ],
        "vrf_context_ref": "string"
    },
    "runtime": {
        "_last_modified": "string",
        "name": "string",
        "obj_uuids": [
            "string"
        ],
        "subnet_runtime": [
            {
                "ip_range_runtimes": [
                    {
                        "allocated_ips": [
                            {
                                "ip": {
                                    "addr": "string",
                                    "type": "string"
                                },
                                "obj_info": "string",
                                "obj_uuid": "string"
                            }
                        ],
                        "free_ip_count": 0,
                        "total_ip_count": 0,
                        "type": "string"
                    }
                ],
                "prefix": {
                    "ip_addr": {
                        "addr": "string",
                        "type": "string"
                    },
                    "mask": 0
                }
            }
        ],
        "tenant_ref": "string",
        "url": "string",
        "uuid": "string"
    },
    "url": "string",
    "uuid": "string"
}
Responses
200

OK

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

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

object
config
Optional

config

object
discovery
Optional

discovery

object
runtime
Optional

runtime

string
url
Optional

url

string
uuid
Optional

UUID of the network. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

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