GET /api/foreman_datacenter/console_server_ports
List all ConsoleServerPorts

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/console_server_ports/:id
Show a ConsoleServerPort

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/console_server_ports
Create a ConsoleServerPort

Params

Param name Description
console_server_port
required

Validations:

  • Must be a Hash

console_server_port[name]
required

Validations:

  • Must be a String

console_server_port[device_id]
optional , nil allowed

Device ID

Validations:

  • Must be a number.


PUT /api/foreman_datacenter/console_server_ports/:id
Update a ConsoleServerPort

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.

console_server_port
required

Validations:

  • Must be a Hash

console_server_port[name]
optional

Validations:

  • Must be a String

console_server_port[device_id]
optional , nil allowed

Device ID

Validations:

  • Must be a number.


DELETE /api/foreman_datacenter/console_server_ports/:id
Delete a ConsoleServerPort

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.


PATCH /api/foreman_datacenter/console_server_ports/:id/connect
Connect

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.

console_server_port
required

Validations:

  • Must be a Hash

console_server_port[name]
optional

Validations:

  • Must be a String

console_server_port[device_id]
optional , nil allowed

Device ID

Validations:

  • Must be a number.

console_port_id
required

ConsolePort ID

Validations:

  • Must be a number.

connection_status
required

Connections status

Validations:

  • Must be a number.


PATCH /api/foreman_datacenter/console_server_ports/:id/disconnect
Disconnect

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.

console_server_port
required

Validations:

  • Must be a Hash

console_server_port[name]
optional

Validations:

  • Must be a String

console_server_port[device_id]
optional , nil allowed

Device ID

Validations:

  • Must be a number.