Abiquo Documentation Cookies Policy

Our Documentation website uses cookies to improve your experience. Please visit our Cookie Policy page for more information about cookies and how we use them.


Abiquo 4.4

Skip to end of metadata
Go to start of metadata

Contents:

ExcludedNetworks Resource

To prevent the users in private cloud datacenters from creating private networks with certain address ranges, the administrator can create excluded networks.

Main URI of the Resource

This class operates mainly over the Resource URI: /admin/datacenters/{datacenter}/excludednetworks

Exposed Methods

Get excluded networks

This method returns the list of excluded networks

Synopsis: GET http://example.com/api/admin/datacenters/{datacenter}/excludednetworks
Roles Required: PHYS_DC_ENUMERATE,USERS_MANAGE_ENTERPRISE
Request Headers: Accept:  application/vnd.abiquo.excludednetworks+json; version=4.4; application/vnd.abiquo.excludednetworks+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

startwith

false

0The first element to be retrieved of the filtered search.

limit

false

25

The number of entities to retrieve.

has

true

""

A way to filter the search, for example, using a substring of the name.

by

false

name

Sort preference. Depends on the resource, this value affects different to the request.

asc

false

true

If the value of the 'by' parameter must be sorted in ascending way (true) or descending way (false)

Request Message Body Entity: 
Response Message Body Entity: ExcludedNetworks Media Type
Request Example:

 Click here to show or hide the request example

GET_adm_dcs_X_excludednws_AC_excludednws_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/admin/datacenters/3863/excludednetworks \ 
	 -H 'Accept:application/vnd.abiquo.excludednetworks+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "totalSize": 3, 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/datacenters/3863/excludednetworks?limit=25&by=name&asc=true", 
      "rel": "first"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3863/excludednetworks?startwith=0&limit=25&by=name&asc=true", 
      "rel": "last"
    }
  ], 
  "collection": [
    {
      "address": "192.168.0.0", 
      "mask": 24, 
      "name": "384", 
      "links": [
        {
          "href": "http://localhost:9009/api/admin/datacenters/3863/excludednetworks/6", 
          "type": "application/vnd.abiquo.excludednetwork+json", 
          "rel": "edit", 
          "title": "384"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/3863", 
          "type": "application/vnd.abiquo.datacenter+json", 
          "rel": "datacenter", 
          "title": "341"
        }
      ], 
      "ipv6": false
    }, 
    {
      "address": "192.168.0.0", 
      "mask": 24, 
      "name": "385", 
      "links": [
        {
          "href": "http://localhost:9009/api/admin/datacenters/3863/excludednetworks/7", 
          "type": "application/vnd.abiquo.excludednetwork+json", 
          "rel": "edit", 
          "title": "385"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/3863", 
          "type": "application/vnd.abiquo.datacenter+json", 
          "rel": "datacenter", 
          "title": "341"
        }
      ], 
      "ipv6": false
    }, 
    {
      "address": "192.168.0.0", 
      "mask": 24, 
      "name": "386", 
      "links": [
        {
          "href": "http://localhost:9009/api/admin/datacenters/3863/excludednetworks/8", 
          "type": "application/vnd.abiquo.excludednetwork+json", 
          "rel": "edit", 
          "title": "386"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/3863", 
          "type": "application/vnd.abiquo.datacenter+json", 
          "rel": "datacenter", 
          "title": "341"
        }
      ], 
      "ipv6": false
    }
  ]
}

Create an excluded network 

Create an excluded network

Synopsis: POST http://example.com/api/admin/datacenters/{datacenter}/excludednetworks 
Roles Required: PHYS_DC_MANAGE
Request Headers: Accept:  application/vnd.abiquo.excludednetwork+json; version=4.4; application/vnd.abiquo.excludednetwork+xml; version=4.4;  Content-type:  application/vnd.abiquo.excludednetwork+json; version=4.4; application/vnd.abiquo.excludednetwork+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: ExcludedNetwork Media Type
Response Message Body Entity: ExcludedNetwork Media Type  
Request Example:

 Click here to show or hide the request example

POST_adm_dcs_X_excludednws_CT_excludednw_j_AC_excludednw_j.0001.txt

cURL:

curl -X POST http://localhost:9000/api/admin/datacenters/3856/excludednetworks \ 
	 -H 'Accept:application/vnd.abiquo.excludednetwork+json; version=4.2' \ 
	 -H 'Content-Type:application/vnd.abiquo.excludednetwork+json; version=4.2' \ 
	 -d @requestpayload.json \ 
	 -u user:password --verbose 

Success status code: 201

Request payload:

