Citrix SD-WAN Orchestrator für Lokal 14.3

API-Leitfaden für Citrix SD-WAN Orchestrator for On-premises

So greifen Sie auf das Citrix SD-WAN Orchestrator for On-premises API-Handbuch auf der Swagger-Benutzeroberfläche zu:

  1. Melden Sie sich beim Citrix SD-WAN Orchestrator for On-premises an und klicken Sie auf ? in der oberen rechten Ecke der Benutzeroberfläche und klicken Sie dann auf API Guide.

    API-Symbol

    Die Details der Swagger-Spezifikation werden angezeigt.

    API-Symbol

  2. Klicken Sie auf die Swagger-Spezifikations-URL, um auf den API-Leitfaden zuzugreifen.

Citrix SD-WAN Orchestrator für lokale APIs durch curl

Voraussetzungen

  • Cloud-Anmeldung
  • Lokaler Login

Führen Sie die folgenden Schritte aus, um Citrix On-premises Orchestrator-APIs über curl zu verwenden:

  1. Cloud-Login: Im Falle einer neuen XVA müssen Sie sich zuerst in der Cloud anmelden.

    curl -k -X POST -H "Content-Type: application/json "https://<onprem-orchestrator-ip>/policy/v1/onprem/cloudLogon –data '{"clientId":"<clientId>","clientSecret":"<clientSecret> ","ccId":"<ccid>", "pop": "<popName>"}'
    

    Die clientIdclientSecret, und ccId können auf der IAM-Seite abgerufen werden.

    Hinweis Stellen Sie

    sicher, dass das Kundenkonto bereits in der Cloud erstellt wurde, bevor Sie die Cloud-Anmeldung versuchen.

  2. Lokale Anmeldung: Führen Sie dann eine lokale Anmeldung durch, um das Auth-Token zu erhalten.

    curl -k -X POST -H "Content-Type: application/json" https://<onprem-orchestrator-ip>/onpm/v1/logon --data '{"username":"admin","password":"<passwordField>"}'
    

    Dies gibt Token und CustomerID als Antwort zurück. Die CustomerID bleibt fest und wird in anderen API-Aufrufen benötigt. Speichern Sie die CustomerID für die spätere Verwendung. Das Token bleibt eine Stunde lang gültig. Später müssen Sie eine neue Anmeldung durchführen.

    Beispiel: Verwenden Sie das Auth-Token und die CustomerID, um andere lokale Citrix APIs auszulösen.

    curl -k -X GET -H "authorization:CWSAuth bearer= <token> " -H "Content-Type: application/json"https://<onprem-orchestrator-ip>/onpm/v1/scope/<customerId>/globalSettings/ntpSettings
    
API-Leitfaden für Citrix SD-WAN Orchestrator for On-premises