components: schemas: EthernetInterface_v1_5_0_Actions: additionalProperties: false description: The available actions for this resource. properties: Oem: $ref: '#/components/schemas/EthernetInterface_v1_5_0_OemActions' description: This property contains the available OEM specific actions for this resource. x-longDescription: This property shall contain any additional OEM 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_5_0_DHCPFallback: enum: - Static - AutoConfig - None type: string x-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. x-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. EthernetInterface_v1_5_0_DHCPv4Configuration: additionalProperties: false description: DHCPv4 configuration for this interface. properties: DHCPEnabled: description: Determines whether DHCPv4 is enabled on this interface. nullable: true readOnly: false type: boolean x-longDescription: This property shall indicate whether DHCP v4 is enabled for this EthernetInterface. x-versionAdded: v1_4_0 FallbackAddress: $ref: '#/components/schemas/EthernetInterface_v1_5_0_DHCPFallback' description: DHCPv4 fallback address method for this interface. nullable: true readOnly: false x-longDescription: This property shall contain the fallback address method of DHCPv4. x-versionAdded: v1_5_0 UseDNSServers: description: Determines whether to use DHCPv4-supplied DNS servers. nullable: true readOnly: false type: boolean x-longDescription: This property shall indicate whether the interface will use DHCPv4-supplied DNS servers. x-versionAdded: v1_4_0 UseDomainName: description: Determines whether to use a DHCPv4-supplied domain name. nullable: true readOnly: false type: boolean x-longDescription: This property shall indicate whether the interface will use a DHCPv4-supplied domain name. x-versionAdded: v1_4_0 UseGateway: description: Determines whether to use a DHCPv4-supplied gateway. nullable: true readOnly: false type: boolean x-longDescription: This property shall indicate whether the interface will use a DHCPv4-supplied gateway. x-versionAdded: v1_4_0 UseNTPServers: description: Determines whether to use DHCPv4-supplied NTP servers. nullable: true readOnly: false type: boolean x-longDescription: This property shall indicate whether the interface will use DHCPv4-supplied NTP servers. x-versionAdded: v1_4_0 UseStaticRoutes: description: Determines whether to use DHCPv4-supplied static routes. nullable: true readOnly: false type: boolean x-longDescription: This property shall indicate whether the interface will use a DHCPv4-supplied static routes. x-versionAdded: v1_4_0 type: object x-longDescription: This type shall describe the configuration of DHCP v4. 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_5_0_DHCPv6Configuration: additionalProperties: false description: DHCPv6 configuration for this interface. properties: OperatingMode: $ref: '#/components/schemas/EthernetInterface_v1_5_0_DHCPv6OperatingMode' description: Determines the DHCPv6 operating mode for this interface. nullable: true readOnly: false x-longDescription: This property shall control the operating mode of DHCPv6 on this interface. DHCPv6 stateful mode is used to configure addresses, and when it is enabled, stateless mode is also implicitly enabled. x-versionAdded: v1_4_0 UseDNSServers: description: When enabled, DNS server addresses supplied through DHCPv6 stateless mode will be used. nullable: true readOnly: false type: boolean x-longDescription: This property shall indicate whether the interface will use DHCPv6-supplied DNS servers. x-versionAdded: v1_4_0 UseDomainName: description: When enabled, the domain name supplied through DHCPv6 stateless mode will be used. nullable: true readOnly: false type: boolean x-longDescription: This property shall indicate whether the interface will use a domain name supplied through DHCPv6 stateless mode. x-versionAdded: v1_4_0 UseNTPServers: description: When enabled, NTP server addresses supplied through DHCPv6 stateless mode will be used. nullable: true readOnly: false type: boolean x-longDescription: This property shall indicate whether the interface will use DHCPv6-supplied NTP servers. x-versionAdded: v1_4_0 UseRapidCommit: description: Determines whether to use DHCPv6 rapid commit mode for stateful mode address assignments. Do not enable in networks where more than one DHCPv6 server is configured to provide address assignments. nullable: true readOnly: false type: boolean x-longDescription: This property shall indicate whether the interface will use DHCPv6 rapid commit mode for stateful mode address assignments. x-versionAdded: v1_4_0 type: object x-longDescription: This type shall describe the configuration of DHCP v6. 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_5_0_DHCPv6OperatingMode: enum: - Stateful - Stateless - Disabled type: string x-enumDescriptions: Disabled: DHCPv6 is disabled. Stateful: DHCPv6 stateful mode. Stateless: DHCPv6 stateless mode. x-enumLongDescriptions: Disabled: DHCPv6 shall be disabled for this interface. Stateful: DHCPv6 shall operate in stateful mode on this interface. DHCPv6 stateful mode is used to configure addresses, and when it is enabled, stateless mode is also implicitly 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. EthernetInterface_v1_5_0_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_5_0_Actions' description: The available actions for this resource. x-longDescription: The Actions property shall contain the available actions for this resource. x-versionAdded: v1_3_0 AutoNeg: description: This indicates if the speed and duplex are automatically negotiated and configured on this interface. nullable: true readOnly: false type: boolean x-longDescription: The value of this property shall be true if auto negotiation of speed and duplex is enabled on this interface and false if it is disabled. DHCPv4: $ref: '#/components/schemas/EthernetInterface_v1_5_0_DHCPv4Configuration' description: DHCPv4 configuration for this interface. x-longDescription: This property shall contain the configuration of DHCP v4. x-versionAdded: v1_4_0 DHCPv6: $ref: '#/components/schemas/EthernetInterface_v1_5_0_DHCPv6Configuration' description: DHCPv6 configuration for this interface. x-longDescription: This property shall contain the configuration of DHCP v6. x-versionAdded: v1_4_0 Description: $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Description nullable: true readOnly: true FQDN: description: This is the complete, fully qualified domain name obtained by DNS for this interface. nullable: true readOnly: false type: string x-longDescription: The value of this property shall be the fully qualified domain name for this interface. FullDuplex: description: This indicates if the interface is in Full Duplex mode or not. nullable: true readOnly: false type: boolean x-longDescription: The value of this property shall represent the duplex status of the Ethernet connection on this interface. HostName: description: The DNS Host Name, without any domain information. nullable: true readOnly: false type: string x-longDescription: The value of this property shall be host name for this interface. IPv4Addresses: description: The IPv4 addresses currently assigned to this interface. items: $ref: http://redfish.dmtf.org/schemas/v1/IPAddresses.yaml#/components/schemas/IPAddresses_IPv4Address type: array x-longDescription: The value of this property shall be an array of objects used to represent the IPv4 connection characteristics for this interface. It is recommended that this propety be regarded as read-only, with configuration of static addresses performed by updating the values within IPv4StaticAddessses. Services may reject updates to this array for this reason. IPv4StaticAddresses: description: The IPv4 static addresses assigned to this interface. items: $ref: http://redfish.dmtf.org/schemas/v1/IPAddresses.yaml#/components/schemas/IPAddresses_IPv4Address type: array x-longDescription: The value of this property shall be an array of objects used to represent all IPv4 static addresses assigned (but not necessarily in use) to this interface. Addresses in use by this interface shall also appear in the IPv4Addresses property. x-versionAdded: v1_4_0 IPv6AddressPolicyTable: description: An array representing the RFC 6724 Address Selection Policy Table. items: $ref: '#/components/schemas/EthernetInterface_v1_5_0_IPv6AddressPolicyEntry' type: array x-longDescription: The value of this property shall be an array of objects used to represent the Address Selection Policy Table as defined in RFC 6724. IPv6Addresses: description: Enumerates in an array all of the currently assigned IPv6 addresses on this interface. items: $ref: http://redfish.dmtf.org/schemas/v1/IPAddresses.yaml#/components/schemas/IPAddresses_IPv6Address type: array x-longDescription: The value of this property shall be an array of objects used to represent the IPv6 connection characteristics for this interface. IPv6DefaultGateway: description: This is the IPv6 default gateway address that is currently in use on this interface. nullable: true readOnly: true type: string x-longDescription: The value of this property shall be the current IPv6 default gateway address that is in use on this interface. IPv6StaticAddresses: description: Represents in an array all of the IPv6 static addresses to be assigned on this interface. items: $ref: http://redfish.dmtf.org/schemas/v1/IPAddresses.yaml#/components/schemas/IPAddresses_IPv6StaticAddress type: array x-longDescription: The value of this property shall be an array of objects used to represent the IPv6 static connection characteristics for this interface. IPv6StaticDefaultGateways: description: The IPv6 static default gateways for this interface. items: $ref: http://redfish.dmtf.org/schemas/v1/IPAddresses.yaml#/components/schemas/IPAddresses_IPv6GatewayStaticAddress type: array x-longDescription: The values in this array shall represent the IPv6 static default gateway addresses for this interface. x-versionAdded: v1_4_0 Id: $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Id readOnly: true InterfaceEnabled: description: This indicates whether this interface is enabled. nullable: true readOnly: false type: boolean x-longDescription: The value of this property shall be a boolean indicating whether this interface is enabled. LinkStatus: $ref: '#/components/schemas/EthernetInterface_v1_5_0_LinkStatus' description: The link status of this interface (port). nullable: true readOnly: true x-longDescription: The value of this property shall be the link status of this interface (port). x-versionAdded: v1_1_0 Links: $ref: '#/components/schemas/EthernetInterface_v1_5_0_Links' description: Contains references to other resources that are related to this resource. x-longDescription: The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource. x-versionAdded: v1_1_0 MACAddress: $ref: '#/components/schemas/EthernetInterface_v1_5_0_MACAddress' description: This is the currently configured MAC address of the (logical port) interface. nullable: true readOnly: false x-longDescription: The value of this property shall be the effective current MAC Address of this interface. If an assignable MAC address is not supported, this is a read only alias of the PermanentMACAddress. MTUSize: description: This is the currently configured Maximum Transmission Unit (MTU) in bytes on this interface. nullable: true readOnly: false type: integer x-longDescription: The value of this property shall be the size in bytes of largest Protocol Data Unit (PDU) that can be passed in an Ethernet (MAC) frame on this interface. MaxIPv6StaticAddresses: description: This indicates the maximum number of Static IPv6 addresses that can be configured on this interface. nullable: true readOnly: true type: integer x-longDescription: The value of this property shall indicate the number of array items supported by IPv6StaticAddresses. Name: $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Name readOnly: true NameServers: description: This represents DNS name servers that are currently in use on this interface. items: type: string readOnly: true type: array x-longDescription: The value of this property shall be the DNS name servers used on this interface. Oem: $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Oem description: This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections. x-longDescription: The value of this string shall be of the format for the reserved word *Oem*. PermanentMACAddress: $ref: '#/components/schemas/EthernetInterface_v1_5_0_MACAddress' description: This is the permanent MAC address assigned to this interface (port). nullable: true readOnly: true x-longDescription: The value of this property shall be the Permanent MAC Address of this interface (port). This value is typically programmed during the manufacturing time. This address is not assignable. SpeedMbps: description: This is the current speed in Mbps of this interface. nullable: true readOnly: false type: integer x-longDescription: The value of this property shall be the link speed of the interface in Mbps. x-units: Mbit/s StatelessAddressAutoConfig: $ref: '#/components/schemas/EthernetInterface_v1_5_0_StatelessAddressAutoConfiguration' description: Stateless Address Automatic Configuration (SLAAC) parameters for this interface. x-longDescription: This object shall contain the IPv4 and IPv6 Stateless Address Automatic Configuration (SLAAC) properties for this interface. x-versionAdded: v1_4_0 StaticNameServers: description: A statically defined set of DNS server IP addresses (both IPv4 and IPv6). items: nullable: true type: string readOnly: false type: array x-longDescription: A statically defined set of DNS server IP addresses to be used when DHCP provisioning is not in enabled for name server configuration. As an implementation option they may also be used in addition to DHCP provided addresses, or in cases where the DHCP server provides no DNS assigments. x-versionAdded: v1_4_0 Status: $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Status description: This property describes the status and health of the resource and its children. 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: The value of this property shall be the UEFI device path to the device which implements this interface (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 not present. VLANs collections appear in the Link section of this resource. x-longDescription: The value of this property shall be the VLAN for this interface. If this interface supports more than one VLAN, the VLAN property shall not be present and the VLANS collection link shall be present instead. VLANs: $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef description: This is a reference to a collection of VLANs and is only used if the interface supports more than one VLANs. readOnly: true x-longDescription: The value of this property shall reference a collection of VLAN resources. If this property is used, the VLANEnabled and VLANId property shall not be used. required: - '@odata.id' - '@odata.type' - Id - Name type: object x-longDescription: This resource shall be used to represent 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. EthernetInterface_v1_5_0_IPv6AddressPolicyEntry: additionalProperties: false description: A entry in the RFC 6724 Address Selection Policy Table. properties: Label: description: The IPv6 Label (as defined in RFC 6724 section 2.1). 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 RFC 6724 section 2.1. Precedence: description: The IPv6 Precedence (as defined in RFC 6724 section 2.1. 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 RFC 6724 section 2.1. Prefix: description: The IPv6 Address Prefix (as defined in RFC 6724 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 RFC 6724 section 2.1. type: object x-longDescription: This type shall describe and entry in the Address Selection Policy Table as defined in RFC 6724. 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_5_0_LinkStatus: enum: - LinkUp - NoLink - LinkDown type: string x-enumDescriptions: LinkDown: There is no link on this interface, but the interface is connected. LinkUp: The link is available for communication on this interface. NoLink: There is no link or connection detected on this interface. EthernetInterface_v1_5_0_Links: additionalProperties: false description: Contains references 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: A reference to the Chassis which contains this Ethernet Interface. readOnly: true x-longDescription: The value of this property shall be a reference 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 references 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: The value of this property shall be a reference to the resources that this ethernet interface is associated with and shall reference a resource of type Endpoint. 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: This is a reference to a Host Interface that is associated with this Ethernet Interface. readOnly: true x-longDescription: The value of this property shall be a reference to a resource of type HostInterface which represents the interface used by a host 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: Oem extension object. x-longDescription: This object represents the Oem property. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification. type: object x-longDescription: This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (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_5_0_MACAddress: pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ type: string EthernetInterface_v1_5_0_OemActions: additionalProperties: true description: The available OEM specific actions for this resource. properties: {} type: object x-longDescription: This type shall contain any additional OEM 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_5_0_StatelessAddressAutoConfiguration: additionalProperties: false description: Stateless Address Automatic Configuration (SLAAC) parameters for this interface. properties: IPv4AutoConfigEnabled: description: Indicates whether IPv4 SLAAC is enabled for this interface. nullable: true readOnly: false type: boolean x-longDescription: This property shall indicate whether IPv4 Stateless Address Auto-Configuration (SLAAC) is enabled for this interface. x-versionAdded: v1_4_0 IPv6AutoConfigEnabled: description: Indicates whether IPv6 SLAAC is enabled for this interface. nullable: true readOnly: false type: boolean x-longDescription: This property shall indicate whether IPv6 Stateless Address Auto-Configuration (SLAAC) is enabled for this interface. x-versionAdded: v1_4_0 type: object x-longDescription: This type shall describe the IPv4 and IPv6 Stateless Address Automatic Configuration (SLAAC) for this interface. 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_5_0.EthernetInterface' x-copyright: Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright x-owningEntity: DMTF x-release: '2019.1'