diff options
Diffstat (limited to 'static/redfish/v1/JsonSchemas/EthernetInterface/EthernetInterface.json')
| -rw-r--r-- | static/redfish/v1/JsonSchemas/EthernetInterface/EthernetInterface.json | 427 |
1 files changed, 245 insertions, 182 deletions
diff --git a/static/redfish/v1/JsonSchemas/EthernetInterface/EthernetInterface.json b/static/redfish/v1/JsonSchemas/EthernetInterface/EthernetInterface.json index 6a106789e9..27c09568e9 100644 --- a/static/redfish/v1/JsonSchemas/EthernetInterface/EthernetInterface.json +++ b/static/redfish/v1/JsonSchemas/EthernetInterface/EthernetInterface.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/EthernetInterface.v1_5_1.json", "$ref": "#/definitions/EthernetInterface", "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", - "copyright": "Copyright 2014-2018 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", + "copyright": "Copyright 2014-2019 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.", + "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_.]+$": { + "^([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", @@ -24,18 +25,37 @@ "properties": { "Oem": { "$ref": "#/definitions/OemActions", - "description": "This property contains the available OEM specific actions for this resource.", - "longDescription": "This property shall contain any additional OEM actions for this resource." + "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_.]+$": { + "^([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", @@ -50,58 +70,78 @@ }, "properties": { "DHCPEnabled": { - "description": "Determines whether DHCPv4 is enabled on this interface.", - "longDescription": "This property shall indicate whether DHCP v4 is enabled for this EthernetInterface.", + "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": "Determines whether to use DHCPv4-supplied DNS servers.", - "longDescription": "This property shall indicate whether the interface will use DHCPv4-supplied DNS servers.", + "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": "Determines whether to use a DHCPv4-supplied domain name.", - "longDescription": "This property shall indicate whether the interface will use a DHCPv4-supplied domain name.", + "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": "Determines whether to use a DHCPv4-supplied gateway.", - "longDescription": "This property shall indicate whether the interface will use a DHCPv4-supplied gateway.", + "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": "Determines whether to use DHCPv4-supplied NTP servers.", - "longDescription": "This property shall indicate whether the interface will use DHCPv4-supplied NTP servers.", + "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": "Determines whether to use DHCPv4-supplied static routes.", - "longDescription": "This property shall indicate whether the interface will use a DHCPv4-supplied static routes.", + "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" @@ -111,7 +151,7 @@ "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_.]+$": { + "^([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", @@ -135,44 +175,49 @@ } ], "description": "Determines the DHCPv6 operating mode for this interface.", - "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.", - "readonly": false + "longDescription": "This property shall control the operating mode of DHCPv6 on this interface. DHCPv6 stateful mode configures addresses, and when it is enabled, stateless mode is also implicitly enabled.", + "readonly": false, + "versionAdded": "v1_4_0" }, "UseDNSServers": { - "description": "When enabled, DNS server addresses supplied through DHCPv6 stateless mode will be used.", - "longDescription": "This property shall indicate whether the interface will use DHCPv6-supplied DNS servers.", + "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": "When enabled, the domain name supplied through DHCPv6 stateless mode will be used.", - "longDescription": "This property shall indicate whether the interface will use a domain name supplied through DHCPv6 stateless mode.", + "description": "An indication of whether the interface uses a domain name supplied through DHCP v6 stateless mode.", + "longDescription": "This property shall indicate whether the interface uses a domain name supplied through DHCP v6 stateless mode.", "readonly": false, "type": [ "boolean", "null" - ] + ], + "versionAdded": "v1_4_0" }, "UseNTPServers": { - "description": "When enabled, NTP server addresses supplied through DHCPv6 stateless mode will be used.", - "longDescription": "This property shall indicate whether the interface will use DHCPv6-supplied NTP servers.", + "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": "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.", - "longDescription": "This property shall indicate whether the interface will use DHCPv6 rapid commit mode for stateful mode address assignments.", + "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" @@ -190,17 +235,17 @@ }, "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." + "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.", + "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." }, "type": "string" }, "EthernetInterface": { "additionalProperties": false, - "description": "The EthernetInterface schema represents a single, logical ethernet interface or network interface controller (NIC).", - "longDescription": "This resource shall be used to represent NIC resources as part of the Redfish specification.", + "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_.]+$": { + "^([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", @@ -215,25 +260,26 @@ }, "properties": { "@odata.context": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id" + "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "@odata.type": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/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": "The Actions property shall contain the available actions for this resource." + "description": "The available actions for this Resource.", + "longDescription": "This property shall contain the available actions for this Resource.", + "versionAdded": "v1_3_0" }, "AutoNeg": { - "description": "This indicates if the speed and duplex are automatically negotiated and configured on this interface.", - "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.", + "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", @@ -241,28 +287,16 @@ ] }, "DHCPv4": { - "anyOf": [ - { - "$ref": "#/definitions/DHCPv4Configuration" - }, - { - "type": "null" - } - ], + "$ref": "#/definitions/DHCPv4Configuration", "description": "DHCPv4 configuration for this interface.", - "longDescription": "This property shall contain the configuration of DHCP v4." + "longDescription": "This property shall contain the configuration of DHCP v4.", + "versionAdded": "v1_4_0" }, "DHCPv6": { - "anyOf": [ - { - "$ref": "#/definitions/DHCPv6Configuration" - }, - { - "type": "null" - } - ], + "$ref": "#/definitions/DHCPv6Configuration", "description": "DHCPv6 configuration for this interface.", - "longDescription": "This property shall contain the configuration of DHCP v6." + "longDescription": "This property shall contain the configuration of DHCP v6.", + "versionAdded": "v1_4_0" }, "Description": { "anyOf": [ @@ -276,8 +310,8 @@ "readonly": true }, "FQDN": { - "description": "This is the complete, fully qualified domain name obtained by DNS for this interface.", - "longDescription": "The value of this property shall be the fully qualified domain name for this interface.", + "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", @@ -285,8 +319,8 @@ ] }, "FullDuplex": { - "description": "This indicates if the interface is in Full Duplex mode or not.", - "longDescription": "The value of this property shall represent the duplex status of the Ethernet connection on this interface.", + "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", @@ -294,8 +328,8 @@ ] }, "HostName": { - "description": "The DNS Host Name, without any domain information.", - "longDescription": "The value of this property shall be host name for this interface.", + "description": "The DNS host name, without any domain information.", + "longDescription": "This property shall contain DNS host name for this interface.", "readonly": false, "type": [ "string", @@ -307,36 +341,51 @@ "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv4Address" }, - "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.", + "longDescription": "This property shall contain an array of objects that represent the IPv4 connection characteristics for this interface. It is recommended that this property 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.", "type": "array" }, "IPv4StaticAddresses": { "description": "The IPv4 static addresses assigned to this interface.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv4Address" + "anyOf": [ + { + "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv4Address" + }, + { + "type": "null" + } + ] }, - "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.", - "type": "array" + "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 .", + "type": "array", + "versionAdded": "v1_4_0" }, "IPv6AddressPolicyTable": { - "description": "An array representing the RFC 6724 Address Selection Policy Table.", + "description": "An array that represents the RFC6724-defined address selection policy table.", "items": { - "$ref": "#/definitions/IPv6AddressPolicyEntry" + "anyOf": [ + { + "$ref": "#/definitions/IPv6AddressPolicyEntry" + }, + { + "type": "null" + } + ] }, - "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.", + "longDescription": "This property shall contain an array of objects that represent the RFC6724-defined address selection policy table.", "type": "array" }, "IPv6Addresses": { - "description": "Enumerates in an array all of the currently assigned IPv6 addresses on this interface.", + "description": "An array of the currently assigned IPv6 addresses on this interface.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv6Address" }, - "longDescription": "The value of this property shall be an array of objects used to represent the IPv6 connection characteristics for this interface.", + "longDescription": "This property shall contain an array of objects that represent the IPv6 connection characteristics for this interface.", "type": "array" }, "IPv6DefaultGateway": { - "description": "This is the IPv6 default gateway address that is currently in use on this interface.", - "longDescription": "The value of this property shall be the current IPv6 default gateway address that is in use on this interface.", + "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", @@ -344,28 +393,43 @@ ] }, "IPv6StaticAddresses": { - "description": "Represents in an array all of the IPv6 static addresses to be assigned on this interface.", + "description": "An array of the IPv6 static addresses to assign on this interface.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv6StaticAddress" + "anyOf": [ + { + "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv6StaticAddress" + }, + { + "type": "null" + } + ] }, - "longDescription": "The value of this property shall be an array of objects used to represent the IPv6 static connection characteristics for this interface.", + "longDescription": "This property shall contain an array of objects that represent the IPv6 static connection characteristics for this interface.", "type": "array" }, "IPv6StaticDefaultGateways": { "description": "The IPv6 static default gateways for this interface.", "items": { - "$ref": "http://redfish.dmtf.org/schemas/v1/IPAddresses.json#/definitions/IPv6GatewayStaticAddress" + "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" + "type": "array", + "versionAdded": "v1_4_0" }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", "readonly": true }, "InterfaceEnabled": { - "description": "This indicates whether this interface is enabled.", - "longDescription": "The value of this property shall be a boolean indicating whether this interface is enabled.", + "description": "An indication of whether this interface is enabled.", + "longDescription": "This property shall indicate whether this interface is enabled.", "readonly": false, "type": [ "boolean", @@ -381,14 +445,16 @@ "type": "null" } ], - "description": "The link status of this interface (port).", - "longDescription": "The value of this property shall be the link status of this interface (port).", - "readonly": true + "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": "Contains references to other resources that are related to this resource.", - "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." + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described Links Property shall contain links to Resources related to but not subordinate to this Resource.", + "versionAdded": "v1_1_0" }, "MACAddress": { "anyOf": [ @@ -399,13 +465,13 @@ "type": "null" } ], - "description": "This is the currently configured MAC address of the (logical port) interface.", - "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.", + "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": "This is the currently configured Maximum Transmission Unit (MTU) in bytes on this interface.", - "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.", + "description": "The currently configured maximum transmission unit (MTU), in bytes, on this interface.", + "longDescription": "This property shall contain the size, in bytes, of largest protocol data unit (PDU) that can be passed in an Ethernet (MAC) frame on this interface.", "readonly": false, "type": [ "integer", @@ -413,8 +479,8 @@ ] }, "MaxIPv6StaticAddresses": { - "description": "This indicates the maximum number of Static IPv6 addresses that can be configured on this interface.", - "longDescription": "The value of this property shall indicate the number of array items supported by IPv6StaticAddresses.", + "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", @@ -426,18 +492,18 @@ "readonly": true }, "NameServers": { - "description": "This represents DNS name servers that are currently in use on this interface.", + "description": "The DNS servers in use on this interface.", "items": { "type": "string" }, - "longDescription": "The value of this property shall be the DNS name servers used on this interface.", + "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": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.", - "longDescription": "The value of this string shall be of the format for the reserved word *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": [ @@ -448,13 +514,13 @@ "type": "null" } ], - "description": "This is the permanent MAC address assigned to this interface (port).", - "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.", + "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 }, "SpeedMbps": { - "description": "This is the current speed in Mbps of this interface.", - "longDescription": "The value of this property shall be the link speed of the interface in Mbps.", + "description": "The current speed, in Mbps, of this interface.", + "longDescription": "This property shall contain the link speed of the interface, in Mbps. This property shall be writable only when the AutoNeg property is `false`.", "readonly": false, "type": [ "integer", @@ -463,34 +529,32 @@ "units": "Mbit/s" }, "StatelessAddressAutoConfig": { - "anyOf": [ - { - "$ref": "#/definitions/StatelessAddressAutoConfiguration" - }, - { - "type": "null" - } - ], - "description": "Stateless Address Automatic Configuration (SLAAC) parameters for this interface.", - "longDescription": "This object shall contain the IPv4 and IPv6 Stateless Address Automatic Configuration (SLAAC) properties for this interface." + "$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": "A statically defined set of DNS server IP addresses (both IPv4 and IPv6).", + "description": "The statically-defined set of DNS server IPv4 and IPv6 addresses.", "items": { - "type": "string" + "type": [ + "string", + "null" + ] }, - "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.", + "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 may also be used in addition to DHCP-provided addresses, or in cases where the DHCP server provides no DNS assigments.", "readonly": false, - "type": "array" + "type": "array", + "versionAdded": "v1_4_0" }, "Status": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status", - "description": "This property describes the status and health of the resource and its children.", - "longDescription": "This property shall contain any status or health properties of the resource." + "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." }, "UefiDevicePath": { "description": "The UEFI device path for this interface.", - "longDescription": "The value of this property shall be the UEFI device path to the device which implements this interface (port).", + "longDescription": "This property shall contain the UEFI device path to the device that implements this interface, or port.", "readonly": true, "type": [ "string", @@ -498,21 +562,14 @@ ] }, "VLAN": { - "anyOf": [ - { - "$ref": "http://redfish.dmtf.org/schemas/v1/VLanNetworkInterface.json#/definitions/VLAN" - }, - { - "type": "null" - } - ], - "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.", - "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." + "$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 Link section 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", - "description": "This is a reference to a collection of VLANs and is only used if the interface supports more than one VLANs.", - "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.", + "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 collection of VLAN Resources, 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 } }, @@ -526,10 +583,10 @@ }, "IPv6AddressPolicyEntry": { "additionalProperties": false, - "description": "A entry in the RFC 6724 Address Selection Policy Table.", - "longDescription": "This type shall describe and entry in the Address Selection Policy Table as defined in RFC 6724.", + "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_.]+$": { + "^([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", @@ -544,8 +601,8 @@ }, "properties": { "Label": { - "description": "The IPv6 Label (as defined in RFC 6724 section 2.1).", - "longDescription": "This property shall contain the IPv6 Label value for this table entry as defined in RFC 6724 section 2.1.", + "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, @@ -555,8 +612,8 @@ ] }, "Precedence": { - "description": "The IPv6 Precedence (as defined in RFC 6724 section 2.1.", - "longDescription": "This property shall contain the IPv6 Precedence value for this table entry as defined in RFC 6724 section 2.1.", + "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, @@ -566,8 +623,8 @@ ] }, "Prefix": { - "description": "The IPv6 Address Prefix (as defined in RFC 6724 section 2.1).", - "longDescription": "This property shall contain the IPv6 Address Prefix for this table entry as defined in RFC 6724 section 2.1.", + "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", @@ -584,18 +641,18 @@ "LinkDown" ], "enumDescriptions": { - "LinkDown": "There is no link on this interface, but the interface is connected.", + "LinkDown": "No link is detected 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." + "NoLink": "No link or connection is detected on this interface." }, "type": "string" }, "Links": { "additionalProperties": false, - "description": "Contains references to other resources that are related to this resource.", - "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.", + "description": "The links to other Resources that are related to this Resource.", + "longDescription": "The Redfish Specification-described type shall contain links to Resources related to but not subordinate to this Resource.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([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", @@ -611,32 +668,35 @@ "properties": { "Chassis": { "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis", - "description": "A reference to the Chassis which contains this Ethernet Interface.", - "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.", - "readonly": true + "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 references to the endpoints that connect to this ethernet interface.", + "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": "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.", + "longDescription": "This property shall contain a link to the Resources of the Endpoint type with which this Ethernet interface is associated.", "readonly": true, - "type": "array" + "type": "array", + "versionAdded": "v1_1_0" }, "Endpoints@odata.count": { - "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/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": "This is a reference to a Host Interface that is associated with this Ethernet Interface.", - "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.", - "readonly": true + "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" }, "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", - "description": "Oem extension object.", - "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." + "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." } }, "type": "object" @@ -647,10 +707,10 @@ }, "OemActions": { "additionalProperties": true, - "description": "The available OEM specific actions for this resource.", - "longDescription": "This type shall contain any additional OEM actions for this resource.", + "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_.]+$": { + "^([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", @@ -668,10 +728,10 @@ }, "StatelessAddressAutoConfiguration": { "additionalProperties": false, - "description": "Stateless Address Automatic Configuration (SLAAC) parameters for this interface.", - "longDescription": "This type shall describe the IPv4 and IPv6 Stateless Address Automatic Configuration (SLAAC) for this interface.", + "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_.]+$": { + "^([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", @@ -686,27 +746,30 @@ }, "properties": { "IPv4AutoConfigEnabled": { - "description": "Indicates whether IPv4 SLAAC is enabled for this interface.", - "longDescription": "This property shall indicate whether IPv4 Stateless Address Auto-Configuration (SLAAC) is enabled for this interface.", + "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": "Indicates whether IPv6 SLAAC is enabled for this interface.", - "longDescription": "This property shall indicate whether IPv6 Stateless Address Auto-Configuration (SLAAC) is enabled for this interface.", + "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" } }, "owningEntity": "DMTF", - "title": "#EthernetInterface.v1_4_1.EthernetInterface" + "release": "2019.1", + "title": "#EthernetInterface.v1_5_1.EthernetInterface" }
\ No newline at end of file |