{
  "address": "192.0.0.0", 
  "mask": 16, 
  "name": "name", 
  "links": [], 
  "ipv6": false
}

Response payload:

{
  "address": "192.0.0.0", 
  "mask": 16, 
  "name": "name", 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/datacenters/3856/excludednetworks/3", 
      "type": "application/vnd.abiquo.excludednetwork+json", 
      "rel": "edit", 
      "title": "name"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3856", 
      "type": "application/vnd.abiquo.datacenter+json", 
      "rel": "datacenter", 
      "title": "5"
    }
  ], 
  "ipv6": false
}

 

Main URI of the Resource

This class operates mainly over the Resource URI:  /admin/datacenters/{datacenter}/excludednetworks/{excludednetwork}

Exposed Methods

Get an excluded network 

Get an excluded network

Synopsis: GET  http://example.com/api/admin/datacenters/{datacenter}/excludednetworks/{excludednetwork} 
Roles Required: PHYS_DC_ENUMERATE
Request Headers: Accept:  application/vnd.abiquo.excludednetwork+json; version=4.4; application/vnd.abiquo.excludednetwork+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: 
Response Message Body Entity:  ExcludedNetwork Media Type  
Request Example:

 Click here to show or hide the request example

GET_adm_dcs_X_excludednws_X_AC_excludednw_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/admin/datacenters/4912/excludednetworks/10 \ 
	 -H 'Accept:application/vnd.abiquo.excludednetwork+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "address": "192.168.0.0", 
  "mask": 24, 
  "name": "49", 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/datacenters/4912/excludednetworks/10", 
      "type": "application/vnd.abiquo.excludednetwork+json", 
      "rel": "edit", 
      "title": "49"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4912", 
      "type": "application/vnd.abiquo.datacenter+json", 
      "rel": "datacenter", 
      "title": "5"
    }
  ], 
  "ipv6": false
}

Delete an excluded network

Delete an excluded network

Synopsis: DELETE  http://example.com/api/admin/datacenters/{datacenter}/excludednetworks/{excludednetwork} 
Roles Required: PHYS_DC_MANAGE
Request Headers: Accept: ; Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: 
Response Message Body Entity: 
Request Example:

 Click here to show or hide the request example

DELETE_adm_dcs_X_excludednws_X.0001.txt

cURL:

curl -X DELETE http://localhost:9000/api/admin/datacenters/4925/excludednetworks/36 \ 
	 -H 'Accept:text/json,application/json' \ 
	 -u user:password --verbose 

Success status code: 204

Request payload:

--none--

Response payload:

--none--

Update an excluded network

Update an excluded network

Synopsis: PUT http://example.com/api/admin/datacenters/{datacenter}/excludednetworks/{excludednetwork} 
Roles Required: PHYS_DC_MANAGE
Request Headers: Accept:  application/vnd.abiquo.excludednetwork+json; version=4.4; application/vnd.abiquo.excludednetwork+xml; version=4.4;  Content-type:  application/vnd.abiquo.excludednetwork+json; version=4.4; application/vnd.abiquo.excludednetwork+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: ExcludedNetwork Media Type  
Response Message Body Entity: ExcludedNetwork Media Type  
Request Example:

 Click here to show or hide the request example

PUT_adm_dcs_X_excludednws_X_CT_excludednw_j_AC_excludednw_j.0001.txt

cURL:

curl -X PUT http://localhost:9000/api/admin/datacenters/4913/excludednetworks/13 \ 
	 -H 'Accept:application/vnd.abiquo.excludednetwork+json; version=4.2' \ 
	 -H 'Content-Type:application/vnd.abiquo.excludednetwork+json; version=4.2' \ 
	 -d @requestpayload.json \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

{
  "address": "2002:4860:4860::8888", 
  "mask": 56, 
  "name": "98", 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/datacenters/4913/excludednetworks/13", 
      "type": "application/vnd.abiquo.excludednetwork+json", 
      "rel": "edit", 
      "title": "98"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4913", 
      "type": "application/vnd.abiquo.datacenter+json", 
      "rel": "datacenter", 
      "title": "55"
    }
  ], 
  "ipv6": true
}

Response payload:

{
  "address": "2002:4860:4860::", 
  "mask": 56, 
  "name": "98", 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/datacenters/4913/excludednetworks/13", 
      "type": "application/vnd.abiquo.excludednetwork+json", 
      "rel": "edit", 
      "title": "98"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4913", 
      "type": "application/vnd.abiquo.datacenter+json", 
      "rel": "datacenter", 
      "title": "55"
    }
  ], 
  "ipv6": true
}