POST /api/hostgroups
Create a host group

Examples

POST /api/hostgroups
{
  "hostgroup": {
    "name": "TestHostgroup",
    "parameters": [
      {
        "name": "foo",
        "value": 42,
        "parameter_type": "integer"
      }
    ]
  }
}
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": "2021-05-19 07:16:11 UTC",
  "updated_at": "2021-05-19 07:16:11 UTC",
  "id": 928644290,
  "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,
  "inherited_compute_profile_id": null,
  "inherited_environment_id": null,
  "inherited_domain_id": null,
  "inherited_puppet_proxy_id": null,
  "inherited_puppet_ca_proxy_id": null,
  "inherited_compute_resource_id": null,
  "inherited_operatingsystem_id": null,
  "inherited_architecture_id": null,
  "inherited_medium_id": null,
  "inherited_ptable_id": null,
  "inherited_subnet_id": null,
  "inherited_subnet6_id": null,
  "inherited_realm_id": null,
  "inherited_pxe_loader": null,
  "parameters": [],
  "template_combinations": [],
  "puppetclasses": [],
  "config_groups": [],
  "all_puppetclasses": [],
  "locations": [],
  "organizations": []
}

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

Name of the host group

Validations:

  • Must be a String
hostgroup[description]
optional , nil allowed

Host group description

Validations:

  • Must be a String
hostgroup[parent_id]
optional , nil allowed

Parent ID of the host group

Validations:

  • Must be a number.
hostgroup[environment_id]
optional , nil allowed

Environment 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

Operating system ID

Validations:

  • Must be a number.
hostgroup[architecture_id]
optional , nil allowed

Architecture ID

Validations:

  • Must be a number.
hostgroup[pxe_loader]
optional , nil allowed

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

Media ID

Validations:

  • Must be a number.
hostgroup[ptable_id]
optional , nil allowed

Partition table 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

Domain 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 of associated config groups

Validations:

  • Must be an array of any type
hostgroup[group_parameters_attributes]
optional , nil allowed

Array of parameters

Validations:

  • Must be an Array of nested elements
hostgroup[group_parameters_attributes][name]
required

Name of the parameter

Validations:

  • Must be a String
hostgroup[group_parameters_attributes][value]
required

Parameter value

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 password on provisioned hosts

Validations:

  • Must be a String
hostgroup[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
hostgroup[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type