ExcludedNetworksResource


Create an excluded network in a datacenter


POST https://example.com/api/admin/datacenters/{datacenter}/excludednetworks

Roles : [ROLE_PHYS_DC_MANAGE]

Parameter Type Default Value Description
force boolean false If true create the network although exist another network with the same range

Content-Type : excludednetwork Accept : excludednetwork

Error Codes

  • CONSTR-LENGTH - The property 'name' length must be between 1 and 40.
  • CONSTR-MAX - The property 'mask' must be less than or equal to 128.
  • EXCLUDEDNETWORK-1 - Address attribute is required
  • EXCLUDEDNETWORK-2 - Mask attribute is required and must be equal or greater than 0
  • EXCLUDEDNETWORK-3 - The network does not match the mask. Check your request
  • EXCLUDEDNETWORK-4 - IP format is invalid
  • EXCLUDEDNETWORK-5 - IPv6 networks can have a netmask of 64, 56 or 48
  • EXCLUDEDNETWORK-6 - The range to exclude is already in use by another existing network
  • EXCLUDEDNETWORK-7 - Name attribute is required

Example

List excluded networks in a datacenter


GET https://example.com/api/admin/datacenters/{datacenter}/excludednetworks

Roles : [ROLE_PHYS_DC_ENUMERATE, ROLE_USERS_MANAGE_ENTERPRISE]

Parameter Type Default Value Description
startwith Integer 0 The first element to be retrieved of the filtered search
by String name Order by
has String If present filter to apply in the search.
limit Integer 25 The number of entities to retrieve
asc Boolean true If the value of the 'by' parameter must be sorted in ascending order (true) or descending order (false)

Accept : excludednetworks

Example

Delete an excluded network from a datacenter


DELETE https://example.com/api/admin/datacenters/{datacenter}/excludednetworks/{excludednetwork}

Roles : [ROLE_PHYS_DC_MANAGE]

Example

Get an excluded network in a datacenter


GET https://example.com/api/admin/datacenters/{datacenter}/excludednetworks/{excludednetwork}

Roles : [ROLE_PHYS_DC_ENUMERATE]

Accept : excludednetwork

Error Codes

  • DC-0 - The requested datacenter does not exist
  • EXCLUDEDNETWORK-0 - The requested excluded network does not exist

Example

Update an excluded network in a datacenter


PUT https://example.com/api/admin/datacenters/{datacenter}/excludednetworks/{excludednetwork}

Roles : [ROLE_PHYS_DC_MANAGE]

Parameter Type Default Value Description
force boolean false If true update the network although exist another network with the same range

Content-Type : excludednetwork Accept : excludednetwork

Error Codes

  • DC-0 - The requested datacenter does not exist
  • EXCLUDEDNETWORK-0 - The requested excluded network does not exist
  • EXCLUDEDNETWORK-3 - The network does not match the mask. Check your request
  • EXCLUDEDNETWORK-4 - IP format is invalid
  • EXCLUDEDNETWORK-5 - IPv6 networks can have a netmask of 64, 56 or 48
  • EXCLUDEDNETWORK-6 - The range to exclude is already in use by another existing network

Example