GET /api/hostgroups
Som alle host groepen op

GET /api/puppetclasses/:puppetclass_id/hostgroups
Som alle host groepen voor een Puppet class op

GET /api/locations/:location_id/hostgroups
Som alle host groepen per locatie op

GET /api/organizations/:organization_id/hostgroups
Som alle host groepen per organisatie op

Params

Param name Description
puppetclass_id
optional

ID van de Puppet class

Validations:

  • Must be a String

location_id
optional

Scope met locaties

Validations:

  • Must be a Integer

organization_id
optional

Scope met organisaties

Validations:

  • Must be a Integer

search
optional

filter resultaten

Validations:

  • Must be a String

order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Number of results per page to return

Validations:

  • Must be a number.

include
optional

Array van extra informatie types om toe te voegen

Validations:

  • Must be an array of [“parameters”]

Search fields

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

GET /api/hostgroups/:id
Bekijk een host groep

Params

Param name Description
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

id
required

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
optional

Display hidden parameter values

Validations:

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


POST /api/hostgroups
Maak een host groep

Params

Param name Description
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

hostgroup
required

Validations:

  • Must be a Hash

hostgroup[name]
required

Naam van de host groep

Validations:

  • Must be a String

hostgroup[description]
optional , nil allowed

Host groep beschrijving

Validations:

  • Must be a String

hostgroup[parent_id]
optional , nil allowed

Parent ID van de host groep

Validations:

  • Must be a number.

hostgroup[environment_id]
optional , nil allowed

Omgevings ID

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
optional , nil allowed

Compute profile ID

Validations:

  • Must be a number.

hostgroup[compute_resource_id]
optional , nil allowed

Compute Resource ID

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
optional , nil allowed

Besturingssysteem ID

Validations:

  • Must be a number.

hostgroup[architecture_id]
optional , nil allowed

Architectuur ID

Validations:

  • Must be a number.

hostgroup[pxe_loader]
optional , nil allowed

DHCP Filenaam optie (Grub2/PXELinux is standaard)

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

Media ID

Validations:

  • Must be a number.

hostgroup[ptable_id]
optional , nil allowed

Partitie tabel ID

Validations:

  • Must be a number.

hostgroup[subnet_id]
optional , nil allowed

Subnet ID

Validations:

  • Must be a number.

hostgroup[subnet6_id]
optional , nil allowed

Subnet IPv6 ID

Validations:

  • Must be a number.

hostgroup[domain_id]
optional , nil allowed

Domein ID

Validations:

  • Must be a number.

hostgroup[realm_id]
optional , nil allowed

Realm ID

Validations:

  • Must be a number.

hostgroup[puppetclass_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

hostgroup[config_group_ids]
optional , nil allowed

IDs van geassocieerde configuratie groepen

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
optional , nil allowed

Array van parameters

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
required

Naam van de parameter

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][value]
required

Parameter waarde

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][parameter_type]
optional , nil allowed

Type of value

Validations:

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

hostgroup[group_parameters_attributes][hidden_value]
optional , nil allowed

Validations:

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

hostgroup[puppet_proxy_id]
optional , nil allowed

Puppet proxy ID

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
optional , nil allowed

Puppet CA proxy ID

Validations:

  • Must be a number.

hostgroup[root_pass]
optional , nil allowed

Root wachtwoord op uitgerolde hosts

Validations:

  • Must be a String

hostgroup[location_ids]
optional , nil allowed

Vervang locaties met de opgegeven ids

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
optional , nil allowed

Vervang organisaties met de opgegeven ids.

Validations:

  • Must be an array of any type


PUT /api/hostgroups/:id
Wijzig een host groep

Params

Param name Description
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

id
required

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
required

Validations:

  • Must be a Hash

hostgroup[name]
optional

Naam van de host groep

Validations:

  • Must be a String

hostgroup[description]
optional , nil allowed

Host groep beschrijving

Validations:

  • Must be a String

hostgroup[parent_id]
optional , nil allowed

Parent ID van de host groep

Validations:

  • Must be a number.

hostgroup[environment_id]
optional , nil allowed

Omgevings ID

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
optional , nil allowed

Compute profile ID

Validations:

  • Must be a number.

hostgroup[compute_resource_id]
optional , nil allowed

Compute Resource ID

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
optional , nil allowed

Besturingssysteem ID

Validations:

  • Must be a number.

hostgroup[architecture_id]
optional , nil allowed

Architectuur ID

Validations:

  • Must be a number.

hostgroup[pxe_loader]
optional , nil allowed

DHCP Filenaam optie (Grub2/PXELinux is standaard)

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

Media ID

Validations:

  • Must be a number.

hostgroup[ptable_id]
optional , nil allowed

Partitie tabel ID

Validations:

  • Must be a number.

hostgroup[subnet_id]
optional , nil allowed

Subnet ID

Validations:

  • Must be a number.

hostgroup[subnet6_id]
optional , nil allowed

Subnet IPv6 ID

Validations:

  • Must be a number.

hostgroup[domain_id]
optional , nil allowed

Domein ID

Validations:

  • Must be a number.

hostgroup[realm_id]
optional , nil allowed

Realm ID

Validations:

  • Must be a number.

hostgroup[puppetclass_ids]
optional , nil allowed

Validations:

  • Must be an array of any type

hostgroup[config_group_ids]
optional , nil allowed

IDs van geassocieerde configuratie groepen

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
optional , nil allowed

Array van parameters

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
optional

Naam van de parameter

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][value]
optional

Parameter waarde

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][parameter_type]
optional , nil allowed

Type of value

Validations:

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

hostgroup[group_parameters_attributes][hidden_value]
optional , nil allowed

Validations:

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

hostgroup[puppet_proxy_id]
optional , nil allowed

Puppet proxy ID

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
optional , nil allowed

Puppet CA proxy ID

Validations:

  • Must be a number.

hostgroup[root_pass]
optional , nil allowed

Root wachtwoord op uitgerolde hosts

Validations:

  • Must be a String

hostgroup[location_ids]
optional , nil allowed

Vervang locaties met de opgegeven ids

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
optional , nil allowed

Vervang organisaties met de opgegeven ids.

Validations:

  • Must be an array of any type


DELETE /api/hostgroups/:id
Verwijder een host groep

Params

Param name Description
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

id
required

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
Cloon een host groep

Params

Param name Description
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

name
required

Validations:

  • Must be a String


PUT /api/hostgroups/:id/rebuild_config
Herbouw de orchestration configuratie

Params

Param name Description
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

id
required

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
optional

Limiteer de herbouw stappen, valide stappen zijn DHCP, DNS, TFTP

Validations:

  • Must be an array of any type

children_hosts
optional

Operate on child hostgroup hosts

Validations:

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