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
Llista tots els paràmetres per a un amfitrió

GET /api/hostgroups/:hostgroup_id/parameters
Llista tots els paràmetres per a un grup d'amfitrions

GET /api/domains/:domain_id/parameters
Llista tots els paràmetres per a un domini

GET /api/operatingsystems/:operatingsystem_id/parameters
Llista tots els paràmetres per a un sistema operatiu

GET /api/locations/:location_id/parameters
Llista tots els paràmetres per a una ubicació

GET /api/organizations/:organization_id/parameters
Llista tots els paràmetres per a una organització

GET /api/subnets/:subnet_id/parameters
Llista tots els paràmetres per a una subxarxa

Params

Param name Description
host_id
optional

ID d'amfitrió

Validations:

  • Must be a String
hostgroup_id
optional

ID de grup d'amfitrions

Validations:

  • Must be a String
domain_id
optional

ID de domini

Validations:

  • Must be a String
operatingsystem_id
optional

ID de sistema operatiu

Validations:

  • Must be a String
location_id
optional

ID d'ubicació

Validations:

  • Must be a String
organization_id
optional

ID d'organització

Validations:

  • Must be a String
subnet_id
optional

ID de subxarxa

Validations:

  • Must be a String
show_hidden
optional

Mostra els valors ocults

Validations:

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

filtra els resultats

Validations:

  • Must be a String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Nombre de resultats per pàgina a retornar

Validations:

  • Must be a number.

Search fields

Field name Tipus Possible values
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
Mostra un paràmetre niat per a un amfitrió

GET /api/hostgroups/:hostgroup_id/parameters/:id
Mostra un paràmetre niat per a un grup d'amfitrions

GET /api/domains/:domain_id/parameters/:id
Mostra un paràmetre niat per un domini

GET /api/operatingsystems/:operatingsystem_id/parameters/:id
Mostra un paràmetre niat per un sistema operatiu

GET /api/locations/:location_id/parameters/:id
Mostra un paràmetre niat per una ubicació

GET /api/organizations/:organization_id/parameters/:id
Mostra un paràmetre niat per una organització

GET /api/subnets/:subnet_id/parameters/:id
Mostra un paràmetre niat per a una subxarxa

Params

Param name Description
host_id
optional

ID d'amfitrió

Validations:

  • Must be a String
hostgroup_id
optional

ID de grup d'amfitrions

Validations:

  • Must be a String
domain_id
optional

ID de domini

Validations:

  • Must be a String
operatingsystem_id
optional

ID de sistema operatiu

Validations:

  • Must be a String
location_id
optional

ID d'ubicació

Validations:

  • Must be a String
organization_id
optional

ID d'organització

Validations:

  • Must be a String
subnet_id
optional

ID de subxarxa

Validations:

  • Must be a String
id
required

ID de paràmetre

Validations:

  • Must be a String
show_hidden
optional

Mostra els valors ocults

Validations:

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

POST /api/hosts/:host_id/parameters
Crea un paràmetre niat per a un amfitrió

POST /api/hostgroups/:hostgroup_id/parameters
Crea un paràmetre niat per a un grup d'amfitrions

POST /api/domains/:domain_id/parameters
Crea un paràmetre niat per un domini

POST /api/operatingsystems/:operatingsystem_id/parameters
Crea un paràmetre niat per un sistema operatiu

POST /api/locations/:location_id/parameters
Crea un paràmetre niat per una ubicació

POST /api/organizations/:organization_id/parameters
Crea un paràmetre niat per una organització

POST /api/subnets/:subnet_id/parameters
Crea un paràmetre niat per a una subxarxa

Params

Param name Description
host_id
optional

ID d'amfitrió

Validations:

  • Must be a String
hostgroup_id
optional

ID de grup d'amfitrions

Validations:

  • Must be a String
domain_id
optional

ID de domini

Validations:

  • Must be a String
operatingsystem_id
optional

ID de sistema operatiu

Validations:

  • Must be a String
location_id
optional

ID d'ubicació

Validations:

  • Must be a String
organization_id
optional

ID d'organització

Validations:

  • Must be a String
subnet_id
optional

ID de subxarxa

Validations:

  • Must be a String
parameter
required

Validations:

  • Must be a Hash
parameter[name]
required

Validations:

  • Must be a String
parameter[value]
required

Validations:

  • Must be a String
parameter[parameter_type]
required

Type of value

