A sub-interface is a list of additional (secondary, or virtual) addresses that are to be assigned to a network interface. Sub-interfaces are present only in the saved configuration and are stored in suffixed file names derived from the interface configuration script file name. For example, sub-interfaces for eth0 are stored as: /etc/sysconfig/network-scripts/ifcfg-eth0.0 /etc/sysconfig/network-scripts/ifcfg-eth0.1 etc.
Supports the configuration of bonded NICs, i.e. link aggregation. Bond interface configuration is stored as an interface configuration script, for example: /etc/sysconfig/network-scripts/ifcfg-bond0
Represents a list of bond interface elements.
Configuration for the loopback interface. Loopback interface configuration is stored as an interface configuration script, for example: /etc/sysconfig/network-scripts/ifcfg-lo
Configuration for an ethernet interface. Ethernet interface configuration is stored as an interface configuration script, for example: /etc/sysconfig/network-scripts/ifcfg-eth0
Represents a list of ethernet interface elements.
| Name | Type | Description | Attributes |
|---|---|---|---|
| plcmEthernetInterfaceList | Array of PlcmEthernetInterface | See Definition of PlcmEthernetInterface |
| Name | Type | Description | Attributes |
|---|---|---|---|
| services | Array of PlcmService | ||
| lanSecurityConfig | LanSecurityConfiguration | ||
| searchPathElements | Array of SearchPathElement | ||
| ethtoolOptions | Array of PlcmEthtoolOption | ||
| driverInfo | DriverInfo | See Definition of DriverInfo | |
| rules | Array of PlcmNetworkRoutingRule | ||
| routes | Array of PlcmNetworkRoute | ||
| subInterfaces | Array of PlcmSubInterface | ||
| addresses | Array of PlcmNetworkAddress | ||
| name | string | A descriptive name for the interface | |
| deviceName | string | Defines the name for the device to be configured, e.g. eth0 | Mandatory |
| state | PlcmNetworkInterfaceState | For a live network configuration, this value will not be null and will reflect the current operational state of the interface. For a saved network configuration, this value will be null. | |
| dscp | int | The Differentiated Services marker for outgoing traffic originating on the interface. | |
| readOnly | boolean | Informs the client whether this interface can have its settings changed via this API | |
| macAddress | PlcmMacAddress | This address overrides the physical MAC address for this interface. The physical MAC address is found on the ethernet-interface container defined later in this module and is referred to as the hardware address. | |
| ipv4FailureIsFatal | boolean | Whether a failure to initialize ipv4 should be considered fatal with respect to the network service startup, i.e even if ipv6 is enabled and successfully initialized, the link will not be considered UP if ipv4 cannot be initialized. | |
| ipv6Init | boolean | If set to true, initialize this interface for ipv6 addressing. If set to false, do not initialize this interface for ipv6 addressing. False is the default value. This setting is required for ipv6 static and DHCP assignment of ipv6 addresses. It does not affect ipv6 Stateless Address Auto-Configuration (SLAAC) as per RFC 4862. | |
| ipv6FailureIsFatal | boolean | Whether a failure to initialize ipv6 should be considered fatal with respect to the network service startup, i.e even if ipv4 is enabled and successfully initialized, the link will not be considered UP if ipv6 cannot be initialized. | |
| ipv6AutoConfig | boolean | Defines whether this ipv6 interface has auto configuration turned on | |
| mtu | int | Maximum transmission unit for Ipv4 traffic through this interface | |
| ipv6Mtu | int | Maximum transmission unit for ipv6 traffic through this interface | |
| linkDelayTime | int | ||
| interfaceType | PlcmNetworkInterfaceType | Specifies the type of interface | |
| bootProtocol | PlcmNetworkBootProtocol | Defines the boot protocol setting for this interface | |
| onBoot | boolean | Defines whether interface is enabled on system boot up | |
| hardwareAddress | PlcmPhysAddress | The hardware address of the physical device or in the case of a bond interface, the hardware address to use for the channel (link aggregator) | |
| bondMaster | BondMaster | The name of the interface that is the master interface when bonding multiple interfaces | |
| bondSlave | boolean | true means this device is controlled by the channel bonding interface specified in the bond-master; false means otherwise. | |
| ipv6Privacy | boolean | Defines whether this ipv6 interface has the privacy feature turned on | |
| ipv6Dhcp | boolean | Defines whether this interface has DHCP feature turned on for ipv6 | |
| ipv6DhcpOptions | Array of PlcmIpv6DhcpOption | Defines the DHCP options for ipv6 for this interface, if DHCP is turned on | |
| dhcpHostName | PlcmDomainName | The hostname of the DHCP server | |
| peerDns | boolean | When set to true, the DNS nameservers assigned by DHCP will be automatically added to the DNS configuration (/etc/resolv.conf) file. The DNS nameservers may be specified as one (or more) addresses for the interface with address-type set to DNS and an order value specified, e.g. 1,2,3. When using DHCP and specifying nameservers in this fashion, this option should be set to false, which will NOT write the DHCP assigned nameservers to the DNS configuration file. | |
| defRoute | boolean | Whether this interface represents the default gateway for the server | |
| uuid | Uuid | Universally unique identifier for the network interface. | |
| dnsDomain | PlcmDomainName | DNS domain name for the server | |
| hotPlug | boolean | Whether the interface should be activated when it is hot-plugged | |
| appConfig | string | Any application specific configuration that might be associated with this interface | |
| natAddress | PlcmInetAddress | IP address on the external firewall behind which the service is hosted. |
| Name | Type | Description | Attributes |
|---|---|---|---|
| rules | Array of PlcmNetworkRoutingRule | ||
| routes | Array of PlcmNetworkRoute | ||
| subInterfaces | Array of PlcmSubInterface | ||
| addresses | Array of PlcmNetworkAddress | ||
| name | string | A descriptive name for the interface. | |
| deviceName | string | Defines the name for the device to be configured, e.g. eth0 | Mandatory |
| state | PlcmNetworkInterfaceState | For a live network configuration, this value will not be null and will reflect the current operational state of the interface. For a saved network configuration, this value will be null. | |
| readOnly | boolean | Informs the client whether this interface can have its settings changed via this API | |
| macAddress | PlcmMacAddress | This address overrides the physical MAC address for this interface. The physical MAC address is found on the ethernet-interface container defined later in this module and is referred to as the hardware address. | |
| ipv4FailureIsFatal | boolean | Whether a failure to initialize ipv4 should be considered fatal with respect to the network service startup, i.e even if ipv6 is enabled and successfully initialized, the link will not be considered UP if ipv4 cannot be initialized. | |
| ipv6Init | boolean | If set to true, initialize this interface for ipv6 addressing. If set to false, do not initialize this interface for ipv6 addressing. False is the default value. This setting is required for ipv6 static and DHCP assignment of ipv6 addresses. It does not affect ipv6 Stateless Address Auto-Configuration (SLAAC) as per RFC 4862. | |
| ipv6FailureIsFatal | boolean | Whether a failure to initialize ipv6 should be considered fatal with respect to the network service startup, i.e even if ipv4 is enabled and successfully initialized, the link will not be considered UP if ipv6 cannot be initialized. | |
| ipv6AutoConfig | boolean | Defines whether this ipv6 interface has auto configuration turned on | |
| mtu | int | Maximum transmission unit for Ipv4 traffic through this interface | |
| ipv6Mtu | int | Maximum transmission unit for ipv6 traffic through this interface | |
| linkDelayTime | int | ||
| interfaceType | PlcmNetworkInterfaceType | Specifies the type of interface | |
| bootProtocol | PlcmNetworkBootProtocol | Defines the boot protocol setting for this interface | |
| onBoot | boolean | Defines whether interface is enabled on system boot up | |
| hardwareAddress | PlcmPhysAddress | The hardware address of the physical device or in the case of a bond interface, the hardware address to use for the channel (link aggregator) |
| Name | Type | Description | Attributes |
|---|---|---|---|
| plcmBondInterfaceList | Array of PlcmBondInterface | See Definition of PlcmBondInterface |
| Name | Type | Description | Attributes |
|---|---|---|---|
| services | Array of PlcmService | ||
| options | Array of PlcmBondingOption | ||
| rules | Array of PlcmNetworkRoutingRule | ||
| routes | Array of PlcmNetworkRoute | ||
| subInterfaces | Array of PlcmSubInterface | ||
| searchPathElements | Array of SearchPathElement | ||
| addresses | Array of PlcmNetworkAddress | ||
| name | string | A descriptive name for the interface. | |
| deviceName | string | Defines the name for the device to be configured, e.g. eth0 | Mandatory |
| state | PlcmNetworkInterfaceState | For a live network configuration, this value will not be null and will reflect the current operational state of the interface. For a saved network configuration, this value will be null. | |
| dscp | int | The Differentiated Services marker for outgoing traffic originating on the interface. | |
| readOnly | boolean | Informs the client whether this interface can have its settings changed via this API | |
| macAddress | PlcmMacAddress | This address overrides the physical MAC address for this interface. The physical MAC address is found on the ethernet-interface container defined later in this module and is referred to as the hardware address. | |
| ipv4FailureIsFatal | boolean | Whether a failure to initialize ipv4 should be considered fatal with respect to the network service startup, i.e even if ipv6 is enabled and successfully initialized, the link will not be considered UP if ipv4 cannot be initialized. | |
| ipv6Init | boolean | If set to true, initialize this interface for ipv6 addressing. If set to false, do not initialize this interface for ipv6 addressing. False is the default value. This setting is required for ipv6 static and DHCP assignment of ipv6 addresses. It does not affect ipv6 Stateless Address Auto-Configuration (SLAAC) as per RFC 4862. | |
| ipv6FailureIsFatal | boolean | Whether a failure to initialize ipv6 should be considered fatal with respect to the network service startup, i.e even if ipv4 is enabled and successfully initialized, the link will not be considered UP if ipv6 cannot be initialized. | |
| ipv6AutoConfig | boolean | Defines whether this ipv6 interface has auto configuration turned on | |
| mtu | int | Maximum transmission unit for Ipv4 traffic through this interface | |
| ipv6Mtu | int | Maximum transmission unit for ipv6 traffic through this interface | |
| ipv6Privacy | boolean | Defines whether this ipv6 interface has the privacy feature turned on | |
| ipv6Dhcp | boolean | Defines whether this interface has DHCP feature turned on for ipv6 | |
| ipv6DhcpOptions | Array of PlcmIpv6DhcpOption | Defines the DHCP options for ipv6 for this interface, if DHCP is turned on | |
| dhcpHostName | PlcmDomainName | The hostname of the DHCP server | |
| peerDns | boolean | When set to true, the DNS nameservers assigned by DHCP will be automatically added to the DNS configuration (/etc/resolv.conf) file. The DNS nameservers may be specified as one (or more) addresses for the interface with address-type set to DNS and an order value specified, e.g. 1,2,3. When using DHCP and specifying nameservers in this fashion, this option should be set to false, which will NOT write the DHCP assigned nameservers to the DNS configuration file. | |
| defRoute | boolean | Whether this interface represents the default gateway for the server | |
| dnsDomain | PlcmDomainName | DNS domain name for the server | |
| linkDelayTime | int | ||
| interfaceType | PlcmNetworkInterfaceType | Specifies the type of interface | |
| bootProtocol | PlcmNetworkBootProtocol | Defines the boot protocol setting for this interface | |
| onBoot | boolean | Defines whether interface is enabled on system boot up | |
| hardwareAddress | PlcmPhysAddress | The hardware address of the physical device or in the case of a bond interface, the hardware address to use for the channel (link aggregator) | |
| appConfig | string | Any application specific configuration that might be associated with this interface |
| Name | Type | Description | Attributes |
|---|---|---|---|
| services | Array of PlcmService | ||
| rules | Array of PlcmNetworkRoutingRule | ||
| routes | Array of PlcmNetworkRoute | ||
| searchPathElements | Array of SearchPathElement | ||
| addresses | Array of PlcmNetworkAddress | ||
| name | string | A descriptive name for the interface. | |
| deviceName | string | Defines the device name for the sub-interface to be configured, e.g. eth0.1, eth0.2, etc. NOTE: When configuring VLAN sub-interfaces, the sub-interface suffix number (.1, .2, etc.) MUST match the ID of the virtual network, i.e. the VLAN tag. For example, to configure a sub-interface of eth0 to use VLAN 492, the number suffix for the device name MUST be .492 resulting in the device name: eth0.492 | Mandatory |
| state | PlcmNetworkInterfaceState | For a live network configuration, this value will not be null and will reflect the current operational state of the interface. For a saved network configuration, this value will be null. | |
| dscp | int | The Differentiated Services marker for outgoing traffic originating on the interface. | |
| readOnly | boolean | Informs the client whether this interface can have its settings changed via this API | |
| macAddress | PlcmMacAddress | This address overrides the physical MAC address for this interface. The physical MAC address is found on the ethernet-interface container defined later in this module and is referred to as the hardware address. | |
| ipv4FailureIsFatal | boolean | Whether a failure to initialize ipv4 should be considered fatal with respect to the network service startup, i.e even if ipv6 is enabled and successfully initialized, the link will not be considered UP if ipv4 cannot be initialized. | |
| ipv6Init | boolean | If set to true, initialize this interface for ipv6 addressing. If set to false, do not initialize this interface for ipv6 addressing. False is the default value. This setting is required for ipv6 static and DHCP assignment of ipv6 addresses. It does not affect ipv6 Stateless Address Auto-Configuration (SLAAC) as per RFC 4862. | |
| ipv6FailureIsFatal | boolean | Whether a failure to initialize ipv6 should be considered fatal with respect to the network service startup, i.e even if ipv4 is enabled and successfully initialized, the link will not be considered UP if ipv6 cannot be initialized. | |
| ipv6AutoConfig | boolean | Defines whether this ipv6 interface has auto configuration turned on | |
| mtu | int | Maximum transmission unit for Ipv4 traffic through this interface | |
| ipv6Mtu | int | Maximum transmission unit for ipv6 traffic through this interface | |
| ipv6Privacy | boolean | Defines whether this ipv6 interface has the privacy feature turned on | |
| ipv6Dhcp | boolean | Defines whether this interface has DHCP feature turned on for ipv6 | |
| ipv6DhcpOptions | Array of PlcmIpv6DhcpOption | Defines the DHCP options for ipv6 for this interface, if DHCP is turned on | |
| dhcpHostName | PlcmDomainName | The hostname of the DHCP server | |
| peerDns | boolean | When set to true, the DNS nameservers assigned by DHCP will be automatically added to the DNS configuration (/etc/resolv.conf) file. The DNS nameservers may be specified as one (or more) addresses for the interface with address-type set to DNS and an order value specified, e.g. 1,2,3. When using DHCP and specifying nameservers in this fashion, this option should be set to false, which will NOT write the DHCP assigned nameservers to the DNS configuration file. | |
| defRoute | boolean | Whether this interface represents the default gateway for the server | |
| dnsDomain | PlcmDomainName | DNS domain name for the server | |
| linkDelayTime | int | ||
| bootProtocol | PlcmNetworkBootProtocol | Defines the boot protocol setting for this interface | |
| onParent | boolean | If set to true, the sub-interface will be brought up/down when the parent interface is brought up/down. | |
| vlan | boolean | If set to true, the sub-interface is for a VLAN network. The VLAN id is part of the device name. | |
| appConfig | string | Any application specific configuration that might be associated with this interface |
| Name | Type | Description | Attributes |
|---|---|---|---|
| driverName | string | Name of the network interface driver | |
| driverVersion | string | Version of the network interface driver | |
| firmwareVersion | string | Version of the firmware used by the network interface driver |
| Name | Type | Restrictions |
|---|---|---|
| BondMaster | string | Length of value must be >=1 Length of value must be <=32 |