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. del domini

Validations:

  • Must be String

location_id
Optional

Abast per ubicacions

Validations:

  • Must be Integer

organization_id
Optional

Abast per organitzacions

Validations:

  • Must be Integer

search
Optional

filtra els resultats

Validations:

  • Must be String

order
Optional

ordena els resultats

Validations:

  • Must be String

page
Optional

pagina els resultats

Validations:

  • Must be String

per_page
Optional

Nombre d'entrades per petició

Validations:

  • Must be String


GET /api/subnets/:id
Mostra una subxarxa

Params

Param Name Description
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

Display hidden parameter values

Validations:

  • Must be 'true' or 'false' or '1' or '0'


POST /api/subnets
Crea una subxarxa

Params

Param Name Description
subnet
Required

Validations:

  • Must be a Hash

subnet[name]
Required

Nom de la subxarxa

Validations:

  • Must be String

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

Type or protocol, IPv4 or IPv6, defaults to IPv4

Validations:

  • Must be one of: IPv4, IPv6.

subnet[network]
Required

Subnet network

Validations:

  • Must be String

subnet[mask]
Required

Màscara de xarxa per a aquesta subxarxa

Validations:

  • Must be String

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

DNS primari per a aquesta subxarxa

Validations:

  • Must be String

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

DNS primari per a aquesta subxarxa

Validations:

  • Must be String

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

DNS secundari per a aquesta subxarxa

Validations:

  • Must be 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 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 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 String

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

ID de la VLAN per a aquesta subxarxa

Validations:

  • Must be String

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[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[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 String

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

Array of parameters (name, value)

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
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 String

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

Type or protocol, IPv4 or IPv6, defaults to IPv4

Validations:

  • Must be one of: IPv4, IPv6.

subnet[network]
Optional

Subnet network

Validations:

  • Must be String

subnet[mask]
Optional

Màscara de xarxa per a aquesta subxarxa

Validations:

  • Must be String

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

DNS primari per a aquesta subxarxa

Validations:

  • Must be String

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

DNS primari per a aquesta subxarxa

Validations:

  • Must be String

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

DNS secundari per a aquesta subxarxa

Validations:

  • Must be 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 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 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 String

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

ID de la VLAN per a aquesta subxarxa

Validations:

  • Must be String

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[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[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 String

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

Array of parameters (name, value)

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
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
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 String

excluded_ips
Optional

IP addresses that should be excluded from suggestion

Validations:

  • Must be an array of any type