GET /api/hostgroups
Elenca tutti i gruppi di host

GET /api/puppetclasses/:puppetclass_id/hostgroups
Elenca tutti i gruppi di host per una classe del puppet

GET /api/locations/:location_id/hostgroups
Elenca tutti i gruppi di host per posizione

GET /api/organizations/:organization_id/hostgroups
Elenca tutti i gruppi di host per organizzazione

Esempi

GET /api/hostgroups
200
{
  "total": 5,
  "subtotal": 5,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "subnet_id": null,
      "subnet_name": null,
      "operatingsystem_id": 309172073,
      "operatingsystem_name": "centos 5.3",
      "domain_id": 22495316,
      "domain_name": "mydomain.net",
      "environment_id": 334344675,
      "environment_name": "production",
      "compute_profile_id": 980190962,
      "compute_profile_name": "1-Small",
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "ptable_id": null,
      "ptable_name": null,
      "medium_id": 980190962,
      "medium_name": "CentOS 5.4",
      "pxe_loader": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "compute_resource_id": null,
      "compute_resource_name": null,
      "architecture_id": 501905019,
      "architecture_name": "x86_64",
      "realm_id": null,
      "realm_name": null,
      "created_at": "2019-11-07 08:56:53 UTC",
      "updated_at": "2019-11-07 08:56:53 UTC",
      "id": 636252244,
      "name": "Common",
      "title": "Common",
      "description": null,
      "puppet_proxy_id": 182953976,
      "puppet_proxy_name": "Puppetmaster Proxy",
      "puppet_ca_proxy_id": null,
      "puppet_ca_proxy_name": null,
      "puppet_proxy": {
        "name": "Puppetmaster Proxy",
        "id": 182953976,
        "url": "http://else.where:4567"
      },
      "puppet_ca_proxy": null,
      "parameters": [
        {
          "priority": null,
          "created_at": "2019-11-07 08:56:53 UTC",
          "updated_at": "2019-11-07 08:56:53 UTC",
          "id": 767575238,
          "name": "group1",
          "parameter_type": "string",
          "value": "group1"
        }
      ]
    },
    {
      "subnet_id": null,
      "subnet_name": null,
      "operatingsystem_id": 309172073,
      "operatingsystem_name": "centos 5.3",
      "domain_id": null,
      "domain_name": null,
      "environment_id": 334344675,
      "environment_name": "production",
      "compute_profile_id": null,
      "compute_profile_name": null,
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "ptable_id": null,
      "ptable_name": null,
      "medium_id": 980190962,
      "medium_name": "CentOS 5.4",
      "pxe_loader": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "compute_resource_id": null,
      "compute_resource_name": null,
      "architecture_id": 501905019,
      "architecture_name": "x86_64",
      "realm_id": null,
      "realm_name": null,
      "created_at": "2019-11-07 08:56:53 UTC",
      "updated_at": "2019-11-07 08:56:53 UTC",
      "id": 603241515,
      "name": "db",
      "title": "db",
      "description": null,
      "puppet_proxy_id": 182953976,
      "puppet_proxy_name": "Puppetmaster Proxy",
      "puppet_ca_proxy_id": null,
      "puppet_ca_proxy_name": null,
      "puppet_proxy": {
        "name": "Puppetmaster Proxy",
        "id": 182953976,
        "url": "http://else.where:4567"
      },
      "puppet_ca_proxy": null,
      "parameters": []
    },
    {
      "subnet_id": 1018350795,
      "subnet_name": "five",
      "operatingsystem_id": 309172073,
      "operatingsystem_name": "centos 5.3",
      "domain_id": 22495316,
      "domain_name": "mydomain.net",
      "environment_id": 153855663,
      "environment_name": "global_puppetmaster",
      "compute_profile_id": 980190962,
      "compute_profile_name": "1-Small",
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "ptable_id": 615088209,
      "ptable_name": "Example partition table",
      "medium_id": 980190962,
      "medium_name": "CentOS 5.4",
      "pxe_loader": "PXELinux BIOS",
      "subnet6_id": 51848956,
      "subnet6_name": "six",
      "compute_resource_id": null,
      "compute_resource_name": null,
      "architecture_id": 501905019,
      "architecture_name": "x86_64",
      "realm_id": null,
      "realm_name": null,
      "created_at": "2019-11-07 08:56:53 UTC",
      "updated_at": "2019-11-07 08:56:53 UTC",
      "id": 1,
      "name": "Parent",
      "title": "Parent",
      "description": null,
      "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"
      },
      "parameters": []
    },
    {
      "subnet_id": null,
      "subnet_name": "five",
      "operatingsystem_id": null,
      "operatingsystem_name": "centos 5.3",
      "domain_id": null,
      "domain_name": "mydomain.net",
      "environment_id": 334344675,
      "environment_name": "production",
      "compute_profile_id": null,
      "compute_profile_name": "1-Small",
      "ancestry": "1",
      "parent_id": 1,
      "parent_name": "Parent",
      "ptable_id": null,
      "ptable_name": "Example partition table",
      "medium_id": null,
      "medium_name": "CentOS 5.4",
      "pxe_loader": "PXELinux BIOS",
      "subnet6_id": null,
      "subnet6_name": "six",
      "compute_resource_id": null,
      "compute_resource_name": null,
      "architecture_id": null,
      "architecture_name": "x86_64",
      "realm_id": null,
      "realm_name": null,
      "created_at": "2019-11-07 08:56:53 UTC",
      "updated_at": "2019-11-07 08:56:53 UTC",
      "id": 928644285,
      "name": "inherited",
      "title": "Parent/inherited",
      "description": null,
      "puppet_proxy_id": null,
      "puppet_proxy_name": "Puppetmaster Proxy",
      "puppet_ca_proxy_id": null,
      "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"
      },
      "parameters": []
    },
    {
      "subnet_id": null,
      "subnet_name": null,
      "operatingsystem_id": null,
      "operatingsystem_name": null,
      "domain_id": null,
      "domain_name": null,
      "environment_id": null,
      "environment_name": null,
      "compute_profile_id": null,
      "compute_profile_name": null,
      "ancestry": null,
      "parent_id": null,
      "parent_name": null,
      "ptable_id": null,
      "ptable_name": null,
      "medium_id": null,
      "medium_name": null,
      "pxe_loader": null,
      "subnet6_id": null,
      "subnet6_name": null,
      "compute_resource_id": null,
      "compute_resource_name": null,
      "architecture_id": null,
      "architecture_name": null,
      "realm_id": null,
      "realm_name": null,
      "created_at": "2019-11-07 08:56:53 UTC",
      "updated_at": "2019-11-07 08:56:53 UTC",
      "id": 866317115,
      "name": "Unusual",
      "title": "Unusual",
      "description": null,
      "puppet_proxy_id": 182953976,
      "puppet_proxy_name": "Puppetmaster Proxy",
      "puppet_ca_proxy_id": null,
      "puppet_ca_proxy_name": null,
      "puppet_proxy": {
        "name": "Puppetmaster Proxy",
        "id": 182953976,
        "url": "http://else.where:4567"
      },
      "puppet_ca_proxy": null,
      "parameters": []
    }
  ]
}

