Param Name | Description |
---|---|
location_id Optional |
Scope by locations Validations:
|
organization_id Optional |
Scope by organizations Validations:
|
host_id Required |
ID or name of host Validations:
|
interface Required |
interface information Validations:
|
interface[mac] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
MAC address of interface. Required for managed interfaces on bare metal. Validations:
|
interface[ip] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
IPv4 address of interface Validations:
|
interface[ip6] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
IPv6 address of interface Validations:
|
interface[type] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Interface type, e.g. bmc. Default is interface Validations:
|
interface[name] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Interface's DNS name Validations:
|
interface[subnet_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Foreman subnet ID of IPv4 interface Validations:
|
interface[subnet6_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Foreman subnet ID of IPv6 interface Validations:
|
interface[domain_id] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Foreman domain ID of interface. Required for primary interfaces on managed hosts. Validations:
|
interface[identifier] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Device identifier, e.g. eth0 or eth1.1 Validations:
|
interface[managed] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning? Validations:
|
interface[primary] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Should this interface be used for constructing the FQDN of the host? Each managed hosts needs to have one primary interface. Validations:
|
interface[provision] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
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:
|
interface[username] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Only for BMC interfaces. Validations:
|
interface[password] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Only for BMC interfaces. Validations:
|
interface[provider] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Interface provider, e.g. IPMI. Only for BMC interfaces. Validations:
|
interface[virtual] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Alias or VLAN device Validations:
|
interface[tag] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
VLAN tag, this attribute has precedence over the subnet VLAN ID. Only for virtual interfaces. Validations:
|
interface[mtu] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
MTU, this attribute has precedence over the subnet MTU. Validations:
|
interface[attached_to] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Identifier of the interface to which this interface belongs, e.g. eth1. Only for virtual interfaces. Validations:
|
interface[mode] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Bond mode of the interface, e.g. balance-rr. Only for bond interfaces. Validations:
|
interface[attached_devices] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Identifiers of attached interfaces, e.g. `['eth1', 'eth2']`. For bond interfaces those are the slaves. Only for bond and bridges interfaces. Validations:
|
interface[bond_options] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Space separated options, e.g. miimon=100. Only for bond interfaces. Validations:
|
interface[compute_attributes] Optional , <span class="translation_missing" title="translation missing: gl.apipie.nil_allowed">Nil Allowed</span> |
Additional compute resource specific attributes for the interface. Validations:
|