Network Pools APIs

Network Pools APIs

APIs for managing Network Pools

Table of Contents

1. Create a Network Pool

  • Used to create a Network pool in the system. The added network pool would be used during domain deployments, host commission/expansion flows.

  • If a network pool which is already added before is added, you will get an error with HTTP status 400.

  • If a malformed network pool is added (payload for network parameters, name which is already exist), you will get an error.

1.1. Prerequisites

The following data is required

  • Name

  • List of networks associated with network pool in which each network has

    • Network type - It can be VSAN, VMOTION or NFS Type.

    • VLAN ID - Valid Vlan id range is 0 to 4096.

    • MTU - Valid MTU range is 1500 to 9216.

    • Subnet - Networks of diferent types (e.g. VSAN/VMOTION/NFS) must not have overlapping subnets

    • Subnet mask

    • gateway - The gateway defined for the specified subnet

    • List of IP address ranges - the start and end IP address of each IP Pool should be part of the subnet

1.2. Steps

  • Invoke the API

cURL Request 

$ curl 'https://sfo-vcf01.rainpole.io/v1/network-pools' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "name" : "engineering-networkpool",
  "networks" : [ {
    "type" : "VSAN",
    "vlanId" : 3002,
    "mtu" : 9001,
    "subnet" : "192.168.8.0",
    "mask" : "255.255.252.0",
    "gateway" : "192.168.8.1",
    "ipPools" : [ {
      "start" : "192.168.8.5",
      "end" : "192.168.8.8"
    } ]
  } ]
}'

HTTP Request 

POST /v1/network-pools HTTP/1.1
Content-Type: application/json
Content-Length: 304
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

{
  "name" : "engineering-networkpool",
  "networks" : [ {
    "type" : "VSAN",
    "vlanId" : 3002,
    "mtu" : 9001,
    "subnet" : "192.168.8.0",
    "mask" : "255.255.252.0",
    "gateway" : "192.168.8.1",
    "ipPools" : [ {
      "start" : "192.168.8.5",
      "end" : "192.168.8.8"
    } ]
  } ]
}

HTTP Response 

HTTP/1.1 201 Created
Location: /v1/network-pools/074cc908-dd69-4879-baf6-5d34cae04ca4
Content-Type: application/json
Content-Length: 165

{
  "id" : "074cc908-dd69-4879-baf6-5d34cae04ca4",
  "name" : "engineering-networkpool",
  "networks" : [ {
    "id" : "6e81628b-37c3-4cb5-9f71-a387a1c30824"
  } ]
}

2. Get the Network Pools

2.1. Prerequisites

None

2.2. Steps

  • Invoke the API

cURL Request 

$ curl 'https://sfo-vcf01.rainpole.io/v1/network-pools' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request 

GET /v1/network-pools HTTP/1.1
Content-Type: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response 

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 375

{
  "elements" : [ {
    "id" : "36ec7ded-1bba-48cc-ad0a-c608a6070108",
    "name" : "engineering-networkpool",
    "networks" : [ {
      "id" : "2c998ffa-f5a5-4abb-a225-f215d5c4d3c4"
    } ]
  }, {
    "id" : "0d823aca-5698-4554-b649-9519c2923008",
    "name" : "finance-networkpool",
    "networks" : [ {
      "id" : "36c2c34f-412d-4f94-90ca-f4481398ca35"
    } ]
  } ]
}

3. Get a Network Pool

3.1. Prerequisites

The following data is required

  • ID of the network pool

3.2. Steps

  • Invoke the API

cURL Request 

$ curl 'https://sfo-vcf01.rainpole.io/v1/network-pools/cd6e7331-77e2-40b9-ad05-1f9801327bff' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request 

GET /v1/network-pools/cd6e7331-77e2-40b9-ad05-1f9801327bff HTTP/1.1
Content-Type: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response 

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 165

{
  "id" : "cd6e7331-77e2-40b9-ad05-1f9801327bff",
  "name" : "engineering-networkpool",
  "networks" : [ {
    "id" : "57091355-a0a1-46a8-81e8-289a2a420d90"
  } ]
}

4. Get a Network of a Network Pool

4.1. Prerequisites

The following data is required

  • ID of the network

4.2. Steps

  • Invoke the API

cURL Request 

$ curl 'https://sfo-vcf01.rainpole.io/v1/network-pools/85c6e836-676f-45b2-b2b4-357070948d55/networks/ffb3515c-1aba-46f9-808b-5623e7292d79' -i -X GET \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Response 

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 270

{
  "id" : "ffb3515c-1aba-46f9-808b-5623e7292d79",
  "type" : "VSAN",
  "vlanId" : 3002,
  "mtu" : 9216,
  "subnet" : "192.168.8.0",
  "mask" : "255.255.252.0",
  "gateway" : "192.168.8.1",
  "ipPools" : [ {
    "start" : "192.168.8.5",
    "end" : "192.168.8.8"
  } ]
}

5. Rename a Network Pool

5.1. Prerequisites

  • Network pool must exist.

5.2. Steps

  • Get the ID of the network pool. Filter the response by the network pool's current name to get the corresponding ID.

Tip : Get the Network Pools

  • Create a network pool update spec. Create a JSON with the "name" field containing the desired new network pool name.

