GET /api/foreman_datacenter/device_modules
List all DeviceModules

Params

Param name Description
search
optional

filter results

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

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.

Search fields

Field name Type Possible values
connection_status connected, planned
console_port
created_at
device
port
updated_at

GET /api/foreman_datacenter/device_moudles/:id
Show a DeviceModule

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/foreman_datacenter/devices/:device_id/device_modules
Create a device_module

Params

Param name Description
device_module
required

Validations:

  • Must be a Hash

device_module[name]
required

Validations:

  • Must be a String

device_module[device_id]
required

Validations:

  • Must be a number.

device_module[part_id]
required

Validations:

  • Must be a String

device_module[serial]
required

Validations:

  • Must be a String


PUT /api/foreman_datacenter/devices/:device_id/device_modules/:id
Update a device_module

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

device_module
required

Validations:

  • Must be a Hash

device_module[name]
optional

Validations:

  • Must be a String

device_module[device_id]
optional

Validations:

  • Must be a number.

device_module[part_id]
optional

Validations:

  • Must be a String

device_module[serial]
optional

Validations:

  • Must be a String


DELETE /api/foreman_datacenter/devices/:device_id/device_modules/:id
Delete a device_module

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.