POST /register { "host": { "name": "centos-test.example.com", "managed": false, "build": false, "organization_id": 447626440, "location_id": 447626439, "operatingsystem_id": 1073012829 }, "remote_execution_interface": "dummy0", "registration": { "host": { "name": "centos-test.example.com", "managed": false, "build": false, "organization_id": 447626440, "location_id": 447626439, "operatingsystem_id": 1073012829 }, "remote_execution_interface": "dummy0" } } 200 template content centos-test.example.com
Param name | Description |
---|---|
location_id
optional |
Set the current location context for the request Validations:
|
organization_id
optional |
Set the current organization context for the request Validations:
|
host
required |
Validations:
|
host[name]
optional |
Validations:
|
host[location_id]
optional |
Validations:
|
host[organization_id]
optional |
Validations:
|
host[ip]
optional , nil allowed |
IPv4 address, not required if using a subnet with DHCP proxy Validations:
|
host[ip6]
optional , nil allowed |
IPv6 address, not required if using a subnet with DHCP proxy Validations:
|
host[mac]
optional , nil allowed |
required for managed host that is bare metal, not required if it's a virtual machine Validations:
|
host[domain_id]
optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[operatingsystem_id]
optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[subnet_id]
optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[model_id]
optional , nil allowed |
Validations:
|
host[hostgroup_id]
optional , nil allowed |
Validations:
|
host[host_parameters_attributes]
optional , nil allowed |
Host's parameters (array or indexed hash) Validations:
|
host[host_parameters_attributes][name]
optional |
Name of the parameter Validations:
|
host[host_parameters_attributes][value]
optional |
Parameter value Validations:
|
host[host_parameters_attributes][parameter_type]
optional , nil allowed |
Type of value Validations:
|
host[host_parameters_attributes][hidden_value]
optional , nil allowed |
Validations:
|
host[build]
optional , nil allowed |
Validations:
|
host[enabled]
optional , nil allowed |
Include this host within Foreman reporting Validations:
|
host[managed]
optional , nil allowed |
True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not Validations:
|
host[comment]
optional , nil allowed |
Additional information about this host Validations:
|
host[interfaces_attributes]
optional , nil allowed |
Host's network interfaces Validations:
|
host[interfaces_attributes][mac]
optional , nil allowed |
MAC address of interface. Required for managed interfaces on bare metal. Validations:
|
host[interfaces_attributes][ip]
optional , nil allowed |
IPv4 address of interface Validations:
|
host[interfaces_attributes][ip6]
optional , nil allowed |
IPv6 address of interface Validations:
|
host[interfaces_attributes][type]
optional , nil allowed |
Interface type, e.g. bmc. Default is interface Validations:
|
host[interfaces_attributes][name]
optional , nil allowed |
Interface's DNS name Validations:
|
host[interfaces_attributes][subnet_id]
optional , nil allowed |
Foreman subnet ID of IPv4 interface Validations:
|
host[interfaces_attributes][subnet6_id]
optional , nil allowed |
Foreman subnet ID of IPv6 interface Validations:
|
host[interfaces_attributes][domain_id]
optional , nil allowed |
Foreman domain ID of interface. Required for primary interfaces on managed hosts. Validations:
|
host[interfaces_attributes][identifier]
optional , nil allowed |
Device identifier, e.g. eth0 or eth1.1 Validations:
|
host[interfaces_attributes][managed]
optional , nil allowed |
Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning? Validations:
|
host[interfaces_attributes][primary]
optional , nil allowed |
Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface. Validations:
|
host[interfaces_attributes][provision]
optional , nil allowed |
Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface. Validations:
|
host[interfaces_attributes][username]
optional , nil allowed |
Only for BMC interfaces. Validations:
|
host[interfaces_attributes][password]
optional , nil allowed |
Only for BMC interfaces. Validations:
|
host[interfaces_attributes][provider]
optional , nil allowed |
Interface provider, e.g. IPMI. Only for BMC interfaces. Validations:
|
host[interfaces_attributes][virtual]
optional , nil allowed |
Alias or VLAN device Validations:
|
host[interfaces_attributes][tag]
optional , nil allowed |
VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces. Validations:
|
host[interfaces_attributes][mtu]
optional , nil allowed |
MTU, this attribute has precedence over the subnet MTU. Validations:
|
host[interfaces_attributes][attached_to]
optional , nil allowed |
Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces. Validations:
|
host[interfaces_attributes][mode]
optional , nil allowed |
Bond mode of the interface, e.g. balance-rr. Only for bond interfaces. Validations:
|
host[interfaces_attributes][attached_devices]
optional , nil allowed |
Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces. Validations:
|
host[interfaces_attributes][bond_options]
optional , nil allowed |
Space separated options, e.g. miimon=100. Only for bond interfaces. Validations:
|
host[interfaces_attributes][compute_attributes]
optional , nil allowed |
Additional compute resource specific attributes for the interface. Validations:
|
host[content_facet_attributes]
optional , nil allowed |
Parameters for host's content_facet facet Validations:
|
host[content_facet_attributes][content_view_id]
optional , nil allowed |
Validations:
|
host[content_facet_attributes][lifecycle_environment_id]
optional , nil allowed |
Validations:
|
host[content_facet_attributes][content_source_id]
optional , nil allowed |
Validations:
|
host[content_facet_attributes][kickstart_repository_id]
optional , nil allowed |
Repository Id associated with the kickstart repo used for provisioning Validations:
|
host[subscription_facet_attributes]
optional , nil allowed |
Parameters for host's subscription_facet facet Validations:
|
host[subscription_facet_attributes][release_version]
optional , nil allowed |
Release version for this Host to use (7Server, 7.1, etc) Validations:
|
host[subscription_facet_attributes][autoheal]
optional , nil allowed |
Sets whether the Host will autoheal subscriptions upon checkin Validations:
|
host[subscription_facet_attributes][purpose_usage]
optional , nil allowed |
Sets the system purpose usage Validations:
|
host[subscription_facet_attributes][purpose_role]
optional , nil allowed |
Sets the system purpose usage Validations:
|
host[subscription_facet_attributes][purpose_addons]
optional , nil allowed |
Sets the system add-ons Validations:
|
host[subscription_facet_attributes][service_level]
optional , nil allowed |
Service level to be used for autoheal Validations:
|
host[subscription_facet_attributes][hypervisor_guest_uuids]
optional , nil allowed |
List of hypervisor guest uuids Validations:
|
host[subscription_facet_attributes][installed_products_attributes]
optional , nil allowed |
List of products installed on the host Validations:
|
host[subscription_facet_attributes][installed_products_attributes][product_id]
optional , nil allowed |
Product id as listed from a host's installed products, this is not the same product id as the products api returns Validations:
|
host[subscription_facet_attributes][installed_products_attributes][product_name]
optional , nil allowed |
Product name as listed from a host's installed products Validations:
|
host[subscription_facet_attributes][installed_products_attributes][arch]
optional , nil allowed |
Product architecture Validations:
|
host[subscription_facet_attributes][installed_products_attributes][version]
optional , nil allowed |
Product version Validations:
|
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:
|
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:
|
remote_execution_interface
optional |
Identifier of the Host interface for Remote execution Validations:
|
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:
|