xref: /openbmc/bmcweb/features/redfish/schema/dmtf/json-schema-installed/EthernetInterface.v1_12_4.json

{
    "$id": "http://redfish.dmtf.org/schemas/v1/EthernetInterface.v1_12_4.json",
    "$ref": "#/definitions/EthernetInterface",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2025 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
    "definitions": {
        "Actions": {
            "additionalProperties": false,
            "description": "The available actions for this resource.",
            "longDescription": "This type shall contain the available actions for this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "Oem": {
                    "$ref": "#/definitions/OemActions",
                    "description": "The available OEM-specific actions for this resource.",
                    "longDescription": "This property shall contain the available OEM-specific actions for this resource.",
                    "versionAdded": "v1_3_0"
                }
            },
            "type": "object"
        },
        "DHCPFallback": {
            "enum": [
                "Static",
                "AutoConfig",
                "None"
            ],
            "enumDescriptions": {
                "AutoConfig": "Fall back to an autoconfigured address.",
                "None": "Continue attempting DHCP without a fallback address.",
                "Static": "Fall back to a static address specified by `IPv4StaticAddresses`."
            },
            "enumLongDescriptions": {
                "AutoConfig": "DHCP shall fall back to an address generated by the implementation.",
                "None": "DHCP shall continue trying to obtain an address without falling back to a fixed address.",
                "Static": "DHCP shall fall back to a static address specified by `IPv4StaticAddresses`."
            },
            "type": "string"
        },
        "DHCPv4Configuration": {
            "additionalProperties": false,
            "description": "DHCPv4 configuration for this interface.",
            "longDescription": "This type shall describe the configuration of DHCP v4.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "DHCPEnabled": {
                    "description": "An indication of whether DHCP v4 is enabled on this Ethernet interface.",
                    "longDescription": "This property shall indicate whether DHCP v4 is enabled for this Ethernet interface.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                },
                "FallbackAddress": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/DHCPFallback"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "DHCPv4 fallback address method for this interface.",
                    "longDescription": "This property shall contain the fallback address method of DHCPv4.",
                    "readonly": false,
                    "versionAdded": "v1_5_0"
                },
                "UseDNSServers": {
                    "description": "An indication of whether this interface uses DHCP v4-supplied DNS servers.",
                    "longDescription": "This property shall indicate whether the interface uses DHCP v4-supplied DNS servers.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                },
                "UseDomainName": {
                    "description": "An indication of whether this interface uses a DHCP v4-supplied domain name.",
                    "longDescription": "This property shall indicate whether the interface uses a DHCP v4-supplied domain name.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                },
                "UseGateway": {
                    "description": "An indication of whether this interface uses a DHCP v4-supplied gateway.",
                    "longDescription": "This property shall indicate whether the interface uses a DHCP v4-supplied gateway.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                },
                "UseNTPServers": {
                    "description": "An indication of whether the interface uses DHCP v4-supplied NTP servers.",
                    "longDescription": "This property shall indicate whether the interface uses DHCP v4-supplied NTP servers.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                },
                "UseStaticRoutes": {
                    "description": "An indication of whether the interface uses DHCP v4-supplied static routes.",
                    "longDescription": "This property shall indicate whether the interface uses a DHCP v4-supplied static routes.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                }
            },
            "type": "object"
        },
        "DHCPv6Configuration": {
            "additionalProperties": false,
            "description": "DHCPv6 configuration for this interface.",
            "longDescription": "This type shall describe the configuration of DHCP v6.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "OperatingMode": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/DHCPv6OperatingMode"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "Determines the DHCPv6 operating mode for this interface.",
                    "longDescription": "This property shall control the operating mode of DHCPv6 on this interface.",
                    "readonly": false,
                    "versionAdded": "v1_4_0"
                },
                "UseDNSServers": {
                    "description": "An indication of whether the interface uses DHCP v6-supplied DNS servers.",
                    "longDescription": "This property shall indicate whether the interface uses DHCP v6-supplied DNS servers.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                },
                "UseDomainName": {
                    "description": "An indication of whether this interface uses a DHCP v6-supplied domain name.",
                    "longDescription": "This property shall indicate whether the interface uses a DHCP v6-supplied domain name.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                },
                "UseNTPServers": {
                    "description": "An indication of whether the interface uses DHCP v6-supplied NTP servers.",
                    "longDescription": "This property shall indicate whether the interface uses DHCP v6-supplied NTP servers.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                },
                "UseRapidCommit": {
                    "description": "An indication of whether the interface uses DHCP v6 rapid commit mode for stateful mode address assignments.  Do not enable this option in networks where more than one DHCP v6 server is configured to provide address assignments.",
                    "longDescription": "This property shall indicate whether the interface uses DHCP v6 rapid commit mode for stateful mode address assignments.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                }
            },
            "type": "object"
        },
        "DHCPv6OperatingMode": {
            "enum": [
                "Stateful",
                "Stateless",
                "Disabled",
                "Enabled"
            ],
            "enumDeprecated": {
                "Stateful": "This property has been deprecated in favor of `Enabled`.  The control between 'stateful' and 'stateless' is managed by the DHCP server and not the client.",
                "Stateless": "This property has been deprecated in favor of `Enabled`.  The control between 'stateful' and 'stateless' is managed by the DHCP server and not the client."
            },
            "enumDescriptions": {
                "Disabled": "DHCPv6 is disabled.",
                "Enabled": "DHCPv6 is enabled.",
                "Stateful": "DHCPv6 stateful mode.",
                "Stateless": "DHCPv6 stateless mode."
            },
            "enumLongDescriptions": {
                "Disabled": "DHCPv6 shall be disabled for this interface.",
                "Enabled": "DHCPv6 shall be enabled for this interface.",
                "Stateful": "DHCPv6 shall operate in stateful mode on this interface.  DHCPv6 stateful mode configures addresses, and when it is enabled, stateless mode is also implicitly enabled.  Services may replace this value with `Enabled`.",
                "Stateless": "DHCPv6 shall operate in stateless mode on this interface.  DHCPv6 stateless mode allows configuring the interface using DHCP options but does not configure addresses.  It is always enabled by default whenever DHCPv6 stateful mode is also enabled.  Services may replace this value with `Enabled`."
            },
            "enumVersionAdded": {
                "Enabled": "v1_8_0"
            },
            "enumVersionDeprecated": {
                "Stateful": "v1_8_0",
                "Stateless": "v1_8_0"
            },
            "type": "string"
        },
        "EthernetDeviceType": {
            "enum": [
                "Physical",
                "Virtual"
            ],
            "enumDescriptions": {
                "Physical": "A physical Ethernet interface.",
                "Virtual": "A virtual Ethernet interface."
            },
            "enumLongDescriptions": {
                "Physical": "This value shall indicate a physical traditional network interface.",
                "Virtual": "This value shall indicate a network device function has multiple VLANs and is representing one of them as a virtual Ethernet interface.  The `NetworkDeviceFunction` property within Links shall contain the locator for the parent network device function."
            },
            "type": "string"
        },
        "EthernetInterface": {
            "additionalProperties": false,
            "description": "The `EthernetInterface` schema represents a single, logical Ethernet interface or network interface controller (NIC).",
            "longDescription": "This resource contains NIC resources as part of the Redfish Specification.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "@odata.context": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
                },
                "@odata.etag": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
                },
                "@odata.id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
                },
                "@odata.type": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
                },
                "Actions": {
                    "$ref": "#/definitions/Actions",
                    "description": "The available actions for this resource.",
                    "longDescription": "This property shall contain the available actions for this resource.",
                    "versionAdded": "v1_3_0"
                },
                "AutoNeg": {
                    "description": "An indication of whether the speed and duplex are automatically negotiated and configured on this interface.",
                    "longDescription": "This property shall indicate whether the speed and duplex are automatically negotiated and configured on this interface.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "DHCPv4": {
                    "$ref": "#/definitions/DHCPv4Configuration",
                    "description": "DHCPv4 configuration for this interface.",
                    "longDescription": "This property shall contain the configuration of DHCP v4.",
                    "versionAdded": "v1_4_0"
                },
                "DHCPv6": {
                    "$ref": "#/definitions/DHCPv6Configuration",
                    "description": "DHCPv6 configuration for this interface.",
                    "longDescription": "This property shall contain the configuration of DHCP v6.",
                    "versionAdded": "v1_4_0"
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "EthernetInterfaceType": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/EthernetDeviceType"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The type of interface.",
                    "longDescription": "This property shall contain the type of interface.",
                    "readonly": true,
                    "versionAdded": "v1_6_0"
                },
                "FQDN": {
                    "description": "The complete, fully qualified domain name that DNS obtains for this interface.",
                    "longDescription": "This property shall contain the fully qualified domain name that DNS obtains for this interface.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "FullDuplex": {
                    "description": "An indication of whether full-duplex mode is enabled on the Ethernet connection for this interface.",
                    "longDescription": "This property shall indicate whether full-duplex mode is enabled on the Ethernet connection for this interface.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "HostName": {
                    "description": "The DNS host name, without any domain information.",
                    "longDescription": "This property shall contain the DNS host name for this interface.  Modifying this property may modify the `HostName` in one or more `EthernetInterface` resources that belong to the same system, manager, or other device.  If this interface is subordinate to a `ComputerSystem` resource, modifying this property may modify the `HostName` of the `ComputerSystem` resource that contains this interface.  If this interface is subordinate to a `Manager` resource, modifying this property may modify the `HostName` of the `ManagerNetworkProtocol` resource of the `Manager` resource that contains this interface.  Services should ignore this property in modification requests if `FQDN` is also provided in the same request.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "IPv4Addresses": {
                    "description": "The IPv4 addresses currently in use by this interface.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv4Address"
                    },
                    "longDescription": "This property shall contain an array of objects that represent the IPv4 connection characteristics currently in use by this interface for any value of `AddressOrigin`.  It is recommended that this property be regarded as read-only with configuration of static addresses performed by updating the values within `IPv4StaticAddresses`.  Services may reject updates to this array for this reason.  This property should contain an empty array if there are no active IPv4 addresses.",
                    "type": "array"
                },
                "IPv4StaticAddresses": {
                    "description": "The IPv4 static addresses assigned to this interface.  See `IPv4Addresses` for the addresses in use by this interface.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv4Address"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "This property shall contain an array of objects that represent all IPv4 static addresses assigned to, but not necessarily in use by, this interface.  The `IPv4Addresses` property shall also list the addresses that this interface uses.  Services should represent static addresses that are not configured as `null` values, as described by the 'PATCH on array properties' clause of the Redfish Specification.  Services should not represent static addresses that are not configured as invalid IP addresses, such as `0.0.0.0`.",
                    "type": "array",
                    "versionAdded": "v1_4_0"
                },
                "IPv6AddressPolicyTable": {
                    "description": "An array that represents the RFC6724-defined address selection policy table.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "#/definitions/IPv6AddressPolicyEntry"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "This property shall contain an array of objects that represent the RFC6724-defined address selection policy table.",
                    "type": "array"
                },
                "IPv6Addresses": {
                    "description": "The IPv6 addresses currently in use by this interface.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv6Address"
                    },
                    "longDescription": "This property shall contain an array of objects that represent the IPv6 connection characteristics for this interface for any value of  `AddressOrigin`.  This property should contain an empty array if there are no active IPv6 addresses.",
                    "type": "array"
                },
                "IPv6DefaultGateway": {
                    "description": "The IPv6 default gateway address in use on this interface.",
                    "longDescription": "This property shall contain the current IPv6 default gateway address in use on this interface.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "IPv6Enabled": {
                    "description": "An indication of whether IPv6 is enabled on this interface.",
                    "longDescription": "This property shall indicate whether IPv6 is enabled on this interface.  If this property contains `false`, the interface shall not contain any assigned IPv6 addresses, shall not initiate DHCPv6 requests, and shall not send or process ICMPv6 packets.  If this property is not present, but this interface contains other IPv6 properties, the value shall be assumed to be `true`.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_12_0"
                },
                "IPv6StaticAddresses": {
                    "description": "The IPv6 static addresses assigned to this interface.  See `IPv6Addresses` for the addresses in use by this interface.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv6StaticAddress"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "This property shall contain an array of objects that represent the IPv6 static connection characteristics for this interface.  Services should represent static addresses that are not configured as `null` values, as described by the 'PATCH on array properties' clause of the Redfish Specification.  Services should not represent static addresses that are not configured as invalid IP addresses, such as `::`.",
                    "type": "array"
                },
                "IPv6StaticDefaultGateways": {
                    "description": "The IPv6 static default gateways for this interface.",
                    "items": {
                        "anyOf": [
                            {
                                "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv6GatewayStaticAddress"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "longDescription": "The values in this array shall represent the IPv6 static default gateway addresses for this interface.",
                    "type": "array",
                    "versionAdded": "v1_4_0"
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "InterfaceEnabled": {
                    "description": "An indication of whether this interface is enabled.",
                    "longDescription": "This property shall indicate whether this interface is enabled.  If this interface is also a host interface, modifying this property may modify the `InterfaceEnabled` property in the `HostInterface` resource for this interface.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ]
                },
                "LinkStatus": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/LinkStatus"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The link status of this interface, or port.",
                    "longDescription": "This property shall contain the link status of this interface, or port.",
                    "readonly": true,
                    "versionAdded": "v1_1_0"
                },
                "Links": {
                    "$ref": "#/definitions/Links",
                    "description": "The links to other resources that are related to this resource.",
                    "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.",
                    "versionAdded": "v1_1_0"
                },
                "MACAddress": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/MACAddress"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The currently configured MAC address of the interface, or logical port.",
                    "longDescription": "This property shall contain the effective current MAC address of this interface.  If an assignable MAC address is not supported, this value is a read-only alias of the PermanentMACAddress.",
                    "readonly": false
                },
                "MTUSize": {
                    "description": "The currently configured maximum transmission unit (MTU), in bytes, on this interface.",
                    "longDescription": "This property shall contain the size, in bytes, of the largest protocol data unit (PDU) that can be passed in an Ethernet (MAC) frame on this interface, as currently configured by the operating system or driver.",
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "MaxIPv6StaticAddresses": {
                    "description": "The maximum number of static IPv6 addresses that can be configured on this interface.",
                    "longDescription": "This property shall indicate the number of array items supported by `IPv6StaticAddresses`, or the maximum number of static IPv6 addresses that can be configured on this interface.",
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "Name": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
                    "readonly": true
                },
                "NameServers": {
                    "description": "The DNS servers in use on this interface.",
                    "items": {
                        "type": "string"
                    },
                    "longDescription": "This property shall contain the DNS servers in use on this interface.",
                    "readonly": true,
                    "type": "array"
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "The OEM extension property.",
                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
                },
                "PermanentMACAddress": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/MACAddress"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The permanent MAC address assigned to this interface, or port.",
                    "longDescription": "This property shall contain the permanent MAC address of this interface, or port.  Typically, this value is programmed during manufacturing.  This address is not assignable.",
                    "readonly": true
                },
                "RoutingScope": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/RoutingScope"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The routing scope for this interface.",
                    "longDescription": "This property shall contain the routing scope for this interface.  This property shall only be present if this interface belongs to a virtual machine or container.",
                    "readonly": true,
                    "versionAdded": "v1_11_0"
                },
                "SpeedMbps": {
                    "description": "The current speed, in Mbit/s, of this interface.",
                    "longDescription": "This property shall contain the link speed of the interface, in megabits per second (Mbit/s) units.  This property shall be writable only when the `AutoNeg` property is `false`.",
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ],
                    "units": "Mbit/s"
                },
                "StatelessAddressAutoConfig": {
                    "$ref": "#/definitions/StatelessAddressAutoConfiguration",
                    "description": "Stateless address autoconfiguration (SLAAC) parameters for this interface.",
                    "longDescription": "This object shall contain the IPv4 and IPv6 stateless address automatic configuration (SLAAC) properties for this interface.",
                    "versionAdded": "v1_4_0"
                },
                "StaticNameServers": {
                    "description": "The statically-defined set of DNS server IPv4 and IPv6 addresses.",
                    "items": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "longDescription": "This property shall contain the statically-defined set of DNS server IP addresses to use when DHCP provisioning is not enabled for name server configuration.  As an implementation option, they can be used in addition to DHCP-provided addresses, or in cases where the DHCP server provides no DNS assignments.",
                    "readonly": false,
                    "type": "array",
                    "versionAdded": "v1_4_0"
                },
                "Status": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
                    "description": "The status and health of the resource and its subordinate or dependent resources.",
                    "longDescription": "This property shall contain any status or health properties of the resource."
                },
                "TeamMode": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/TeamMode"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The team mode for this interface.",
                    "longDescription": "This property shall contain the team mode for this interface.  If this property is not present, the value shall be assumed to be `None`.",
                    "readonly": false,
                    "versionAdded": "v1_9_0"
                },
                "UefiDevicePath": {
                    "description": "The UEFI device path for this interface.",
                    "longDescription": "This property shall contain the UEFI device path to the device that implements this interface, or port.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "VLAN": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/VLanNetworkInterface.json#/definitions/VLAN",
                    "description": "If this network interface supports more than one VLAN, this property is absent.  VLAN collections appear in the `Links` property of this resource.",
                    "longDescription": "This property shall contain the VLAN for this interface.  If this interface supports more than one VLAN, the `VLAN` property shall be absent and, instead, the VLAN collection link shall be present."
                },
                "VLANs": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/VLanNetworkInterfaceCollection.json#/definitions/VLanNetworkInterfaceCollection",
                    "deprecated": "This property has been deprecated in favor of newer methods indicating multiple VLANs.",
                    "description": "The link to a collection of VLANs, which applies only if the interface supports more than one VLAN.  If this property applies, the `VLANEnabled` and `VLANId` properties do not apply.",
                    "longDescription": "This property shall contain a link to a resource collection of type `VLanNetworkInterfaceCollection`, which applies only if the interface supports more than one VLAN.  If this property is present, the `VLANEnabled` and `VLANId` properties shall not be present.",
                    "readonly": true,
                    "versionDeprecated": "v1_7_0"
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "requiredOnCreate": [
                "Links"
            ],
            "type": "object"
        },
        "IPv6AddressPolicyEntry": {
            "additionalProperties": false,
            "description": "The entry in the RFC6724-defined address selection policy table.",
            "longDescription": "This type shall describe an entry in the RFC6724-defined address selection policy table.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "Label": {
                    "description": "The IPv6 label, as defined in RFC6724, section 2.1.",
                    "longDescription": "This property shall contain the IPv6 label value for this table entry, as defined in RFC6724, section 2.1.",
                    "maximum": 100,
                    "minimum": 0,
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "Precedence": {
                    "description": "The IPv6 precedence, as defined in RFC6724, section 2.1.",
                    "longDescription": "This property shall contain the IPv6 precedence value for this table entry, as defined in RFC6724, section 2.1.",
                    "maximum": 100,
                    "minimum": 1,
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "Prefix": {
                    "description": "The IPv6 address prefix, as defined in RFC6724, section 2.1.",
                    "longDescription": "This property shall contain the IPv6 address prefix for this table entry, as defined in RFC6724, section 2.1.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                }
            },
            "type": "object"
        },
        "LinkStatus": {
            "enum": [
                "LinkUp",
                "NoLink",
                "LinkDown"
            ],
            "enumDescriptions": {
                "LinkDown": "No link is detected on this interface, but the interface is connected.",
                "LinkUp": "The link is available for communication on this interface.",
                "NoLink": "No link or connection is detected on this interface."
            },
            "type": "string"
        },
        "Links": {
            "additionalProperties": false,
            "description": "The links to other resources that are related to this resource.",
            "longDescription": "This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "AffiliatedInterfaces": {
                    "description": "The links to the Ethernet interfaces that are affiliated with this interface, such as a VLAN or a team that uses this interface.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/EthernetInterface.json#/definitions/EthernetInterface"
                    },
                    "longDescription": "This property shall contain an array of links to resources of type `EthernetInterface` that represent the Ethernet interfaces that are affiliated with this interface.  `EthernetInterface` resources referenced in this property shall reference this resource in their `RelatedInterfaces` property.",
                    "readonly": true,
                    "type": "array",
                    "versionAdded": "v1_10_0"
                },
                "AffiliatedInterfaces@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                },
                "Chassis": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis",
                    "description": "The link to the chassis that contains this Ethernet interface.",
                    "longDescription": "This property shall contain a link to a resource of type `Chassis` that represent the physical container associated with this Ethernet interface.",
                    "readonly": true,
                    "versionAdded": "v1_3_0"
                },
                "Endpoints": {
                    "description": "An array of links to the endpoints that connect to this Ethernet interface.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint"
                    },
                    "longDescription": "This property shall contain an array of links to resources of type `Endpoint` with which this Ethernet interface is associated.",
                    "readonly": true,
                    "type": "array",
                    "versionAdded": "v1_1_0"
                },
                "Endpoints@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                },
                "HostInterface": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/HostInterface.json#/definitions/HostInterface",
                    "description": "The link to a Host Interface that is associated with this Ethernet interface.",
                    "longDescription": "This property shall contain a link to a resource of type `HostInterface` that represents the interface that a host uses to communicate with a manager.",
                    "readonly": true,
                    "versionAdded": "v1_2_0"
                },
                "NetworkDeviceFunction": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.json#/definitions/NetworkDeviceFunction"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "deprecated": "This property has been deprecated in favor of `NetworkDeviceFunctions` as each `EthernetInterface` could represent more than one `NetworkDeviceFunction`.",
                    "description": "The link to the parent network device function and is only used when representing one of the VLANs on that network device function, such as is done in Unix.",
                    "longDescription": "This property shall contain a link to a resource of type `NetworkDeviceFunction` and only be populated with the `EthernetInterfaceType` property is `Virtual`.",
                    "readonly": true,
                    "versionAdded": "v1_6_0",
                    "versionDeprecated": "v1_7_0"
                },
                "NetworkDeviceFunctions": {
                    "description": "The link to the network device functions that constitute this Ethernet interface.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.json#/definitions/NetworkDeviceFunction"
                    },
                    "longDescription": "This property shall contain an array of links to resources of type `NetworkDeviceFunction`.",
                    "readonly": true,
                    "type": "array",
                    "versionAdded": "v1_7_0"
                },
                "NetworkDeviceFunctions@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "The OEM extension property.",
                    "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
                },
                "Ports": {
                    "description": "The links to the ports providing this Ethernet interface.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Port.json#/definitions/Port"
                    },
                    "longDescription": "This property shall contain an array of links to resources of type `Port` that represent the ports providing this Ethernet interface.  This property shall not be present if the Ethernet interface is not directly associated to a physical port.",
                    "readonly": true,
                    "type": "array",
                    "versionAdded": "v1_9_0"
                },
                "Ports@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                },
                "RelatedInterfaces": {
                    "description": "The links to the Ethernet interfaces that constitute this Ethernet interface.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/EthernetInterface.json#/definitions/EthernetInterface"
                    },
                    "longDescription": "This property shall contain an array of links to resources of type `EthernetInterface`.  If `TeamMode` contains `None`, this property shall contain one member that represents the parent interface for the VLAN.  For other values of TeamMode, this property shall contain the members of the team.",
                    "readonly": false,
                    "type": "array",
                    "versionAdded": "v1_9_0"
                },
                "RelatedInterfaces@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
                }
            },
            "requiredOnCreate": [
                "RelatedInterfaces"
            ],
            "type": "object"
        },
        "MACAddress": {
            "pattern": "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$",
            "type": "string"
        },
        "OemActions": {
            "additionalProperties": true,
            "description": "The available OEM-specific actions for this resource.",
            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {},
            "type": "object"
        },
        "RoutingScope": {
            "enum": [
                "External",
                "HostOnly",
                "Internal",
                "Limited"
            ],
            "enumDescriptions": {
                "External": "Externally accessible.",
                "HostOnly": "Only accessible to a dedicated interface on the host.",
                "Internal": "Only accessible to internal networking on the host, such as when virtual machines or containers are allowed to communicate with each other on the same host system as well as a dedicated interface on the hosting system.",
                "Limited": "Accessible through IP translation provided by the hosting system."
            },
            "enumLongDescriptions": {
                "External": "This value shall indicate this interface is externally accessible as if it were physically on the same network as the hosting system.",
                "HostOnly": "This value shall indicate this interface is only accessible to a dedicated interface on the hosting system.",
                "Internal": "This value shall indicate this interface is only accessible to internal networking on the host, such as when virtual machines or containers are allowed to communicate with each other on the same host system as well as a dedicated interface on the hosting system.",
                "Limited": "This value shall indicate this interface is accessible through IP translation provided by the hosting system, such as a NAT (network address translation)."
            },
            "type": "string"
        },
        "StatelessAddressAutoConfiguration": {
            "additionalProperties": false,
            "description": "Stateless address autoconfiguration (SLAAC) parameters for this interface.",
            "longDescription": "This type shall describe the IPv4 and IPv6 stateless address autoconfiguration (SLAAC) for this interface.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "IPv4AutoConfigEnabled": {
                    "description": "An indication of whether IPv4 stateless address autoconfiguration (SLAAC) is enabled for this interface.",
                    "longDescription": "This property shall indicate whether IPv4 stateless address autoconfiguration (SLAAC) is enabled for this interface.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                },
                "IPv6AutoConfigEnabled": {
                    "description": "An indication of whether IPv6 stateless address autoconfiguration (SLAAC) is enabled for this interface.",
                    "longDescription": "This property shall indicate whether IPv6 stateless address autoconfiguration (SLAAC) is enabled for this interface.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "versionAdded": "v1_4_0"
                }
            },
            "type": "object"
        },
        "TeamMode": {
            "enum": [
                "None",
                "RoundRobin",
                "ActiveBackup",
                "XOR",
                "Broadcast",
                "IEEE802_3ad",
                "AdaptiveTransmitLoadBalancing",
                "AdaptiveLoadBalancing"
            ],
            "enumDescriptions": {
                "ActiveBackup": "One interface in the team is active and the others are kept in standby until a failure occurs.",
                "AdaptiveLoadBalancing": "Packets are transmitted and received based upon the current load of each interface in the team.",
                "AdaptiveTransmitLoadBalancing": "Packets are transmitted based upon the current load of each interface in the team.",
                "Broadcast": "Packets are transmitted on all interfaces in the team.",
                "IEEE802_3ad": "The interfaces in the team create an IEEE802.3ad link aggregation group.",
                "None": "No teaming.",
                "RoundRobin": "Packets are transmitted in sequential order from the teamed interfaces.",
                "XOR": "Transmitting is determined based upon a hash policy."
            },
            "type": "string"
        }
    },
    "language": "en",
    "owningEntity": "DMTF",
    "release": "2023.3",
    "title": "#EthernetInterface.v1_12_4.EthernetInterface"
}