Avns APIs
APIs for managing Solutions Networking (Application Virtual Networks)
Table of Contents
1. Validate AVN Creation
Validating the Application virtual networks (AVNs) specification before creation.
AVNs are used in deploying vRealize vRealize Suite components.
AVNs are backed by overlay segments using the encapsulation protocol of NSX.
AVNs use a single IP network address space, to span across data centers.
1.1. Prerequisites API
The following data is required for the Validate AVN Creation Spec API:
- TODO
Tip : Refer to: AvnsCreationSpec.
1.2. Steps API
- Validate the input specification using Validate AVN Creation Spec API.
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/avns/validations' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer etYWRta....' \
-d '{
"edgeClusterId" : "52309268-2a1f-4c2c-b8ea-3dd78b6d5677",
"avns" : [ {
"name" : "sfo-m01-seg01",
"regionType" : "REGION_A",
"subnet" : "192.168.20.0",
"subnetMask" : "255.255.255.0",
"gateway" : "192.168.20.1",
"mtu" : 9000,
"routerName" : "sfo-m01-seg01-t0-gw01"
}, {
"name" : "xreg-m01-seg01",
"regionType" : "X_REGION",
"subnet" : "192.168.30.0",
"subnetMask" : "255.255.255.0",
"gateway" : "192.168.30.1",
"mtu" : 9000,
"routerName" : "xreg-m01-seg01-t0-gw01"
} ]
}'
HTTP Request
POST /v1/avns/validations HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 535
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....
{
"edgeClusterId" : "52309268-2a1f-4c2c-b8ea-3dd78b6d5677",
"avns" : [ {
"name" : "sfo-m01-seg01",
"regionType" : "REGION_A",
"subnet" : "192.168.20.0",
"subnetMask" : "255.255.255.0",
"gateway" : "192.168.20.1",
"mtu" : 9000,
"routerName" : "sfo-m01-seg01-t0-gw01"
}, {
"name" : "xreg-m01-seg01",
"regionType" : "X_REGION",
"subnet" : "192.168.30.0",
"subnetMask" : "255.255.255.0",
"gateway" : "192.168.30.1",
"mtu" : 9000,
"routerName" : "xreg-m01-seg01-t0-gw01"
} ]
}
HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 146
{
"id" : "3eb6a29c-b0c9-4b64-8676-e3bdeef73f59",
"executionStatus" : "COMPLETED",
"resultStatus" : "SUCCEEDED",
"validationChecks" : [ ]
}
1.3. Related APIs API
[_validateavnspec] API [_createavns] API [_getavns] API Get the AVNs by RegionType
2. Create AVN
Creating Application virtual networks (AVNs).
AVNs are used in deploying vRealize vRealize Suite components.
AVNs are backed by overlay segments using the encapsulation protocol of NSX.
AVNs use a single IP network address space, to span across data centers.
2.1. Prerequisites API
The following data is required for the Create AVNs API:
- TODO
Tip : Refer to: AvnsCreationSpec.
2.2. Steps API
- Invoke the Create AVNs API. This API returns a task which can be polled and monitored.
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/avns' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer etYWRta....' \
-d '{
"edgeClusterId" : "52309268-2a1f-4c2c-b8ea-3dd78b6d5677",
"avns" : [ {
"name" : "sfo-m01-seg01",
"regionType" : "REGION_A",
"subnet" : "192.168.20.0",
"subnetMask" : "255.255.255.0",
"gateway" : "192.168.20.1",
"mtu" : 9000,
"routerName" : "sfo-m01-seg01-t0-gw01"
}, {
"name" : "xreg-m01-seg01",
"regionType" : "X_REGION",
"subnet" : "192.168.30.0",
"subnetMask" : "255.255.255.0",
"gateway" : "192.168.30.1",
"mtu" : 9000,
"routerName" : "xreg-m01-seg01-t0-gw01"
} ]
}'
HTTP Request
POST /v1/avns HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 535
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....
{
"edgeClusterId" : "52309268-2a1f-4c2c-b8ea-3dd78b6d5677",
"avns" : [ {
"name" : "sfo-m01-seg01",
"regionType" : "REGION_A",
"subnet" : "192.168.20.0",
"subnetMask" : "255.255.255.0",
"gateway" : "192.168.20.1",
"mtu" : 9000,
"routerName" : "sfo-m01-seg01-t0-gw01"
}, {
"name" : "xreg-m01-seg01",
"regionType" : "X_REGION",
"subnet" : "192.168.30.0",
"subnetMask" : "255.255.255.0",
"gateway" : "192.168.30.1",
"mtu" : 9000,
"routerName" : "xreg-m01-seg01-t0-gw01"
} ]
}
HTTP Response
HTTP/1.1 202 Accepted
Content-Type: application/json
Location: /v1/tasks/f5a50d6c-475c-4d41-9490-44102ed8f915
Content-Length: 261
{
"id" : "f5a50d6c-475c-4d41-9490-44102ed8f915",
"name" : "Deploying Overlay AVNs for default cluster of management domain",
"status" : "IN_PROGRESS",
"creationTimestamp" : "2024-08-27T19:55:10.054Z",
"isCancellable" : false,
"isRetryable" : false
}
- Poll the status of the task using the task API with the ID from the response of the previous API.
Tip : Refer to: Get a Task.
2.3. Related APIs API
[_validateavnspec] API [_createavns] API [_getavns] API Get the AVNs by RegionType
3. Get the AVNs
This API is used to fetch all configured AVNs
3.1. Prerequisites API
None
3.2. Steps API
- Invoke the API
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/avns' -i -X GET \
-H 'Accept: application/json' \
-H 'Authorization: Bearer etYWRta....'
HTTP Request
GET /v1/avns HTTP/1.1
Accept: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....
HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 312
[ {
"id" : "sfo-m01-seg01",
"name" : "sfo-m01-seg01",
"regionType" : "REGION_A",
"subnet" : "192.168.20.0",
"subnetMask" : "255.255.255.0",
"gateway" : "192.168.20.1",
"mtu" : 9000,
"portGroupName" : "sfo-m01-seg01-pg",
"domainName" : "rainpole.io",
"routerName" : "sfo-m01-seg01-t0-gw01"
} ]
3.3. Related APIs API
[_validateavnspec] API [_createavns] API [_getavns] API Get the AVNs by RegionType
4. Get the AVNs by RegionType
This API is used to fetch all configured AVNs for a given region type
4.1. Prerequisites API
The following data is required
- RegionType of the AVN
4.2. Steps API
- Invoke the API
cURL Request
$ curl 'https://sfo-vcf01.rainpole.io/v1/avns?regionType=X_REGION' -i -X GET \
-H 'Accept: application/json' \
-H 'Authorization: Bearer etYWRta....'
HTTP Request
GET /v1/avns?regionType=X_REGION HTTP/1.1
Accept: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....
HTTP Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 316
[ {
"id" : "xreg-m01-seg01",
"name" : "xreg-m01-seg01",
"regionType" : "X_REGION",
"subnet" : "192.168.30.0",
"subnetMask" : "255.255.255.0",
"gateway" : "192.168.30.1",
"mtu" : 9000,
"portGroupName" : "xreg-m01-seg01-pg",
"domainName" : "rainpole.io",
"routerName" : "xreg-m01-seg01-t0-gw01"
} ]
4.3. Related APIs API
[_validateavnspec] API [_createavns] API [_getavns] API Get the AVNs by RegionType
Last updated 2024-08-27 16:13:54 -0700