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

Examples

PUT /api/hostgroups/636252244
{
  "hostgroup": {
    "name": "New Name",
    "content_source_id": 281110143
  }
}
200
{
  "subnet_id": null,
  "subnet_name": null,
  "operatingsystem_id": 309172073,
  "operatingsystem_name": "centos 5.3",
  "domain_id": 22495316,
  "domain_name": "mydomain.net",
  "compute_profile_id": 980190962,
  "compute_profile_name": "1-Small",
  "ancestry": null,
  "parent_id": null,
  "parent_name": null,
  "ptable_id": null,
  "ptable_name": null,
  "medium_id": 980190962,
  "medium_name": "CentOS 5.4",
  "pxe_loader": null,
  "subnet6_id": null,
  "subnet6_name": null,
  "compute_resource_id": null,
  "compute_resource_name": null,
  "architecture_id": 501905019,
  "architecture_name": "x86_64",
  "realm_id": null,
  "realm_name": null,
  "created_at": "2024-05-23 19:46:01 UTC",
  "updated_at": "2024-05-23 20:07:42 UTC",
  "id": 636252244,
  "name": "New Name",
  "title": "New Name",
  "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"
  },
  "inherited_compute_profile_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": [
    {
      "priority": null,
      "created_at": "2024-05-23 19:46:01 UTC",
      "updated_at": "2024-05-23 19:46:01 UTC",
      "id": 767575238,
      "name": "group1",
      "parameter_type": "string",
      "associated_type": "host group",
      "hidden_value?": false,
      "value": "group1"
    }
  ],
  "template_combinations": [
    {
      "id": 980190962,
      "provisioning_template_id": 943779058,
      "provisioning_template_name": "MyString",
      "hostgroup_id": 636252244,
      "hostgroup_name": "New Name"
    },
    {
      "id": 113629430,
      "provisioning_template_id": 104314179,
      "provisioning_template_name": "MyFinish",
      "hostgroup_id": 636252244,
      "hostgroup_name": "New Name"
    },
    {
      "id": 281110143,
      "provisioning_template_id": 269958254,
      "provisioning_template_name": "MyString2",
      "hostgroup_id": 636252244,
      "hostgroup_name": "New Name"
    },
    {
      "id": 1018350795,
      "provisioning_template_id": 981457253,
      "provisioning_template_name": "MyScript",
      "hostgroup_id": 636252244,
      "hostgroup_name": "New Name"
    }
  ],
  "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

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
hostgroup
required

Validations:

  • Hash
hostgroup[name]
optional

Name of the host group

Validations:

  • String
hostgroup[description]
optional , nil allowed

Host group description

Validations:

  • String
hostgroup[parent_id]
optional , nil allowed

Parent ID of the host group

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[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:

  • String
hostgroup[group_parameters_attributes][value]
optional

Parameter value

Validations:

  • 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:

  • 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
hostgroup[content_source_id]
optional

Content source ID

Validations:

  • Must be a number.
hostgroup[content_view_id]
optional

Content view ID

Validations:

  • Must be a number.
hostgroup[lifecycle_environment_id]
optional

Lifecycle environment ID

Validations:

  • Must be a number.
hostgroup[kickstart_repository_id]
optional

Kickstart repository ID

Validations:

  • Must be a number.
hostgroup[ansible_role_ids]
optional

IDs of associated ansible roles

Validations:

  • Must be an array of any type