GET /api/hostgroups
Alle Hostgruppen auflisten

GET /api/puppetclasses/:puppetclass_id/hostgroups
Alle Hostgruppen für eine Puppet-Klasse auflisten

GET /api/locations/:location_id/hostgroups
Alle Hostgruppen pro Standort auflisten

GET /api/organizations/:organization_id/hostgroups
Alle Hostgruppen pro Organisation auflisten

Parameter

Parametername Beschreibung
puppetclass_id
optional

Kennung der Puppet-Klasse

Validations:

  • Must be a String

location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

search
optional

Ergebnisse filtern

Validations:

  • Must be a String

order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
optional

Ergebnisse nummerieren

Validations:

  • Must be a String

per_page
optional

Anzahl der Einträge pro Anfrage

Validations:

  • Must be a String

include
optional

Array of extra information types to include

Validations:

  • Must be an array of [“parameters”]

Search fields

Feld Name Typ Mögliche Werte
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
Hostgruppe anzeigen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

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

Versteckte Parameter Werte anzeigen

Validations:

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


POST /api/hostgroups
Hostgruppe erstellen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

hostgroup
verpflichtend

Validations:

  • Must be a Hash

hostgroup[name]
verpflichtend

Name der Hostgruppe

Validations:

  • Must be a String

hostgroup[description]
optional , nil erlaubt

Beschreibung der Hostgruppe

Validations:

  • Must be a String

hostgroup[parent_id]
optional , nil erlaubt

Übergeordnete Kennung der Hostgruppe

Validations:

  • Must be a number.

hostgroup[environment_id]
optional , nil erlaubt

Umgebungskennung

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
optional , nil erlaubt

Rechenprofilkennung

Validations:

  • Must be a number.

hostgroup[compute_resource_id]
optional , nil erlaubt

Kennung der Rechenressource

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
optional , nil erlaubt

Betriebssystemkennung

Validations:

  • Must be a number.

hostgroup[architecture_id]
optional , nil erlaubt

Architekturkennung

Validations:

  • Must be a number.

hostgroup[pxe_loader]
optional , nil erlaubt

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

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, 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 erlaubt

Medienkennung

Validations:

  • Must be a number.

hostgroup[ptable_id]
optional , nil erlaubt

Partitionstabellenkennung

Validations:

  • Must be a number.

hostgroup[subnet_id]
optional , nil erlaubt

Subnetzkennung

Validations:

  • Must be a number.

hostgroup[subnet6_id]
optional , nil erlaubt

Subnet IPv6 ID

Validations:

  • Must be a number.

hostgroup[domain_id]
optional , nil erlaubt

Domänenkennung

Validations:

  • Must be a number.

hostgroup[realm_id]
optional , nil erlaubt

Realm-Kennung

Validations:

  • Must be a number.

hostgroup[config_group_ids]
optional , nil erlaubt

Kennungen von zugehörigen Konfigurationsgruppen

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
optional , nil erlaubt

Parameter Array

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
verpflichtend

Name des Parameters

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][value]
verpflichtend

Parameterwert

Validations:

  • Must be a String

hostgroup[puppet_proxy_id]
optional , nil erlaubt

Puppet-Proxy Kennung

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
optional , nil erlaubt

Puppet-CA-Proxy Kennung

Validations:

  • Must be a number.

hostgroup[root_pass]
optional , nil erlaubt

Root-Passwort auf bereitgestellten Hosts

Validations:

  • Must be a String

hostgroup[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

hostgroup[ansible_role_ids]
optional

IDs of associated ansible roles

Validations:

  • Must be an array of any type


PUT /api/hostgroups/:id
Hostgruppe aktualisieren

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

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
verpflichtend

Validations:

  • Must be a Hash

hostgroup[name]
optional

Name der Hostgruppe

Validations:

  • Must be a String

hostgroup[description]
optional , nil erlaubt

Beschreibung der Hostgruppe

Validations:

  • Must be a String

hostgroup[parent_id]
optional , nil erlaubt

Übergeordnete Kennung der Hostgruppe

Validations:

  • Must be a number.

hostgroup[environment_id]
optional , nil erlaubt

Umgebungskennung

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
optional , nil erlaubt

Rechenprofilkennung

Validations:

  • Must be a number.

hostgroup[compute_resource_id]
optional , nil erlaubt

Kennung der Rechenressource

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
optional , nil erlaubt

Betriebssystemkennung

Validations:

  • Must be a number.

hostgroup[architecture_id]
optional , nil erlaubt

Architekturkennung

Validations:

  • Must be a number.

hostgroup[pxe_loader]
optional , nil erlaubt

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

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, 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 erlaubt

Medienkennung

Validations:

  • Must be a number.

hostgroup[ptable_id]
optional , nil erlaubt

Partitionstabellenkennung

Validations:

  • Must be a number.

hostgroup[subnet_id]
optional , nil erlaubt

Subnetzkennung

Validations:

  • Must be a number.

hostgroup[subnet6_id]
optional , nil erlaubt

Subnet IPv6 ID

Validations:

  • Must be a number.

hostgroup[domain_id]
optional , nil erlaubt

Domänenkennung

Validations:

  • Must be a number.

hostgroup[realm_id]
optional , nil erlaubt

Realm-Kennung

Validations:

  • Must be a number.

hostgroup[config_group_ids]
optional , nil erlaubt

Kennungen von zugehörigen Konfigurationsgruppen

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
optional , nil erlaubt

Parameter Array

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
optional

Name des Parameters

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][value]
optional

Parameterwert

Validations:

  • Must be a String

hostgroup[puppet_proxy_id]
optional , nil erlaubt

Puppet-Proxy Kennung

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
optional , nil erlaubt

Puppet-CA-Proxy Kennung

Validations:

  • Must be a number.

hostgroup[root_pass]
optional , nil erlaubt

Root-Passwort auf bereitgestellten Hosts

Validations:

  • Must be a String

hostgroup[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

hostgroup[ansible_role_ids]
optional

IDs of associated ansible roles

Validations:

  • Must be an array of any type


DELETE /api/hostgroups/:id
Hostgruppe löschen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

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
Hostgruppe klonen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

name
verpflichtend

Validations:

  • Must be a String


PUT /api/hostgroups/:id/rebuild_config
Orchestrierungs-Konfig neu erstellen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

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

Limit rebuild steps, valid steps are 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.


POST /api/hostgroups/:id/play_roles
Plays Ansible roles on a hostgroup

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

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/multiple_play_roles
Plays Ansible roles on hostgroups

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

hostgroup_ids
verpflichtend

IDs of hostgroups to play roles on

Validations:

  • Must be an array of any type


GET /api/hostgroups/:id/ansible_roles
List all Ansible roles for a hostgroup

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

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/assign_ansible_roles
Assigns Ansible roles to a hostgroup

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

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

ansible_role_ids
verpflichtend

Ansible roles to assign to a hostgroup

Validations:

  • Must be an array of any type