diff options
Diffstat (limited to 'static/redfish/v1/JsonSchemas/Switch/Switch.json')
| -rw-r--r-- | static/redfish/v1/JsonSchemas/Switch/Switch.json | 160 |
1 files changed, 83 insertions, 77 deletions
diff --git a/static/redfish/v1/JsonSchemas/Switch/Switch.json b/static/redfish/v1/JsonSchemas/Switch/Switch.json index 77838309b5..0792058e2e 100644 --- a/static/redfish/v1/JsonSchemas/Switch/Switch.json +++ b/static/redfish/v1/JsonSchemas/Switch/Switch.json @@ -1,14 +1,15 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/Switch.v1_2_0.json", "$ref": "#/definitions/Switch", "$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", @@ -27,18 +28,18 @@ }, "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." } }, "type": "object" }, "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", @@ -54,36 +55,36 @@ "properties": { "Chassis": { "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis", - "description": "A reference to the chassis which contains this switch.", - "longDescription": "The value of this property shall be a reference to the resources that this switch is associated with and shall reference a resource of type Chassis.", + "description": "The link to the chassis that contains this switch.", + "longDescription": "This property shall contain a link to the Resource of type Chassis with which this switch is associated.", "readonly": true }, "ManagedBy": { - "description": "An array of references to the managers that manage this switch.", + "description": "An array of links to the managers that manage this switch.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager" }, - "longDescription": "The value of this property shall be a reference to the resources that this switch is associated with and shall reference a resource of type Manager.", + "longDescription": "This property shall contain a link to the Resource of type Manager with which this switch is associated.", "readonly": true, "type": "array" }, "ManagedBy@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" }, "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" }, "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", @@ -101,17 +102,17 @@ }, "Reset": { "additionalProperties": false, - "description": "This action is used to reset this switch.", - "longDescription": "This action shall perform a reset of this switch.", + "description": "This action resets this switch.", + "longDescription": "This action shall reset this switch.", "parameters": { "ResetType": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/ResetType", - "description": "The type of reset to be performed.", - "longDescription": "This parameter shall define the type of reset to be performed. The service may accept a request without the parameter and perform an implementation specific default reset." + "description": "The type of reset.", + "longDescription": "This parameter shall contain the type of reset. The Service may accept a request without this parameter and can complete an implementation-specific default reset." } }, "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", @@ -127,7 +128,7 @@ "properties": { "target": { "description": "Link to invoke action", - "format": "uri", + "format": "uri-reference", "type": "string" }, "title": { @@ -139,10 +140,10 @@ }, "Switch": { "additionalProperties": false, - "description": "Switch contains properties describing a simple fabric switch.", - "longDescription": "This resource shall be used to represent a simple switch for a Redfish implementation.", + "description": "The Switch schema contains properties that describe a fabric switch.", + "longDescription": "This Resource contains a switch for a Redfish implementation.", "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", @@ -157,25 +158,25 @@ }, "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." }, "AssetTag": { - "description": "The user assigned asset tag for this switch.", - "longDescription": "The value of this property shall be an identifying string used to track the drive for inventory purposes.", + "description": "The user-assigned asset tag for this switch.", + "longDescription": "This property shall contain the user-assigned asset tag, which is an identifying string that tracks the drive for inventory purposes.", "readonly": false, "type": [ "string", @@ -194,14 +195,24 @@ "readonly": true }, "DomainID": { - "description": "The Domain ID for this switch.", - "longDescription": "The value of this property shall have a scope of uniqueness within the fabric of which the switch is a member.", + "description": "The domain ID for this switch.", + "longDescription": "This property shall contain The domain ID for this switch. This property has a scope of uniqueness within the fabric of which the switch is a member.", "readonly": true, "type": [ "integer", "null" ] }, + "FirmwareVersion": { + "description": "The firmware version of this switch.", + "longDescription": "This property shall contain the firwmare version as defined by the manufacturer for the associated switch.", + "readonly": true, + "type": [ + "string", + "null" + ], + "versionAdded": "v1_2_0" + }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", "readonly": true @@ -215,13 +226,13 @@ "type": "null" } ], - "description": "The state of the indicator LED, used to identify the switch.", - "longDescription": "This value of this property shall contain the indicator light state for the indicator light associated with this switch.", + "description": "The state of the indicator LED, which identifies the switch.", + "longDescription": "This property shall contain the state of the indicator light associated with this switch.", "readonly": false }, "IsManaged": { - "description": "This indicates whether the switch is in a managed or unmanaged state.", - "longDescription": "The value of this property shall be a boolean indicating whether this switch is in a managed or unmanaged state.", + "description": "An indication of whether the switch is in a managed or unmanaged state.", + "longDescription": "This property shall indicate whether this switch is in a managed or unmanaged state.", "readonly": false, "type": [ "boolean", @@ -230,30 +241,24 @@ }, "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." }, "Location": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Location", - "description": "The Location of the switch.", - "longDescription": "This property shall contain location information of the associated switch." + "description": "The location of the switch.", + "longDescription": "This property shall contain location information of the associated switch.", + "versionAdded": "v1_1_0" }, "LogServices": { - "anyOf": [ - { - "$ref": "http://redfish.dmtf.org/schemas/v1/LogServiceCollection.json#/definitions/LogServiceCollection" - }, - { - "type": "null" - } - ], - "description": "A reference to the collection of Log Services associated with this system.", - "longDescription": "The value of this property shall be a link to a collection of type LogServiceCollection.", + "$ref": "http://redfish.dmtf.org/schemas/v1/LogServiceCollection.json#/definitions/LogServiceCollection", + "description": "The link to the collection of Log Services associated with this switch.", + "longDescription": "This property shall contain a link to a Resource Collection of type LogServiceCollection.", "readonly": true }, "Manufacturer": { - "description": "This is the manufacturer of this switch.", - "longDescription": "The value of this property shall be the name of the organization responsible for producing the switch. This organization might be the entity from whom the switch is purchased, but this is not necessarily true.", + "description": "The manufacturer of this switch.", + "longDescription": "This property shall contain the name of the organization responsible for producing the switch. This organization might be the entity from which the switch is purchased, but this is not necessarily true.", "readonly": true, "type": [ "string", @@ -262,7 +267,7 @@ }, "Model": { "description": "The product model number of this switch.", - "longDescription": "This property shall indicate the model information as provided by the manufacturer of this switch.", + "longDescription": "This property shall contain the manufacturer-provided model information of this switch.", "readonly": true, "type": [ "string", @@ -275,12 +280,12 @@ }, "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." }, "PartNumber": { "description": "The part number for this switch.", - "longDescription": "The value of this property shall be a part number assigned by the organization that is responsible for producing or manufacturing the switch.", + "longDescription": "This property shall contain the manufacturer-provided part number for the switch.", "readonly": true, "type": [ "string", @@ -289,8 +294,8 @@ }, "Ports": { "$ref": "http://redfish.dmtf.org/schemas/v1/PortCollection.json#/definitions/PortCollection", - "description": "A collection of references to the ports for this switch.", - "longDescription": "The value of this property shall be a reference to the resources that this switch contains and shall reference a resource of type Port.", + "description": "The link to the collection ports for this switch.", + "longDescription": "This property shall contain a link to a Resource Collection of type PortCollection.", "readonly": true }, "PowerState": { @@ -302,8 +307,8 @@ "type": "null" } ], - "description": "This is the current power state of the switch.", - "longDescription": "The value of this property shall contain the power state of the switch.", + "description": "The current power state of the switch.", + "longDescription": "This property shall contain the power state of the switch.", "readonly": true }, "Redundancy": { @@ -312,15 +317,15 @@ "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/Redundancy.json#/definitions/Redundancy" }, - "longDescription": "The values of the properties in this array shall be used to show how this switch is grouped with other switches for form redundancy sets.", + "longDescription": "This property shall contain an array that shows how this switch is grouped with other switches for form redundancy sets.", "type": "array" }, "Redundancy@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" }, "SKU": { - "description": "This is the SKU for this switch.", - "longDescription": "The value of this property shall be the stock-keeping unit number for this switch.", + "description": "The SKU for this switch.", + "longDescription": "This property shall contain the SKU number for this switch.", "readonly": true, "type": [ "string", @@ -329,7 +334,7 @@ }, "SerialNumber": { "description": "The serial number for this switch.", - "longDescription": "The value of this property shall be a manufacturer-allocated number used to identify the switch.", + "longDescription": "This property shall contain a manufacturer-allocated number that identifies the switch.", "readonly": true, "type": [ "string", @@ -338,8 +343,8 @@ }, "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." }, "SwitchType": { "anyOf": [ @@ -350,13 +355,13 @@ "type": "null" } ], - "description": "The protocol being sent over this switch.", - "longDescription": "The value of this property shall contain the type of switch being represented by this simple switch.", + "description": "The type of switch.", + "longDescription": "This property shall contain the type of switch.", "readonly": true }, "TotalSwitchWidth": { "description": "The total number of lanes, phys, or other physical transport links that this switch contains.", - "longDescription": "The value of this property shall be the number of physical transport lanes, phys, or other physical transport links that this switch contains. For PCIe, this shall be lane count.", + "longDescription": "This property shall contain the number of physical transport lanes, phys, or other physical transport links that this switch contains. For PCIe, this value shall be the lane count.", "readonly": true, "type": [ "integer", @@ -374,5 +379,6 @@ } }, "owningEntity": "DMTF", - "title": "#Switch.v1_1_1.Switch" + "release": "2019.2", + "title": "#Switch.v1_2_0.Switch" }
\ No newline at end of file |