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:

Public networks resource

This resource manages networks in the platform at the datacenter level, including Public Networks, External Networks and Unmanaged Networks (a subset of external networks). 

  • Tenants obtain IPs from public networks to allow them to comunicate outside the datacenter.
  • Admins assign each External and Unmanaged networks to a specific tenant

The API organizes and administers Public and External VLANs differently but after you select an IP for use in a VM, they are effectively the same. The platform does not perform operations on IPs in Unmanaged networks.

Main URI of the Resource

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

Exposed Methods

Get VLAN tag availability

To create a network with this resource, you must supply a tag. Use this method to check if other networks in the datacenter are already using the tag.

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

Parameter

Required

Default Value

Description

tag

true

 

Identifier of the tag.

 

 

 

 

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

 Click here to show or hide the request example

GET_adm_dcs_X_nw_act_chkav_AC_vlntagav_j_tag.0001.txt

cURL:

curl -X GET http://localhost:9000/api/admin/datacenters/4490/network/action/checkavailability?tag=45 \ 
	 -H 'Accept:application/vnd.abiquo.vlantagavailability+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "available": "USED", 
  "message": "This tag is used by another VLAN in the Datacenter", 
  "links": []
}

Create a public or external or unmanaged network

This method creates VLANs for public, external and unmanaged networks with the appropriate VLANNetworkDto object.

  • To create an external network, supply the link to an enterprise. 
  • To create an unmanaged network, supply a link to an enterprise and set the unmanaged attribute to "true"
  • To create a public network, do not supply a link to an enterprise or the unmanaged attribute

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

Parameter

Required

Default Value

Description

 

 

 

 

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

 Click here to show or hide the request example

This example shows the creation of an external network

POST_adm_dcs_X_nw_CT_vlan_j_AC_vlan_j.0001.txt

cURL:

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

Success status code: 201

Request payload:

{
  "links": [
    {
      "href": "http://localhost:9009/api/admin/datacenters/2677/networkservicetypes/443", 
      "rel": "networkservicetype"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/2677/devices/708", 
      "rel": "device"
    }
  ], 
  "secondaryDNS": "2001:4860:4860::8888", 
  "internetGatewayRole": false, 
  "defaultNetwork": false, 
  "tag": 56, 
  "ipRanges": [], 
  "address": "2001:db8:0:1::", 
  "primaryDNS": "2001:4860:4860::8888", 
  "gateway": "?", 
  "name": "Default Ipv6 Network", 
  "sufixDNS": "bcn.abiquo.com", 
  "restricted": false, 
  "excludedFromFirewall": false, 
  "mask": 64, 
  "strict": false, 
  "ipv6": true
}

Response payload:

{
  "links": [
    {
      "href": "http://localhost:9009/api/admin/datacenters/2677", 
      "type": "application/vnd.abiquo.datacenter+json", 
      "rel": "datacenter", 
      "title": "0"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/2677/network/522", 
      "type": "application/vnd.abiquo.vlan+json", 
      "rel": "edit", 
      "title": "Default Ipv6 Network"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/2677/devices/708", 
      "type": "application/vnd.abiquo.device+json", 
      "rel": "device", 
      "title": "network_external_public-device"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/2677/networkservicetypes", 
      "type": "application/vnd.abiquo.networkservicetypes+json", 
      "rel": "networkservicetypes", 
      "title": "network services types"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/2677/networkservicetypes/443", 
      "type": "application/vnd.abiquo.networkservicetype+json", 
      "rel": "networkservicetype", 
      "title": "Network Service"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/2677/network/522/ips", 
      "type": "application/vnd.abiquo.publicips+json", 
      "rel": "ips", 
      "title": "public ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/2677/network/522/configuration", 
      "type": "application/vnd.abiquo.networkconfiguration+json", 
      "rel": "configuration", 
      "title": "configuration"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/2677/network/522/configuration/522", 
      "type": "application/vnd.abiquo.networkconfiguration+json", 
      "rel": "network_configuration", 
      "title": "2001:db8:0:1::/64"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/2677/network/522/ips/action/disable", 
      "type": "application/vnd.abiquo.ipliterals+json", 
      "rel": "disableips", 
      "title": "disable a set of ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/2677/network/522/ips/action/enable", 
      "type": "application/vnd.abiquo.ipliterals+json", 
      "rel": "enableips", 
      "title": "enable a set of ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/2677/network/522/ips/action/disableall", 
      "type": "", 
      "rel": "disableallips", 
      "title": "disable all ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/2677/network/522/ips/action/enableall", 
      "type": "", 
      "rel": "enableallips", 
      "title": "enable all ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/2677/network/522/ips/action/quarantine", 
      "type": "application/vnd.abiquo.ipliterals+json", 
      "rel": "quarantineips", 
      "title": "put in quarantine a set of ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/2677/network/522/ips/action/removequarantine", 
      "type": "application/vnd.abiquo.ipliterals+json", 
      "rel": "removequarantineips", 
      "title": "remove from quarantine a set of ips"
    }
  ], 
  "secondaryDNS": "2001:4860:4860::8888", 
  "internetGatewayRole": false, 
  "defaultNetwork": false, 
  "tag": 56, 
  "ipRanges": [], 
  "address": "2001:db8:0:1::", 
  "unmanaged": false, 
  "gateway": "?", 
  "name": "Default Ipv6 Network", 
  "sufixDNS": "bcn.abiquo.com", 
  "primaryDNS": "2001:4860:4860::8888", 
  "restricted": false, 
  "dhcpOptions": {
    "links": [], 
    "collection": []
  }, 
  "mask": 64, 
  "id": 522, 
  "strict": false, 
  "providerId": "b67f178f-5032-44bb-9d55-1809a1d7ed06", 
  "ipv6": true, 
  "type": "PUBLIC", 
  "excludedFromFirewall": false
}

 

List external IPs in a datacenter

Returns the list of external IPs registered in the datacenter.

Paging Method

This method works with paging. Check out Basic Behaviors for information about how it works

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

Parameter

Required

Default Value

Description

startwith

false

0

First element to retrieve.

by

false

ip

How to order the search. Available values are: {IP, QUARANTINE, MAC, LEASE, VLAN,
VIRTUALDATACENTER, VIRTUALMACHINE, VIRTUALAPPLIANCE, ENTERPRISENAME}

has

false

 

a way to filter the search. It can be filtered by: IP address, MAC address,
network name, Virtual Machine name, Virtual Appliance name or Enterprise Name

limit

false

25

number of elements to retrieve.

asc

false

true

the way to order the search (ascendant-> true, descendant -> false). Ascendant by
default.

all

false

false

