GET /api/hostgroups
Lista wszystkich grup hostów

GET /api/puppetclasses/:puppetclass_id/hostgroups
Lista wszystkich grup hostów dla jednej klasy Puppet

GET /api/locations/:location_id/hostgroups
Lista wszystkich grup hostów na lokację

GET /api/organizations/:organization_id/hostgroups
Lista wszystkich grup hostów na organizację

Parametry

Nazwa parametru Opis
puppetclass_id
opcjonalny

ID klasy Puppet

Validations:

  • Must be a String

location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

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

rezultat paginacji

Validations:

  • Must be a String

per_page
opcjonalny

Liczba wpisów na jedno żądanie

Validations:

  • Must be a String

include
opcjonalny

Array of extra information types to include

Validations:

  • Must be an array of [“parameters”]

Search fields

Field name Typ 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
Pokaż grupę hostów

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

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.

show_hidden_parameters
opcjonalny

Display hidden parameter values

Validations:

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


POST /api/hostgroups
Utwórz grupę hostów

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

hostgroup
wymagany

Validations:

  • Must be a Hash

hostgroup[name]
wymagany

Nazwa grupy hostów

Validations:

  • Must be a String

hostgroup[description]
opcjonalny , nil dopuszczalny

Host group description

Validations:

  • Must be a String

hostgroup[parent_id]
opcjonalny , nil dopuszczalny

ID rodzica grupy hostów

Validations:

  • Must be a number.

hostgroup[environment_id]
opcjonalny , nil dopuszczalny

ID środowiska

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
opcjonalny , nil dopuszczalny

Obliczanie ID profilu

Validations:

  • Must be a number.

hostgroup[compute_resource_id]
opcjonalny , nil dopuszczalny

Compute resource ID

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
opcjonalny , nil dopuszczalny

ID systemu operacyjnego

Validations:

  • Must be a number.

hostgroup[architecture_id]
opcjonalny , nil dopuszczalny

ID architektury

Validations:

  • Must be a number.

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

ID multimediów

Validations:

  • Must be a number.

hostgroup[ptable_id]
opcjonalny , nil dopuszczalny

ID tabeli partycji

Validations:

  • Must be a number.

hostgroup[subnet_id]
opcjonalny , nil dopuszczalny

ID podsieci

Validations:

  • Must be a number.

hostgroup[subnet6_id]
opcjonalny , nil dopuszczalny

Subnet IPv6 ID

Validations:

  • Must be a number.

hostgroup[domain_id]
opcjonalny , nil dopuszczalny

ID domeny

Validations:

  • Must be a number.

hostgroup[realm_id]
opcjonalny , nil dopuszczalny

Realm ID

Validations:

  • Must be a number.

hostgroup[config_group_ids]
opcjonalny , nil dopuszczalny

IDs of associated config groups

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
opcjonalny , nil dopuszczalny

Array of parameters

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
wymagany

Nazwa parametru

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][value]
wymagany

Wartość parametru

Validations:

  • Must be a String

hostgroup[puppet_proxy_id]
opcjonalny , nil dopuszczalny

Puppet Proxy ID

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
opcjonalny , nil dopuszczalny

Puppet CA proxy ID

Validations:

  • Must be a number.

hostgroup[root_pass]
opcjonalny , nil dopuszczalny

Hasło root-a dla zabezpieczonych hostów

Validations:

  • Must be a String

hostgroup[location_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ lokalizacje o podanym id

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ organizacje o podanym id

Validations:

  • Must be an array of any type

hostgroup[ansible_role_ids]
opcjonalny

IDs of associated ansible roles

Validations:

  • Must be an array of any type


PUT /api/hostgroups/:id
Aktualizuj grupę hostów

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

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.

hostgroup
wymagany

Validations:

  • Must be a Hash

hostgroup[name]
opcjonalny

Nazwa grupy hostów

Validations:

  • Must be a String

hostgroup[description]
opcjonalny , nil dopuszczalny

Host group description

Validations:

  • Must be a String

hostgroup[parent_id]
opcjonalny , nil dopuszczalny

ID rodzica grupy hostów

Validations:

  • Must be a number.

hostgroup[environment_id]
opcjonalny , nil dopuszczalny

ID środowiska

Validations:

  • Must be a number.

hostgroup[compute_profile_id]
opcjonalny , nil dopuszczalny

Obliczanie ID profilu

Validations:

  • Must be a number.

hostgroup[compute_resource_id]
opcjonalny , nil dopuszczalny

Compute resource ID

Validations:

  • Must be a number.

hostgroup[operatingsystem_id]
opcjonalny , nil dopuszczalny

ID systemu operacyjnego

Validations:

  • Must be a number.

hostgroup[architecture_id]
opcjonalny , nil dopuszczalny

ID architektury

Validations:

  • Must be a number.

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

ID multimediów

Validations:

  • Must be a number.

hostgroup[ptable_id]
opcjonalny , nil dopuszczalny

ID tabeli partycji

Validations:

  • Must be a number.

hostgroup[subnet_id]
opcjonalny , nil dopuszczalny

ID podsieci

Validations:

  • Must be a number.

hostgroup[subnet6_id]
opcjonalny , nil dopuszczalny

Subnet IPv6 ID

Validations:

  • Must be a number.

hostgroup[domain_id]
opcjonalny , nil dopuszczalny

ID domeny

Validations:

  • Must be a number.

hostgroup[realm_id]
opcjonalny , nil dopuszczalny

Realm ID

Validations:

  • Must be a number.

hostgroup[config_group_ids]
opcjonalny , nil dopuszczalny

IDs of associated config groups

Validations:

  • Must be an array of any type

hostgroup[group_parameters_attributes]
opcjonalny , nil dopuszczalny

Array of parameters

Validations:

  • Must be an Array of nested elements

hostgroup[group_parameters_attributes][name]
opcjonalny

Nazwa parametru

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][value]
opcjonalny

Wartość parametru

Validations:

  • Must be a String

hostgroup[puppet_proxy_id]
opcjonalny , nil dopuszczalny

Puppet Proxy ID

Validations:

  • Must be a number.

hostgroup[puppet_ca_proxy_id]
opcjonalny , nil dopuszczalny

Puppet CA proxy ID

Validations:

  • Must be a number.

hostgroup[root_pass]
opcjonalny , nil dopuszczalny

Hasło root-a dla zabezpieczonych hostów

Validations:

  • Must be a String

hostgroup[location_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ lokalizacje o podanym id

Validations:

  • Must be an array of any type

hostgroup[organization_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ organizacje o podanym id

Validations:

  • Must be an array of any type

hostgroup[ansible_role_ids]
opcjonalny

IDs of associated ansible roles

Validations:

  • Must be an array of any type


DELETE /api/hostgroups/:id
Usuń grupę hostów

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

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.


POST /api/hostgroups/:id/clone
Sklonuj grupę hostów

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

name
wymagany

Validations:

  • Must be a String


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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

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.

only
opcjonalny

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

Validations:

  • Must be an array of any type

children_hosts
opcjonalny

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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

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.


POST /api/hostgroups/multiple_play_roles
Plays Ansible roles on hostgroups

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

hostgroup_ids
wymagany

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

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

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.


POST /api/hostgroups/:id/assign_ansible_roles
Assigns Ansible roles to a hostgroup

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

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.

ansible_role_ids
wymagany

Ansible roles to assign to a hostgroup

Validations:

  • Must be an array of any type