Parameters

These API calls are related to nested parameters for a host, domain, subnet, host group, operating system. If you are looking for <a href=“common_parameters.html”>global parameters</a>, go to <a href=“common_parameters.html”>this link</a>.

>>>

GET /api/hosts/:host_id/parameters
Alle Parameter für einen Host auflisten

GET /api/hostgroups/:hostgroup_id/parameters
Alle Parameter für eine Hostgruppe auflisten

GET /api/domains/:domain_id/parameters
Alle Parameter für eine Domäne auflisten

GET /api/operatingsystems/:operatingsystem_id/parameters
Alle Parameter für ein Betriebssystem auflisten

GET /api/locations/:location_id/parameters
Alle Parameter für einen Standort auflisten

GET /api/organizations/:organization_id/parameters
Alle Parameter für eine Organisation auflisten

GET /api/subnets/:subnet_id/parameters
Alle Parameter für ein Subnetz auflisten

Parameter

Parametername Beschreibung
host_id
optional

Hostkennung

Validations:

  • Must be a String
hostgroup_id
optional

Kennung der Hostgruppe

Validations:

  • Must be a String
domain_id
optional

Kennung der Domäne

Validations:

  • Must be a String
operatingsystem_id
optional

Kennung des Betriebssystems

Validations:

  • Must be a String
location_id
optional

Standortkennung

Validations:

  • Must be a String
organization_id
optional

Kennung der Organisation

Validations:

  • Must be a String
subnet_id
optional

Kennung des Subnetzes

Validations:

  • Must be a String
show_hidden
optional

Versteckte Werte anzeigen

Validations:

  • Must be one of: true, false, 1, 0.
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
domain_name
host_group_name
host_name
key_type
location_name
name
organization_name
os_name
parameter_type
subnet_name
type
value
>>>

GET /api/hosts/:host_id/parameters/:id
Verschachtelten Parameter für einen Host anzeigen

GET /api/hostgroups/:hostgroup_id/parameters/:id
Verschachtelten Parameter für eine Hostgruppe anzeigen

GET /api/domains/:domain_id/parameters/:id
Verschachtelten Parameter für eine Domäne anzeigen

GET /api/operatingsystems/:operatingsystem_id/parameters/:id
Verschachtelten Parameter für ein Betriebssystem anzeigen

GET /api/locations/:location_id/parameters/:id
Verschachtelten Parameter für einen Standort anzeigen

GET /api/organizations/:organization_id/parameters/:id
Verschachtelten Parameter für eine Organisation anzeigen

GET /api/subnets/:subnet_id/parameters/:id
Verschachtelten Parameter für ein Subnetz anzeigen

Parameter

Parametername Beschreibung
host_id
optional

Hostkennung

Validations:

  • Must be a String
hostgroup_id
optional

Kennung der Hostgruppe

Validations:

  • Must be a String
domain_id
optional

Kennung der Domäne

Validations:

  • Must be a String
operatingsystem_id
optional

Kennung des Betriebssystems

Validations:

  • Must be a String
location_id
optional

Standortkennung

Validations:

  • Must be a String
organization_id
optional

Kennung der Organisation

Validations:

  • Must be a String
subnet_id
optional

Kennung des Subnetzes

Validations:

  • Must be a String
id
verpflichtend

Parameterkennung

Validations:

  • Must be a String
show_hidden
optional

Versteckte Werte anzeigen

Validations:

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

POST /api/hosts/:host_id/parameters
Verschachtelten Parameter für einen Host erstellen

POST /api/hostgroups/:hostgroup_id/parameters
Verschachtelten Parameter für eine Hostgruppe erstellen

POST /api/domains/:domain_id/parameters
Verschachtelten Parameter für eine Domäne erstellen

POST /api/operatingsystems/:operatingsystem_id/parameters
Verschachtelten Parameter für ein Betriebssystem erstellen

POST /api/locations/:location_id/parameters
Verschachtelten Parameter für einen Standort erstellen

POST /api/organizations/:organization_id/parameters
Verschachtelten Parameter für eine Organisation erstellen

POST /api/subnets/:subnet_id/parameters
Verschachtelten Parameter für ein Subnetz erstellen

Parameter

Parametername Beschreibung
host_id
optional

Hostkennung

Validations:

  • Must be a String
hostgroup_id
optional

Kennung der Hostgruppe

Validations:

  • Must be a String
domain_id
optional

Kennung der Domäne

Validations:

  • Must be a String
operatingsystem_id
optional

Kennung des Betriebssystems

Validations:

  • Must be a String
location_id
optional

Standortkennung

Validations:

  • Must be a String
organization_id
optional

Kennung der Organisation

Validations:

  • Must be a String
subnet_id
optional

Kennung des Subnetzes

Validations:

  • Must be a String
parameter
verpflichtend

Validations:

  • Must be a Hash
parameter[name]
verpflichtend

Validations:

  • Must be a String
