GET /api/hosts
Lista wszystkich hostów

GET /api/hostgroups/:hostgroup_id/hosts
Lista wszystkich hostów dla danej grupy

GET /api/locations/:location_id/hosts
Lista hostów na lokalizację

GET /api/organizations/:organization_id/hosts
Lista hostów na organizację

GET /api/environments/:environment_id/hosts
Lista hostów na środowisko

Przykłady

GET /api/hosts
200
{
  "total": 10,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": "host650.example361.com",
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "ip": "0.0.0.98",
      "ip6": null,
      "environment_id": null,
      "environment_name": null,
      "last_report": null,
      "mac": "00:53:67:ab:00:7d",
      "realm_id": null,
      "realm_name": null,
      "sp_mac": "00:43:56:cd:00:0b",
      "sp_ip": "1.0.0.7",
      "sp_name": null,
      "domain_id": 759776793,
      "domain_name": "example361.com",
      "architecture_id": 578327787,
      "architecture_name": "x86_64-361",
      "operatingsystem_id": 1073012858,
      "operatingsystem_name": "operatingsystem180 192",
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "sp_subnet_id": null,
      "ptable_id": 1007981802,
      "ptable_name": "ptable284",
      "medium_id": 1011586648,
      "medium_name": "medium183",
      "pxe_loader": "Grub2 UEFI",
      "build": false,
      "comment": null,
      "disk": null,
      "installed_at": null,
      "model_id": null,
      "hostgroup_id": null,
      "owner_id": 886836129,
      "owner_name": "apiadmin User",
      "owner_type": "User",
      "enabled": true,
      "managed": true,
      "use_image": null,
      "image_file": "",
      "uuid": null,
      "compute_resource_id": null,
      "compute_resource_name": null,
      "compute_profile_id": null,
      "compute_profile_name": null,
      "capabilities": [
        "build"
      ],
      "provision_method": "build",
      "certname": "host650.example361.com",
      "image_id": null,
      "image_name": null,
      "created_at": "2019-11-07 08:39:29 UTC",
      "updated_at": "2019-11-07 08:39:29 UTC",
      "last_compile": null,
      "global_status": 0,
      "global_status_label": "OK",
      "uptime_seconds": null,
      "organization_id": 447626438,
      "organization_name": "Organization 1",
      "location_id": 255093256,
      "location_name": "Location 1",
      "puppet_status": 0,
      "model_name": null,
      "build_status": 0,
      "build_status_label": "Installed",
      "name": "host650.example361.com",
      "id": 51,
      "puppet_proxy_id": null,
      "puppet_proxy_name": null,
      "puppet_ca_proxy_id": null,
      "puppet_ca_proxy_name": null,
      "puppet_proxy": null,
      "puppet_ca_proxy": null,
      "hostgroup_name": null,
      "hostgroup_title": null
    }
  ]
}

Parametry

Nazwa parametru Opis
thin
opcjonalny

Only list ID and name of hosts

Validations:

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

hostgroup_id
opcjonalny

ID grupy hostów

Validations:

  • Must be a String

location_id
opcjonalny

ID lokalizacji

Validations:

  • Must be a String

organization_id
opcjonalny

ID organizacji

Validations:

  • Must be a String

environment_id
opcjonalny

ID środowiska

Validations:

  • Must be a String

include
opcjonalny

Array of extra information types to include

Validations:

  • Must be one of: parameters, all_parameters.

search
opcjonalny

rezultat filtrowania

Validations:

  • Must be a String

order
opcjonalny

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
opcjonalny

Page number, starting at 1

Validations:

  • Must be a number.

per_page
opcjonalny

Number of results per page to return

Validations:

  • Must be a number.

Search fields

Field name Typ Possible values
architecture string
boot_time datetime
build true, false
class string
comment text
compute_resource string
compute_resource_id integer
config_group string
created_at datetime
domain string
domain_id integer
environment string
facts string
global_status ok, warning, error
has_ip string
has_mac string
hostgroup string
hostgroup_fullname string
hostgroup_id integer
hostgroup_name string
hostgroup_title string
image string
installed_at datetime
ip string
last_report datetime
location string
location_id integer
mac string
managed true, false
model string
name string
organization string
organization_id integer
origin string
os string
os_description string
os_id integer
os_major string
os_minor string
os_title string
owner string
owner_id integer
owner_type string
params string
params_name string
parent_hostgroup string
puppet_ca string
puppet_proxy_id integer
puppetmaster string
realm string
realm_id integer
smart_proxy string
status.applied integer
status.enabled true, false
status.failed integer
status.failed_restarts integer
status.interesting true, false
status.pending integer
status.restarted integer
status.skipped integer
subnet string
subnet.name text
subnet6 string
subnet6.name text
user.firstname string
user.lastname string
user.login string
user.mail string
usergroup string
usergroup.name string
uuid string

