1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
{
"$id": "http://redfish.dmtf.org/schemas/v1/ActionInfo.v1_1_2.json",
"$ref": "#/definitions/ActionInfo",
"$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",
"definitions": {
"ActionInfo": {
"additionalProperties": false,
"description": "The ActionInfo schema defines the supported parameters and other information for a Redfish action. Supported parameters can differ among vendors and even among Resource instances. This data can ensure that action requests from applications contain supported parameters.",
"longDescription": "This Resource shall represent the supported parameters and other information for a Redfish action on a target within a Redfish implementation. Supported parameters can differ among vendors and even among Resource instances. This data can ensure that action requests from applications contain supported parameters.",
"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"
},
"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
},
"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."
},
"Parameters": {
"description": "The list of parameters included in the specified Redfish action.",
"items": {
"$ref": "#/definitions/Parameters"
},
"longDescription": "This property shall list the parameters included in the specified Redfish action for this Resource.",
"type": "array"
}
},
"required": [
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"type": "object"
},
"ParameterTypes": {
"enum": [
"Boolean",
"Number",
"NumberArray",
"String",
"StringArray",
"Object",
"ObjectArray"
],
"enumDescriptions": {
"Boolean": "A boolean.",
"Number": "A number.",
"NumberArray": "An array of numbers.",
"Object": "An embedded JSON object.",
"ObjectArray": "An array of JSON objects.",
"String": "A string.",
"StringArray": "An array of strings."
},
"type": "string"
},
"Parameters": {
"additionalProperties": false,
"description": "The information about a parameter included in a Redfish action for this Resource.",
"longDescription": "This property shall contain information about a parameter included in a Redfish Action 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": {
"AllowableValues": {
"description": "The allowable values for this parameter as applied to this action target.",
"items": {
"type": [
"string",
"null"
]
},
"longDescription": "This property shall indicate the allowable values for this parameter as applied to this action target.",
"readonly": true,
"type": "array"
},
"DataType": {
"anyOf": [
{
"$ref": "#/definitions/ParameterTypes"
},
{
"type": "null"
}
],
"description": "The JSON property type for this parameter.",
"longDescription": "This property shall contain the JSON property type for this parameter.",
"readonly": true
},
"MaximumValue": {
"description": "The maximum supported value for this parameter.",
"longDescription": "This integer or number property shall contain the maximum value that this service supports. This property shall not be present for non-integer or number parameters.",
"readonly": true,
"type": [
"number",
"null"
],
"versionAdded": "v1_1_0"
},
"MinimumValue": {
"description": "The minimum supported value for this parameter.",
"longDescription": "This integer or number property shall contain the minimum value that this service supports. This property shall not be present for parameters that are of types other than integer or number.",
"readonly": true,
"type": [
"number",
"null"
],
"versionAdded": "v1_1_0"
},
"Name": {
"description": "The name of the parameter for this action.",
"longDescription": "This property shall contain the name of the parameter included in a Redfish action.",
"readonly": true,
"type": "string"
},
"ObjectDataType": {
"description": "The data type of an object-based parameter.",
"longDescription": "This property shall describe the entity type definition in `@odata.type` format for the parameter. This property shall be required for parameters with a data type of `Object` or `ObjectArray`, and shall not be present for parameters with other data types.",
"readonly": true,
"type": [
"string",
"null"
]
},
"Required": {
"description": "An indication of whether the parameter is required to complete this action.",
"longDescription": "This property shall indicate whether the parameter is required to complete this action.",
"readonly": true,
"type": "boolean"
}
},
"required": [
"Name"
],
"type": "object"
}
},
"owningEntity": "DMTF",
"release": "2018.2",
"title": "#ActionInfo.v1_1_2.ActionInfo"
}
|
