static/DSP8010_2016.3/json-schema/NetworkAdapter.v1_0_0.json
{
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_1_0.json",
"title": "#NetworkAdapter.v1_0_0.NetworkAdapter",
"$ref": "#/definitions/NetworkAdapter",
"definitions": {
"ResetSettingsToDefault": {
"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."
}
},
"type": "object",
"additionalProperties": false,
"properties": {
"title": {
"type": "string",
"description": "Friendly action name"
},
"target": {
"type": "string",
"format": "uri",
"description": "Link to invoke action"
}
},
"description": "This action is to clear the settings back to factory defaults.",
"longDescription": "This action shall perform a reset of all active and pending settings back to factory default settings upon reset of the network adapter."
},
"ControllerCapabilities": {
"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": {
"NetworkPortCount": {
"type": [
"number",
"null"
],
"readonly": true,
"description": "The number of physical ports on this controller.",
"longDescription": "The value of this property shall be the number of physical ports on this controller."
},
"NetworkDeviceFunctionCount": {
"type": [
"number",
"null"
],
"readonly": true,
"description": "The maximum number of physical functions available on this controller.",
"longDescription": "The value of this property shall be the number of physical functions available on this controller."
},
"DataCenterBridging": {
"anyOf": [
{"$ref": "#/definitions/DataCenterBridging"},
{"type": "null"}
],
"description": "Data Center Bridging (DCB) for this controller.",
"longDescription": "This object shall contain capability, status, and configuration values related to Data Center Bridging (DCB) for this controller."
},
"VirtualizationOffload": {
"anyOf": [
{"$ref": "#/definitions/VirtualizationOffload"},
{"type": "null"}
],
"description": "Virtualization offload for this controller.",
"longDescription": "This object shall contain capability, status, and configuration values related to virtualization offload for this controller."
},
"NPIV": {
"anyOf": [
{"$ref": "#/definitions/NPIV"},
{"type": "null"}
],
"description": "N_Port ID Virtualization (NPIV) capabilties for this controller.",
"longDescription": "This object shall contain N_Port ID Virtualization (NPIV) capabilties for this controller."
}
}
},
"Controllers": {
"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": {
"FirmwarePackageVersion": {
"type": [
"string",
"null"
],
"readonly": true,
"description": "The version of the user-facing firmware package.",
"longDescription": "The value of this property shall be the version number of the user-facing firmware package."
},
"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": false,
"properties": {
"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."
},
"PCIeDevices@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/count"
},
"PCIeDevices@odata.navigationLink": {
"type": "string",
"format": "uri"
},
"PCIeDevices": {
"type": "array",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeDevice"
},
"readonly": true,
"description": "Contains the members of this collection."
},
"NetworkPorts@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/count"
},
"NetworkPorts@odata.navigationLink": {
"type": "string",
"format": "uri"
},
"NetworkPorts": {
"type": "array",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/NetworkPort.json#/definitions/NetworkPort"
},
"readonly": true,
"description": "Contains the members of this collection."
},
"NetworkDeviceFunctions@odata.count": {
"$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/count"
},
"NetworkDeviceFunctions@odata.navigationLink": {
"type": "string",
"format": "uri"
},
"NetworkDeviceFunctions": {
"type": "array",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction.json#/definitions/NetworkDeviceFunction"
},
"readonly": true,
"description": "Contains the members of this collection."
}
},
"description": "Links.",
"longDescription": "Links for this controller."
},
"ControllerCapabilities": {
"anyOf": [
{"$ref": "#/definitions/ControllerCapabilities"},
{"type": "null"}
],
"description": "The capabilities of this controller.",
"longDescription": "The value of this property shall contain the capabilities of this controller."
}
}
},
"DataCenterBridging": {
"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": {
"Capable": {
"type": [
"boolean",
"null"
],
"readonly": true,
"description": "Whether this controller is capable of Data Center Bridging (DCB).",
"longDescription": "The value of this property shall be a boolean indicating whether this controller is capable of Data Center Bridging (DCB)."
}
}
},
"NPIV": {
"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": {
"MaxDeviceLogins": {
"type": [
"number",
"null"
],
"readonly": true,
"description": "The maximum number of N_Port ID Virtualization (NPIV) logins allowed simultaneously from all ports on this controller.",
"longDescription": "The value of this property shall be the maximum number of N_Port ID Virtualization (NPIV) logins allowed simultaneously from all ports on this controller."
},
"MaxPortLogins": {
"type": [
"number",
"null"
],
"readonly": true,
"description": "The maximum number of N_Port ID Virtualization (NPIV) logins allowed per physical port on this controller.",
"longDescription": "The value of this property shall be the maximum number of N_Port ID Virtualization (NPIV) logins allowed per physical port on this controller."
}
}
},
"NetworkAdapter": {
"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"}
]
},
"Manufacturer": {
"type": [
"string",
"null"
],
"readonly": true,
"description": "The manufacturer or OEM of this network adapter.",
"longDescription": "The value of this property shall contain a value that represents the manufacturer of the network adapter."
},
"Model": {
"type": [
"string",
"null"
],
"readonly": true,
"description": "The model string for this network adapter.",
"longDescription": "The value of this property shall contain the information about how the manufacturer references this network adapter."
},
"SKU": {
"type": [
"string",
"null"
],
"readonly": true,
"description": "The manufacturer SKU for this network adapter.",
"longDescription": "The value of this property shall contain the Stock Keeping Unit (SKU) for the network adapter."
},
"SerialNumber": {
"type": [
"string",
"null"
],
"readonly": true,
"description": "The serial number for this network adapter.",
"longDescription": "The value of this property shall contain the serial number for the network adapter."
},
"PartNumber": {
"type": [
"string",
"null"
],
"readonly": true,
"description": "Part number for this network adapter.",
"longDescription": "The value of this property shall contain the part number for the network adapter as defined by the manufacturer."
},
"Controllers": {
"type": "array",
"items": {
"anyOf": [
{"$ref": "#/definitions/Controllers"},
{"type": "null"}
]
},
"description": "The set of network controllers ASICs that make up this NetworkAdapter.",
"longDescription": "The value of this property shall contain the set of network controllers ASICs that make up this NetworkAdapter."
},
"Actions": {
"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": {
"Oem": {
"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": {}
},
"#NetworkAdapter.ResetSettingsToDefault": {
"$ref": "#/definitions/ResetSettingsToDefault"
}
},
"description": "The available actions for this resource.",
"longDescription": "The Actions property shall contain the available actions for this resource."
},
"NetworkPorts": {
"$ref": "http://redfish.dmtf.org/schemas/v1/NetworkPortCollection.json#/definitions/NetworkPortCollection",
"readonly": true,
"description": "Contains the members of this collection."
},
"NetworkDeviceFunctions": {
"$ref": "http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunctionCollection.json#/definitions/NetworkDeviceFunctionCollection",
"readonly": true,
"description": "Contains the members of this collection."
}
},
"required": [
"Id",
"Name"
],
"description": "A NetworkAdapter represents the physical network adapter capable of connecting to a computer network. Examples include but are not limited to Ethernet, Fibre Channel, and converged network adapters.",
"longDescription": "A NetworkAdapter represents the physical network adapter capable of connecting to a computer network. Examples include but are not limited to Ethernet, Fibre Channel, and converged network adapters."
},
"SRIOV": {
"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": {
"SRIOVVEPACapable": {
"type": [
"boolean",
"null"
],
"readonly": true,
"description": "Whether this controller supports Single Root Input/Output Virtualization (SR-IOV) in Virtual Ethernet Port Aggregator (VEPA) mode.",
"longDescription": "The value of this property shall be a boolean indicating whether this controller supports Single Root Input/Output Virtualization (SR-IOV) in Virtual Ethernet Port Aggregator (VEPA) mode."
}
}
},
"VirtualFunction": {
"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": {
"DeviceMaxCount": {
"type": [
"number",
"null"
],
"readonly": true,
"description": "The maximum number of Virtual Functions (VFs) supported by this controller.",
"longDescription": "The value of this property shall be the maximum number of Virtual Functions (VFs) supported by this controller."
},
"NetworkPortMaxCount": {
"type": [
"number",
"null"
],
"readonly": true,
"description": "The maximum number of Virtual Functions (VFs) supported per network port for this controller.",
"longDescription": "The value of this property shall be the maximum number of Virtual Functions (VFs) supported per network port for this controller."
},
"MinAssignmentGroupSize": {
"type": [
"number",
"null"
],
"readonly": true,
"description": "The minimum number of Virtual Functions (VFs) that can be allocated or moved between physical functions for this controller.",
"longDescription": "The value of this property shall be the minimum number of Virtual Functions (VFs) that can be allocated or moved between physical functions for this controller."
}
}
},
"VirtualizationOffload": {
"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": {
"VirtualFunction": {
"anyOf": [
{"$ref": "#/definitions/VirtualFunction"},
{"type": "null"}
]
},
"SRIOV": {
"anyOf": [
{"$ref": "#/definitions/SRIOV"},
{"type": "null"}
],
"description": "Single-Root Input/Output Virtualization (SR-IOV) capabilities.",
"longDescription": "This object shall contain Single-Root Input/Output Virtualization (SR-IOV) capabilities."
}
}
}
},
"copyright": "Copyright 2014-2016 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright"
}