Exemplos

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âmentros

Nome parâmetro Descrição
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 , nulo permitido

necessário se o host é gerenciado e valor não é herdado do grupo de host

Validations:

  • Must be a String

host[ip]
opcional , nulo permitido

não necessário se utilizar um subrede com proxy DHCP

Validations:

  • Must be a String

host[mac]
opcional , nulo permitido

necessário para host gerenciado que é bare metal, não necessário se é uma máquina virtual

Validations:

  • Must be a String

host[architecture_id]
opcional , nulo permitido

necessário se o host é gerenciado e valor não é herdado do grupo de host

Validations:

  • Must be a number.

host[domain_id]
opcional , nulo permitido

necessário se o host é gerenciado e valor não é herdado do grupo de host

Validations:

  • Must be a number.

host[realm_id]
opcional , nulo permitido

Validations:

  • Must be a number.

host[puppet_proxy_id]
opcional , nulo permitido

Relatório de Marionete ID

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
opcional , nulo permitido

ID de Proxy do Puppet CA

Validations:

  • Must be a number.

host[puppetclass_ids]
opcional , nulo permitido

Validations:

  • Must be an array of any type

host[config_group_ids]
opcional , nulo permitido

ID de grupos de configuração associados

Validations:

  • Must be an array of any type

host[operatingsystem_id]
opcional , nulo permitido

necessário se o host é gerenciado e valor não é herdado do grupo de host

Validations:

  • Must be a String

host[medium_id]
opcional , nulo permitido

solicitado se o provisionamento não for baseado em imagem, o host for gerenciado e o valor não for herdado do grupo de host

Validations:

  • Must be a String

host[pxe_loader]
opcional , nulo permitido

opção de nome de arquivo DHCP (Grub2/PXELinux por padrão)

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 , nulo permitido

requerido se o host é gerenciado e uma partição customizada não foi definida

Validations:

  • Must be a number.

host[subnet_id]
opcional , nulo permitido

necessário se o host é gerenciado e valor não é herdado do grupo de host

Validations:

  • Must be a number.

host[compute_resource_id]
opcional , nulo permitido

nulo significa que o host é bare metal

Validations:

  • Must be a number.

host[root_pass]
opcional , nulo permitido

requerido se o host é gerenciado e o valor não é herdado do grupo de host ou senha padrão em configurações

Validations:

  • Must be a String

host[model_id]
opcional , nulo permitido

Validations:

  • Must be a number.

host[hostgroup_id]
opcional , nulo permitido

Validations:

  • Must be a number.

host[owner_id]
opcional , nulo permitido

Validations:

  • Must be a number.

host[owner_type]
opcional , nulo permitido

Tipo de proprietário do host

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
opcional , nulo permitido

Validations:

  • Must be a number.

host[host_parameters_attributes]
opcional , nulo permitido

Parâmetros do host (matriz ou hash indexado)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
opcional

Nome do parâmetro

Validations:

  • Must be a String

host[host_parameters_attributes][value]
opcional

Valor do parâmetro

Validations:

  • Must be a String

host[host_parameters_attributes][parameter_type]
opcional , nulo permitido

Type of value

Validations:

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

host[host_parameters_attributes][hidden_value]
opcional , nulo permitido

Validations:

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

host[build]
opcional , nulo permitido

Validations:

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

host[enabled]
opcional , nulo permitido

Incluir este host dentro do relatório do Foreman

Validations:

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

host[provision_method]
opcional , nulo permitido

O método utilizado para provisionar o host.

Validations:

  • Must be one of: build, image.

host[managed]
opcional , nulo permitido

Sinal Verdadeiro / Falso se um host é gerenciado ou não . Nota: este valor também determina se são necessários vários parâmetros ou não

Validations:

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

host[progress_report_id]
opcional , nulo permitido

UUID a rastrear o status de tarefas de orquestração, GET /api/orchestration/:UUID/tasks

Validations:

  • Must be a String

