GET /api/hosts
Alle Hosts auflisten

GET /api/hostgroups/:hostgroup_id/hosts
Alle Hosts für eine Hostgruppe auflisten

GET /api/locations/:location_id/hosts
Hosts pro Standort auflisten

GET /api/organizations/:organization_id/hosts
Hosts pro Organisation auflisten

GET /api/environments/:environment_id/hosts
Hosts pro Umgebung auflisten

Parameter

Parametername Beschreibung
thin
optional

Nur Kennung und Namen von Hosts auflisten

Validations:

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

hostgroup_id
optional

Kennung der Hostgruppe

Validations:

  • String

location_id
optional

Standortkennung

Validations:

  • String

organization_id
optional

Kennung der Organisation

Validations:

  • String

environment_id
optional

Umgebungskennung

Validations:

  • String

include
optional

Array of extra information types to include

Validations:

  • Must be one of: parameters, all_parameters.

search
optional

Ergebnisse filtern

Validations:

  • String

order
optional

Feld und Reihenfolge sortieren, z.B. 'id DESC'

Validations:

  • String

page
optional

Ergebnisse nummerieren

Validations:

  • String

per_page
optional

Anzahl der Einträge pro Anfrage

Validations:

  • String

Suchfelder

Feld Name Typ Mögliche Werte
activation_key string
activation_key_id string
addon text
addons_status mismatched, matched, not_specified
applicable_errata string
applicable_rpms string
architecture string
autoheal boolean
available_module_stream_name string
available_module_stream_stream string
build true, false
class string
comment text
compute_resource string
compute_resource_id integer
config_group string
content_source string
content_view string
content_view_id integer
domain string
domain_id integer
environment string
errata_status security_needed, errata_needed, updated, unknown
facts string
global_status ok, warning, error
has_ip string
has_mac string
host_collection string
host_collection_id integer
hostgroup string
hostgroup_fullname string
hostgroup_id integer
hostgroup_name string
hostgroup_title string
hypervisor true, false
hypervisor_host string
image string
installable_errata string
installed_at datetime
installed_package string
installed_package_name string
ip string
last_checkin datetime
last_report datetime
lifecycle_environment string
lifecycle_environment_id integer
location string
location_id integer
mac string
managed true, false
model string
name string
organization string
organization_id integer
origin string
os string
os_description string
os_id integer
os_major string
os_minor string
os_title string
owner string
owner_id integer
owner_type string
params string
parent_hostgroup string
puppet_ca string
puppet_proxy_id integer
puppetmaster string
purpose_status mismatched, matched, not_specified
realm string
realm_id integer
registered_at datetime
registered_through string
release_version string
role text
role_status mismatched, matched, not_specified
service_level string
sla_status mismatched, matched, not_specified
smart_proxy string
status.applied integer
status.enabled true, false
status.failed integer
status.failed_restarts integer
status.interesting true, false
status.pending integer
status.restarted integer
status.skipped integer
subnet string
subnet.name text
subnet6 string
subnet6.name text
subscription_id string
subscription_name string
subscription_status valid, partial, invalid, unknown, unsubscribed_hypervisor
subscription_uuid string
trace_app string
trace_app_type string
trace_helper string
trace_status reboot_needed, process_restart_needed, updated
upgradable_rpms string
usage text
usage_status mismatched, matched, not_specified
user.firstname string
user.lastname string
user.login string
user.mail string
usergroup string
usergroup.name string
uuid string

GET /api/hosts/:id
Host anzeigen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

show_hidden_parameters
optional

Versteckte Parameter Werte anzeigen

Validations:

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


POST /api/hosts
Host erstellen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Integer

host
verpflichtend

Validations:

  • Hash

host[name]
verpflichtend

Validations:

  • String

host[location_id]
verpflichtend

Validations:

  • Must be a number.

host[organization_id]
verpflichtend

Validations:

  • Must be a number.

host[environment_id]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • String

host[ip]
optional , nil erlaubt

nicht erforderlich, wenn ein Subnetz mit DHCP-Proxy verwendet wird

Validations:

  • String

host[mac]
optional , nil erlaubt

erforderlich für Bare-Metal-Host, nicht erforderlich, wenn der Host eine virtuelle Maschine ist

Validations:

  • String

host[architecture_id]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • Must be a number.

host[domain_id]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • Must be a number.

