Params

Param name Description
host_id
required

ID or name of host

Validations:

  • String

interface
required

interface information

Validations:

  • Hash

interface[mac]
optional , nil allowed

MAC address of interface. Required for managed interfaces on bare metal.

Validations:

  • String

interface[ip]
optional , nil allowed

IPv4 address of interface

Validations:

  • String

interface[ip6]
optional , nil allowed

IPv6 address of interface

Validations:

  • String

interface[type]
optional , nil allowed

Interface type, e.g. bmc. Default is interface

Validations:

  • Must be one of: interface, bmc, bond, bridge.

interface[name]
optional , nil allowed

Interface’s DNS name

Validations:

  • String

interface[subnet_id]
optional , nil allowed

Foreman subnet ID of IPv4 interface

Validations:

  • number.

interface[subnet6_id]
optional , nil allowed

Foreman subnet ID of IPv6 interface

Validations:

  • number.

interface[domain_id]
optional , nil allowed

Foreman domain ID of interface. Required for primary interfaces on managed hosts.

Validations:

  • number.

interface[identifier]
optional , nil allowed

Device identifier, e.g. eth0 or eth1.1

Validations:

  • String

interface[managed]
optional , nil allowed

Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?

Validations:

  • boolean

interface[primary]
optional , nil allowed

Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface.

Validations:

  • boolean

interface[provision]
optional , nil allowed

Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)? Each managed hosts needs to have one provision interface.

Validations:

  • boolean

interface[username]
optional , nil allowed

Only for BMC interfaces.

Validations:

  • String

interface[password]
optional , nil allowed

Only for BMC interfaces.

Validations:

  • String

interface[provider]
optional , nil allowed

Interface provider, e.g. IPMI. Only for BMC interfaces.

Validations:

  • Must be one of: IPMI, SSH.

interface[virtual]
optional , nil allowed

Alias or VLAN device

Validations:

  • boolean

interface[tag]
optional , nil allowed

VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces.

Validations:

  • String

interface[attached_to]
optional , nil allowed

Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces.

Validations:

  • String

interface[mode]
optional , nil allowed

Bond mode of the interface, e.g. balance-rr. Only for bond interfaces.

Validations:

  • Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

interface[attached_devices]
optional , nil allowed

Identifiers of attached interfaces, e.g. ['eth1', 'eth2']. For bond interfaces those are the slaves. Only for bond and bridges interfaces.

Validations:

  • Must be an array of any type

interface[bond_options]
optional , nil allowed

Space separated options, e.g. miimon=100. Only for bond interfaces.

Validations:

  • String

interface[compute_attributes]
optional , nil allowed

Additional compute resource specific attributes for the interface.

Validations:

  • Hash