summaryrefslogtreecommitdiff
path: root/static/redfish/v1/JsonSchemas/ManagerNetworkProtocol/ManagerNetworkProtocol.json
diff options
context:
space:
mode:
Diffstat (limited to 'static/redfish/v1/JsonSchemas/ManagerNetworkProtocol/ManagerNetworkProtocol.json')
-rw-r--r--static/redfish/v1/JsonSchemas/ManagerNetworkProtocol/ManagerNetworkProtocol.json317
1 files changed, 313 insertions, 4 deletions
diff --git a/static/redfish/v1/JsonSchemas/ManagerNetworkProtocol/ManagerNetworkProtocol.json b/static/redfish/v1/JsonSchemas/ManagerNetworkProtocol/ManagerNetworkProtocol.json
index d3f6771b7b..81635e0a79 100644
--- a/static/redfish/v1/JsonSchemas/ManagerNetworkProtocol/ManagerNetworkProtocol.json
+++ b/static/redfish/v1/JsonSchemas/ManagerNetworkProtocol/ManagerNetworkProtocol.json
@@ -1,5 +1,5 @@
{
- "$id": "http://redfish.dmtf.org/schemas/v1/ManagerNetworkProtocol.v1_4_2.json",
+ "$id": "http://redfish.dmtf.org/schemas/v1/ManagerNetworkProtocol.v1_5_0.json",
"$ref": "#/definitions/ManagerNetworkProtocol",
"$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
"copyright": "Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
@@ -32,6 +32,50 @@
},
"type": "object"
},
+ "EngineId": {
+ "additionalProperties": false,
+ "description": "The engine ID.",
+ "longDescription": "This object shall contain the RFC3411-defined engine ID.",
+ "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": {
+ "EnterpriseSpecificMethod": {
+ "description": "The enterprise specific method.",
+ "longDescription": "This property shall contain an RFC3411-defined enterprise specific method.",
+ "pattern": "^([A-Fa-f0-9]{2} ){7}[A-Fa-f0-9]{2}$",
+ "readonly": false,
+ "type": [
+ "string",
+ "null"
+ ],
+ "versionAdded": "v1_5_0"
+ },
+ "PrivateEnterpriseId": {
+ "description": "The private enterprise ID.",
+ "longDescription": "This property shall contain an RFC3411-defined private enterprise ID.",
+ "pattern": "^([A-Fa-f0-9]{2} ){3}[A-Fa-f0-9]{2}$",
+ "readonly": false,
+ "type": [
+ "string",
+ "null"
+ ],
+ "versionAdded": "v1_5_0"
+ }
+ },
+ "type": "object"
+ },
"HTTPSProtocol": {
"additionalProperties": false,
"description": "The settings for a network protocol associated with a manager.",
@@ -210,7 +254,7 @@
"versionAdded": "v1_3_0"
},
"SNMP": {
- "$ref": "#/definitions/Protocol",
+ "$ref": "#/definitions/SNMPProtocol",
"description": "The settings for this manager's SNMP support.",
"longDescription": "This object shall contain the SNMP protocol settings for this manager. The default Port property value should be `161` for compatibility with established client implementations."
},
@@ -377,6 +421,271 @@
},
"type": "object"
},
+ "SNMPAuthenticationProtocols": {
+ "enum": [
+ "Account",
+ "CommunityString",
+ "HMAC_MD5",
+ "HMAC_SHA96"
+ ],
+ "enumDescriptions": {
+ "Account": "Authentication is determined by account settings.",
+ "CommunityString": "SNMP community string authentication.",
+ "HMAC_MD5": "HMAC-MD5-96 authentication.",
+ "HMAC_SHA96": "HMAC-SHA-96 authentication."
+ },
+ "enumLongDescriptions": {
+ "Account": "This value shall indicate authentication for SNMPv3 access is determined based on the corresponding account settings.",
+ "CommunityString": "This value shall indicate authentication uses SNMP community strings.",
+ "HMAC_MD5": "This value shall indicate authentication for SNMPv3 access conforms to the RFC3414-defined HMAC-MD5-96 authentication protocol.",
+ "HMAC_SHA96": "This value shall indicate authentication for SNMPv3 access conforms to the RFC3414-defined HMAC-SHA-96 authentication protocol."
+ },
+ "type": "string"
+ },
+ "SNMPCommunity": {
+ "additionalProperties": false,
+ "description": "An SNMP community strings.",
+ "longDescription": "This object shall contain an SNMP community string used to access an SNMP manager.",
+ "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": {
+ "AccessMode": {
+ "anyOf": [
+ {
+ "$ref": "#/definitions/SNMPCommunityAccessMode"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The access level of the SNMP community.",
+ "longDescription": "This property shall contain the access/privilege level of the SNMP community used to access an SNMP manager.",
+ "readonly": false,
+ "versionAdded": "v1_5_0"
+ },
+ "CommunityString": {
+ "description": "The SNMP community string.",
+ "longDescription": "This property shall contain the SNMP community string used for accessing an SNMP service on this manager. If HideCommunityStrings is `true`, this value shall be `null` in responses.",
+ "readonly": false,
+ "type": [
+ "string",
+ "null"
+ ],
+ "versionAdded": "v1_5_0"
+ },
+ "Name": {
+ "description": "The name of the SNMP community.",
+ "longDescription": "This property shall contain a display name describing the SNMP community.",
+ "readonly": false,
+ "type": [
+ "string",
+ "null"
+ ],
+ "versionAdded": "v1_5_0"
+ }
+ },
+ "type": "object"
+ },
+ "SNMPCommunityAccessMode": {
+ "enum": [
+ "Full",
+ "Limited"
+ ],
+ "enumDescriptions": {
+ "Full": "READ-WRITE access mode.",
+ "Limited": "READ-ONLY access mode."
+ },
+ "enumLongDescriptions": {
+ "Full": "This value shall indicate the RFC1157-defined READ-WRITE access mode.",
+ "Limited": "This value shall indicate the RFC1157-defined READ-ONLY access mode."
+ },
+ "type": "string"
+ },
+ "SNMPEncryptionProtocols": {
+ "enum": [
+ "None",
+ "Account",
+ "CBC_DES",
+ "CFB128_AES128"
+ ],
+ "enumDescriptions": {
+ "Account": "Encryption is determined by account settings.",
+ "CBC_DES": "CBC-DES encryption.",
+ "CFB128_AES128": "CFB128-AES-128 encryption.",
+ "None": "No encryption."
+ },
+ "enumLongDescriptions": {
+ "Account": "This value shall indicate encryption is determined based on the corresponding account settings.",
+ "CBC_DES": "This value shall indicate encryption conforms to the RFC3414-defined CBC-DES encryption protocol.",
+ "CFB128_AES128": "This value shall indicate encryption conforms to the RFC3414-defined CFB128-AES-128 encryption protocol.",
+ "None": "This value shall indicate there is no encryption."
+ },
+ "type": "string"
+ },
+ "SNMPProtocol": {
+ "additionalProperties": false,
+ "description": "The settings for a network protocol associated with a manager.",
+ "longDescription": "This type shall describe information about a protocol setting for a manager.",
+ "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": {
+ "AuthenticationProtocol": {
+ "anyOf": [
+ {
+ "$ref": "#/definitions/SNMPAuthenticationProtocols"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The authentication protocol for SNMP.",
+ "longDescription": "This property shall contain the SNMP authentication protocol.",
+ "readonly": false,
+ "versionAdded": "v1_5_0"
+ },
+ "CommunityAccessMode": {
+ "anyOf": [
+ {
+ "$ref": "#/definitions/SNMPCommunityAccessMode"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The access level of the SNMP community.",
+ "longDescription": "This property shall contain the access/privilege level of the SNMP community used to access an SNMP manager.",
+ "readonly": false,
+ "versionAdded": "v1_5_0"
+ },
+ "CommunityStrings": {
+ "description": "The SNMP community strings.",
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/definitions/SNMPCommunity"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "longDescription": "This property shall contain an array of the SNMP community strings used to access an SNMP manager.",
+ "type": "array",
+ "versionAdded": "v1_5_0"
+ },
+ "EnableSNMPv1": {
+ "description": "Indicates if access via SNMPv1 is enabled.",
+ "longDescription": "This property shall indicate if access to the SNMP service on this manager using the SNMPv1 protocol is enabled.",
+ "readonly": false,
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "versionAdded": "v1_5_0"
+ },
+ "EnableSNMPv2c": {
+ "description": "Indicates if access via SNMPv2c is enabled.",
+ "longDescription": "This property shall indicate if access to the SNMP service on this manager using the SNMPv2c protocol is enabled.",
+ "readonly": false,
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "versionAdded": "v1_5_0"
+ },
+ "EnableSNMPv3": {
+ "description": "Indicates if access via SNMPv3 is enabled.",
+ "longDescription": "This property shall indicate if access to the SNMP service on this manager using the SNMPv3 protocol is enabled.",
+ "readonly": false,
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "versionAdded": "v1_5_0"
+ },
+ "EncryptionProtocol": {
+ "anyOf": [
+ {
+ "$ref": "#/definitions/SNMPEncryptionProtocols"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The encryption protocol for SNMPv3.",
+ "longDescription": "This property shall contain the SNMPv3 encryption protocol.",
+ "readonly": false,
+ "versionAdded": "v1_5_0"
+ },
+ "EngineId": {
+ "anyOf": [
+ {
+ "$ref": "#/definitions/EngineId"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The engine ID.",
+ "longDescription": "This property shall contain the RFC3411-defined engine ID.",
+ "versionAdded": "v1_5_0"
+ },
+ "HideCommunityStrings": {
+ "description": "Indicates if the community strings should be hidden.",
+ "longDescription": "This property shall indicate if the community strings should be hidden in responses.",
+ "readonly": false,
+ "type": [
+ "boolean",
+ "null"
+ ],
+ "versionAdded": "v1_5_0"
+ },
+ "Port": {
+ "description": "The protocol port.",
+ "longDescription": "This property shall contain the port assigned to the protocol.",
+ "minimum": 0,
+ "readonly": false,
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "ProtocolEnabled": {
+ "description": "An indication of whether the protocol is enabled.",
+ "longDescription": "This property shall indicate whether the protocol is enabled.",
+ "readonly": false,
+ "type": [
+ "boolean",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ },
"SSDProtocol": {
"additionalProperties": false,
"description": "The settings for a network protocol associated with a manager.",
@@ -454,6 +763,6 @@
}
},
"owningEntity": "DMTF",
- "release": "2018.3",
- "title": "#ManagerNetworkProtocol.v1_4_2.ManagerNetworkProtocol"
+ "release": "2019.3",
+ "title": "#ManagerNetworkProtocol.v1_5_0.ManagerNetworkProtocol"
} \ No newline at end of file