Przykłady

POST /api/hosts
{
  "host": {
    "name": "testhost11",
    "environment_id": 334344675,
    "domain_id": 22495316,
    "ptable_id": 1007981711,
    "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,
    "interfaces_attributes": {
      "1": {
        "primary": true,
        "ip": "10.0.0.20",
        "mac": "00:11:22:33:44:00"
      },
      "2": {
        "type": "bmc",
        "provider": "IPMI",
        "mac": "00:11:22:33:44:01"
      },
      "3": {
        "mac": "00:11:22:33:44:02",
        "_destroy": 1
      }
    }
  }
}
201
{
  "ip": "10.0.0.20",
  "ip6": null,
  "environment_id": 334344675,
  "environment_name": "production",
  "last_report": null,
  "mac": "00:11:22:33:44:00",
  "realm_id": null,
  "realm_name": null,
  "sp_mac": "00:11:22:33:44:01",
  "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": 1007981711,
  "ptable_name": "ptable8",
  "medium_id": 980190962,
  "medium_name": "CentOS 5.4",
  "pxe_loader": "Grub 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-09-11 14:31:57 UTC",
  "updated_at": "2019-09-11 14:31:57 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": 95,
  "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:57 UTC",
      "updated_at": "2019-09-11 14:31:57 UTC",
      "managed": true,
      "identifier": null,
      "id": 101,
      "name": "testhost11.mydomain.net",
      "ip": "10.0.0.20",
      "ip6": null,
      "mac": "00:11:22:33:44:00",
      "mtu": null,
      "fqdn": "testhost11.mydomain.net",
      "primary": true,
      "provision": true,
      "type": "interface",
      "virtual": false
    },
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": null,
      "domain_name": null,
      "created_at": "2019-09-11 14:31:57 UTC",
      "updated_at": "2019-09-11 14:31:57 UTC",
      "managed": true,
      "identifier": null,
      "id": 102,
      "name": null,
      "ip": null,
      "ip6": null,
      "mac": "00:11:22:33:44:01",
      "mtu": null,
      "fqdn": null,
      "primary": false,
      "provision": false,
      "type": "bmc",
      "username": null,
      "password": null,
      "provider": "IPMI",
      "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
  }
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

host
wymagany

Validations:

  • Must be a Hash

host[name]
wymagany

Validations:

  • Must be a String

host[location_id]
wymagany

Validations:

  • Must be a number.

host[organization_id]
wymagany

Validations:

  • Must be a number.

host[environment_id]
opcjonalny , nil dopuszczalny

Wymagane, jeśli host jest zarządzany a wartość nie jest dziedziczona z grupy hostów

Validations:

  • Must be a String

host[ip]
opcjonalny , nil dopuszczalny

nie wymagany, jeśli używa podsieć z DHCP proxy

Validations:

  • Must be a String

host[mac]
opcjonalny , nil dopuszczalny

Wymagane dla hosta z gołą maszyną (bez systemu), nie wymagane jeśli jest maszyną wirtualną

Validations:

  • Must be a String

host[architecture_id]
opcjonalny , nil dopuszczalny

Wymagane, jeśli host jest zarządzany a wartość nie jest dziedziczona z grupy hostów

Validations:

  • Must be a number.

host[domain_id]
opcjonalny , nil dopuszczalny

Wymagane, jeśli host jest zarządzany a wartość nie jest dziedziczona z grupy hostów

Validations:

  • Must be a number.

host[realm_id]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a number.

host[puppet_proxy_id]
opcjonalny , nil dopuszczalny

Puppet Proxy ID

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
opcjonalny , nil dopuszczalny

Puppet CA proxy ID

Validations:

  • Must be a number.

host[puppetclass_ids]
opcjonalny , nil dopuszczalny

Validations:

  • Must be an array of any type

host[config_group_ids]
opcjonalny , nil dopuszczalny

IDs of associated config groups

Validations:

  • Must be an array of any type

host[operatingsystem_id]
opcjonalny , nil dopuszczalny

Wymagane, jeśli host jest zarządzany a wartość nie jest dziedziczona z grupy hostów

Validations:

  • Must be a String

host[medium_id]
opcjonalny , nil dopuszczalny

wymagane, jeśli wdrożenie nie jest oparte na obrazie, host jest zarządzany a wartość nie jest dziedziczona z grupy hostów

Validations:

  • Must be a String

host[pxe_loader]
opcjonalny , nil dopuszczalny

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]
opcjonalny , nil dopuszczalny

Wymagane, jeśli host jest zarządzany a domyslna partycja nie została zdefiniowana

Validations:

  • Must be a number.

host[subnet_id]
opcjonalny , nil dopuszczalny

Wymagane, jeśli host jest zarządzany a wartość nie jest dziedziczona z grupy hostów

Validations:

  • Must be a number.

host[compute_resource_id]
opcjonalny , nil dopuszczalny

nil oznacza że host jest gołą maszyną

Validations:

  • Must be a number.

host[root_pass]
opcjonalny , nil dopuszczalny

wymagane jeśli host jest zarządzany a wartość nie jest dziedziczona z grupy hostów lub domyślne hasło ustawień

Validations:

  • Must be a String

host[model_id]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a number.

host[hostgroup_id]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a number.

host[owner_id]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a number.

host[owner_type]
opcjonalny , nil dopuszczalny

Typ właściciela hostów

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a number.

host[host_parameters_attributes]
opcjonalny , nil dopuszczalny

Parametry hostów (tablica lub indeks hasza)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
wymagany