set if we should return all the IPs or only the available ones (by default).

 

 

 

 

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

 Click here to show or hide the request example

List external IPs by datacenter filtered by text


GET_adm_dcs_X_nw_act_extips_AC_extips_j.txt

cURL:

curl -X GET http://example.com/api/admin/datacenters/1/network/action/externalips?has=aperque \ 
	 -H 'Accept:application/vnd.abiquo.externalips+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
    "links": [
        {
            "rel": "first",
            "href": "https://example.com:443/api/admin/datacenters/1/network/action/externalips?limit=25&has=aperque&by=ip&asc=true"
        },
        {
            "rel": "last",
            "href": "https://example.com:443/api/admin/datacenters/1/network/action/externalips?startwith=0&limit=25&has=aperque&by=ip&asc=true"
        }
    ],
    "collection": [
        {
            "available": true,
            "quarantine": false,
            "links": [
                {
                    "title": "aperque_external",
                    "rel": "externalnetwork",
                    "type": "application/vnd.abiquo.vlan+json",
                    "href": "https://example.com:443/api/admin/datacenters/1/network/13"
                },
                {
                    "title": "Aperque",
                    "rel": "enterprise",
                    "type": "application/vnd.abiquo.enterprise+json",
                    "href": "https://example.com:443/api/admin/enterprises/2"
                },
                {
                    "title": "10.10.10.2",
                    "rel": "self",
                    "type": "application/vnd.abiquo.externalip+json",
                    "href": "https://example.com:443/api/admin/datacenters/1/network/13/ips/47"
                }
            ],
            "id": 47,
            "ip": "10.10.10.2",
            "networkName": "aperque_external",
            "ipv6": false
        },
        {
            "available": true,
            "quarantine": false,
            "links": [
                {
                    "title": "aperque_external",
                    "rel": "externalnetwork",
                    "type": "application/vnd.abiquo.vlan+json",
                    "href": "https://example.com:443/api/admin/datacenters/1/network/13"
                },
                {
                    "title": "Aperque",
                    "rel": "enterprise",
                    "type": "application/vnd.abiquo.enterprise+json",
                    "href": "https://example.com:443/api/admin/enterprises/2"
                },
                {
                    "title": "10.10.10.3",
                    "rel": "self",
                    "type": "application/vnd.abiquo.externalip+json",
                    "href": "https://example.com:443/api/admin/datacenters/1/network/13/ips/48"
                }
            ],
            "id": 48,
            "ip": "10.10.10.3",
            "networkName": "aperque_external",
            "ipv6": false
        },
        {
            "available": true,
            "quarantine": false,
            "links": [
                {
                    "title": "aperque_external",
                    "rel": "externalnetwork",
                    "type": "application/vnd.abiquo.vlan+json",
                    "href": "https://example.com:443/api/admin/datacenters/1/network/13"
                },
                {
                    "title": "Aperque",
                    "rel": "enterprise",
                    "type": "application/vnd.abiquo.enterprise+json",
                    "href": "https://example.com:443/api/admin/enterprises/2"
                },
                {
                    "title": "10.10.10.4",
                    "rel": "self",
                    "type": "application/vnd.abiquo.externalip+json",
                    "href": "https://example.com:443/api/admin/datacenters/1/network/13/ips/49"
                }
            ],
            "id": 49,
            "ip": "10.10.10.4",
            "networkName": "aperque_external",
            "ipv6": false
        },
        {
            "available": true,
            "quarantine": false,
            "links": [
                {
                    "title": "aperque_external",
                    "rel": "externalnetwork",
                    "type": "application/vnd.abiquo.vlan+json",
                    "href": "https://example.com:443/api/admin/datacenters/1/network/13"
                },
                {
                    "title": "Aperque",
                    "rel": "enterprise",
                    "type": "application/vnd.abiquo.enterprise+json",
                    "href": "https://example.com:443/api/admin/enterprises/2"
                },
                {
                    "title": "ABQ_895335e6-aba5-4c86-86f7-89c4edb94bbb",
                    "rel": "virtualmachine",
                    "type": "application/vnd.abiquo.virtualmachine+json",
                    "href": "https://example.com:443/api/cloud/virtualdatacenters/7/virtualappliances/4/virtualmachines/51"
                },
                {
                    "title": "10.10.10.5",
                    "rel": "self",
                    "type": "application/vnd.abiquo.externalip+json",
                    "href": "https://example.com:443/api/admin/datacenters/1/network/13/ips/81"
                },
                {
                    "title": "vdc-bcdca001",
                    "rel": "virtualdatacenter",
                    "type": "application/vnd.abiquo.virtualdatacenter+json",
                    "href": "https://example.com:443/api/cloud/virtualdatacenters/7"
                },
                {
                    "title": "vapp_vdc-bcdca001",
                    "rel": "virtualappliance",
                    "type": "application/vnd.abiquo.virtualappliance+json",
                    "href": "https://example.com:443/api/cloud/virtualdatacenters/7/virtualappliances/4"
                },
                {
                    "title": "ABQ_895335e6-aba5-4c86-86f7-89c4edb94bbb",
                    "rel": "virtualmachine",
                    "type": "application/vnd.abiquo.virtualmachine+json",
                    "href": "https://example.com:443/api/cloud/virtualdatacenters/7/virtualappliances/4/virtualmachines/51"
                }
            ],
            "id": 81,
            "ip": "10.10.10.5",
            "mac": "00:50:56:1D:BB:D9",
            "name": "0050561DBBD9_host",
            "networkName": "aperque_external",
            "ipv6": false,
            "usedBy": "ABQ_895335e6-aba5-4c86-86f7-89c4edb94bbb"
        }
    ],
    "totalSize": 4
}

List public IPs in a datacenter

Return the list of public IPs for a given datacenter.

Paging Method

This method works with paging. Check out Basic Behaviors for information about how it works

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

Parameter

Required

Default Value

Description

startwith

false

0

First element to retrieve.

by

false

ip

How to order the search. Available values are: {IP, QUARANTINE, MAC, LEASE, VLAN,
VIRTUALDATACENTER, VIRTUALMACHINE, VIRTUALAPPLIANCE, ENTERPRISENAME}

has

false

 

a way to filter the search. It can be filtered by: IP address, MAC address,
network name, Virtual Machine name, Virtual Appliance name or Enterprise Name

limit

false

25

number of elements to retrieve.

asc

false

true

the way to order the search (ascendant-> true, descendant -> false). Ascendant by
default.

all

false

false

set if we should return all the IPs or only the available ones (by default).

 

 

 

 

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

 Click here to show or hide the request example

GET_adm_dcs_X_nw_act_pubips_AC_pubips_j.txt

