Parametername | Beschreibung |
---|---|
thin optional |
Nur Kennung und Namen von Hosts auflisten Validations:
|
hostgroup_id optional |
Kennung der Hostgruppe Validations:
|
location_id optional |
Standortkennung Validations:
|
organization_id optional |
Kennung der Organisation Validations:
|
environment_id optional |
Umgebungskennung Validations:
|
include optional |
Array of extra information types to include Validations:
|
search optional |
Ergebnisse filtern Validations:
|
order optional |
Sort field and order, eg. ‘id DESC’ Validations:
|
page optional |
Ergebnisse nummerieren Validations:
|
per_page optional |
Anzahl der Einträge pro Anfrage Validations:
|
Feld Name | Typ | Mögliche Werte |
---|---|---|
ansible_role | string | |
architecture | string | |
build | true, false | |
class | string | |
comment | text | |
compute_resource | string | |
compute_resource_id | integer | |
config_group | string | |
domain | string | |
domain_id | integer | |
environment | string | |
execution_status | ok, error | |
facts | string | |
global_status | ok, warning, error | |
has_ip | string | |
has_mac | string | |
hostgroup | string | |
hostgroup_fullname | string | |
hostgroup_id | integer | |
hostgroup_name | string | |
hostgroup_title | string | |
image | string | |
installed_at | datetime | |
ip | string | |
job_invocation.id | string | |
job_invocation.result | cancelled, failed, pending, success | |
last_report | datetime | |
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 | |
realm | string | |
realm_id | integer | |
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 | |
user.firstname | string | |
user.lastname | string | |
user.login | string | |
user.mail | string | |
usergroup | string | |
usergroup.name | string | |
uuid | string |
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
show_hidden_parameters optional |
Versteckte Parameter Werte anzeigen Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
host verpflichtend |
Validations:
|
host[name] verpflichtend |
Validations:
|
host[location_id] verpflichtend |
erforderlich, wenn Standorte aktiviert sind Validations:
|
host[organization_id] verpflichtend |
erforderlich, wenn Organisationen aktiviert sind Validations:
|
host[environment_id] optional , nil erlaubt |
erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist Validations:
|
host[ip] optional , nil erlaubt |
nicht erforderlich, wenn ein Subnetz mit DHCP-Proxy verwendet wird Validations:
|
host[mac] optional , nil erlaubt |
erforderlich für Bare-Metal-Host, nicht erforderlich, wenn der Host eine virtuelle Maschine ist Validations:
|
host[architecture_id] optional , nil erlaubt |
erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist Validations:
|
host[domain_id] optional , nil erlaubt |
erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist Validations:
|
host[realm_id] optional , nil erlaubt |
Validations:
|
host[puppet_proxy_id] optional , nil erlaubt |
Puppet-Proxy Kennung Validations:
|
host[puppet_ca_proxy_id] optional , nil erlaubt |
Puppet-CA-Proxy Kennung Validations:
|
host[puppetclass_ids] optional , nil erlaubt |
Validations:
|
host[config_group_ids] optional , nil erlaubt |
Kennungen von zugehörigen Konfigurationsgruppen Validations:
|
host[operatingsystem_id] optional , nil erlaubt |
erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist Validations:
|
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:
|
host[pxe_loader] optional , nil erlaubt |
DHCP-Dateinamensoption (Standardmäßig Grub2/PXELinux) Validations:
|
host[ptable_id] optional , nil erlaubt |
erforderlich, wenn der Host gemanagt und keine spezifische Partition definiert ist Validations:
|
host[subnet_id] optional , nil erlaubt |
erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist Validations:
|
host[compute_resource_id] optional , nil erlaubt |
“nil” bedeutet, dass es sich um einen Bare-Metal-Host handelt Validations:
|
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:
|
host[model_id] optional , nil erlaubt |
Validations:
|
host[hostgroup_id] optional , nil erlaubt |
Validations:
|
host[owner_id] optional , nil erlaubt |
Validations:
|
host[owner_type] optional , nil erlaubt |
Eigentümertyp des Hosts Validations:
|
host[image_id] optional , nil erlaubt |
Validations:
|
host[host_parameters_attributes] optional , nil erlaubt |
Hostparameter (Array oder indizierter Hash) Validations:
|
host[host_parameters_attributes][name] verpflichtend |
Name des Parameters Validations:
|
host[host_parameters_attributes][value] verpflichtend |
Parameterwert Validations:
|
host[build] optional , nil erlaubt |
Validations:
|
host[enabled] optional , nil erlaubt |
Diesen Host in das Foreman-Reporting aufnehmen Validations:
|
host[provision_method] optional , nil erlaubt |
Methode der Bereitstellung des Host Validations:
|
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:
|
host[progress_report_id] optional , nil erlaubt |
UUID zum Tracken des Status der Orchestrierungsaufgaben, GET /api/orchestration/:UUID/tasks Validations:
|
host[comment] optional , nil erlaubt |
Weitere Informationen über diesen Host Validations:
|
host[capabilities] optional , nil erlaubt |
Validations:
|
host[compute_profile_id] optional , nil erlaubt |
Validations:
|
host[interfaces_attributes] optional , nil erlaubt |
Netzwerkschnittstelle des Hosts Validations:
|
host[interfaces_attributes][mac] optional , nil erlaubt |
MAC-Adresse der Schnittstelle. Erforderlich für gemanagte Bare-Metal-Schnittstellen. Validations:
|
host[interfaces_attributes][ip] optional , nil erlaubt |
IPv4-Adresse der Schnittstelle Validations:
|
host[interfaces_attributes][ip6] optional , nil erlaubt |
IPv6-Adresse der Schnittstelle Validations:
|
host[interfaces_attributes][type] optional , nil erlaubt |
Schnittstellentyp, z.B. BMC. Standard ist interface Validations:
|
host[interfaces_attributes][name] optional , nil erlaubt |
DNS-Name der Schnittstelle Validations:
|
host[interfaces_attributes][subnet_id] optional , nil erlaubt |
Foreman Subnetz Kennung der IPv4 Schnittstelle Validations:
|
host[interfaces_attributes][subnet6_id] optional , nil erlaubt |
Foreman Subnetz Kennung der IPv6 Schnittstelle Validations:
|
host[interfaces_attributes][domain_id] optional , nil erlaubt |
Foreman-Domänen-Kennung der Schnittstelle. Erforderlich für Primärschnittstellen auf gemanagten Hosts. Validations:
|
host[interfaces_attributes][identifier] optional , nil erlaubt |
Gerätebezeichner, z.B. eth0 oder eth1.1 Validations:
|
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:
|
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:
|
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:
|
host[interfaces_attributes][username] optional , nil erlaubt |
Nur für BMC-Schnittstellen. Validations:
|
host[interfaces_attributes][password] optional , nil erlaubt |
Nur für BMC-Schnittstellen. Validations:
|
host[interfaces_attributes][provider] optional , nil erlaubt |
Schnittstellen-Provider, z.B. IPMI. Nur für BMC-Schnittstellen. Validations:
|
host[interfaces_attributes][virtual] optional , nil erlaubt |
Alias oder VLAN-Gerät Validations:
|
host[interfaces_attributes][tag] optional , nil erlaubt |
VLAN-Tag, dieses Atttribut hat Vorrang vor der Subnetz-VLAN-Kennung. Nur für virtuelle Schnittstellen. Validations:
|
host[interfaces_attributes][mtu] optional , nil erlaubt |
MTU. Dieser Wert hat Vorrang über die Subnetz MTU. Validations:
|
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:
|
host[interfaces_attributes][mode] optional , nil erlaubt |
Bond-Modus der Schnittstelle, z.B. balance-rr. Ausschließlich für Bond-Schnittstellen. Validations:
|
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:
|
host[interfaces_attributes][bond_options] optional , nil erlaubt |
Durch Leerzeichen getrennte Optionen, z.B. miimon=100. Ausschließlich für Bond-Schnittstellen. Validations:
|
host[interfaces_attributes][compute_attributes] optional , nil erlaubt |
Zusätzliche Rechenressourcen-spezifische Attribute für die Schnittstelle. Validations:
|
host[compute_attributes] optional , nil erlaubt |
Zusätzliche Rechenressourcen-spezifische Attribute Validations:
|
host[ansible_role_ids] optional |
IDs of associated ansible roles Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
host verpflichtend |
Validations:
|
host[name] optional |
Validations:
|
host[location_id] optional |
erforderlich, wenn Standorte aktiviert sind Validations:
|
host[organization_id] optional |
erforderlich, wenn Organisationen aktiviert sind Validations:
|
host[environment_id] optional , nil erlaubt |
erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist Validations:
|
host[ip] optional , nil erlaubt |
nicht erforderlich, wenn ein Subnetz mit DHCP-Proxy verwendet wird Validations:
|
host[mac] optional , nil erlaubt |
erforderlich für Bare-Metal-Host, nicht erforderlich, wenn der Host eine virtuelle Maschine ist Validations:
|
host[architecture_id] optional , nil erlaubt |
erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist Validations:
|
host[domain_id] optional , nil erlaubt |
erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist Validations:
|
host[realm_id] optional , nil erlaubt |
Validations:
|
host[puppet_proxy_id] optional , nil erlaubt |
Puppet-Proxy Kennung Validations:
|
host[puppet_ca_proxy_id] optional , nil erlaubt |
Puppet-CA-Proxy Kennung Validations:
|
host[puppetclass_ids] optional , nil erlaubt |
Validations:
|
host[config_group_ids] optional , nil erlaubt |
Kennungen von zugehörigen Konfigurationsgruppen Validations:
|
host[operatingsystem_id] optional , nil erlaubt |
erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist Validations:
|
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:
|
host[pxe_loader] optional , nil erlaubt |
DHCP-Dateinamensoption (Standardmäßig Grub2/PXELinux) Validations:
|
host[ptable_id] optional , nil erlaubt |
erforderlich, wenn der Host gemanagt und keine spezifische Partition definiert ist Validations:
|
host[subnet_id] optional , nil erlaubt |
erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist Validations:
|
host[compute_resource_id] optional , nil erlaubt |
“nil” bedeutet, dass es sich um einen Bare-Metal-Host handelt Validations:
|
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:
|
host[model_id] optional , nil erlaubt |
Validations:
|
host[hostgroup_id] optional , nil erlaubt |
Validations:
|
host[owner_id] optional , nil erlaubt |
Validations:
|
host[owner_type] optional , nil erlaubt |
Eigentümertyp des Hosts Validations:
|
host[image_id] optional , nil erlaubt |
Validations:
|
host[host_parameters_attributes] optional , nil erlaubt |
Hostparameter (Array oder indizierter Hash) Validations:
|
host[host_parameters_attributes][name] optional |
Name des Parameters Validations:
|
host[host_parameters_attributes][value] optional |
Parameterwert Validations:
|
host[build] optional , nil erlaubt |
Validations:
|
host[enabled] optional , nil erlaubt |
Diesen Host in das Foreman-Reporting aufnehmen Validations:
|
host[provision_method] optional , nil erlaubt |
Methode der Bereitstellung des Host Validations:
|
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:
|
host[progress_report_id] optional , nil erlaubt |
UUID zum Tracken des Status der Orchestrierungsaufgaben, GET /api/orchestration/:UUID/tasks Validations:
|
host[comment] optional , nil erlaubt |
Weitere Informationen über diesen Host Validations:
|
host[capabilities] optional , nil erlaubt |
Validations:
|
host[compute_profile_id] optional , nil erlaubt |
Validations:
|
host[interfaces_attributes] optional , nil erlaubt |
Netzwerkschnittstelle des Hosts Validations:
|
host[interfaces_attributes][mac] optional , nil erlaubt |
MAC-Adresse der Schnittstelle. Erforderlich für gemanagte Bare-Metal-Schnittstellen. Validations:
|
host[interfaces_attributes][ip] optional , nil erlaubt |
IPv4-Adresse der Schnittstelle Validations:
|
host[interfaces_attributes][ip6] optional , nil erlaubt |
IPv6-Adresse der Schnittstelle Validations:
|
host[interfaces_attributes][type] optional , nil erlaubt |
Schnittstellentyp, z.B. BMC. Standard ist interface Validations:
|
host[interfaces_attributes][name] optional , nil erlaubt |
DNS-Name der Schnittstelle Validations:
|
host[interfaces_attributes][subnet_id] optional , nil erlaubt |
Foreman Subnetz Kennung der IPv4 Schnittstelle Validations:
|
host[interfaces_attributes][subnet6_id] optional , nil erlaubt |
Foreman Subnetz Kennung der IPv6 Schnittstelle Validations:
|
host[interfaces_attributes][domain_id] optional , nil erlaubt |
Foreman-Domänen-Kennung der Schnittstelle. Erforderlich für Primärschnittstellen auf gemanagten Hosts. Validations:
|
host[interfaces_attributes][identifier] optional , nil erlaubt |
Gerätebezeichner, z.B. eth0 oder eth1.1 Validations:
|
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:
|
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:
|
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:
|
host[interfaces_attributes][username] optional , nil erlaubt |
Nur für BMC-Schnittstellen. Validations:
|
host[interfaces_attributes][password] optional , nil erlaubt |
Nur für BMC-Schnittstellen. Validations:
|
host[interfaces_attributes][provider] optional , nil erlaubt |
Schnittstellen-Provider, z.B. IPMI. Nur für BMC-Schnittstellen. Validations:
|
host[interfaces_attributes][virtual] optional , nil erlaubt |
Alias oder VLAN-Gerät Validations:
|
host[interfaces_attributes][tag] optional , nil erlaubt |
VLAN-Tag, dieses Atttribut hat Vorrang vor der Subnetz-VLAN-Kennung. Nur für virtuelle Schnittstellen. Validations:
|
host[interfaces_attributes][mtu] optional , nil erlaubt |
MTU. Dieser Wert hat Vorrang über die Subnetz MTU. Validations:
|
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:
|
host[interfaces_attributes][mode] optional , nil erlaubt |
Bond-Modus der Schnittstelle, z.B. balance-rr. Ausschließlich für Bond-Schnittstellen. Validations:
|
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:
|
host[interfaces_attributes][bond_options] optional , nil erlaubt |
Durch Leerzeichen getrennte Optionen, z.B. miimon=100. Ausschließlich für Bond-Schnittstellen. Validations:
|
host[interfaces_attributes][compute_attributes] optional , nil erlaubt |
Zusätzliche Rechenressourcen-spezifische Attribute für die Schnittstelle. Validations:
|
host[compute_attributes] optional , nil erlaubt |
Zusätzliche Rechenressourcen-spezifische Attribute Validations:
|
host[ansible_role_ids] optional |
IDs of associated ansible roles Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
Return value may either be one of the following:
Alerts disabled
No reports
Error
Out of sync
Active
Pending
No changes
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
Returns string representing a host status of a given type
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
type verpflichtend |
Statustyp, einer von
Validations:
|
Return the host's compute attributes that can be used to create a clone of this VM
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
power_action verpflichtend |
Energieaktion, gültige Aktionen sind (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status) Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
device verpflichtend |
Boot Device, gültige Geräte sind Festplatte, CD-Rom, PXE, BIOS Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
name verpflichtend |
Hostname des Hosts Validations:
|
facts verpflichtend |
Hash, der die Fakten für den Host enthält Validations:
|
certname optional |
optional: Certname des Hosts Validations:
|
type optional |
optional: der STI-Typ des zu erstellenden Hosts Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
only optional |
Limit rebuild steps, valid steps are DHCP, DNS, TFTP Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
kind verpflichtend |
Vorlagenarten, verfügbare Werte: Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
host_ids verpflichtend |
IDs of hosts to play roles on Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
Parametername | Beschreibung |
---|---|
location_id optional |
Scope nach Standorten Validations:
|
organization_id optional |
Scope nach Organisationen Validations:
|
id verpflichtend |
Validations:
|
ansible_role_ids verpflichtend |
Ansible roles to assign to a host Validations:
|