Beispiele

POST /api/hosts
{
  "host": {
    "name": "testhost11",
    "environment_id": 334344675,
    "domain_id": 22495316,
    "ptable_id": 1007981703,
    "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
    }
  }
}
201
{
  "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": 1007981703,
  "ptable_name": "ptable213",
  "medium_id": 980190962,
  "medium_name": "CentOS 5.4",
  "pxe_loader": "Grub2 UEFI",
  "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": true,
  "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-11-07 08:37:28 UTC",
  "updated_at": "2019-11-07 08:37:28 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",
  "build_status": 0,
  "build_status_label": "Installed",
  "name": "testhost11.mydomain.net",
  "id": 3,
  "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-11-07 08:37:27 UTC",
      "updated_at": "2019-11-07 08:37:27 UTC",
      "id": 716195090,
      "name": "os1",
      "parameter_type": "string",
      "value": "os1"
    },
    {
      "priority": null,
      "created_at": "2019-11-07 08:37:27 UTC",
      "updated_at": "2019-11-07 08:37:27 UTC",
      "id": 665394701,
      "name": "parameter",
      "parameter_type": "string",
      "value": "value1"
    },
    {
      "priority": null,
      "created_at": "2019-11-07 08:37:27 UTC",
      "updated_at": "2019-11-07 08:37:27 UTC",
      "id": 513706444,
      "name": "loc_param",
      "parameter_type": "string",
      "value": "abc"
    },
    {
      "priority": null,
      "created_at": "2019-11-07 08:37:27 UTC",
      "updated_at": "2019-11-07 08:37:27 UTC",
      "id": 32400255,
      "name": "org_param",
      "parameter_type": "string",
      "value": "xyz"
    },
    {
      "priority": null,
      "created_at": "2019-11-07 08:37:27 UTC",
      "updated_at": "2019-11-07 08:37:27 UTC",
      "id": 636252244,
      "name": "test",
      "parameter_type": "string",
      "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-11-07 08:37:28 UTC",
      "updated_at": "2019-11-07 08:37:28 UTC",
      "managed": true,
      "identifier": null,
      "id": 3,
      "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
  }
}

Parameter

Parametername Beschreibung
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer

host
verpflichtend

Validations:

  • Must be a Hash

host[name]
verpflichtend

Validations:

  • Must be a String

host[location_id]
verpflichtend

Validations:

  • Must be a number.

host[organization_id]
verpflichtend

Validations:

  • Must be a number.

host[environment_id]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • Must be a String

host[ip]
optional , nil erlaubt

nicht erforderlich, wenn ein Subnetz mit DHCP-Proxy verwendet wird

Validations:

  • Must be a String

host[mac]
optional , nil erlaubt

erforderlich für Bare-Metal-Host, nicht erforderlich, wenn der Host eine virtuelle Maschine ist

Validations:

  • Must be a String

host[architecture_id]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • Must be a number.

host[domain_id]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • Must be a number.

host[realm_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[puppet_proxy_id]
optional , nil erlaubt

Puppet-Proxy Kennung

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
optional , nil erlaubt

Puppet-CA-Proxy Kennung

Validations:

  • Must be a number.

host[puppetclass_ids]
optional , nil erlaubt

Validations:

  • Must be an array of any type

host[config_group_ids]
optional , nil erlaubt

Kennungen von zugehörigen Konfigurationsgruppen

Validations:

  • Must be an array of any type

host[operatingsystem_id]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • Must be a String

host[medium_id]
optional , nil erlaubt

erforderlich, wenn die Bereitstellung nicht image-basiert, der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • Must be a String

host[pxe_loader]
optional , nil erlaubt

DHCP-Dateinamensoption (Standardmäßig Grub2/PXELinux)

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]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und keine spezifische Partition definiert ist

Validations:

  • Must be a number.

host[subnet_id]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe vererbt ist

Validations:

  • Must be a number.

host[compute_resource_id]
optional , nil erlaubt

“nil” bedeutet, dass es sich um einen Bare-Metal-Host handelt

Validations:

  • Must be a number.

host[root_pass]
optional , nil erlaubt

erforderlich, wenn der Host gemanagt und der Wert nicht von einer Hostgruppe oder einem Standardpasswort in den Einstellungen vererbt ist

Validations:

  • Must be a String