cURL:

curl -X GET http://example.com/api/admin/datacenters/4/network/action/publicips?has=bcdc \ 
	 -H 'Accept:application/vnd.abiquo.publicips+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
    "links": [
        {
            "rel": "first",
            "href": "https://example.com/api/admin/datacenters/4/network/action/publicips?limit=25&has=bcdc&by=ip&asc=true"
        },
        {
            "rel": "last",
            "href": "https://example.com/api/admin/datacenters/4/network/action/publicips?startwith=0&limit=25&has=bcdc&by=ip&asc=true"
        }
    ],
    "collection": [
        {
            "available": true,
            "quarantine": false,
            "links": [
                {
                    "title": "bcdc_public_01",
                    "rel": "publicnetwork",
                    "type": "application/vnd.abiquo.vlan+json",
                    "href": "https://example.com/api/admin/datacenters/4/network/6"
                },
                {
                    "title": "10.10.10.2",
                    "rel": "self",
                    "type": "application/vnd.abiquo.publicip+json",
                    "href": "https://example.com/api/admin/datacenters/4/network/6/ips/23"
                }
            ],
            "id": 23,
            "ip": "10.10.10.2",
            "networkName": "bcdc_public_01",
            "ipv6": false
        },
        {
            "available": true,
            "quarantine": false,
            "links": [
                {
                    "title": "bcdc_public_01",
                    "rel": "publicnetwork",
                    "type": "application/vnd.abiquo.vlan+json",
                    "href": "https://example.com/api/admin/datacenters/4/network/6"
                },
                {
                    "title": "10.10.10.3",
                    "rel": "self",
                    "type": "application/vnd.abiquo.publicip+json",
                    "href": "https://example.com/api/admin/datacenters/4/network/6/ips/24"
                }
            ],
            "id": 24,
            "ip": "10.10.10.3",
            "networkName": "bcdc_public_01",
            "ipv6": false
        }
    ],
    "totalSize": 2
} 

List public and external and unmanaged networks in a datacenter

Return the list of Public, External or Unmanaged VLANs. You can filter to return only one of these network types. By default this method will return all of them.

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

Parameter

Required

Default Value

Description

type

false

 

Type of VLANs to return, otherwise will return all of them. Available values are
PUBLIC, EXTERNAL, UNMANAGED and EXTERNAL_UNMANAGED (for return both)

 

 

 

 

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

 Click here to show or hide the request example

List datacenter networks

 