parameter[value]
verpflichtend

Validations:

  • Must be a String
parameter[parameter_type]
verpflichtend

Typ des Wertes

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
>>>

PUT /api/hosts/:host_id/parameters/:id
Verschachtelten Parameter für einen Host aktualisieren

PUT /api/hostgroups/:hostgroup_id/parameters/:id
Verschachtelten Parameter für eine Hostgruppe aktualisieren

PUT /api/domains/:domain_id/parameters/:id
Verschachtelten Parameter für eine Domäne aktualisieren

PUT /api/operatingsystems/:operatingsystem_id/parameters/:id
Verschachtelten Parameter für ein Betriebssystem aktualisieren

PUT /api/locations/:location_id/parameters/:id
Verschachtelten Parameter für einen Standort aktualisieren

PUT /api/organizations/:organization_id/parameters/:id
Verschachtelten Parameter für eine Organisation aktualisieren

PUT /api/subnets/:subnet_id/parameters/:id
Verschachtelten Parameter für ein Subnetz aktualisieren

Parameter

Parametername Beschreibung
host_id
optional

Hostkennung

Validations:

  • Must be a String
hostgroup_id
optional

Kennung der Hostgruppe

Validations:

  • Must be a String
domain_id
optional

Kennung der Domäne

Validations:

  • Must be a String
operatingsystem_id
optional

Kennung des Betriebssystems

Validations:

  • Must be a String
location_id
optional

Standortkennung

Validations:

  • Must be a String
organization_id
optional

Kennung der Organisation

Validations:

  • Must be a String
id
verpflichtend

Parameterkennung

Validations:

  • Must be a String
subnet_id
optional

Kennung des Subnetzes

Validations:

  • Must be a String
parameter
verpflichtend

Validations:

  • Must be a Hash
parameter[name]
optional

Validations:

  • Must be a String
parameter[value]
optional

Validations:

  • Must be a String
parameter[parameter_type]
optional

Typ des Wertes

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
>>>

DELETE /api/hosts/:host_id/parameters/:id
Verschachtelten Parameter für einen Host löschen

DELETE /api/hostgroups/:hostgroup_id/parameters/:id
Verschachtelten Parameter für eine Hostgruppe löschen

DELETE /api/domains/:domain_id/parameters/:id
Verschachtelten Parameter für eine Domäne löschen

DELETE /api/operatingsystems/:operatingsystem_id/parameters/:id
Verschachtelten Parameter für ein Betriebssystem löschen

DELETE /api/locations/:location_id/parameters/:id
Verschachtelten Parameter für einen Standort löschen

DELETE /api/organizations/:organization_id/parameters/:id
Verschachtelten Parameter für eine Organisation löschen

DELETE /api/subnets/:subnet_id/parameters/:id
Verschachtelten Parameter für ein Subnetz löschen

Parameter

Parametername Beschreibung
host_id
optional

Hostkennung

Validations:

  • Must be a String
hostgroup_id
optional

Kennung der Hostgruppe

Validations:

  • Must be a String
domain_id
optional

Kennung der Domäne

Validations:

  • Must be a String
operatingsystem_id
optional

Kennung des Betriebssystems

Validations:

  • Must be a String
location_id
optional

Standortkennung

Validations:

  • Must be a String
organization_id
optional

Kennung der Organisation

Validations:

  • Must be a String
id
verpflichtend

Parameterkennung

Validations:

  • Must be a String
subnet_id
optional

Kennung des Subnetzes

Validations:

  • Must be a String
>>>

DELETE /api/hosts/:host_id/parameters
Alle verschachtelten Parameter für einen Host löschen

DELETE /api/hostgroups/:hostgroup_id/parameters
Alle verschachtelten Parameter für eine Hostgruppe löschen

DELETE /api/domains/:domain_id/parameters
Alle verschachtelten Parameter für eine Domäne löschen

DELETE /api/operatingsystems/:operatingsystem_id/parameters
Alle verschachtelten Parameter für ein Betriebssystem löschen

DELETE /api/locations/:location_id/parameters
Alle verschachtelten Parameter für einen Standort löschen

DELETE /api/organizations/:organization_id/parameters
Alle verschachtelten Parameter für eine Organisation löschen

DELETE /api/subnets/:subnet_id/parameters
Alle verschachtelten Parameter für ein Subnetz löschen

Parameter

Parametername Beschreibung
host_id
optional

Hostkennung

Validations:

  • Must be a String
hostgroup_id
optional

Kennung der Hostgruppe

Validations:

  • Must be a String
domain_id
optional

Kennung der Domäne

Validations:

  • Must be a String
operatingsystem_id
optional

Kennung des Betriebssystems

Validations:

  • Must be a String
location_id
optional

Standortkennung

Validations:

  • Must be a String
organization_id
optional

Kennung der Organisation

Validations:

  • Must be a String
subnet_id
optional

Kennung des Subnetzes

Validations:

  • Must be a String