Subnets

>>>

GET /api/subnets
Seznam podsítí

GET /api/domains/:domain_id/subnets
List of subnets for a domain

GET /api/locations/:location_id/subnets
List of subnets per location

GET /api/organizations/:organization_id/subnets
List of subnets per organization

Params

Param Name Description
domain_id
Optional

Identifikátor domény

Validations:

  • Must be a String
location_id
Optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
Optional

Scope by organizations

Validations:

  • Must be a Integer
search
Optional

výsledky filtru

Validations:

  • Must be a String
order
Optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
Optional

Číslo stránky, začíná od jedničky

Validations:

  • Must be a number.
per_page
Optional

Počet výsledků na stránku

Validations:

  • Must be a number.

Search fields

Název kolonky Typ Možné hodnoty
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
Zobrazit podsíť

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

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

Zobrazit hodnoty skrytého parametru

Validations:

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

POST /api/subnets
Vytvořit podsíť

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
subnet
Required

Validations:

  • Must be a Hash
subnet[name]
Required

Název podsítě

Validations:

  • Must be a String
subnet[description]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Popis podsítě

Validations:

  • Must be a String
subnet[network_type]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.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 a String
subnet[cidr]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Network prefix in CIDR notation

Validations:

  • Must be a String
subnet[mask]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Maska pro tuto podsíť

Validations:

  • Must be a String
subnet[gateway]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Subnet gateway

Validations:

  • Must be a String
subnet[dns_primary]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Hlavní DNS pro tuto podsíť

Validations:

  • Must be a String
subnet[dns_secondary]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Záložní DNS pro tuto podsíť

Validations:

  • Must be a String
subnet[ipam]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

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

Počáteční IP adresa pro automatické doporučování IP adres

Validations:

  • Must be a String
subnet[to]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Koncová IP adresa pro automatické doporučování IP adres

Validations:

  • Must be a String
subnet[vlanid]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

VLAN ID for this subnet

Validations:

  • Must be a String
subnet[mtu]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.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: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Domény kterých je tato podsíť součástí

Validations:

  • Must be an array of any type
subnet[dhcp_id]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.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: cs-CZ.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: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

HTTPBoot Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[externalipam_id]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

External IPAM Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[dns_id]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.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: cs-CZ.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: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Výchozí režim zavádění ze sítě pro rozhraní, přiřazená do této podsítě.

Validations:

  • Must be one of: Static, DHCP.
subnet[subnet_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Pole parametrů (název, hodnota)

Validations:

  • Must be an array of any type
subnet[location_ids]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

REPLACE locations with given ids

Validations:

  • Must be an array of any type
subnet[organization_ids]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
subnet[remote_execution_proxy_ids]
Optional

List of proxy IDs to be used for remote execution

Validations:

  • Must be an array of any type
>>>

PUT /api/subnets/:id
Aktualizovat podsíť

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Číselný identifikátor podsítě

Validations:

  • Must be a number.
subnet
Required

Validations:

  • Must be a Hash
subnet[name]
Optional

Název podsítě

Validations:

  • Must be a String
subnet[description]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Popis podsítě

Validations:

  • Must be a String
subnet[network_type]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.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 a String
subnet[cidr]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Network prefix in CIDR notation

Validations:

  • Must be a String
subnet[mask]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Maska pro tuto podsíť

Validations:

  • Must be a String
subnet[gateway]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Subnet gateway

Validations:

  • Must be a String
subnet[dns_primary]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Hlavní DNS pro tuto podsíť

Validations:

  • Must be a String
subnet[dns_secondary]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Záložní DNS pro tuto podsíť

Validations:

  • Must be a String
subnet[ipam]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

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

Počáteční IP adresa pro automatické doporučování IP adres

Validations:

  • Must be a String
subnet[to]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Koncová IP adresa pro automatické doporučování IP adres

Validations:

  • Must be a String
subnet[vlanid]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

VLAN ID for this subnet

Validations:

  • Must be a String
subnet[mtu]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.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: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Domény kterých je tato podsíť součástí

Validations:

  • Must be an array of any type
subnet[dhcp_id]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.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: cs-CZ.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: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

HTTPBoot Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[externalipam_id]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

External IPAM Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[dns_id]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.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: cs-CZ.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: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Výchozí režim zavádění ze sítě pro rozhraní, přiřazená do této podsítě.

Validations:

  • Must be one of: Static, DHCP.
subnet[subnet_parameters_attributes]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

Pole parametrů (název, hodnota)

Validations:

  • Must be an array of any type
subnet[location_ids]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

REPLACE locations with given ids

Validations:

  • Must be an array of any type
subnet[organization_ids]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type
subnet[remote_execution_proxy_ids]
Optional

List of proxy IDs to be used for remote execution

Validations:

  • Must be an array of any type
>>>

DELETE /api/subnets/:id
Smazat podsíť

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
Required

Číselný identifikátor podsítě

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

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
Optional

Set the current organization context for the request

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