GET_adm_dcs_X_nw_AC_vlans_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/admin/datacenters/4520/network \ 
	 -H 'Accept:application/vnd.abiquo.vlans+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/4520/network/action/checkavailability", 
      "type": "application/vnd.abiquo.vlantagavailability+json", 
      "rel": "checkavailability", 
      "title": "check vlan availability"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4520/network/action/publicips", 
      "type": "application/vnd.abiquo.publicips+json", 
      "rel": "publicips", 
      "title": "public ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4520/network/action/externalips", 
      "type": "application/vnd.abiquo.externalips+json", 
      "rel": "externalips", 
      "title": "external ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4520/network/action/unmanagedips", 
      "type": "application/vnd.abiquo.unmanagedips+json", 
      "rel": "unmanagedips", 
      "title": "unmanaged ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4520/network?limit=25&asc=true", 
      "rel": "first"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4520/network?startwith=0&limit=25&asc=true", 
      "rel": "last"
    }
  ], 
  "collection": [
    {
      "links": [
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520", 
          "type": "application/vnd.abiquo.datacenter+json", 
          "rel": "datacenter", 
          "title": "604"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1797", 
          "type": "application/vnd.abiquo.vlan+json", 
          "rel": "edit", 
          "title": "617"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/networkservicetypes", 
          "type": "application/vnd.abiquo.networkservicetypes+json", 
          "rel": "networkservicetypes", 
          "title": "network services types"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/networkservicetypes/1668", 
          "type": "application/vnd.abiquo.networkservicetype+json", 
          "rel": "networkservicetype", 
          "title": "Network Service"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1797/ips", 
          "type": "application/vnd.abiquo.publicips+json", 
          "rel": "ips", 
          "title": "public ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1797/configuration", 
          "type": "application/vnd.abiquo.networkconfiguration+json", 
          "rel": "configuration", 
          "title": "configuration"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1797/configuration/1799", 
          "type": "application/vnd.abiquo.networkconfiguration+json", 
          "rel": "network_configuration", 
          "title": "192.168.1.0/24"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1797/ips/action/disable", 
          "type": "application/vnd.abiquo.ipliterals+json", 
          "rel": "disableips", 
          "title": "disable a set of ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1797/ips/action/enable", 
          "type": "application/vnd.abiquo.ipliterals+json", 
          "rel": "enableips", 
          "title": "enable a set of ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1797/ips/action/disableall", 
          "type": "", 
          "rel": "disableallips", 
          "title": "disable all ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1797/ips/action/enableall", 
          "type": "", 
          "rel": "enableallips", 
          "title": "enable all ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1797/ips/action/quarantine", 
          "type": "application/vnd.abiquo.ipliterals+json", 
          "rel": "quarantineips", 
          "title": "put in quarantine a set of ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1797/ips/action/removequarantine", 
          "type": "application/vnd.abiquo.ipliterals+json", 
          "rel": "removequarantineips", 
          "title": "remove from quarantine a set of ips"
        }
      ], 
      "secondaryDNS": "9.9.9.9", 
      "internetGatewayRole": false, 
      "defaultNetwork": false, 
      "tag": 6, 
      "ipRanges": [], 
      "address": "192.168.1.0", 
      "unmanaged": false, 
      "gateway": "192.168.1.1", 
      "name": "617", 
      "primaryDNS": "8.8.8.8", 
      "restricted": false, 
      "dhcpOptions": {
        "links": [], 
        "collection": []
      }, 
      "mask": 24, 
      "id": 1797, 
      "strict": false, 
      "ipv6": false, 
      "type": "PUBLIC", 
      "excludedFromFirewall": false
    }, 
    {
      "links": [
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520", 
          "type": "application/vnd.abiquo.datacenter+json", 
          "rel": "datacenter", 
          "title": "604"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1798", 
          "type": "application/vnd.abiquo.vlan+json", 
          "rel": "edit", 
          "title": "620"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/networkservicetypes", 
          "type": "application/vnd.abiquo.networkservicetypes+json", 
          "rel": "networkservicetypes", 
          "title": "network services types"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/networkservicetypes/1669", 
          "type": "application/vnd.abiquo.networkservicetype+json", 
          "rel": "networkservicetype", 
          "title": "4809"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5159/limits/3544/externalnetworks/1798/ips", 
          "type": "application/vnd.abiquo.externalips+json", 
          "rel": "ips", 
          "title": "external ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5159/limits/3544/externalnetworks/1798/configuration", 
          "type": "application/vnd.abiquo.networkconfiguration+json", 
          "rel": "configuration", 
          "title": "configuration"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5159/limits/3544/externalnetworks/1798/configuration/1800", 
          "type": "application/vnd.abiquo.networkconfiguration+json", 
          "rel": "network_configuration", 
          "title": "192.168.1.0/24"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1798/ips", 
          "type": "application/vnd.abiquo.externalips+json", 
          "rel": "infrastructureips", 
          "title": "external ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5159", 
          "type": "application/vnd.abiquo.enterprise+json", 
          "rel": "enterprise", 
          "title": "606"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1798/ips/action/disable", 
          "type": "application/vnd.abiquo.ipliterals+json", 
          "rel": "disableips", 
          "title": "disable a set of ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1798/ips/action/enable", 
          "type": "application/vnd.abiquo.ipliterals+json", 
          "rel": "enableips", 
          "title": "enable a set of ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1798/ips/action/disableall", 
          "type": "", 
          "rel": "disableallips", 
          "title": "disable all ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1798/ips/action/enableall", 
          "type": "", 
          "rel": "enableallips", 
          "title": "enable all ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1798/ips/action/quarantine", 
          "type": "application/vnd.abiquo.ipliterals+json", 
          "rel": "quarantineips", 
          "title": "put in quarantine a set of ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1798/ips/action/removequarantine", 
          "type": "application/vnd.abiquo.ipliterals+json", 
          "rel": "removequarantineips", 
          "title": "remove from quarantine a set of ips"
        }
      ], 
      "secondaryDNS": "9.9.9.9", 
      "internetGatewayRole": false, 
      "defaultNetwork": false, 
      "tag": 7, 
      "ipRanges": [], 
      "address": "192.168.1.0", 
      "unmanaged": false, 
      "gateway": "192.168.1.1", 
      "name": "620", 
      "primaryDNS": "8.8.8.8", 
      "restricted": false, 
      "dhcpOptions": {
        "links": [], 
        "collection": []
      }, 
      "mask": 24, 
      "id": 1798, 
      "strict": false, 
      "ipv6": false, 
      "type": "EXTERNAL", 
      "excludedFromFirewall": false
    }, 
    {
      "links": [
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520", 
          "type": "application/vnd.abiquo.datacenter+json", 
          "rel": "datacenter", 
          "title": "604"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1799", 
          "type": "application/vnd.abiquo.vlan+json", 
          "rel": "edit", 
          "title": "624"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/networkservicetypes", 
          "type": "application/vnd.abiquo.networkservicetypes+json", 
          "rel": "networkservicetypes", 
          "title": "network services types"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/networkservicetypes/1670", 
          "type": "application/vnd.abiquo.networkservicetype+json", 
          "rel": "networkservicetype", 
          "title": "8326"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5159/limits/3544/externalnetworks/1799/ips", 
          "type": "application/vnd.abiquo.unmanagedips+json", 
          "rel": "ips", 
          "title": "unmanaged ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5159/limits/3544/externalnetworks/1799/configuration", 
          "type": "application/vnd.abiquo.networkconfiguration+json", 
          "rel": "configuration", 
          "title": "configuration"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5159/limits/3544/externalnetworks/1799/configuration/1801", 
          "type": "application/vnd.abiquo.networkconfiguration+json", 
          "rel": "network_configuration", 
          "title": "192.168.1.0/24"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1799/ips", 
          "type": "application/vnd.abiquo.unmanagedips+json", 
          "rel": "infrastructureips", 
          "title": "unmanaged ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/5159", 
          "type": "application/vnd.abiquo.enterprise+json", 
          "rel": "enterprise", 
          "title": "606"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1799/ips/action/disable", 
          "type": "application/vnd.abiquo.ipliterals+json", 
          "rel": "disableips", 
          "title": "disable a set of ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1799/ips/action/enable", 
          "type": "application/vnd.abiquo.ipliterals+json", 
          "rel": "enableips", 
          "title": "enable a set of ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1799/ips/action/disableall", 
          "type": "", 
          "rel": "disableallips", 
          "title": "disable all ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4520/network/1799/ips/action/enableall", 
          "type": "", 
          "rel": "enableallips", 
          "title": "enable all ips"
        }
      ], 
      "secondaryDNS": "9.9.9.9", 
      "internetGatewayRole": false, 
      "defaultNetwork": false, 
      "tag": 8, 
      "ipRanges": [], 
      "address": "192.168.1.0", 
      "unmanaged": true, 
      "gateway": "192.168.1.1", 
      "name": "624", 
      "primaryDNS": "8.8.8.8", 
      "restricted": false, 
      "dhcpOptions": {
        "links": [], 
        "collection": []
      }, 
      "mask": 24, 
      "id": 1799, 
      "strict": false, 
      "ipv6": false, 
      "type": "UNMANAGED", 
      "excludedFromFirewall": false
    }
  ]
}

Retrieve networks using type parameter

 Click here to show or hide the request example

 List datacenter networks by type external and filtered by text

GET_adm_dcs_X_nw_AC_vlans_j_type_startw_lmt_has.0001.txt

cURL:

