Subnets

>>>

GET /api/subnets
Lista podsieci

GET /api/domains/:domain_id/subnets
Lista podsieci dla domeny

GET /api/locations/:location_id/subnets
Lista podsieci w danej lokalizacji

GET /api/organizations/:organization_id/subnets
Lista podsieci na organizację

Parametry

Nazwa parametru Opis
domain_id
opcjonalny

Identyfikator kategorii

Validations:

  • Must be a String
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer
organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer
search
opcjonalny

rezultat filtrowania

Validations:

  • Must be a String
order
opcjonalny

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
opcjonalny

Page number, starting at 1

Validations:

  • Must be a number.
per_page
opcjonalny

Number of results per page to return

Validations:

  • Must be a number.

Search fields

Field name Typ 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
Pokaż podsieć

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
id
wymagany

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
opcjonalny

Display hidden parameter values

Validations:

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

POST /api/subnets
Tworzenie podsieci

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
subnet
wymagany

Validations:

  • Must be a Hash
subnet[name]
wymagany

Nazwa podsieci

Validations:

  • Must be a String
subnet[description]
opcjonalny , nil dopuszczalny

Subnet description

Validations:

  • Must be a String
subnet[network_type]
opcjonalny , nil dopuszczalny

Type or protocol, IPv4 or IPv6, defaults to IPv4

Validations:

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

sieć podsieci

Validations:

  • Must be a String
subnet[cidr]
opcjonalny , nil dopuszczalny

Network prefix in CIDR notation

Validations:

  • Must be a String
subnet[mask]
opcjonalny , nil dopuszczalny

Maska dla tej podsieci

Validations:

  • Must be a String
subnet[gateway]
opcjonalny , nil dopuszczalny

Subnet gateway

Validations:

  • Must be a String
subnet[dns_primary]
opcjonalny , nil dopuszczalny

Primary DNS dla danej podsieci

Validations:

  • Must be a String
subnet[dns_secondary]
opcjonalny , nil dopuszczalny

Secondary DNS dla danej podsieci

Validations:

  • Must be a String
subnet[ipam]
opcjonalny , nil dopuszczalny

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]
opcjonalny , nil dopuszczalny

Początkowy adres IP dla autosugestii IP

Validations:

  • Must be a String
subnet[to]
opcjonalny , nil dopuszczalny

Końcowy adres IP dla autosugestii IP

Validations:

  • Must be a String
subnet[vlanid]
opcjonalny , nil dopuszczalny

VLAN ID dla tej podsieci

Validations:

  • Must be a String
subnet[mtu]
opcjonalny , nil dopuszczalny

MTU for this subnet

Validations:

  • Must be a Integer
subnet[domain_ids]
opcjonalny , nil dopuszczalny

Dziedziny, w których ta podsieć jest częścią

Validations:

  • Must be an array of any type
subnet[dhcp_id]
opcjonalny , nil dopuszczalny

DHCP Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[tftp_id]
opcjonalny , nil dopuszczalny

TFTP Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[httpboot_id]
opcjonalny , nil dopuszczalny

HTTPBoot Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[externalipam_id]
opcjonalny , nil dopuszczalny

External IPAM Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[dns_id]
opcjonalny , nil dopuszczalny

DNS Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[template_id]
opcjonalny , nil dopuszczalny

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

Validations:

  • Must be a number.
subnet[boot_mode]
opcjonalny , nil dopuszczalny

Default boot mode for interfaces assigned to this subnet.

Validations:

  • Must be one of: Static, DHCP.
subnet[subnet_parameters_attributes]
opcjonalny , nil dopuszczalny

Tablica parametrów (name, value)

Validations:

  • Must be an array of any type
subnet[location_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ lokalizacje o podanym id

Validations:

  • Must be an array of any type
subnet[organization_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ organizacje o podanym id

Validations:

  • Must be an array of any type
>>>

PUT /api/subnets/:id
Aktualizacja podsieci

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
id
wymagany

Numeryczny identyfikator podsieci

Validations:

  • Must be a number.
subnet
wymagany

Validations:

  • Must be a Hash
subnet[name]
opcjonalny

Nazwa podsieci

Validations:

  • Must be a String
subnet[description]
opcjonalny , nil dopuszczalny

Subnet description

Validations:

  • Must be a String
subnet[network_type]
opcjonalny , nil dopuszczalny

Type or protocol, IPv4 or IPv6, defaults to IPv4

Validations:

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

sieć podsieci

Validations:

  • Must be a String
subnet[cidr]
opcjonalny , nil dopuszczalny

Network prefix in CIDR notation

Validations:

  • Must be a String
subnet[mask]
opcjonalny , nil dopuszczalny

Maska dla tej podsieci

Validations:

  • Must be a String
subnet[gateway]
opcjonalny , nil dopuszczalny

Subnet gateway

Validations:

  • Must be a String
subnet[dns_primary]
opcjonalny , nil dopuszczalny

Primary DNS dla danej podsieci

Validations:

  • Must be a String
subnet[dns_secondary]
opcjonalny , nil dopuszczalny

Secondary DNS dla danej podsieci

Validations:

  • Must be a String
subnet[ipam]
opcjonalny , nil dopuszczalny

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]
opcjonalny , nil dopuszczalny

Początkowy adres IP dla autosugestii IP

Validations:

  • Must be a String
subnet[to]
opcjonalny , nil dopuszczalny

Końcowy adres IP dla autosugestii IP

Validations:

  • Must be a String
subnet[vlanid]
opcjonalny , nil dopuszczalny

VLAN ID dla tej podsieci

Validations:

  • Must be a String
subnet[mtu]
opcjonalny , nil dopuszczalny

MTU for this subnet

Validations:

  • Must be a Integer
subnet[domain_ids]
opcjonalny , nil dopuszczalny

Dziedziny, w których ta podsieć jest częścią

Validations:

  • Must be an array of any type
subnet[dhcp_id]
opcjonalny , nil dopuszczalny

DHCP Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[tftp_id]
opcjonalny , nil dopuszczalny

TFTP Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[httpboot_id]
opcjonalny , nil dopuszczalny

HTTPBoot Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[externalipam_id]
opcjonalny , nil dopuszczalny

External IPAM Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[dns_id]
opcjonalny , nil dopuszczalny

DNS Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[template_id]
opcjonalny , nil dopuszczalny

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

Validations:

  • Must be a number.
subnet[boot_mode]
opcjonalny , nil dopuszczalny

Default boot mode for interfaces assigned to this subnet.

Validations:

  • Must be one of: Static, DHCP.
subnet[subnet_parameters_attributes]
opcjonalny , nil dopuszczalny

Tablica parametrów (name, value)

Validations:

  • Must be an array of any type
subnet[location_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ lokalizacje o podanym id

Validations:

  • Must be an array of any type
subnet[organization_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ organizacje o podanym id

Validations:

  • Must be an array of any type
>>>

DELETE /api/subnets/:id
Usuń podsieć

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
id
wymagany

Numeryczny identyfikator podsieci

Validations:

  • Must be a number.
>>>

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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer
id
wymagany

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
opcjonalny

MAC address to reuse the IP for this host

Validations:

  • Must be a String
excluded_ips
opcjonalny

IP addresses that should be excluded from suggestion

Validations:

  • Must be an array of any type