Nombre del parámetro | Descripción |
---|---|
thin opcional |
Solo mencionar ID y nombre de hosts Validations:
|
hostgroup_id opcional |
ID del grupo de hosts Validations:
|
location_id opcional |
ID de la ubicación Validations:
|
organization_id opcional |
ID de la organización Validations:
|
environment_id opcional |
ID del entorno Validations:
|
include opcional |
Serie de tipos de información adicionales para incluir Validations:
|
search opcional |
filtrar resultados Validations:
|
order opcional |
Orden y campo de clasificación, p. ej., 'id DESC' Validations:
|
page opcional |
Número de página, comenzando por 1 Validations:
|
per_page opcional |
Número de resultados por página para devolver Validations:
|
Nombre del campo | Tipo | Valores posibles |
---|---|---|
architecture | ||
boot_time | ||
build | true, false | |
class | string | |
comment | ||
compute_resource | ||
compute_resource_id | ||
config_group | string | |
created_at | ||
domain | ||
domain_id | ||
environment | ||
facts | string | |
global_status | ok, warning, error | |
has_ip | ||
has_mac | ||
hostgroup | ||
hostgroup_fullname | ||
hostgroup_id | ||
hostgroup_name | ||
hostgroup_title | ||
image | ||
installed_at | ||
ip | ||
last_report | ||
location | ||
location_id | ||
mac | ||
managed | true, false | |
model | ||
name | ||
organization | ||
organization_id | ||
origin | ||
os | ||
os_description | ||
os_id | ||
os_major | string | |
os_minor | string | |
os_title | ||
owner | string | |
owner_id | ||
owner_type | ||
params | string | |
params_name | ||
parent_hostgroup | string | |
puppet_ca | ||
puppet_proxy_id | ||
puppetmaster | ||
realm | ||
realm_id | ||
smart_proxy | string | |
status.applied | ||
status.enabled | true, false | |
status.failed | ||
status.failed_restarts | ||
status.interesting | true, false | |
status.pending | ||
status.restarted | ||
status.skipped | ||
subnet | ||
subnet.name | ||
subnet6 | ||
subnet6.name | ||
user.firstname | string | |
user.lastname | string | |
user.login | string | |
user.mail | string | |
usergroup | ||
usergroup.name | ||
uuid |
Nombre del parámetro | Descripción |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
show_hidden_parameters opcional |
Mostrar valores de parámetros ocultos Validations:
|
Nombre del parámetro | Descripción |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
host requerido |
Validations:
|
host[name] requerido |
Validations:
|
host[location_id] requerido |
Validations:
|
host[organization_id] requerido |
Validations:
|
host[environment_id] opcional , nil permitido |
obligatorio si los hosts están administrados y el valor no se ha heredado de un grupo de hosts Validations:
|
host[ip] opcional , nil permitido |
no es necesario si se usa una subred con un proxy DHCP Validations:
|
host[mac] opcional , nil permitido |
obligatorio para hosts administrados bare metal, no se requiere para máquinas virtuales Validations:
|
host[architecture_id] opcional , nil permitido |
obligatorio si los hosts están administrados y el valor no se ha heredado de un grupo de hosts Validations:
|
host[domain_id] opcional , nil permitido |
obligatorio si los hosts están administrados y el valor no se ha heredado de un grupo de hosts Validations:
|
host[realm_id] opcional , nil permitido |
Validations:
|
host[puppet_proxy_id] opcional , nil permitido |
ID del Proxy Puppet Validations:
|
host[puppet_ca_proxy_id] opcional , nil permitido |
ID del Proxy Puppet CA Validations:
|
host[puppetclass_ids] opcional , nil permitido |
Validations:
|
host[config_group_ids] opcional , nil permitido |
ID de grupos de configuración asociados Validations:
|
host[operatingsystem_id] opcional , nil permitido |
obligatorio si los hosts están administrados y el valor no se ha heredado de un grupo de hosts Validations:
|
host[medium_id] opcional , nil permitido |
obligatorio si el aprovisionamiento no se basa en imágenes, el host está administrado y el valor no se hereda de un grupo de hosts Validations:
|
host[pxe_loader] opcional , nil permitido |
Opción de nombre de archivo DHCP (Grub2/PXELinux por defecto) Validations:
|
host[ptable_id] opcional , nil permitido |
obligatorio si el host está administrado y no se han definido particiones personalizadas Validations:
|
host[subnet_id] opcional , nil permitido |
obligatorio si los hosts están administrados y el valor no se ha heredado de un grupo de hosts Validations:
|
host[compute_resource_id] opcional , nil permitido |
nil implica que el host es bare metal Validations:
|
host[root_pass] opcional , nil permitido |
obligatorio si el host está administrado y el valor no se hereda de un grupo de hosts o contraseñas predeterminadas en parámetros Validations:
|
host[model_id] opcional , nil permitido |
Validations:
|
host[hostgroup_id] opcional , nil permitido |
Validations:
|
host[owner_id] opcional , nil permitido |
Validations:
|
host[owner_type] opcional , nil permitido |
Tipo de propietario de host Validations:
|
host[image_id] opcional , nil permitido |
Validations:
|
host[host_parameters_attributes] opcional , nil permitido |
Parámetros del host (array o hash indexado) Validations:
|
host[host_parameters_attributes][name] requerido |
Nombre del parámetro Validations:
|
host[host_parameters_attributes][value] requerido |
Valor del parámetro Validations:
|
host[host_parameters_attributes][parameter_type] opcional , nil permitido |
Type of value Validations:
|
host[host_parameters_attributes][hidden_value] opcional , nil permitido |
Validations:
|
host[build] opcional , nil permitido |
Validations:
|
host[enabled] opcional , nil permitido |
Incluir este host en el informe de Foreman Validations:
|
host[provision_method] opcional , nil permitido |
El método utilizado para aprovisionar el host. Validations:
|
host[managed] opcional , nil permitido |
Indicador verdadero/falso que indica si el host es administradoo no. Nota: este valor también determina si ciertos parámetros son obligatorios. Validations:
|
host[progress_report_id] opcional , nil permitido |
UUID para seguir el estado de la tarea de orquestación, GET /api/orchestration/:UUID/tasks Validations:
|
host[comment] opcional , nil permitido |
Información adicional sobre este host Validations:
|
host[capabilities] opcional , nil permitido |
Validations:
|
host[compute_profile_id] opcional , nil permitido |
Validations:
|
host[interfaces_attributes] opcional , nil permitido |
Interfaces de red del host Validations:
|
host[interfaces_attributes][mac] opcional , nil permitido |
Dirección MAC de la interfaz. Requerida para interfaces administradas bare metal. Validations:
|
host[interfaces_attributes][ip] opcional , nil permitido |
Dirección IPv4 de la interfaz Validations:
|
host[interfaces_attributes][ip6] opcional , nil permitido |
Dirección IPv6 de la interfaz Validations:
|
host[interfaces_attributes][type] opcional , nil permitido |
Tipo de interfaz, por ejemplo, bmc. El tipo predeterminado es interface Validations:
|
host[interfaces_attributes][name] opcional , nil permitido |
Nombre de DNS de la interfaz Validations:
|
host[interfaces_attributes][subnet_id] opcional , nil permitido |
ID de subred Foreman de la interfaz IPv4 Validations:
|
host[interfaces_attributes][subnet6_id] opcional , nil permitido |
ID de subred Foreman de la interfaz IPv6 Validations:
|
host[interfaces_attributes][domain_id] opcional , nil permitido |
ID del dominio de Foreman de la interfaz. Requerida para interfaces principales en hosts administrados. Validations:
|
host[interfaces_attributes][identifier] opcional , nil permitido |
Identificador de dispositivo, p.ej. eth0 o eth1.1 Validations:
|
host[interfaces_attributes][managed] opcional , nil permitido |
¿Debería esta interfaz ser administrada vía proxy inteligente DHCP y DNS y configurarse durante el aprovisionamiento? Validations:
|
host[interfaces_attributes][primary] opcional , nil permitido |
¿Debería ser usada esta interface para construir el FQDN del host? Cada host gestionado necesita tener una interfaz primaria. Validations:
|
host[interfaces_attributes][provision] opcional , nil permitido |
¿Debería ser usada esta interfaz para TFTP o PXELinux (o SSH para hosts basados en imágenes)? Cada host gestionado necesita tener una interfaz de provisión. Validations:
|
host[interfaces_attributes][username] opcional , nil permitido |
Solamente para interfaces BMC. Validations:
|
host[interfaces_attributes][password] opcional , nil permitido |
Solamente para interfaces BMC. Validations:
|
host[interfaces_attributes][provider] opcional , nil permitido |
Proveedor de interfaz, p.ej., IPMI. Solo para interfaces BMC. Validations:
|
host[interfaces_attributes][virtual] opcional , nil permitido |
Dispositivo VLAN o alias Validations:
|
host[interfaces_attributes][tag] opcional , nil permitido |
Etiqueta VLAN, este atributo tiene precedencia sobre la ID de subred VLAN. Solo para interfaces virtuales. Validations:
|
host[interfaces_attributes][mtu] opcional , nil permitido |
MTU, este atributo tiene precedencia sobre la MTU de subred. Validations:
|
host[interfaces_attributes][attached_to] opcional , nil permitido |
Identificador de la interfaz a la que pertenece esta interfaz, p.ej., eth1. Solo para interfaces virtuales. Validations:
|
host[interfaces_attributes][mode] opcional , nil permitido |
Modo de vinculación de la interfaz, p. ej,. balance-rr. Solo para interfaces de vínculo. Validations:
|
host[interfaces_attributes][attached_devices] opcional , nil permitido |
Identificadores de interfaces adjuntas, por ejemplo: `['eth1', 'eth2']`. Para las interfaces vinculadas son esclavos. Solo para interfaces vinculadas y puentes. Validations:
|
host[interfaces_attributes][bond_options] opcional , nil permitido |
Opciones separadas por espacios, p.ej miimon=100. Solo para interfaces de vínculo. Validations:
|
host[interfaces_attributes][compute_attributes] opcional , nil permitido |
Atributos adicionales específicos del recurso de computación para la interfaz. Validations:
|
host[compute_attributes] opcional , nil permitido |
Atributos adicionales específicos del recurso de computación Validations:
|
Nombre del parámetro | Descripción |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
host requerido |
Validations:
|
host[name] opcional |
Validations:
|
host[location_id] opcional |
Validations:
|
host[organization_id] opcional |
Validations:
|
host[environment_id] opcional , nil permitido |
obligatorio si los hosts están administrados y el valor no se ha heredado de un grupo de hosts Validations:
|
host[ip] opcional , nil permitido |
no es necesario si se usa una subred con un proxy DHCP Validations:
|
host[mac] opcional , nil permitido |
obligatorio para hosts administrados bare metal, no se requiere para máquinas virtuales Validations:
|
host[architecture_id] opcional , nil permitido |
obligatorio si los hosts están administrados y el valor no se ha heredado de un grupo de hosts Validations:
|
host[domain_id] opcional , nil permitido |
obligatorio si los hosts están administrados y el valor no se ha heredado de un grupo de hosts Validations:
|
host[realm_id] opcional , nil permitido |
Validations:
|
host[puppet_proxy_id] opcional , nil permitido |
ID del Proxy Puppet Validations:
|
host[puppet_ca_proxy_id] opcional , nil permitido |
ID del Proxy Puppet CA Validations:
|
host[puppetclass_ids] opcional , nil permitido |
Validations:
|
host[config_group_ids] opcional , nil permitido |
ID de grupos de configuración asociados Validations:
|
host[operatingsystem_id] opcional , nil permitido |
obligatorio si los hosts están administrados y el valor no se ha heredado de un grupo de hosts Validations:
|
host[medium_id] opcional , nil permitido |
obligatorio si el aprovisionamiento no se basa en imágenes, el host está administrado y el valor no se hereda de un grupo de hosts Validations:
|
host[pxe_loader] opcional , nil permitido |
Opción de nombre de archivo DHCP (Grub2/PXELinux por defecto) Validations:
|
host[ptable_id] opcional , nil permitido |
obligatorio si el host está administrado y no se han definido particiones personalizadas Validations:
|
host[subnet_id] opcional , nil permitido |
obligatorio si los hosts están administrados y el valor no se ha heredado de un grupo de hosts Validations:
|
host[compute_resource_id] opcional , nil permitido |
nil implica que el host es bare metal Validations:
|
host[root_pass] opcional , nil permitido |
obligatorio si el host está administrado y el valor no se hereda de un grupo de hosts o contraseñas predeterminadas en parámetros Validations:
|
host[model_id] opcional , nil permitido |
Validations:
|
host[hostgroup_id] opcional , nil permitido |
Validations:
|
host[owner_id] opcional , nil permitido |
Validations:
|
host[owner_type] opcional , nil permitido |
Tipo de propietario de host Validations:
|
host[image_id] opcional , nil permitido |
Validations:
|
host[host_parameters_attributes] opcional , nil permitido |
Parámetros del host (array o hash indexado) Validations:
|
host[host_parameters_attributes][name] opcional |
Nombre del parámetro Validations:
|
host[host_parameters_attributes][value] opcional |
Valor del parámetro Validations:
|
host[host_parameters_attributes][parameter_type] opcional , nil permitido |
Type of value Validations:
|
host[host_parameters_attributes][hidden_value] opcional , nil permitido |
Validations:
|
host[build] opcional , nil permitido |
Validations:
|
host[enabled] opcional , nil permitido |
Incluir este host en el informe de Foreman Validations:
|
host[provision_method] opcional , nil permitido |
El método utilizado para aprovisionar el host. Validations:
|
host[managed] opcional , nil permitido |
Indicador verdadero/falso que indica si el host es administradoo no. Nota: este valor también determina si ciertos parámetros son obligatorios. Validations:
|
host[progress_report_id] opcional , nil permitido |
UUID para seguir el estado de la tarea de orquestación, GET /api/orchestration/:UUID/tasks Validations:
|
host[comment] opcional , nil permitido |
Información adicional sobre este host Validations:
|
host[capabilities] opcional , nil permitido |
Validations:
|
host[compute_profile_id] opcional , nil permitido |
Validations:
|
host[interfaces_attributes] opcional , nil permitido |
Interfaces de red del host Validations:
|
host[interfaces_attributes][mac] opcional , nil permitido |
Dirección MAC de la interfaz. Requerida para interfaces administradas bare metal. Validations:
|
host[interfaces_attributes][ip] opcional , nil permitido |
Dirección IPv4 de la interfaz Validations:
|
host[interfaces_attributes][ip6] opcional , nil permitido |
Dirección IPv6 de la interfaz Validations:
|
host[interfaces_attributes][type] opcional , nil permitido |
Tipo de interfaz, por ejemplo, bmc. El tipo predeterminado es interface Validations:
|
host[interfaces_attributes][name] opcional , nil permitido |
Nombre de DNS de la interfaz Validations:
|
host[interfaces_attributes][subnet_id] opcional , nil permitido |
ID de subred Foreman de la interfaz IPv4 Validations:
|
host[interfaces_attributes][subnet6_id] opcional , nil permitido |
ID de subred Foreman de la interfaz IPv6 Validations:
|
host[interfaces_attributes][domain_id] opcional , nil permitido |
ID del dominio de Foreman de la interfaz. Requerida para interfaces principales en hosts administrados. Validations:
|
host[interfaces_attributes][identifier] opcional , nil permitido |
Identificador de dispositivo, p.ej. eth0 o eth1.1 Validations:
|
host[interfaces_attributes][managed] opcional , nil permitido |
¿Debería esta interfaz ser administrada vía proxy inteligente DHCP y DNS y configurarse durante el aprovisionamiento? Validations:
|
host[interfaces_attributes][primary] opcional , nil permitido |
¿Debería ser usada esta interface para construir el FQDN del host? Cada host gestionado necesita tener una interfaz primaria. Validations:
|
host[interfaces_attributes][provision] opcional , nil permitido |
¿Debería ser usada esta interfaz para TFTP o PXELinux (o SSH para hosts basados en imágenes)? Cada host gestionado necesita tener una interfaz de provisión. Validations:
|
host[interfaces_attributes][username] opcional , nil permitido |
Solamente para interfaces BMC. Validations:
|
host[interfaces_attributes][password] opcional , nil permitido |
Solamente para interfaces BMC. Validations:
|
host[interfaces_attributes][provider] opcional , nil permitido |
Proveedor de interfaz, p.ej., IPMI. Solo para interfaces BMC. Validations:
|
host[interfaces_attributes][virtual] opcional , nil permitido |
Dispositivo VLAN o alias Validations:
|
host[interfaces_attributes][tag] opcional , nil permitido |
Etiqueta VLAN, este atributo tiene precedencia sobre la ID de subred VLAN. Solo para interfaces virtuales. Validations:
|
host[interfaces_attributes][mtu] opcional , nil permitido |
MTU, este atributo tiene precedencia sobre la MTU de subred. Validations:
|
host[interfaces_attributes][attached_to] opcional , nil permitido |
Identificador de la interfaz a la que pertenece esta interfaz, p.ej., eth1. Solo para interfaces virtuales. Validations:
|
host[interfaces_attributes][mode] opcional , nil permitido |
Modo de vinculación de la interfaz, p. ej,. balance-rr. Solo para interfaces de vínculo. Validations:
|
host[interfaces_attributes][attached_devices] opcional , nil permitido |
Identificadores de interfaces adjuntas, por ejemplo: `['eth1', 'eth2']`. Para las interfaces vinculadas son esclavos. Solo para interfaces vinculadas y puentes. Validations:
|
host[interfaces_attributes][bond_options] opcional , nil permitido |
Opciones separadas por espacios, p.ej miimon=100. Solo para interfaces de vínculo. Validations:
|
host[interfaces_attributes][compute_attributes] opcional , nil permitido |
Atributos adicionales específicos del recurso de computación para la interfaz. Validations:
|
host[compute_attributes] opcional , nil permitido |
Atributos adicionales específicos del recurso de computación Validations:
|
Nombre del parámetro | Descripción |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
Nombre del parámetro | Descripción |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
Returns string representing a host status of a given type
Nombre del parámetro | Descripción |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
type requerido |
tipo de estado, se puede hacer
Validations:
|
Clears a host sub-status of a given type
Nombre del parámetro | Descripción |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
type requerido |
status type Validations:
|
Return the host's compute attributes that can be used to create a clone of this VM
Nombre del parámetro | Descripción |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
Nombre del parámetro | Descripción |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
Nombre del parámetro | Descripción |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
power_action requerido |
acción de encendido, las acciones válidas incluyen (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status) Validations:
|
Nombre del parámetro | Descripción |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
Nombre del parámetro | Descripción |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
device requerido |
dispositivo de inicio, dispositivos validos son disk, cdrom, pxe, bios Validations:
|
Nombre del parámetro | Descripción |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
name requerido |
nombre de host del host Validations:
|
facts requerido |
hash con los eventos para el host Validations:
|
certname opcional |
opcional: nombre de certificado del host Validations:
|
type opcional |
opcional: el tipo STI de host a crear Validations:
|
Nombre del parámetro | Descripción |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
only opcional |
Limitar los pasos de reconstrucción. Los pasos válidos son DHCP, DNS, TFTP Validations:
|
Nombre del parámetro | Descripción |
---|---|
location_id opcional |
Set the current location context for the request Validations:
|
organization_id opcional |
Set the current organization context for the request Validations:
|
id requerido |
Validations:
|
kind requerido |
Tipos de plantilla, valores disponibles: Validations:
|