Tip : NetworkPoolUpdateSpec

  • Invoke the network pool rename (update) task using the input spec and network pool ID.

Note : Running the updateNetworkPool API will ensure that the requested new name is valid. The API call will fail if the requested new name is invalid.

cURL Request 

$ curl 'https://sfo-vcf01.rainpole.io/v1/network-pools/1474a202-01dd-4f29-90c2-0cc926c970ec' -i -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "name" : "new_name"
}'

HTTP Request 

PATCH /v1/network-pools/1474a202-01dd-4f29-90c2-0cc926c970ec HTTP/1.1
Content-Type: application/json
Content-Length: 25
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

{
  "name" : "new_name"
}

HTTP Response 

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 165

{
  "id" : "1474a202-01dd-4f29-90c2-0cc926c970ec",
  "name" : "engineering-networkpool",
  "networks" : [ {
    "id" : "01f9d946-7ae5-4c79-99ea-7a4905768c61"
  } ]
}

6. Delete a Network Pool

  • Used to delete a Network pool.

  • Deleting a networkpool which is being used, will give an error.

  • Deleting a networkpool which does not exist, will give a HTTP response code 404.

6.1. Prerequisites

The following data is required

  • ID of the network pool

6.2. Steps

  • Invoke the API

Tip : Refer to: Get the Network Pools to retrieve all network pools in the system and use the ID of network pool to be deleted.

cURL Request 

$ curl 'https://sfo-vcf01.rainpole.io/v1/network-pools/80c85b90-9eee-4ce7-aac6-dc57b24d4d5f' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....'

HTTP Request 

DELETE /v1/network-pools/80c85b90-9eee-4ce7-aac6-dc57b24d4d5f HTTP/1.1
Content-Type: application/json
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

HTTP Response 

HTTP/1.1 204 No Content

7. Add an IP Pool to a Network of a Network Pool

7.1. Prerequisites

The following data is required

  • ID of the network pool

Tip : Refer to: Get the Network Pools

  • ID of the network.

Tip : Refer to: Get a Network of a Network Pool

  • The start and end IP addresses for the IP pool

7.2. Steps

  • Invoke the API

cURL Request 

$ curl 'https://sfo-vcf01.rainpole.io/v1/network-pools/92bbd425-e8a5-47b3-93f1-71acba9df124/networks/673cc7aa-062f-4ca5-a100-3b307a6aafd9/ip-pools' -i -X POST \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "start" : "192.168.8.5",
  "end" : "192.168.8.8"
}'

HTTP Request 

POST /v1/network-pools/92bbd425-e8a5-47b3-93f1-71acba9df124/networks/673cc7aa-062f-4ca5-a100-3b307a6aafd9/ip-pools HTTP/1.1
Content-Type: application/json
Content-Length: 54
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

{
  "start" : "192.168.8.5",
  "end" : "192.168.8.8"
}

HTTP Response 

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 270

{
  "id" : "c71c3548-38fb-44b7-81f1-e38bc2dc9c78",
  "type" : "VSAN",
  "vlanId" : 3002,
  "mtu" : 9216,
  "subnet" : "192.168.8.0",
  "mask" : "255.255.252.0",
  "gateway" : "192.168.8.1",
  "ipPools" : [ {
    "start" : "192.168.8.5",
    "end" : "192.168.8.8"
  } ]
}

8. Delete an IP Pool from a Network of a Network Pool

8.1. Prerequisites

The following data is required

  • ID of the IP pool

8.2. Steps

  • Invoke the API

cURL Request 

$ curl 'https://sfo-vcf01.rainpole.io/v1/network-pools/494946bb-f2b1-4e32-905a-c5d7af9a95a0/networks/f11c1e73-be76-4941-aa6c-e7ff0b8fe3a2/ip-pools' -i -X DELETE \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer etYWRta....' \
    -d '{
  "start" : "192.168.8.5",
  "end" : "192.168.8.8"
}'

HTTP Request 

DELETE /v1/network-pools/494946bb-f2b1-4e32-905a-c5d7af9a95a0/networks/f11c1e73-be76-4941-aa6c-e7ff0b8fe3a2/ip-pools HTTP/1.1
Content-Type: application/json
Content-Length: 54
Host: sfo-vcf01.rainpole.io
Authorization: Bearer etYWRta....

{
  "start" : "192.168.8.5",
  "end" : "192.168.8.8"
}

HTTP Response 

HTTP/1.1 204 No Content

Last updated 2024-03-14 07:59:42 -0700

Operations
POST
Add Ip Pool To Network Of Network Pool
Add an IP Pool to a Network of a Network Pool
POST
Create Network Pool
Create a Network Pool
DELETE
Delete Ip Pool From Network Of Network Pool
Delete an IP Pool from a Network of a Network Pool
DELETE
Delete Network Pool
Delete a Network Pool
GET
Get Network Of Network Pool
Get a Network of a Network Pool
GET
Get Network Pool
Get the list of all Network Pools
GET
Get Network Pool By ID
Get a Network Pool
GET
Get Networks Of Network Pool
Get the Networks of a Network Pool
PATCH
Update Network Pool
Update Network Pool