GET /api/subnets
Liste von Subnetzen

GET /api/domains/:domain_id/subnets
Liste von Subnetzen für eine Domäne

GET /api/locations/:location_id/subnets
Liste von Subnetzen pro Standort

GET /api/organizations/:organization_id/subnets
Liste von Subnetzen pro Organisation

Parameter

Parametername Beschreibung
domain_id
optional

Kennung der Domäne

Validations:

  • Must be a String

location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

search
optional

Ergebnisse filtern

Validations:

  • Must be a String

order
optional

Ergebnisse sortieren

Validations:

  • Must be a String

page
optional

Ergebnisse nummerieren

Validations:

  • Must be a String

per_page
optional

Anzahl der Einträge pro Anfrage

Validations:

  • Must be a String


GET /api/subnets/:id
Subnetz anzeigen

Parameter

Parametername Beschreibung
id
verpflichtend

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 one of: true, false, 1, 0


POST /api/subnets
Subnetz erstellen

Parameter

Parametername Beschreibung
subnet
verpflichtend

Validations:

  • Must be a Hash

subnet[name]
verpflichtend

Subnetzname

Validations:

  • Must be a String

subnet[description]
optional , nil erlaubt

Subnet description

Validations:

  • Must be a String

subnet[network_type]
optional , nil erlaubt

Protokollversion: IPv4 oder IPv6; Standardwert IPv4

Validations:

  • Must be one of: IPv4, IPv6.

subnet[network]
verpflichtend

Subnetznetzwerk

Validations:

  • Must be a String

subnet[mask]
verpflichtend

Netzmaske für dieses Subnetz

Validations:

  • Must be a String

subnet[gateway]
optional , nil erlaubt

Primärer DNS für dieses Subnetz

Validations:

  • Must be a String

subnet[dns_primary]
optional , nil erlaubt

Primärer DNS für dieses Subnetz

Validations:

  • Must be a String

subnet[dns_secondary]
optional , nil erlaubt

Sekundärer DNS für dieses Subnetz

Validations:

  • Must be a String

subnet[ipam]
optional , nil erlaubt

automatischer IP-Adress-Vorschlagsmodus für dieses Subnetz, gültige Werte sind “DHCP”, “Interne DB”, “Keine”

Validations:

  • Must be a String

subnet[from]
optional , nil erlaubt

Beginnende IP-Adresse für automatischen IP-Vorschlag

Validations:

  • Must be a String

subnet[to]
optional , nil erlaubt

Abschließende IP-Adresse für automatischen IP-Vorschlag

Validations:

  • Must be a String

subnet[vlanid]
optional , nil erlaubt

VLAN-Kennung für dieses Subnetz

Validations:

  • Must be a String

subnet[domain_ids]
optional , nil erlaubt

Domänen, denen dieses Subnetz angehört

Validations:

  • Must be an array of any type

subnet[dhcp_id]
optional , nil erlaubt

DHCP Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[tftp_id]
optional , nil erlaubt

TFTP Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[dns_id]
optional , nil erlaubt

DNS Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[boot_mode]
optional , nil erlaubt

Standard-Boot-Modus für Schnittstellen die diesem Subnetz zugewiesen sind, gültige Werte sind “Statisch”, “DHCP”

Validations:

  • Must be a String

subnet[subnet_parameters_attributes]
optional , nil erlaubt

Abfolge von Parametern (name, value)

Validations:

  • Must be an array of any type

subnet[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

subnet[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


PUT /api/subnets/:id
Subnet aktualisieren

Parameter

Parametername Beschreibung
id
verpflichtend

Numerische Subnetzkennung

Validations:

  • Must be a number.

subnet
verpflichtend

Validations:

  • Must be a Hash

subnet[name]
optional

Subnetzname

Validations:

  • Must be a String

subnet[description]
optional , nil erlaubt

Subnet description

Validations:

  • Must be a String

subnet[network_type]
optional , nil erlaubt

Protokollversion: IPv4 oder IPv6; Standardwert IPv4

Validations:

  • Must be one of: IPv4, IPv6.

subnet[network]
optional

Subnetznetzwerk

Validations:

  • Must be a String

subnet[mask]
optional

Netzmaske für dieses Subnetz

Validations:

  • Must be a String

subnet[gateway]
optional , nil erlaubt

Primärer DNS für dieses Subnetz

Validations:

  • Must be a String

subnet[dns_primary]
optional , nil erlaubt

Primärer DNS für dieses Subnetz

Validations:

  • Must be a String

subnet[dns_secondary]
optional , nil erlaubt

Sekundärer DNS für dieses Subnetz

Validations:

  • Must be a String

subnet[ipam]
optional , nil erlaubt

automatischer IP-Adress-Vorschlagsmodus für dieses Subnetz, gültige Werte sind “DHCP”, “Interne DB”, “Keine”

Validations:

  • Must be a String

subnet[from]
optional , nil erlaubt

Beginnende IP-Adresse für automatischen IP-Vorschlag

Validations:

  • Must be a String

subnet[to]
optional , nil erlaubt

Abschließende IP-Adresse für automatischen IP-Vorschlag

Validations:

  • Must be a String

subnet[vlanid]
optional , nil erlaubt

VLAN-Kennung für dieses Subnetz

Validations:

  • Must be a String

subnet[domain_ids]
optional , nil erlaubt

Domänen, denen dieses Subnetz angehört

Validations:

  • Must be an array of any type

subnet[dhcp_id]
optional , nil erlaubt

DHCP Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[tftp_id]
optional , nil erlaubt

TFTP Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[dns_id]
optional , nil erlaubt

DNS Proxy ID to use within this subnet

Validations:

  • Must be a number.

subnet[boot_mode]
optional , nil erlaubt

Standard-Boot-Modus für Schnittstellen die diesem Subnetz zugewiesen sind, gültige Werte sind “Statisch”, “DHCP”

Validations:

  • Must be a String

subnet[subnet_parameters_attributes]
optional , nil erlaubt

Abfolge von Parametern (name, value)

Validations:

  • Must be an array of any type

subnet[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

subnet[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


DELETE /api/subnets/:id
Subnetz löschen

Parameter

Parametername Beschreibung
id
verpflichtend

Numerische Subnetzkennung

Validations:

  • Must be a number.


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

Parameter

Parametername Beschreibung
id
verpflichtend

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-Adressen, die nicht vorgeschlagen werden sollen

Validations:

  • Must be an array of any type