curl -X GET http://localhost:9000/api/admin/datacenters/4135/network?type=EXTERNAL&startwith=0&limit=1&has=test%20filter \ 
	 -H 'Accept:application/vnd.abiquo.vlans+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/4135/network/action/checkavailability", 
      "type": "application/vnd.abiquo.vlantagavailability+json", 
      "rel": "checkavailability", 
      "title": "check vlan availability"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4135/network/action/publicips", 
      "type": "application/vnd.abiquo.publicips+json", 
      "rel": "publicips", 
      "title": "public ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4135/network/action/externalips", 
      "type": "application/vnd.abiquo.externalips+json", 
      "rel": "externalips", 
      "title": "external ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4135/network/action/unmanagedips", 
      "type": "application/vnd.abiquo.unmanagedips+json", 
      "rel": "unmanagedips", 
      "title": "unmanaged ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4135/network?type=EXTERNAL&limit=1&has=test filter&asc=true", 
      "rel": "first"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4135/network?type=EXTERNAL&startwith=1&limit=1&has=test filter&asc=true", 
      "rel": "next"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/4135/network?type=EXTERNAL&startwith=2&limit=1&has=test filter&asc=true", 
      "rel": "last"
    }
  ], 
  "collection": [
    {
      "links": [
        {
          "href": "http://localhost:9009/api/admin/datacenters/4135", 
          "type": "application/vnd.abiquo.datacenter+json", 
          "rel": "datacenter", 
          "title": "1179"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4135/network/1762", 
          "type": "application/vnd.abiquo.vlan+json", 
          "rel": "edit", 
          "title": "1196test filter"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4135/networkservicetypes", 
          "type": "application/vnd.abiquo.networkservicetypes+json", 
          "rel": "networkservicetypes", 
          "title": "network services types"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4135/networkservicetypes/1663", 
          "type": "application/vnd.abiquo.networkservicetype+json", 
          "rel": "networkservicetype", 
          "title": "1798"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/4667/limits/3125/externalnetworks/1762/ips", 
          "type": "application/vnd.abiquo.externalips+json", 
          "rel": "ips", 
          "title": "external ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/4667/limits/3125/externalnetworks/1762/configuration", 
          "type": "application/vnd.abiquo.networkconfiguration+json", 
          "rel": "configuration", 
          "title": "configuration"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/4667/limits/3125/externalnetworks/1762/configuration/1764", 
          "type": "application/vnd.abiquo.networkconfiguration+json", 
          "rel": "network_configuration", 
          "title": "192.168.1.0/24"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4135/network/1762/ips", 
          "type": "application/vnd.abiquo.externalips+json", 
          "rel": "infrastructureips", 
          "title": "external ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/4667", 
          "type": "application/vnd.abiquo.enterprise+json", 
          "rel": "enterprise", 
          "title": "1181"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4135/network/1762/ips/action/disable", 
          "type": "application/vnd.abiquo.ipliterals+json", 
          "rel": "disableips", 
          "title": "disable a set of ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4135/network/1762/ips/action/enable", 
          "type": "application/vnd.abiquo.ipliterals+json", 
          "rel": "enableips", 
          "title": "enable a set of ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4135/network/1762/ips/action/disableall", 
          "type": "", 
          "rel": "disableallips", 
          "title": "disable all ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4135/network/1762/ips/action/enableall", 
          "type": "", 
          "rel": "enableallips", 
          "title": "enable all ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4135/network/1762/ips/action/quarantine", 
          "type": "application/vnd.abiquo.ipliterals+json", 
          "rel": "quarantineips", 
          "title": "put in quarantine a set of ips"
        }, 
        {
          "href": "http://localhost:9009/api/admin/datacenters/4135/network/1762/ips/action/removequarantine", 
          "type": "application/vnd.abiquo.ipliterals+json", 
          "rel": "removequarantineips", 
          "title": "remove from quarantine a set of ips"
        }
      ], 
      "secondaryDNS": "9.9.9.9", 
      "internetGatewayRole": false, 
      "defaultNetwork": false, 
      "tag": 7, 
      "ipRanges": [], 
      "address": "192.168.1.0", 
      "unmanaged": false, 
      "gateway": "192.168.1.1", 
      "name": "1196test filter", 
      "primaryDNS": "8.8.8.8", 
      "restricted": false, 
      "dhcpOptions": {
        "links": [], 
        "collection": []
      }, 
      "mask": 24, 
      "id": 1762, 
      "strict": false, 
      "ipv6": false, 
      "type": "EXTERNAL", 
      "excludedFromFirewall": false
    }
  ]
}

List unmanaged IPs in a datacenter

Return the list of unmanaged IPs for a given datacenter.

Paging Method

This method works with paging. Check out Basic Behaviors for information about how it works

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

Parameter

Required

Default Value

Description

startwith

false

0

First element to retrieve.

by

false

ip

How to order the search. Available values are: {IP, QUARANTINE, MAC, LEASE, VLAN,
VIRTUALDATACENTER, VIRTUALMACHINE, VIRTUALAPPLIANCE, ENTERPRISENAME}

has

false

 

a way to filter the search. It can be filtered by: IP address, MAC address,
network name, Virtual Machine name, Virtual Appliance name or Enterprise Name

limit

false

25

number of elements to retrieve.

asc

false

true

the way to order the search (ascendant-> true, descendant -> false). Ascendant by
default.

all

false

false

set if we should return all the IPs or only the available ones (by default).

 

 

 

 

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

 Click here to show or hide the request example

GET_adm_dcs_X_nw_act_unmgdips_AC_unmgdips_j.txt

cURL:

curl -X GET http://localhost:9000/api/admin/datacenters/1/network/action/unmanagedips?has=mjentu2 \ 
	 -H 'Accept:application/vnd.abiquo.unmanagedips+json; version=3.4' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
    "links": [
        {
            "rel": "first",
            "href": "http://localhost:9000/api/admin/datacenters/1/network/action/unmanagedips?limit=25&has=mjentu2&by=ip"
        },
        {
            "rel": "last",
            "href": "http://localhost:9000/api/admin/datacenters/1/network/action/unmanagedips?startwith=0&limit=25&has=mjentu2&by=ip"
        }
    ],
    "collection": [
        {
            "links": [
                {
                    "title": "mjentu2",
                    "rel": "unmanagednetwork",
                    "type": "application/vnd.abiquo.vlan+json",
                    "href": "http://localhost:9000/api/admin/datacenters/1/network/172"
                },
                {
                    "title": "Marketing Joint Ent",
                    "rel": "enterprise",
                    "type": "application/vnd.abiquo.enterprise+json",
                    "href": "http://localhost:9000/api/admin/enterprises/6"
                },
                {
                    "title": "ABQ_7ac78ec8-76c5-4ebf-8e18-9ca1a8adc240",
                    "rel": "virtualmachine",
                    "type": "application/vnd.abiquo.virtualmachine+json",
                    "href": "http://localhost:9000/api/cloud/virtualdatacenters/26/virtualappliances/53/virtualmachines/225"
                },
                {
                    "title": "?",
                    "rel": "self",
                    "type": "application/vnd.abiquo.unmanagedip+json",
                    "href": "http://localhost:9000/api/admin/datacenters/1/network/172/ips/1507"
                },
                {
                    "title": "def_vdc_01",
                    "rel": "virtualdatacenter",
                    "type": "application/vnd.abiquo.virtualdatacenter+json",
                    "href": "http://localhost:9000/api/cloud/virtualdatacenters/26"
                },
                {
                    "title": "abc_def_mjs_vapp",
                    "rel": "virtualappliance",
                    "type": "application/vnd.abiquo.virtualappliance+json",
                    "href": "http://localhost:9000/api/cloud/virtualdatacenters/26/virtualappliances/53"
                },
                {
                    "title": "ABQ_7ac78ec8-76c5-4ebf-8e18-9ca1a8adc240",
                    "rel": "virtualmachine",
                    "type": "application/vnd.abiquo.virtualmachine+json",
                    "href": "http://localhost:9000/api/cloud/virtualdatacenters/26/virtualappliances/53/virtualmachines/225"
                }
            ],
            "id": 1507,
            "ip": "?",
            "mac": "00:50:56:26:91:9E",
            "name": "00505626919E_host",
            "networkName": "mjentu2",
            "ipv6": false,
            "available": true,
            "quarantine": false
        },
        {
            "links": [
                {
                    "title": "mjentu2",
                    "rel": "unmanagednetwork",
                    "type": "application/vnd.abiquo.vlan+json",
                    "href": "http://localhost:9000/api/admin/datacenters/1/network/172"
                },
                {
                    "title": "Marketing Joint Ent",
                    "rel": "enterprise",
                    "type": "application/vnd.abiquo.enterprise+json",
                    "href": "http://localhost:9000/api/admin/enterprises/6"
                },
                {
                    "title": "10.10.66.1",
                    "rel": "self",
                    "type": "application/vnd.abiquo.unmanagedip+json",
                    "href": "http://localhost:9000/api/admin/datacenters/1/network/172/ips/1506"
                }
            ],
            "id": 1506,
            "ip": "10.10.66.1",
            "networkName": "mjentu2",
            "ipv6": false,
            "available": true,
            "quarantine": false
        }
    ],
    "totalSize": 2
}

