Param Name | Description |
---|---|
puppetclass_id Optional |
ID of Puppet class Validations:
|
location_id Optional |
Scope by locations Validations:
|
organization_id Optional |
Scope by organizations Validations:
|
search Optional |
filter results Validations:
|
order Optional |
Sort field and order, eg. ‘id DESC’ Validations:
|
page Optional |
Page number, starting at 1 Validations:
|
per_page Optional |
Number of results per page to return, 'all' to return all results Validations:
|
include Optional |
Array of extra information types to include Validations:
|
Field name | Tipo | 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 |
Param Name | Description |
---|---|
location_id Optional |
Set the current location context for the request Validations:
|
organization_id Optional |
Set the current organization context for the request Validations:
|
id Required |
Validations:
|
show_hidden_parameters Optional |
Display hidden parameter values Validations:
|
Param Name | Description |
---|---|
location_id Optional |
Set the current location context for the request Validations:
|
organization_id Optional |
Set the current organization context for the request Validations:
|
hostgroup Required |
Validations:
|
hostgroup[name] Required |
Name of the host group Validations:
|
hostgroup[description] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Host group description Validations:
|
hostgroup[parent_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Parent ID of the host group Validations:
|
hostgroup[environment_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Environment ID Validations:
|
hostgroup[compute_profile_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Compute profile ID Validations:
|
hostgroup[compute_resource_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Compute resource ID Validations:
|
hostgroup[operatingsystem_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Operating system ID Validations:
|
hostgroup[architecture_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Architecture ID Validations:
|
hostgroup[pxe_loader] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
DHCP filename option (Grub2/PXELinux by default) Validations:
|
hostgroup[medium_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Media ID Validations:
|
hostgroup[ptable_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Partition table ID Validations:
|
hostgroup[subnet_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Subnet ID Validations:
|
hostgroup[subnet6_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Subnet IPv6 ID Validations:
|
hostgroup[domain_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Domain ID Validations:
|
hostgroup[realm_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Realm ID Validations:
|
hostgroup[puppetclass_ids] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
hostgroup[config_group_ids] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
IDs of associated config groups Validations:
|
hostgroup[group_parameters_attributes] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Array of parameters Validations:
|
hostgroup[group_parameters_attributes][name] Required |
Name of the parameter Validations:
|
hostgroup[group_parameters_attributes][value] Required |
Parameter value Validations:
|
hostgroup[group_parameters_attributes][parameter_type] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Type of value Validations:
|
hostgroup[group_parameters_attributes][hidden_value] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
hostgroup[puppet_proxy_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Puppet proxy ID Validations:
|
hostgroup[puppet_ca_proxy_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Puppet CA proxy ID Validations:
|
hostgroup[root_pass] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Root password on provisioned hosts Validations:
|
hostgroup[location_ids] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
REPLACE locations with given ids Validations:
|
hostgroup[organization_ids] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
REPLACE organizations with given ids. Validations:
|
hostgroup[ansible_role_ids] Optional |
IDs of associated ansible roles Validations:
|
Param Name | Description |
---|---|
location_id Optional |
Set the current location context for the request Validations:
|
organization_id Optional |
Set the current organization context for the request Validations:
|
id Required |
Validations:
|
hostgroup Required |
Validations:
|
hostgroup[name] Optional |
Name of the host group Validations:
|
hostgroup[description] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Host group description Validations:
|
hostgroup[parent_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Parent ID of the host group Validations:
|
hostgroup[environment_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Environment ID Validations:
|
hostgroup[compute_profile_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Compute profile ID Validations:
|
hostgroup[compute_resource_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Compute resource ID Validations:
|
hostgroup[operatingsystem_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Operating system ID Validations:
|
hostgroup[architecture_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Architecture ID Validations:
|
hostgroup[pxe_loader] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
DHCP filename option (Grub2/PXELinux by default) Validations:
|
hostgroup[medium_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Media ID Validations:
|
hostgroup[ptable_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Partition table ID Validations:
|
hostgroup[subnet_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Subnet ID Validations:
|
hostgroup[subnet6_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Subnet IPv6 ID Validations:
|
hostgroup[domain_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Domain ID Validations:
|
hostgroup[realm_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Realm ID Validations:
|
hostgroup[puppetclass_ids] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
hostgroup[config_group_ids] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
IDs of associated config groups Validations:
|
hostgroup[group_parameters_attributes] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Array of parameters Validations:
|
hostgroup[group_parameters_attributes][name] Optional |
Name of the parameter Validations:
|
hostgroup[group_parameters_attributes][value] Optional |
Parameter value Validations:
|
hostgroup[group_parameters_attributes][parameter_type] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Type of value Validations:
|
hostgroup[group_parameters_attributes][hidden_value] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Validations:
|
hostgroup[puppet_proxy_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Puppet proxy ID Validations:
|
hostgroup[puppet_ca_proxy_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Puppet CA proxy ID Validations:
|
hostgroup[root_pass] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Root password on provisioned hosts Validations:
|
hostgroup[location_ids] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
REPLACE locations with given ids Validations:
|
hostgroup[organization_ids] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
REPLACE organizations with given ids. Validations:
|
hostgroup[ansible_role_ids] Optional |
IDs of associated ansible roles Validations:
|
Param Name | Description |
---|---|
location_id Optional |
Set the current location context for the request Validations:
|
organization_id Optional |
Set the current organization context for the request Validations:
|
id Required |
Validations:
|
Param Name | Description |
---|---|
location_id Optional |
Set the current location context for the request Validations:
|
organization_id Optional |
Set the current organization context for the request Validations:
|
name Required |
Validations:
|
Param Name | Description |
---|---|
location_id Optional |
Set the current location context for the request Validations:
|
organization_id Optional |
Set the current organization context for the request Validations:
|
id Required |
Validations:
|
only Optional |
Limit rebuild steps, valid steps are DHCP, DNS, TFTP, SSH_Nic, SSH_Host Validations:
|
children_hosts Optional |
Operate on child hostgroup hosts Validations:
|
Param Name | Description |
---|---|
location_id Optional |
Set the current location context for the request Validations:
|
organization_id Optional |
Set the current organization context for the request Validations:
|
id Required |
Validations:
|
Param Name | Description |
---|---|
location_id Optional |
Set the current location context for the request Validations:
|
organization_id Optional |
Set the current organization context for the request Validations:
|
hostgroup_ids Required |
IDs of hostgroups to play roles on Validations:
|
Param Name | Description |
---|---|
location_id Optional |
Set the current location context for the request Validations:
|
organization_id Optional |
Set the current organization context for the request Validations:
|
id Required |
Validations:
|
Param Name | Description |
---|---|
location_id Optional |
Set the current location context for the request Validations:
|
organization_id Optional |
Set the current organization context for the request Validations:
|
id Required |
Validations:
|
ansible_role_ids Required |
Ansible roles to assign to a hostgroup Validations:
|