{ "$id": "http://redfish.dmtf.org/schemas/v1/ConnectionMethod.v1_1_1.json", "$ref": "#/definitions/ConnectionMethod", "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", "copyright": "Copyright 2014-2024 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.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "Oem": { "$ref": "#/definitions/OemActions", "description": "The available OEM-specific actions for this resource.", "longDescription": "This property shall contain the available OEM-specific actions for this resource." } }, "type": "object" }, "ConnectionMethod": { "additionalProperties": false, "description": "The `ConnectionMethod` schema describes the protocol, provider, or other method used to communicate to a given access point for a Redfish aggregation service.", "longDescription": "This resource shall represent a connection method for a Redfish implementation.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "@odata.context": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" }, "@odata.etag": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" }, "@odata.id": { "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" }, "@odata.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": "This property shall contain the available actions for this resource." }, "ConnectionMethodType": { "anyOf": [ { "$ref": "#/definitions/ConnectionMethodType" }, { "type": "null" } ], "description": "The type of connection method.", "longDescription": "This property shall contain an identifier of the connection method.", "readonly": true }, "ConnectionMethodVariant": { "description": "The variant of connection method.", "longDescription": "This property shall contain an additional identifier of the connection method. This property shall be present if `ConnectionMethodType` is `OEM`.", "readonly": true, "type": [ "string", "null" ] }, "Description": { "anyOf": [ { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" }, { "type": "null" } ], "readonly": true }, "Id": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", "readonly": true }, "Links": { "$ref": "#/definitions/Links", "description": "The links to other resources that are related to this resource.", "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource." }, "Name": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", "readonly": true }, "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/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." }, "TunnelingProtocol": { "anyOf": [ { "$ref": "#/definitions/TunnelingProtocolType" }, { "type": "null" } ], "description": "The tunneling protocol used for this connection method.", "longDescription": "This property shall contain the tunneling protocol used for this connection method.", "readonly": true, "versionAdded": "v1_1_0" } }, "required": [ "@odata.id", "@odata.type", "Id", "Name" ], "type": "object" }, "ConnectionMethodType": { "enum": [ "Redfish", "SNMP", "IPMI15", "IPMI20", "NETCONF", "OEM" ], "enumDescriptions": { "IPMI15": "IPMI 1.5 connection method.", "IPMI20": "IPMI 2.0 connection method.", "NETCONF": "NETCONF connection method.", "OEM": "OEM connection method.", "Redfish": "Redfish connection method.", "SNMP": "SNMP connection method." }, "enumLongDescriptions": { "IPMI15": "This value shall indicate the connection method is IPMI 1.5.", "IPMI20": "This value shall indicate the connection method is IPMI 2.0.", "NETCONF": "This value shall indicate the connection method is NETCONF.", "OEM": "This value shall indicate the connection method is OEM. The `ConnectionMethodVariant` property shall contain further identification information.", "Redfish": "This value shall indicate the connection method is Redfish.", "SNMP": "This value shall indicate the connection method is SNMP." }, "type": "string" }, "Links": { "additionalProperties": false, "description": "The links to other resources that are related to this resource.", "longDescription": "This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.", "patternProperties": { "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": { "AggregationSources": { "description": "An array of links to the access points using this connection method.", "items": { "$ref": "http://redfish.dmtf.org/schemas/v1/AggregationSource.json#/definitions/AggregationSource" }, "longDescription": "This property shall contain an array of links to resources of type `AggregationSource` that are using this connection method.", "readonly": true, "type": "array" }, "AggregationSources@odata.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": "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 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_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", "boolean", "integer", "number", "null", "object", "string" ] } }, "properties": {}, "type": "object" }, "TunnelingProtocolType": { "enum": [ "SSH", "OEM" ], "enumDescriptions": { "OEM": "OEM tunneling.", "SSH": "SSH tunneling." }, "enumLongDescriptions": { "OEM": "This value shall indicate that the tunneling protocol is OEM-specific.", "SSH": "This value shall indicate that the tunneling protocol is SSH." }, "type": "string" } }, "language": "en", "owningEntity": "DMTF", "release": "2022.3", "title": "#ConnectionMethod.v1_1_1.ConnectionMethod" }