Update a public, external, or unmanaged network

Update a public, external or unmanaged network. If no IPs are being used by virtual machines, then some of the network values can be modified.

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

Parameter

Required

Default Value

Description

 

 

 

 

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

 Click here to show or hide the request example

Update a public network

PUT_adm_dcs_X_nw_X_CT_vlan_j_AC_vlan_j.0001.txt

cURL:

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

Success status code: 200

Request payload:

{
  "links": [
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982", 
      "type": "application/vnd.abiquo.datacenter+json", 
      "rel": "datacenter", 
      "title": "1424"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982/network/1582", 
      "type": "application/vnd.abiquo.vlan+json", 
      "rel": "edit", 
      "title": "1475"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982/networkservicetypes", 
      "type": "application/vnd.abiquo.networkservicetypes+json", 
      "rel": "networkservicetypes", 
      "title": "network services types"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982/networkservicetypes/1377", 
      "type": "application/vnd.abiquo.networkservicetype+json", 
      "rel": "networkservicetype", 
      "title": "4960"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/4595/limits/3214/externalnetworks/1582/ips", 
      "type": "application/vnd.abiquo.externalips+json", 
      "rel": "ips", 
      "title": "external ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/4595/limits/3214/externalnetworks/1582/configuration", 
      "type": "application/vnd.abiquo.networkconfiguration+json", 
      "rel": "configuration", 
      "title": "configuration"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/4595/limits/3214/externalnetworks/1582/configuration/1584", 
      "type": "application/vnd.abiquo.networkconfiguration+json", 
      "rel": "network_configuration", 
      "title": "2001:db8:0:1::/64"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982/network/1582/ips", 
      "type": "application/vnd.abiquo.externalips+json", 
      "rel": "infrastructureips", 
      "title": "external ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/4595", 
      "type": "application/vnd.abiquo.enterprise+json", 
      "rel": "enterprise", 
      "title": "1426"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982/network/1582/ips/action/disable", 
      "type": "application/vnd.abiquo.ipliterals+json", 
      "rel": "disableips", 
      "title": "disable a set of ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982/network/1582/ips/action/enable", 
      "type": "application/vnd.abiquo.ipliterals+json", 
      "rel": "enableips", 
      "title": "enable a set of ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982/network/1582/ips/action/disableall", 
      "type": "", 
      "rel": "disableallips", 
      "title": "disable all ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982/network/1582/ips/action/enableall", 
      "type": "", 
      "rel": "enableallips", 
      "title": "enable all ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982/network/1582/ips/action/quarantine", 
      "type": "application/vnd.abiquo.ipliterals+json", 
      "rel": "quarantineips", 
      "title": "put in quarantine a set of ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982/network/1582/ips/action/removequarantine", 
      "type": "application/vnd.abiquo.ipliterals+json", 
      "rel": "removequarantineips", 
      "title": "remove from quarantine a set of ips"
    }
  ], 
  "secondaryDNS": "9.9.9.9", 
  "internetGatewayRole": false, 
  "defaultNetwork": false, 
  "tag": 34, 
  "ipRanges": [], 
  "address": "2001:db8:0:1::", 
  "unmanaged": false, 
  "gateway": "2001:db8:0:1::1230", 
  "name": "newpublicnetworkname", 
  "sufixDNS": "bcn.community.abiquo.com", 
  "primaryDNS": "8.8.8.8", 
  "restricted": true, 
  "dhcpOptions": {
    "links": [], 
    "collection": []
  }, 
  "mask": 64, 
  "id": 1582, 
  "strict": true, 
  "ipv6": true, 
  "type": "EXTERNAL", 
  "excludedFromFirewall": false
}

Response payload:

{
  "links": [
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982", 
      "type": "application/vnd.abiquo.datacenter+json", 
      "rel": "datacenter", 
      "title": "1424"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982/network/1582", 
      "type": "application/vnd.abiquo.vlan+json", 
      "rel": "edit", 
      "title": "newpublicnetworkname"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982/networkservicetypes", 
      "type": "application/vnd.abiquo.networkservicetypes+json", 
      "rel": "networkservicetypes", 
      "title": "network services types"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982/networkservicetypes/1377", 
      "type": "application/vnd.abiquo.networkservicetype+json", 
      "rel": "networkservicetype", 
      "title": "4960"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/4595/limits/3214/externalnetworks/1582/ips", 
      "type": "application/vnd.abiquo.externalips+json", 
      "rel": "ips", 
      "title": "external ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/4595/limits/3214/externalnetworks/1582/configuration", 
      "type": "application/vnd.abiquo.networkconfiguration+json", 
      "rel": "configuration", 
      "title": "configuration"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/4595/limits/3214/externalnetworks/1582/configuration/1584", 
      "type": "application/vnd.abiquo.networkconfiguration+json", 
      "rel": "network_configuration", 
      "title": "2001:db8:0:1::/64"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982/network/1582/ips", 
      "type": "application/vnd.abiquo.externalips+json", 
      "rel": "infrastructureips", 
      "title": "external ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/4595", 
      "type": "application/vnd.abiquo.enterprise+json", 
      "rel": "enterprise", 
      "title": "1426"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982/network/1582/ips/action/disable", 
      "type": "application/vnd.abiquo.ipliterals+json", 
      "rel": "disableips", 
      "title": "disable a set of ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982/network/1582/ips/action/enable", 
      "type": "application/vnd.abiquo.ipliterals+json", 
      "rel": "enableips", 
      "title": "enable a set of ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982/network/1582/ips/action/disableall", 
      "type": "", 
      "rel": "disableallips", 
      "title": "disable all ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982/network/1582/ips/action/enableall", 
      "type": "", 
      "rel": "enableallips", 
      "title": "enable all ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982/network/1582/ips/action/quarantine", 
      "type": "application/vnd.abiquo.ipliterals+json", 
      "rel": "quarantineips", 
      "title": "put in quarantine a set of ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/3982/network/1582/ips/action/removequarantine", 
      "type": "application/vnd.abiquo.ipliterals+json", 
      "rel": "removequarantineips", 
      "title": "remove from quarantine a set of ips"
    }
  ], 
  "secondaryDNS": "9.9.9.9", 
  "internetGatewayRole": false, 
  "defaultNetwork": false, 
  "tag": 34, 
  "ipRanges": [], 
  "address": "2001:db8:0:1::", 
  "unmanaged": false, 
  "gateway": "2001:db8:0:1::1230", 
  "name": "newpublicnetworkname", 
  "sufixDNS": "bcn.community.abiquo.com", 
  "primaryDNS": "8.8.8.8", 
  "restricted": true, 
  "dhcpOptions": {
    "links": [], 
    "collection": []
  }, 
  "mask": 64, 
  "id": 1582, 
  "strict": true, 
  "ipv6": true, 
  "type": "EXTERNAL", 
  "excludedFromFirewall": false
}

 