host[realm_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[puppet_proxy_id]
optional , nil erlaubt

Puppet-Proxy Kennung

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
optional , nil erlaubt

Puppet-CA-Proxy Kennung

Validations:

  • Must be a number.

host[puppetclass_ids]
optional , nil erlaubt

Validations:

  • Must be an array of any type

host[config_group_ids]
optional , nil erlaubt

Kennungen von zugehörigen Konfigurationsgruppen

Validations:

  • Must be an array of any type

host[operatingsystem_id]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • String

host[medium_id]
optional , nil erlaubt

erforderlich, wenn die Bereitstellung nicht image-basiert, der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • String

host[pxe_loader]
optional , nil erlaubt

DHCP-Dateinamensoption (Standardmäßig Grub2/PXELinux)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

host[ptable_id]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und keine spezifische Partition definiert ist

Validations:

  • Must be a number.

host[subnet_id]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • Must be a number.

host[compute_resource_id]
optional , nil erlaubt

“nil” bedeutet, dass es sich um einen Bare-Metal-Host handelt

Validations:

  • Must be a number.

host[root_pass]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe oder einem Standardpasswort in den Einstellungen vererbt ist

Validations:

  • String

host[model_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[hostgroup_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[owner_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[owner_type]
optional , nil erlaubt

Eigentümertyp des Hosts

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[host_parameters_attributes]
optional , nil erlaubt

Hostparameter (Array oder indizierter Hash)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
verpflichtend

Name des Parameters

Validations:

  • String

host[host_parameters_attributes][value]
verpflichtend

Parameterwert

Validations:

  • String

host[build]
optional , nil erlaubt

Validations:

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

host[enabled]
optional , nil erlaubt

Diesen Host in das Foreman-Reporting aufnehmen

Validations:

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

host[provision_method]
optional , nil erlaubt

Methode der Bereitstellung des Host

Validations:

  • Must be one of: build, image.

host[managed]
optional , nil erlaubt

True/False-Flag, ob ein Host gemanagt oder ungemanagt ist. Hinweis: Dieser Wert bestimmt außerdem, ob mehrere Parameter erforderlich sind oder nicht.

Validations:

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

host[progress_report_id]
optional , nil erlaubt

UUID zum Tracken des Status der Orchestrierungsaufgaben, GET /api/orchestration/:UUID/tasks

Validations:

  • String

host[comment]
optional , nil erlaubt

Weitere Informationen über diesen Host

Validations:

  • String

host[capabilities]
optional , nil erlaubt

Validations:

  • String

host[compute_profile_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[interfaces_attributes]
optional , nil erlaubt

Netzwerkschnittstelle des Hosts

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
optional , nil erlaubt

MAC-Adresse der Schnittstelle. Erforderlich für gemanagte Bare-Metal-Schnittstellen.

Validations:

  • String

host[interfaces_attributes][ip]
optional , nil erlaubt

IPv4-Adresse der Schnittstelle

Validations:

  • String

host[interfaces_attributes][ip6]
optional , nil erlaubt

IPv6-Adresse der Schnittstelle

Validations:

  • String

host[interfaces_attributes][type]
optional , nil erlaubt

Schnittstellentyp, z.B. BMC. Standard ist interface

Validations:

  • Must be one of: interface, bmc, bond, bridge.

host[interfaces_attributes][name]
optional , nil erlaubt

DNS-Name der Schnittstelle

Validations:

  • String

host[interfaces_attributes][subnet_id]
optional , nil erlaubt

Foreman Subnetz Kennung der IPv4 Schnittstelle

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
optional , nil erlaubt

Foreman Subnetz Kennung der IPv6 Schnittstelle

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
optional , nil erlaubt

Foreman-Domänen-Kennung der Schnittstelle. Erforderlich für Primärschnittstellen auf gemanagten Hosts.

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
optional , nil erlaubt

Gerätebezeichner, z.B. eth0 oder eth1.1

Validations:

  • String

host[interfaces_attributes][managed]
optional , nil erlaubt

Soll diese Schnittstelle über DHCP- und DNS-Smart-Proxy verwaltet werden, oder soll sie bei der Bereitstellung konfiguriert werden?

Validations:

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

host[interfaces_attributes][primary]
optional , nil erlaubt

Soll diese Schnittstelle zum Erstellen des FQDN des Hosts verwendet werden? Jeder gemanagte Host muss eine Primärschnittstelle aufweisen.

Validations:

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

host[interfaces_attributes][provision]
optional , nil erlaubt

Soll diese Schnittstelle für TFTP von PXELinux (oder SSH für image-basierte Hosts) verwendet werden? Jeder gemanagte Host muss eine Bereitstellungsschnittstelle aufweisen.

Validations:

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

host[interfaces_attributes][username]
optional , nil erlaubt

Nur für BMC-Schnittstellen.

Validations:

  • String

host[interfaces_attributes][password]
optional , nil erlaubt

Nur für BMC-Schnittstellen.

Validations:

  • String

host[interfaces_attributes][provider]
optional , nil erlaubt

Schnittstellen-Provider, z.B. IPMI. Nur für BMC-Schnittstellen.

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
optional , nil erlaubt

Alias oder VLAN-Gerät

Validations:

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

host[interfaces_attributes][tag]
optional , nil erlaubt

VLAN-Tag, dieses Atttribut hat Vorrang vor der Subnetz-VLAN-Kennung. Nur für virtuelle Schnittstellen.

Validations:

  • String

host[interfaces_attributes][mtu]
optional , nil erlaubt

MTU. Dieser Wert hat Vorrang über die Subnetz MTU.

Validations:

  • Integer

host[interfaces_attributes][attached_to]
optional , nil erlaubt

Kennung der Schnittstelle, zu der diese Schnittstelle gehört, z.B. eth1. Nur für virtuelle Schnittstellen.

Validations:

  • String

host[interfaces_attributes][mode]
optional , nil erlaubt

Bond-Modus der Schnittstelle, z.B. balance-rr. Ausschließlich für Bond-Schnittstellen.

Validations:

  • Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

host[interfaces_attributes][attached_devices]
optional , nil erlaubt

Kennungen von verbundenen Schnittstellen, z.B. `['eth1', 'eth2']`. Für Bond-Schnittstellen sind diese die Slaves. Nur für Bond- und Bridge-Schnittstellen.

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
optional , nil erlaubt

Durch Leerzeichen getrennte Optionen, z.B. miimon=100. Ausschließlich für Bond-Schnittstellen.

Validations:

  • String

host[interfaces_attributes][compute_attributes]
optional , nil erlaubt

Zusätzliche Rechenressourcen-spezifische Attribute für die Schnittstelle.

Validations:

  • Hash

host[compute_attributes]
optional , nil erlaubt

Zusätzliche Rechenressourcen-spezifische Attribute

Validations:

  • Hash

host[content_facet_attributes]
optional , nil erlaubt

Parameters for host's content_facet facet

Validations:

  • Hash

host[content_facet_attributes][content_view_id]
optional , nil erlaubt

Validations:

  • Integer

host[content_facet_attributes][lifecycle_environment_id]
optional , nil erlaubt

Validations:

  • Integer

host[content_facet_attributes][content_source_id]
optional , nil erlaubt

Validations:

  • Integer

host[content_facet_attributes][kickstart_repository_id]
optional , nil erlaubt

Repository Id associated with the kickstart repo used for provisioning

Validations:

  • Integer

host[subscription_facet_attributes]
optional , nil erlaubt

Parameters for host's subscription_facet facet

Validations:

  • Hash

host[subscription_facet_attributes][release_version]
optional , nil erlaubt

Release version for this Host to use (7Server, 7.1, etc)

Validations:

  • String

host[subscription_facet_attributes][autoheal]
optional , nil erlaubt

Sets whether the Host will autoheal subscriptions upon checkin

Validations:

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

host[subscription_facet_attributes][purpose_usage]
optional , nil erlaubt

Sets the system purpose usage

Validations:

  • String

host[subscription_facet_attributes][purpose_role]
optional , nil erlaubt

Sets the system purpose usage

Validations:

  • String

host[subscription_facet_attributes][purpose_addons]
optional , nil erlaubt

Sets the system add-ons

Validations:

  • Must be an array of any type

host[subscription_facet_attributes][service_level]
optional , nil erlaubt

Service level to be used for autoheal

Validations:

  • String

host[subscription_facet_attributes][hypervisor_guest_uuids]
optional , nil erlaubt

List of hypervisor guest uuids

Validations:

  • Must be an array of any type

host[subscription_facet_attributes][installed_products_attributes]
optional , nil erlaubt

List of products installed on the host

Validations:

  • Must be an Array of nested elements

host[subscription_facet_attributes][installed_products_attributes][product_id]
optional , nil erlaubt

Product id as listed from a host's installed products, this is not the same product id as the products api returns

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][product_name]
optional , nil erlaubt

Product name as listed from a host's installed products

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][arch]
optional , nil erlaubt

Product architecture

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][version]
optional , nil erlaubt

Product version

Validations:

  • String


PUT /api/hosts/:id
Host Aktualisieren

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Integer

id
verpflichtend

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

host
verpflichtend

Validations:

  • Hash

host[name]
optional

Validations:

  • String

host[location_id]
optional

Validations:

  • Must be a number.

host[organization_id]
optional

Validations:

  • Must be a number.

host[environment_id]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • String

host[ip]
optional , nil erlaubt

nicht erforderlich, wenn ein Subnetz mit DHCP-Proxy verwendet wird

Validations:

  • String

host[mac]
optional , nil erlaubt

erforderlich für Bare-Metal-Host, nicht erforderlich, wenn der Host eine virtuelle Maschine ist

Validations:

  • String

host[architecture_id]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • Must be a number.

host[domain_id]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • Must be a number.

host[realm_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[puppet_proxy_id]
optional , nil erlaubt

Puppet-Proxy Kennung

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
optional , nil erlaubt

Puppet-CA-Proxy Kennung

Validations:

  • Must be a number.

host[puppetclass_ids]
optional , nil erlaubt

Validations:

  • Must be an array of any type

host[config_group_ids]
optional , nil erlaubt

Kennungen von zugehörigen Konfigurationsgruppen

Validations:

  • Must be an array of any type

host[operatingsystem_id]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • String

host[medium_id]
optional , nil erlaubt

erforderlich, wenn die Bereitstellung nicht image-basiert, der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • String

host[pxe_loader]
optional , nil erlaubt

DHCP-Dateinamensoption (Standardmäßig Grub2/PXELinux)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 BIOS, Grub2 ELF, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

host[ptable_id]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und keine spezifische Partition definiert ist

Validations:

  • Must be a number.

host[subnet_id]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • Must be a number.

host[compute_resource_id]
optional , nil erlaubt

“nil” bedeutet, dass es sich um einen Bare-Metal-Host handelt

Validations:

  • Must be a number.

host[root_pass]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe oder einem Standardpasswort in den Einstellungen vererbt ist

Validations:

  • String

host[model_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[hostgroup_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[owner_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[owner_type]
optional , nil erlaubt

Eigentümertyp des Hosts

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[host_parameters_attributes]
optional , nil erlaubt

Hostparameter (Array oder indizierter Hash)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
optional

Name des Parameters

Validations:

  • String

host[host_parameters_attributes][value]
optional

Parameterwert

Validations:

  • String

host[build]
optional , nil erlaubt

Validations:

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

host[enabled]
optional , nil erlaubt

Diesen Host in das Foreman-Reporting aufnehmen

Validations:

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

host[provision_method]
optional , nil erlaubt

Methode der Bereitstellung des Host

Validations:

  • Must be one of: build, image.

host[managed]
optional , nil erlaubt

True/False-Flag, ob ein Host gemanagt oder ungemanagt ist. Hinweis: Dieser Wert bestimmt außerdem, ob mehrere Parameter erforderlich sind oder nicht.

Validations:

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

host[progress_report_id]
optional , nil erlaubt

UUID zum Tracken des Status der Orchestrierungsaufgaben, GET /api/orchestration/:UUID/tasks

Validations:

  • String

host[comment]
optional , nil erlaubt

Weitere Informationen über diesen Host

Validations:

  • String

host[capabilities]
optional , nil erlaubt

Validations:

  • String

host[compute_profile_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[interfaces_attributes]
optional , nil erlaubt

Netzwerkschnittstelle des Hosts

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
optional , nil erlaubt

MAC-Adresse der Schnittstelle. Erforderlich für gemanagte Bare-Metal-Schnittstellen.

Validations:

  • String

host[interfaces_attributes][ip]
optional , nil erlaubt

IPv4-Adresse der Schnittstelle

Validations:

  • String

host[interfaces_attributes][ip6]
optional , nil erlaubt

IPv6-Adresse der Schnittstelle

Validations:

  • String

host[interfaces_attributes][type]
optional , nil erlaubt

Schnittstellentyp, z.B. BMC. Standard ist interface

Validations:

  • Must be one of: interface, bmc, bond, bridge.

host[interfaces_attributes][name]
optional , nil erlaubt

DNS-Name der Schnittstelle

Validations:

  • String

host[interfaces_attributes][subnet_id]
optional , nil erlaubt

Foreman Subnetz Kennung der IPv4 Schnittstelle

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
optional , nil erlaubt

Foreman Subnetz Kennung der IPv6 Schnittstelle

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
optional , nil erlaubt

Foreman-Domänen-Kennung der Schnittstelle. Erforderlich für Primärschnittstellen auf gemanagten Hosts.

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
optional , nil erlaubt

Gerätebezeichner, z.B. eth0 oder eth1.1

Validations:

  • String

host[interfaces_attributes][managed]
optional , nil erlaubt

Soll diese Schnittstelle über DHCP- und DNS-Smart-Proxy verwaltet werden, oder soll sie bei der Bereitstellung konfiguriert werden?

Validations:

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

host[interfaces_attributes][primary]
optional , nil erlaubt

Soll diese Schnittstelle zum Erstellen des FQDN des Hosts verwendet werden? Jeder gemanagte Host muss eine Primärschnittstelle aufweisen.

Validations:

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

host[interfaces_attributes][provision]
optional , nil erlaubt

Soll diese Schnittstelle für TFTP von PXELinux (oder SSH für image-basierte Hosts) verwendet werden? Jeder gemanagte Host muss eine Bereitstellungsschnittstelle aufweisen.

Validations:

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

host[interfaces_attributes][username]
optional , nil erlaubt

Nur für BMC-Schnittstellen.

Validations:

  • String

host[interfaces_attributes][password]
optional , nil erlaubt

Nur für BMC-Schnittstellen.

Validations:

  • String

host[interfaces_attributes][provider]
optional , nil erlaubt

Schnittstellen-Provider, z.B. IPMI. Nur für BMC-Schnittstellen.

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
optional , nil erlaubt

Alias oder VLAN-Gerät

Validations:

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

host[interfaces_attributes][tag]
optional , nil erlaubt

VLAN-Tag, dieses Atttribut hat Vorrang vor der Subnetz-VLAN-Kennung. Nur für virtuelle Schnittstellen.

Validations:

  • String

host[interfaces_attributes][mtu]
optional , nil erlaubt

MTU. Dieser Wert hat Vorrang über die Subnetz MTU.

Validations:

  • Integer

host[interfaces_attributes][attached_to]
optional , nil erlaubt

Kennung der Schnittstelle, zu der diese Schnittstelle gehört, z.B. eth1. Nur für virtuelle Schnittstellen.

Validations:

  • String

host[interfaces_attributes][mode]
optional , nil erlaubt

Bond-Modus der Schnittstelle, z.B. balance-rr. Ausschließlich für Bond-Schnittstellen.

Validations:

  • Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

host[interfaces_attributes][attached_devices]
optional , nil erlaubt

Kennungen von verbundenen Schnittstellen, z.B. `['eth1', 'eth2']`. Für Bond-Schnittstellen sind diese die Slaves. Nur für Bond- und Bridge-Schnittstellen.

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
optional , nil erlaubt

Durch Leerzeichen getrennte Optionen, z.B. miimon=100. Ausschließlich für Bond-Schnittstellen.

Validations:

  • String

host[interfaces_attributes][compute_attributes]
optional , nil erlaubt

Zusätzliche Rechenressourcen-spezifische Attribute für die Schnittstelle.

Validations:

  • Hash

host[compute_attributes]
optional , nil erlaubt

Zusätzliche Rechenressourcen-spezifische Attribute

Validations:

  • Hash

host[content_facet_attributes]
optional , nil erlaubt

Parameters for host's content_facet facet

Validations:

  • Hash

host[content_facet_attributes][content_view_id]
optional , nil erlaubt

Validations:

  • Integer

host[content_facet_attributes][lifecycle_environment_id]
optional , nil erlaubt

Validations:

  • Integer

host[content_facet_attributes][content_source_id]
optional , nil erlaubt

Validations:

  • Integer

host[content_facet_attributes][kickstart_repository_id]
optional , nil erlaubt

Repository Id associated with the kickstart repo used for provisioning

Validations:

  • Integer

host[subscription_facet_attributes]
optional , nil erlaubt

Parameters for host's subscription_facet facet

Validations:

  • Hash

host[subscription_facet_attributes][release_version]
optional , nil erlaubt

Release version for this Host to use (7Server, 7.1, etc)

Validations:

  • String

host[subscription_facet_attributes][autoheal]
optional , nil erlaubt

Sets whether the Host will autoheal subscriptions upon checkin

Validations:

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

host[subscription_facet_attributes][purpose_usage]
optional , nil erlaubt

Sets the system purpose usage

Validations:

  • String

host[subscription_facet_attributes][purpose_role]
optional , nil erlaubt

Sets the system purpose usage

Validations:

  • String

host[subscription_facet_attributes][purpose_addons]
optional , nil erlaubt

Sets the system add-ons

Validations:

  • Must be an array of any type

host[subscription_facet_attributes][service_level]
optional , nil erlaubt

Service level to be used for autoheal

Validations:

  • String

host[subscription_facet_attributes][hypervisor_guest_uuids]
optional , nil erlaubt

List of hypervisor guest uuids

Validations:

  • Must be an array of any type

host[subscription_facet_attributes][installed_products_attributes]
optional , nil erlaubt

List of products installed on the host

Validations:

  • Must be an Array of nested elements

host[subscription_facet_attributes][installed_products_attributes][product_id]
optional , nil erlaubt

Product id as listed from a host's installed products, this is not the same product id as the products api returns

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][product_name]
optional , nil erlaubt

Product name as listed from a host's installed products

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][arch]
optional , nil erlaubt

Product architecture

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][version]
optional , nil erlaubt

Product version

Validations:

  • String


DELETE /api/hosts/:id
Host löschen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Integer

id
verpflichtend

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..


GET /api/hosts/:id/enc
ENC Werte des Host abrufen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


GET /api/hosts/:id/status
Konfigurationsstatus des Hosts abholen

Return value may either be one of the following:

  • Alerts disabled

  • No reports

  • Error

  • Out of sync

  • Active

  • Pending

  • No changes

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


GET /api/hosts/:id/status/:type
Hoststatus abholen

Returns string representing a host status of a given type

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

type
verpflichtend

Statustyp, einer von

  • Global

  • Konfiguration

  • Build

Validations:

  • Must be one of: HostStatus::Global, configuration, build.


GET /api/hosts/:id/vm_compute_attributes
VM-Attribute des Hosts abrufen

Return the host's compute attributes that can be used to create a clone of this VM

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


PUT /api/hosts/:id/disassociate
Host von einer VM lösen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


PUT /api/hosts/:id/power
Power-Operation auf Host ausführen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

power_action
verpflichtend

Energieaktion, gültige Aktionen sind (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)

Validations:

  • String


GET /api/hosts/:id/power
Status, ob der Host an oder aus ist anziehen. Unterstützte Hosts sind VMs und physische Hosts BMCs.

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


PUT /api/hosts/:id/boot
Host von angegebenem Gerät starten

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

device
verpflichtend

Boot Device, gültige Geräte sind Festplatte, CD-Rom, PXE, BIOS

Validations:

  • String


POST /api/hosts/facts
Fakten für einen Host hochladen mit Erstellung des Hosts, wenn erforderlich

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Integer

name
verpflichtend

Hostname des Hosts

Validations:

  • String

facts
verpflichtend

Hash, der die Fakten für den Host enthält

Validations:

  • Hash

certname
optional

optional: Certname des Hosts

Validations:

  • String

type
optional

optional: der STI-Typ des zu erstellenden Hosts

Validations:

  • String


PUT /api/hosts/:id/rebuild_config
Orchestrierungs-Konfig neu erstellen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

only
optional

Limit rebuild steps, valid steps are DHCP, DNS, TFTP

Validations:

  • Must be an array of any type


GET /api/hosts/:id/template/:kind
Inhaltsvorschau der gerenderten Bereitstellungsvorlage

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

kind
verpflichtend

Vorlagenarten, verfügbare Werte:

Validations:

  • String


PUT /api/hosts/:host_id/host_collections
Alter a hosts host collections

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Integer

host_id
verpflichtend

The id of the host to alter

Validations:

  • Must be a number.

host_collection_ids
verpflichtend

List of host collection ids to update

Validations:

  • Must be an array of any type