GET /api/register
Render Global registration template

Params

Param name Description
organization_id
optional

ID of the Organization to register the host in

Validations:

  • Must be a number.
location_id
optional

ID of the Location to register the host in

Validations:

  • Must be a number.
hostgroup_id
optional

ID of the Host group to register the host in

Validations:

  • Must be a number.
operatingsystem_id
optional

ID of the Operating System to register the host in

Validations:

  • Must be a number.
setup_insights
optional

Set 'host_registration_insights' parameter for the host. If it is set to true, insights client will be installed and registered on Red Hat family operating systems

Validations:

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

Set 'host_registration_remote_execution' parameter for the host. If it is set to true, SSH keys will be installed on the host

Validations:

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

Packages to install on the host when registered. Can be set by `host_packages` parameter, example: `pkg1 pkg2`

Validations:

  • String
update_packages
optional

Update all packages on the host

Validations:

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

Array with repository URL and corresponding GPG key URL

Validations:

  • Must be an Array of nested elements
repo_data[repo]
optional

Repository URL / details, for example for Debian OS family: 'deb deb.example.com/ buster 1.0', for Red Hat OS family: 'yum.theforeman.org/client/latest/el8/x86_64/'

Validations:

  • String
repo_data[repo_gpg_key_url]
optional

URL of the GPG key for the repository

Validations:

  • String
remote_execution_interface
optional

Identifier of the Host interface for Remote execution

Validations:

  • String
setup_remote_execution_pull
optional

Set 'host_registration_remote_execution_pull' parameter for the host. If it is set to true, pull provider client will be deployed on the host

Validations:

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