Subnets

>>>

GET /api/subnets
Lista de subredes

GET /api/domains/:domain_id/subnets
Listarr subredes para un dominio

GET /api/locations/:location_id/subnets
Lista de subredes por ubicación

GET /api/organizations/:organization_id/subnets
Lista de subredes por organización

Parámetros

Nombre del parámetro Descripción
domain_id
opcional

ID del dominio

Validations:

  • Must be a String
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer
organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer
search
opcional

filtrar resultados

Validations:

  • Must be a String
order
opcional

Orden y campo de clasificación, p. ej., 'id DESC'

Validations:

  • Must be a String
page
opcional

Número de página, comenzando por 1

Validations:

  • Must be a number.
per_page
opcional

Número de resultados por página para devolver

Validations:

  • Must be a number.

Campos de búsqueda

Nombre del campo Tipo Valores posibles
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
Mostrar una subred

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
requerido

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
opcional

Mostrar valores de parámetros ocultos

Validations:

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

POST /api/subnets
Crear una subred

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer
subnet
requerido

Validations:

  • Must be a Hash
subnet[name]
requerido

Nombre de subred

Validations:

  • Must be a String
subnet[description]
opcional , nil permitido

Descripción de subred

Validations:

  • Must be a String
subnet[network_type]
opcional , nil permitido

Tipo o protocolo, IPv4 o IPv6, se predetermina en IPv4

Validations:

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

Red de subred

Validations:

  • Must be a String
subnet[cidr]
opcional , nil permitido

Network prefix in CIDR notation

Validations:

  • Must be a String
subnet[mask]
opcional , nil permitido

Máscara para esta subred

Validations:

  • Must be a String
subnet[gateway]
opcional , nil permitido

Gateway de subred

Validations:

  • Must be a String
subnet[dns_primary]
opcional , nil permitido

DNS primaria para esta subred

Validations:

  • Must be a String
subnet[dns_secondary]
opcional , nil permitido

DNS secundaria para esta subred

Validations:

  • Must be a String
subnet[ipam]
opcional , nil permitido

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]
opcional , nil permitido

Dirección IP de inicio para autosugerencia de IP

Validations:

  • Must be a String
subnet[to]
opcional , nil permitido

Dirección IP final para sugerencias

Validations:

  • Must be a String
subnet[vlanid]
opcional , nil permitido

ID de VLAN para esta subred

Validations:

  • Must be a String
subnet[mtu]
opcional , nil permitido

MTU de esta subred

Validations:

  • Must be a Integer
subnet[domain_ids]
opcional , nil permitido

Dominios a los que pertenece esta subred

Validations:

  • Must be an array of any type
subnet[dhcp_id]
opcional , nil permitido

ID de proxy DHCP para usar con esta subred

Validations:

  • Must be a number.
subnet[tftp_id]
opcional , nil permitido

ID de proxy TFTP para usar con esta subred

Validations:

  • Must be a number.
subnet[httpboot_id]
opcional , nil permitido

ID de Proxy HTTPBoot para usar dentro de esta subred

Validations:

  • Must be a number.
subnet[externalipam_id]
opcional , nil permitido

External IPAM Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[dns_id]
opcional , nil permitido

ID de proxy DNS para usar con esta subred

Validations:

  • Must be a number.
subnet[template_id]
opcional , nil permitido

ID de proxy HTTP(S) de plantilla para utilizar dentro de esta subred

Validations:

  • Must be a number.
subnet[boot_mode]
opcional , nil permitido

Default boot mode for interfaces assigned to this subnet.

Validations:

  • Must be one of: Static, DHCP.
subnet[subnet_parameters_attributes]
opcional , nil permitido

Array de parámetros (nombre, valor)

Validations:

  • Must be an array of any type
subnet[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type
subnet[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type
>>>

PUT /api/subnets/:id
Actualizar una subred

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
requerido

Identificador numérico de subred

Validations:

  • Must be a number.
subnet
requerido

Validations:

  • Must be a Hash
subnet[name]
opcional

Nombre de subred

Validations:

  • Must be a String
subnet[description]
opcional , nil permitido

Descripción de subred

Validations:

  • Must be a String
subnet[network_type]
opcional , nil permitido

Tipo o protocolo, IPv4 o IPv6, se predetermina en IPv4

Validations:

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

Red de subred

Validations:

  • Must be a String
subnet[cidr]
opcional , nil permitido

Network prefix in CIDR notation

Validations:

  • Must be a String
subnet[mask]
opcional , nil permitido

Máscara para esta subred

Validations:

  • Must be a String
subnet[gateway]
opcional , nil permitido

Gateway de subred

Validations:

  • Must be a String
subnet[dns_primary]
opcional , nil permitido

DNS primaria para esta subred

Validations:

  • Must be a String
subnet[dns_secondary]
opcional , nil permitido

DNS secundaria para esta subred

Validations:

  • Must be a String
subnet[ipam]
opcional , nil permitido

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]
opcional , nil permitido

Dirección IP de inicio para autosugerencia de IP

Validations:

  • Must be a String
subnet[to]
opcional , nil permitido

Dirección IP final para sugerencias

Validations:

  • Must be a String
subnet[vlanid]
opcional , nil permitido

ID de VLAN para esta subred

Validations:

  • Must be a String
subnet[mtu]
opcional , nil permitido

MTU de esta subred

Validations:

  • Must be a Integer
subnet[domain_ids]
opcional , nil permitido

Dominios a los que pertenece esta subred

Validations:

  • Must be an array of any type
subnet[dhcp_id]
opcional , nil permitido

ID de proxy DHCP para usar con esta subred

Validations:

  • Must be a number.
subnet[tftp_id]
opcional , nil permitido

ID de proxy TFTP para usar con esta subred

Validations:

  • Must be a number.
subnet[httpboot_id]
opcional , nil permitido

ID de Proxy HTTPBoot para usar dentro de esta subred

Validations:

  • Must be a number.
subnet[externalipam_id]
opcional , nil permitido

External IPAM Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[dns_id]
opcional , nil permitido

ID de proxy DNS para usar con esta subred

Validations:

  • Must be a number.
subnet[template_id]
opcional , nil permitido

ID de proxy HTTP(S) de plantilla para utilizar dentro de esta subred

Validations:

  • Must be a number.
subnet[boot_mode]
opcional , nil permitido

Default boot mode for interfaces assigned to this subnet.

Validations:

  • Must be one of: Static, DHCP.
subnet[subnet_parameters_attributes]
opcional , nil permitido

Array de parámetros (nombre, valor)

Validations:

  • Must be an array of any type
subnet[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type
subnet[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type
>>>

DELETE /api/subnets/:id
Borrar una subred

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
requerido

Identificador numérico de subred

Validations:

  • Must be a number.
>>>

GET /api/subnets/:id/freeip
Proporciona una dirección IP no utilizada en esta subred

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
requerido

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
opcional

Dirección MAC para reutilizar la IP de este host

Validations:

  • Must be a String
excluded_ips
opcional

Direcciones IP que deben excluirse de la sugerencia

Validations:

  • Must be an array of any type