4 description: Swagger OpenAPI document for the INF O2 Services
6 title: INF O2 Services API
9 - name: O2IMS-InfrastructureInventory
10 description: O2 IMS Inventory related operations.
11 - name: O2IMS-InfrastructureMonitoring
12 description: O2 IMS Monitoring related operations.
18 /o2ims-infrastructureInventory/api_versions:
21 - O2IMS-InfrastructureInventory
22 operationId: Get Inventory Version
28 $ref: '#/definitions/InventoryAPIVersion'
29 /o2ims-infrastructureInventory/v1:
32 - O2IMS-InfrastructureInventory
33 operationId: Get Ocloud Information
35 - name: exclude_default
37 description: "Exclude showing all default fields, Set \"true\" to enable."
40 - name: exclude_fields
42 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
47 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
52 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
59 $ref: '#/definitions/OcloudDto'
61 description: oCloud not found
62 /o2ims-infrastructureInventory/v1/:
65 - O2IMS-InfrastructureInventory
66 operationId: Get Ocloud Information
68 - name: exclude_default
70 description: "Exclude showing all default fields, Set \"true\" to enable."
73 - name: exclude_fields
75 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
80 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
85 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
92 $ref: '#/definitions/OcloudDto'
94 description: oCloud not found
95 /o2ims-infrastructureInventory/v1/api_versions:
98 - O2IMS-InfrastructureInventory
99 operationId: Get Inventory API version
105 $ref: '#/definitions/InventoryV1APIVersion'
106 /o2ims-infrastructureInventory/v1/deploymentManagers:
109 - O2IMS-InfrastructureInventory
110 operationId: Get Deployment Manager List
114 description: Filter of the query.
117 - name: exclude_default
119 description: "Exclude showing all default fields, Set \"true\" to enable."
122 - name: exclude_fields
124 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
129 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
134 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
137 - name: nextpage_opaque_marker
139 description: "Page number of the results to fetch. Default: 1"
149 $ref: '#/definitions/DeploymentManagerListDto'
150 /o2ims-infrastructureInventory/v1/deploymentManagers/{deploymentManagerID}:
153 - O2IMS-InfrastructureInventory
154 operationId: Get Deployment Manager Information
156 - name: exclude_default
158 description: "Exclude showing all default fields, Set \"true\" to enable."
161 - name: exclude_fields
163 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
168 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
173 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
178 description: "DMS profile: value supports \"native_k8sapi\""
181 - name: deploymentManagerID
183 description: ID of the deployment manager
190 $ref: '#/definitions/DeploymentManagerGetDto'
192 description: Deployment manager not found
193 /o2ims-infrastructureInventory/v1/resourcePools:
196 - O2IMS-InfrastructureInventory
197 operationId: Get Resource Pool List
201 description: Filter of the query.
204 - name: exclude_default
206 description: "Exclude showing all default fields, Set \"true\" to enable."
209 - name: exclude_fields
211 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
216 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
221 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
224 - name: nextpage_opaque_marker
226 description: "Page number of the results to fetch. Default: 1"
236 $ref: '#/definitions/ResourcePoolGetDto'
237 /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}:
240 - O2IMS-InfrastructureInventory
241 operationId: Get Resource Pool Information
243 - name: exclude_default
245 description: "Exclude showing all default fields, Set \"true\" to enable."
248 - name: exclude_fields
250 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
255 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
260 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
263 - name: resourcePoolID
265 description: ID of the resource pool
272 $ref: '#/definitions/ResourcePoolGetDto'
274 description: Resource pool not found
275 /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources:
278 - O2IMS-InfrastructureInventory
279 operationId: Get Resource List
283 description: Filter of the query.
286 - name: exclude_default
288 description: "Exclude showing all default fields, Set \"true\" to enable."
291 - name: exclude_fields
293 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
298 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
303 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
306 - name: nextpage_opaque_marker
308 description: "Page number of the results to fetch. Default: 1"
312 - name: resourcePoolID
314 description: ID of the resource pool
323 $ref: '#/definitions/ResourceListDto'
325 description: Resource pool not found
326 /o2ims-infrastructureInventory/v1/resourcePools/{resourcePoolID}/resources/{resourceID}:
329 - O2IMS-InfrastructureInventory
330 operationId: Get Resource Information
332 - name: exclude_default
334 description: "Exclude showing all default fields, Set \"true\" to enable."
337 - name: exclude_fields
339 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
344 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
349 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
354 description: ID of the resource
357 - name: resourcePoolID
359 description: ID of the resource pool
366 $ref: '#/definitions/ResourceGetDto2'
368 description: Resource not found
369 /o2ims-infrastructureInventory/v1/resourceTypes:
372 - O2IMS-InfrastructureInventory
373 operationId: Get Resource Type List
377 description: Filter of the query.
380 - name: exclude_default
382 description: "Exclude showing all default fields, Set \"true\" to enable."
385 - name: exclude_fields
387 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
392 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
397 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
400 - name: nextpage_opaque_marker
402 description: "Page number of the results to fetch. Default: 1"
412 $ref: '#/definitions/ResourceTypeGetDto'
413 /o2ims-infrastructureInventory/v1/resourceTypes/{resourceTypeID}:
416 - O2IMS-InfrastructureInventory
417 operationId: Get Resource Type Information
419 - name: exclude_default
421 description: "Exclude showing all default fields, Set \"true\" to enable."
424 - name: exclude_fields
426 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
431 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
436 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
439 - name: resourceTypeID
441 description: ID of the resource type
448 $ref: '#/definitions/ResourceTypeGetDto'
450 description: Resource type not found
451 /o2ims-infrastructureInventory/v1/subscriptions:
454 - O2IMS-InfrastructureInventory
455 operationId: Get Subscription List
459 description: Filter of the query.
462 - name: exclude_default
464 description: "Exclude showing all default fields, Set \"true\" to enable."
467 - name: exclude_fields
469 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
474 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
479 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
482 - name: nextpage_opaque_marker
484 description: "Page number of the results to fetch. Default: 1"
494 $ref: '#/definitions/SubscriptionGetDto'
497 - O2IMS-InfrastructureInventory
498 operationId: Create a Subscription
504 $ref: '#/definitions/SubscriptionCreateDto'
509 $ref: '#/definitions/SubscriptionGetDto'
510 /o2ims-infrastructureInventory/v1/subscriptions/{subscriptionID}:
513 - O2IMS-InfrastructureInventory
514 operationId: Get Subscription Information
516 - name: subscriptionID
518 description: ID of the subscription
521 - name: exclude_default
523 description: "Exclude showing all default fields, Set \"true\" to enable."
526 - name: exclude_fields
528 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
533 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
538 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
545 $ref: '#/definitions/SubscriptionGetDto'
547 description: Subscription not found
550 - O2IMS-InfrastructureInventory
551 operationId: Delete a Subscription
553 - name: subscriptionID
555 description: ID of the subscription
560 description: Subscription deleted
562 description: Subscription not found
563 /o2ims-infrastructureMonitoring/api_versions:
566 - O2IMS-InfrastructureMonitoring
567 operationId: Get Monitoring Version
573 $ref: '#/definitions/MonitoringAPIVersion'
574 /o2ims-infrastructureMonitoring/v1/alarmSubscriptions:
577 - O2IMS-InfrastructureMonitoring
578 operationId: Get Alarm Subscription List
582 description: Filter of the query.
585 - name: exclude_default
587 description: "Exclude showing all default fields, Set \"true\" to enable."
590 - name: exclude_fields
592 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
597 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
602 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
605 - name: nextpage_opaque_marker
607 description: "Page number of the results to fetch. Default: 1"
617 $ref: '#/definitions/AlarmSubscriptionGetDto'
620 - O2IMS-InfrastructureMonitoring
621 operationId: Create a Alarm Subscription
627 $ref: '#/definitions/AlarmSubscriptionCreateDto'
632 $ref: '#/definitions/AlarmSubscriptionGetDto'
633 /o2ims-infrastructureMonitoring/v1/alarmSubscriptions/{alarmSubscriptionID}:
636 - O2IMS-InfrastructureMonitoring
637 operationId: Get Alarm Subscription Information
639 - name: alarmSubscriptionID
641 description: ID of the Alarm Subscription
644 - name: exclude_default
646 description: "Exclude showing all default fields, Set \"true\" to enable."
649 - name: exclude_fields
651 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
656 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
661 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
668 $ref: '#/definitions/AlarmSubscriptionGetDto'
670 description: Alarm Subscription not found
673 - O2IMS-InfrastructureMonitoring
674 operationId: Delete an Alarm Subscription
676 - name: alarmSubscriptionID
678 description: ID of the Alarm Subscription
683 description: Subscription deleted
685 description: Alarm Subscription not found
686 /o2ims-infrastructureMonitoring/v1/alarms:
689 - O2IMS-InfrastructureMonitoring
690 operationId: Get Alarm Event Record List
694 description: Filter of the query.
697 - name: exclude_default
699 description: "Exclude showing all default fields, Set \"true\" to enable."
702 - name: exclude_fields
704 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
709 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
714 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
717 - name: nextpage_opaque_marker
719 description: "Page number of the results to fetch. Default: 1"
729 $ref: '#/definitions/AlarmGetDto'
730 /o2ims-infrastructureMonitoring/v1/alarms/{alarmEventRecordId}:
733 - O2IMS-InfrastructureMonitoring
734 operationId: Get Alarm Event Record Information
736 - name: exclude_default
738 description: "Exclude showing all default fields, Set \"true\" to enable."
741 - name: exclude_fields
743 description: "Set fields to exclude showing, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exclude_default\"."
748 description: "Set fields to show, split by comma, \"/\" for parent and children. Like \"name,parent/children\". This value will cover \"exculde_fields\"."
753 description: Set any value for show all fields. This value will cover "fields" and "all_fields".
756 - name: alarmEventRecordId
758 description: ID of the alarm event record
765 $ref: '#/definitions/AlarmGetDto'
767 description: Alarm Event Record not found
768 /o2ims-infrastructureMonitoring/v1/api_versions:
771 - O2IMS-InfrastructureMonitoring
772 operationId: Get Monitoring API version
780 $ref: '#/definitions/MonitoringV1APIVersion'
789 example: https://128.224.115.36:30205/o2ims-infrastructureInventory
790 description: Specifies the URI prefix for the API
795 description: Version(s) supported for the API signaled by the uriPrefix attribute.
797 $ref: '#/definitions/InventoryApiVersionStructure'
798 x-mask: "{uriPrefix,apiVersions}"
799 InventoryApiVersionStructure:
807 description: Identifies a supported version.
809 InventoryV1APIVersion:
816 example: https://128.224.115.36:30205/o2ims-infrastructureInventory/v1
817 description: Specifies the URI prefix for the API
822 description: Version(s) supported for the API signaled by the uriPrefix attribute.
824 $ref: '#/definitions/InventoryV1ApiVersionStructure'
825 x-mask: "{uriPrefix,apiVersions}"
826 InventoryV1ApiVersionStructure:
834 description: Identifies a supported version.
843 example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
844 description: Identifier for the containing O-Cloud.
847 example: 10a07219-4201-4b3e-a52d-81ab6a755d8a
848 description: Identifier of the O-Cloud instance. Globally unique across O-Cloud instances.
851 example: 10a07219-4201-4b3e-a52d-81ab6a755d8a
852 description: Identifier of the O-Cloud instance. Globally unique across O-Cloud instances.(Specification)
855 example: 95b818b8-b315-4d9f-af37-b82c492101f1
856 description: Human readable name of the O-Cloud.
860 description: Human readable description of the O-Cloud.
863 example: https://128.224.115.51:30205
864 description: The fully qualified URI root to all services provided by the O2ims interface
868 description: These are unspecified (not standardized) properties (keys) which are tailored by the vendor to extend the information provided about the O-Cloud.
869 x-mask: "{oCloudId,globalCloudId,globalcloudId,name,description,serviceUri}"
877 example: 60cba7be-e2cd-3b8c-a7ff-16e0f10573f9
878 description: Identifier for the Resource Type.
882 description: Human readable name of the resource type.
885 example: The Physical Server resource type
886 description: Human readable description of the resource type.
890 description: Provider of the Resource.
894 description: Information about the model of the resource as defined by its provider.
898 description: Version or generation of the resource as defined by its provider.
900 $ref: '#/definitions/AlarmDictionaryDto'
904 description: List of metadata key-value pairs used to associate meaningful metadata to the related resource type.
905 x-mask: "{resourceTypeId,name,description,model,vendor,version}"
911 example: 7e1e59c3-c99e-3d1c-9934-21548a3a699a
912 description: Identifier for the Alarm Dictionary.
913 alarmDictionaryVersion:
916 description: Version of the Alarm Dictionary.
917 alarmDictionarySchemaVersion:
920 description: Version of the Alarm Dictionary Schema to which this alarm dictionary conforms.
924 description: "O-RAN entity type emitting the alarm: This shall be unique per vendor ResourceType.model and ResourceType.version"
928 description: Vendor of the Entity Type to whom this Alarm Dictionary applies. This should be the same value as in the ResourceType.vendor attribute.
929 managementInterfaceId:
932 description: List of management interface over which alarms are transmitted for this Entity Type.
936 description: Identifies which field or list of fields in the alarm notification contains the primary key (PK) into the Alarm Dictionary for this interface; i.e. which field contains the Alarm Definition ID.
940 description: Contains the list of alarms that can be detected against this ResourceType.
942 $ref: '#/definitions/AlarmDefinitionDto'
948 example: eaefa070-7cb6-3403-be46-177bd9ccc2d3
949 description: Provides a unique identifier of the alarm being raised.
953 description: Provides short name for the alarm.
957 description: Indicates the Alarm Dictionary Version in which this alarm last changed.
961 description: "Indicates the type of change that occurred during the alarm last change; added, deleted, modified."
965 host=<hostname>.filesystem=<mount-dir>
966 File System threshold exceeded; threshold x%, actual y% .
970 host=<hostname>.volumegroup=<volumegroup-name>
971 Monitor and if condition persists, consider addin ...
972 description: Provides a longer descriptive meaning of the alarm condition and a description of the consequences of the alarm condition.
973 proposedRepairActions:
975 example: Reduce usage or resize filesystem.
976 description: Provides guidance for proposed repair actions.
980 description: Identifies whether alarm is cleared automatically or manually.
981 managementInterfaceId:
984 description: List of management interface over which alarms are transmitted for this Entity Type.
988 description: Identifies which field or list of fields in the alarm notification contains the primary key (PK) into the Alarm Dictionary for this interface; i.e. which field contains the Alarm Definition ID.
989 alarmAdditionalFields:
992 description: List of metadata key-value pairs used to associate meaningful metadata to the related resource type.
1000 example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
1001 description: Identifier for the Resource Pool in the O-Cloud instance.
1005 description: This identifier is copied from the O-Cloud Id assigned by the SMO during the O-Cloud deployment.
1009 description: Human readable name of the resource pool.
1012 example: A Resource Pool
1013 description: Human readable description of the resource pool.
1016 example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
1017 description: Identifier for the containing O-Cloud.
1021 description: Information about the geographical location of the resource pool as detected by the O-Cloud.
1025 description: List of metadata key-value pairs used to associate meaningful metadata to the related resource pool.
1026 x-mask: "{resourcePoolId,oCloudId,globalLocationId,name,description}"
1034 example: 5b3a2da8-17da-466c-b5f7-972590c7baf2
1035 description: Identifier for the Resource.
1038 example: 60cba7be-e2cd-3b8c-a7ff-16e0f10573f9
1039 description: Identifier for the Resource Type of this resource.
1042 example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
1043 description: Identifier of the Resource Pool containing this resource.
1047 description: Identifier or serial number of the resource.
1051 description: Identifier for the parent resource.
1054 example: "id:1;hostname:controller-0;mgmt_mac:00:00:00:00:00:00;mgmt_ip:192.168.204.2;personality:controller;subfunctions:controller,worker;administrative:unlocked;operational:enabled;availability:available;clock_synchronization:ntp;capabilities:{'is_max_cpu_configurable': 'configurable', 'stor_function': 'monitor', 'Personality': 'Controller-Active'};boot_device:/dev/disk/by-path/pci-0000:02:00.0-scsi-0:1:0:0;rootfs_device:/dev/disk/by-path/pci-0000:02:00.0-scsi-0:1:0:0;software_load:22.12;install_state:None;max_cpu_mhz_allowed:None"
1055 description: Human readable description of the resource.
1059 x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
1067 example: eee8b101-6b7f-4f0a-b54b-89adc0f3f906
1068 description: Identifier for the Resource.
1071 example: a45983bb-199a-30ec-b7a1-eab2455f333c
1072 description: Identifier for the Resource Type of this resource.
1075 example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
1076 description: Identifier of the Resource Pool containing this resource.
1080 description: Identifier or serial number of the resource.
1083 example: 5b3a2da8-17da-466c-b5f7-972590c7baf2
1084 description: Identifier for the parent resource.
1087 example: cpu:0;core:0;thread:0;cpu_family:6;cpu_model:Intel(R) Xeon(R) CPU E5-2670 v2 @ 2.50GHz;allocated_function:Platform;numa_node:0
1088 description: Human readable description of the resource.
1095 $ref: '#/definitions/ResourceGetDto1'
1096 x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
1104 example: eee8b101-6b7f-4f0a-b54b-89adc0f3f906
1105 description: Identifier for the Resource.
1108 example: a45983bb-199a-30ec-b7a1-eab2455f333c
1109 description: Identifier for the Resource Type of this resource.
1112 example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
1113 description: Identifier of the Resource Pool containing this resource.
1117 description: Identifier or serial number of the resource.
1120 example: 5b3a2da8-17da-466c-b5f7-972590c7baf2
1121 description: Identifier for the parent resource.
1124 example: cpu:0;core:0;thread:0;cpu_family:6;cpu_model:Intel(R) Xeon(R) CPU E5-2670 v2 @ 2.50GHz;allocated_function:Platform;numa_node:0
1125 description: Human readable description of the resource.
1132 $ref: '#/definitions/ResourceGetDto0'
1133 x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
1141 example: eee8b101-6b7f-4f0a-b54b-89adc0f3f906
1142 description: Identifier for the Resource.
1145 example: a45983bb-199a-30ec-b7a1-eab2455f333c
1146 description: Identifier for the Resource Type of this resource.
1149 example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
1150 description: Identifier of the Resource Pool containing this resource.
1154 description: Identifier or serial number of the resource.
1157 example: 5b3a2da8-17da-466c-b5f7-972590c7baf2
1158 description: Identifier for the parent resource.
1161 example: cpu:0;core:0;thread:0;cpu_family:6;cpu_model:Intel(R) Xeon(R) CPU E5-2670 v2 @ 2.50GHz;allocated_function:Platform;numa_node:0
1162 description: Human readable description of the resource.
1166 x-mask: "{resourceId,resourcePoolId,resourceTypeId,description,parentId}"
1167 DeploymentManagerListDto:
1170 - deploymentManagerId
1172 deploymentManagerId:
1174 example: c765516a-a84e-30c9-b954-9c3031bf71c8
1175 description: Identifier for the Deployment Manager.
1178 example: 95b818b8-b315-4d9f-af37-b82c492101f1.kubernetes
1179 description: Human readable name of the deployment manager.
1183 description: Human readable description of the deployment manager.
1186 example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
1187 description: Identifier for the containing O-Cloud.
1190 example: https://128.224.115.51:6443
1191 description: The fully qualified URI to a Deployment Management server for O2dms services.
1196 description: "Profile support list, use default for the return endpoint"
1202 description: List of metadata key-value pairs used to associate meaningful metadata to the related Deployment Manager
1203 x-mask: "{deploymentManagerId,name,description,oCloudId,serviceUri,profileSupportList}"
1204 DeploymentManagerGetDto:
1207 - deploymentManagerId
1209 deploymentManagerId:
1211 example: c765516a-a84e-30c9-b954-9c3031bf71c8
1212 description: Identifier for the Deployment Manager.
1215 example: 95b818b8-b315-4d9f-af37-b82c492101f1.kubernetes
1216 description: Human readable name of the deployment manager.
1220 description: Human readable description of the deployment manager.
1223 example: f078a1d3-56df-46c2-88a2-dd659aa3f6bd
1224 description: Identifier for the containing O-Cloud.
1227 example: https://128.224.115.51:6443
1228 description: The fully qualified URI to a Deployment Management server for O2dms services.
1230 $ref: '#/definitions/DeploymentManagerExtensions'
1231 x-mask: "{deploymentManagerId,name,description,oCloudId,serviceUri,extensions,profileName,profileData}"
1232 DeploymentManagerExtensions:
1240 $ref: '#/definitions/DeploymentManagerGetDtoProfile'
1241 DeploymentManagerGetDtoProfile:
1244 cluster_api_endpoint:
1246 example: https://128.224.115.51:6443
1247 description: Kubernetes Cluster API Endpoint
1250 example: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUZEakNDQX.....
1251 description: Kubernetes Cluster CA cert
1254 example: kubernetes-admin
1255 description: Kubernetes Admin username
1258 example: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVJRENDQW.....
1259 description: Kubernetes Admin client cert
1262 example: LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcE.....
1263 description: Kubernetes Admin client key
1264 helmcli_host_with_port:
1266 example: 128.224.115.34:30022
1267 description: Helm CLI Host address with SSH port
1271 description: Helm CLI SSH login username
1275 description: Helm CLI SSH login password
1278 example: /share/kubeconfig_c765516a.config
1279 description: Helm CLI KUBECONFIG path
1280 SubscriptionCreateDto:
1287 example: https://128.224.115.15:1081/smo/v1/o2ims_inventory_observer
1288 description: Identifier for the Subscription.
1289 consumerSubscriptionId:
1291 example: 3F20D850-AF4F-A84F-FB5A-0AD585410361
1292 description: Identifier for the consumer of events sent due to the Subscription.
1296 description: "Criteria for events which do not need to be reported or will be filtered by the subscription notification service. Therefore, if a filter is not provided then all events are reported."
1304 example: 0bea3e71-d2f7-4bf3-9c06-41d8d35806f9
1305 description: Identifier for the Subscription.
1308 example: https://128.224.115.15:1081/smo/v1/o2ims_inventory_observer
1309 description: The fully qualified URI to a consumer procedure which can process a Post of the InventoryEventNotification.
1310 consumerSubscriptionId:
1312 example: 3F20D850-AF4F-A84F-FB5A-0AD585410361
1313 description: Identifier for the consumer of events sent due to the Subscription.
1317 description: "Criteria for events which do not need to be reported or will be filtered by the subscription notification service. Therefore, if a filter is not provided then all events are reported."
1318 x-mask: "{subscriptionId,callback}"
1319 MonitoringAPIVersion:
1326 example: https://128.224.115.36:30205/o2ims-infrastructureMonitoring
1327 description: Specifies the URI prefix for the API
1332 description: Version(s) supported for the API signaled by the uriPrefix attribute.
1334 $ref: '#/definitions/MonitoringApiVersionStructure'
1335 x-mask: "{uriPrefix,apiVersions}"
1336 MonitoringApiVersionStructure:
1344 description: Identifies a supported version.
1346 MonitoringV1APIVersion:
1353 example: https://128.224.115.36:30205/o2ims-infrastructureMonitoring/v1
1354 description: Specifies the URI prefix for the API
1359 description: Version(s) supported for the API signaled by the uriPrefix attribute.
1361 $ref: '#/definitions/MonitoringV1ApiVersionStructure'
1362 x-mask: "{uriPrefix,apiVersions}"
1363 MonitoringV1ApiVersionStructure:
1371 description: Identifies a supported version.
1376 - alarmEventRecordId
1380 example: 97cc2b01-0e71-4a93-a911-2e87f04d996f
1381 description: The identifier for the AlarmEventRecord Object.
1384 example: 60cba7be-e2cd-3b8c-a7ff-16e0f10573f9
1385 description: A reference to the type of resource which caused the alarm.
1388 example: 60cba7be-e2cd-3b8c-a7ff-16e0f10573f9
1389 description: A reference to the type of resource which caused the alarm.(Specification)
1392 example: 5b3a2da8-17da-466c-b5f7-972590c7baf2
1393 description: A reference to the resource instance which caused the alarm.
1396 example: 5b3a2da8-17da-466c-b5f7-972590c7baf2
1397 description: A reference to the resource instance which caused the alarm.(Specification)
1400 example: 1197f463-b3d4-3aa3-9c14-faa493baa069
1401 description: A reference to the Alarm Definition record in the Alarm Dictionary associated with the referenced Resource Type.
1404 example: 1197f463-b3d4-3aa3-9c14-faa493baa069
1405 description: A reference to the Alarm Definition record in the Alarm Dictionary associated with the referenced Resource Type.(Specification)
1408 example: f52054c9-6f3c-39a0-aab8-e00e01d8c4d3
1409 description: A reference to the ProbableCause of the Alarm.
1412 example: f52054c9-6f3c-39a0-aab8-e00e01d8c4d3
1413 description: A reference to the ProbableCause of the Alarm.(Specification)
1416 example: 2022-12-22 09:42:53
1417 description: Date/Time stamp value when the AlarmEventRecord has been created.
1421 description: Date/Time stamp value when any value of the AlarmEventRecord has been modified.
1422 alarmAcknowledgeTime:
1425 description: Date/Time stamp value when the alarm condition is acknowledged.
1429 description: Boolean value indicating of a management system has acknowledged the alarm.
1433 description: "One of the following values: \n 0 for \"CRITICAL\" \n1 for \"MAJOR\" \n2 for \"MINOR\" \n3 for \"WARNING\" \n4 for \"INDETERMINATE\" \n5 for \"CLEARED\""
1437 AlarmSubscriptionCreateDto:
1444 example: https://128.224.115.15:1081/smo/v1/o2ims_alarm_observer
1445 description: The fully qualified URI to a consumer procedure which can process a Post of the InventoryEventNotification.
1446 consumerSubscriptionId:
1448 example: 3F20D850-AF4F-A84F-FB5A-0AD585410361
1449 description: Identifier for the consumer of events sent due to the Subscription.
1453 description: "Criteria for events which do not need to be reported or will be filtered by the subscription notification service. Therefore, if a filter is not provided then all events are reported."
1454 AlarmSubscriptionGetDto:
1457 - alarmSubscriptionId
1459 alarmSubscriptionId:
1461 example: e320da6d-27a8-4948-8b52-3bf3355b45f3
1462 description: Identifier for the Alarm Subscription.
1465 example: https://128.224.115.15:1081/smo/v1/o2ims_alarm_observer
1466 description: The fully qualified URI to a consumer procedure which can process a Post of the InventoryEventNotification.
1467 consumerSubscriptionId:
1469 example: 3F20D850-AF4F-A84F-FB5A-0AD585410361
1470 description: Identifier for the consumer of events sent due to the Subscription.
1474 description: "Criteria for events which do not need to be reported or will be filtered by the subscription notification service. Therefore, if a filter is not provided then all events are reported."
1475 x-mask: "{alarmSubscriptionId,callback}"
1478 description: When a mask can't be parsed
1480 description: When any error occurs on mask
1482 description: Default error handler
1484 description: notfound handler
1485 BadRequestException:
1486 description: Return a custom message and 400 status code
1488 description: Return a custom message and 404 status code
1490 description: Return a custom message and 405 status code
1491 InternalServerError:
1492 description: Return a custom message and 500 status code
1494 description: Return a custom message and 500 status code