GET /api/foreman_datacenter/device_interfaces
List all DeviceInterfaces

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
name

GET /api/foreman_datacenter/device_interfaces/:id
Show a DeviceBayTemplate

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/device_interfaces
Create a DeviceInterface

Params

Param name Description
device_interface
required

Validations:

  • Must be a Hash

device_interface[name]
required

Validations:

  • Must be a String

device_interface[device_id]
optional , nil allowed

Device ID

Validations:

  • Must be a number.

device_interface[form_factor]
optional , nil allowed

Form Factor

Validations:

  • Must be a String

device_interface[mac_address]
optional , nil allowed

MAC address

Validations:

  • Must be a String

device_interface[mgmn_only]
optional , nil allowed

Management only

Validations:

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

device_interface[description]
optional , nil allowed

Description

Validations:

  • Must be a String

device_interface[ip_address]
optional , nil allowed

IP address

Validations:

  • Must be a String


PUT /api/foreman_datacenter/device_interfaces/:id
Update a DeviceInterface

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_interface
required

Validations:

  • Must be a Hash

device_interface[name]
optional

Validations:

  • Must be a String

device_interface[device_id]
optional , nil allowed

Device ID

Validations:

  • Must be a number.

device_interface[form_factor]
optional , nil allowed

Form Factor

Validations:

  • Must be a String

device_interface[mac_address]
optional , nil allowed

MAC address

Validations:

  • Must be a String

device_interface[mgmn_only]
optional , nil allowed

Management only

Validations:

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

device_interface[description]
optional , nil allowed

Description

Validations:

  • Must be a String

device_interface[ip_address]
optional , nil allowed

IP address

Validations:

  • Must be a String


DELETE /api/foreman_datacenter/device_interfaces/:id
Delete a DeviceInterface

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.