POST /api/locations/255093256/organizations/447626438/hosts { "name": "contenthost.example.com", "root_pass": "$5$pCUV1467lDAwH0J6$mhPXD8OHjOSn.DyQ1g0aL7vKWolTzMJgPFScL7kK9X4", "operatingsystem_id": 1073012846, "build": false, "owner_id": 135138680, "owner_type": "User", "enabled": true, "managed": false, "type": "Host::Managed", "global_status": 0, "creator_id": 135138680, "content_facet_attributes": { "content_view_id": 30237652, "lifecycle_environment_id": 562075838 }, "subscription_facet_attributes": { "purpose_addons": [ "Addon" ] }, "host": { "content_facet_attributes": { "content_view_id": 30237652, "lifecycle_environment_id": 562075838 }, "subscription_facet_attributes": { "purpose_addons": [ "Addon" ] }, "build": false, "global_status": 0, "owner_id": 135138680, "owner_type": "User", "enabled": true, "managed": false, "name": "contenthost.example.com", "root_pass": "$5$pCUV1467lDAwH0J6$mhPXD8OHjOSn.DyQ1g0aL7vKWolTzMJgPFScL7kK9X4", "type": "Host::Managed", "operatingsystem_id": 1073012846 } } 201 { "ip": null, "ip6": null, "last_report": null, "mac": null, "realm_id": null, "realm_name": null, "sp_mac": null, "sp_ip": null, "sp_name": null, "domain_id": null, "domain_name": null, "architecture_id": null, "architecture_name": null, "operatingsystem_id": 1073012846, "operatingsystem_name": "operatingsystem11 11", "subnet_id": null, "subnet_name": null, "subnet6_id": null, "subnet6_name": null, "sp_subnet_id": null, "ptable_id": null, "ptable_name": null, "medium_id": null, "medium_name": null, "pxe_loader": null, "build": false, "comment": null, "disk": null, "initiated_at": null, "installed_at": null, "model_id": null, "hostgroup_id": null, "owner_id": 135138680, "owner_name": "Admin User", "owner_type": "User", "creator_id": 135138680, "creator": "Admin User", "enabled": true, "managed": false, "use_image": null, "image_file": "", "uuid": null, "compute_resource_id": null, "compute_resource_name": null, "compute_profile_id": null, "compute_profile_name": null, "capabilities": [ "build" ], "provision_method": "build", "certname": "contenthost.example.com", "image_id": null, "image_name": null, "created_at": "2024-02-22 18:18:32 UTC", "updated_at": "2024-02-22 18:18:32 UTC", "last_compile": null, "global_status": 0, "global_status_label": "OK", "bmc_available": false, "organization_id": 447626438, "organization_name": "Organization 1", "location_id": 255093256, "location_name": "Location 1", "puppet_status": 0, "model_name": null, "build_status": 0, "build_status_label": "Installed", "name": "contenthost.example.com", "id": 980191036, "display_name": "contenthost.example.com", "puppet_proxy_id": null, "puppet_proxy_name": null, "puppet_ca_proxy_id": null, "puppet_ca_proxy_name": null, "puppet_proxy": null, "puppet_ca_proxy": null, "cockpit_url": null, "compute_resource_provider": null, "hostgroup_name": null, "hostgroup_title": null, "parameters": [], "all_parameters": [ { "priority": null, "created_at": "2024-02-22 18:15:42 UTC", "updated_at": "2024-02-22 18:15:42 UTC", "id": 513706444, "name": "loc_param", "parameter_type": "string", "associated_type": "location", "hidden_value?": false, "value": "abc" }, { "priority": null, "created_at": "2024-02-22 18:15:42 UTC", "updated_at": "2024-02-22 18:15:42 UTC", "id": 32400255, "name": "org_param", "parameter_type": "string", "associated_type": "organization", "hidden_value?": false, "value": "xyz" }, { "priority": null, "created_at": "2024-02-22 18:15:42 UTC", "updated_at": "2024-02-22 18:15:42 UTC", "id": 636252244, "name": "test", "parameter_type": "string", "associated_type": "global", "hidden_value?": false, "value": "myvalue" } ], "content_facet_attributes": { "id": 906413804, "uuid": null, "content_source_id": null, "content_source_name": null, "kickstart_repository_id": null, "kickstart_repository_name": null, "errata_counts": { "security": 0, "bugfix": 0, "enhancement": 0, "total": 0, "applicable": { "bugfix": 0, "security": 0, "enhancement": 0, "total": 0 } }, "applicable_deb_count": 0, "upgradable_deb_count": 0, "applicable_package_count": 0, "upgradable_package_count": 0, "applicable_module_stream_count": 0, "upgradable_module_stream_count": 0, "content_view_environments": [ { "content_view": { "id": 30237652, "name": "ACME Default ContentView", "composite": false }, "lifecycle_environment": { "id": 562075838, "name": "Library" } } ], "content_source": null, "kickstart_repository": null, "content_view": { "id": 30237652, "name": "ACME Default ContentView", "composite": false }, "lifecycle_environment": { "id": 562075838, "name": "Library" }, "permissions": { "view_lifecycle_environments": true, "view_content_views": true, "promote_or_remove_content_views_to_environments": true, "view_host_collections": true, "create_job_invocations": true, "view_activation_keys": true, "view_products": true, "create_bookmarks": true }, "content_view_version": "1.0", "content_view_version_id": 840492357, "content_view_version_latest": true, "content_view_default?": true, "lifecycle_environment_library?": true, "katello_tracer_installed": false, "katello_tracer_rpm_available": false }, "subscription_facet_attributes": { "host_type": null, "dmi_uuid": null, "id": 980191015, "uuid": null, "last_checkin": null, "service_level": null, "release_version": null, "autoheal": false, "registered_at": "2024-02-20 14:14:40 UTC", "registered_through": null, "purpose_role": null, "purpose_usage": null, "hypervisor": false, "user": null, "purpose_addons": [ "Addon" ], "virtual_host": null, "virtual_guests": [], "installed_products": [], "activation_keys": [], "compliance_reasons": [] }, "host_collections": [], "operatingsystem_family": null, "operatingsystem_major": "11", "content_view": { "id": 30237652, "name": "ACME Default ContentView", "composite": false }, "lifecycle_environment": { "id": 562075838, "name": "Library" }, "interfaces": [ { "subnet_id": null, "subnet_name": null, "subnet6_id": null, "subnet6_name": null, "domain_id": null, "domain_name": null, "created_at": "2024-02-22 18:18:32 UTC", "updated_at": "2024-02-22 18:18:32 UTC", "managed": true, "identifier": null, "id": 372, "name": "contenthost.example.com", "ip": null, "ip6": null, "mac": null, "mtu": null, "fqdn": "contenthost.example.com", "primary": true, "provision": true, "type": "interface", "execution": true, "virtual": false } ], "facts": {}, "permissions": { "view_hosts": true, "create_hosts": true, "edit_hosts": true, "destroy_hosts": true, "build_hosts": true, "power_hosts": true, "console_hosts": true, "ipmi_boot_hosts": true, "cockpit_hosts": true } }
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]
required |
Validations:
|
host[location_id]
required |
Validations:
|
host[organization_id]
required |
Validations:
|
host[ip]
optional , nil allowed |
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[architecture_id]
optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[domain_id]
optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[realm_id]
optional , nil allowed |
Validations:
|
host[puppet_proxy_id]
optional , nil allowed |
Puppet proxy ID Validations:
|
host[puppet_ca_proxy_id]
optional , nil allowed |
Puppet CA proxy ID Validations:
|
host[operatingsystem_id]
optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[medium_id]
optional , nil allowed |
required if not imaged based provisioning and host is managed and value is not inherited from host group Validations:
|
host[pxe_loader]
optional , nil allowed |
DHCP filename option (Grub2/PXELinux by default) Validations:
|
host[ptable_id]
optional , nil allowed |
required if host is managed and custom partition has not been defined Validations:
|
host[subnet_id]
optional , nil allowed |
required if host is managed and value is not inherited from host group Validations:
|
host[compute_resource_id]
optional , nil allowed |
nil means host is bare metal Validations:
|
host[root_pass]
optional , nil allowed |
required if host is managed and value is not inherited from host group or default password in settings Validations:
|
host[model_id]
optional , nil allowed |
Validations:
|
host[hostgroup_id]
optional , nil allowed |
Validations:
|
host[owner_id]
optional , nil allowed |
Validations:
|
host[owner_type]
optional , nil allowed |
Host's owner type Validations:
|
host[image_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]
required |
Name of the parameter Validations:
|
host[host_parameters_attributes][value]
required |
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[provision_method]
optional , nil allowed |
The method used to provision the host. 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[progress_report_id]
optional , nil allowed |
UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks Validations:
|
host[comment]
optional , nil allowed |
Additional information about this host Validations:
|
host[capabilities]
optional , nil allowed |
Validations:
|
host[compute_profile_id]
optional , nil allowed |
Validations:
|
host[interfaces_attributes]
optional , nil allowed |
Host's network interfaces. Validations:
|
host[interfaces_attributes][id]
optional , nil allowed |
ID of interface 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[compute_attributes]
optional , nil allowed |
Additional compute resource specific attributes. 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:
|
host[overwrite]
optional |
Overwrite existing host (true by default) Validations:
|