Subnets

>>>

GET /api/subnets
Liste des sous-réseaux

GET /api/domains/:domain_id/subnets
Liste des sous-réseaux d'un domaine

GET /api/locations/:location_id/subnets
Liste des sous-réseaux par emplacement

GET /api/organizations/:organization_id/subnets
Liste des sous-réseaux par organisation

Paramètres

Nom du paramètre Description
domain_id
optionel

ID du domaine

Validations:

  • Must be a String
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer
organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer
search
optionel

filtrer les résultats

Validations:

  • Must be a String
order
optionel

Champ et sens de tri, ex: 'id DESC'

Validations:

  • Must be a String
page
optionel

Numéro de la page, commençant par 1

Validations:

  • Must be a number.
per_page
optionel

Nombre de résultats par page à renvoyer

Validations:

  • Must be a number.

Rechercher les champs

Nom du champ Type Valeurs possibles
boot_mode string
dns_primary string
dns_secondary string
domain string
gateway string
ipam string
location string
location_id integer
mask string
mtu integer
name text
network string
nic_delay integer
organization string
organization_id integer
params text
type string
vlanid integer
>>>

GET /api/subnets/:id
Afficher un sous-réseau

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer
id
requis

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
optionel

Afficher les valeurs de paramètre masquées

Validations:

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

POST /api/subnets
Créer un sous-réseau

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer
subnet
requis

Validations:

  • Must be a Hash
subnet[name]
requis

Nom du sous-réseau

Validations:

  • Must be a String
subnet[description]
optionel , nil autorisé

Description du sous-réseau

Validations:

  • Must be a String
subnet[network_type]
optionel , nil autorisé

Type ou protocole, IPv4 ou IPv6, par défaut IPv4

Validations:

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

Réseau du sous-réseau

Validations:

  • Must be a String
subnet[mask]
requis

masque de sous-réseau

Validations:

  • Must be a String
subnet[gateway]
optionel , nil autorisé

Passerelle du sous réseau

Validations:

  • Must be a String
subnet[dns_primary]
optionel , nil autorisé

DNS primaire pour ce sous-réseau

Validations:

  • Must be a String
subnet[dns_secondary]
optionel , nil autorisé

DNS secondaire pour ce sous-réseau

Validations:

  • Must be a String
subnet[ipam]
optionel , nil autorisé

IP Address auto suggestion mode for this subnet.

Validations:

  • Must be one of: DHCP, Internal DB, Random DB, EUI-64, None.
subnet[from]
optionel , nil autorisé

Adresse IP de début pour l'auto suggestion d'IP

Validations:

  • Must be a String
subnet[to]
optionel , nil autorisé

Adresse IP de fin pour l'autosuggestion d'adresse IP

Validations:

  • Must be a String
subnet[vlanid]
optionel , nil autorisé

ID VLAN de ce sous-réseau

Validations:

  • Must be a String
subnet[mtu]
optionel , nil autorisé

MTU pour ce sous réseau

Validations:

  • Must be a Integer
subnet[domain_ids]
optionel , nil autorisé

Domaines qui incluent ce sous-réseau

Validations:

  • Must be an array of any type
subnet[dhcp_id]
optionel , nil autorisé

ID Proxy DHCP à utiliser avec ce sous-réseau

Validations:

  • Must be a number.
subnet[tftp_id]
optionel , nil autorisé

ID Proxy TFTP à utiliser pour ce sous-réseau

Validations:

  • Must be a number.
subnet[httpboot_id]
optionel , nil autorisé

ID de proxy HTTPBoot à utiliser dans ce sous-réseau

Validations:

  • Must be a number.
subnet[dns_id]
optionel , nil autorisé

ID Proxy DNS à utiliser pour ce sous-réseau

Validations:

  • Must be a number.
subnet[template_id]
optionel , nil autorisé

ID de proxy HTTP(S) de modèle à utiliser au sein de ce sous-réseau

Validations:

  • Must be a number.
subnet[boot_mode]
optionel , nil autorisé

Default boot mode for interfaces assigned to this subnet.

Validations:

  • Must be one of: Static, DHCP.
subnet[subnet_parameters_attributes]
optionel , nil autorisé

