Subnets

>>>

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

Feld und Reihenfolge sortieren, z.B. 'id DESC'

Validations:

  • Must be a String
page
optional

Seitennummer, beginnend bei 1

Validations:

  • Must be a number.
per_page
optional

Anzahl der angezeigten Ergebnisse pro Seite

Validations:

  • Must be a number.

Suchfelder

Feld Name Typ Mögliche Werte
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
Subnetz anzeigen

Parameter

Parametername Beschreibung
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
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

Versteckte Parameter Werte anzeigen

Validations:

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

POST /api/subnets
Subnetz erstellen

Parameter

Parametername Beschreibung
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
verpflichtend

Validations:

  • Must be a Hash
subnet[name]
verpflichtend

Subnetzname

Validations:

  • Must be a String
subnet[description]
optional , nil erlaubt

Subnetz Beschreibung

Validations:

  • Must be a String
subnet[network_type]
optional , nil erlaubt

Typ oder Protokoll: IPv4 oder IPv6, Standardwert ist IPv4

Validations:

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

Subnetznetzwerk

Validations:

  • Must be a String
subnet[cidr]
optional , nil erlaubt

Network prefix in CIDR notation

Validations:

  • Must be a String
subnet[mask]
optional , nil erlaubt

Netzmaske für dieses Subnetz

Validations:

  • Must be a String
subnet[gateway]
optional , nil erlaubt

Subnetz Gateway

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

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 , 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[mtu]
optional , nil erlaubt

MTU für dieses Subnetz

Validations:

  • Must be a Integer
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 Kennung zur Verwendung in diesem Subnetz

Validations:

  • Must be a number.
subnet[tftp_id]
optional , nil erlaubt

TFTP-Proxy Kennung zur Verwendung in diesem Subnetz

Validations:

  • Must be a number.
subnet[httpboot_id]
optional , nil erlaubt

HTTPBoot-Proxy Kennung zur Verwendung in diesem Subnetz

Validations:

  • Must be a number.
subnet[externalipam_id]
optional , nil erlaubt

External IPAM Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[dns_id]
optional , nil erlaubt

DNS-Proxy Kennung zur Verwendung in diesem Subnetz

Validations:

  • Must be a number.
subnet[template_id]
optional , nil erlaubt

Vorlagen HTTP(S) Proxy Kennung zur Verwendung in diesem Subnetz

Validations:

  • Must be a number.
subnet[boot_mode]
optional , nil erlaubt

Default boot mode for interfaces assigned to this subnet.

Validations:

  • Must be one of: Static, DHCP.
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
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
Subnet aktualisieren

Parameter

Parametername Beschreibung
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
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

Subnetz Beschreibung

Validations:

  • Must be a String
subnet[network_type]
optional , nil erlaubt

Typ oder Protokoll: IPv4 oder IPv6, Standardwert ist IPv4

Validations:

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

Subnetznetzwerk

Validations:

  • Must be a String
subnet[cidr]
optional , nil erlaubt

Network prefix in CIDR notation

Validations:

  • Must be a String
subnet[mask]
optional , nil erlaubt

Netzmaske für dieses Subnetz

Validations:

  • Must be a String
subnet[gateway]
optional , nil erlaubt

Subnetz Gateway

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

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 , 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[mtu]
optional , nil erlaubt

MTU für dieses Subnetz

Validations:

  • Must be a Integer
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 Kennung zur Verwendung in diesem Subnetz

Validations:

  • Must be a number.
subnet[tftp_id]
optional , nil erlaubt

TFTP-Proxy Kennung zur Verwendung in diesem Subnetz

Validations:

  • Must be a number.
subnet[httpboot_id]
optional , nil erlaubt

HTTPBoot-Proxy Kennung zur Verwendung in diesem Subnetz

Validations:

  • Must be a number.
subnet[externalipam_id]
optional , nil erlaubt

External IPAM Proxy ID to use within this subnet

Validations:

  • Must be a number.
subnet[dns_id]
optional , nil erlaubt

DNS-Proxy Kennung zur Verwendung in diesem Subnetz

Validations:

  • Must be a number.
subnet[template_id]
optional , nil erlaubt

Vorlagen HTTP(S) Proxy Kennung zur Verwendung in diesem Subnetz

Validations:

  • Must be a number.
subnet[boot_mode]
optional , nil erlaubt

Default boot mode for interfaces assigned to this subnet.

Validations:

  • Must be one of: Static, DHCP.
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
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
Subnetz löschen

Parameter

Parametername Beschreibung
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
verpflichtend

Numerische Subnetzkennung

Validations:

  • Must be a number.
>>>

GET /api/subnets/:id/freeip
Stellt eine ungenutzte IP-Adresse für dieses Subnetz bereit

Parameter

Parametername Beschreibung
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
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-Adresse zur Wiederverwendung der IP dieses Host

Validations:

  • Must be a String
excluded_ips
optional

IP-Adressen die nicht vorgeschlagen werden sollen

Validations:

  • Must be an array of any type