GET /api/hosts/:id
Pokaż host

Przykłady

GET /api/hosts/host716
200
{
  "ip": null,
  "ip6": null,
  "environment_id": null,
  "environment_name": null,
  "last_report": null,
  "mac": null,
  "realm_id": null,
  "realm_name": null,
  "sp_mac": null,
  "sp_ip": null,
  "sp_name": null,
  "domain_id": null,
  "domain_name": null,
  "architecture_id": null,
  "architecture_name": null,
  "operatingsystem_id": null,
  "operatingsystem_name": null,
  "subnet_id": null,
  "subnet_name": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "sp_subnet_id": null,
  "ptable_id": null,
  "ptable_name": null,
  "medium_id": null,
  "medium_name": null,
  "pxe_loader": null,
  "build": false,
  "comment": null,
  "disk": null,
  "installed_at": null,
  "model_id": 980190963,
  "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": null,
  "compute_resource_name": null,
  "compute_profile_id": null,
  "compute_profile_name": null,
  "capabilities": [
    "build"
  ],
  "provision_method": "build",
  "certname": "host716",
  "image_id": null,
  "image_name": null,
  "created_at": "2019-11-07 08:39:58 UTC",
  "updated_at": "2019-11-07 08:39:58 UTC",
  "last_compile": null,
  "global_status": 0,
  "global_status_label": "OK",
  "uptime_seconds": null,
  "organization_id": 447626438,
  "organization_name": "Organization 1",
  "location_id": 255093256,
  "location_name": "Location 1",
  "puppet_status": 0,
  "model_name": "hal900253",
  "name": "host716",
  "id": 16,
  "puppet_proxy_id": null,
  "puppet_proxy_name": null,
  "puppet_ca_proxy_id": null,
  "puppet_ca_proxy_name": null,
  "puppet_proxy": null,
  "puppet_ca_proxy": null,
  "hostgroup_name": null,
  "hostgroup_title": null,
  "parameters": [],
  "all_parameters": [
    {
      "priority": null,
      "created_at": "2019-11-07 08:39:50 UTC",
      "updated_at": "2019-11-07 08:39:50 UTC",
      "id": 513706444,
      "name": "loc_param",
      "parameter_type": "string",
      "value": "abc"
    },
    {
      "priority": null,
      "created_at": "2019-11-07 08:39:50 UTC",
      "updated_at": "2019-11-07 08:39:50 UTC",
      "id": 32400255,
      "name": "org_param",
      "parameter_type": "string",
      "value": "xyz"
    },
    {
      "priority": null,
      "created_at": "2019-11-07 08:39:50 UTC",
      "updated_at": "2019-11-07 08:39:50 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": null,
      "domain_name": null,
      "created_at": "2019-11-07 08:39:58 UTC",
      "updated_at": "2019-11-07 08:39:58 UTC",
      "managed": true,
      "identifier": null,
      "id": 18,
      "name": "host716",
      "ip": null,
      "ip6": null,
      "mac": null,
      "mtu": null,
      "fqdn": "host716",
      "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
  }
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

Validations:

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

show_hidden_parameters
opcjonalny

Display hidden parameter values

Validations:

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


POST /api/hosts
Utwórz host

Przykłady

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
  }
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

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

Type of value

Validations:

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

host[host_parameters_attributes][hidden_value]
opcjonalny , nil dopuszczalny

Validations:

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

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


PUT /api/hosts/:id
Aktualizuj host

Przykłady

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"
    ]
  }
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

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
wymagany

Validations:

  • Must be a Hash

host[name]
opcjonalny

Validations:

  • Must be a String

host[location_id]
opcjonalny

Validations:

  • Must be a number.

host[organization_id]
opcjonalny

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]
opcjonalny

Nazwa parametru

Validations:

  • Must be a String

host[host_parameters_attributes][value]
opcjonalny

Wartość parametru

Validations:

  • Must be a String

host[host_parameters_attributes][parameter_type]
opcjonalny , nil dopuszczalny

Type of value

Validations:

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

host[host_parameters_attributes][hidden_value]
opcjonalny , nil dopuszczalny