Tableau de paramètres (nom, valeur)

Validations:

  • Must be an array of any type
subnet[location_ids]
optionel , nil autorisé

REMPLACER les emplacements par les id donnés

Validations:

  • Must be an array of any type
subnet[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivants

Validations:

  • Must be an array of any type
>>>

PUT /api/subnets/:id
Mise à jour d'un sous-réseau

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer
id
requis

Identifiant numérique du sous-réseau

Validations:

  • Must be a number.
subnet
requis

Validations:

  • Must be a Hash
subnet[name]
optionel

Nom du sous-réseau

Validations:

  • Must be a String
subnet[description]
optionel , nil autorisé

Description du sous-réseau

Validations:

  • Must be a String
subnet[network_type]
optionel , nil autorisé

Type ou protocole, IPv4 ou IPv6, par défaut IPv4

Validations:

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

Réseau du sous-réseau

Validations:

  • Must be a String
subnet[mask]
optionel

masque de sous-réseau

Validations:

  • Must be a String
subnet[gateway]
optionel , nil autorisé

Passerelle du sous réseau

Validations:

  • Must be a String
subnet[dns_primary]
optionel , nil autorisé

DNS primaire pour ce sous-réseau

Validations:

  • Must be a String
subnet[dns_secondary]
optionel , nil autorisé

DNS secondaire pour ce sous-réseau

Validations:

  • Must be a String
subnet[ipam]
optionel , nil autorisé

IP Address auto suggestion mode for this subnet.

Validations:

  • Must be one of: DHCP, Internal DB, Random DB, EUI-64, None.
subnet[from]
optionel , nil autorisé

Adresse IP de début pour l'auto suggestion d'IP

Validations:

  • Must be a String
subnet[to]
optionel , nil autorisé

Adresse IP de fin pour l'autosuggestion d'adresse IP

Validations:

  • Must be a String
subnet[vlanid]
optionel , nil autorisé

ID VLAN de ce sous-réseau

Validations:

  • Must be a String
subnet[mtu]
optionel , nil autorisé

MTU pour ce sous réseau

Validations:

  • Must be a Integer
subnet[domain_ids]
optionel , nil autorisé

Domaines qui incluent ce sous-réseau

Validations:

  • Must be an array of any type
subnet[dhcp_id]
optionel , nil autorisé

ID Proxy DHCP à utiliser avec ce sous-réseau

Validations:

  • Must be a number.
subnet[tftp_id]
optionel , nil autorisé

ID Proxy TFTP à utiliser pour ce sous-réseau

Validations:

  • Must be a number.
subnet[httpboot_id]
optionel , nil autorisé

ID de proxy HTTPBoot à utiliser dans ce sous-réseau

Validations:

  • Must be a number.
subnet[dns_id]
optionel , nil autorisé

ID Proxy DNS à utiliser pour ce sous-réseau

Validations:

  • Must be a number.
subnet[template_id]
optionel , nil autorisé

ID de proxy HTTP(S) de modèle à utiliser au sein de ce sous-réseau

Validations:

  • Must be a number.
subnet[boot_mode]
optionel , nil autorisé

Default boot mode for interfaces assigned to this subnet.

Validations:

  • Must be one of: Static, DHCP.
subnet[subnet_parameters_attributes]
optionel , nil autorisé

Tableau de paramètres (nom, valeur)

Validations:

  • Must be an array of any type
subnet[location_ids]
optionel , nil autorisé

REMPLACER les emplacements par les id donnés

Validations:

  • Must be an array of any type
subnet[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivants

Validations:

  • Must be an array of any type
>>>

DELETE /api/subnets/:id
Supprimer un sous-réseau

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer
id
requis

Identifiant numérique du sous-réseau

Validations:

  • Must be a number.
>>>

GET /api/subnets/:id/freeip
Fournir une adresse IP non utilisée dans le sous-réseaux

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optionel

Set the current organization context for the request

Validations:

  • Must be a Integer
id
requis

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
optionel

Adresse MAC pour réutiliser l'IP de cet hôte

Validations:

  • Must be a String
excluded_ips
optionel

Les adresses IP qui devraient être exclues des suggestions.

Validations:

  • Must be an array of any type