Citrix SD-WAN Orchestrator pour site 14.3

Guide d’API pour Citrix SD-WAN Orchestrator pour locaux

Pour accéder au guide de l’API Citrix SD-WAN Orchestrator pour locaux sur l’interface utilisateur Swagger, procédez comme suit :

  1. Connectez-vous au Citrix SD-WAN Orchestrator for On-premises et cliquez sur  ? dans le coin supérieur droit de l’interface utilisateur, puis cliquez sur Guide des API.

    Icône API

    Les détails de la spécification Swagger sont affichés.

    Icône API

  2. Cliquez sur l’URL de la spécification Swagger pour accéder au guide de l’API.

Citrix SD-WAN Orchestrator pour les API locales via curl

Conditions préalables

  • Connexion au cloud
  • Connexion locale

Effectuez les étapes suivantes pour utiliser les API d’orchestrateur sur site Citrix via curl :

  1. Connexion au cloud : dans le cas d’un nouveau XVA, vous devez d’abord vous connecter au cloud.

    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>"}'
    

    Les clientIdclientSecret, et ccId peuvent être obtenus sur la page IAM.

    Remarque

    Assurez-vous que le compte client est déjà créé dans le cloud avant de tenter de vous connecter au cloud.

  2. Connexion locale : effectuez ensuite une connexion locale pour obtenir le jeton d’authentification.

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

    Cela renvoie le token et le CustomerID en réponse. Le CustomerID reste fixe et il est nécessaire dans les autres appels d’API. Enregistrez le CustomerID pour une utilisation ultérieure. Le jeton reste valide pendant une heure. Plus tard, vous devrez effectuer une nouvelle connexion.

    Exemple : utilisez le jeton d’ authentification et l’ ID client pour déclencher d’autres API Citrix locales.

    curl -k -X GET -H "authorization:CWSAuth bearer= <token> " -H "Content-Type: application/json"https://<onprem-orchestrator-ip>/onpm/v1/scope/<customerId>/globalSettings/ntpSettings
    
Guide d’API pour Citrix SD-WAN Orchestrator pour locaux