Parametri

Nome parametro Descrizione
puppetclass_id
opzionale

ID della classe del puppet

Validations:

  • Must be a String

location_id
opzionale

Scopo per posizioni

Validations:

  • Must be a Integer

organization_id
opzionale

Scopo per organizzazioni

Validations:

  • Must be a Integer

search
opzionale

filtra i risultati

Validations:

  • Must be a String

order
opzionale

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
opzionale

Numero pagina, iniziando da 1

Validations:

  • Must be a number.

per_page
opzionale

Numero di risultati per pagina da ritornare

Validations:

  • Must be a number.

include
opzionale

Array of extra information types to include

Validations:

  • Must be an array of [parameters]

Search fields

Field name Tipo Possible values
architecture string
class string
config_group string
environment string
host string
id integer
label string
location string
location_id integer
medium string
name string
organization string
organization_id integer
os string
os_description string
os_id integer
os_major string
os_minor string
os_title string
params text
template string
title string

GET /api/hostgroups/:id
Mostra un gruppo di host

Esempi

GET /api/hostgroups/928644301
200
{
  "subnet_id": null,
  "subnet_name": null,
  "operatingsystem_id": null,
  "operatingsystem_name": null,
  "domain_id": null,
  "domain_name": null,
  "environment_id": null,
  "environment_name": null,
  "compute_profile_id": null,
  "compute_profile_name": null,
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "ptable_id": null,
  "ptable_name": null,
  "medium_id": null,
  "medium_name": null,
  "pxe_loader": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "compute_resource_id": null,
  "compute_resource_name": null,
  "architecture_id": null,
  "architecture_name": null,
  "realm_id": null,
  "realm_name": null,
  "created_at": "2019-11-07 08:34:25 UTC",
  "updated_at": "2019-11-07 08:34:25 UTC",
  "id": 928644301,
  "name": "hostgroup18",
  "title": "hostgroup18",
  "description": null,
  "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,
  "parameters": [
    {
      "priority": 60,
      "created_at": "2019-11-07 08:34:25 UTC",
      "updated_at": "2019-11-07 08:34:25 UTC",
      "id": 767575239,
      "name": "foo",
      "parameter_type": "string",
      "value": "bar"
    }
  ],
  "template_combinations": [],
  "puppetclasses": [],
  "config_groups": [],
  "all_puppetclasses": [],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opzionale

Set the current organization context for the request

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.

show_hidden_parameters
opzionale

Display hidden parameter values

Validations:

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


POST /api/hostgroups
Crea un gruppo di host

Esempi

POST /api/hostgroups
{
  "hostgroup": {
    "name": "TestHostgroup",
    "parameters": [
      {
        "name": "foo",
        "value": "bar",
        "hidden_value": true
      }
    ]
  }
}
201
{
  "subnet_id": null,
  "subnet_name": null,
  "operatingsystem_id": null,
  "operatingsystem_name": null,
  "domain_id": null,
  "domain_name": null,
  "environment_id": null,
  "environment_name": null,
  "compute_profile_id": null,
  "compute_profile_name": null,
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "ptable_id": null,
  "ptable_name": null,
  "medium_id": null,
  "medium_name": null,
  "pxe_loader": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "compute_resource_id": null,
  "compute_resource_name": null,
  "architecture_id": null,
  "architecture_name": null,
  "realm_id": null,
  "realm_name": null,
  "created_at": "2019-11-07 08:34:25 UTC",
  "updated_at": "2019-11-07 08:34:25 UTC",
  "id": 928644300,
  "name": "TestHostgroup",
  "title": "TestHostgroup",
  "description": null,
  "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,
  "parameters": [],
  "template_combinations": [],
  "puppetclasses": [],
  "config_groups": [],
  "all_puppetclasses": [],
  "locations": [],
  "organizations": []
}

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer

hostgroup
richiesto

Validations:

  • Must be a Hash

hostgroup[name]
richiesto

Name of the host group

Validations:

  • Must be a String

hostgroup[description]
opzionale , consentito nil

Host group description

Validations:

  • Must be a String

hostgroup[parent_id]
opzionale , consentito nil

Parent ID of the host group

Validations:

  • Must be a number.

hostgroup[environment_id]
opzionale , consentito nil

Environment ID

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
opzionale , consentito nil

Compute profile ID

Validations:

  • Must be a number.

hostgroup[compute_resource_id]
opzionale , consentito nil

Compute resource ID

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
opzionale , consentito nil

Operating system ID

Validations:

  • Must be a number.

hostgroup[architecture_id]
opzionale , consentito nil

Architecture ID

Validations:

  • Must be a number.

hostgroup[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.

hostgroup[medium_id]
opzionale , consentito nil

Media ID

Validations:

  • Must be a number.

hostgroup[ptable_id]
opzionale , consentito nil

Partition table ID

Validations:

  • Must be a number.

hostgroup[subnet_id]
opzionale , consentito nil

Subnet ID

Validations:

  • Must be a number.

hostgroup[subnet6_id]
opzionale , consentito nil

Subnet IPv6 ID

Validations:

  • Must be a number.

hostgroup[domain_id]
opzionale , consentito nil

Domain ID

Validations:

  • Must be a number.

hostgroup[realm_id]
opzionale , consentito nil

Realm ID

Validations:

  • Must be a number.

hostgroup[config_group_ids]
opzionale , consentito nil

IDs of associated config groups

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
opzionale , consentito nil

Array of parameters

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
richiesto

Name of the parameter

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][value]
richiesto

Parameter value

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][parameter_type]
opzionale , consentito nil

