components:
  schemas:
    EthernetInterface_v1_3_14_Actions:
      additionalProperties: false
      description: The available actions for this resource.
      properties:
        Oem:
          $ref: '#/components/schemas/EthernetInterface_v1_3_14_OemActions'
          description: The available OEM-specific actions for this resource.
          x-longDescription: This property shall contain the available OEM-specific
            actions for this resource.
          x-versionAdded: v1_3_0
      type: object
      x-longDescription: This type shall contain the available actions for this resource.
      x-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.
    EthernetInterface_v1_3_14_EthernetInterface:
      additionalProperties: false
      description: The `EthernetInterface` schema represents a single, logical Ethernet
        interface or network interface controller (NIC).
      properties:
        '@odata.context':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_context
        '@odata.etag':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_etag
        '@odata.id':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_id
        '@odata.type':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_type
        Actions:
          $ref: '#/components/schemas/EthernetInterface_v1_3_14_Actions'
          description: The available actions for this resource.
          x-longDescription: This property shall contain the available actions for
            this resource.
          x-versionAdded: v1_3_0
        AutoNeg:
          description: An indication of whether the speed and duplex are automatically
            negotiated and configured on this interface.
          nullable: true
          readOnly: false
          type: boolean
          x-longDescription: This property shall indicate whether the speed and duplex
            are automatically negotiated and configured on this interface.
        Description:
          oneOf:
          - $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Description
          - enum:
            - null
          readOnly: true
        FQDN:
          description: The complete, fully qualified domain name that DNS obtains
            for this interface.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: This property shall contain the fully qualified domain
            name that DNS obtains for this interface.
        FullDuplex:
          description: An indication of whether full-duplex mode is enabled on the
            Ethernet connection for this interface.
          nullable: true
          readOnly: false
          type: boolean
          x-longDescription: This property shall indicate whether full-duplex mode
            is enabled on the Ethernet connection for this interface.
        HostName:
          description: The DNS host name, without any domain information.
          nullable: true
          readOnly: false
          type: string
          x-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.
        IPv4Addresses:
          description: The IPv4 addresses currently in use by this interface.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/IPAddresses.yaml#/components/schemas/IPAddresses_IPv4Address
          type: array
          x-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.
        IPv6AddressPolicyTable:
          description: An array that represents the RFC6724-defined address selection
            policy table.
          items:
            oneOf:
            - $ref: '#/components/schemas/EthernetInterface_v1_3_14_IPv6AddressPolicyEntry'
            - enum:
              - null
          type: array
          x-longDescription: This property shall contain an array of objects that
            represent the RFC6724-defined address selection policy table.
        IPv6Addresses:
          description: The IPv6 addresses currently in use by this interface.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/IPAddresses.yaml#/components/schemas/IPAddresses_IPv6Address
          type: array
          x-longDescription: This property shall contain an array of objects that
            represent the IPv6 connection characteristics for this interface for any
            value of  `AddressOrigin`.
        IPv6DefaultGateway:
          description: The IPv6 default gateway address in use on this interface.
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain the current IPv6 default
            gateway address in use on this interface.
        IPv6StaticAddresses:
          description: The IPv6 static addresses assigned to this interface.  See
            `IPv6Addresses` for the addresses in use by this interface.
          items:
            oneOf:
            - $ref: http://redfish.dmtf.org/schemas/v1/IPAddresses.yaml#/components/schemas/IPAddresses_IPv6StaticAddress
            - enum:
              - null
          type: array
          x-longDescription: This property shall contain an array of objects that
            represent the IPv6 static connection characteristics for this interface.
        Id:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Id
          readOnly: true
        InterfaceEnabled:
          description: An indication of whether this interface is enabled.
          nullable: true
          readOnly: false
          type: boolean
          x-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.
        LinkStatus:
          description: The link status of this interface, or port.
          oneOf:
          - $ref: '#/components/schemas/EthernetInterface_v1_3_14_LinkStatus'
          - enum:
            - null
          readOnly: true
          x-longDescription: This property shall contain the link status of this interface,
            or port.
          x-versionAdded: v1_1_0
        Links:
          $ref: '#/components/schemas/EthernetInterface_v1_3_14_Links'
          description: The links to other resources that are related to this resource.
          x-longDescription: This property shall contain links to resources that are
            related to but are not contained by, or subordinate to, this resource.
          x-versionAdded: v1_1_0
        MACAddress:
          description: The currently configured MAC address of the interface, or logical
            port.
          oneOf:
          - $ref: '#/components/schemas/EthernetInterface_v1_3_14_MACAddress'
          - enum:
            - null
          readOnly: false
          x-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.
        MTUSize:
          description: The currently configured maximum transmission unit (MTU), in
            bytes, on this interface.
          format: int64
          nullable: true
          readOnly: false
          type: integer
          x-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.
        MaxIPv6StaticAddresses:
          description: The maximum number of static IPv6 addresses that can be configured
            on this interface.
          format: int64
          nullable: true
          readOnly: true
          type: integer
          x-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.
        Name:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Name
          readOnly: true
        NameServers:
          description: The DNS servers in use on this interface.
          items:
            type: string
          readOnly: true
          type: array
          x-longDescription: This property shall contain the DNS servers in use on
            this interface.
        Oem:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Oem
          description: The OEM extension property.
          x-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:
          description: The permanent MAC address assigned to this interface, or port.
          oneOf:
          - $ref: '#/components/schemas/EthernetInterface_v1_3_14_MACAddress'
          - enum:
            - null
          readOnly: true
          x-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.
        SpeedMbps:
          description: The current speed, in Mbit/s, of this interface.
          format: int64
          nullable: true
          readOnly: false
          type: integer
          x-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`.
          x-units: Mbit/s
        Status:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Status
          description: The status and health of the resource and its subordinate or
            dependent resources.
          x-longDescription: This property shall contain any status or health properties
            of the resource.
        UefiDevicePath:
          description: The UEFI device path for this interface.
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain the UEFI device path to the
            device that implements this interface, or port.
        VLAN:
          $ref: http://redfish.dmtf.org/schemas/v1/VLanNetworkInterface.yaml#/components/schemas/VLanNetworkInterface_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.
          x-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/odata-v4.yaml#/components/schemas/odata-v4_idRef
          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.
          readOnly: true
          x-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.
      required:
      - '@odata.id'
      - '@odata.type'
      - Id
      - Name
      type: object
      x-longDescription: This resource contains NIC resources as part of the Redfish
        Specification.
      x-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.
      x-requiredOnCreate:
      - Links
    EthernetInterface_v1_3_14_IPv6AddressPolicyEntry:
      additionalProperties: false
      description: The entry in the RFC6724-defined address selection policy table.
      properties:
        Label:
          description: The IPv6 label, as defined in RFC6724, section 2.1.
          format: int64
          maximum: 100
          minimum: 0
          nullable: true
          readOnly: false
          type: integer
          x-longDescription: This property shall contain the IPv6 label value for
            this table entry, as defined in RFC6724, section 2.1.
        Precedence:
          description: The IPv6 precedence, as defined in RFC6724, section 2.1.
          format: int64
          maximum: 100
          minimum: 1
          nullable: true
          readOnly: false
          type: integer
          x-longDescription: This property shall contain the IPv6 precedence value
            for this table entry, as defined in RFC6724, section 2.1.
        Prefix:
          description: The IPv6 address prefix, as defined in RFC6724, section 2.1.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: This property shall contain the IPv6 address prefix for
            this table entry, as defined in RFC6724, section 2.1.
      type: object
      x-longDescription: This type shall describe an entry in the RFC6724-defined
        address selection policy table.
      x-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.
    EthernetInterface_v1_3_14_LinkStatus:
      enum:
      - LinkUp
      - NoLink
      - LinkDown
      type: string
      x-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.
    EthernetInterface_v1_3_14_Links:
      additionalProperties: false
      description: The links to other resources that are related to this resource.
      properties:
        Chassis:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The link to the chassis that contains this Ethernet interface.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource of type
            `Chassis` that represent the physical container associated with this Ethernet
            interface.
          x-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/odata-v4.yaml#/components/schemas/odata-v4_idRef
          readOnly: true
          type: array
          x-longDescription: This property shall contain an array of links to resources
            of type `Endpoint` with which this Ethernet interface is associated.
          x-versionAdded: v1_1_0
        Endpoints@odata.count:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_count
        HostInterface:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: The link to a Host Interface that is associated with this Ethernet
            interface.
          readOnly: true
          x-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.
          x-versionAdded: v1_2_0
        Oem:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Oem
          description: The OEM extension property.
          x-longDescription: This property shall contain the OEM extensions.  All
            values for properties contained in this object shall conform to the Redfish
            Specification-described requirements.
      type: object
      x-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.
      x-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.
    EthernetInterface_v1_3_14_MACAddress:
      pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$
      type: string
    EthernetInterface_v1_3_14_OemActions:
      additionalProperties: true
      description: The available OEM-specific actions for this resource.
      properties: {}
      type: object
      x-longDescription: This type shall contain the available OEM-specific actions
        for this resource.
      x-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.
title: '#EthernetInterface.v1_3_14.EthernetInterface'
x-copyright: Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright
x-language: en
x-owningEntity: DMTF
x-release: '2017.1'
