GET /api/subnets
Listar as sub-redes

GET /api/domains/:domain_id/subnets
Listar as sub-redes por domínio

GET /api/locations/:location_id/subnets
Listar as sub-redes por localização

GET /api/organizations/:organization_id/subnets
Listar as sub-redes por organização

Parâmentros

Nome parâmetro Descrição
domain_id
opcional

ID para um domínio

Validations:

  • Must be a String

location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

ordenar resultados

Validations:

  • Must be a String

page
opcional

paginar resultados

Validations:

  • Must be a String

per_page
opcional

número de entradas por requisições

Validations:

  • Must be a String


GET /api/subnets/:id
Mostrar uma sub-rede

Parâmentros

Nome parâmetro Descrição
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

Display hidden parameter values

Validations:

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


POST /api/subnets
Criar uma subrete

Parâmentros

Nome parâmetro Descrição
subnet
requerido

Validations:

  • Must be a Hash

subnet[name]
requerido

Nome da subnet

Validations:

  • Must be a String

subnet[description]
opcional , nulo permitido

Subnet description

Validations:

  • Must be a String

subnet[network_type]
opcional , nulo permitido

Tipo ou protocolo, IPv4 ou IPv6, padrão é IPv4

Validations:

  • Must be one of: IPv4, IPv6.

subnet[network]
requerido

Rede de Subrede

Validations:

  • Must be a String

subnet[mask]
requerido

Máscara de rede para esta subrede

Validations:

  • Must be a String

subnet[gateway]
opcional , nulo permitido

DNS primário para essa sub-rede

Validations:

  • Must be a String

subnet[dns_primary]
opcional , nulo permitido

DNS primário para essa sub-rede

Validations:

  • Must be a String

subnet[dns_secondary]
opcional , nulo permitido

DNS secundário para essa sub-rede

Validations:

  • Must be a String

subnet[ipam]
opcional , nulo permitido

Modo de sugestão do endereço IP para esta subrede, valores válidos são “DHCP”, “DB Interno”, “Nenhum”

Validations:

  • Must be a String

subnet[from]
opcional , nulo permitido

Endereço IP inicial para auto sugestão

Validations:

  • Must be a String

subnet[to]
opcional , nulo permitido

Endereço IP final para auto sugestão

Validations:

  • Must be a String

subnet[vlanid]
opcional , nulo permitido

ID da VLAN para essa sub-rede

Validations:

  • Must be a String

subnet[domain_ids]
opcional , nulo permitido

Domínios em que essa subrede faz parte

Validations:

  • Must be an array of any type

subnet[dhcp_id]
opcional , nulo permitido

ID do proxy DHCP a ser usado nesta sub-rede

Validations:

  • Must be a number.

subnet[tftp_id]
opcional , nulo permitido

ID do proxy TFTP a ser usado nesta sub-rede

Validations:

  • Must be a number.

subnet[dns_id]
opcional , nulo permitido

ID do proxy DNS a ser usado nesta sub-rede

Validations:

  • Must be a number.

subnet[boot_mode]
opcional , nulo permitido

Modo de inicialização padrão para interfaces atribuídos a este sub-rede, os valores válidos são “Static”, “DHCP”

Validations:

  • Must be a String

subnet[subnet_parameters_attributes]
opcional , nulo permitido

Array de parâmetros(name, value)

Validations:

  • Must be an array of any type

subnet[location_ids]
opcional , nulo permitido

SUBSTITUIR localizações dadas com ids

Validations:

  • Must be an array of any type

subnet[organization_ids]
opcional , nulo permitido

SUBSTITUIR organizações dadas com ids

Validations:

  • Must be an array of any type


PUT /api/subnets/:id
Atualizar uma sub-rede

Parâmentros

Nome parâmetro Descrição
id
requerido

Identificador numérico da sub-rede

Validations:

  • Must be a number.

subnet
requerido

Validations:

  • Must be a Hash

subnet[name]
opcional

Nome da subnet

Validations:

  • Must be a String

subnet[description]
opcional , nulo permitido

Subnet description

Validations:

  • Must be a String

subnet[network_type]
opcional , nulo permitido

Tipo ou protocolo, IPv4 ou IPv6, padrão é IPv4

Validations:

  • Must be one of: IPv4, IPv6.

subnet[network]
opcional

Rede de Subrede

Validations:

  • Must be a String

subnet[mask]
opcional

Máscara de rede para esta subrede

Validations:

  • Must be a String

subnet[gateway]
opcional , nulo permitido

DNS primário para essa sub-rede

Validations:

  • Must be a String

subnet[dns_primary]
opcional , nulo permitido

DNS primário para essa sub-rede

Validations:

  • Must be a String

subnet[dns_secondary]
opcional , nulo permitido

DNS secundário para essa sub-rede

Validations:

  • Must be a String

subnet[ipam]
opcional , nulo permitido

Modo de sugestão do endereço IP para esta subrede, valores válidos são “DHCP”, “DB Interno”, “Nenhum”

Validations:

  • Must be a String

subnet[from]
opcional , nulo permitido

Endereço IP inicial para auto sugestão

Validations:

  • Must be a String

subnet[to]
opcional , nulo permitido

Endereço IP final para auto sugestão

Validations:

  • Must be a String

subnet[vlanid]
opcional , nulo permitido

ID da VLAN para essa sub-rede

Validations:

  • Must be a String

subnet[domain_ids]
opcional , nulo permitido

Domínios em que essa subrede faz parte

Validations:

  • Must be an array of any type

subnet[dhcp_id]
opcional , nulo permitido

ID do proxy DHCP a ser usado nesta sub-rede

Validations:

  • Must be a number.

subnet[tftp_id]
opcional , nulo permitido

ID do proxy TFTP a ser usado nesta sub-rede

Validations:

  • Must be a number.

subnet[dns_id]
opcional , nulo permitido

ID do proxy DNS a ser usado nesta sub-rede

Validations:

  • Must be a number.

subnet[boot_mode]
opcional , nulo permitido

Modo de inicialização padrão para interfaces atribuídos a este sub-rede, os valores válidos são “Static”, “DHCP”

Validations:

  • Must be a String

subnet[subnet_parameters_attributes]
opcional , nulo permitido

Array de parâmetros(name, value)

Validations:

  • Must be an array of any type

subnet[location_ids]
opcional , nulo permitido

SUBSTITUIR localizações dadas com ids

Validations:

  • Must be an array of any type

subnet[organization_ids]
opcional , nulo permitido

SUBSTITUIR organizações dadas com ids

Validations:

  • Must be an array of any type


DELETE /api/subnets/:id
Apagar uma subrede

Parâmentros

Nome parâmetro Descrição
id
requerido

Identificador numérico da sub-rede

Validations:

  • Must be a number.


GET /api/subnets/:id/freeip
Prove um endereço IP não utilizado nessa subrede

Parâmentros

Nome parâmetro Descrição
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

Endereço MAC para reutilização do IP para este host

Validations:

  • Must be a String

excluded_ips
opcional

Endereços IP que devem ser excluídos da sugestão

Validations:

  • Must be an array of any type