Nazwa parametru

Validations:

  • Must be a String

host[host_parameters_attributes][value]
wymagany

Wartość parametru

Validations:

  • Must be a String

host[build]
opcjonalny , nil dopuszczalny

Validations:

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

host[enabled]
opcjonalny , nil dopuszczalny

Dołącz host bez informowania Foremana

Validations:

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

host[provision_method]
opcjonalny , nil dopuszczalny

The method used to provision the host.

Validations:

  • Must be one of: build, image.

host[managed]
opcjonalny , nil dopuszczalny

Flaga o wartościach Prawda (host jest zarządzany) lub fałsz (nie jest). Uwaga: wartość również określa czy kilka parametrów jest wymaganych lub nie

Validations:

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

host[progress_report_id]
opcjonalny , nil dopuszczalny

UUID do śledzenia statusu zadań orkiestracji, GET /api/orchestration/:UUID/tasks

Validations:

  • Must be a String

host[comment]
opcjonalny , nil dopuszczalny

Dodatkowe informacje o tym hoście

Validations:

  • Must be a String

host[capabilities]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a String

host[compute_profile_id]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a number.

host[interfaces_attributes]
opcjonalny , nil dopuszczalny

Host interfejsu sieciowego.

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
opcjonalny , nil dopuszczalny

MAC adres interfejsu. Wymagany do zarządzania interfejsem maszyny

Validations:

  • Must be a String

host[interfaces_attributes][ip]
opcjonalny , nil dopuszczalny

IPv4 address of interface

Validations:

  • Must be a String

host[interfaces_attributes][ip6]
opcjonalny , nil dopuszczalny

IPv6 address of interface

Validations:

  • Must be a String

host[interfaces_attributes][type]
opcjonalny , nil dopuszczalny

Typ interfejsu, np. BMC. Domyślnie ma wartość interface

Validations:

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

host[interfaces_attributes][name]
opcjonalny , nil dopuszczalny

Nazwa DNS interfejsu

Validations:

  • Must be a String

host[interfaces_attributes][subnet_id]
opcjonalny , nil dopuszczalny

Foreman subnet ID of IPv4 interface

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
opcjonalny , nil dopuszczalny

Foreman subnet ID of IPv6 interface

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
opcjonalny , nil dopuszczalny

ID domeny interfejsu Foremana. Wymagany dla pierwszego interfejsu zarządzanego hostu

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
opcjonalny , nil dopuszczalny

identyfikator wejścia, np. eth0 lub eth1.1

Validations:

  • Must be a String

host[interfaces_attributes][managed]
opcjonalny , nil dopuszczalny

Czy na pewno interfejs powinien być zarządzany przez DHCP i DNS smart proxy i powinien być konfigurowany podczas dostawy?

Validations:

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

host[interfaces_attributes][primary]
opcjonalny , nil dopuszczalny

Czy interfejs ma zostać użyty do konstrukcji FQDN hosta? Każdy zarządzany host potrzebuje jednego pierwszego interfejsu.

Validations:

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

host[interfaces_attributes][provision]
opcjonalny , nil dopuszczalny

Czy interfejs ma zostać użyty przez TFTP dla PXELinux (lub SSH dla bazującego na obrazie hostu)? Każdy zarządzany host potrzebuje jednego interfejsu - dostawcy

Validations:

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

host[interfaces_attributes][username]
opcjonalny , nil dopuszczalny

Tylko dla interfejsu BMC.

Validations:

  • Must be a String

host[interfaces_attributes][password]
opcjonalny , nil dopuszczalny

Tylko dla interfejsu BMC.

Validations:

  • Must be a String

host[interfaces_attributes][provider]
opcjonalny , nil dopuszczalny

Dostawca interfejsu,np. IPMI. Tylko dla interfejsu BMC.

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
opcjonalny , nil dopuszczalny

Alias lub urządzenie VLAN

Validations:

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

host[interfaces_attributes][tag]
opcjonalny , nil dopuszczalny

VLAN tag, ten atrybut ma pierwszeństwo przed podsiecią VLAN ID. tylko dla wirtualnych interfejsów.

Validations:

  • Must be a String

host[interfaces_attributes][mtu]
opcjonalny , nil dopuszczalny

MTU, this attribute has precedence over the subnet MTU.

Validations:

  • Must be a Integer

host[interfaces_attributes][attached_to]
opcjonalny , nil dopuszczalny

Identyfikator interfejsu do rozpoznania do kogo on należy, np. eth1. Tylko dla wirtualnych interfejsów.

Validations:

  • Must be a String

host[interfaces_attributes][mode]
opcjonalny , nil dopuszczalny

Bond Mode interfejsu np. balance-rr. Tylko dla złączonych interfejsów

Validations:

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

host[interfaces_attributes][attached_devices]
opcjonalny , nil dopuszczalny

Identyfikatory zależnych interfejsów,np. ['eth1', 'eth2']. Tylko dla złączonych interfejsów.

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
opcjonalny , nil dopuszczalny

Oddzielone odstępem opcje, np. miiom=100. Tylko dla złączonych interfejsów.

Validations:

  • Must be a String

host[interfaces_attributes][compute_attributes]
opcjonalny , nil dopuszczalny

Dodatkowe zasoby obliczeniowe specyficznych atrybutów interfejsu.

Validations:

  • Must be a Hash

host[compute_attributes]
opcjonalny , nil dopuszczalny

Specyficzne cechy dodatkowe zasobów obliczeniowych

Validations:

  • Must be a Hash