Param Name | Description |
---|---|
hostgroup_id Optional |
Id. del grup d'amfitrions Validations:
|
location_id Optional |
id. de la ubicació Validations:
|
organization_id Optional |
id. de l'organització Validations:
|
environment_id Optional |
id. de l'entorn Validations:
|
search Optional |
filtra els resultats Validations:
|
order Optional |
ordena els resultats Validations:
|
page Optional |
pagina els resultats Validations:
|
per_page Optional |
Nombre d'entrades per petició Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|
Param Name | Description |
---|---|
host Required |
Validations:
|
host[name] Required |
Validations:
|
host[location_id] Required |
es requereix si les ubicacions estan habilitades Validations:
|
host[organization_id] Required |
es requereix si les organitzacions estan habilitades Validations:
|
host[environment_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
required if host is managed and value is not inherited from host group Validations:
|
host[ip] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
no es requereix si s'està utilitzant una subxarxa amb servidor intermediari de DHCP Validations:
|
host[mac] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
required for managed host that is bare metal, not required if it's a virtual machine Validations:
|
host[architecture_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
required if host is managed and value is not inherited from host group Validations:
|
host[domain_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
required if host is managed and value is not inherited from host group Validations:
|
host[realm_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[puppet_proxy_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[puppetclass_ids] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[operatingsystem_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
required if host is managed and value is not inherited from host group Validations:
|
host[medium_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
required if not imaged based provisioning and host is managed and value is not inherited from host group Validations:
|
host[ptable_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
es requereix si l'amfitrió està gestionat i no s'ha definit la partició personalitzada Validations:
|
host[subnet_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
required if host is managed and value is not inherited from host group Validations:
|
host[compute_resource_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
nil means host is bare metal Validations:
|
host[root_pass] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
required if host is managed and value is not inherited from host group or default password in settings Validations:
|
host[model_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[hostgroup_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[owner_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[owner_type] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Tipus de propietari de l'amfitrió Validations:
|
host[puppet_ca_proxy_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[image_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[host_parameters_attributes] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Host's parameters (array or indexed hash) Validations:
|
host[host_parameters_attributes][name] Required |
Nom del paràmetre Validations:
|
host[host_parameters_attributes][value] Required |
Valor del paràmetre Validations:
|
host[build] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[enabled] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[provision_method] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
The method used to provision the host. Possible provision_methods may be build (Network Based), image (Image Based) Validations:
|
host[managed] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks Validations:
|
host[comment] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Informació addicional quant a aquest amfitrió Validations:
|
host[capabilities] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[compute_profile_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[interfaces_attributes] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Les interfícies de xarxa dels amfitrions. Validations:
|
host[interfaces_attributes][mac] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
MAC address of interface. Required for managed interfaces on bare metal. Validations:
|
host[interfaces_attributes][ip] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Adreça IP de la interfície Validations:
|
host[interfaces_attributes][type] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Interface type, e.g. bmc. Default is interface Validations:
|
host[interfaces_attributes][name] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Nom DNS de la interfície Validations:
|
host[interfaces_attributes][subnet_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Foreman subnet ID of interface Validations:
|
host[interfaces_attributes][domain_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Foreman domain ID of interface. Required for primary interfaces on managed hosts. Validations:
|
host[interfaces_attributes][identifier] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
L'identificador de dispositiu, p. ex. eth0 o eth1.1 Validations:
|
host[interfaces_attributes][managed] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning? Validations:
|
host[interfaces_attributes][primary] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Només per a les interfícies BMC. Validations:
|
host[interfaces_attributes][password] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Només per a les interfícies BMC. Validations:
|
host[interfaces_attributes][provider] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Interface provider, e.g. IPMI. Only for BMC interfaces. Validations:
|
host[interfaces_attributes][virtual] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Àlies o dispositiu VLAN Validations:
|
host[interfaces_attributes][tag] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces. Validations:
|
host[interfaces_attributes][attached_to] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces. Validations:
|
host[interfaces_attributes][mode] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Bond mode of the interface, e.g. balance-rr. Only for bond interfaces. Validations:
|
host[interfaces_attributes][attached_devices] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Space separated options, e.g. miimon=100. Only for bond interfaces. Validations:
|
host[interfaces_attributes][compute_attributes] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Additional compute resource specific attributes for the interface. Validations:
|
host[compute_attributes] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Additional compute resource specific attributes. Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|
host Required |
Validations:
|
host[name] Optional |
Validations:
|
host[location_id] Optional |
es requereix si les ubicacions estan habilitades Validations:
|
host[organization_id] Optional |
es requereix si les organitzacions estan habilitades Validations:
|
host[environment_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
required if host is managed and value is not inherited from host group Validations:
|
host[ip] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
no es requereix si s'està utilitzant una subxarxa amb servidor intermediari de DHCP Validations:
|
host[mac] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
required for managed host that is bare metal, not required if it's a virtual machine Validations:
|
host[architecture_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
required if host is managed and value is not inherited from host group Validations:
|
host[domain_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
required if host is managed and value is not inherited from host group Validations:
|
host[realm_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[puppet_proxy_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[puppetclass_ids] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[operatingsystem_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
required if host is managed and value is not inherited from host group Validations:
|
host[medium_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
required if not imaged based provisioning and host is managed and value is not inherited from host group Validations:
|
host[ptable_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
es requereix si l'amfitrió està gestionat i no s'ha definit la partició personalitzada Validations:
|
host[subnet_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
required if host is managed and value is not inherited from host group Validations:
|
host[compute_resource_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
nil means host is bare metal Validations:
|
host[root_pass] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
required if host is managed and value is not inherited from host group or default password in settings Validations:
|
host[model_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[hostgroup_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[owner_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[owner_type] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Tipus de propietari de l'amfitrió Validations:
|
host[puppet_ca_proxy_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[image_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[host_parameters_attributes] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Host's parameters (array or indexed hash) Validations:
|
host[host_parameters_attributes][name] Optional |
Nom del paràmetre Validations:
|
host[host_parameters_attributes][value] Optional |
Valor del paràmetre Validations:
|
host[build] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[enabled] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[provision_method] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
The method used to provision the host. Possible provision_methods may be build (Network Based), image (Image Based) Validations:
|
host[managed] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks Validations:
|
host[comment] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Informació addicional quant a aquest amfitrió Validations:
|
host[capabilities] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[compute_profile_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
host[interfaces_attributes] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Les interfícies de xarxa dels amfitrions. Validations:
|
host[interfaces_attributes][mac] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
MAC address of interface. Required for managed interfaces on bare metal. Validations:
|
host[interfaces_attributes][ip] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Adreça IP de la interfície Validations:
|
host[interfaces_attributes][type] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Interface type, e.g. bmc. Default is interface Validations:
|
host[interfaces_attributes][name] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Nom DNS de la interfície Validations:
|
host[interfaces_attributes][subnet_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Foreman subnet ID of interface Validations:
|
host[interfaces_attributes][domain_id] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Foreman domain ID of interface. Required for primary interfaces on managed hosts. Validations:
|
host[interfaces_attributes][identifier] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
L'identificador de dispositiu, p. ex. eth0 o eth1.1 Validations:
|
host[interfaces_attributes][managed] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning? Validations:
|
host[interfaces_attributes][primary] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Només per a les interfícies BMC. Validations:
|
host[interfaces_attributes][password] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Només per a les interfícies BMC. Validations:
|
host[interfaces_attributes][provider] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Interface provider, e.g. IPMI. Only for BMC interfaces. Validations:
|
host[interfaces_attributes][virtual] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Àlies o dispositiu VLAN Validations:
|
host[interfaces_attributes][tag] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces. Validations:
|
host[interfaces_attributes][attached_to] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces. Validations:
|
host[interfaces_attributes][mode] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Bond mode of the interface, e.g. balance-rr. Only for bond interfaces. Validations:
|
host[interfaces_attributes][attached_devices] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Space separated options, e.g. miimon=100. Only for bond interfaces. Validations:
|
host[interfaces_attributes][compute_attributes] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Additional compute resource specific attributes for the interface. Validations:
|
host[compute_attributes] Optional , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span> |
Additional compute resource specific attributes. Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|
Return value may either be one of the following:
missing
failed
pending
changed
unchanged
unreported
Param Name | Description |
---|---|
id Required |
Validations:
|
Returns string representing a host status of a given type
Param Name | Description |
---|---|
id Required |
Validations:
|
type Required |
status type, can be one of
Validations:
|
Return the host's compute attributes that can be used to create a clone of this VM
Param Name | Description |
---|---|
id Required |
Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|
power_action Required |
power action, valid actions are (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status) Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|
device Required |
boot device, valid devices are disk, cdrom, pxe, bios Validations:
|
Param Name | Description |
---|---|
name Required |
nom d'amfitrió de l'amfitrió Validations:
|
facts Required |
el hash que conté els objectes d'interès per a l'amfitrió Validations:
|
certname Optional |
optional: certname of the host Validations:
|
type Optional |
optional: the STI type of host to create Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|
Param Name | Description |
---|---|
id Required |
Validations:
|
kind Required |
Template kinds, available values: Validations:
|