1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Files
openshift-docs/modules/nw-multus-host-device-object.adoc

66 lines
1.6 KiB
Plaintext

// Module included in the following assemblies:
//
// * networking/multiple_networks/secondary_networks/creating-secondary-nwt-other-cni.adoc
:_mod-docs-content-type: REFERENCE
[id="nw-multus-host-device-object_{context}"]
= Configuration for a host device secondary network
[role="_abstract"]
The host device CNI plugin JSON configuration object describes the configuration parameters for the host-device CNI plugin.
[NOTE]
====
Specify your network device by setting only one of the following parameters: `device`,`hwaddr`, `kernelpath`, or `pciBusID`.
====
The following table details the configuration parameters:
[cols=".^2,.^2,.^6",options="header"]
|====
|Field|Type|Description
|`cniVersion`
|`string`
|The CNI specification version. The `0.3.1` value is required.
|`name`
|`string`
|The value for the `name` parameter you provided previously for the CNO configuration.
|`type`
|`string`
|The name of the CNI plugin to configure: `host-device`.
|`device`
|`string`
|Optional: The name of the device, such as `eth0`.
|`hwaddr`
|`string`
|Optional: The device hardware MAC address.
|`kernelpath`
|`string`
|Optional: The Linux kernel device path, such as `/sys/devices/pci0000:00/0000:00:1f.6`.
|`pciBusID`
|`string`
|Optional: The PCI address of the network device, such as `0000:00:1f.6`.
|====
[id="nw-multus-hostdev-config-example_{context}"]
== host-device configuration example
The following example configures a secondary network named `hostdev-net`:
[source,json]
----
{
"cniVersion": "0.3.1",
"name": "hostdev-net",
"type": "host-device",
"device": "eth1"
}
----