Subnets

>>>

GET /api/subnets
Llista de les subxarxes

GET /api/domains/:domain_id/subnets
Llista de les subxarxes per a un domini

GET /api/locations/:location_id/subnets
Llista de les subxarxes per ubicació

GET /api/organizations/:organization_id/subnets
Llista de les subxarxes per organització

Params

Param name Description
domain_id
optional

ID de domini

Validations:

  • Must be a String
location_id
optional

Abast per ubicacions

Validations:

  • Must be a Integer
organization_id
optional

Abast per organitzacions

Validations:

  • Must be a Integer
search
optional

filtra els resultats

Validations:

  • Must be a String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Nombre de resultats per pàgina a retornar

Validations:

  • Must be a number.

Search fields

Field name Tipus Possible values
boot_mode
dns_primary
dns_secondary
domain
gateway
ipam
location
location_id
mask
mtu
name
network
nic_delay
organization
organization_id
params string
type
vlanid
>>>

GET /api/subnets/:id
Mostra una subxarxa

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
show_hidden_parameters
optional

Mostra els valors dels paràmetres ocults

Validations:

  • Must be one of: true, false, 1, 0.
>>>

POST /api/subnets
Crea una subxarxa

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
subnet
required

Validations:

  • Must be a Hash
subnet[name]
required

Nom de la subxarxa

Validations:

  • Must be a String
subnet[description]
optional , nil allowed

Descripció de la subxarxa

Validations:

  • Must be a String
subnet[network_type]
optional , nil allowed

Tipus de protocol, IPv4 o IPv6, per defecte IPv4

Validations:

  • Must be one of: IPv4, IPv6.
subnet[network]
required

Xarxa de la subxarxa

Validations:

  • Must be a String
subnet[cidr]
optional , nil allowed

Network prefix in CIDR notation

Validations:

  • Must be a String
subnet[mask]
optional , nil allowed

Màscara de xarxa per aquesta subxarxa

Validations:

  • Must be a String
subnet[gateway]
optional , nil allowed

Subnet gateway

Validations:

  • Must be a String
subnet[dns_primary]
optional , nil allowed

DNS primari per aquesta subxarxa

Validations:

  • Must be a String
subnet[dns_secondary]
optional , nil allowed

DNS secundari per aquesta subxarxa

Validations:

  • Must be a String
subnet[ipam]
optional , nil allowed

IP Address auto suggestion mode for this subnet.

Validations:

  • Must be one of: DHCP, Internal DB, Random DB, EUI-64, External IPAM, None.
subnet[from]
optional , nil allowed

Adreça IP inicial per a l'autosuggestió de la IP

Validations:

  • Must be a String
subnet[to]
optional , nil allowed

Adreça IP final per a l'autosuggestió de la IP

Validations:

  • Must be a String
subnet[vlanid]
optional , nil allowed

ID de VLAN per aquesta subxarxa

Validations:

  • Must be a String
subnet[mtu]
optional , nil allowed

MTU for this subnet

Validations:

  • Must be a Integer
subnet[domain_ids]
optional , nil allowed

Dominis als quals aquesta subxarxa en forma part

Validations:

  • Must be an array of any type
subnet[dhcp_id]
optional , nil allowed

DHCP Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[tftp_id]
optional , nil allowed

TFTP Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[httpboot_id]
optional , nil allowed

HTTPBoot Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[externalipam_id]
optional , nil allowed

External IPAM Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[dns_id]
optional , nil allowed

DNS Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[template_id]
optional , nil allowed

Template HTTP(S) Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[boot_mode]
optional , nil allowed

Default boot mode for interfaces assigned to this subnet.

Validations:

  • Must be one of: Static, DHCP.
subnet[subnet_parameters_attributes]
optional , nil allowed

Seqüència de paràmetres (nom, valor)

Validations:

  • Must be an array of any type
subnet[location_ids]
optional , nil allowed

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type
subnet[organization_ids]
optional , nil allowed

SUBSTITUEIX les organitzacions amb els ID donats.

Validations:

  • Must be an array of any type
>>>

PUT /api/subnets/:id
Actualitza una subxarxa

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Identificador numèric de subxarxa

Validations:

  • Must be a number.
subnet
required

Validations:

  • Must be a Hash
subnet[name]
optional

Nom de la subxarxa

Validations:

  • Must be a String
subnet[description]
optional , nil allowed

Descripció de la subxarxa

Validations:

  • Must be a String
subnet[network_type]
optional , nil allowed

Tipus de protocol, IPv4 o IPv6, per defecte IPv4

Validations:

  • Must be one of: IPv4, IPv6.
subnet[network]
optional

Xarxa de la subxarxa

Validations:

  • Must be a String
subnet[cidr]
optional , nil allowed

Network prefix in CIDR notation

Validations:

  • Must be a String
subnet[mask]
optional , nil allowed

Màscara de xarxa per aquesta subxarxa

Validations:

  • Must be a String
subnet[gateway]
optional , nil allowed

Subnet gateway

Validations:

  • Must be a String
subnet[dns_primary]
optional , nil allowed

DNS primari per aquesta subxarxa

Validations:

  • Must be a String
subnet[dns_secondary]
optional , nil allowed

DNS secundari per aquesta subxarxa

Validations:

  • Must be a String
subnet[ipam]
optional , nil allowed

IP Address auto suggestion mode for this subnet.

Validations:

  • Must be one of: DHCP, Internal DB, Random DB, EUI-64, External IPAM, None.
subnet[from]
optional , nil allowed

Adreça IP inicial per a l'autosuggestió de la IP

Validations:

  • Must be a String
subnet[to]
optional , nil allowed

Adreça IP final per a l'autosuggestió de la IP

Validations:

  • Must be a String
subnet[vlanid]
optional , nil allowed

ID de VLAN per aquesta subxarxa

Validations:

  • Must be a String
subnet[mtu]
optional , nil allowed

MTU for this subnet

Validations:

  • Must be a Integer
subnet[domain_ids]
optional , nil allowed

Dominis als quals aquesta subxarxa en forma part

Validations:

  • Must be an array of any type
subnet[dhcp_id]
optional , nil allowed

DHCP Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[tftp_id]
optional , nil allowed

TFTP Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[httpboot_id]
optional , nil allowed

HTTPBoot Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[externalipam_id]
optional , nil allowed

External IPAM Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[dns_id]
optional , nil allowed

DNS Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[template_id]
optional , nil allowed

Template HTTP(S) Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[boot_mode]
optional , nil allowed

Default boot mode for interfaces assigned to this subnet.

Validations:

  • Must be one of: Static, DHCP.
subnet[subnet_parameters_attributes]
optional , nil allowed

Seqüència de paràmetres (nom, valor)

Validations:

  • Must be an array of any type
subnet[location_ids]
optional , nil allowed

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type
subnet[organization_ids]
optional , nil allowed

SUBSTITUEIX les organitzacions amb els ID donats.

Validations:

  • Must be an array of any type
>>>

DELETE /api/subnets/:id
Suprimeix una subxarxa

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Identificador numèric de subxarxa

Validations:

  • Must be a number.
>>>

GET /api/subnets/:id/freeip
Provides an unused IP address in this subnet

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
mac
optional

MAC address to reuse the IP for this host

Validations:

  • Must be a String
excluded_ips
optional

IP addresses that should be excluded from suggestion

Validations:

  • Must be an array of any type