static/DSP8010_2016.3/json-schema/NetworkDeviceFunction.v1_0_0.json
{
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_1_0.json",
"title": "#NetworkDeviceFunction.v1_0_0.NetworkDeviceFunction",
"$ref": "#/definitions/NetworkDeviceFunction",
"definitions": {
"AuthenticationMethod": {
"type": "string",
"enum": [
"None",
"CHAP",
"MutualCHAP"
],
"enumDescriptions": {
"None": "No iSCSI authentication is used.",
"CHAP": "iSCSI Challenge Handshake Authentication Protocol (CHAP) authentication is used.",
"MutualCHAP": "iSCSI Mutual Challenge Handshake Authentication Protocol (CHAP) authentication is used."
}
},
"BootMode": {
"type": "string",
"enum": [
"Disabled",
"PXE",
"iSCSI",
"FibreChannel",
"FibreChannelOverEthernet"
],
"enumDescriptions": {
"Disabled": "Do not indicate to UEFI/BIOS that this device is bootable.",
"PXE": "Boot this device using the embedded PXE support. Only applicable if the NetworkDeviceFunctionType is set to Ethernet.",
"iSCSI": "Boot this device using the embedded iSCSI boot support and configuration. Only applicable if the NetworkDeviceFunctionType is set to iSCSI.",
"FibreChannel": "Boot this device using the embedded Fibre Channel support and configuration. Only applicable if the NetworkDeviceFunctionType is set to FibreChannel.",
"FibreChannelOverEthernet": "Boot this device using the embedded Fibre Channel over Ethernet (FCoE) boot support and configuration. Only applicable if the NetworkDeviceFunctionType is set to FibreChannelOverEthernet."
}
},
"BootTargets": {
"type": "object",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"type": [
"array",
"boolean",
"number",
"null",
"object",
"string"
],
"description": "This property shall specify a valid odata or Redfish property."
}
},
"additionalProperties": true,
"properties": {
"WWPN": {
"type": [
"string",
"null"
],
"readonly": false,
"description": "The World-Wide Port Name to boot from.",
"longDescription": "The value of this property shall be World-Wide Port Name (WWPN) to boot from."
},
"LUNID": {
"type": [
"string",
"null"
],
"readonly": false,
"description": "The Logical Unit Number (LUN) ID to boot from on the device referred to by the corresponding WWPN.",
"longDescription": "The value of this property shall be the Logical Unit Number (LUN) ID to boot from on the device referred to by the corresponding WWPN."
},
"BootPriority": {
"type": [
"number",
"null"
],
"readonly": false,
"description": "The relative priority for this entry in the boot targets array.",
"longDescription": "The value of this property shall be the relative priority for this entry in the boot targets array. Lower numbers shall represent higher priority, with zero being the highest priority. The BootPriority shall be unique for all entries of the BootTargets array."
}
}
},
"Ethernet": {
"type": "object",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"type": [
"array",
"boolean",
"number",
"null",
"object",
"string"
],
"description": "This property shall specify a valid odata or Redfish property."
}
},
"additionalProperties": true,
"properties": {
"PermanentMACAddress": {
"type": [
"string",
"null"
],
"readonly": true,
"description": "This is the permanent MAC address assigned to this network device function (physical function).",
"longDescription": "The value of this property shall be the Permanent MAC Address of this network device function (physical function). This value is typically programmed during the manufacturing time. This address is not assignable."
},
"MACAddress": {
"type": [
"string",
"null"
],
"readonly": false,
"description": "This is the currently configured MAC address of the (logical port) network device function.",
"longDescription": "The value of this property shall be the effective current MAC Address of this network device function. If an assignable MAC address is not supported, this is a read only alias of the PermanentMACAddress."
},
"MTUSize": {
"type": [
"number",
"null"
],
"readonly": false,
"description": "The Maximum Transmission Unit (MTU) configured for this network device function.",
"longDescription": "The Maximum Transmission Unit (MTU) configured for this Network Device Function. This value serves as a default for the OS driver when booting. The value only takes-effect on boot."
}
}
},
"FibreChannel": {
"type": "object",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"type": [
"array",
"boolean",
"number",
"null",
"object",
"string"
],
"description": "This property shall specify a valid odata or Redfish property."
}
},
"additionalProperties": true,
"properties": {
"PermanentWWPN": {
"type": [
"string",
"null"
],
"readonly": true,
"description": "This is the permanent WWPN address assigned to this network device function (physical function).",
"longDescription": "The value of this property shall be the permanent World-Wide Port Name (WWPN) of this network device function (physical function). This value is typically programmed during the manufacturing time. This address is not assignable."
},
"PermanentWWNN": {
"type": [
"string",
"null"
],
"readonly": true,
"description": "This is the permanent WWNN address assigned to this network device function (physical function).",
"longDescription": "The value of this property shall be the permanent World-Wide Node Name (WWNN) of this network device function (physical function). This value is typically programmed during the manufacturing time. This address is not assignable."
},
"WWPN": {
"type": [
"string",
"null"
],
"readonly": false,
"description": "This is the currently configured WWPN address of the network device function (physical function).",
"longDescription": "The value of this property shall be the effective current World-Wide Port Name (WWPN) of this network device function (physical function). If an assignable WWPN is not supported, this is a read only alias of the PermanentWWPN."
},
"WWNN": {
"type": [
"string",
"null"
],
"readonly": false,
"description": "This is the currently configured WWNN address of the network device function (physical function).",
"longDescription": "The value of this property shall be the effective current World-Wide Node Name (WWNN) of this network device function (physical function). If an assignable WWNN is not supported, this is a read only alias of the PermanentWWNN."
},
"WWNSource": {
"anyOf": [
{"$ref": "#/definitions/WWNSource"},
{"type": "null"}
],
"readonly": false,
"description": "The configuration source of the WWNs for this connection (WWPN and WWNN).",
"longDescription": "The value of this property shall be the configuration source of the World-Wide Names (WWNs) for this connection (WWPN and WWNN)."
},
"FCoELocalVLANId": {
"type": [
"number",
"null"
],
"readonly": false,
"description": "The locally configured FCoE VLAN ID.",
"longDescription": "For FCoE connections, the value of this property shall be the VLAN ID configured locally by setting this property. This value shall be used for FCoE traffic to this network device function during boot unless AllowFIPVLANDiscovery is true and a valid FCoE VLAN ID is found via the FIP VLAN Discovery Protocol."
},
"AllowFIPVLANDiscovery": {
"type": [
"boolean",
"null"
],
"readonly": false,
"description": "Whether the FCoE Initialization Protocol (FIP) is used for populating the FCoE VLAN Id.",
"longDescription": "For FCoE connections, the value of this property shall be a boolean indicating whether the FIP VLAN Discovery Protocol is used to determine the FCoE VLAN ID selected by the network device function for the FCoE connection. If true, and the FIP VLAN Discovery succeeds, the FCoEActiveVLANId property shall reflect the FCoE VLAN ID to be used for all FCoE traffic. If false, or if the FIP VLAN Discovery protocol fails, the FCoELocalVLANId shall be used for all FCoE traffic and the FCoEActiveVLANId shall reflect the FCoELocalVLANId."
},
"FCoEActiveVLANId": {
"type": [
"number",
"null"
],
"readonly": true,
"description": "The active FCoE VLAN ID.",
"longDescription": "For FCoE connections, the value of this property shall be null or a VLAN ID currently being used for FCoE traffic. When the FCoE link is down this value shall be null. When the FCoE link is up this value shall be either the FCoELocalVLANId property or a VLAN discovered via the FIP protocol."
},
"BootTargets": {
"type": "array",
"items": {
"anyOf": [
{"$ref": "#/definitions/BootTargets"},
{"type": "null"}
]
},
"description": "An array of Fibre Channel boot targets configured for this network device function.",
"longDescription": "The value of this property shall be an array of Fibre Channel boot targets configured for this network device function."
}
}
},
"IPAddressType": {
"type": "string",
"enum": [
"IPv4",
"IPv6"
],
"enumDescriptions": {
"IPv4": "IPv4 addressing is used for all IP-fields in this object.",
"IPv6": "IPv6 addressing is used for all IP-fields in this object."
}
},
"Links": {
"type": "object",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"type": [
"array",
"boolean",
"number",
"null",
"object",
"string"
],
"description": "This property shall specify a valid odata or Redfish property."
}
},
"additionalProperties": true,
"properties": {
"PCIeFunction": {
"$ref": "http://redfish.dmtf.org/schemas/v1/PCIeFunction.json#/definitions/PCIeFunction",
"readonly": true,
"description": "Contains the members of this collection."
}
}
},
"NetworkDeviceFunction": {
"type": "object",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"type": [
"array",
"boolean",
"number",
"null",
"object",
"string"
],
"description": "This property shall specify a valid odata or Redfish property."
}
},
"additionalProperties": false,
"properties": {
"@odata.context": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/context"
},
"@odata.id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/id"
},
"@odata.type": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/type"
},
"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*."
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"Description": {
"anyOf": [
{"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"},
{"type": "null"}
],
"readonly": true
},
"Name": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
"readonly": true
},
"Status": {
"anyOf": [
{"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status"},
{"type": "null"}
]
},
"NetDevFuncType": {
"anyOf": [
{"$ref": "#/definitions/NetworkDeviceTechology"},
{"type": "null"}
],
"readonly": false,
"description": "The configured capability of this network device function.",
"longDescription": "The value of this property shall be the configured capability of this network device function."
},
"DeviceEnabled": {
"type": [
"boolean",
"null"
],
"readonly": false,
"description": "Whether the network device function is enabled.",
"longDescription": "The value of this property shall be a boolean indicating whether the network device function is enabled. Disabled network device functions shall not be enumerated or seen by the operating system."
},
"NetDevFuncCapabilities": {
"type": "array",
"items": {
"anyOf": [
{"$ref": "#/definitions/NetworkDeviceTechology"},
{"type": "null"}
]
},
"readonly": true,
"description": "Capabilities of this network device function.",
"longDescription": "This object shall contain an array of capabilities of this network device function."
},
"Ethernet": {
"anyOf": [
{"$ref": "#/definitions/Ethernet"},
{"type": "null"}
],
"description": "Ethernet.",
"longDescription": "This object shall contain Ethernet capabilities, status, and configuration values for this network device function."
},
"iSCSIBoot": {
"anyOf": [
{"$ref": "#/definitions/iSCSIBoot"},
{"type": "null"}
],
"description": "iSCSI Boot.",
"longDescription": "This object shall contain iSCSI boot capabilities, status, and configuration values for this network device function."
},
"FibreChannel": {
"anyOf": [
{"$ref": "#/definitions/FibreChannel"},
{"type": "null"}
],
"description": "Fibre Channel.",
"longDescription": "This object shall contain Fibre Channel capabilities, status, and configuration values for this network device function."
},
"BootMode": {
"anyOf": [
{"$ref": "#/definitions/BootMode"},
{"type": "null"}
],
"readonly": false,
"description": "The boot mode configured for this network device function.",
"longDescription": "The value of this property shall be the boot mode configured for this network device function. If the value is not quot;Disabled\", this network device function shall be configured for boot using the specified technology."
},
"VirtualFunctionsEnabled": {
"type": [
"boolean",
"null"
],
"readonly": true,
"description": "Whether Single Root I/O Virtualization (SR-IOV) Virual Functions (VFs) are enabled for this Network Device Function.",
"longDescription": "The value of this property shall be a boolean indicating whether Single Root I/O Virtualization (SR-IOV) Virual Functions (VFs) are enabled for this Network Device Function."
},
"MaxVirtualFunctions": {
"type": [
"number",
"null"
],
"readonly": true,
"description": "The number of virtual functions (VFs) that are available for this Network Device Function.",
"longDescription": "The value of this property shall be the number of virtual functions (VFs) that are available for this Network Device Function."
},
"Links": {
"$ref": "#/definitions/Links",
"description": "Links.",
"longDescription": "Links for this NetworkDeviceFunction."
},
"AssignablePhysicalPorts@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/count"
},
"AssignablePhysicalPorts@odata.navigationLink": {
"type": "string",
"format": "uri"
},
"AssignablePhysicalPorts": {
"type": "array",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/NetworkPort.json#/definitions/NetworkPort"
},
"readonly": true,
"description": "Contains the members of this collection."
},
"PhysicalPortAssignment": {
"$ref": "http://redfish.dmtf.org/schemas/v1/NetworkPort.json#/definitions/NetworkPort",
"readonly": true,
"description": "Contains the members of this collection."
}
},
"required": [
"Id",
"Name"
],
"description": "A Network Device Function represents a logical interface exposed by the network adapter.",
"longDescription": "A Network Device Function represents a logical interface exposed by the network adapter."
},
"NetworkDeviceTechology": {
"type": "string",
"enum": [
"Disabled",
"Ethernet",
"FibreChannel",
"iSCSI",
"FibreChannelOverEthernet"
],
"enumDescriptions": {
"Disabled": "Neither enumerated nor visible to the operating system.",
"Ethernet": "Appears to the operating system as an Ethernet device.",
"FibreChannel": "Appears to the operating system as a Fibre Channel device.",
"iSCSI": "Appears to the operating system as an iSCSI device.",
"FibreChannelOverEthernet": "Appears to the operating system as an FCoE device."
}
},
"WWNSource": {
"type": "string",
"enum": [
"ConfiguredLocally",
"ProvidedByFabric"
],
"enumDescriptions": {
"ConfiguredLocally": "The set of FC/FCoE boot targets was applied locally through API or UI.",
"ProvidedByFabric": "The set of FC/FCoE boot targets was applied by the Fibre Channel fabric."
}
},
"iSCSIBoot": {
"type": "object",
"patternProperties": {
"^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
"type": [
"array",
"boolean",
"number",
"null",
"object",
"string"
],
"description": "This property shall specify a valid odata or Redfish property."
}
},
"additionalProperties": true,
"properties": {
"IPAddressType": {
"anyOf": [
{"$ref": "#/definitions/IPAddressType"},
{"type": "null"}
],
"readonly": false,
"description": "The type of IP address (IPv6 or IPv4) being populated in the iSCSIBoot IP address fields.",
"longDescription": "The value of this property shall behe type of IP address (IPv6 or IPv4) being populated in the iSCSIBoot IP address fields. Mixing of IPv6 and IPv4 addresses on the same network device function shall not be permissible."
},
"InitiatorIPAddress": {
"type": [
"string",
"null"
],
"readonly": false,
"description": "The IPv6 or IPv4 address of the iSCSI initiator.",
"longDescription": "The value of this property shall be the IPv6 or IPv4 address of the iSCSI boot initiator."
},
"InitiatorName": {
"type": [
"string",
"null"
],
"readonly": false,
"description": "The iSCSI initiator name.",
"longDescription": "The value of this property shall be the iSCSI boot initiator name."
},
"InitiatorDefaultGateway": {
"type": [
"string",
"null"
],
"readonly": false,
"description": "The IPv6 or IPv4 iSCSI boot default gateway.",
"longDescription": "The value of this property shall be the IPv6 or IPv4 iSCSI boot default gateway."
},
"InitiatorNetmask": {
"type": [
"string",
"null"
],
"readonly": false,
"description": "The IPv6 or IPv4 netmask of the iSCSI boot initiator.",
"longDescription": "The value of this property shall be the IPv6 or IPv4 netmask of the iSCSI boot initiator."
},
"TargetInfoViaDHCP": {
"type": [
"boolean",
"null"
],
"readonly": false,
"description": "Whether the iSCSI boot target name, LUN, IP address, and netmask should be obtained from DHCP.",
"longDescription": "The value of this property shall be a boolean indicating whether the iSCSI boot target name, LUN, IP address, and netmask should be obtained from DHCP."
},
"PrimaryTargetName": {
"type": [
"string",
"null"
],
"readonly": false,
"description": "The name of the iSCSI primary boot target.",
"longDescription": "The value of this property shall be the name of the primary iSCSI boot target (iSCSI Qualified Name, IQN)."
},
"PrimaryTargetIPAddress": {
"type": [
"string",
"null"
],
"readonly": false,
"description": "The IP address (IPv6 or IPv4) for the primary iSCSI boot target.",
"longDescription": "The value of this property shall be the IP address (IPv6 or IPv4) for the primary iSCSI boot target."
},
"PrimaryTargetTCPPort": {
"type": [
"number",
"null"
],
"readonly": false,
"description": "The TCP port for the primary iSCSI boot target.",
"longDescription": "The value of this property shall be the TCP port for the primary iSCSI boot target."
},
"PrimaryLUN": {
"type": [
"number",
"null"
],
"readonly": false,
"description": "The logical unit number (LUN) for the primary iSCSI boot target.",
"longDescription": "The value of this property shall be the logical unit number (LUN) for the primary iSCSI boot target."
},
"PrimaryVLANEnable": {
"type": [
"boolean",
"null"
],
"readonly": false,
"description": "This indicates if the primary VLAN is enabled.",
"longDescription": "The value of this property shall be used to indicate if this VLAN is enabled for the primary iSCSI boot target."
},
"PrimaryVLANId": {
"type": [
"number",
"null"
],
"readonly": false,
"description": "The 802.1q VLAN ID to use for iSCSI boot from the primary target.",
"longDescription": "The value of this property shall be the 802.1q VLAN ID to use for iSCSI boot from the primary target. This VLAN ID is only used if PrimaryVLANEnable is true."
},
"PrimaryDNS": {
"type": [
"string",
"null"
],
"readonly": false,
"description": "The IPv6 or IPv4 address of the primary DNS server for the iSCSI boot initiator.",
"longDescription": "The value of this property shall be the IPv6 or IPv4 address of the primary DNS server for the iSCSI boot initiator."
},
"SecondaryTargetName": {
"type": [
"string",
"null"
],
"readonly": false,
"description": "The name of the iSCSI secondary boot target.",
"longDescription": "The value of this property shall be the name of the secondary iSCSI boot target (iSCSI Qualified Name, IQN)."
},
"SecondaryTargetIPAddress": {
"type": [
"string",
"null"
],
"readonly": false,
"description": "The IP address (IPv6 or IPv4) for the secondary iSCSI boot target.",
"longDescription": "The value of this property shall be the IP address (IPv6 or IPv4) for the secondary iSCSI boot target."
},
"SecondaryTargetTCPPort": {
"type": [
"number",
"null"
],
"readonly": false,
"description": "The TCP port for the secondary iSCSI boot target.",
"longDescription": "The value of this property shall be the TCP port for the secondary iSCSI boot target."
},
"SecondaryLUN": {
"type": [
"number",
"null"
],
"readonly": false,
"description": "The logical unit number (LUN) for the secondary iSCSI boot target.",
"longDescription": "The value of this property shall be the logical unit number (LUN) for the secondary iSCSI boot target."
},
"SecondaryVLANEnable": {
"type": [
"boolean",
"null"
],
"readonly": false,
"description": "This indicates if the secondary VLAN is enabled.",
"longDescription": "The value of this property shall be used to indicate if this VLAN is enabled for the secondary iSCSI boot target."
},
"SecondaryVLANId": {
"type": [
"number",
"null"
],
"readonly": false,
"description": "The 802.1q VLAN ID to use for iSCSI boot from the secondary target.",
"longDescription": "The value of this property shall be the 802.1q VLAN ID to use for iSCSI boot from the secondary target. This VLAN ID is only used if SecondaryVLANEnable is true."
},
"SecondaryDNS": {
"type": [
"string",
"null"
],
"readonly": false,
"description": "The IPv6 or IPv4 address of the secondary DNS server for the iSCSI boot initiator.",
"longDescription": "The value of this property shall be the IPv6 or IPv4 address of the secondary DNS server for the iSCSI boot initiator."
},
"IPMaskDNSViaDHCP": {
"type": [
"boolean",
"null"
],
"readonly": false,
"description": "Whether the iSCSI boot initiator uses DHCP to obtain the iniator name, IP address, and netmask.",
"longDescription": "The value of this property shall be a boolean indicating whether the iSCSI boot initiator uses DHCP to obtain the iniator name, IP address, and netmask."
},
"RouterAdvertisementEnabled": {
"type": [
"boolean",
"null"
],
"readonly": false,
"description": "Whether IPv6 router advertisement is enabled for the iSCSI boot target.",
"longDescription": "The value of this property shall be a boolean indicating whether IPv6 router advertisement is enabled for the iSCSI boot target. This setting shall only apply to IPv6 configurations."
},
"AuthenticationMethod": {
"anyOf": [
{"$ref": "#/definitions/AuthenticationMethod"},
{"type": "null"}
],
"readonly": false,
"description": "The iSCSI boot authentication method for this network device function.",
"longDescription": "The value of this property shall be the iSCSI boot authentication method for this network device function."
},
"CHAPUsername": {
"type": [
"string",
"null"
],
"readonly": false,
"description": "The username for CHAP authentication.",
"longDescription": "The value of this property shall behe username for CHAP authentication."
},
"CHAPSecret": {
"type": [
"string",
"null"
],
"readonly": false,
"description": "The shared secret for CHAP authentication.",
"longDescription": "The value of this property shall be the shared secret for CHAP authentication."
},
"MutualCHAPUsername": {
"type": [
"string",
"null"
],
"readonly": false,
"description": "The CHAP Username for 2-way CHAP authentication.",
"longDescription": "The value of this property shall be the CHAP Username for 2-way CHAP authentication."
},
"MutualCHAPSecret": {
"type": [
"string",
"null"
],
"readonly": false,
"description": "The CHAP Secret for 2-way CHAP authentication.",
"longDescription": "The value of this property shall be the CHAP Secret for 2-way CHAP authentication."
}
}
}
},
"copyright": "Copyright 2014-2016 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright"
}