Instruction Manual for CISCO models including: Smart PHY, PHY
Cisco Smart PHY - Cisco
File Info : application/pdf, 168 Pages, 1.87MB
DocumentDocumentREVIEW DRAFT - CISCO CONFIDENTIAL
Cisco Operations Hub and Smart PHY REST API Guide, Release 22.3
First Published: 2022-10-28
Americas Headquarters
Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.com Tel: 408 526-4000
800 553-NETS (6387) Fax: 408 527-0883
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED "AS IS" WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.
All printed copies and duplicate soft copies of this document are considered uncontrolled. See the current online version for the latest version.
Cisco has more than 200 offices worldwide. Addresses and phone numbers are listed on the Cisco website at www.cisco.com/go/offices.
The documentation set for this product strives to use bias-free language. For purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on standards documentation, or language that is used by a referenced third-party product.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: https://www.cisco.com/c/en/us/about/legal/trademarks.html. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1721R)
© 2022 Cisco Systems, Inc. All rights reserved.
Contents
RPD Service Manager APIs
1
Version: 22.1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
/rpdorch/v2/rpd-topology/query-rpd-config-history . . . . . . . . 1
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
/rpdorch/v2/rpd-pairing/set-rpd-pairing . . . . . . . . . . . . . . 1
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
/rpdorch/v2/rpd-pairing/set-latestSD-rpd-pairing . . . . . . . . 1
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
/rpdorch/v2/rpd-pairing/query-rpd-pairing . . . . . . . . . . . . 2
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
/rpdorch/v2/rpd-pairing/query-rpd-name-pairing . . . . . . . . . 2
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
/rpdorch/v2/rpd-pairing/query-rpd-mac-pairing . . . . . . . . . 2
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
/rpdorch/v2/rpd-pairing/delete-rpd-pairing . . . . . . . . . . . . 2
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
/rpdorch/v2/rpd-pairing/clear-rpd-pairing . . . . . . . . . . . . . 2
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
/rpdorch/v2/rpd-compatibility/set-rpd-compatibility . . . . . . . 3
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
/rpdorch/v2/gcp/set-redirect-version . . . . . . . . . . . . . . . . 3
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
/rpdorch/v2/gcp/remove-redirect-version . . . . . . . . . . . . . 3
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
/rpdorch/v2/gcp/query-redirect-version . . . . . . . . . . . . . . 3
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
/rpdorch/v1/system-info/get-rpd-processing-queue . . . . . . . . 4
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
/rpdorch/v1/system-info/get-nso-commit-queue . . . . . . . . . . 4
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
/rpdorch/v1/system-info/delete-nso-commit-queue-item . . . . . 4
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
/rpdorch/v1/service-catalog-topology/set-service-template . . . . 4
i
ii
CONTENTS
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 /rpdorch/v1/service-catalog-topology/query-servicegroup-profiles 5
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 /rpdorch/v1/service-catalog-topology/query-servicedefinition-diff 5
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 /rpdorch/v1/service-catalog-topology/get-service-template . . . . 5
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 /rpdorch/v1/service-catalog-topology/get-service-template-rpds-
assigned-list . . . . . . . . . . . . . . . . . . . . . . . . . . 5 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 /rpdorch/v1/service-catalog-topology/get-service-template-list . 6 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 /rpdorch/v1/service-catalog-topology/get-service-definition . . . 6 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 /rpdorch/v1/service-catalog-topology/delete-service-templates . . 6 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 /rpdorch/v1/service-catalog-topology/delete-service-template . . 6 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 /rpdorch/v1/service-catalog-topology/create-service-templates . 7 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 /rpdorch/v1/rpd-topology/update-rpd-inventory . . . . . . . . . 7 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 /rpdorch/v1/rpd-topology/send-test-gcp-message . . . . . . . . . 7 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 /rpdorch/v1/rpd-topology/refresh-rpd-status . . . . . . . . . . . 7 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 /rpdorch/v1/rpd-topology/query-rpd-topology . . . . . . . . . . 7 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 /rpdorch/v1/rpd-topology/query-rpd-inventory . . . . . . . . . . 8 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 /rpdorch/v1/rpd-topology/query-rpd-details . . . . . . . . . . . 8 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 /rpdorch/v1/rpd-topology/query-corewise-rpd-status . . . . . . . 8 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 /rpdorch/v1/rpd-topology/query-all-rpd-data . . . . . . . . . . . 8 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 /rpdorch/v1/rpd-topology/dump-system-info . . . . . . . . . . . 9 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 /rpdorch/v1/rpd-topology/delete-rpd-inventory . . . . . . . . . . 9 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 /rpdorch/v1/rpd-topology/add-rpd-inventory . . . . . . . . . . . 9 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 /rpdorch/v1/rpd-pairing/set-rpd-pairing . . . . . . . . . . . . . . 9 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 /rpdorch/v1/rpd-pairing/query-servicedefinition-rpdlist . . . . . 9 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
CONTENTS
iii
/rpdorch/v1/rpd-pairing/query-service-definition-rpds . . . . . . 10 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
/rpdorch/v1/rpd-pairing/query-rpds-on-service-definition . . . . 10 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
/rpdorch/v1/rpd-pairing/query-rpds-notinlatestSD . . . . . . . . 10 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
/rpdorch/v1/rpd-pairing/query-rpd-pairing . . . . . . . . . . . . 10 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
/rpdorch/v1/rpd-pairing/query-rpd-name-pairing . . . . . . . . . 11 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
/rpdorch/v1/rpd-pairing/query-rpd-mac-pairing . . . . . . . . . 11 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
/rpdorch/v1/rpd-pairing/delete-rpd-pairing . . . . . . . . . . . . 11 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
/rpdorch/v1/rpd-pairing/clear-rpd-pairing . . . . . . . . . . . . . 11 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
/rpdorch/v1/rpd-compatibility/set-rpd-compatibility . . . . . . . 11 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
/rpdorch/v1/rpd-compatibility/query-rpd-compatibility . . . . . 12 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
/rpdorch/v1/rpd-compatibility/query-rpd-compatibility-list . . . 12 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
/rpdorch/v1/rpd-compatibility/delete-rpd-compatibility . . . . . 12 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
/rpdorch/v1/rfpower-config/set-rfPower-profile . . . . . . . . . . 12 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
/rpdorch/v1/rfpower-config/get-rfPower-profiles . . . . . . . . . . 13 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
/rpdorch/v1/rfpower-config/delete-rfPower-profiles . . . . . . . . 13 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
/rpdorch/v1/resource-manager/test-release-resources . . . . . . . 13 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
/rpdorch/v1/resource-manager/test-insert-resource . . . . . . . . 13 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
/rpdorch/v1/resource-manager/test-delete-resources . . . . . . . 13 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
/rpdorch/v1/resource-manager/test-delete-interface-resources . . 14 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
/rpdorch/v1/resource-manager/test-assign-resources . . . . . . . 14 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
/rpdorch/v1/resource-manager/dump-resource-map . . . . . . . 14 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
/rpdorch/v1/global-config/set-global-config . . . . . . . . . . . . 14 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
/rpdorch/v1/global-config/reset-global-config . . . . . . . . . . . 15 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
iv
CONTENTS
/rpdorch/v1/global-config/query-global-config . . . . . . . . . . . 15 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
/rpdorch/v1/data-service/set-instance-id . . . . . . . . . . . . . . 15 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
/rpdorch/v1/data-service/get-instance-id . . . . . . . . . . . . . 15 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
/rpdorch/v1/data-service/get-db-export-import-status-list . . . . 15 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
/rpdorch/v1/data-service/data-import . . . . . . . . . . . . . . . 16 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
/rpdorch/v1/data-service/data-export . . . . . . . . . . . . . . . 16 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
/rpdorch/v1/dashboard/count . . . . . . . . . . . . . . . . . . . 16 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
/rpdorch/v1/core-topology/query-credentials . . . . . . . . . . . 16 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
/rpdorch/v1/core-topology/query-core-details . . . . . . . . . . . 17 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
/rpdorch/v1/core-topology/query-CoreResourceUsage . . . . . . 17 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
/rpdorch/v1/core-topology/fetch-ssh-key . . . . . . . . . . . . . . 17 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
/rpdorch/v1/core-topology/delete-dpic-inventory . . . . . . . . . 17 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
/rpdorch/v1/core-topology/delete-core-inventory . . . . . . . . . 17 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
/rpdorch/v1/core-topology/add-dpic-inventory . . . . . . . . . . 18 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
/rpdorch/v1/core-topology/add-core-inventory . . . . . . . . . . 18 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
/rpdorch/v1/config-reconciliation/reconciliation-check . . . . . . 18 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
/rpdorch/v1/config-reconciliation/reconcile-from . . . . . . . . . 18 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
/rpdorch/v1/config-reconciliation/perform-reconciliation . . . . . 19 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
/rpdorch/v1/config-reconciliation/get-reconciliation-report . . . . 19 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
/rpdorch/v1/config-reconciliation/get-reconciliation-report-list . 19 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
/rpdorch/v2/rpd-topology/query-rpd-configurations . . . . . . . 19 GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
/rpdorch/v1/rpd-topology/query-rpd-configurations . . . . . . . 20 GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
/rpdorch/v1/rpd-topology/get-service-template-counts . . . . . . 20 GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
CONTENTS
v
/rpdorch/v1/rpd-topology/get-rpd-counts . . . . . . . . . . . . . 20 GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 QueryRpdDetailsInput . . . . . . . . . . . . . . . . . . . . 20 CliData . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 DeviceInfoRest . . . . . . . . . . . . . . . . . . . . . . . . 21 Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 GpsLocationRest . . . . . . . . . . . . . . . . . . . . . . . 22 QueryRpdDetailsOutputV2 . . . . . . . . . . . . . . . . . 22 RpdHistoryNotification . . . . . . . . . . . . . . . . . . . 23 AssignedCores . . . . . . . . . . . . . . . . . . . . . . . . 24 PortConfig . . . . . . . . . . . . . . . . . . . . . . . . . . 24 SetRpdPairing . . . . . . . . . . . . . . . . . . . . . . . . 25 SetRpdPairingInput . . . . . . . . . . . . . . . . . . . . . 25 RpdStatusOutput . . . . . . . . . . . . . . . . . . . . . . 26 SetRpdPairingOutput . . . . . . . . . . . . . . . . . . . . 26 SetLatestSDRpdPairingInput . . . . . . . . . . . . . . . . 26 SetLatestSDRpdPairingOutput . . . . . . . . . . . . . . . 26 QueryRpdPairingInput . . . . . . . . . . . . . . . . . . . 27 QueryRpdPairingOutput . . . . . . . . . . . . . . . . . . 27 RpdPairingOutput . . . . . . . . . . . . . . . . . . . . . . 27 QueryRpdNamePairingInput . . . . . . . . . . . . . . . . 29 QueryRpdNamePairingOutput . . . . . . . . . . . . . . . 29 QueryRpdMacPairingInput . . . . . . . . . . . . . . . . . 29 QueryRpdMacPairingOutput . . . . . . . . . . . . . . . . 29 DeleteRpdPairingInput . . . . . . . . . . . . . . . . . . . 29 DeleteRpdPairingOutput . . . . . . . . . . . . . . . . . . 29 ClearRpdPairingInput . . . . . . . . . . . . . . . . . . . . 30 ClearRpdPairingOutput . . . . . . . . . . . . . . . . . . . 30 RpdRestCompatibilityKey . . . . . . . . . . . . . . . . . . 30 RpdRestCompatibilityV2 . . . . . . . . . . . . . . . . . . 30 SetRpdCompatibilityInputV2 . . . . . . . . . . . . . . . . 31 RpdRestCompatibilityStatus . . . . . . . . . . . . . . . . 31 SetRpdCompatibilityOutput . . . . . . . . . . . . . . . . 31 SetRedirectVersionInput . . . . . . . . . . . . . . . . . . . 31 SetRedirectVersionOutput . . . . . . . . . . . . . . . . . . 31 DeleteRedirectVersionInput . . . . . . . . . . . . . . . . . 32 DeleteRedirectVersionOutput . . . . . . . . . . . . . . . . 32 GcpRedirectRpdDetails . . . . . . . . . . . . . . . . . . . 32 QueryRedirectVersionListOutput . . . . . . . . . . . . . . 32 DumpSystemInfoOutput . . . . . . . . . . . . . . . . . . . 32 ThreadPoolInfo . . . . . . . . . . . . . . . . . . . . . . . . 33 ShowCommitQueueInput . . . . . . . . . . . . . . . . . . 33 QueueItem . . . . . . . . . . . . . . . . . . . . . . . . . . 33 ShowCommitQueueOutput . . . . . . . . . . . . . . . . . 34 DeleteCommitQueueItemInput . . . . . . . . . . . . . . . 34
vi
CONTENTS
AddServiceTemplateInput . . . . . . . . . . . . . . . . . . 34 ServiceElementInput . . . . . . . . . . . . . . . . . . . . . 34 ServiceOobProfile . . . . . . . . . . . . . . . . . . . . . . . 35 AddServiceTemplateOutput . . . . . . . . . . . . . . . . . 35 ServiceGroupProfilesInput . . . . . . . . . . . . . . . . . . 35 ServiceGroupProfilesOutput . . . . . . . . . . . . . . . . . 35 ServiceDefinitionDiffInput . . . . . . . . . . . . . . . . . . 36 ServiceDefinitionDiffOutput . . . . . . . . . . . . . . . . . 36 ServiceElementOutput . . . . . . . . . . . . . . . . . . . . 36 ServiceTemplateOutput . . . . . . . . . . . . . . . . . . . 37 GetServiceTemplateInput . . . . . . . . . . . . . . . . . . 37 GetServiceTemplateOutput . . . . . . . . . . . . . . . . . 37 GetServiceTemplateRpdsAssignedListOutput . . . . . . . 38 ServiceTemplateRpdsAssignedOutput . . . . . . . . . . . 38 GetServiceTemplateListOutput . . . . . . . . . . . . . . . 39 GetServiceDefinitionOutput . . . . . . . . . . . . . . . . . 39 DeleteServiceTemplateListInput . . . . . . . . . . . . . . 39 DeleteServiceTemplateListOutput . . . . . . . . . . . . . 39 DeleteServiceTemplateOutput . . . . . . . . . . . . . . . . 39 DeleteServiceTemplateInput . . . . . . . . . . . . . . . . . 40 AddServiceTemplateListInput . . . . . . . . . . . . . . . . 40 AddServiceTemplateListOutput . . . . . . . . . . . . . . . 40 UpdateRpdInventoryInput . . . . . . . . . . . . . . . . . 40 UpdateRpdInventoryOutput . . . . . . . . . . . . . . . . 40 SendTestGcpMessageInput . . . . . . . . . . . . . . . . . 41 SendTestGcpMessageOutput . . . . . . . . . . . . . . . . 41 RefreshRPDStatusInput . . . . . . . . . . . . . . . . . . . 41 RefreshRPDStatusOutput . . . . . . . . . . . . . . . . . . 41 QueryRpdTopologyInput . . . . . . . . . . . . . . . . . . 42 QueryRpdTopologyOutput . . . . . . . . . . . . . . . . . 42 RpdTopology . . . . . . . . . . . . . . . . . . . . . . . . . 42 GpsRange . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 QueryRpdInventoryInput . . . . . . . . . . . . . . . . . . 43 GpsLocationRange . . . . . . . . . . . . . . . . . . . . . . 44 QueryRpdInventoryOutput . . . . . . . . . . . . . . . . . 44 RpdInventory . . . . . . . . . . . . . . . . . . . . . . . . . 44 QueryRpdDetailsOutput . . . . . . . . . . . . . . . . . . . 45 QueryRpdStateInput . . . . . . . . . . . . . . . . . . . . . 46 CorewiseRpdStates . . . . . . . . . . . . . . . . . . . . . . 46 QueryRpdStateOutput . . . . . . . . . . . . . . . . . . . . 47 RpdCorewiseStateOutput . . . . . . . . . . . . . . . . . . 47 QueryAllRpdDataInput . . . . . . . . . . . . . . . . . . . 47 QueryAllRpdDataOutput . . . . . . . . . . . . . . . . . . 47 RpdData . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 DeleteRpdInventoryInput . . . . . . . . . . . . . . . . . . 49 DeleteRpdInventoryOutput . . . . . . . . . . . . . . . . . 49
CONTENTS
vii
AddRpdInventoryInput . . . . . . . . . . . . . . . . . . . 49 AddRpdInventoryOutput . . . . . . . . . . . . . . . . . . 50 QueryRpdListOnServiceDefinitionInput . . . . . . . . . . 50 QueryRpdListOnServiceDefinitionOutput . . . . . . . . . 50 RpdDetails . . . . . . . . . . . . . . . . . . . . . . . . . . 50 RpdServiceDefinition . . . . . . . . . . . . . . . . . . . . . 51 SdVersionCount . . . . . . . . . . . . . . . . . . . . . . . 51 GetServiceTemplateInputList . . . . . . . . . . . . . . . . 51 QueryRpdServiceDefinition . . . . . . . . . . . . . . . . . 51 QueryRpdOnServiceDefinitionInput . . . . . . . . . . . . 52 QueryRpdOnServiceDefinition . . . . . . . . . . . . . . . 52 QueryRpdsNotonLatestSDInput . . . . . . . . . . . . . . 52 QueryRpdsNotonLatestSDOutput . . . . . . . . . . . . . 52 RpdRestCompatibility . . . . . . . . . . . . . . . . . . . . 53 SetRpdCompatibilityInput . . . . . . . . . . . . . . . . . 53 QueryRpdCompatibilityInput . . . . . . . . . . . . . . . . 53 QueryRpdCompatibilityOutput . . . . . . . . . . . . . . . 53 QueryRpdCompatibilityListInput . . . . . . . . . . . . . . 53 QueryRpdCompatibilityListOutput . . . . . . . . . . . . . 53 DeleteRpdCompatibilityInput . . . . . . . . . . . . . . . . 54 DeleteRpdCompatibilityOutput . . . . . . . . . . . . . . . 54 RFPowerConfigInput . . . . . . . . . . . . . . . . . . . . . 54 RFPowerConfigOutput . . . . . . . . . . . . . . . . . . . . 54 QueryRFPowerConfigInput . . . . . . . . . . . . . . . . . 54 GetRFPowerConfigOutput . . . . . . . . . . . . . . . . . 55 DeleteRfPowerConfigInput . . . . . . . . . . . . . . . . . 55 DeleteRfPowerConfigOutput . . . . . . . . . . . . . . . . 55 DeleteRfPowerConfigOutputList . . . . . . . . . . . . . . 55 TestReleaseResourcesInput . . . . . . . . . . . . . . . . . 55 TestInsertResourcesInput . . . . . . . . . . . . . . . . . . 56 TestDeleteResourcesInput . . . . . . . . . . . . . . . . . . 56 TestDeleteInterfaceResourcesInput . . . . . . . . . . . . . 56 TestAssignResourcesToRpdInput . . . . . . . . . . . . . . 56 DumpResourceMapOutput . . . . . . . . . . . . . . . . . 56 SetGlobalConfigInput . . . . . . . . . . . . . . . . . . . . 56 SetGlobalConfigOutput . . . . . . . . . . . . . . . . . . . 57 ResetGlobalConfigInput . . . . . . . . . . . . . . . . . . . 57 ResetGlobalConfigOutput . . . . . . . . . . . . . . . . . . 57 QueryGlobalConfigInput . . . . . . . . . . . . . . . . . . . 57 ConfigRecord . . . . . . . . . . . . . . . . . . . . . . . . . 57 QueryGlobalConfigOutput . . . . . . . . . . . . . . . . . . 58 SetInstanceIdInput . . . . . . . . . . . . . . . . . . . . . . 58 SetInstanceIdOutput . . . . . . . . . . . . . . . . . . . . . 58 GetInstanceIdInput . . . . . . . . . . . . . . . . . . . . . 58 GetInstanceIdOutput . . . . . . . . . . . . . . . . . . . . 58 DbExportImportStatus . . . . . . . . . . . . . . . . . . . 59
viii
CONTENTS
GetDbExportImportStatusOutput . . . . . . . . . . . . . 59 DataImportInput . . . . . . . . . . . . . . . . . . . . . . . 59 DataImportOutput . . . . . . . . . . . . . . . . . . . . . . 60 DataExportInput . . . . . . . . . . . . . . . . . . . . . . . 60 DataExportOutput . . . . . . . . . . . . . . . . . . . . . . 60 CountOutput . . . . . . . . . . . . . . . . . . . . . . . . . 60 QueryCredentialsInput . . . . . . . . . . . . . . . . . . . . 61 QueryCredentialsOutput . . . . . . . . . . . . . . . . . . . 61 QueryCoreDetailsInput . . . . . . . . . . . . . . . . . . . 61 CoreDetails . . . . . . . . . . . . . . . . . . . . . . . . . . 62 DpicInterface . . . . . . . . . . . . . . . . . . . . . . . . . 62 IpMask . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 OOBProfiles . . . . . . . . . . . . . . . . . . . . . . . . . 63 QueryCoreDetailsOutput . . . . . . . . . . . . . . . . . . 63 SsdProfile . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 VirtualSG . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 QueryCoreResourceUsageInput . . . . . . . . . . . . . . . 63 QueryCoreResourceUsageOutput . . . . . . . . . . . . . . 64 FetchSshKeyInput . . . . . . . . . . . . . . . . . . . . . . 64 FetchSshKeyOutput . . . . . . . . . . . . . . . . . . . . . 64 DeleteDpicInventoryInput . . . . . . . . . . . . . . . . . . 64 DeleteDpicInventoryOutput . . . . . . . . . . . . . . . . . 65 DeleteCoreInventoryInput . . . . . . . . . . . . . . . . . . 65 DeleteCoreInventoryOutput . . . . . . . . . . . . . . . . . 65 AddDpicInventoryInput . . . . . . . . . . . . . . . . . . . 65 AddDpicInventoryOutput . . . . . . . . . . . . . . . . . . 65 AddCoreInventoryInput . . . . . . . . . . . . . . . . . . . 66 AddCoreInventoryOutput . . . . . . . . . . . . . . . . . . 66 CoreKeyInput . . . . . . . . . . . . . . . . . . . . . . . . 66 CoreReconciliationOutput . . . . . . . . . . . . . . . . . . 66 CoreReconciliationInput . . . . . . . . . . . . . . . . . . . 66 ReconciliationReportParams . . . . . . . . . . . . . . . . 67 ConfigDiff . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 ReconciliationReport . . . . . . . . . . . . . . . . . . . . . 67 ReconciliationReportKey . . . . . . . . . . . . . . . . . . 67 ReconciliationMeta . . . . . . . . . . . . . . . . . . . . . . 68 CoreConfigurationDetailsV2 . . . . . . . . . . . . . . . . . 68 DeviceInfoDetails . . . . . . . . . . . . . . . . . . . . . . . 68 GpsLocation . . . . . . . . . . . . . . . . . . . . . . . . . 68 RpdConfigurationDetailsV2 . . . . . . . . . . . . . . . . . 68 ServiceDetailsV2 . . . . . . . . . . . . . . . . . . . . . . . 69 CoreConfigurationDetails . . . . . . . . . . . . . . . . . . 70 RpdConfigurationDetails . . . . . . . . . . . . . . . . . . 70 RpdConfigurationDetailsListOutput . . . . . . . . . . . . 71 ServiceDetails . . . . . . . . . . . . . . . . . . . . . . . . . 71 RpdCount . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
CONTENTS
ix
Inventory Manager APIs
73
Version: 22.1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
/inventory/v2/credential/query-credential-profile . . . . . . . . . 73
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
/inventory/v2/credential/delete-credential-profile . . . . . . . . . 73
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
/inventory/v1/instance/set-instance-id . . . . . . . . . . . . . . . 73
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
/inventory/v1/instance/get-instance-id . . . . . . . . . . . . . . . 74
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
/inventory/v1/device/update-device-inventory . . . . . . . . . . . 74
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
/inventory/v1/device/update-device-inventory-list . . . . . . . . 74
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
/inventory/v1/device/update-ccap-core-state . . . . . . . . . . . 74
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
/inventory/v1/device/query-device-list . . . . . . . . . . . . . . . 74
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
/inventory/v1/device/delete-device-inventory . . . . . . . . . . . 75
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
/inventory/v1/device/add-device-inventory . . . . . . . . . . . . 75
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
/inventory/v1/device/add-device-inventory-list . . . . . . . . . . 75
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
/inventory/v1/credential/set-credential-profile . . . . . . . . . . . 75
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
/inventory/v1/credential/query-credential-profile . . . . . . . . . 76
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
/inventory/v1/credential/delete-credential-profile . . . . . . . . . 76
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
/api/config/smiuser/_operations/change-password . . . . . . . . 76
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
/inventory/v2/credential/get-inventory-counts . . . . . . . . . . . 76
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
QueryCredentialProfileInput . . . . . . . . . . . . . . . . 76
CredentialProfileOutputV2 . . . . . . . . . . . . . . . . . 77
Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
QueryCredentialProfileOutputV2 . . . . . . . . . . . . . . 78
Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
DeleteCredProfileListInput . . . . . . . . . . . . . . . . . 78
DeleteCredentialProfileInput . . . . . . . . . . . . . . . . 78
DeleteCredProfileListOutput . . . . . . . . . . . . . . . . 78
DeleteCredentialProfileOutput . . . . . . . . . . . . . . . 79
SetInstanceIdInput . . . . . . . . . . . . . . . . . . . . . . 79
SetInstanceIdOutput . . . . . . . . . . . . . . . . . . . . . 79
x
CONTENTS
GetInstanceIdInput . . . . . . . . . . . . . . . . . . . . . 79 GetInstanceIdOutput . . . . . . . . . . . . . . . . . . . . 79 GpsLocation . . . . . . . . . . . . . . . . . . . . . . . . . 80 UpdateDeviceInventoryInput . . . . . . . . . . . . . . . . 80 UpdateDeviceInventoryOutput . . . . . . . . . . . . . . . 80 UpdateDeviceInventoryListInput . . . . . . . . . . . . . . 80 UpdateDeviceInventoryListOutput . . . . . . . . . . . . . 81 MaintainCCAPCoreInput . . . . . . . . . . . . . . . . . . 81 DeviceStatusOutput . . . . . . . . . . . . . . . . . . . . . 81 MaintainCCAPCoreOutput . . . . . . . . . . . . . . . . . 81 QueryDeviceListInput . . . . . . . . . . . . . . . . . . . . 82 DeviceDetails . . . . . . . . . . . . . . . . . . . . . . . . . 82 DeviceHistoryNotification . . . . . . . . . . . . . . . . . . 83 DeviceInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 QueryDeviceListOutput . . . . . . . . . . . . . . . . . . . 85 TagDetails . . . . . . . . . . . . . . . . . . . . . . . . . . 85 DeleteDeviceInventoryInput . . . . . . . . . . . . . . . . . 85 DeleteDeviceInventoryOutput . . . . . . . . . . . . . . . . 85 AddDeviceInventoryInput . . . . . . . . . . . . . . . . . . 85 AddDeviceInventoryOutput . . . . . . . . . . . . . . . . . 86 AddDeviceInventoryListInput . . . . . . . . . . . . . . . . 86 AddDeviceInventoryListOutput . . . . . . . . . . . . . . . 86 SetCredentialProfileInput . . . . . . . . . . . . . . . . . . 86 SetCredentialProfileOutput . . . . . . . . . . . . . . . . . 87 CredentialProfileOutput . . . . . . . . . . . . . . . . . . . 87 QueryCredentialProfileOutput . . . . . . . . . . . . . . . 87 UserResetPasswordInput . . . . . . . . . . . . . . . . . . 88 InventoryCount . . . . . . . . . . . . . . . . . . . . . . . . 88
Operations Hub Authentication API
89
Version: 1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
/loglevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
PUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
/reset-internal-user . . . . . . . . . . . . . . . . . . . . . . . . . . 90
PATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
/v1/login/banner . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
PATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
/v1/token . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
DELETE . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
/v1/token/fresh . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
/v1/token/validation . . . . . . . . . . . . . . . . . . . . . . . . . 93
CONTENTS
xi
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
auth.Content . . . . . . . . . . . . . . . . . . . . . . . . . 94 auth.ErrorResponse . . . . . . . . . . . . . . . . . . . . . 94 auth.LogLevel . . . . . . . . . . . . . . . . . . . . . . . . . 94 auth.LoginBanner . . . . . . . . . . . . . . . . . . . . . . 94 structs.ResetPasswordRequestObj . . . . . . . . . . . . . 94 structs.TokenGenInfo . . . . . . . . . . . . . . . . . . . . 95 structs.TokenRefreshReqInfo . . . . . . . . . . . . . . . . 95
Operations Hub RBAC API
97
Version: 1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
/v1/iam/user/action . . . . . . . . . . . . . . . . . . . . . . . . . 97
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
/v1/identitymgmt/exportldap . . . . . . . . . . . . . . . . . . . . 98
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
/v1/identitymgmt/exportum . . . . . . . . . . . . . . . . . . . . 98
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
/v1/identitymgmt/group . . . . . . . . . . . . . . . . . . . . . . . 98
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
/v1/identitymgmt/importldap . . . . . . . . . . . . . . . . . . . . 99
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
/v1/identitymgmt/importum . . . . . . . . . . . . . . . . . . . . 99
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
/v1/identitymgmt/ldap/config . . . . . . . . . . . . . . . . . . . 100
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
PUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
DELETE . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
PATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
/v1/identitymgmt/ldap/validate/current-config . . . . . . . . . . 102
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
/v1/identitymgmt/ldap/validate/new-config . . . . . . . . . . . . 103
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
/v1/identitymgmt/loglevel . . . . . . . . . . . . . . . . . . . . . . 103
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
/v1/identitymgmt/password-age . . . . . . . . . . . . . . . . . . 104
PATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
/v1/identitymgmt/password-length . . . . . . . . . . . . . . . . . 104
PATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
/v1/identitymgmt/reset-password . . . . . . . . . . . . . . . . . . 105
PATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
/v1/identitymgmt/self-password . . . . . . . . . . . . . . . . . . 105
PATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
/v1/identitymgmt/user . . . . . . . . . . . . . . . . . . . . . . . 106
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
xii
CONTENTS
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 /v1/identitymgmt/user-group . . . . . . . . . . . . . . . . . . . . 107
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 PATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 /v1/identitymgmt/user/{username} . . . . . . . . . . . . . . . . 108 GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 DELETE . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 /v1/identitymgmt/user/{username}/namespace/{namespace} . . 109 GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 model.ChangePasswordLengthRequest . . . . . . . . . . . 109 model.ChangeSelfPasswordRequest . . . . . . . . . . . . . 109 model.CreateUserRequest . . . . . . . . . . . . . . . . . . 110 model.CurrentSecurityConfig . . . . . . . . . . . . . . . . 110 model.ElasticSearchRequest . . . . . . . . . . . . . . . . . 110 model.ElasticSearchResponse . . . . . . . . . . . . . . . . 110 model.GenericMapResponse . . . . . . . . . . . . . . . . . 111 model.GenericResponse . . . . . . . . . . . . . . . . . . . 111 model.GroupListResponse . . . . . . . . . . . . . . . . . . 111 model.LdapConfigObject . . . . . . . . . . . . . . . . . . 111 model.LdapDeleteConfigRequest . . . . . . . . . . . . . . 111 model.LdapGroupMappingObject . . . . . . . . . . . . . . 112 model.LogLevelRequest . . . . . . . . . . . . . . . . . . . 112 model.NewSecurityConfig . . . . . . . . . . . . . . . . . . 112 model.PasswordAgeRequest . . . . . . . . . . . . . . . . . 112 model.ResetPasswordRequest . . . . . . . . . . . . . . . . 112 model.UMExportResponse . . . . . . . . . . . . . . . . . 113 model.UserDetailListResponse . . . . . . . . . . . . . . . 113 model.UserDetailResponse . . . . . . . . . . . . . . . . . . 113 model.UserDetails . . . . . . . . . . . . . . . . . . . . . . 113 model.UserGroupRequest . . . . . . . . . . . . . . . . . . 113
Operations Hub Tag Management API
115
Version: 1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
/v1/tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
/v1/tags/create-assign-tags . . . . . . . . . . . . . . . . . . . . . 115
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
/v1/tags/delete-tag/{tag-name} . . . . . . . . . . . . . . . . . . 116
DELETE . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
/v1/tags/entity-instance . . . . . . . . . . . . . . . . . . . . . . . 117
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
/v1/tags/export . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
/v1/tags/import . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
CONTENTS
xiii
/v1/tags/remove-tag-association . . . . . . . . . . . . . . . . . . 118 POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
/v1/tags/search/{tag-name} . . . . . . . . . . . . . . . . . . . . 119 GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
/v1/tags/{entity} . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 tag.ApiResponse . . . . . . . . . . . . . . . . . . . . . . . 121 tag.ApplicationError . . . . . . . . . . . . . . . . . . . . . 121 tag.EntityTag . . . . . . . . . . . . . . . . . . . . . . . . . 121 tag.EntityTagDetails . . . . . . . . . . . . . . . . . . . . . 122 tag.EntityTagUuid . . . . . . . . . . . . . . . . . . . . . . 122 tag.EntityUuid . . . . . . . . . . . . . . . . . . . . . . . . 122 tag.EntityUuidTag . . . . . . . . . . . . . . . . . . . . . . 122 tag.ExportTagData . . . . . . . . . . . . . . . . . . . . . . 122 tag.GetTagsForEntityResponse . . . . . . . . . . . . . . . 123 tag.TagBasicDetails . . . . . . . . . . . . . . . . . . . . . 123 tag.TagResponse . . . . . . . . . . . . . . . . . . . . . . . 123 tag.TagsWithUid . . . . . . . . . . . . . . . . . . . . . . . 123 tag.UuidTag . . . . . . . . . . . . . . . . . . . . . . . . . 123
Operations Hub Infra Alert Management API
125
Version: 1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
/v1/alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
/v1/alerts/groups . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
/v1/alerts/groups/{name} . . . . . . . . . . . . . . . . . . . . . . 126
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
PUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
/v1/alerts/{id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
/v1/alerts/{id}/ack . . . . . . . . . . . . . . . . . . . . . . . . . 128
PUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
/v1/cluster/health . . . . . . . . . . . . . . . . . . . . . . . . . . 128
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
/v1/loglevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
PUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
/v1/smtp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
PUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
model.AlertConfigGetInfo . . . . . . . . . . . . . . . . . . 131
model.AlertConfigSetInfo . . . . . . . . . . . . . . . . . . 131
xiv
CONTENTS
model.AlertGetEntry . . . . . . . . . . . . . . . . . . . . . 131 model.AlertGetInfo . . . . . . . . . . . . . . . . . . . . . . 132 model.AlertGroupGetInfo . . . . . . . . . . . . . . . . . . 132 model.AlertGroupSetInfo . . . . . . . . . . . . . . . . . . 132 model.AlertSetInfo . . . . . . . . . . . . . . . . . . . . . . 132 model.HealthStatus . . . . . . . . . . . . . . . . . . . . . 133 model.LogLevel . . . . . . . . . . . . . . . . . . . . . . . . 133 model.NotReadyPods . . . . . . . . . . . . . . . . . . . . 133
Operations Hub Configuration Backup and Restore
135
Version: 1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
/v1/config/export . . . . . . . . . . . . . . . . . . . . . . . . . . 135
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
/v1/config/import . . . . . . . . . . . . . . . . . . . . . . . . . . 136
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
/v1/config/operation/status . . . . . . . . . . . . . . . . . . . . . 136
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
/v1/tac/create . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
/v1/tac/delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
DELETE . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
/v1/tac/download . . . . . . . . . . . . . . . . . . . . . . . . . . 138
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
/v1/tac/list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
/v1/tac/status . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
model.ApiResponse . . . . . . . . . . . . . . . . . . . . . . 139
model.ErrorResponse . . . . . . . . . . . . . . . . . . . . . 139
model.ListTac . . . . . . . . . . . . . . . . . . . . . . . . . 140
model.OperationStatusResponse . . . . . . . . . . . . . . 140
model.StatusResponse . . . . . . . . . . . . . . . . . . . . 140
model.StatusTac . . . . . . . . . . . . . . . . . . . . . . . 140
model.StringResponse . . . . . . . . . . . . . . . . . . . . 140
model.Tac . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Operations Hub Scheduler
141
Version: 1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
/v1/scheduler/create . . . . . . . . . . . . . . . . . . . . . . . . . 141
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
/v1/scheduler/delete . . . . . . . . . . . . . . . . . . . . . . . . . 141
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
/v1/scheduler/suspend . . . . . . . . . . . . . . . . . . . . . . . . 142
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
/v1/scheduler/task/status . . . . . . . . . . . . . . . . . . . . . . 142
CONTENTS
xv
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 /v1/scheduler/tasks . . . . . . . . . . . . . . . . . . . . . . . . . 143
GET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 /v1/scheduler/update . . . . . . . . . . . . . . . . . . . . . . . . 143
POST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
model.APITaskConfig . . . . . . . . . . . . . . . . . . . . 144 model.ApiResponse . . . . . . . . . . . . . . . . . . . . . . 144 model.CronSchedule . . . . . . . . . . . . . . . . . . . . . 145 model.CyclicalSchedule . . . . . . . . . . . . . . . . . . . 145 model.DiscreteTimeSchedule . . . . . . . . . . . . . . . . 145 model.HeaderMap . . . . . . . . . . . . . . . . . . . . . . 145 model.ListScheduleConfig . . . . . . . . . . . . . . . . . . 145 model.MessageTaskConfig . . . . . . . . . . . . . . . . . . 145 model.Schedule . . . . . . . . . . . . . . . . . . . . . . . . 146 model.ScheduleConfig . . . . . . . . . . . . . . . . . . . . 146 model.ScheduleDbConfig . . . . . . . . . . . . . . . . . . . 146 model.ScheduleTaskDbConfig . . . . . . . . . . . . . . . . 147 model.StringErrResponse . . . . . . . . . . . . . . . . . . 147 model.TaskCommonConfig . . . . . . . . . . . . . . . . . 147 model.TaskConfig . . . . . . . . . . . . . . . . . . . . . . 147 model.TaskDbConfig . . . . . . . . . . . . . . . . . . . . . 147 model.TaskExecutionDbStatus . . . . . . . . . . . . . . . 148 model.TaskExecutionStatus . . . . . . . . . . . . . . . . . 148 model.TaskExecutionStatusAll . . . . . . . . . . . . . . . 148 model.TaskList . . . . . . . . . . . . . . . . . . . . . . . . 148 model.UpdateScheduleConfig . . . . . . . . . . . . . . . . 148 model.UpdateTaskConfig . . . . . . . . . . . . . . . . . . 149
xvi
CONTENTS
RPD Service Manager APIs
Version: 22.1.0
License: Cisco Systems, Inc.
/rpdorch/v2/rpd-topology/query-rpd-config-history
POST Responses
Code Description 200 OK
/rpdorch/v2/rpd-pairing/set-rpd-pairing
POST Responses
Code Description 200 OK
/rpdorch/v2/rpd-pairing/set-latestSD-rpd-pairing
POST Responses
Code Description 200 OK
1
2
RPD SERVICE MANAGER APIS
/rpdorch/v2/rpd-pairing/query-rpd-pairing
POST Responses
Code Description 200 OK
/rpdorch/v2/rpd-pairing/query-rpd-name-pairing
POST Responses
Code Description 200 OK
/rpdorch/v2/rpd-pairing/query-rpd-mac-pairing
POST Responses
Code Description 200 OK
/rpdorch/v2/rpd-pairing/delete-rpd-pairing
POST Responses
Code Description 200 OK
/rpdorch/v2/rpd-pairing/clear-rpd-pairing
POST Responses
VERSION: 22.1.0
3
Code Description 200 OK
/rpdorch/v2/rpd-compatibility/set-rpd-compatibility
POST Responses
Code Description 200 OK
/rpdorch/v2/gcp/set-redirect-version
POST Responses
Code Description 200 OK
/rpdorch/v2/gcp/remove-redirect-version
POST Responses
Code Description 200 OK
/rpdorch/v2/gcp/query-redirect-version
POST Responses
Code Description 200 OK
4
RPD SERVICE MANAGER APIS
/rpdorch/v1/system-info/get-rpd-processing-queue
POST Responses
Code Description 200 OK
/rpdorch/v1/system-info/get-nso-commit-queue
POST Responses
Code Description 200 OK
/rpdorch/v1/system-info/delete-nso-commit-queue-item
POST Responses
Code Description 200 OK
/rpdorch/v1/service-catalog-topology/set-service-template
POST Parameters
Name
Located in Description Required Schema
X-JWT-ACCESS-TOKEN cookie
No
string
Responses
Code Description 200 OK
VERSION: 22.1.0
5
/rpdorch/v1/service-catalog-topology/query-servicegroupprofiles
POST
Responses
Code Description 200 OK
/rpdorch/v1/service-catalog-topology/query-servicedefinitiondiff
POST Responses
Code Description 200 OK
/rpdorch/v1/service-catalog-topology/get-service-template
POST Responses
Code Description 200 OK
/rpdorch/v1/service-catalog-topology/get-service-templaterpds-assigned-list
POST Responses
Code Description 200 OK
6
RPD SERVICE MANAGER APIS
/rpdorch/v1/service-catalog-topology/get-service-templatelist
POST
Responses
Code Description 200 OK
/rpdorch/v1/service-catalog-topology/get-service-definition
POST Responses
Code Description 200 OK
/rpdorch/v1/service-catalog-topology/delete-servicetemplates
POST Responses
Code Description 200 OK
/rpdorch/v1/service-catalog-topology/delete-servicetemplate
POST Responses
Code Description 200 OK
VERSION: 22.1.0
7
/rpdorch/v1/service-catalog-topology/create-servicetemplates
POST
Responses
Code Description 200 OK
/rpdorch/v1/rpd-topology/update-rpd-inventory
POST Responses
Code Description 200 OK
/rpdorch/v1/rpd-topology/send-test-gcp-message
POST Responses
Code Description 200 OK
/rpdorch/v1/rpd-topology/refresh-rpd-status
POST Responses
Code Description 200 OK
/rpdorch/v1/rpd-topology/query-rpd-topology
POST Responses
8
RPD SERVICE MANAGER APIS
Code Description 200 OK
/rpdorch/v1/rpd-topology/query-rpd-inventory
POST Responses
Code Description 200 OK
/rpdorch/v1/rpd-topology/query-rpd-details
POST Responses
Code Description 200 OK
/rpdorch/v1/rpd-topology/query-corewise-rpd-status
POST Responses
Code Description 200 OK
/rpdorch/v1/rpd-topology/query-all-rpd-data
POST Responses
Code Description 200 OK
VERSION: 22.1.0
9
/rpdorch/v1/rpd-topology/dump-system-info
POST Responses
Code Description 200 OK
/rpdorch/v1/rpd-topology/delete-rpd-inventory
POST Responses
Code Description 200 OK
/rpdorch/v1/rpd-topology/add-rpd-inventory
POST Responses
Code Description 200 OK
/rpdorch/v1/rpd-pairing/set-rpd-pairing
POST Responses
Code Description 200 OK
/rpdorch/v1/rpd-pairing/query-servicedefinition-rpdlist
POST Responses
10
RPD SERVICE MANAGER APIS
Code Description 200 OK
/rpdorch/v1/rpd-pairing/query-service-definition-rpds
POST Responses
Code Description 200 OK
/rpdorch/v1/rpd-pairing/query-rpds-on-service-definition
POST Responses
Code Description 200 OK
/rpdorch/v1/rpd-pairing/query-rpds-notinlatestSD
POST Responses
Code Description 200 OK
/rpdorch/v1/rpd-pairing/query-rpd-pairing
POST Responses
Code Description 200 OK
VERSION: 22.1.0
11
/rpdorch/v1/rpd-pairing/query-rpd-name-pairing
POST Responses
Code Description 200 OK
/rpdorch/v1/rpd-pairing/query-rpd-mac-pairing
POST Responses
Code Description 200 OK
/rpdorch/v1/rpd-pairing/delete-rpd-pairing
POST Responses
Code Description 200 OK
/rpdorch/v1/rpd-pairing/clear-rpd-pairing
POST Responses
Code Description 200 OK
/rpdorch/v1/rpd-compatibility/set-rpd-compatibility
POST Responses
12
RPD SERVICE MANAGER APIS
Code Description 200 OK
/rpdorch/v1/rpd-compatibility/query-rpd-compatibility
POST Responses
Code Description 200 OK
/rpdorch/v1/rpd-compatibility/query-rpd-compatibilitylist
POST Responses
Code Description 200 OK
/rpdorch/v1/rpd-compatibility/delete-rpd-compatibility
POST Responses
Code Description 200 OK
/rpdorch/v1/rfpower-config/set-rfPower-profile
POST Responses
Code Description 200 OK
VERSION: 22.1.0
13
/rpdorch/v1/rfpower-config/get-rfPower-profiles
POST Responses
Code Description 200 OK
/rpdorch/v1/rfpower-config/delete-rfPower-profiles
POST Responses
Code Description 200 OK
/rpdorch/v1/resource-manager/test-release-resources
POST Responses
Code Description 200 OK
/rpdorch/v1/resource-manager/test-insert-resource
POST Responses
Code Description 200 OK
/rpdorch/v1/resource-manager/test-delete-resources
POST Responses
14
RPD SERVICE MANAGER APIS
Code Description 200 OK
/rpdorch/v1/resource-manager/test-delete-interfaceresources
POST Responses
Code Description 200 OK
/rpdorch/v1/resource-manager/test-assign-resources
POST Responses
Code Description 200 OK
/rpdorch/v1/resource-manager/dump-resource-map
POST Responses
Code Description 200 OK
/rpdorch/v1/global-config/set-global-config
POST Responses
Code Description 200 OK
VERSION: 22.1.0
15
/rpdorch/v1/global-config/reset-global-config
POST Responses
Code Description 200 OK
/rpdorch/v1/global-config/query-global-config
POST Responses
Code Description 200 OK
/rpdorch/v1/data-service/set-instance-id
POST Responses
Code Description 200 OK
/rpdorch/v1/data-service/get-instance-id
POST Responses
Code Description 200 OK
/rpdorch/v1/data-service/get-db-export-import-statuslist
POST
Responses
16
RPD SERVICE MANAGER APIS
Code Description 200 OK
/rpdorch/v1/data-service/data-import
POST Responses
Code Description 200 OK
/rpdorch/v1/data-service/data-export
POST Responses
Code Description 200 OK
/rpdorch/v1/dashboard/count
POST Responses
Code Description 200 OK
/rpdorch/v1/core-topology/query-credentials
POST Responses
Code Description 200 OK
VERSION: 22.1.0
17
/rpdorch/v1/core-topology/query-core-details
POST Responses
Code Description 200 OK
/rpdorch/v1/core-topology/query-CoreResourceUsage
POST Responses
Code Description 200 OK
/rpdorch/v1/core-topology/fetch-ssh-key
POST Responses
Code Description 200 OK
/rpdorch/v1/core-topology/delete-dpic-inventory
POST Responses
Code Description 200 OK
/rpdorch/v1/core-topology/delete-core-inventory
POST Responses
18
RPD SERVICE MANAGER APIS
Code Description 200 OK
/rpdorch/v1/core-topology/add-dpic-inventory
POST Responses
Code Description 200 OK
/rpdorch/v1/core-topology/add-core-inventory
POST Responses
Code Description 200 OK
/rpdorch/v1/config-reconciliation/reconciliation-check
POST Responses
Code Description 200 OK
/rpdorch/v1/config-reconciliation/reconcile-from
POST Responses
Code Description 200 OK
VERSION: 22.1.0
19
/rpdorch/v1/config-reconciliation/perform-reconciliation
POST Responses
Code Description 200 OK
/rpdorch/v1/config-reconciliation/get-reconciliationreport
POST Responses
Code Description 200 OK
/rpdorch/v1/config-reconciliation/get-reconciliationreport-list
POST Responses
Code Description 200 OK
/rpdorch/v2/rpd-topology/query-rpd-configurations
GET Parameters
Name Located in Description Required Schema
rpdMac query
Yes
string
Responses
20
RPD SERVICE MANAGER APIS
Code Description 200 OK
/rpdorch/v1/rpd-topology/query-rpd-configurations
GET Parameters
Name Located in Description Required Schema
rpdMac query
Yes
[ string ]
Responses
Code Description 200 OK
/rpdorch/v1/rpd-topology/get-service-template-counts
GET Responses
Code Description 200 OK
/rpdorch/v1/rpd-topology/get-rpd-counts
GET Responses
Code Description 200 OK
Models
QueryRpdDetailsInput
VERSION: 22.1.0
21
Name
macAddress name
Type
string string
Description
Required
No No
CliData
Name
description ipAddress modifiedDate configuraion
Type
string string string string
Description
Required
No No No No
DeviceInfoRest
Name
serialNumber hwVersion swVersion bootRomVersion modelNumber vendorName
Type
string string string string string string
Description
Required
No No No No No No
Error
Name
Type
errorType string
Description Enum: "User", "System"
Required No
22
Name
Type
errorCode string
errorMessage string errorTag string
RPD SERVICE MANAGER APIS
Description
Required
Enum: "InputInvalid",
No
"InputMismatch",
"InputDuplicate",
"InputMissing",
"RecordExists",
"RecordNotFound",
"DataStoreConnectivityError",
"DataStoreError",
"DataNotFound",
"InternalError",
"OperationNotAllowed",
"ResourceReleaseError",
"ConfigurationError",
"DeviceCommunicationError",
"CoreNotOnline",
"SshKeyFetchFailed",
"InvalidCoreState"
No
No
GpsLocationRest
Name
latitude longitude genericLocation
Type
number number string
Description
Required
No No No
QueryRpdDetailsOutputV2
Name status
Type string
error
object
macAddress string
uuid
string
ipAddress object
name
string
description string
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No No No No No
VERSION: 22.1.0
23
Name state
Type string
type
string
gpsLocation object
deviceInfo object
stateChangeTdimateesTtaimmep
rpdHistory [ object ]
cli
[ object ]
Description
Required
Enum: "Defined",
No
"Inventory", "Installed",
"GcpUp",
"RouterVersionIncompatible",
"ConfigNotFound",
"ConfigurationError",
"ConfigReadError",
"ResourceAllocationError",
"ConfigPushError",
"NotProvisioned",
"Configured",
"Reconciled",
"StaticRouteNotConfigured",
"CableDsgNotConfigured",
"GcpRedirectStarted",
"GcpRedirectStartedWithException",
"GcpRedirected",
"GcpRedirectedWithException",
"GcpRedirectError",
"Online",
"PartialOnline",
"DeletePending",
"Offline",
"OnlineWithException"
No
No
No
No
No
No
RpdHistoryNotification
Name
Type
Description
stateChangeTdimateesTtaimmep
Required No
24
Name state
Type string
stateDetails string correctiveActisotnring
RPD SERVICE MANAGER APIS
Description
Required
Enum: "Defined",
No
"Inventory", "Installed",
"GcpUp",
"RouterVersionIncompatible",
"ConfigNotFound",
"ConfigurationError",
"ConfigReadError",
"ResourceAllocationError",
"ConfigPushError",
"NotProvisioned",
"Configured",
"Reconciled",
"StaticRouteNotConfigured",
"CableDsgNotConfigured",
"GcpRedirectStarted",
"GcpRedirectStartedWithException",
"GcpRedirected",
"GcpRedirectedWithException",
"GcpRedirectError",
"Online",
"PartialOnline",
"DeletePending",
"Offline",
"OnlineWithException"
No
No
AssignedCores
Name
Type
serviceType string
mgmtCore string rpdConnectiosntIrnitnegrface
Description
Enum: "DATA", "VIDEO", "MULTICASTVIDEO", "OOB"
Required No
No No
PortConfig
Name dsPort basePower tiltPivotFreq
Type
integer float integer
Description
Required
No No No
VERSION: 22.1.0
25
Name
tiltSlope usPort dsServiceGroup usServiceGroup videoServiceGroups videoInterfaces usPortDescription rfpowerProfiles
Type
float integer string string [ string ] [ string ] string [ string ]
Description
Required
No No No No No No No No
SetRpdPairing
Name
Type
Description
macAddress string
name
string
type
string
description string
gpsLocation object
previousNamestring
serviceTemplasttering
approvalStatestring
Enum: "Pending",
"Approved"
nodeSegmentastiroing
Enum: "RPD_1x1",
"RPD_1x2", "RPD_2x2"
shelf
boolean
controllerAligbnomoelneat n
dsgTgList [ integer ]
assignedCores[ object ]
portConfigs [ object ]
downstreamVoinmteIdger
downstreamVolomnPg rofile
upstreamVarpidnItdeger
upstreamVarpldoPngrofile
secondUpstrealomnVgarpdProfile
additionalCor[estring ]
preConfigure boolean
ssdProfileId integer
disableNetworbkoDoelelaayn
Required
No No No No No No No No
No
No No No No No No No No No No No No No No
SetRpdPairingInput
26
RPD SERVICE MANAGER APIS
Name
Type
Description Required
setRpdPairingList [ object ]
No
RpdStatusOutput
Name status
Type string
error
object
macAddress string
name
string
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No No
SetRpdPairingOutput
Name status
Type string
error
object
rpdPairingRsp[ Loibsjtect ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
SetLatestSDRpdPairingInput
Name Type
Description Required
rpds [ string ]
No
SetLatestSDRpdPairingOutput
Name status
Type string
error
object
rpdPairingRsp[ Loibsjtect ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
VERSION: 22.1.0
27
QueryRpdPairingInput
Name
pageSize nextFrom configChangeTsDelta statusChangeTsDelta approvalState pairedRpdsOnly
Type
integer string long long string boolean
Description Enum: "Pending", "Approved"
Required
No No No No No No
QueryRpdPairingOutput
Name status
Type string
error
object
rpdPairingRsp[ Loibsjtect ]
nextFrom string
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No No
RpdPairingOutput
Name status
Type string
error
object
macAddress string
name
string
description string
approvalStatestring
additionalCor[esobject ]
Description Enum: "Success", "Failure", "PartialSuccess"
Enum: "Pending", "Approved"
Required No
No No No No No
No
28
RPD SERVICE MANAGER APIS
Name
Type
Description
Required
state
string
Enum: "Defined",
No
"Inventory", "Installed",
"GcpUp",
"RouterVersionIncompatible",
"ConfigNotFound",
"ConfigurationError",
"ConfigReadError",
"ResourceAllocationError",
"ConfigPushError",
"NotProvisioned",
"Configured",
"Reconciled",
"StaticRouteNotConfigured",
"CableDsgNotConfigured",
"GcpRedirectStarted",
"GcpRedirectStartedWithException",
"GcpRedirected",
"GcpRedirectedWithException",
"GcpRedirectError",
"Online",
"PartialOnline",
"DeletePending",
"Offline",
"OnlineWithException"
pairingChangedTatimeTeismtaemp
No
serviceTemplasttering
No
nodeSegmentastiroing
Enum: "RPD_1x1",
No
"RPD_1x2", "RPD_2x2"
dsgTgList [ integer ]
No
downstreamVoinmteIdger
No
downstreamVolomnPg rofile
No
shelf
boolean
No
upstreamVarpidnItdeger
No
upstreamVarpldoPngrofile
No
secondUpstrealomnVgarpdProfile
No
disableNetworbkoDoelelaayn
No
assignedCores[ object ]
No
portConfigs [ object ]
No
gpsLocation object
No
ssdProfileId integer
No
controllerAligbnomoelneat n
No
sduid
string
No
sdVersion integer
No
VERSION: 22.1.0
29
QueryRpdNamePairingInput
Name
Type
Description Required
nameList [ string ]
No
QueryRpdNamePairingOutput
Name status
Type string
error
object
rpdPairingRsp[ Loibsjtect ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
QueryRpdMacPairingInput
Name
Type
Description Required
macAddressList [ string ]
No
QueryRpdMacPairingOutput
Name status
Type string
error
object
rpdPairingRsp[ Loibsjtect ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
DeleteRpdPairingInput
Name
Type
Description Required
nameList [ string ]
No
DeleteRpdPairingOutput
30
RPD SERVICE MANAGER APIS
Name status
Type string
error
object
rpdPairingRsp[ Loibsjtect ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
ClearRpdPairingInput
Name
nameList macAddressList
Type
[ string ] [ string ]
Description
Required
No No
ClearRpdPairingOutput
Name status
Type string
error
object
rpdPairingRsp[ Loibsjtect ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
RpdRestCompatibilityKey
Name
rpdVendor rpdSwVersion routerType routerSwVersion
Type
string string string string
Description
Required
No No No No
RpdRestCompatibilityV2
Name
existingRecord newRecord
Type
object object
Description
Required
No No
VERSION: 22.1.0
31
SetRpdCompatibilityInputV2
Name
Type
Description Required
compatibilityList [ object ]
No
RpdRestCompatibilityStatus
Name status
error key
Type string
object object
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
SetRpdCompatibilityOutput
Name status
Type string
error
object
statusList [ object ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
SetRedirectVersionInput
Name
rpdVersion rpdVendor redirectVersion
Type
string string string
Description Enum: "I15"
Required
No No No
SetRedirectVersionOutput
Name status
Type string
error
object
rpdVersion string
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
32
Name
Type
rpdVendor string redirectVersiosntring
Description
RPD SERVICE MANAGER APIS
Required No No
DeleteRedirectVersionInput
Name
rpdVersion rpdVendor
Type
string string
Description
Required
No No
DeleteRedirectVersionOutput
Name status
error
Type string
object
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No
GcpRedirectRpdDetails
Name
rpdVersion rpdVendor redirectVersion
Type
string string string
Description Enum: "I15"
Required
No No No
QueryRedirectVersionListOutput
Name status
Type string
error
object
gcpRedirectVe[ rosbiojnecLtis]t
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
DumpSystemInfoOutput
VERSION: 22.1.0
Name status
Type string
error
object
deletePending[Rsptrdisng ]
lockedRpds [ string ]
beingGcpUpR[psdtrsing ]
threadPoolInf[oobject ]
Description
Enum: "Success", "Failure", "PartialSuccess"
33
Required No
No No No No No
ThreadPoolInfo
Name
name queueSize activeCount completedTaskCount corePoolSize largestPoolSize maxPoolSize poolSize taskCount
Type
string integer integer long integer integer integer integer long
Description
Required
No No No No No No No No No
ShowCommitQueueInput
Name Type Description Required
showAll boolean
No
QueueItem
Name
id tag age status devices when failureReason
Type
string string integer string [ string ] dateTime string
Description
Required
No No No No No No No
34
RPD SERVICE MANAGER APIS
ShowCommitQueueOutput
Name status
Type string
error
object
queueItems [ object ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
DeleteCommitQueueItemInput
Name
Type Description Required
queueItemId string
No
AddServiceTemplateInput
Name
name defaultFlag autoAccept pilotToneProfile dsgTunnelGroupIDs loadBalanceXml networkDelayStatic networkDelayDlm dlmMeasureOnly elementsList rpdNameList uuid enforce
Type
string boolean boolean integer [ integer ] string integer integer boolean [ object ] [ string ] string boolean
Description
Required
No No No No No No No No No No No No No
ServiceElementInput
Name
Type
description string serviceType string
serviceGroupNstarmineg eventProfile integer mdSplitting boolean
Description
Enum: "DATA", "VIDEO", "MULTICASTVIDEO", "OOB"
Required
No No
No No No
VERSION: 22.1.0
Name
Type
Description
downstreamVoinmteIdger upstreamVarpidnItdeger downstreamVolomnPg rofile upstreamVarpldoPngrofile secondUpstrealomnVgarpdProfile downstreamCionnttergoelrlerProfile upstreamContinrotlelgeerPr rofile svcNdfProfiles[ object ] svcNdrProfiles[ object ] rfPowerAdjust[ string ] rdtiConfig integer
35
Required
No No No No No No No No No No No
ServiceOobProfile
Name
pwName profileId portNum
Type
string long integer
Description
Required
No No No
AddServiceTemplateOutput
Name status
error name
Type string
object string
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
ServiceGroupProfilesInput
Name
allCore coreIdentifier
Type
boolean [ string ]
Description
Required
No No
ServiceGroupProfilesOutput
36
RPD SERVICE MANAGER APIS
Name status
Type string
error
object
servicegroupp[rosfitrleinsg ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
ServiceDefinitionDiffInput
Name
uuid sdversion1 sdversion2
Type
string integer integer
Description
Required
No No No
ServiceDefinitionDiffOutput
Name status
Type string
error
object
serviceTemplaotbej1ect
serviceTemplaotbej2ect
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No No
ServiceElementOutput
Name
Type
Description
description string
serviceType string
Enum: "DATA", "VIDEO",
"MULTICASTVIDEO", "OOB"
serviceGroupNstarmineg
eventProfile integer
mdSplitting boolean
downstreamCionnttergoelrlerProfile
upstreamContinrotlelgeerPr rofile
downstreamVoinmteIdger
downstreamVolomnPg rofile
upstreamVarpidnItdeger
upstreamVarpldoPngrofile
secondUpstrealomnVgarpdProfile
Required
No No
No No No No No No No No No No
VERSION: 22.1.0
Name
Type
svcNdfProfiles[ object ] svcNdrProfiles[ object ] rfPowerAdjust[ string ] rdtiConfig integer
Description
37
Required No No No No
ServiceTemplateOutput
Name status
Type string
error
object
name
string
defaultFlag boolean
autoAccept boolean
rpdsAssigned long
rpdsProvisionbedoolean
pilotToneProfiinleteger
dsgTunnelGro[uipnItDegser ]
loadBalanceXsmtrling
networkDelayiSnttaetgicer
networkDelayiDntlmeger
dlmMeasureObnolyolean
uuid
string
sdversion integer
timestamp string
user
string
elementsList [ object ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required
No
No No No No No No No No No No No No No No No No No
GetServiceTemplateInput
Name Type Description Required
name string
No
GetServiceTemplateOutput
38
RPD SERVICE MANAGER APIS
Name status
Type string
error
object
name
string
defaultFlag boolean
autoAccept boolean
rpdsAssigned long
rpdsProvisionbedoolean
pilotToneProfiinleteger
dsgTunnelGro[uipnItDegser ]
loadBalanceXsmtrling
networkDelayiSnttaetgicer
networkDelayiDntlmeger
dlmMeasureObnolyolean
uuid
string
sdversion integer
timestamp string
user
string
elementsList [ object ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required
No
No No No No No No No No No No No No No No No No No
GetServiceTemplateRpdsAssignedListOutput
Name
Type
Description
status
string
Enum: "Success",
"Failure",
"PartialSuccess"
error
object
serviceTempla[toeRbjpedctsA] ssignedOutputList
Required No
No No
ServiceTemplateRpdsAssignedOutput
Name status
Type string
error
object
name
string
rpdsAssigned long
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No No
VERSION: 22.1.0
GetServiceTemplateListOutput
Name
Type
Description
status
string
Enum: "Success",
"Failure",
"PartialSuccess"
error
object
serviceTempla[toeObjuetcptu]tList
39
Required No
No No
GetServiceDefinitionOutput
Name
Type
Description
status
string
Enum: "Success",
"Failure",
"PartialSuccess"
error
object
serviceTempla[toeObjuetcptu]tList
Required No
No No
DeleteServiceTemplateListInput
Name
Type
Description Required
nameList [ string ]
No
DeleteServiceTemplateListOutput
Name
Type
Description
status
string
Enum: "Success",
"Failure",
"PartialSuccess"
error
object
deleteServiceT[ eombpjelacte]OutputList
Required No
No No
DeleteServiceTemplateOutput
Name status
Type string
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
40
Name error name
Type
object string
Description
RPD SERVICE MANAGER APIS
Required No No
DeleteServiceTemplateInput
Name Type Description Required
name string
No
AddServiceTemplateListInput
Name
Type
Description Required
serviceTemplateInputList [ object ]
No
AddServiceTemplateListOutput
Name
Type
Description
status
string
Enum: "Success",
"Failure",
"PartialSuccess"
error
object
addServiceTem[ opblajetecOt u] tputList
Required No
No No
UpdateRpdInventoryInput
Name
macAddress name type description gpsLocation
Type
string string string string object
Description
Required
No No No No No
UpdateRpdInventoryOutput
VERSION: 22.1.0
Name status
Type string
error
object
macAddress string
name
string
Description
Enum: "Success", "Failure", "PartialSuccess"
41
Required No
No No No
SendTestGcpMessageInput
Name
Type
macAddressLi[ssttring ] bypassConfigSbeorovliecaen bypassDelayIninSteecgoenrds rpdVendor string rpdSwVersionstring rpdIpAddressobject gcpEventTypestring
Description
Enum: "GcpEventUp", "GcpEventRedirected", "GcpEventRedirectError"
Required
No No No No No No No
SendTestGcpMessageOutput
Name status
error
Type string
object
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No
RefreshRPDStatusInput
Name
macAddress name
Type
string string
Description
Required
No No
RefreshRPDStatusOutput
42 Name status
error
Type string
object
RPD SERVICE MANAGER APIS
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No
QueryRpdTopologyInput
Name
Type
Description Required
macAddressList [ string ]
No
QueryRpdTopologyOutput
Name status
Type string
error
object
rpdTopology [ object ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
RpdTopology
Name status
Type string
error
object
macAddress string
uuid
string
name
string
rpdConnected[Csotriensg ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No No No No
VERSION: 22.1.0
43
Name rpdState
Type string
Description
Required
Enum: "Defined",
No
"Inventory", "Installed",
"GcpUp",
"RouterVersionIncompatible",
"ConfigNotFound",
"ConfigurationError",
"ConfigReadError",
"ResourceAllocationError",
"ConfigPushError",
"NotProvisioned",
"Configured",
"Reconciled",
"StaticRouteNotConfigured",
"CableDsgNotConfigured",
"GcpRedirectStarted",
"GcpRedirectStartedWithException",
"GcpRedirected",
"GcpRedirectedWithException",
"GcpRedirectError",
"Online",
"PartialOnline",
"DeletePending",
"Offline",
"OnlineWithException"
GpsRange
Name
from to
Type
number number
Description
Required
No No
QueryRpdInventoryInput
Name
latitudeRange longitudeRange timeStampDelta pageSize nextFrom
Type
object object long integer string
Description
Required
No No No No No
44
RPD SERVICE MANAGER APIS
GpsLocationRange
Name
latitudeRange longitudeRange
Type
object object
Description
Required
No No
QueryRpdInventoryOutput
Name status
Type string
error
object
nextFrom string
gpsLocationRoabnjgeect
rpdInventory [ object ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No No No
RpdInventory
Name
Type
macAddress string
uuid
string
name
string
description string
modelNumberstring
ipAddress object
Description
Required
No No No No No No
VERSION: 22.1.0
45
Name state
Type string
stateChangeTdimateesTtaimmep gpsLocation object
Description
Required
Enum: "Defined",
No
"Inventory", "Installed",
"GcpUp",
"RouterVersionIncompatible",
"ConfigNotFound",
"ConfigurationError",
"ConfigReadError",
"ResourceAllocationError",
"ConfigPushError",
"NotProvisioned",
"Configured",
"Reconciled",
"StaticRouteNotConfigured",
"CableDsgNotConfigured",
"GcpRedirectStarted",
"GcpRedirectStartedWithException",
"GcpRedirected",
"GcpRedirectedWithException",
"GcpRedirectError",
"Online",
"PartialOnline",
"DeletePending",
"Offline",
"OnlineWithException"
No
No
QueryRpdDetailsOutput
Name status
Type string
error
object
macAddress string
uuid
string
ipAddress object
name
string
description string
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No No No No No
46
RPD SERVICE MANAGER APIS
Name state
Type string
type
string
gpsLocation object
deviceInfo object
stateChangeTdimateesTtaimmep
rpdHistory [ object ]
cli
string
Description
Required
Enum: "Defined",
No
"Inventory", "Installed",
"GcpUp",
"RouterVersionIncompatible",
"ConfigNotFound",
"ConfigurationError",
"ConfigReadError",
"ResourceAllocationError",
"ConfigPushError",
"NotProvisioned",
"Configured",
"Reconciled",
"StaticRouteNotConfigured",
"CableDsgNotConfigured",
"GcpRedirectStarted",
"GcpRedirectStartedWithException",
"GcpRedirected",
"GcpRedirectedWithException",
"GcpRedirectError",
"Online",
"PartialOnline",
"DeletePending",
"Offline",
"OnlineWithException"
No
No
No
No
No
No
QueryRpdStateInput
Name
nameList macAddressList
Type
[ string ] [ string ]
Description
Required
No No
CorewiseRpdStates
VERSION: 22.1.0
Name status
Type string
error
object
interfacewiseRopbdjeScttates
Description
Enum: "Success", "Failure", "PartialSuccess"
47
Required No
No No
QueryRpdStateOutput
Name
Type
Description
status
string
Enum: "Success",
"Failure",
"PartialSuccess"
error
object
corewiseRpdS[taotbujseRctes]ponse
Required No
No No
RpdCorewiseStateOutput
Name status
Type string
error
object
rpdName string
macAddress string
corewiseRpdSotbatjecst
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No No No
QueryAllRpdDataInput
Name
latitudeRange longitudeRange timeStampDelta
Type
object object long
Description
Required
No No No
QueryAllRpdDataOutput
48
RPD SERVICE MANAGER APIS
Name status
Type string
error
object
gpsLocationRoabnjgeect
rpdData [ object ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No No
RpdData
Name
Type
macAddress string
uuid
string
ipAddress object
name
string
description string
state
string
type
string
stateChangeTdimateesTtaimmep
gpsLocation object
Description
Required
No
No
No
No
No
Enum: "Defined",
No
"Inventory", "Installed",
"GcpUp",
"RouterVersionIncompatible",
"ConfigNotFound",
"ConfigurationError",
"ConfigReadError",
"ResourceAllocationError",
"ConfigPushError",
"NotProvisioned",
"Configured",
"Reconciled",
"StaticRouteNotConfigured",
"CableDsgNotConfigured",
"GcpRedirectStarted",
"GcpRedirectStartedWithException",
"GcpRedirected",
"GcpRedirectedWithException",
"GcpRedirectError",
"Online",
"PartialOnline",
"DeletePending",
"Offline",
"OnlineWithException"
No
No
No
VERSION: 22.1.0
49
Name
Type
Description
deviceInfo object
serviceTemplasttering
approvalStatestring
Enum: "Pending",
"Approved"
assignedCores[ object ]
portConfigs [ object ]
additionalCor[esobject ]
nodeSegmentastiroing
Enum: "RPD_1x1",
"RPD_1x2", "RPD_2x2"
dsgTgList [ integer ]
downstreamVoinmteIdger
downstreamVolomnPg rofile
upstreamVarpidnItdeger
upstreamVarpldoPngrofile
secondUpstrealomnVgarpdProfile
pairingChangedTatimeTeismtaemp
rpdHistory [ object ]
cli
string
ssdProfileId integer
disableNetworbkoDoelelaayn
shelf
boolean
controllerAligbnomoelneat n
sdVersion integer
Required
No No No
No No No No
No No No No No No No No No No No No No No
DeleteRpdInventoryInput
Name
Type Description Required
macAddress string
No
DeleteRpdInventoryOutput
Name status
Type string
error
object
macAddress string
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
AddRpdInventoryInput
50
RPD SERVICE MANAGER APIS
Name
macAddress name type description gpsLocation
Type
string string string string object
Description
Required
No No No No No
AddRpdInventoryOutput
Name status
Type string
error
object
macAddress string
name
string
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No No
QueryRpdListOnServiceDefinitionInput
Name
sduid page_size next_from
Type
string integer string
Description
Required
No No No
QueryRpdListOnServiceDefinitionOutput
Name status
Type string
error
object
rpdServiceDefi[ noibtijoenctLi]st
next_from string
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No No
RpdDetails
Name name
Type string
Description
Required No
VERSION: 22.1.0
51
Name
Type
macAddress string
state
string
approvalStatestring
version
string
sdversion integer
suid
string
segmentation string
Description
Enum: "RPD_1x1", "RPD_1x2", "RPD_2x2"
Required
No No No No No No No
RpdServiceDefinition
Name status
Type string
error
object
serviceDefinitsiotnriNngame
rpdsAssigned long
sdVersionCou[ntoLbijsetct ]
rpdList
[ object ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No No No No
SdVersionCount
Name
sdversion count
Type
integer long
Description
Required
No No
GetServiceTemplateInputList
Name
Type
Description Required
serviceTemplateList [ object ]
No
QueryRpdServiceDefinition
52
RPD SERVICE MANAGER APIS
Name status
Type string
error
object
rpdServiceDefi[ noibtijoenctLi]st
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
QueryRpdOnServiceDefinitionInput
Name
uuid sdverison
Type
string integer
Description
Required
No No
QueryRpdOnServiceDefinition
Name status
error rpdList
Type string
object [ object ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
QueryRpdsNotonLatestSDInput
Name
sdname page_size next_from
Type
string integer string
Description
Required
No No No
QueryRpdsNotonLatestSDOutput
Name status
Type string
error
object
rpdList
[ object ]
next_from string
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No No
VERSION: 22.1.0
53
RpdRestCompatibility
Name Type Description Required
key object
No
SetRpdCompatibilityInput
Name
Type
Description Required
compatibilityList [ object ]
No
QueryRpdCompatibilityInput
Name Type Description Required
key object
No
QueryRpdCompatibilityOutput
Name status
error key
Type string
object object
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
QueryRpdCompatibilityListInput
Name
Type Description Required
QueryRpdCompatibilityListInput object
QueryRpdCompatibilityListOutput
Name status
error
Type string
object
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No
54
Name
Type
compatibilityL[ iosbt ject ]
Description
RPD SERVICE MANAGER APIS
Required No
DeleteRpdCompatibilityInput
Name
Type
Description Required
compatibilityKeyList [ object ]
No
DeleteRpdCompatibilityOutput
Name status
Type string
error
object
statusList [ object ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
RFPowerConfigInput
Name
profileName rfChannels powerAdjust
Type
string string string
Description
Required
No No No
RFPowerConfigOutput
Name status
error
Type string
object
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No
QueryRFPowerConfigInput
Name
Type Description Required
QueryRFPowerConfigInput object
VERSION: 22.1.0
GetRFPowerConfigOutput
Name
Type
Description
status
string
Enum: "Success",
"Failure",
"PartialSuccess"
error
object
rfPowerConfig[OoubtjpecuttL] ist
55
Required No
No No
DeleteRfPowerConfigInput
Name
Type
Description Required
profilenames [ string ]
No
DeleteRfPowerConfigOutput
Name status
Type string
error
object
profileName string
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
DeleteRfPowerConfigOutputList
Name
Type
Description
status
string
Enum: "Success",
"Failure",
"PartialSuccess"
error
object
deleteRfPower[ CoobnjeficgtO]utput
Required No
No No
TestReleaseResourcesInput
Name
coreUuid rpdMacAddress
Type
string string
Description
Required
No No
56
RPD SERVICE MANAGER APIS
TestInsertResourcesInput
Name
coreUuid rpdConnectionInterface
Type
string string
Description
Required
No No
TestDeleteResourcesInput
Name
Type Description Required
coreUuid string
No
TestDeleteInterfaceResourcesInput
Name
coreUuid rpdConnectionInterfaceList
Type
string [ string ]
Description
Required
No No
TestAssignResourcesToRpdInput
Name
coreUuid rpdConnectionInterface rpdMacAddress
Type
string string string
Description
Required
No No No
DumpResourceMapOutput
Name status
Type string
error
object
resourceMap object
usedRPDResooubrjceecst
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No No
SetGlobalConfigInput
VERSION: 22.1.0
57
Name
staticRouting rpdSoftwareVersionValidate coreConfigPersist cableDsg coreConfigPersistInterval
Type
boolean boolean boolean boolean integer
Description
Required
No No No No No
SetGlobalConfigOutput
Name status
error
Type string
object
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No
ResetGlobalConfigInput
Name
Type Description Required
ResetGlobalConfigInput object
ResetGlobalConfigOutput
Name status
error
Type string
object
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No
QueryGlobalConfigInput
Name
Type Description Required
QueryGlobalConfigInput object
ConfigRecord
58
RPD SERVICE MANAGER APIS
Name
staticRouting rpdSoftwareVersionValidate coreConfigPersist cableDsg coreConfigPersistInterval
Type
boolean boolean boolean boolean integer
Description
Required
No No No No No
QueryGlobalConfigOutput
Name status
error config
Type string
object object
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
SetInstanceIdInput
Name
Type Description Required
instanceId string
No
SetInstanceIdOutput
Name status
error
Type string
object
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No
GetInstanceIdInput
Name
Type Description Required
GetInstanceIdInput object
GetInstanceIdOutput
VERSION: 22.1.0
Name status
Type string
error
object
instanceId string
instanceDate dateTime
instanceZone string
instanceZoneOinfftseegter
instanceInDSTboolean
Description
Enum: "Success", "Failure", "PartialSuccess"
59
Required No
No No No No No No
DbExportImportStatus
Name
operation startTime currentTime state message exportDirectory filename exportInProgress importInProgress upgradeInProgress
Type
string dateTime dateTime string string string string boolean boolean boolean
Description Enum: "EXPORT", "IMPORT"
Enum: "PENDING", "SUCCESS", "FAILED"
Required
No No No No No No No No No No
GetDbExportImportStatusOutput
Name
Type
Description
status
string
Enum: "Success",
"Failure",
"PartialSuccess"
error
object
dbExportImp[orotbSjteacttu]sList
Required No
No No
DataImportInput
Name
dir server username
Type
string string string
Description
Required
No No No
60
RPD SERVICE MANAGER APIS
Name
password passphrase filename overwrite action
Type
string string string boolean string
Description Enum: "IMPORT", "DELETE_AND_IMPORT"
Required
No No No No No
DataImportOutput
Name status
error
Type string
object
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No
DataExportInput
Name
dir server username password passphrase
Type
string string string string string
Description
Required
No No No No No
DataExportOutput
Name status
Type string
error filename
object string
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
CountOutput
VERSION: 22.1.0
Name
Type
Description
status
string
Enum: "Success",
"Failure",
"PartialSuccess"
error
object
coreCount integer
rpdCount integer
rpdAssociatioinnCteoguenrt
principalCoreiAnstseogceirationCount
auxCoreAssociinatteigoenrCount
serviceTemplaitnetCegoeurnt
credProfileCoiunntteger
61
Required No
No No No No No No No No
QueryCredentialsInput
Name
Type Description Required
QueryCredentialsInput object
QueryCredentialsOutput
Name status
Type string
error
object
credentialProfi[ lsetsring ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
QueryCoreDetailsInput
Name
Type
ipAddressList[ object ]
state
string
Description
Required
No
Enum: "UNKNOWN",
No
"ONLINE", "MAINTENANCE",
"NORMALOPS_PROGRESS",
"RECONCILIATION_PROGRESS",
"RECONCILED",
"RECONCILIATION_FAILED",
"OFFLINE",
"SSHKEYFETCH_IN_PROGRESS",
"SSHKEYFETCH_FAILED"
62
RPD SERVICE MANAGER APIS
CoreDetails
Name status
Type string
error
object
ipAddressList[ object ]
uuid
string
gpsLocation object
hostName string
description string
interfacesList[ object ]
virtualSGs [ object ]
ndfProfiles object
ndrProfiles object
ssdProfiles [ object ]
state
string
productType string swVersion string vendorName string protectedLC integer
Description
Required
Enum: "Success",
No
"Failure",
"PartialSuccess"
No
No
No
No
No
No
No
No
No
No
No
Enum: "UNKNOWN",
No
"ONLINE", "MAINTENANCE",
"NORMALOPS_PROGRESS",
"RECONCILIATION_PROGRESS",
"RECONCILED",
"RECONCILIATION_FAILED",
"OFFLINE",
"SSHKEYFETCH_IN_PROGRESS",
"SSHKEYFETCH_FAILED"
No
No
No
No
DpicInterface
Name
name dpicIpMaskList
Type
string [ object ]
Description
Required
No No
IpMask
Name ip
Type Description Required
object
No
VERSION: 22.1.0
63
Name
Type Description Required
prefixLen integer
No
OOBProfiles
Name
pwNames profileIds
Type
[ string ] [ long ]
Description
Required
No No
QueryCoreDetailsOutput
Name status
error coreList
Type string
object [ object ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
SsdProfile
Name
id name
Type
integer string
Description
Required
No No
VirtualSG
Name
name dsControllerId slotNumber profileId isVideoController
Type
string string integer integer boolean
Description
Required
No No No No No
QueryCoreResourceUsageInput
64
RPD SERVICE MANAGER APIS
Name
Type Description Required
coreIdentifier string
No
QueryCoreResourceUsageOutput
Name status
Type string
error
object
fiberNodes [ string ]
dscontrollers [ string ]
uscontrollers [ string ]
macDomain [ string ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No No No No
FetchSshKeyInput
Name
ipAddressList allCore
Type
[ object ] boolean
Description
Required
No No
FetchSshKeyOutput
Name status
Type string
error
object
ipAddress object
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
DeleteDpicInventoryInput
Name
ipAddress interfacesList
Type
object [ object ]
Description
Required
No No
VERSION: 22.1.0
DeleteDpicInventoryOutput
Name status
Type string
error
object
ipAddress object
Description
Enum: "Success", "Failure", "PartialSuccess"
65
Required No
No No
DeleteCoreInventoryInput
Name
Type
Description Required
ipAddressList [ object ]
No
DeleteCoreInventoryOutput
Name status
Type string
error
object
ipAddressList[ object ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
AddDpicInventoryInput
Name
ipAddress interfacesList
Type
object [ object ]
Description
Required
No No
AddDpicInventoryOutput
Name status
Type string
error
object
ipAddressList[ object ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
66
RPD SERVICE MANAGER APIS
AddCoreInventoryInput
Name
ipAddressList profile gpsLocation description hostName uuid productType swVersion vendorName
Type
[ object ] string object string string string string string string
Description
Required
No No No No No No No No No
AddCoreInventoryOutput
Name status
Type string
error
object
ipAddressList[ object ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
CoreKeyInput
Name
Type
Description Required
ipAddressList [ object ]
No
CoreReconciliationOutput
Name status
Type string
error
object
ipAddress object
reconciliationJstorbinIdg
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No No
CoreReconciliationInput
VERSION: 22.1.0
67
Name
ipAddressList reconciliationAction
Type
[ object ] string
Description
Required
No No
ReconciliationReportParams
Name
reportId coreIpAddress rpdIdentifier
Type
string object string
Description
Required
No No No
ConfigDiff
Name
configname configpath configtype configvalueincore configvalueinsmartphy
Type
string string string string string
Description
Required
No No No No No
ReconciliationReport
Name
Type
key
object
reconciliationtloimnge
state
string
presentincore boolean presentinsystebmoolean configdiff [ object ] actionperformsetdring
Description
Enum: "Missing", "Identical", "Different"
Required
No No No
No No No No
ReconciliationReportKey
Name
reconciliationid coreidentifier rpdidentifier
Type
string string string
Description
Required
No No No
68
RPD SERVICE MANAGER APIS
ReconciliationMeta
Name status
Type string
error
object
reportId string
reportTime string
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No No
CoreConfigurationDetailsV2
Name
coreHostname coreIpAddress coreType coreConfigurationTime coreServiceDetails coreConfigurationCli
Type
string string string string [ object ] string
Description
Required
No No No No No No
DeviceInfoDetails
Name
rpdVendor rpdModel rpdSWVersion
Type
string string string
Description
Required
No No No
GpsLocation
Name
latitude longitude genericlocation
Type
number number string
Description
Required
No No No
RpdConfigurationDetailsV2
VERSION: 22.1.0
69
Name status
Type string
error
object
name
string
macAddress string
state
string
rpdType string ipAddress string rpdSWUpgradstering rpdUpTime long description string gpsLocation object deviceInfo object coreConfigura[tioobnjsect ]
Description
Required
Enum: "Success",
No
"Failure",
"PartialSuccess"
No
No
No
Enum: "Defined",
No
"Inventory", "Installed",
"GcpUp",
"RouterVersionIncompatible",
"ConfigNotFound",
"ConfigurationError",
"ConfigReadError",
"ResourceAllocationError",
"ConfigPushError",
"NotProvisioned",
"Configured",
"Reconciled",
"StaticRouteNotConfigured",
"CableDsgNotConfigured",
"GcpRedirectStarted",
"GcpRedirectStartedWithException",
"GcpRedirected",
"GcpRedirectedWithException",
"GcpRedirectError",
"Online",
"PartialOnline",
"DeletePending",
"Offline",
"OnlineWithException"
No
No
No
No
No
No
No
No
ServiceDetailsV2
70
Name
Type
coreInterfacesobject serviceType string
RPD SERVICE MANAGER APIS
Description
Enum: "DATA", "VIDEO", "MULTICASTVIDEO", "OOB"
Required
No No
CoreConfigurationDetails
Name
coreHostname coreIpAddress coreType coreConfigurationTime coreServiceDetails coreConfigurationCli
Type
string string string string [ object ] string
Description
Required
No No No No No No
RpdConfigurationDetails
Name status
Type string
error
object
rpdName string
rpdMacAddresstsring
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No No
VERSION: 22.1.0
71
Name rpdState
Type string
rpdType string coreConfigura[tioobnjsect ]
Description
Required
Enum: "Defined",
No
"Inventory", "Installed",
"GcpUp",
"RouterVersionIncompatible",
"ConfigNotFound",
"ConfigurationError",
"ConfigReadError",
"ResourceAllocationError",
"ConfigPushError",
"NotProvisioned",
"Configured",
"Reconciled",
"StaticRouteNotConfigured",
"CableDsgNotConfigured",
"GcpRedirectStarted",
"GcpRedirectStartedWithException",
"GcpRedirected",
"GcpRedirectedWithException",
"GcpRedirectError",
"Online",
"PartialOnline",
"DeletePending",
"Offline",
"OnlineWithException"
No
No
RpdConfigurationDetailsListOutput
Name
Type
Description
status
string
Enum: "Success",
"Failure",
"PartialSuccess"
error
object
rpdConfigurat[ionbDjeectta]ilsList
Required No
No No
ServiceDetails
Name
Type
coreInterfaces[ string ]
Description
Required No
72
Name
Type
serviceType string
RpdCount
Name status
Type string
error
object
rpdCount object
RPD SERVICE MANAGER APIS
Description
Enum: "DATA", "VIDEO", "MULTICASTVIDEO", "OOB"
Required No
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
Inventory Manager APIs
Version: 22.1.0
License: Cisco Systems, Inc.
/inventory/v2/credential/query-credential-profile
POST Responses
Code Description 200 OK
/inventory/v2/credential/delete-credential-profile
POST Responses
Code Description 200 OK
/inventory/v1/instance/set-instance-id
POST Responses
Code Description 200 OK
73
74
INVENTORY MANAGER APIS
/inventory/v1/instance/get-instance-id
POST Responses
Code Description 200 OK
/inventory/v1/device/update-device-inventory
POST Responses
Code Description 200 OK
/inventory/v1/device/update-device-inventory-list
POST Responses
Code Description 200 OK
/inventory/v1/device/update-ccap-core-state
POST Responses
Code Description 200 OK
/inventory/v1/device/query-device-list
POST Responses
VERSION: 22.1.0
75
Code Description 200 OK
/inventory/v1/device/delete-device-inventory
POST Responses
Code Description 200 OK
/inventory/v1/device/add-device-inventory
POST Responses
Code Description 200 OK
/inventory/v1/device/add-device-inventory-list
POST Responses
Code Description 200 OK
/inventory/v1/credential/set-credential-profile
POST Responses
Code Description 200 OK
76
INVENTORY MANAGER APIS
/inventory/v1/credential/query-credential-profile
POST Responses
Code Description 200 OK
/inventory/v1/credential/delete-credential-profile
POST Responses
Code Description 200 OK
/api/config/smiuser/_operations/change-password
POST Responses
Code Description 200 OK
/inventory/v2/credential/get-inventory-counts
GET Responses
Code Description 200 OK
Models
QueryCredentialProfileInput
VERSION: 22.1.0
77
Name
Type
Description Required
profileNameList [ string ]
No
CredentialProfileOutputV2
Name
profileId profileName username password enablePassword connectionType port snmpReadCommunity snmpWriteCommunity timeStamp status used
Type
string string string string string string integer string string dateTime object boolean
Description Enum: "SSH", "Telnet"
Required
No No No No No No No No No No No No
Error
Name
errorType errorCode
Type
string string
errorMessage string
Description
Required
Enum: "User", "System" No
Enum: "InputInvalid",
No
"InputMismatch",
"InputDuplicate",
"InputMissing",
"RecordExists",
"RecordNotFound",
"DataStoreConnectivityError",
"DataStoreError",
"DataNotFound",
"InternalError",
"OperationNotAllowed",
"ResourceReleaseError",
"ConfigurationError",
"DeviceCommunicationError",
"CoreNotOnline",
"SshKeyFetchFailed",
"InvalidCoreState"
No
78
Name errorTag
Type string
Description
INVENTORY MANAGER APIS
Required No
QueryCredentialProfileOutputV2
Name status
Type string
error
object
credentialProfi[ loebLjiesctt ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
Status
Name status
Type string
error
object
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No
DeleteCredProfileListInput
Name
Type
Description Required
deleteCredentialProfileInputList [ object ]
No
DeleteCredentialProfileInput
Name
Type Description Required
profileName string
No
DeleteCredProfileListOutput
Name status
error
Type string
object
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No
VERSION: 22.1.0
Name
Type
Description
deleteCredent[iaolbPjreocfitle] Output
79
Required No
DeleteCredentialProfileOutput
Name status
Type string
error
object
profileName string
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
SetInstanceIdInput
Name
Type Description Required
instanceId string
No
SetInstanceIdOutput
Name status
error
Type string
object
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No
GetInstanceIdInput
Name
Type Description Required
GetInstanceIdInput object
GetInstanceIdOutput
Name status
error
Type string
object
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No
80
Name
Type
instanceId string instanceDate dateTime instanceZone string instanceZoneOinfftseegter instanceInDSTboolean
Description
INVENTORY MANAGER APIS
Required No No No No No
GpsLocation
Name
latitude longitude genericlocation
Type
number number string
Description
Required
No No No
UpdateDeviceInventoryInput
Name
deviceKeyType macAddress ipAddressList credentialProfile gpsLocation description hostName uuid productType
Type
string string [ object ] string object string string string string
Description Enum: "IPADDRESS", "MACADDRESS"
Required
No No No No No No No No No
UpdateDeviceInventoryOutput
Name status
Type string
error
object
deviceKey string
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
UpdateDeviceInventoryListInput
VERSION: 22.1.0
81
Name
Type
Description Required
updateDeviceInventoryInputList [ object ]
No
UpdateDeviceInventoryListOutput
Name
Type
Description
status
string
Enum: "Success",
"Failure",
"PartialSuccess"
error
object
updateDevice[Inovbejnetcotry] OutputList
Required No
No No
MaintainCCAPCoreInput
Name
deviceKeyList allCore reconcile maintenanceState
Type
[ string ] boolean boolean string
Description Enum: "MAINTENANCE", "NORMAL"
Required
No No No No
DeviceStatusOutput
Name status
Type string
error
object
deviceKey string
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
MaintainCCAPCoreOutput
Name status
Type string
error
object
deviceRspList[ object ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
82
INVENTORY MANAGER APIS
QueryDeviceListInput
Name
deviceKeyList pageSize nextFrom
Type
[ string ] integer string
Description
Required
No No No
DeviceDetails
Name status
Type string
error
object
deviceKey string
deviceKeyTypsetring
Description Enum: "Success", "Failure", "PartialSuccess"
Enum: "IPADDRESS", "MACADDRESS"
Required No
No No No
VERSION: 22.1.0
83
Name state
Type string
stateChangeTdimateesTtaimmep
macAddress string
ipAddressList[ object ]
uuid
string
credentialProfistlering
gpsLocation object
hostName string
description string
productType string
deviceInfo object
deviceHistory[ object ]
tagDetails [ object ]
Description
Required
Enum: "UNKNOWN",
No
"ONLINE", "MAINTENANCE",
"NORMALOPS_PROGRESS",
"RECONCILIATION_PROGRESS",
"RECONCILED",
"RECONCILIATION_FAILED",
"OFFLINE",
"SSHKEYFETCH_IN_PROGRESS",
"SSHKEYFETCH_FAILED",
"Defined", "Inventory",
"Installed", "GcpUp",
"RouterVersionIncompatible",
"ConfigNotFound",
"ConfigurationError",
"ConfigReadError",
"ResourceAllocationError",
"ConfigPushError",
"NotProvisioned",
"Configured",
"StaticRouteNotConfigured",
"CableDsgNotConfigured",
"GcpRedirectStarted",
"GcpRedirectStartedWithException",
"GcpRedirected",
"GcpRedirectedWithException",
"GcpRedirectError",
"PartialOnline",
"DeletePending",
"OnlineWithException"
No
No
No
No
No
No
No
No
No
No
No
No
DeviceHistoryNotification
84
INVENTORY MANAGER APIS
Name state
Type string
stateDetails string correctiveActisotnring stateChangeTdimateesTtaimmep
Description
Required
Enum: "UNKNOWN",
No
"ONLINE", "MAINTENANCE",
"NORMALOPS_PROGRESS",
"RECONCILIATION_PROGRESS",
"RECONCILED",
"RECONCILIATION_FAILED",
"OFFLINE",
"SSHKEYFETCH_IN_PROGRESS",
"SSHKEYFETCH_FAILED",
"Defined", "Inventory",
"Installed", "GcpUp",
"RouterVersionIncompatible",
"ConfigNotFound",
"ConfigurationError",
"ConfigReadError",
"ResourceAllocationError",
"ConfigPushError",
"NotProvisioned",
"Configured",
"StaticRouteNotConfigured",
"CableDsgNotConfigured",
"GcpRedirectStarted",
"GcpRedirectStartedWithException",
"GcpRedirected",
"GcpRedirectedWithException",
"GcpRedirectError",
"PartialOnline",
"DeletePending",
"OnlineWithException"
No
No
No
DeviceInfo
Name
serialNumber hwVersion swVersion bootRomVersion modelNumber vendorName
Type
string string string string string string
Description
Required
No No No No No No
VERSION: 22.1.0
QueryDeviceListOutput
Name status
Type string
error nextFrom deviceList
object string [ object ]
Description
Enum: "Success", "Failure", "PartialSuccess"
85
Required No
No No No
TagDetails
Name
id tagName colorid colorcode
Type
string string integer string
Description
Required
No No No No
DeleteDeviceInventoryInput
Name
Type
Description Required
deviceKeyList [ string ]
No
DeleteDeviceInventoryOutput
Name status
Type string
error
object
deviceRspList[ object ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
AddDeviceInventoryInput
Name
deviceKeyType macAddress ipAddressList
Type
string string [ object ]
Description Enum: "IPADDRESS", "MACADDRESS"
Required
No No No
86
Name
credentialProfile gpsLocation description hostName uuid productType
Type
string object string string string string
INVENTORY MANAGER APIS
Description
Required
No No No No No No
AddDeviceInventoryOutput
Name status
Type string
error
object
deviceKey string
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
AddDeviceInventoryListInput
Name
Type
Description Required
addDeviceInventoryInputList [ object ]
No
AddDeviceInventoryListOutput
Name
Type
Description
status
string
Enum: "Success",
"Failure",
"PartialSuccess"
error
object
addDeviceInv[enotbojreycOt u] tputList
Required No
No No
SetCredentialProfileInput
Name
profileId profileName username password
Type
string string string string
Description
Required
No No No No
VERSION: 22.1.0
87
Name
connectionType port enablePassword snmpReadCommunity snmpWriteCommunity
Type
string integer string string string
Description Enum: "SSH", "Telnet"
Required
No No No No No
SetCredentialProfileOutput
Name status
Type string
error
object
profileName string
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
CredentialProfileOutput
Name
profileId profileName username password enablePassword connectionType port snmpReadCommunity snmpWriteCommunity timeStamp status
Type
string string string string string string integer string string dateTime object
Description Enum: "SSH", "Telnet"
Required
No No No No No No No No No No No
QueryCredentialProfileOutput
Name status
Type string
error
object
credentialProfi[ loebLjiesctt ]
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No
88
INVENTORY MANAGER APIS
UserResetPasswordInput
Name
username current_password new_password confirm_password
Type
string string string string
Description
Required
Yes Yes Yes Yes
InventoryCount
Name status
Type string
error
object
deviceCountBoybSjteacttus
deviceCountBoybTjeycpte
credentialCouonbtject
rpdCountBySotbatjuecst
Description
Enum: "Success", "Failure", "PartialSuccess"
Required No
No No No No No
Operations Hub Authentication API
Version: 1.0
Contact information: Operations Hub API Support
Security
BasicAuth
basic Basic
/loglevel
GET Summary Get HM Auth Current LogLevel
Description Get HM Auth Current LogLevel
Responses
Code Description Schema
200 OK
auth.LogLevel
Security
89
90
OPERATIONS HUB AUTHENTICATION API
Security Schema Scopes AuthBearerHeader
PUT Summary Set HM Auth LogLevel
Description Set HM Auth LogLevel
Parameters
Name Located in Description Required Schema
LogLevel body
Log Level Yes
auth.LogLevel
Responses
Code
200 400
Description
OK Bad Request
Schema
auth.LogLevel string
Security
Security Schema Scopes AuthBearerHeader
/reset-internal-user
PATCH Summary Reset internal admin user for opshub-data namespace
Description Reset internal admin user for opshub-data namespace
Parameters
Name Located in ResetPasswborddyRequestObj
Description
Required
Reset Internal User Yes
Schema structs.ResetPasswordRequestOb
VERSION: 1.0
91
Responses
Code
200 400
Description
OK Bad Request
Schema
string string
/v1/login/banner
GET Summary Get login banner message
Description Get login banner message default is in english
Responses
Code
200 500
Description
OK Internal Server Error
Schema
auth.Content auth.ErrorResponse
PATCH Summary Create, update login banner message
Description Create, update loign banner message
Parameters
Name Located in LoginBannbeordy
Description Login Banner
Required Yes
Schema auth.LoginBanner
Responses
Code
200 400 401 500
Description
OK Bad Request Unauthorized Internal Server Error
Schema
string auth.ErrorResponse auth.ErrorResponse auth.ErrorResponse
92
OPERATIONS HUB AUTHENTICATION API
/v1/token
POST Summary Generate an API token if user is valid
Description Generate an API token
Responses
Code
201 400
Description
Created Bad Request
Schema
structs.TokenGenInfo auth.ErrorResponse
Security
Security Schema Scopes BasicAuth
DELETE Summary Delete access token from DB
Description Delete access token from DB
Responses
Code
200 400
Description
OK Bad Request
Schema
string string
Security
Security Schema Scopes AuthBearerHeader
/v1/token/fresh
POST Summary Refresh access and fresh token
VERSION: 1.0
Description Refresh access and fresh token
Parameters
Name Token
Located in body
Description Token
Required Yes
Responses
Code
200 400
Description
OK Bad Request
Schema
structs.TokenGenInfo string
Security
Security Schema Scopes AuthBearerHeader
/v1/token/validation
POST Summary Validate access token
Description Check if the access token is valid
Responses
Code
200 400
Description
OK Bad Request
Schema
string string
Security
Security Schema Scopes AuthBearerHeader
93
Schema structs.TokenRefreshReqInfo
94
Models
auth.Content
Name language
Type string
message string
OPERATIONS HUB AUTHENTICATION API
Description
Language will always be 2 char standered representation as per ISO 639-1 code https://www.loc. gov/standards/iso6392/php/code_list.php Message must be limited to no more than 500 characters"
Required Yes
No
auth.ErrorResponse
Name
code description status
Type
integer string string
Description
Required
No No No
auth.LogLevel
Name
Type Description Required
Log Level string
No
auth.LoginBanner
Name Type
Description Required
content [ auth.Content ]
No
structs.ResetPasswordRequestObj
Name
admin_password confirm_password namespace new_password
Type
string string string string
Description
Required
No No No No
VERSION: 1.0
95
structs.TokenGenInfo
Name
access_token refresh_token refresh_token_expire token_type
Type
string string integer string
Description
Required
No No No No
structs.TokenRefreshReqInfo
Name
access_token refresh_token
Type
string string
Description
Required
No No
96
OPERATIONS HUB AUTHENTICATION API
Operations Hub RBAC API
This is Operations Hub server.
Version: 1.0
/v1/iam/user/action
POST Summary This api will fetch the logs from elastic db
Description This api will fetch the logs from elastic db
Username - The user for whom the logs are to be fetched
StartDate-EndDate - Range of dates between which logs are needed. format yyyy-mm-dd
SearchAfter - To be used for pagination, to paginate caller will have to pass the value of @timestamp field of the last record to get the logs next to it
DataSizePerPage - Default value is 10, if caller wants to change it then pass the value explicitly
LogType -
1) All- For All logs 2) Login - All login logs 3) Logout - All logout logs 4) LoginLogout - All login-logout logs
Parameters
Name Located in RBAC body
Description
Required
ElasticSearchRequest Yes
Schema model.ElasticSearchRequest
97
98
Responses
Code
200 400 500
Description
OK Bad Request Processing Errors
OPERATIONS HUB RBAC API
Schema model.ElasticSearchResponse model.GenericResponse model.GenericResponse
/v1/identitymgmt/exportldap
GET Summary This api will export ldap configuration
Description This api will export ldap configuration
Responses
Code
200 400 500
Description
OK Bad Request Internal Server Error
Schema
model.LdapConfigObject model.GenericResponse model.GenericResponse
/v1/identitymgmt/exportum
GET Summary This api will export all the local users
Description This api will export all the local users
Responses
Code
200 400 500
Description
OK Bad Request Internal Server Error
Schema
model.UMExportResponse model.GenericResponse model.GenericResponse
/v1/identitymgmt/group
GET Summary List all groups
VERSION: 1.0
99
Description This api can be used to get list of all the groups
Responses
Code 200 400 500
Description
OK Bad Request Processing Errors
Schema
model.GroupListResponse model.GenericResponse model.GenericResponse
/v1/identitymgmt/importldap
POST Summary This api will import ldap configuration
Description This api will import ldap configuration
Parameters
Name Located in LDAP body
Description LdapConfigObject
Required Yes
Schema model.LdapConfigObject
Responses
Code 200 400 500
Description
OK Bad Request Internal Server Error
Schema
model.GenericResponse model.GenericResponse model.GenericResponse
/v1/identitymgmt/importum
POST Summary This api will import UM data
Description This api will import UM data
Parameters
100
Name Located in RBAC body
OPERATIONS HUB RBAC API
Description
Required
UMExportResponse Yes
Schema model.UMExportResponse
Responses
Code 200 400 500
Description
OK Bad Request Internal Server Error
Schema
model.GenericResponse model.GenericMapResponse model.GenericMapResponse
/v1/identitymgmt/ldap/config
GET Summary This api will get the ldap configuration in SMI
Description This api will get the ldap configuration in SMI
Responses
Code
200 400 500
Description
OK Bad Request Processing Errors
Schema
model.LdapConfigObject model.GenericResponse model.GenericResponse
PUT Summary This api will update the ldap config in SMI
Description This api will update the ldap config in SMI
Parameters
Name Located in LDAP body
Description LdapConfigObject
Required Yes
Schema model.LdapConfigObject
Responses
VERSION: 1.0
Code
200 400 500
Description
Ldap Config updated successfully Bad Request Processing Errors
101
Schema model.GenericResponse model.GenericResponse model.GenericResponse
POST Summary This api will add ldap configuration in SMI
Description This api will add ldap configuration in SMI
Parameters
Name Located in LDAP body
Description LdapConfigObject
Required Yes
Schema model.LdapConfigObject
Responses
Code 200 400 500
Description
Ldap config added successfully Bad Request Processing Errors
Schema
model.GenericResponse model.GenericResponse model.GenericResponse
DELETE Summary This api will delete the ldap config in SMI
Description This api will delete the ldap config in SMI
Parameters
Name Located in LDAP body
Description
Required
LdapDeleteConfigRequeYsets
Schema model.LdapDeleteConfigRequest
Responses
Code 200 400
Description
Ldap Config deleted successfully Bad Request
Schema
model.GenericResponse model.GenericResponse
102
Code 500
Description Processing Errors
OPERATIONS HUB RBAC API
Schema model.GenericResponse
PATCH Summary This api will update the ldap config in SMI
Description This api will update the ldap config in SMI
Parameters
Name Located in LDAP body
Description LdapConfigObject
Required Yes
Schema model.LdapConfigObject
Responses
Code 200 400 500
Description
Ldap Config added successfully Bad Request Processing Errors
Schema
model.GenericResponse model.GenericResponse model.GenericResponse
/v1/identitymgmt/ldap/validate/current-config
POST Summary This api will validate existing ldap configuration
Description This api will validate existing ldap configuration
Parameters
Name Located in LDAP body
Description
Required
CurrentSecurityConfig Yes
Schema model.CurrentSecurityConfig
Responses
Code 200
Description
LDAP server successfully authenticated the user
Schema model.GenericResponse
VERSION: 1.0
Code
400 408 422
500 504
Description
Wrong username or password Timeout on search for user objects A syntactically invalid DN was specified Could not connect to AD server Timeout on AD server
103
Schema model.GenericResponse model.GenericResponse model.GenericResponse
model.GenericResponse model.GenericResponse
/v1/identitymgmt/ldap/validate/new-config
POST Summary This api will validate new ldap configuration
Description This api will validate new ldap configuration
Parameters
Name Located in LDAP body
Description NewSecurityConfig
Required Yes
Schema model.NewSecurityConfig
Responses
Code 200
400 408 422
500 504
Description
LDAP server successfully authenticated the user Wrong username or password Timeout on search for user objects A syntactically invalid DN was specified Could not connect to AD server Timeout on AD server
Schema model.GenericResponse
model.GenericResponse model.GenericResponse model.GenericResponse
model.GenericResponse model.GenericResponse
/v1/identitymgmt/loglevel
POST Summary API to change the loglevel
Description This Api can be used to change the log level in run time
104
Parameters Name Located in RBAC body
OPERATIONS HUB RBAC API
Description LogLevelRequest
Required Yes
Schema model.LogLevelRequest
Responses
Code 200 400 500
Description
Assigned succesfully Bad Request Processing Errors
Schema
model.GenericResponse model.GenericResponse model.GenericResponse
/v1/identitymgmt/password-age
PATCH Summary Change password expiry
Description This api can be used to change the expiry duration of a password for an existing user
Parameters
Name Located in RBAC body
Description
Required
PasswordAgeRequest Yes
Schema model.PasswordAgeRequest
Responses
Code 200 400 500
Description
Password age changed successfully Bad Request Processing Errors
Schema
model.GenericResponse model.GenericResponse model.GenericResponse
/v1/identitymgmt/password-length
PATCH Summary This api can be used to update the password length.
Description New password length to update
VERSION: 1.0
Parameters Name Located in RBAC body
105
Description
Required
ChangePasswordLengthYReesquest
Schema model.ChangePasswordLengthRequest
Responses
Code 200 400 500
Description
Updated successfully Bad Request Processing Errors
Schema
model.GenericResponse model.GenericResponse model.GenericResponse
/v1/identitymgmt/reset-password
PATCH Summary Reset user login password.
Description This api can be used to reset password for an existing user
Parameters
Name Located in RBAC body
Description
Required
ResetPasswordRequest Yes
Schema model.ResetPasswordRequest
Responses
Code
200 400 500
Description
Password Updated succesfully Bad Request Processing Errors
Schema
model.GenericResponse model.GenericResponse model.GenericResponse
/v1/identitymgmt/self-password
PATCH Summary User can change self login password.
Description This api can be used to change self password
106
Parameters Name Located in RBAC body
OPERATIONS HUB RBAC API
Description
Required
ChangeSelfPasswordReqYueesst
Schema model.ChangeSelfPasswordReque
Responses
Code
200 400 500
Description
Password Updated succesfully Bad Request Processing Errors
Schema
model.GenericResponse model.GenericResponse model.GenericResponse
/v1/identitymgmt/user
GET Summary List all the users.
Description This api can be used to get list of all the users and the associated details.
Responses
Code
200 400 500
Description
OK Bad Request Processing Errors
Schema
model.UserDetailListResponse model.GenericResponse model.GenericResponse
POST Summary This api will add a new user
Description This api will add a new user
Parameters
Name Located in RBAC body
Description
Required
CreateUserRequest Yes
Schema model.CreateUserRequest
VERSION: 1.0
Responses
Code
200 400 500
Description
User added successfully Bad Request Processing Errors
107
Schema model.GenericResponse model.GenericResponse model.GenericResponse
/v1/identitymgmt/user-group
POST Summary Map user to a group
Description This api can be used to assign user to a group, This is an additive operation, which will give previleges to the user to perform crud operations.
Parameters
Name Located in RBAC body
Description UserGroupRequest
Required Yes
Schema model.UserGroupRequest
Responses
Code
200 400 500
Description
Assigned succesfully Bad Request Processing Errors
Schema
model.GenericResponse model.GenericResponse model.GenericResponse
PATCH Summary Remove a user from group
Description This api is selective operation can be used to remove a set of privileges for a user by unassigning a group for the user.
Parameters
Name Located in RBAC body
Description UserGroupRequest
Required Yes
Schema model.UserGroupRequest
108
Responses
Code 200 400 500
Description
Unassigned successfully Bad Request Processing Errors
OPERATIONS HUB RBAC API
Schema model.GenericResponse model.GenericResponse model.GenericResponse
/v1/identitymgmt/user/{username}
GET Summary Details of a user
Description This api can be used to get all the details of a user queried against a username
Parameters
Name
Located in Description Required Schema
username path
username Yes
string
Responses
Code
200 400 500
Description
OK Bad Request Processing Errors
Schema
model.UserDetailResponse model.GenericResponse model.GenericResponse
DELETE Summary Delete user by username
Description This api can be used to delete user against a username
Parameters
Name
Located in Description Required Schema
username path
username Yes
string
VERSION: 1.0
Responses
Code 200 400 500
Description
User deleted successfully Bad Request Processing Errors
109
Schema model.GenericResponse model.GenericResponse model.GenericResponse
/v1/identitymgmt/user/{username}/namespace/{namespace}
GET Summary Details of a user from required namespace
Description This api can be used to get all the details of a user queried against a username for requird namespace
Parameters
Name
Located in Description Required Schema
username path
username Yes
string
Responses
Code 200 400 500
Description
OK Bad Request Processing Errors
Schema
model.UserDetailResponse model.GenericResponse model.GenericResponse
Models
model.ChangePasswordLengthRequest
Name Type Description Required
length integer
No
model.ChangeSelfPasswordRequest
Name
Type Description Required
confirm_password string
No
110
OPERATIONS HUB RBAC API
Name
current_password namespace new_password username
Type
string string string string
Description
Required
No No No No
model.CreateUserRequest
Name
groupList password username
Type
[ string ] string string
Description
Required
No No No
model.CurrentSecurityConfig
Name
password username
Type
string string
Description
Required
No No
model.ElasticSearchRequest
Name
dataSizePerPage enddate logType searchafter startdate username
Type
string string string string string string
Description
Required
No No No No No No
model.ElasticSearchResponse
Name
_shards hits took
Type
object object integer
Description
Required
No No No
VERSION: 1.0
111
model.GenericMapResponse
Name Type Description Required
message object
No
model.GenericResponse
Name Type Description Required
message string
No
model.GroupListResponse
Name
Type
Description Required
groupList [ string ]
No
model.LdapConfigObject
Name
base-dn bind-dn group-attr groupmapping
ldap-filter ldapserver-url ldapusernamedomain
Type
Description
string string string [ model.LdapGroupMappingObject ] string string
string
Required No No No No
No No
No
model.LdapDeleteConfigRequest
Name Type Description Required
url string
No
112
OPERATIONS HUB RBAC API
model.LdapGroupMappingObject
Name
group ldap-group
Type
string string
Description
Required
No No
model.LogLevelRequest
Name logLevel
Type string
Description
"panic", "fatal", "error", "warn", "warning", "info", "debug", "trace"
Required No
model.NewSecurityConfig
Name
base-dn bind-dn group-attr groupmapping
ldap-filter ldapserver-url ldapusernamedomain password username
Type
Description
string string string [ model.LdapGroupMappingObject ] string string
string
string string
Required No No No No
No No
No
No No
model.PasswordAgeRequest
Name
password_expire_days username
Type
string string
Description in days
Required
No No
model.ResetPasswordRequest
VERSION: 1.0
113
Name
confirm_password new_password username
Type
string string string
Description
Required
No No No
model.UMExportResponse
Name
genericPassword userList
Type
string [ model.UserDetails ]
Description
Required
No No
model.UserDetailListResponse
Name
Type
Description
userDetailList[ model.UserDetailResponse ]
Required No
model.UserDetailResponse
Name
groupList passwordExpiryPeriod username
Type
[ string ] string string
Description
Required
No No No
model.UserDetails
Name
groupList password username
Type
[ string ] string string
Description
Required
No No No
model.UserGroupRequest
Name
Type
Description Required
groupList [ string ]
No
114
OPERATIONS HUB RBAC API
Name
Type
username string
Description Required No
Operations Hub Tag Management API
Version: 1.0
Contact information: Operations Hub API Support
/v1/tags
GET Summary List of tags.
Description API to retrieve list of all the tags. For large scale data of tags use rest client.
Responses
Code 200
500
Description list of all the tags
internal server error
Schema
tag.ApiResponse & object tag.ApplicationError
/v1/tags/create-assign-tags
POST Summary Create tags or associate tag to entity instances.
Description API operations: 1. To create one or multiple tags if entity instance details are empty.
115
116
OPERATIONS HUB TAG MANAGEMENT API
2. To create one or multiple tags and assign tag to one or multiple entity instances.
3. To Assign the existing tag to one or multiple entity instances.
Parameters
Name Tags
Located in body
Description
Entity Uuid Tag List
Required Yes
Schema
[ tag.EntityUuidTag ]
Responses
Code 201 400 500
Description tags are created bad request internal server error
Schema
tag.ApiResponse & object tag.ApplicationError & object tag.ApplicationError
/v1/tags/delete-tag/{tag-name}
DELETE Summary Delete tag object if not associated to an entity.
Description API to delete tag object if not associated to entity instance.
Parameters
Name
Located in Description Required Schema
tag-name path
Tag name Yes
string
Responses
Code 200
400 404
Description delete success
bad request not found
Schema
tag.ApiResponse & object tag.ApplicationError tag.ApplicationError
VERSION: 1.0
Code 500
Description internal server error
117
Schema tag.ApplicationError
/v1/tags/entity-instance
POST
Summary Lists tags associated for the given entity and entity instances (i,e entities uuids).
Description API to retrieve tags associated for the given entity and entity instances (i,e entities uuids)
Parameters
Name
EntityUuiddetails
Located in body
Description
Required
Entity Uuid details Yes
Schema tag.EntityUuid
Responses
Code 200
400
404 500
Description list of all the tags
bad request
not found internal server error
Schema
tag.ApiResponse & object tag.ApplicationError & object tag.ApplicationError tag.ApplicationError
/v1/tags/export
GET Summary exports tag data
Description API to export tag data
Responses
118
Code 200 500
OPERATIONS HUB TAG MANAGEMENT API
Description list of tags
internal server error
Schema
tag.ApiResponse & object tag.ApplicationError
/v1/tags/import
POST Summary imports tag data
Description API to import tag data
Parameters
Name
TagData
Located in body
Description tag data
Required Yes
Schema tag.ExportTagData
Responses
Code 200
400 500
Description list of tags
bad request internal server error
Schema
tag.ApiResponse & object tag.ApplicationError tag.ApplicationError
/v1/tags/remove-tag-association
POST Summary Remove one or multiple tags association for an entity instance.
Description API to remove one or multiple tags association for an entity instance.
Parameters
VERSION: 1.0
Name
EntityTaguuid
Located in body
Description
Entity Tag Uuid details
Required Yes
119
Schema tag.EntityTagDetails
Responses
Code 200
400 404 500
Description
Remove tag association from entity success bad request not found internal server error
Schema
tag.ApiResponse & object tag.ApplicationError tag.ApplicationError tag.ApplicationError
/v1/tags/search/{tag-name}
GET
Summary Lists tags that matches with the search string tag-name with the selected search format of requested max records.
Description API to list tags of requested max size that matches with the search string tag-name with the selected search format.
1. API returns list of tags which has search string as substring when the search format is overall.
2. API returns list of tags which starts with search string name when the search format is starts-with.
3. API returns description saying refine search, if the records are more than the requested max-record value.
Parameters
Name
tag-name search-format max-records
Located in
path query query
Description
search string tag name Search format max-records eg:(1,2,3,. . . )
Required
Yes Yes Yes
Schema
string string string
Responses
120
Code 200
400 500
OPERATIONS HUB TAG MANAGEMENT API
Description list of tags
bad request internal server error
Schema
tag.ApiResponse & object tag.ApplicationError tag.ApplicationError
/v1/tags/{entity}
GET Summary Lists tags of an entity for a given cursor of requested max-records.
Description API returns entity instance and associated tags for the given entity name and also the next cursor if all data can't be served in a call. API gaurantee:
1) API will return all the entity instance and associated tags that were present in the server from the start to the end of a full iteration.
2) API will not return entity key instance and associated tag that was not present in the server from the start to the end of a full iteration.
3) No gaurantee that every cursor iteration will give same number of elements as the value of requested max-records but all the elements will be fetched when end of cursor is reached.
4) The iteration starts with cursor value 0 and ends when the cursor returned by the server is 0. Initially, the cursor should be 0 and at end of every call with requested max-records, the server returns an updated cursor called next-cursor the user needs to use this next-cursor as a cursor argument to fetch the next set of records.
Parameters
Name
entity cursor max-records
Located in
path query query
Description
entity name cursor eg:(0. . . next-cursor) max-records eg:(1000. . . 15000)
Required
Yes Yes No
Schema
string string string
Responses
Code 200
400 404
Description list of all the tags
bad request not found
Schema
tag.ApiResponse & object tag.ApplicationError tag.ApplicationError
VERSION: 1.0
Code 500
Description internal server error
121
Schema tag.ApplicationError
Models
tag.ApiResponse
Name code
response
Type integer
object
status
string
Description
Required
add response status code
No
e.g. http.StatusOK // 200
add response body e.g {
No
"action:"delete",
"description": "delete
operation success"}
add response status code
No
text e.g. Success, Partial
Success using
http.StatusText(http.StatusOK)
tag.ApplicationError
Name code
Type integer
description string
meta status
string string
trace
string
Description
Required
add response status code
No
e.g. http.StatusBadRequest
// 400
add user friendly error
No
description to send as part of
api response
add some more meta info for No
the operation
add response status code
No
text e.g. Bad Request using
http.StatusText(http.StatusBadRequest)
add stack trace if any
No
tag.EntityTag
Name
entity entity-uuid
Type
string string
Description
Required
No No
122
OPERATIONS HUB TAG MANAGEMENT API
Name
Type
Description Required
tag-details [ tag.TagBasicDetails ]
No
tag.EntityTagDetails
Name
entity entity-uuid tag-ids
Type
string string [ string ]
Description
Required
Yes Yes No
tag.EntityTagUuid
Name
entity-instance tag-ids
Type
string [ string ]
Description
Required
No No
tag.EntityUuid
Name
entity entity-uuid
Type
string [ string ]
Description
Required
No No
tag.EntityUuidTag
Name
entity-details tag-name
Type
tag.EntityUuid string
Description
Required
No Yes
tag.ExportTagData
Name
entityinstances
opshubregisteredentities
Type
Description
[ tag.EntityTagUuid ] [ string ]
Required No
No
VERSION: 1.0
Name tags
Type
Description
[ tag.TagBasicDetails ]
123
Required No
tag.GetTagsForEntityResponse
Name
entity-tag-details next-cursor total-size
Type
[ tag.EntityTag ] integer integer
Description
Required
No No No
tag.TagBasicDetails
Name
colorcode colorid id tagName
Type
string integer string string
Description
Required
No No No No
tag.TagResponse
Name
invalid-uuids valid-uuids
Type
[ string ] [ tag.UuidTag ]
Description
Required
No No
tag.TagsWithUid
Name
tags uuid
Type
[ tag.TagBasicDetails ] string
Description
Required
No No
tag.UuidTag
Name
Type
entity-uuid string
Description Required No
124
OPERATIONS HUB TAG MANAGEMENT API
Name
Type
Description Required
tag-details [ tag.TagBasicDetails ]
No
Operations Hub Infra Alert Management API
This is Operations Hub KPI Alertmanagement service.
Version: 1.0
Contact information: Operations Hub API Support
Security
AuthHeader
apiKey
Name In
API Key
Authorization header
/v1/alerts
GET Summary Get the Alertmanager Alert List
Description Get the list of alerts("firing" and/or "resolved" status) from the Alertmanager.
Parameters
125
126
OPERATIONS HUB INFRA ALERT MANAGEMENT API
Name status
Located in query
limit query
offset query
sort-by query
order- query by
Description
Filter alerts by status, and if status is empty will return all alerts. Query limit from DB. Query offset from DB. Query sory by the parameter from DB. Query order from DB.
Required No
No No No No
Schema string
integer integer string string
Responses
Code Description Schema
200 OK
model.AlertGetEntry
/v1/alerts/groups
GET Summary Get the Alertmanager Alert Group List
Description Get the list of alert groups from the Alertmanager
Responses
Code Description Schema
200 OK
model.AlertGroupGetInfo
/v1/alerts/groups/{name}
GET Summary Get the Alertmanager Alert Group
Description Get one alert group by group name from the Alertmanager
Parameters
VERSION: 1.0
127
Name Located in Description
Required Schema
name path
Alert Group Name Yes
string
Responses
Code Description Schema
200 OK
model.AlertGroupGetInfo
PUT Summary Set the Alertmanager Alert Group
Description Set one alert group by group name to the Alertmanager.
Parameters
Name Located in name path AlertGroupbody
Description
Alert Group Name Alert Group Setting
Required
Yes Yes
Schema
string model.AlertGroupSetInfo
Responses
Code
200 400
Description
OK Bad Request
Schema
model.AlertGroupGetInfo string
/v1/alerts/{id}
GET Summary Get the Alertmanager Alert
Description Get one alert by alert ID from the Alertmanager.
Parameters
Name Located in Description Required Schema
id
path
Alert ID Yes
string
128 Responses
OPERATIONS HUB INFRA ALERT MANAGEMENT API
Code Description Schema
200 OK
model.AlertGetInfo
/v1/alerts/{id}/ack
PUT Summary Ack the Alertmanager Alert
Description Ack one alert by alert ID to the Alertmanager.
Parameters
Name
id Alert
Located in
path body
Description
Alert ID Alert Ack Information
Required
Yes Yes
Schema
string model.AlertSetInfo
Responses
Code
200 400
Description
OK Bad Request
Schema
model.AlertGetInfo string
/v1/cluster/health
GET Summary Get the health of cluster
Description This API provides health of the cluster for specified alert-groups. Query parameter "alert-groups" is optional, multiple comma separated alertgroups can be specified in the query parameter field. The response will have list of alerts, list of pods not in ready state, severity and description for the specified alert-groups. Possible values of "severity" are -
1) "Clear" - Indicating cluster has no alerts 2) "Minor" - Indicating some non-essential pods are not running
VERSION: 1.0
129
3) "Critical" - Indicating cluster has critical alerts
To know the possible values of alert-groups, use the following API : curl -X GET "https:///api/alertmanager/v1/alerts/groups" -H "accept: application/json"
Parameters
Name
alertgroups
Located in query
Description
Alert groups to watch for. Note : If alert-groups not specified, all critical alerts in system will be considered
Required No
Schema string
Responses
Code
200 500
Description
OK Internal Server Error
Schema
model.HealthStatus string
/v1/loglevel
GET Summary Get OpsHub KPI Alertmanagement Log Level
Description Get Get OpsHub KPI Alertmanagement Log Level
Responses
Code Description Schema
200 OK
model.LogLevel
PUT Summary Set OpsHub KPI Alertmanagement Log Level Description Set OpsHub KPI Alertmanagement Log Level Parameters
130
OPERATIONS HUB INFRA ALERT MANAGEMENT API
Name
Located in Description Required Schema
LogLevel body
Log Level Yes
model.LogLevel
Responses
Code
200 400
Description
OK Bad Request
Schema
model.LogLevel string
/v1/smtp
GET Summary Get the Alertmanager SMTP Configuration
Description Get the configuration for SMTP that is used to forward alerts for notifications.
Responses
Code Description Schema
200 OK
model.AlertConfigGetInfo
PUT Summary Set the Alertmanager SMTP Configuration
Description Set the configuration for SMTP so that alertmanager can forward alerts for notifications through the configured SMTP server.
Parameters
Name Located in Config body
Description
Alertmanager SMTP Configuration
Required Yes
Schema model.AlertConfigSetInfo
Responses
VERSION: 1.0
131
Code
200 400
Description
OK Bad Request
Schema
model.AlertConfigGetInfo string
Models
model.AlertConfigGetInfo
Name
auth-identity auth-password auth-secret auth-username create-time from hello host require-tls update-time
Type
string string string string string string string string boolean string
Description
Required
No No No No No No No No No No
model.AlertConfigSetInfo
Name
auth-identity auth-password auth-secret auth-username from hello host require-tls
Type
string string string string string string string boolean
Description
Required
No No No No No No No No
model.AlertGetEntry
Name
alerts limit offset total
Type
[ model.AlertGetInfo ] integer integer integer
Description
Required
No No No No
132
OPERATIONS HUB INFRA ALERT MANAGEMENT API
model.AlertGetInfo
Name
acked acked-time alert-group alert-name comment create-time creator description end-time expire-time id severity start-time status summary update-time
Type
boolean string string string string string string string string string string string string string string string
Description
Required
No No No No No No No No No No No No No No No No
model.AlertGroupGetInfo
Name
alert create-time enabled name sendto update-time
Type
[ string ] string boolean string [ string ] string
Description
Required
No No No No No No
model.AlertGroupSetInfo
Name
enabled sendto
Type
boolean [ string ]
Description
Required
No No
model.AlertSetInfo
Name
Type Description Required
acked-time string
No
VERSION: 1.0
133
Name
comment creator expire-time
Type
string string string
Description
Required
No No No
model.HealthStatus
Name
Type
Description
alerts
description not-readypods
severity
[ model.AlertGetInfo ] string [ model.NotReadyPods ] string
Required No
No No
No
model.LogLevel
Name
Type Description Required
Log Level string
No
model.NotReadyPods
Name
namespace node pod-ip pod-name pod-restarts
Type
string string string string integer
Description
Required
No No No No No
134
OPERATIONS HUB INFRA ALERT MANAGEMENT API
Operations Hub Configuration Backup and Restore
operations hub config export/import server.
Version: 1.0
/v1/config/export
GET Summary API to export operations hub configuration
Description The exported configuration will be downloaded in the tar.gz archive. API does not support partial export if any of the components fail to export complete export operation will be failed.
Parameters
Name
Located in Description Required Schema
status_id query
123456789 No
string
Responses
Code
400 404 500
Description
Bad Request Not Found Internal Server Error
Schema
model.ApiResponse model.ApiResponse model.ApiResponse
135
136 OPERATIONS HUB CONFIGURATION BACKUP AND RESTORE
/v1/config/import
POST Summary API to import operations hub configuration
Description operations hub configuration in archived file can be imported through this API
Parameters
Name
config-file status_id
Located in
formData query
Description
config archive file 123456789
Required
Yes No
Schema
file string
Responses
Code
200 400 404 500
Description
OK Bad Request Not Found Internal Server Error
Schema
model.ApiResponse model.ApiResponse model.ApiResponse model.ApiResponse
/v1/config/operation/status
GET
Summary API to fetch status of operations hub config export/import operation
Description API used to know the status of ongoing operations hub config export/import operation
Parameters
Name
Located in Description Required Schema
status_id query
123456789 No
string
Responses
VERSION: 1.0
Code
200 400 404 500
Description
OK Bad Request Not Found Internal Server Error
137
Schema model.OperationStatusResponse model.ApiResponse model.ApiResponse model.ApiResponse
/v1/tac/create
POST Summary create tac debug package
Description Triggers TAC debug package file generation.
Note: start-time/end-time example in UTC: 2022-05-10T07:20:50Z starttime/end-time examples with UTC offset : 2022-05-10T07:20:50+05:30
Parameters
Name
start-time end-time
Located in
query query
Description
start-time for log collection end-time for log collection
Required
Yes Yes
Schema
dateTime dateTime
Responses
Code 200 400 422 500
Description
OK Bad Request Unprocessable Entity Internal Server Error
Schema
model.Tac model.ErrorResponse model.ErrorResponse model.ErrorResponse
/v1/tac/delete
DELETE Summary delete tac debug package
Description Delete tac debug package for the given tac-id
Parameters
138 OPERATIONS HUB CONFIGURATION BACKUP AND RESTORE
Name tac-id
Located in query
Description
tac-id for which tac debug content to be deleted
Required Yes
Schema string
Responses
Code
200 400 404 422 500
Description
OK Bad Request Not Found Unprocessable Entity Internal Server Error
Schema
model.StringResponse model.ErrorResponse model.ErrorResponse model.ErrorResponse model.ErrorResponse
/v1/tac/download
GET Summary download tac debug package
Description Download the tac debug package for the given tacId
Parameters
Name tac-id
Located in query
Description
tac-id for which tac debug package to be downloaded
Required Yes
Schema string
Responses
Code
200 400 404 422 500
Description
OK Bad Request Not Found Unprocessable Entity Internal Server Error
Schema
model.StringResponse model.ErrorResponse model.ErrorResponse model.ErrorResponse model.ErrorResponse
/v1/tac/list
GET Summary list tac debug packages
VERSION: 1.0
139
Description Get the list of tac debug packages available
Responses
Code 200 500
Description
OK Internal Server Error
Schema
model.ListTac model.ErrorResponse
/v1/tac/status
GET Summary ongoing tac debug status
Description Check status of ongoing tac debug package
Responses
Code
200 500
Description
OK Internal Server Error
Schema
model.StatusTac model.ErrorResponse
Models
model.ApiResponse
Name code
response
Type integer
status
string
Description
Required
add response status code
No
e.g. http.StatusOK // 200
add response body e.g {
No
"action:"delete",
"description": "delete
operation success"}
add response status code
No
text e.g. Success, Partial
Success using
http.StatusText(http.StatusOK)
model.ErrorResponse
140 OPERATIONS HUB CONFIGURATION BACKUP AND RESTORE
Name Type Description
Required
message string Example: "error message" No
model.ListTac
Name Type
Description Required
tac-ids [ string ]
No
model.OperationStatusResponse
Name
operationStatus operationType
Type
object string
Description Example: "export/import"
Required
No No
model.StatusResponse
Name
errMsg status
Type
string string
Description
Required
No No
model.StatusTac
Name
in-progress-tac-id status
Type
string string
Description
Required
No No
model.StringResponse
Name Type Description
Required
message string Example: "success message" No
model.Tac
Name Type Description Required
tac-id string
No
Operations Hub Scheduler
operations hub task scheduler server.
Version: 1.0
/v1/scheduler/create
POST Summary CreateSchedule API is used to schedule tasks
Description Scheduling request is registered using this API, It can be a cron/adhoc/timeseries based scheduilng
Parameters
Name Located in Template body
Description
Required
create new schedule Yes
Schema model.Schedule
Responses
Code 200 400 404 500
Description
OK Bad Request Not Found Internal Server Error
Schema
model.ApiResponse model.StringErrResponse model.StringErrResponse model.StringErrResponse
/v1/scheduler/delete
POST Summary DeleteSchedule API is called to cancel/delete active schedule/task
141
142
OPERATIONS HUB SCHEDULER
Description This API will delete all active/standby schedule and delete associated tasks and tasks config from DB
Parameters
Name
Located in Description Required Schema
scheduleID query
scheduleID Yes
string
Responses
Code
200 400 404 500
Description
OK Bad Request Not Found Internal Server Error
Schema
model.ApiResponse model.StringErrResponse model.StringErrResponse model.StringErrResponse
/v1/scheduler/suspend
POST Summary SuspendSchedule API is called to suspend an active schedules/task
Description This API will cancel all active/standby schedule and set the is_suspended param in the DB for this schedule
Parameters
Name
Located in Description Required Schema
scheduleID query
scheduleID Yes
string
Responses
Code
200 400 404 500
Description
OK Bad Request Not Found Internal Server Error
Schema
model.ApiResponse model.StringErrResponse model.StringErrResponse model.StringErrResponse
/v1/scheduler/task/status
GET Summary GetTaskStatus API is called to get individual task status
VERSION: 1.0
143
Description This API will give the task execution status along with task response if any.
Parameters
Name Located in Description Required Schema
taskID query
taskID
Yes
string
Responses
Code 200 400 404 500
Description
OK Bad Request Not Found Internal Server Error
Schema
model.TaskExecutionStatusAll model.StringErrResponse model.StringErrResponse model.StringErrResponse
/v1/scheduler/tasks
GET Summary ListAllScheduleTask lists all schedules and tasks
Description ListAllScheduleTask lists all schedules and their correponding tasks in the system and their current status
Responses
Code
200 400 404 500
Description
OK Bad Request Not Found Internal Server Error
Schema
model.ListScheduleConfig model.StringErrResponse model.StringErrResponse model.StringErrResponse
/v1/scheduler/update
POST Summary UpdateSchedule API is called to modify the schedule of exiting tasks
Description Existing schedule configuration is updated using this API
144
Parameters Name Located in Template body
OPERATIONS HUB SCHEDULER
Description update schedule
Required Yes
Schema model.UpdateScheduleConfig
Responses
Code
200 400 404 500
Description
OK Bad Request Not Found Internal Server Error
Schema
model.ApiResponse model.StringErrResponse model.StringErrResponse model.StringErrResponse
Models
model.APITaskConfig
Name
Type
Description
httpHeaders model.HeaderMap
httpMethod string
Enum: "GET", "POST",
"PUT", "DELETE", "PATCH"
payload string
TODO check size in API call
validation matching DB size
url
string
Required Yes Yes
Yes
Yes
model.ApiResponse
Name code
response
Type integer
status
string
Description
Required
add response status code
No
e.g. http.StatusOK // 200
add response body e.g {
No
"action:"delete",
"description": "delete task
success"}
add response status code
No
text e.g. Success, Partial
Success using
http.StatusText(http.StatusOK)
VERSION: 1.0
145
model.CronSchedule
Name
Type Description Required
cronExpression string
No
model.CyclicalSchedule
Name
Type
scheduleEnd string scheduleIntervsatrl ing scheduleTimestring
Description
1s,1m,hr,day,week,month,yea RFC-3339 time format in array,2022-0101T07:20:50.52Z
Required
No No No
model.DiscreteTimeSchedule
Name Type
Description Required
intervals [ string ]
No
model.HeaderMap
Name
Type Description Required
model.HeaderMap object
model.ListScheduleConfig
Name
Type
Description
scheduleTaskC[ onfig model.ScheduleTaskDbConfig ]
Required Yes
model.MessageTaskConfig
Name
headers payload
Type
Description
model.HeaderMap
string
TODO check size in API call
validation matching DB size
Required
No Yes
146
Name
Type
producerTypestring
topicName string
OPERATIONS HUB SCHEDULER
Description
Default to wait for ack/SYNC call
Required Yes
Yes
model.Schedule
Name
Type
Description
scheduleConfimg odel.ScheduRleeCqounirfiegd: true taskConfig model.TaskLisRtequired: true
Required
Yes Yes
model.ScheduleConfig
Name
Type
Description
ConcurrentExbeocuolteioan
cronScheduleCmoondfiegl.CronSchedule
cyclicalSchedumleoCdoenl.fiCgyclicalSchedule
discreteTimeSmchoeddeul.lDeCisocnrefitgeTimeSchedule
isSuspended boolean Default is false
retryCount integer
Default to 0
retryInterval integer
Default to 0. unit is seconds
retry_policy string
schedule_descsrtirpintigon
schedule_groustpring
schedule_namsetring
Required: true
schedule_typestring
Enum: "cron", "discrete",
"interval"
Required
No No No No No No No No No Yes Yes Yes
model.ScheduleDbConfig
Name
Type
Description
last_trigger_straitneg
Enum: "Scheduled",
"Successful", "Failed"
last_trigger_sttimrineg
next_trigger string
scheduleConfimg odel.ScheduleConfig
schedule_id integer
timeInitiated string
timeUpdated string
trigger_user string
Required
No
No No No No No No No
VERSION: 1.0
Name
Type
trigger_user_srtorlieng
Description
147
Required No
model.ScheduleTaskDbConfig
Name
Type
Description
scheduleConfimg odel.ScheduleDbConfig
tasks
[
model.TaskDbConfig
]
Required
Yes Yes
model.StringErrResponse
Name
Type Description
Required
error_message string Example: "reason of failure" No
model.TaskCommonConfig
Name
task_description task_name task_priority task_type
Type
string string integer string
Description Enum: "api", "messaging"
Required
No Yes No Yes
model.TaskConfig
Name
Type
Description
apiTask model.APITaskConfig messagingTasmk odel.MessageTaskConfig taskData model.TaskCommonConfig
Required
No No Yes
model.TaskDbConfig
Name
schedule_id taskConfigData
Type
integer model.TaskConfig
Description
Required
No No
148
Name task_id
Type integer
OPERATIONS HUB SCHEDULER
Description Required No
model.TaskExecutionDbStatus
Name
id status
Type
Description
integer model.TaskExecutionStatus
Required
No No
model.TaskExecutionStatus
Name
apiResponse taskExecutionState taskId triggerRetryCount triggerTime triggerUser triggerUserRole
Type
string string integer integer string string string
Description
Required
Yes Yes Yes No Yes Yes Yes
model.TaskExecutionStatusAll
Name
Type
Description
taskAllStatus[ model.TaskExecutionDbStatus ]
Required No
model.TaskList
Name Type
Description Required
taskList [ model.TaskConfig ]
Yes
model.UpdateScheduleConfig
Name
Type
Description
scheduleConfimg odel.ScheduleConfig scheduleID integer
Required
Yes Yes
VERSION: 1.0
Name tasks
Type
Description
[ model.UpdateTaskConfig ]
149
Required No
model.UpdateTaskConfig
Name
taskConfigData task_id
Type
model.TaskConfig integer
Description
Required
No No
150
OPERATIONS HUB SCHEDULER
LaTeX via pandoc pdfTeX-1.40.24; modified using iText 2.1.7 by 1T3XT