[{"label":"Latest (4.5.0)","version":"latest"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail

Get All AVNs

Description

Returns all matching AVNs

Request

Request

URL

URL


get
https://sfo-vcf01.rainpole.io/v1/avns
Copy

Query Parameters

Query Parameters

string
regionType Optional

Pass an optional AVN region type matching either Region-A or X-Region


Response

Response

Response Body

Response Body

200 OK

Returns array of Avn of type(s) application/json

Returns the list of all matching AVNs

{
    "domainName": "rainpole.io",
    "gateway": "192.168.31.1",
    "id": "3f39d4a1-78d2-11e8-af85-f1cf26258cdc",
    "mtu": "1600",
    "name": "vRealize-AVN",
    "portGroupName": "sfo-m01-seg01-pg",
    "regionType": "REGION_A",
    "routerName": "sfo-m01-ec01-t1-gw01",
    "subnet": "192.168.31.0",
    "subnetMask": "255.255.255.0",
    "vlanId": "30"
}
string
regionType Required

The region type of AVN; X_REGION or REGION_A


string
gateway Required

Gateway of the AVN subnet


string
subnet Required

Subnet assigned to the AVN


integer as int32
mtu Required

MTU for the AVN


string
name Required

User provided name of the AVN


string
subnetMask Required

Subnet mask for the network assigned to the AVN


string
portGroupName Optional

Port group name identifying the AVN on the distributed switch


string
domainName Optional

AVN search domain


string
routerName Optional

Name of Tier-1 Gateway AVN is connected to


string
id Optional

The UUID of the AVN


integer as int32
vlanId Optional

VLAN ID for the VLAN backed AVN

Errors

Errors

500

Unexpected error

Code Samples

Code Samples

cURL Command

curl https://sfo-vcf01.rainpole.io/v1/avns


[{"label":"Latest (4.5.0)","version":"latest"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
Feedback

Was this page helpful?