Put multiple IPs into quarantine in a public or external network

Put multiple IPs in a public or external network into quarantine. Accepts lists of IPs separated by commas and/or ranges of IPs separated by a dash.

Synopsis: POST http://example.com/api/admin/datacenters/{datacenter}/network/{publicnetwork}/ips/action/quarantine
Roles Required: PHYS_DC_ALLOW_MODIFY_NETWORK
Request Headers: Accept:  Content-type:  application/vnd.abiquo.ipliterals+json; version=4.4; application/vnd.abiquo.ipliterals+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

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

 Click here to show or hide the request example

Put multiple IPs in a public or external network into quarantine

POST_adm_dcs_X_nw_X_ips_act_qtn_CT_ipliterals_j.0001.txt

cURL:

curl -X POST http://localhost:9000/api/admin/datacenters/4018/network/1609/ips/action/quarantine \ 
	 -H 'Content-Type:application/vnd.abiquo.ipliterals+json; version=4.2' \ 
	 -d @requestpayload.json \ 
	 -u user:password --verbose 

Success status code: 204

Request payload:

{
  "ips": [
    "10.20.30.1", 
    "", 
    "10.20.30.3", 
    "192.168.1.3", 
    "10.20.30.5-10.20.30.10"
  ], 
  "links": []
}

Response payload:

--none--

 

Remove multiple IPs from quarantine in a public or external network

Remove multiple IPs in a public or external network from quarantine. Accepts lists of IPs separated by commas and/or ranges of IPs separated by a dash.

Synopsis: POST http://example.com/api/admin/datacenters/{datacenter}/network/{publicnetwork}/ips/action/removequarantine
Roles Required: PHYS_DC_ALLOW_MODIFY_NETWORK
Request Headers: Accept:  Content-type:  application/vnd.abiquo.ipliterals+json; version=4.4; application/vnd.abiquo.ipliterals+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

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

 Click here to show or hide the request example

Remove multiple IPs in a public or external network from quarantine

POST_adm_dcs_X_nw_X_ips_act_remqtn_ CT_ipliterals_j_.0001.txt

cURL:

curl -X POST http://localhost:9000/api/admin/datacenters/4039/network/1682/ips/action/removequarantine \ 
	 -H 'Content-Type:application/vnd.abiquo.ipliterals+json; version=4.0' \ 
	 -d @requestpayload.json \ 
	 -u user:password --verbose 

Success status code: 204

Request payload:

{
 ips: ["10.10.12.7","10.10.12.10","10.10.12.12"]
}

Response payload:

-- none --

 

 

Get a datacenter network

Returns a single public, external, or unmanaged network given its identifier.

Synopsis: GET http://example.com/api/admin/datacenters/{datacenter}/network/{publicnetwork}
Roles Required: PHYS_DC_RETRIEVE_DETAILS, VDC_MANAGE_VAPP, VDC_ENUMERATE
Request Headers: Accept: application/vnd.abiquo.vlan+json; version=4.4; application/vnd.abiquo.vlan+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

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

 Click here to show or hide the request example

Get a datacenter network

GET_adm_dcs_X_nw_X_AC_vlan_j.0001.txt

cURL:

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

Success status code: 200

Request payload:

--none--

Response payload:

{
  "links": [
    {
      "href": "http://localhost:9009/api/admin/datacenters/22", 
      "type": "application/vnd.abiquo.datacenter+json", 
      "rel": "datacenter", 
      "title": "95"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/22/network/28", 
      "type": "application/vnd.abiquo.vlan+json", 
      "rel": "edit", 
      "title": "185"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/22/networkservicetypes", 
      "type": "application/vnd.abiquo.networkservicetypes+json", 
      "rel": "networkservicetypes", 
      "title": "network services types"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/22/networkservicetypes/17", 
      "type": "application/vnd.abiquo.networkservicetype+json", 
      "rel": "networkservicetype", 
      "title": "Network Service"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/22/network/28/ips", 
      "type": "application/vnd.abiquo.publicips+json", 
      "rel": "ips", 
      "title": "public ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/22/network/28/configuration", 
      "type": "application/vnd.abiquo.networkconfiguration+json", 
      "rel": "configuration", 
      "title": "configuration"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/22/network/28/configuration/28", 
      "type": "application/vnd.abiquo.networkconfiguration+json", 
      "rel": "network_configuration", 
      "title": "2001:db8:0:1::/64"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/22/network/28/ips/action/disable", 
      "type": "application/vnd.abiquo.ipliterals+json", 
      "rel": "disableips", 
      "title": "disable a set of ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/22/network/28/ips/action/enable", 
      "type": "application/vnd.abiquo.ipliterals+json", 
      "rel": "enableips", 
      "title": "enable a set of ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/22/network/28/ips/action/disableall", 
      "type": "", 
      "rel": "disableallips", 
      "title": "disable all ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/22/network/28/ips/action/enableall", 
      "type": "", 
      "rel": "enableallips", 
      "title": "enable all ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/22/network/28/ips/action/quarantine", 
      "type": "application/vnd.abiquo.ipliterals+json", 
      "rel": "quarantineips", 
      "title": "put in quarantine a set of ips"
    }, 
    {
      "href": "http://localhost:9009/api/admin/datacenters/22/network/28/ips/action/removequarantine", 
      "type": "application/vnd.abiquo.ipliterals+json", 
      "rel": "removequarantineips", 
      "title": "remove from quarantine a set of ips"
    }
  ], 
  "secondaryDNS": "9.9.9.9", 
  "internetGatewayRole": false, 
  "defaultNetwork": false, 
  "tag": 1033, 
  "ipRanges": [], 
  "address": "2001:db8:0:1::", 
  "unmanaged": false, 
  "gateway": "2001:db8:0:1::1230", 
  "name": "185", 
  "primaryDNS": "8.8.8.8", 
  "restricted": false, 
  "dhcpOptions": {
    "links": [], 
    "collection": []
  }, 
  "mask": 64, 
  "id": 28, 
  "strict": false, 
  "ipv6": true, 
  "type": "PUBLIC", 
  "excludedFromFirewall": false
}

