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

pagina els resultats

Validations:

  • Must be a String

per_page
Optional

Nombre d'entrades per petició

Validations:

  • Must be a String

Search fields

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

GET /api/subnets/:id
Mostra una subxarxa

Params

Param Name Description
location_id
Optional

Abast per ubicacions

Validations:

  • Must be a Integer

organization_id
Optional

Abast per organitzacions

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

Abast per ubicacions

Validations:

  • Must be a Integer

organization_id
Optional

Abast per organitzacions

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Descripció de la subxarxa

Validations:

  • Must be a String

subnet[network_type]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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[mask]
Required

Màscara de xarxa per aquesta subxarxa

Validations:

  • Must be a String

subnet[gateway]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Subnet gateway

Validations:

  • Must be a String

subnet[dns_primary]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

DNS primari per aquesta subxarxa

Validations:

  • Must be a String

subnet[dns_secondary]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

DNS secundari per aquesta subxarxa

Validations:

  • Must be a String

subnet[ipam]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

IP Address auto suggestion mode for this subnet, valid values are “DHCP”, “Internal DB”, “None”

Validations:

  • Must be a String

subnet[from]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a String

subnet[to]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a String

subnet[vlanid]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de VLAN per aquesta subxarxa

Validations:

  • Must be a String

subnet[mtu]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

MTU for this subnet

Validations:

  • Must be a Integer

subnet[domain_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Dominis als quals aquesta subxarxa en forma part

Validations:

  • Must be an array of any type

subnet[dhcp_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

DHCP Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[tftp_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

TFTP Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[httpboot_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

HTTPBoot Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[dns_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

DNS Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[template_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a number.

subnet[boot_mode]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Mode d'arrencada per defecte per a les interfícies assignades a aquesta subxarxa, els valors vàlids són «Static» i «DHCP»

Validations:

  • Must be a String

subnet[subnet_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be an array of any type

subnet[location_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type

subnet[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Abast per ubicacions

Validations:

  • Must be a Integer

organization_id
Optional

Abast per organitzacions

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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Descripció de la subxarxa

Validations:

  • Must be a String

subnet[network_type]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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[mask]
Optional

Màscara de xarxa per aquesta subxarxa

Validations:

  • Must be a String

subnet[gateway]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Subnet gateway

Validations:

  • Must be a String

subnet[dns_primary]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

DNS primari per aquesta subxarxa

Validations:

  • Must be a String

subnet[dns_secondary]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

DNS secundari per aquesta subxarxa

Validations:

  • Must be a String

subnet[ipam]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

IP Address auto suggestion mode for this subnet, valid values are “DHCP”, “Internal DB”, “None”

Validations:

  • Must be a String

subnet[from]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a String

subnet[to]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a String

subnet[vlanid]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

ID de VLAN per aquesta subxarxa

Validations:

  • Must be a String

subnet[mtu]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

MTU for this subnet

Validations:

  • Must be a Integer

subnet[domain_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Dominis als quals aquesta subxarxa en forma part

Validations:

  • Must be an array of any type

subnet[dhcp_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

DHCP Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[tftp_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

TFTP Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[httpboot_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

HTTPBoot Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[dns_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

DNS Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[template_id]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be a number.

subnet[boot_mode]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

Mode d'arrencada per defecte per a les interfícies assignades a aquesta subxarxa, els valors vàlids són «Static» i «DHCP»

Validations:

  • Must be a String

subnet[subnet_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be an array of any type

subnet[location_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

SUBSTITUEIX les ubicacions amb els ID donats

Validations:

  • Must be an array of any type

subnet[organization_ids]
Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>

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

Abast per ubicacions

Validations:

  • Must be a Integer

organization_id
Optional

Abast per organitzacions

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

Abast per ubicacions

Validations:

  • Must be a Integer

organization_id
Optional

Abast per organitzacions

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