Type of value

Validations:

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

hostgroup[group_parameters_attributes][hidden_value]
opzionale , consentito nil

Validations:

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

hostgroup[puppet_proxy_id]
opzionale , consentito nil

Puppet proxy ID

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
opzionale , consentito nil

Puppet CA proxy ID

Validations:

  • Must be a number.

hostgroup[root_pass]
opzionale , consentito nil

Root password on provisioned hosts

Validations:

  • Must be a String

hostgroup[location_ids]
opzionale , consentito nil

SOSTITUIRE le posizioni con gli id dati

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
opzionale , consentito nil

SOSTITUIRE le organizzazioni con gli id dati

Validations:

  • Must be an array of any type


PUT /api/hostgroups/:id
Aggiorna un gruppo di host

Esempi

PUT /api/hostgroups/636252244
{
  "hostgroup": {
    "name": ""
  }
}
422
{
  "error": {
    "id": 636252244,
    "errors": {
      "name": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Name can't be blank"
    ]
  }
}

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opzionale

Set the current organization context for the request

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.

hostgroup
richiesto

Validations:

  • Must be a Hash

hostgroup[name]
opzionale

Name of the host group

Validations:

  • Must be a String

hostgroup[description]
opzionale , consentito nil

Host group description

Validations:

  • Must be a String