Delete a public, external, or unamanged network

Delete a public, external or unmanaged network. You can only delete a network if no IPs in the network are being used by a VM. In addition, you can only delete public networks if no IPs are associated with a virtual datacenter.

Synopsis: DELETE http://example.com/api/admin/datacenters/{datacenter}/network/{publicnetwork}
Roles Required: DC_ALLOW_MODIFY_NETWORK
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 a datacenter network

DELETE_adm_dcs_X_nw_X.0001.txt

cURL:

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

Success status code: 204

Request payload:

--none--

Response payload:

--none--

Get the configuration of a datacenter network

Returns a single public, external, or unmanaged network configuration given the network's identifier.

Synopsis: GET http://example.com/api/admin/datacenters/{datacenter}/network/{publicnetwork}
Roles Required: PHYS_DC_RETRIEVE_DETAILS, VDC_MANAGE_VAPP, VDC_ENUMERATE
Request Headers: Accept:  application/vnd.abiquo.networkconfiguration+json; version=4.4; application/vnd.abiquo.networkconfiguration+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

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

 Click here to show or hide the request example

Get the configuration of a datacenter network


GET_adm_dcs_X_nw_X_cfg_AC_networkconfiguration_j.txt

cURL:

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

Success status code: 200

Request payload:

--none--

Response payload:

{
    "id": 2,
    "gateway": "10.10.10.1",
    "primaryDNS": "8.8.8.8",
    "secondaryDNS": "8.8.4.4",
    "links": [
        {
            "title": "10.10.10.1",
            "rel": "self",
            "type": "application/vnd.abiquo.networkconfiguration+json",
            "href": "https://mjsabiquo.bcn.abiquo.com:443/api/admin/enterprises/1/limits/1/externalnetworks/2/configuration/2"
        }
    ]
}

Make all IPs available in a public or external network

Make all IPs available in a public or external network. 

Synopsis: POST http://example.com/api/admin/datacenters/{datacenter}/network/{publicnetwork}/ips/action/enableall 
Roles Required: PHYS_DC_ALLOW_MODIFY_NETWORK
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

Make all IPs available in a public or external network

POST_adm_dcs_X_nw_X_ips_act_enableall_CT_any.0002.txt

cURL:

curl -X POST http://localhost:9000/api/admin/datacenters/3667/network/1623/ips/action/enableall \ 
	 -u user:password --verbose 

Success status code: 204

Request payload:

--none--

Response payload:

--none--

 

Make all IPs unavailable in a public or external network

Make all IPs unavailable in a public or external network. 

Synopsis: POST http://example.com/api/admin/datacenters/{datacenter}/network/{publicnetwork}/ips/action/disableall 
Roles Required: PHYS_DC_ALLOW_MODIFY_NETWORK
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

Make all IPs unavailable in a public or external network

POST_adm_dcs_X_nw_X_ips_act_disableall_CT_any.0001.txt

cURL:

curl -X POST http://localhost:9000/api/admin/datacenters/3942/network/1540/ips/action/disableall \ 
	 -u user:password --verbose 

Success status code: 204

Request payload:

--none--

Response payload:

--none--


Make multiple IPs available in a public or external network

Make multiple IPs available in a public or external network. Accepts lists of IPs separated by commas and/or ranges of IPs separated by a dash.

Synopsis: POST http://example.com/api/admin/datacenters/{datacenter}/network/{publicnetwork}/ips/action/enable 
Roles Required: PHYS_DC_ALLOW_MODIFY_NETWORK
Request Headers: Accept:  Content-type:  application/vnd.abiquo.ipliterals+json; version=4.4; application/vnd.abiquo.ipliterals+xml; version=4.4;  
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

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

 Click here to show or hide the request example

Make multiple IPs available in a public or external network

POST_adm_dcs_X_nw_X_ips_act_enable_CT_ipliterals_j.0001.txt

cURL:

curl -X POST http://localhost:9000/api/admin/datacenters/3950/network/1547/ips/action/enable \ 
	 -H 'Content-Type:application/vnd.abiquo.ipliterals+json; version=4.2' \ 
	 -d @requestpayload.json \ 
	 -u user:password --verbose 

Success status code: 204

Request payload:

{
  "ips": [
    "", 
    "192.168.1.3", 
    "10.20.30.2", 
    "10.20.30.5"
  ], 
  "links": []
}

Response payload:

--none--

 

Make multiple IPs unavailable in a public or external network

Make multiple IPs unavailable in a public or external network. Accepts lists of IPs separated by commas and/or ranges of IPs separated by a dash.

Synopsis: POST http://example.com/api/admin/datacenters/{datacenter}/network/{publicnetwork}/ips/action/disable 
Roles Required: PHYS_DC_ALLOW_MODIFY_NETWORK
Request Headers: Accept:  Content-type:  application/vnd.abiquo.ipliterals+json; version=4.4; application/vnd.abiquo.ipliterals+xml; version=4.4;  
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

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

 Click here to show or hide the request example

Make multiple IPs unavailable in a public or external network

POST_adm_dcs_X_nw_X_ips_act_disable_CT_ipliterals_j.0001.txt

cURL:

curl -X POST http://localhost:9000/api/admin/datacenters/3944/network/1542/ips/action/disable \ 
	 -H 'Content-Type:application/vnd.abiquo.ipliterals+json; version=4.2' \ 
	 -d @requestpayload.json \ 
	 -u user:password --verbose 

Success status code: 204

Request payload:

{
  "ips": [
    "", 
    "192.168.1.3", 
    "10.20.30.2", 
    "10.20.30.5"
  ], 
  "links": []
}

Response payload:

--none--