Esempi

PUT /api/hosts/host20
{
  "host": {
    "name": "testhost11",
    "environment_id": 334344675,
    "domain_id": 22495316,
    "ptable_id": 1007981717,
    "medium_id": 980190962,
    "architecture_id": 501905019,
    "operatingsystem_id": 1073012828,
    "puppet_proxy_id": 182953976,
    "compute_resource_id": 980190962,
    "root_pass": "xybxa6JUkz63w",
    "location_id": 255093256,
    "organization_id": 447626438,
    "ip": "10.0.0.20",
    "mac": "52:53:00:1e:85:93",
    "compute_attributes": {
      "cpus": 4,
      "memory": 1024
    }
  }
}
200
{
  "ip": "10.0.0.20",
  "ip6": null,
  "environment_id": 334344675,
  "environment_name": "production",
  "last_report": null,
  "mac": "52:53:00:1e:85:93",
  "realm_id": null,
  "realm_name": null,
  "sp_mac": null,
  "sp_ip": null,
  "sp_name": null,
  "domain_id": 22495316,
  "domain_name": "mydomain.net",
  "architecture_id": 501905019,
  "architecture_name": "x86_64",
  "operatingsystem_id": 1073012828,
  "operatingsystem_name": "RHEL 6.1",
  "subnet_id": null,
  "subnet_name": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "sp_subnet_id": null,
  "ptable_id": 1007981717,
  "ptable_name": "ptable14",
  "medium_id": 980190962,
  "medium_name": "CentOS 5.4",
  "pxe_loader": null,
  "build": false,
  "comment": null,
  "disk": null,
  "installed_at": null,
  "model_id": null,
  "hostgroup_id": null,
  "owner_id": 135138680,
  "owner_name": "Admin User",
  "owner_type": "User",
  "enabled": true,
  "managed": false,
  "use_image": null,
  "image_file": "",
  "uuid": null,
  "compute_resource_id": 980190962,
  "compute_resource_name": "bigcompute",
  "compute_profile_id": null,
  "compute_profile_name": null,
  "capabilities": [
    "build",
    "image",
    "new_volume"
  ],
  "provision_method": "build",
  "certname": "testhost11.mydomain.net",
  "image_id": null,
  "image_name": null,
  "created_at": "2019-09-11 14:31:59 UTC",
  "updated_at": "2019-09-11 14:31:59 UTC",
  "last_compile": null,
  "global_status": 0,
  "global_status_label": "Warning",
  "uptime_seconds": null,
  "organization_id": 447626438,
  "organization_name": "Organization 1",
  "location_id": 255093256,
  "location_name": "Location 1",
  "puppet_status": 0,
  "model_name": null,
  "configuration_status": 0,
  "configuration_status_label": "No reports",
  "name": "testhost11.mydomain.net",
  "id": 104,
  "puppet_proxy_id": 182953976,
  "puppet_proxy_name": "Puppetmaster Proxy",
  "puppet_ca_proxy_id": 182953976,
  "puppet_ca_proxy_name": "Puppetmaster Proxy",
  "puppet_proxy": {
    "name": "Puppetmaster Proxy",
    "id": 182953976,
    "url": "http://else.where:4567"
  },
  "puppet_ca_proxy": {
    "name": "Puppetmaster Proxy",
    "id": 182953976,
    "url": "http://else.where:4567"
  },
  "hostgroup_name": null,
  "hostgroup_title": null,
  "parameters": [],
  "all_parameters": [
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 716195090,
      "name": "os1",
      "parameter_type": null,
      "value": "os1"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 665394701,
      "name": "parameter",
      "parameter_type": null,
      "value": "value1"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 513706444,
      "name": "loc_param",
      "parameter_type": null,
      "value": "abc"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 32400255,
      "name": "org_param",
      "parameter_type": null,
      "value": "xyz"
    },
    {
      "priority": null,
      "created_at": "2019-09-11 14:31:50 UTC",
      "updated_at": "2019-09-11 14:31:50 UTC",
      "id": 636252244,
      "name": "test",
      "parameter_type": null,
      "value": "myvalue"
    }
  ],
  "interfaces": [
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": 22495316,
      "domain_name": "mydomain.net",
      "created_at": "2019-09-11 14:31:59 UTC",
      "updated_at": "2019-09-11 14:31:59 UTC",
      "managed": true,
      "identifier": null,
      "id": 113,
      "name": "testhost11.mydomain.net",
      "ip": "10.0.0.20",
      "ip6": null,
      "mac": "52:53:00:1e:85:93",
      "mtu": null,
      "fqdn": "testhost11.mydomain.net",
      "primary": true,
      "provision": true,
      "type": "interface",
      "virtual": false
    }
  ],
  "puppetclasses": [],
  "config_groups": [],
  "all_puppetclasses": [],
  "permissions": {
    "view_hosts": true,
    "create_hosts": true,
    "edit_hosts": true,
    "destroy_hosts": true,
    "build_hosts": true,
    "power_hosts": true,
    "console_hosts": true,
    "ipmi_boot_hosts": true,
    "puppetrun_hosts": true
  }
}

