Params

Param Name Description
host
Required

Validations:

  • Must be a Hash

host[name]
Required

Validations:

  • Must be a String

host[location_id]
Required

required if locations are enabled

Validations:

  • Must be a number.

host[organization_id]
Required

required if organisations are enabled

Validations:

  • Must be a number.

host[environment_id]
Optional

required if host is managed and value is not inherited from host group

Validations:

  • Must be a String

host[ip]
Optional

IPv4 address

Validations:

  • Must be a String

host[ip6]
Optional

IPv6 address

Validations:

  • Must be a String

host[mac]
Optional

required for managed host that is bare metal, not required if it's a virtual machine

Validations:

  • Must be a String

host[architecture_id]
Optional

required if host is managed and value is not inherited from host group

Validations:

  • Must be a number.

host[domain_id]
Optional

required if host is managed and value is not inherited from host group

Validations:

  • Must be a number.

host[realm_id]
Optional

Validations:

  • Must be a number.

host[puppet_proxy_id]
Optional

Validations:

  • Must be a number.

host[puppetclass_ids]
Optional

Validations:

  • Must be an array of any type

host[operatingsystem_id]
Optional

required if host is managed and value is not inherited from host group

Validations:

  • Must be a String

host[medium_id]
Optional

required if not imaged based provisioning and host is managed and value is not inherited from host group

Validations:

  • Must be a String

host[pxe_loader]
Optional

DHCP filename option

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub UEFI SecureBoot, Grub2 UEFI, Grub2 UEFI SecureBoot.

host[ptable_id]
Optional

required if host is managed and custom partition has not been defined

Validations:

  • Must be a number.

host[subnet_id]
Optional

IPv4 subnet

Validations:

  • Must be a number.

host[subnet6_id]
Optional

IPv6 subnet

Validations:

  • Must be a number.

host[compute_resource_id]
Optional

nil means host is bare metal

Validations:

  • Must be a number.

host[root_pass]
Optional

required if host is managed and value is not inherited from host group or default password in settings

Validations:

  • Must be a String

host[model_id]
Optional

Validations:

  • Must be a number.

host[hostgroup_id]
Optional

Validations:

  • Must be a number.

host[owner_id]
Optional

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
Optional

Validations:

  • Must be a number.

host[image_id]
Optional

Validations:

  • Must be a number.

host[host_parameters_attributes]
Optional

Host's parameters (array or indexed hash)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
Required

Name of the parameter

Validations:

  • Must be a String

host[host_parameters_attributes][value]
Required

Parameter value

Validations:

  • Must be a String

host[build]
Optional

Validations:

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

host[enabled]
Optional

Validations:

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

host[provision_method]
Optional

Validations:

  • Must be a String

host[managed]
Optional

True/False flag whether a host is managed or unmanaged. Note: this value also determines whether several parameters are required or not

Validations:

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

host[progress_report_id]
Optional

UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks

Validations:

  • Must be a String

host[comment]
Optional

Additional information about this host

Validations:

  • Must be a String

host[capabilities]
Optional

Validations:

  • Must be a String

host[compute_profile_id]
Optional

Validations:

  • Must be a number.

host[compute_attributes]
Optional

Validations:

  • Must be a Hash