Validations:

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

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


DELETE /api/hosts/:id
Usuń host

Przykłady

DELETE /api/hosts/host728
{
  "host": {}
}
404
{
  "error": {
    "message": "Resource host not found by id 'host728'"
  }
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

Validations:

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


GET /api/hosts/:id/enc
Get ENC values of host

Przykłady

GET /api/hosts/host782/enc
200
{
  "data": {
    "parameters": {
      "foreman_subnets": [],
      "foreman_interfaces": [
        {
          "ip": null,
          "ip6": null,
          "mac": null,
          "name": "host782",
          "attrs": {},
          "virtual": false,
          "link": true,
          "identifier": null,
          "managed": true,
          "primary": true,
          "provision": true,
          "subnet": null,
          "subnet6": null,
          "tag": null,
          "attached_to": null,
          "type": "Interface"
        }
      ],
      "location": "Location 1",
      "location_title": "Location 1",
      "organization": "Organization 1",
      "organization_title": "Organization 1",
      "owner_name": "Admin User",
      "owner_email": "admin@someware.com",
      "ssh_authorized_keys": [],
      "foreman_users": {
        "secret_admin": {
          "firstname": "Admin",
          "lastname": "User",
          "mail": "admin@someware.com",
          "description": null,
          "fullname": "Admin User",
          "name": "secret_admin",
          "ssh_authorized_keys": []
        }
      },
      "root_pw": "$5$uLoZGHzYcd1lEBPr$Ow4e9oRmN4/9E3y4rQFN8w1CsoATETimT3HLKRsMgP2",
      "foreman_config_groups": [],
      "puppetmaster": "",
      "foreman_env": "environment152",
      "test": "myvalue",
      "org_param": "xyz",
      "loc_param": "abc"
    },
    "classes": [
      "class30"
    ],
    "environment": "environment152"
  }
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

Validations:

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


GET /api/hosts/:id/status
Pokaż status konfiguracji hosta

Return value may either be one of the following:

  • Alerts disabled
  • No reports
  • Error
  • Out of sync
  • Active
  • Pending
  • No changes

Przykłady

GET /api/hosts/host761/status
404
{
  "error": {
    "message": "Resource host not found by id 'host761'"
  }
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

Validations:

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


GET /api/hosts/:id/status/:type
Pokaż status hosta

Returns string representing a host status of a given type

Przykłady

GET /api/hosts/host823/status/global
200
{
  "status_label": "OK",
  "status": 0
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

Validations:

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

type
wymagany

Typem statusu może być: * globalny * konfigurowany * zbudowany

Validations:

  • Must be one of: HostStatus::Global, configuration, build.


GET /api/hosts/:id/vm_compute_attributes
Podaj atrybuty vm hosta

Return the host’s compute attributes that can be used to create a clone of this VM

Przykłady

GET /api/hosts/host825/vm_compute_attributes
200
{
  "cpus": 4,
  "memory": null
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

Validations:

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


PUT /api/hosts/:id/disassociate
Oddzielony host od VM

Przykłady

PUT /api/hosts/host804/disassociate
{
  "host": {}
}
200
{
  "ip": null,
  "ip6": null,
  "environment_id": null,
  "environment_name": null,
  "last_report": null,
  "mac": null,
  "realm_id": null,
  "realm_name": null,
  "sp_mac": null,
  "sp_ip": null,
  "sp_name": null,
  "domain_id": null,
  "domain_name": null,
  "architecture_id": null,
  "architecture_name": null,
  "operatingsystem_id": null,
  "operatingsystem_name": null,
  "subnet_id": null,
  "subnet_name": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "sp_subnet_id": null,
  "ptable_id": null,
  "ptable_name": null,
  "medium_id": null,
  "medium_name": null,
  "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": null,
  "compute_resource_name": null,
  "compute_profile_id": null,
  "compute_profile_name": null,
  "capabilities": [
    "build"
  ],
  "provision_method": "build",
  "certname": "host804",
  "image_id": null,
  "image_name": null,
  "created_at": "2019-11-07 08:40:15 UTC",
  "updated_at": "2019-11-07 08:40:15 UTC",
  "last_compile": null,
  "global_status": 0,
  "global_status_label": "OK",
  "uptime_seconds": null,
  "organization_id": 447626438,
  "organization_name": "Organization 1",
  "location_id": 255093256,
  "location_name": "Location 1",
  "puppet_status": 0,
  "model_name": null,
  "name": "host804",
  "id": 120,
  "puppet_proxy_id": null,
  "puppet_proxy_name": null,
  "puppet_ca_proxy_id": null,
  "puppet_ca_proxy_name": null,
  "puppet_proxy": null,
  "puppet_ca_proxy": null,
  "hostgroup_name": null,
  "hostgroup_title": null,
  "interfaces": [
    {
      "subnet_id": null,
      "subnet_name": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "domain_id": null,
      "domain_name": null,
      "created_at": "2019-11-07 08:40:15 UTC",
      "updated_at": "2019-11-07 08:40:15 UTC",
      "managed": true,
      "identifier": null,
      "id": 128,
      "name": "host804",
      "ip": null,
      "ip6": null,
      "mac": null,
      "mtu": null,
      "fqdn": "host804",
      "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
  }
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

Validations:

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


PUT /api/hosts/:id/power
Uruchom operację zasilania hosta

Przykłady

PUT /api/hosts/host644.example358.com/power
{
  "power_action": "status",
  "host": {}
}
200
{
  "power": "on"
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

Validations:

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

power_action
wymagany

zasilanie działa, poprawne operacje to (on/start), (off/stop), (soft/reboot), (cycle/reset), (state/status)

Validations:

  • Must be a String


GET /api/hosts/:id/power
Fetch the status of whether the host is powered on or not. Supported hosts are VMs and physical hosts with BMCs.

Przykłady

GET /api/hosts/43/power
200
{
  "id": 43,
  "state": "on",
  "title": "On"
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

Validations:

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


PUT /api/hosts/:id/boot
Uruchamianie hosta z określonego urządzenia

Przykłady

PUT /api/hosts/host646.example359.com/boot
{
  "device": "bios",
  "host": {}
}
200
{
  "boot": "{\"action\":\"bios\",\"result\":true}"
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

Validations:

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

device
wymagany

Urządzenie rozruchowe, dostępne urządzenia to dysk, CD-Rom, PXE, BIOS

Validations:

  • Must be a String


POST /api/hosts/facts
Wyślij informacje dla hosta, tworząc go w razie potrzeby

Przykłady

POST /api/hosts/facts
{
  "name": "brslc022.brs.infineon.com",
  "facts": {
    "is_virtual": "true",
    "processorcount": "2",
    "serialnumber": "VMware-56 4d 15 06 72 86 a9 d3-8a 09 fc 27 5a cf 00 45",
    "kernel": "Linux",
    "virtual": "vmware",
    "_timestamp": "2010-02-16 12:52:38.163833 +01:00",
    "network_eth0": "172.29.205.0",
    "operatingsystemrelease": "4",
    "uniqueid": "1dac16cd",
    "hardwaremodel": "i686",
    "rubysitedir": "/usr/lib/site_ruby/1.8",
    "platform": "Linux_2.6_i386_all",
    "uptime_seconds": "3756",
    "lsbrelease": ":core-3.0-ia32:core-3.0-noarch:graphics-3.0-ia32:graphics-3.0-noarch",
    "memorysize": "1.45 GB",
    "gi": "4",
    "netmask_eth0": "255.255.255.128",
    "ipaddress": "172.29.205.22",
    "physicalprocessorcount": "0",
    "swapfree": "1.95 GB",
    "vmware": "virtual",
    "netmask": "255.255.255.128",
    "clientversion": "0.24.8",
    "fqdn": "brslc022.brs.infineon.com",
    "timezone": "GMT",
    "ps": "ps -ef",
    "kernelrelease": "2.6.9-89.0.16.ELsmp",
    "hardwareisa": "i686",
    "domain": "brs.infineon.com",
    "type": "Other",
    "kernelversion": "2.6.9",
    "id": "root",
    "lsbdistdescription": "Red Hat Enterprise Linux AS release 4 (Nahant Update 8)",
    "uptime_hours": "1",
    "lsbdistrelease": "4",
    "macaddress_eth0": "00:0C:29:CF:00:45",
    "manufacturer": "VMware, Inc.",
    "memoryfree": "1.39 GB",
    "selinux": "false",
    "gateway_if": "eth0",
    "lsbdistcodename": "NahantUpdate8",
    "sshrsakey": "AAAAB3NzaC1yc2EAAAABIwAAAIEAyj0XAKzx4WlNE8Vzj0ABBEHxqHr2H4AZZnabnQkYTOfz5kObXL+BvYqPONg2EqeUYCTNaFtQQPpJ4H+TM+GCJDNvFEKJTRd+cFoOuramf9LunWN/+ETreQ5V8KhKvdYTNw5blPBKiQz/XxSxcm7beo5QiBVr/lOM0u8YhGTLawk=",
    "uptime_days": "0",
    "interfaces": "eth0",
    "hostname": "brslc022",
    "graphcard": "VMware",
    "uptime": "1:02 hours",
    "processor0": "Intel(R) Xeon(R) CPU           X5460  @ 3.16GHz",
    "puppetversion": "0.24.8",
    "productname": "VMware Virtual Platform",
    "architecture": "i386",
    "gateway": "172.29.205.1",
    "rubyversion": "1.8.1",
    "environment": "brs_test",
    "path": "/usr/bin:/sbin:/bin:/usr/sbin:/opt/csw/bin",
    "swapsize": "1.95 GB",
    "ipaddress_eth0": "172.29.205.22",
    "facterversion": "1.5.7",
    "kernelmajversion": "2.6",
    "operatingsystem": "RedHat",
    "macaddress": "00:0C:29:CF:00:45",
    "processor1": "Intel(R) Xeon(R) CPU           X5460  @ 3.16GHz",
    "lsbmajdistrelease": "4",
    "sshdsakey": "AAAAB3NzaC1kc3MAAACBAIUasO2eEvlRHfcO8wMPfbo98YfgVsJj0qhUDSSoSa6xmYI8QWBDMoxf1h8INiDfrNQ5e4VreLQjt4/2Ex7OXoeB7C9Cg18/TlfZU+RTNMdsL85W5hQrrKoBm+ksMnxidkDC66ROq+pmxBTGDwwxg3ugF8eZnVSzCZ1FE605AsStAAAAFQCrr3s1cLQFRc6oZJAx3EZDxDraCQAAAIBqIqIvY7KtRsI+8y8E5MSZXpRRZxf0zqbraDxASwzImUr6ysEmpJsHbHyi6UePnF55tG/iZNM4bSNg/3qExK8So040byV71qN4HNT48nIh3cCS0z8oKLqvlCRJ+dOY1QMkE8ZLfOyF4A6ZOTuE8TTsGpvUIR0HyXkpoiIR9XcgzgAAAIA4nkedBQi+VA01NvWx27GGz5P3TTQ36yDODZdLmXoepQM1rPfKWvPFFd5MxgJumSU5BKhYUiQTOImcRlQcY5DA3dGbog1dOAKlWyeJn4WRHbYr+VNgR/HwBzHLMW4TXLt38ThmPv9TiLS1RvTdHuDm2oRTadNZOrmQz619kZejmw==",
    "lsbdistid": "RedHatEnterpriseAS"
  },
  "host": {
    "name": "brslc022.brs.infineon.com"
  }
}
403
{
  "error": {
    "message": "Access denied",
    "details": "Missing one of the required permissions: upload_facts",
    "missing_permissions": [
      "upload_facts"
    ]
  }
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

name
wymagany

Nazwa danego hostu

Validations:

  • Must be a String

facts
wymagany

Hash zawierający dane dla hosta

Validations:

  • Must be a Hash

certname
opcjonalny

opcjonalnie: Nazwa używana podczas obsługi certyfikatów hosta

Validations:

  • Must be a String

type
opcjonalny

opcjonalnie: typ STI hostu do stworzenia

Validations:

  • Must be a String


PUT /api/hosts/:id/rebuild_config
Odbuduj configurację orkiestracji

Przykłady

POST /api/hosts/host381/rebuild_config
{
  "host": {}
}
422
{
  "message": "Configuration rebuild failed for: TFTP, DNS, and DHCP."
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

Validations:

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

only
opcjonalny

Limit rebuild steps, valid steps are DHCP, DNS, TFTP

Validations:

  • Must be an array of any type


GET /api/hosts/:id/template/:kind
Podgląd zawartości renderowanego szablonu dostawy

Przykłady

GET /api/hosts/host784.example380.com/template/provitamin
404
{
  "message": "No template with kind provitamin for host784.example380.com"
}

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opcjonalny

Set the current organization context for the request

Validations:

  • Must be a Integer

id
wymagany

Validations:

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

kind
wymagany

Rodzaje szablonów, dostępne wartości: PXELinux, PXEGrub, PXEGrub2, iPXE, provision, finish, script, user_data, ZTP, POAP, cloud-init

Validations:

  • Must be a String