Parametri

Nome parametro Descrizione
location_id
opzionale

Scopo per posizioni

Validations:

  • Must be a Integer

organization_id
opzionale

Scopo per organizzazioni

Validations:

  • Must be a Integer

id
richiesto

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
richiesto

Validations:

  • Must be a Hash

host[name]
opzionale

Validations:

  • Must be a String

host[location_id]
opzionale

Validations:

  • Must be a number.

host[organization_id]
opzionale

Validations:

  • Must be a number.

host[environment_id]
opzionale , consentito nil

necessario se l’host è gestito ed il valore non è stato ereditato da un gruppo di host

Validations:

  • Must be a String

host[ip]
opzionale , consentito nil

non necessario se si utilizza una sottorete con DHCP proxy

Validations:

  • Must be a String

host[mac]
opzionale , consentito nil

necessario per gli host gestiti di tipo bare metal, non richiesto se è una macchina virtuale

Validations:

  • Must be a String

host[architecture_id]
opzionale , consentito nil

necessario se l’host è gestito ed il valore non è stato ereditato da un gruppo di host

Validations:

  • Must be a number.

host[domain_id]
opzionale , consentito nil

necessario se l’host è gestito ed il valore non è stato ereditato da un gruppo di host

Validations:

  • Must be a number.

host[realm_id]
opzionale , consentito nil

Validations:

  • Must be a number.

host[puppet_proxy_id]
opzionale , consentito nil

Puppet proxy ID

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
opzionale , consentito nil

Puppet CA proxy ID

Validations:

  • Must be a number.

host[puppetclass_ids]
opzionale , consentito nil

Validations:

  • Must be an array of any type

host[config_group_ids]
opzionale , consentito nil

IDs of associated config groups

Validations:

  • Must be an array of any type

host[operatingsystem_id]
opzionale , consentito nil

necessario se l’host è gestito ed il valore non è stato ereditato da un gruppo di host

Validations:

  • Must be a String

host[medium_id]
opzionale , consentito nil

necessario se non è disponibile imaged based provisioning e l’host è gestito ed il valore non è stato ereditato dal gruppo di host

Validations:

  • Must be a String

host[pxe_loader]
opzionale , consentito nil

DHCP filename option (Grub2/PXELinux by default)

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]
opzionale , consentito nil

necessario se l’host è gestito e la partizione personalizzata non è stata definita

Validations:

  • Must be a number.

host[subnet_id]
opzionale , consentito nil

necessario se l’host è gestito ed il valore non è stato ereditato da un gruppo di host

Validations:

  • Must be a number.

host[compute_resource_id]
opzionale , consentito nil

nil indica che l’host è bare metal

Validations:

  • Must be a number.

host[root_pass]
opzionale , consentito nil

necessario se l’host è gestito ed il valore non è stato ereditato da un gruppo di host oppure se password predefinita nelle impostazioni

Validations:

  • Must be a String

host[model_id]
opzionale , consentito nil

Validations:

  • Must be a number.

host[hostgroup_id]
opzionale , consentito nil

Validations:

  • Must be a number.

host[owner_id]
opzionale , consentito nil

Validations:

  • Must be a number.

host[owner_type]
opzionale , consentito nil

Tipo di proprietario dell’host

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
opzionale , consentito nil

Validations:

  • Must be a number.

host[host_parameters_attributes]
opzionale , consentito nil

Host’s parameters (array or indexed hash)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
opzionale

Name of the parameter

Validations:

  • Must be a String

