GET /api/dlmlocks
List all DLM locks

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

Orden y campo de clasificación, p. ej., 'id DESC'

Validations:

  • Must be a String

page
opcional

Número de página, comenzando por 1

Validations:

  • Must be a number.

per_page
opcional

Número de resultados por página para devolver

Validations:

  • Must be a number.


GET /api/dlmlocks/:id
Show a DLM lock

GET /api/dlmlocks/:id/lock
Show a DLM lock

Errores

Code Descripción
404 Lock could not be found.

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

Id or name of the DLM lock

Validations:

  • Must be a String


POST /api/dlmlocks
Create a DLM lock

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

dlmlock
requerido

Validations:

  • Must be a Hash

dlmlock[name]
requerido

Nombre

Validations:

  • Must be a String

dlmlock[type]
requerido

Type, e.g. ForemanDlm::Dlmlock:Update

Validations:

  • Must be one of: ForemanDlm::Dlmlock:Update.

dlmlock[enabled]
opcional , nil permitido

Enable the lock

Validations:

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


PUT /api/dlmlocks/:id
Update a DLM lock

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

Id or name of the DLM lock

Validations:

  • Must be a String

dlmlock
requerido

Validations:

  • Must be a Hash

dlmlock[name]
opcional

Nombre

Validations:

  • Must be a String

dlmlock[type]
opcional

Type, e.g. ForemanDlm::Dlmlock:Update

Validations:

  • Must be one of: ForemanDlm::Dlmlock:Update.

dlmlock[enabled]
opcional , nil permitido

Enable the lock

Validations:

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


DELETE /api/dlmlocks/:id
Delete a DLM lock

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

Id or name of the DLM lock

Validations:

  • Must be a String


PUT /api/dlmlocks/:id/lock
Acquire a DLM lock

Acquire a lock

This action acquires a lock. It fails, if the lock is currently taken by another host.

Authentication & Host Identification

The host is authenticated via a client certificate and identified via the CN of that certificate.

Errores

Code Descripción
200 Lock acquired successfully.
412 Lock could not be acquired.

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

Id or name of the DLM lock

Validations:

  • Must be a String


DELETE /api/dlmlocks/:id/lock
Release a DLM lock

Release a lock

This action releases a lock.
It fails, if the lock is currently taken by another host.

Authentication & Host Identification

The host is authenticated via a client certificate and identified via the CN of that certificate.

Errores

Code Descripción
200 Lock released successfully.
412 Lock could not be released.

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

Id or name of the DLM lock

Validations:

  • Must be a String