PUT /api/hostgroups/:id
Update a host group

Examples

PUT /api/hostgroups/928644286
{
  "hostgroup": {
    "puppet_proxy_id": 182953976
  }
}
200
{
  "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,
  "architecture_id": null,
  "architecture_name": null,
  "realm_id": null,
  "realm_name": null,
  "created_at": "2018-07-24 13:08:00 UTC",
  "updated_at": "2018-07-24 13:08:00 UTC",
  "id": 928644286,
  "name": "hostgroup124",
  "title": "hostgroup124",
  "description": null,
  "puppet_proxy_id": 182953976,
  "puppet_proxy_name": "Puppetmaster Proxy",
  "puppet_ca_proxy_id": 182953976,
  "puppet_ca_proxy_name": "Puppetmaster Proxy",
  "puppet_proxy": {
    "name": "Puppetmaster Proxy",
    "id": 182953976,
    "url": "http://else.where:4567"
  },
  "puppet_ca_proxy": {
    "name": "Puppetmaster Proxy",
    "id": 182953976,
    "url": "http://else.where:4567"
  },
  "parameters": [],
  "template_combinations": [],
  "puppetclasses": [],
  "config_groups": [],
  "all_puppetclasses": [],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

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

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 UEFI, Grub2 UEFI SecureBoot.
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[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[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]
optional

Name of the parameter

Validations:

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

Parameter value

Validations:

  • Must be a String
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