Params

Param name Description
host_id
required

ID or name of host


Value: Must be String
id
required

ID of interface


Value: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
interface
required

interface information


Value: Must be a Hash
interface[mac]
optional , nil allowed

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


Value: Must be String
interface[ip]
optional , nil allowed

IP address of interface


Value: Must be String
interface[type]
optional , nil allowed

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


Value: Must be one of: interface, bmc, bond.
interface[name]
optional , nil allowed

Interface's DNS name


Value: Must be String
interface[subnet_id]
optional , nil allowed

Foreman subnet ID of interface


Value: Must be Fixnum
interface[domain_id]
optional , nil allowed

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


Value: Must be Fixnum
interface[identifier]
optional , nil allowed

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


Value: Must be String
interface[managed]
optional , nil allowed

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


Value: Must be 'true' or 'false'
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.


Value: Must be 'true' or 'false'
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.


Value: Must be 'true' or 'false'
interface[username]
optional , nil allowed

Only for BMC interfaces.


Value: Must be String
interface[password]
optional , nil allowed

Only for BMC interfaces.


Value: Must be String
interface[provider]
optional , nil allowed

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


Value: Must be one of: IPMI.
interface[virtual]
optional , nil allowed

Alias or VLAN device


Value: Must be 'true' or 'false'
interface[tag]
optional , nil allowed

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


Value: Must be String
interface[attached_to]
optional , nil allowed

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


Value: Must be String
interface[mode]
optional , nil allowed

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


Value: 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 slave interfaces, e.g. `['eth1', 'eth2']`. Only for bond interfaces.


Value: Must be an array of any type
interface[bond_options]
optional , nil allowed

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


Value: Must be String
interface[compute_attributes]
optional , nil allowed

Additional compute resource specific attributes for the interface.


Value: Must be Hash