1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/LicenseService.v1_1_2.json",
3    "$ref": "#/definitions/LicenseService",
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                "#LicenseService.Install": {
27                    "$ref": "#/definitions/Install"
28                },
29                "Oem": {
30                    "$ref": "#/definitions/OemActions",
31                    "description": "The available OEM-specific actions for this resource.",
32                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
33                }
34            },
35            "type": "object"
36        },
37        "Install": {
38            "additionalProperties": false,
39            "description": "This action installs one or more licenses from a remote file.",
40            "longDescription": "This action shall install one or more licenses from a remote file.  The service may update an existing `License` resource.  The `Location` header in the response shall contain the URI of the new or updated `License` resource.",
41            "parameters": {
42                "AuthorizedDevices": {
43                    "description": "An array of links to the devices to be authorized by the license.",
44                    "items": {
45                        "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/idRef"
46                    },
47                    "longDescription": "This parameter shall contain an array of links to the devices to be authorized by the license.  Clients can provide this parameter when installing a license to apply the license to specific devices.  If not provided when installing a license, the service may determine the devices to which the license applies.  This parameter shall not be present if the `AuthorizationScope` property contains the value `Service`.",
48                    "type": "array",
49                    "versionAdded": "v1_1_0"
50                },
51                "LicenseFileURI": {
52                    "description": "The URI of the license file to install.",
53                    "format": "uri-reference",
54                    "longDescription": "This parameter shall contain an RFC3986-defined URI that links to a file that the license service retrieves to install the license in that file.  This URI should contain a scheme that describes the transfer protocol.  If the `TransferProtocol` parameter is absent or not supported, and a transfer protocol is not specified by a scheme contained within this URI, the service shall use HTTP to get the file.",
55                    "requiredParameter": true,
56                    "type": "string"
57                },
58                "Password": {
59                    "description": "The password to access the URI specified by the `LicenseFileURI` parameter.",
60                    "longDescription": "This parameter shall contain the password to access the URI specified by the `LicenseFileURI` parameter.",
61                    "type": "string"
62                },
63                "TargetServices": {
64                    "description": "An array of links to the managers where the license will be installed.",
65                    "items": {
66                        "$ref": "http://redfish.dmtf.org/schemas/v1/Manager.json#/definitions/Manager"
67                    },
68                    "longDescription": "This property shall contain an array of links to resources of type `Manager` that represent the services where the license will be installed, such as remote Redfish services.  This parameter shall only be present in aggregators when the `AuthorizationScope` property contains `Service` or `Capacity`.",
69                    "type": "array",
70                    "versionAdded": "v1_1_0"
71                },
72                "TransferProtocol": {
73                    "$ref": "#/definitions/TransferProtocolType",
74                    "description": "The network protocol that the license service uses to retrieve the license file located at the URI provided in `LicenseFileURI`.  This parameter is ignored if the URI provided in `LicenseFileURI` contains a scheme.",
75                    "longDescription": "This parameter shall contain the network protocol that the license service shall use to retrieve the license file located at the `LicenseFileURI`.  Services should ignore this parameter if the URI provided in `LicenseFileURI` contains a scheme.  If this parameter is not provided or supported, and if a transfer protocol is not specified by a scheme contained within this URI, the service shall use HTTP to retrieve the file."
76                },
77                "Username": {
78                    "description": "The username to access the URI specified by the `LicenseFileURI` parameter.",
79                    "longDescription": "This parameter shall contain the username to access the URI specified by the `LicenseFileURI` parameter.",
80                    "type": "string"
81                }
82            },
83            "patternProperties": {
84                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
85                    "description": "This property shall specify a valid odata or Redfish property.",
86                    "type": [
87                        "array",
88                        "boolean",
89                        "integer",
90                        "number",
91                        "null",
92                        "object",
93                        "string"
94                    ]
95                }
96            },
97            "properties": {
98                "target": {
99                    "description": "Link to invoke action",
100                    "format": "uri-reference",
101                    "type": "string"
102                },
103                "title": {
104                    "description": "Friendly action name",
105                    "type": "string"
106                }
107            },
108            "type": "object"
109        },
110        "LicenseService": {
111            "additionalProperties": false,
112            "description": "The `LicenseService` schema describes the license service and the properties for the service itself with a link to the collection of licenses.  The license service also provides methods for installing licenses in a Redfish service.",
113            "longDescription": "This resource shall represent a license service and the properties that affect the service itself for a Redfish implementation.",
114            "patternProperties": {
115                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
116                    "description": "This property shall specify a valid odata or Redfish property.",
117                    "type": [
118                        "array",
119                        "boolean",
120                        "integer",
121                        "number",
122                        "null",
123                        "object",
124                        "string"
125                    ]
126                }
127            },
128            "properties": {
129                "@odata.context": {
130                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
131                },
132                "@odata.etag": {
133                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
134                },
135                "@odata.id": {
136                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
137                },
138                "@odata.type": {
139                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
140                },
141                "Actions": {
142                    "$ref": "#/definitions/Actions",
143                    "description": "The available actions for this resource.",
144                    "longDescription": "This property shall contain the available actions for this resource."
145                },
146                "Description": {
147                    "anyOf": [
148                        {
149                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
150                        },
151                        {
152                            "type": "null"
153                        }
154                    ],
155                    "readonly": true
156                },
157                "Id": {
158                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
159                    "readonly": true
160                },
161                "LicenseExpirationWarningDays": {
162                    "description": "The number of days prior to a license expiration that a warning message is sent.  A value of zero indicates no warning message is sent.",
163                    "longDescription": "This property shall contain the number of days prior to a license expiration that the service shall send the `DaysBeforeExpiration` message from the License Message Registry at least once.  A value of zero shall indicate that no warning messages are sent prior to license expiration.",
164                    "readonly": false,
165                    "type": [
166                        "integer",
167                        "null"
168                    ]
169                },
170                "Licenses": {
171                    "$ref": "http://redfish.dmtf.org/schemas/v1/LicenseCollection.json#/definitions/LicenseCollection",
172                    "description": "The link to the collection of licenses.",
173                    "longDescription": "This property shall contain a link to a resource collection of type `LicenseCollection`.  When installing a license with a `POST` operation to this collection, the service may update an existing License resource instead of creating a new resource.  In these cases, the service shall respond with the HTTP `200 OK` status code or HTTP `204 No Content` status code and the `Location` header in the response shall contain the URI of the updated License resource.",
174                    "readonly": true
175                },
176                "Name": {
177                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
178                    "readonly": true
179                },
180                "Oem": {
181                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
182                    "description": "The OEM extension property.",
183                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
184                },
185                "ServiceEnabled": {
186                    "description": "An indication of whether this service is enabled.",
187                    "longDescription": "This property shall indicate whether this service is enabled.",
188                    "readonly": false,
189                    "type": [
190                        "boolean",
191                        "null"
192                    ]
193                }
194            },
195            "required": [
196                "@odata.id",
197                "@odata.type",
198                "Id",
199                "Name"
200            ],
201            "type": "object"
202        },
203        "OemActions": {
204            "additionalProperties": true,
205            "description": "The available OEM-specific actions for this resource.",
206            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
207            "patternProperties": {
208                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
209                    "description": "This property shall specify a valid odata or Redfish property.",
210                    "type": [
211                        "array",
212                        "boolean",
213                        "integer",
214                        "number",
215                        "null",
216                        "object",
217                        "string"
218                    ]
219                }
220            },
221            "properties": {},
222            "type": "object"
223        },
224        "TransferProtocolType": {
225            "enum": [
226                "CIFS",
227                "FTP",
228                "SFTP",
229                "HTTP",
230                "HTTPS",
231                "SCP",
232                "TFTP",
233                "OEM",
234                "NFS"
235            ],
236            "enumDescriptions": {
237                "CIFS": "Common Internet File System (CIFS).",
238                "FTP": "File Transfer Protocol (FTP).",
239                "HTTP": "Hypertext Transfer Protocol (HTTP).",
240                "HTTPS": "Hypertext Transfer Protocol Secure (HTTPS).",
241                "NFS": "Network File System (NFS).",
242                "OEM": "A manufacturer-defined protocol.",
243                "SCP": "Secure Copy Protocol (SCP).",
244                "SFTP": "SSH File Transfer Protocol (SFTP).",
245                "TFTP": "Trivial File Transfer Protocol (TFTP)."
246            },
247            "type": "string"
248        }
249    },
250    "language": "en",
251    "owningEntity": "DMTF",
252    "release": "2022.3",
253    "title": "#LicenseService.v1_1_2.LicenseService"
254}