GET /api/hostgroups
Lista alla värdgrupper

GET /api/puppetclasses/:puppetclass_id/hostgroups
Lista alla värdgrupper för en Puppet-klass

GET /api/locations/:location_id/hostgroups
Lista alla värdgrupper per plats

GET /api/organizations/:organization_id/hostgroups
Lista alla värdgrupper per organisation

Params

Param name Description
puppetclass_id
optional

ID of Puppet class

Validations:

  • Must be a String

location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

search
optional

filtrera resultat

Validations:

  • Must be a String

order
optional

sortera resultat

Validations:

  • Must be a String

page
optional

paginate results

Validations:

  • Must be a String

per_page
optional

antal poster per begäran

Validations:

  • Must be a String

include
optional

Array of extra information types to include

Validations:

  • Must be an array of [“parameters”]


GET /api/hostgroups/:id
Visa en värdgrupp

Params

Param name Description
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.

show_hidden_parameters
optional

Display hidden parameter values

Validations:

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


POST /api/hostgroups
Skapa en värdgrupp

Params

Param name Description
hostgroup
required

Validations:

  • Must be a Hash

hostgroup[name]
required

Värdgruppens namn

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[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]
required

Parameterns namn

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][value]
required

Parametervärde

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


PUT /api/hostgroups/:id
Uppdatera en värdgrupp

Params

Param name Description
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

Värdgruppens namn

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

Parameterns namn

Validations:

  • Must be a String

hostgroup[group_parameters_attributes][value]
optional

Parametervärde

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


DELETE /api/hostgroups/:id
Radera en värdgrupp

Params

Param name Description
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.


POST /api/hostgroups/:id/clone
Klona en värdgrupp

Params

Param name Description
name
required

Validations:

  • Must be a String


PUT /api/hostgroups/:id/rebuild_config
Rebuild orchestration config

Params

Param name Description
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.

only
optional

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

Validations:

  • Must be an array of any type

children_hosts
optional

Operate on child hostgroup hosts

Validations:

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