Ejemplos

PUT /api/hosts/host719
{
  "host": {
    "interfaces_attributes": [
      {
        "id": 22,
        "name": "newname",
        "type": "bmc"
      }
    ]
  }
}
422
{
  "error": {
    "id": 20,
    "errors": {
      "interfaces.type": [
        "can't be changed once the interface is saved"
      ]
    },
    "full_messages": [
      "Type can't be changed once the interface is saved"
    ]
  }
}

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
requerido

Validations:

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

host
requerido

Validations:

  • Must be a Hash

host[name]
opcional

Validations:

  • Must be a String

host[location_id]
opcional

Validations:

  • Must be a number.

host[organization_id]
opcional

Validations:

  • Must be a number.

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:

  • Must be a String

host[ip]
opcional , nil permitido

no es necesario si se usa una subred con un proxy DHCP

Validations:

  • Must be a String

host[mac]
opcional , nil permitido

obligatorio para hosts administrados bare metal, no se requiere para máquinas virtuales

Validations:

  • Must be a String

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:

  • Must be a number.

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:

  • Must be a number.

host[realm_id]
opcional , nil permitido

Validations:

  • Must be a number.

host[puppet_proxy_id]
opcional , nil permitido

ID del Proxy Puppet

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
opcional , nil permitido

ID del Proxy Puppet CA

Validations:

  • Must be a number.

host[puppetclass_ids]
opcional , nil permitido

Validations:

  • Must be an array of any type

host[config_group_ids]
opcional , nil permitido

ID de grupos de configuración asociados

Validations:

  • Must be an array of any type

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:

  • Must be a String

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:

  • Must be a String

host[pxe_loader]
opcional , nil permitido

Opción de nombre de archivo DHCP (Grub2/PXELinux por defecto)

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]
opcional , nil permitido

obligatorio si el host está administrado y no se han definido particiones personalizadas

Validations:

  • Must be a number.

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:

  • Must be a number.

host[compute_resource_id]
opcional , nil permitido

nil implica que el host es bare metal

Validations:

  • Must be a number.

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:

  • Must be a String

host[model_id]
opcional , nil permitido

Validations:

  • Must be a number.

host[hostgroup_id]
opcional , nil permitido

Validations:

  • Must be a number.

host[owner_id]
opcional , nil permitido

Validations:

  • Must be a number.

host[owner_type]
opcional , nil permitido

Tipo de propietario de host

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
opcional , nil permitido

Validations:

  • Must be a number.

host[host_parameters_attributes]
opcional , nil permitido

Parámetros del host (array o hash indexado)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
opcional

Nombre del parámetro

Validations:

  • Must be a String

host[host_parameters_attributes][value]
opcional

Valor del parámetro

Validations:

  • Must be a String

host[host_parameters_attributes][parameter_type]
opcional , nil permitido

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.

host[host_parameters_attributes][hidden_value]
opcional , nil permitido

Validations:

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

host[build]
opcional , nil permitido

Validations:

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

host[enabled]
opcional , nil permitido

Incluir este host en el informe de Foreman

Validations:

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

host[provision_method]
opcional , nil permitido

El método utilizado para aprovisionar el host.

Validations:

  • Must be one of: build, image.

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:

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

host[progress_report_id]
opcional , nil permitido

UUID para seguir el estado de la tarea de orquestación, GET /api/orchestration/:UUID/tasks

Validations:

  • Must be a String

host[comment]
opcional , nil permitido

Información adicional sobre este host

Validations:

  • Must be a String

host[capabilities]
opcional , nil permitido

Validations:

  • Must be a String

host[compute_profile_id]
opcional , nil permitido

Validations:

  • Must be a number.

host[interfaces_attributes]
opcional , nil permitido

Interfaces de red del host

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
opcional , nil permitido

Dirección MAC de la interfaz. Requerida para interfaces administradas bare metal.

Validations:

  • Must be a String

host[interfaces_attributes][ip]
opcional , nil permitido

Dirección IPv4 de la interfaz

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
opcional , nil permitido

Dirección IPv6 de la interfaz

Validations:

  • Must be a String

host[interfaces_attributes][type]
opcional , nil permitido

Tipo de interfaz, por ejemplo, bmc. El tipo predeterminado es interface

Validations:

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

host[interfaces_attributes][name]
opcional , nil permitido

Nombre de DNS de la interfaz

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
opcional , nil permitido

ID de subred Foreman de la interfaz IPv4

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
opcional , nil permitido

ID de subred Foreman de la interfaz IPv6

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
opcional , nil permitido

ID del dominio de Foreman de la interfaz. Requerida para interfaces principales en hosts administrados.

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
opcional , nil permitido

Identificador de dispositivo, p.ej. eth0 o eth1.1

Validations:

  • Must be a String

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:

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

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:

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

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:

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

host[interfaces_attributes][username]
opcional , nil permitido

Solamente para interfaces BMC.

Validations:

  • Must be a String

host[interfaces_attributes][password]
opcional , nil permitido

Solamente para interfaces BMC.

Validations:

  • Must be a String

host[interfaces_attributes][provider]
opcional , nil permitido

Proveedor de interfaz, p.ej., IPMI. Solo para interfaces BMC.

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
opcional , nil permitido

Dispositivo VLAN o alias

Validations:

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

host[interfaces_attributes][tag]
opcional , nil permitido

Etiqueta VLAN, este atributo tiene precedencia sobre la ID de subred VLAN. Solo para interfaces virtuales.

Validations:

  • Must be a String

host[interfaces_attributes][mtu]
opcional , nil permitido

MTU, este atributo tiene precedencia sobre la MTU de subred.

Validations:

  • Must be a Integer

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:

  • Must be a String

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:

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

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:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
opcional , nil permitido

Opciones separadas por espacios, p.ej miimon=100. Solo para interfaces de vínculo.

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
opcional , nil permitido

Atributos adicionales específicos del recurso de computación para la interfaz.

Validations:

  • Must be a Hash

host[compute_attributes]
opcional , nil permitido

Atributos adicionales específicos del recurso de computación

Validations:

  • Must be a Hash