Validations:

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

PUT /api/hosts/:host_id/parameters/:id
Actualitza un paràmetre niat per a un amfitrió

PUT /api/hostgroups/:hostgroup_id/parameters/:id
Actualitza un paràmetre niat per a un grup d'amfitrions

PUT /api/domains/:domain_id/parameters/:id
Actualitza un paràmetre niat per un domini

PUT /api/operatingsystems/:operatingsystem_id/parameters/:id
Actualitza un paràmetre niat per un sistema operatiu

PUT /api/locations/:location_id/parameters/:id
Actualitza un paràmetre niat per una ubicació

PUT /api/organizations/:organization_id/parameters/:id
Actualitza un paràmetre niat per una organització

PUT /api/subnets/:subnet_id/parameters/:id
Actualitza un paràmetre niat per a una subxarxa

Params

Param name Description
host_id
optional

ID d'amfitrió

Validations:

  • Must be a String
hostgroup_id
optional

ID de grup d'amfitrions

Validations:

  • Must be a String
domain_id
optional

ID de domini

Validations:

  • Must be a String
operatingsystem_id
optional

ID de sistema operatiu

Validations:

  • Must be a String
location_id
optional

ID d'ubicació

Validations:

  • Must be a String
organization_id
optional

ID d'organització

Validations:

  • Must be a String
id
required

ID de paràmetre

Validations:

  • Must be a String
subnet_id
optional

ID de subxarxa

Validations:

  • Must be a String
parameter
required

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

Type of value

Validations:

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

DELETE /api/hosts/:host_id/parameters/:id
Suprimeix un paràmetre niat per a un amfitrió

DELETE /api/hostgroups/:hostgroup_id/parameters/:id
Suprimeix un paràmetre niat per a un grup d'amfitrions

DELETE /api/domains/:domain_id/parameters/:id
Suprimeix un paràmetre niat per un domini

DELETE /api/operatingsystems/:operatingsystem_id/parameters/:id
Suprimeix un paràmetre niat per un sistema operatiu

DELETE /api/locations/:location_id/parameters/:id
Suprimeix un paràmetre niat per una ubicació

DELETE /api/organizations/:organization_id/parameters/:id
Suprimeix un paràmetre niat per una organització

DELETE /api/subnets/:subnet_id/parameters/:id
Suprimeix un paràmetre niat per a una subxarxa

Params

Param name Description
host_id
optional

ID d'amfitrió

Validations:

  • Must be a String
hostgroup_id
optional

ID de grup d'amfitrions

Validations:

  • Must be a String
domain_id
optional

ID de domini

Validations:

  • Must be a String
operatingsystem_id
optional

ID de sistema operatiu

Validations:

  • Must be a String
location_id
optional

ID d'ubicació

Validations:

  • Must be a String
organization_id
optional

ID d'organització

Validations:

  • Must be a String
id
required

ID de paràmetre

Validations:

  • Must be a String
subnet_id
optional

ID de subxarxa

Validations:

  • Must be a String
>>>

DELETE /api/hosts/:host_id/parameters
Suprimeix tots els paràmetres niats per a un amfitrió

DELETE /api/hostgroups/:hostgroup_id/parameters
Suprimeix tots els paràmetres niats per a un grup d'amfitrions

DELETE /api/domains/:domain_id/parameters
Suprimeix tots els paràmetres niats per un domini

DELETE /api/operatingsystems/:operatingsystem_id/parameters
Suprimeix tots els paràmetres niats per un sistema operatiu

DELETE /api/locations/:location_id/parameters
Suprimeix tots els paràmetres niats per una ubicació

DELETE /api/organizations/:organization_id/parameters
Suprimeix tots els paràmetres niats per una organització

DELETE /api/subnets/:subnet_id/parameters
Suprimeix tots els paràmetres niats per a una subxarxa

Params

Param name Description
host_id
optional

ID d'amfitrió

Validations:

  • Must be a String
hostgroup_id
optional

ID de grup d'amfitrions

Validations:

  • Must be a String
domain_id
optional

ID de domini

Validations:

  • Must be a String
operatingsystem_id
optional

ID de sistema operatiu

Validations:

  • Must be a String
location_id
optional

ID d'ubicació

Validations:

  • Must be a String
organization_id
optional

ID d'organització

Validations:

  • Must be a String
subnet_id
optional

ID de subxarxa

Validations:

  • Must be a String