host[comment]
opcional , nulo permitido

Informação adicional sobre este host

Validations:

  • Must be a String

host[capabilities]
opcional , nulo permitido

Validations:

  • Must be a String

host[compute_profile_id]
opcional , nulo permitido

Validations:

  • Must be a number.

host[interfaces_attributes]
opcional , nulo permitido

Interfaces de rede do host

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
opcional , nulo permitido

Endereço MAC da interface. Necessário para interfaces gerenciadas em bare metal.

Validations:

  • Must be a String

host[interfaces_attributes][ip]
opcional , nulo permitido

endereço IPv4 da interface

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
opcional , nulo permitido

endereço IPv6 da interface

Validations:

  • Must be a String

host[interfaces_attributes][type]
opcional , nulo permitido

Tipo de interface , por exemplo, bmc . O padrão é % { default_nic_type }

Validations:

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

host[interfaces_attributes][name]
opcional , nulo permitido

nome DNS da interface

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
opcional , nulo permitido

ID de sub-rede do Foreman de interface IPv4

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
opcional , nulo permitido

ID de sub-rede do Foreman de interface IPv6

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
opcional , nulo permitido

Foreman ID de domínio da interface. Necessário para as interfaces primárias em hosts gerenciados.

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
opcional , nulo permitido

Identificador do dispositivo, ex.: eth0 ou eth1.1

Validations:

  • Must be a String

host[interfaces_attributes][managed]
opcional , nulo permitido

Esta interface deve ser gerenciada via o proxy inteligente DNS e DHCP e deve ser configurada durante provisionamento ?

Validations:

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

host[interfaces_attributes][primary]
opcional , nulo permitido

Está interface deverá ser usada para a construção do FQDN do host? Cada gerenciamento de host precisa ter uma interface primária.

Validations:

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

host[interfaces_attributes][provision]
opcional , nulo permitido

Esta interface deverá ser usada para TFTP do PXELinux (ou SSH para a base de imagem host)? Cada gerenciamento de host precisa ter uma interface de provisão.

Validations:

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

host[interfaces_attributes][username]
opcional , nulo permitido

Apenas para interfaces BMC.

Validations:

  • Must be a String

host[interfaces_attributes][password]
opcional , nulo permitido

Apenas para interfaces BMC.

Validations:

  • Must be a String

host[interfaces_attributes][provider]
opcional , nulo permitido

prestador de interface , por exemplo IPMI . Apenas para interfaces BMC

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
opcional , nulo permitido

Alias ou VLAN

Validations:

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

host[interfaces_attributes][tag]
opcional , nulo permitido

VLAN tag, este atributo tem precedência sobre a sub-rede VLAN ID . Apenas para interfaces virtuais

Validations:

  • Must be a String

host[interfaces_attributes][mtu]
opcional , nulo permitido

MTU, esse atributo tem precedência sobre a sub-rede MTU.

Validations:

  • Must be a Integer

host[interfaces_attributes][attached_to]
opcional , nulo permitido

Identificador da interface a que pertence esta interface , por exemplo, eth1 . Apenas para interfaces virtuais

Validations:

  • Must be a String

host[interfaces_attributes][mode]
opcional , nulo permitido

Modo do bond da interface, ex.: balance-rr. Somente para interfaces em bond.

Validations:

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

host[interfaces_attributes][attached_devices]
opcional , nulo permitido

Identificadores de interfaces anexadas, ex.['eth1', 'eth2']. Para as interfaces vinculadas, esses são os subordinados. Somente para interfaces vinculadas e pontes.

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
opcional , nulo permitido

Opções separadas espaço, por exemplo, miimon = 100 . Apenas para interfaces bond

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
opcional , nulo permitido

Atributos específicos de recursos adicionais de computação para a interface.

Validations:

  • Must be a Hash

host[compute_attributes]
opcional , nulo permitido

Atributos específicos adicionais de recurso de computação.

Validations:

  • Must be a Hash