GET /api/dlmlocks
List all DLM locks

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

search
opcjonalny

rezultat filtrowania

Validations:

  • Must be a String

order
opcjonalny

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
opcjonalny

Page number, starting at 1

Validations:

  • Must be a number.

per_page
opcjonalny

Number of results per page to return

Validations:

  • Must be a number.


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

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

Błędy

Code Opis
404 Lock could not be found.

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

Id or name of the DLM lock

Validations:

  • Must be a String


POST /api/dlmlocks
Create a DLM lock

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

dlmlock
wymagany

Validations:

  • Must be a Hash

dlmlock[name]
wymagany

Nazwa

Validations:

  • Must be a String

dlmlock[type]
wymagany

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

Validations:

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

dlmlock[enabled]
opcjonalny , nil dopuszczalny

Enable the lock

Validations:

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


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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

Id or name of the DLM lock

Validations:

  • Must be a String

dlmlock
wymagany

Validations:

  • Must be a Hash

dlmlock[name]
opcjonalny

Nazwa

Validations:

  • Must be a String

dlmlock[type]
opcjonalny

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

Validations:

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

dlmlock[enabled]
opcjonalny , nil dopuszczalny

Enable the lock

Validations:

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


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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

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.

Błędy

Code Opis
200 Lock acquired successfully.
412 Lock could not be acquired.

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

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.

Błędy

Code Opis
200 Lock released successfully.
412 Lock could not be released.

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

Id or name of the DLM lock

Validations:

  • Must be a String