host[model_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[hostgroup_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[owner_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[owner_type]
optional , nil erlaubt

Eigentümertyp des Hosts

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[host_parameters_attributes]
optional , nil erlaubt

Hostparameter (Array oder indizierter Hash)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
verpflichtend

Name des Parameters

Validations:

  • Must be a String

host[host_parameters_attributes][value]
verpflichtend

Parameterwert

Validations:

  • Must be a String

host[host_parameters_attributes][parameter_type]
optional , nil erlaubt

Typ des Wertes

Validations:

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

host[host_parameters_attributes][hidden_value]
optional , nil erlaubt

Validations:

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

host[build]
optional , nil erlaubt

Validations:

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

host[enabled]
optional , nil erlaubt

Diesen Host in das Foreman-Reporting aufnehmen

Validations:

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

host[provision_method]
optional , nil erlaubt

Methode der Bereitstellung des Host

Validations:

  • Must be one of: build, image.

host[managed]
optional , nil erlaubt

True/False-Flag, ob ein Host gemanagt oder ungemanagt ist. Hinweis: Dieser Wert bestimmt außerdem, ob mehrere Parameter erforderlich sind oder nicht.

Validations:

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

host[progress_report_id]
optional , nil erlaubt

UUID zum Tracken des Status der Orchestrierungsaufgaben, GET /api/orchestration/:UUID/tasks

Validations:

  • Must be a String

host[comment]
optional , nil erlaubt

Weitere Informationen über diesen Host

Validations:

  • Must be a String

host[capabilities]
optional , nil erlaubt

Validations:

  • Must be a String

host[compute_profile_id]
optional , nil erlaubt

Validations:

  • Must be a number.

host[interfaces_attributes]
optional , nil erlaubt

Netzwerkschnittstelle des Hosts

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
optional , nil erlaubt

MAC-Adresse der Schnittstelle. Erforderlich für gemanagte Bare-Metal-Schnittstellen.

Validations:

  • Must be a String

host[interfaces_attributes][ip]
optional , nil erlaubt

IPv4-Adresse der Schnittstelle

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
optional , nil erlaubt

IPv6-Adresse der Schnittstelle

Validations:

  • Must be a String

host[interfaces_attributes][type]
optional , nil erlaubt

Schnittstellentyp, z.B. BMC. Standard ist interface

Validations:

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

host[interfaces_attributes][name]
optional , nil erlaubt

DNS-Name der Schnittstelle

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
optional , nil erlaubt

Foreman Subnetz Kennung der IPv4 Schnittstelle

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
optional , nil erlaubt

Foreman Subnetz Kennung der IPv6 Schnittstelle

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
optional , nil erlaubt

Foreman-Domänen-Kennung der Schnittstelle. Erforderlich für Primärschnittstellen auf gemanagten Hosts.

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
optional , nil erlaubt

Gerätebezeichner, z.B. eth0 oder eth1.1

Validations:

  • Must be a String

host[interfaces_attributes][managed]
optional , nil erlaubt

Soll diese Schnittstelle über DHCP- und DNS-Smart-Proxy verwaltet werden, oder soll sie bei der Bereitstellung konfiguriert werden?

Validations:

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

host[interfaces_attributes][primary]
optional , nil erlaubt

Soll diese Schnittstelle zum Erstellen des FQDN des Hosts verwendet werden? Jeder gemanagte Host muss eine Primärschnittstelle aufweisen.

Validations:

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

host[interfaces_attributes][provision]
optional , nil erlaubt

Soll diese Schnittstelle für TFTP von PXELinux (oder SSH für image-basierte Hosts) verwendet werden? Jeder gemanagte Host muss eine Bereitstellungsschnittstelle aufweisen.

Validations:

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

host[interfaces_attributes][username]
optional , nil erlaubt

Nur für BMC-Schnittstellen.

Validations:

  • Must be a String

host[interfaces_attributes][password]
optional , nil erlaubt

Nur für BMC-Schnittstellen.

Validations:

  • Must be a String

host[interfaces_attributes][provider]
optional , nil erlaubt

Schnittstellen-Provider, z.B. IPMI. Nur für BMC-Schnittstellen.

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
optional , nil erlaubt

Alias oder VLAN-Gerät

Validations:

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

host[interfaces_attributes][tag]
optional , nil erlaubt

VLAN-Tag, dieses Atttribut hat Vorrang vor der Subnetz-VLAN-Kennung. Nur für virtuelle Schnittstellen.

Validations:

  • Must be a String

host[interfaces_attributes][mtu]
optional , nil erlaubt

MTU. Dieser Wert hat Vorrang über die Subnetz MTU.

Validations:

  • Must be a Integer

host[interfaces_attributes][attached_to]
optional , nil erlaubt

Kennung der Schnittstelle, zu der diese Schnittstelle gehört, z.B. eth1. Nur für virtuelle Schnittstellen.

Validations:

  • Must be a String

host[interfaces_attributes][mode]
optional , nil erlaubt

Bond-Modus der Schnittstelle, z.B. balance-rr. Ausschließlich für Bond-Schnittstellen.

Validations:

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

host[interfaces_attributes][attached_devices]
optional , nil erlaubt

Kennungen von verbundenen Schnittstellen, z.B. ['eth1', 'eth2']. Für Bond-Schnittstellen sind diese die Slaves. Nur für Bond- und Bridge-Schnittstellen.

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
optional , nil erlaubt

Durch Leerzeichen getrennte Optionen, z.B. miimon=100. Ausschließlich für Bond-Schnittstellen.

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
optional , nil erlaubt

Zusätzliche Rechenressourcen-spezifische Attribute für die Schnittstelle.

Validations:

  • Must be a Hash

host[compute_attributes]
optional , nil erlaubt

Zusätzliche Rechenressourcen-spezifische Attribute

Validations:

  • Must be a Hash