1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/KeyService.v1_0_1.json",
3    "$ref": "#/definitions/KeyService",
4    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5    "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
6    "definitions": {
7        "Actions": {
8            "additionalProperties": false,
9            "description": "The available actions for this resource.",
10            "longDescription": "This type shall contain the available actions for this resource.",
11            "patternProperties": {
12                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
13                    "description": "This property shall specify a valid odata or Redfish property.",
14                    "type": [
15                        "array",
16                        "boolean",
17                        "integer",
18                        "number",
19                        "null",
20                        "object",
21                        "string"
22                    ]
23                }
24            },
25            "properties": {
26                "Oem": {
27                    "$ref": "#/definitions/OemActions",
28                    "description": "The available OEM-specific actions for this resource.",
29                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
30                }
31            },
32            "type": "object"
33        },
34        "KeyService": {
35            "additionalProperties": false,
36            "description": "The `KeyService` schema describes a key service that represents the actions available to manage keys.",
37            "longDescription": "This resource shall represent the key service properties for a Redfish implementation.",
38            "patternProperties": {
39                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
40                    "description": "This property shall specify a valid odata or Redfish property.",
41                    "type": [
42                        "array",
43                        "boolean",
44                        "integer",
45                        "number",
46                        "null",
47                        "object",
48                        "string"
49                    ]
50                }
51            },
52            "properties": {
53                "@odata.context": {
54                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
55                },
56                "@odata.etag": {
57                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
58                },
59                "@odata.id": {
60                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
61                },
62                "@odata.type": {
63                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
64                },
65                "Actions": {
66                    "$ref": "#/definitions/Actions",
67                    "description": "The available actions for this resource.",
68                    "longDescription": "This property shall contain the available actions for this resource."
69                },
70                "Description": {
71                    "anyOf": [
72                        {
73                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
74                        },
75                        {
76                            "type": "null"
77                        }
78                    ],
79                    "readonly": true
80                },
81                "Id": {
82                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
83                    "readonly": true
84                },
85                "NVMeoFKeyPolicies": {
86                    "$ref": "http://redfish.dmtf.org/schemas/v1/KeyPolicyCollection.json#/definitions/KeyPolicyCollection",
87                    "description": "The NVMe-oF key policies maintained by this service.",
88                    "longDescription": "This property shall contain a link to a resource collection of type `KeyPolicyCollection` that contains the NVMe-oF key policies maintained by this service.  The `KeyPolicyType` property for all members of this collection shall contain the value `NVMeoF`.",
89                    "readonly": true
90                },
91                "NVMeoFSecrets": {
92                    "$ref": "http://redfish.dmtf.org/schemas/v1/KeyCollection.json#/definitions/KeyCollection",
93                    "description": "The NVMe-oF keys maintained by this service.",
94                    "longDescription": "This property shall contain a link to a resource collection of type `KeyCollection` that contains the NVMe-oF keys maintained by this service.  The `KeyType` property for all members of this collection shall contain the value `NVMeoF`.",
95                    "readonly": true
96                },
97                "Name": {
98                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
99                    "readonly": true
100                },
101                "Oem": {
102                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
103                    "description": "The OEM extension property.",
104                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
105                }
106            },
107            "required": [
108                "@odata.id",
109                "@odata.type",
110                "Id",
111                "Name"
112            ],
113            "type": "object"
114        },
115        "OemActions": {
116            "additionalProperties": true,
117            "description": "The available OEM-specific actions for this resource.",
118            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
119            "patternProperties": {
120                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
121                    "description": "This property shall specify a valid odata or Redfish property.",
122                    "type": [
123                        "array",
124                        "boolean",
125                        "integer",
126                        "number",
127                        "null",
128                        "object",
129                        "string"
130                    ]
131                }
132            },
133            "properties": {},
134            "type": "object"
135        }
136    },
137    "language": "en",
138    "owningEntity": "DMTF",
139    "release": "2021.2",
140    "title": "#KeyService.v1_0_1.KeyService"
141}