オンプレミス向けCitrix SD-WAN Orchestrator 14.3

オンプレミス用 Citrix SD-WAN Orchestrator の API ガイド

Swagger UI でオンプレミス用 Citrix SD-WAN Orchestrator API ガイドにアクセスするには:

  1. オンプレミス用 Citrix SD-WAN Orchestrator にログインし、「 ?」をクリックします UI の右上隅にある [ API ガイド] をクリックします。

    API アイコン

    Swagger スペックの詳細が表示されます。

    API アイコン

  2. Swagger 仕様の URL をクリックして、API ガイドにアクセスします。

curl によるオンプレミス API 用 Citrix SD-WAN Orchestrator

前提条件

  • クラウドログイン
  • ローカルログイン

curl を使用して Citrix オンプレミスOrchestrator API を使用するには、次の手順を実行します。

  1. クラウドログイン:新しい XVA の場合は、まずクラウドにログインする必要があります。

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

    clientIdclientSecret、 およびccIdは IAM ページから入手できます。

    注:

    クラウドログオンを試みる前に、顧客アカウントがクラウドですでに作成されていることを確認してください。

  2. ローカルログイン:次に、ローカルログインを実行して認証トークンを取得します。

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

    これにより、 **応答としてトークンとcustomerIDが返されます** 。CustomerID は固定されたままで、他の API 呼び出しで必要です。 後で使用できるように customerID を保存します。トークンは 1 時間有効です。後で、新しいログインを実行する必要があります。

    例: **認証トークンとCustomerIDを使用して** 、他のCitrixオンプレミスAPIを起動します。

    curl -k -X GET -H "authorization:CWSAuth bearer= <token> " -H "Content-Type: application/json"https://<onprem-orchestrator-ip>/onpm/v1/scope/<customerId>/globalSettings/ntpSettings
    
オンプレミス用 Citrix SD-WAN Orchestrator の API ガイド