host[host_parameters_attributes][value]
opzionale

Parameter value

Validations:

  • Must be a String

host[build]
opzionale , consentito nil

Validations:

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

host[enabled]
opzionale , consentito nil

Includi questo host all’interno del riporto di Foreman

Validations:

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

host[provision_method]
opzionale , consentito nil

The method used to provision the host.

Validations:

  • Must be one of: build, image.

host[managed]
opzionale , consentito nil

Flag True/False se l’host è gestito o non gestito. Nota: questo valore indica anche se è necessario usare alcuni parametri

Validations:

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

host[progress_report_id]
opzionale , consentito nil

UUID per controllare gli stati dei compiti d’orchestrazione, GET /api/orchestration/:UUID/tasks

Validations:

  • Must be a String

host[comment]
opzionale , consentito nil

Informazioni aggiuntive su questo host

Validations:

  • Must be a String

host[capabilities]
opzionale , consentito nil

Validations:

  • Must be a String

host[compute_profile_id]
opzionale , consentito nil

Validations:

  • Must be a number.

host[interfaces_attributes]
opzionale , consentito nil

Host’s network interfaces.

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
opzionale , consentito nil

MAC address of interface. Required for managed interfaces on bare metal.

Validations:

  • Must be a String

host[interfaces_attributes][ip]
opzionale , consentito nil

IPv4 address of interface

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
opzionale , consentito nil

IPv6 address of interface

Validations:

  • Must be a String

host[interfaces_attributes][type]
opzionale , consentito nil

Interface type, e.g. bmc. Default is interface

Validations:

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

host[interfaces_attributes][name]
opzionale , consentito nil

Interface’s DNS name

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
opzionale , consentito nil

Foreman subnet ID of IPv4 interface

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
opzionale , consentito nil

Foreman subnet ID of IPv6 interface

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
opzionale , consentito nil

Foreman domain ID of interface. Required for primary interfaces on managed hosts.

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
opzionale , consentito nil

Identificatore del dispositivo, es. eth0 o eth1.1

Validations:

  • Must be a String

host[interfaces_attributes][managed]
opzionale , consentito nil

L’interfaccia deve essere gestita tramite DHCP e DNS smart proxy e può essere configurarta durante il provisioning?

Validations:

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

host[interfaces_attributes][primary]
opzionale , consentito nil

Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.

Validations:

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

host[interfaces_attributes][provision]
opzionale , consentito nil

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:

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

host[interfaces_attributes][username]
opzionale , consentito nil

Solo per interfacce BMC.

Validations:

  • Must be a String

host[interfaces_attributes][password]
opzionale , consentito nil

Solo per interfacce BMC.

Validations:

  • Must be a String

host[interfaces_attributes][provider]
opzionale , consentito nil

Provider dell’interfaccia, es IPMI. Solo per le interfacce BMC.

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
opzionale , consentito nil

Dispositivo VLAN o Alias

Validations:

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

host[interfaces_attributes][tag]
opzionale , consentito nil

VLAN tag, questo attributo ha la precedenza rispetto a VLAN ID. Solo per interfacce virtuali.

Validations:

  • Must be a String

host[interfaces_attributes][mtu]
opzionale , consentito nil

MTU, this attribute has precedence over the subnet MTU.

Validations:

  • Must be a Integer

host[interfaces_attributes][attached_to]
opzionale , consentito nil

Identificatore dell’interfaccia alla quale appartiene questa interfaccia, es. eth1. Solo per interfacce virtuali.

Validations:

  • Must be a String

host[interfaces_attributes][mode]
opzionale , consentito nil

Modalità associazione dell’interfaccia, es balance-rr. Solo per interfacce di aggregazione.

Validations:

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

host[interfaces_attributes][attached_devices]
opzionale , consentito nil

Identifiers of attached interfaces, e.g. ['eth1', 'eth2']. For bond interfaces those are the slaves. Only for bond and bridges interfaces.

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
opzionale , consentito nil

Opzioni separate da spazi, es. miimon=100. Solo per interfacce di aggregazione.

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
opzionale , consentito nil

Additional compute resource specific attributes for the interface.

Validations:

  • Must be a Hash

host[compute_attributes]
opzionale , consentito nil

Additional compute resource specific attributes.

Validations:

  • Must be a Hash