hostgroup[parent_id]
opzionale , consentito nil

Parent ID of the host group

Validations:

  • Must be a number.

hostgroup[environment_id]
opzionale , consentito nil

Environment ID

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
opzionale , consentito nil

Compute profile ID

Validations:

  • Must be a number.

hostgroup[compute_resource_id]
opzionale , consentito nil

Compute resource ID

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
opzionale , consentito nil

Operating system ID

Validations:

  • Must be a number.

hostgroup[architecture_id]
opzionale , consentito nil

Architecture ID

Validations:

  • Must be a number.

hostgroup[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.

hostgroup[medium_id]
opzionale , consentito nil

Media ID

Validations:

  • Must be a number.

hostgroup[ptable_id]
opzionale , consentito nil

Partition table ID

Validations:

  • Must be a number.

hostgroup[subnet_id]
opzionale , consentito nil

Subnet ID

Validations:

  • Must be a number.

hostgroup[subnet6_id]
opzionale , consentito nil

Subnet IPv6 ID

Validations:

  • Must be a number.

hostgroup[domain_id]
opzionale , consentito nil

Domain ID

Validations:

  • Must be a number.

hostgroup[realm_id]
opzionale , consentito nil

Realm ID

Validations:

  • Must be a number.

hostgroup[config_group_ids]
opzionale , consentito nil

IDs of associated config groups

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
opzionale , consentito nil

Array of parameters

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
opzionale

Name of the parameter

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][value]
opzionale

Parameter value

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][parameter_type]
opzionale , consentito nil

Type of value

Validations:

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

hostgroup[group_parameters_attributes][hidden_value]
opzionale , consentito nil

Validations:

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

hostgroup[puppet_proxy_id]
opzionale , consentito nil

Puppet proxy ID

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
opzionale , consentito nil

Puppet CA proxy ID

Validations:

  • Must be a number.

hostgroup[root_pass]
opzionale , consentito nil

Root password on provisioned hosts

Validations:

  • Must be a String

hostgroup[location_ids]
opzionale , consentito nil

SOSTITUIRE le posizioni con gli id dati

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
opzionale , consentito nil

SOSTITUIRE le organizzazioni con gli id dati

Validations:

  • Must be an array of any type


DELETE /api/hostgroups/:id
Cancella un gruppo di host

Esempi

DELETE /api/hostgroups/1-Parent
{
  "hostgroup": {}
}
409
{
  "message": "Cannot delete group Parent because it has nested host groups."
}

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opzionale

Set the current organization context for the request

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.


POST /api/hostgroups/:id/clone
Clona un gruppo di host

Esempi

POST /api/hostgroups/636252244/clone
{
  "name": "EiXUjczqAK",
  "hostgroup": {
    "name": "EiXUjczqAK"
  }
}
201
{
  "id": 928644297,
  "name": "EiXUjczqAK",
  "created_at": "2019-11-07T08:57:03.118Z",
  "updated_at": "2019-11-07T08:57:03.118Z",
  "environment_id": 334344675,
  "operatingsystem_id": 309172073,
  "architecture_id": 501905019,
  "medium_id": 980190962,
  "ptable_id": null,
  "root_pass": "$1$foreman$NW1XVtbk4/XkJqmKNrFWV0",
  "puppet_ca_proxy_id": 182953976,
  "use_image": null,
  "image_file": "",
  "ancestry": null,
  "vm_defaults": null,
  "subnet_id": null,
  "domain_id": 22495316,
  "puppet_proxy_id": 182953976,
  "title": "EiXUjczqAK",
  "realm_id": null,
  "compute_profile_id": 980190962,
  "grub_pass": "$1$foreman$NW1XVtbk4/XkJqmKNrFWV0",
  "lookup_value_matcher": "hostgroup=EiXUjczqAK",
  "subnet6_id": null,
  "pxe_loader": null,
  "description": null,
  "compute_resource_id": null
}

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer

name
richiesto

Validations:

  • Must be a String


PUT /api/hostgroups/:id/rebuild_config
Rebuild orchestration config

Esempi

POST /api/hostgroups/928644286-hostgroup217/rebuild_config
{
  "hostgroup": {}
}
422
{
  "error": {
    "message": "Configuration rebuild failed for: foo.example.com(DNS)."
  }
}

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
opzionale

Set the current organization context for the request

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.

only
opzionale

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

Validations:

  • Must be an array of any type

children_hosts
opzionale

Operate on child hostgroup hosts

Validations:

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