Cisco APIC REST API ユーザガイド

偏向のない言語

この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。

翻訳について

このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。

マニュアルのコンテンツ

このマニュアル内で検索

ご利用いただける言語

Download Options

Book Title

Cisco APIC REST API ユーザガイド

Chapter Title

一般的なタスクの実行

PDF - Complete Book (2.59 MB) PDF - This Chapter (1.42 MB)
View with Adobe Reader on a variety of devices

検索結果

Updated:: 2017年6月19日

章のタイトル：一般的なタスクの実行

一般的なタスクの実行
ログイン
- 例：XML API を使用したユーザの認証
- 例：JSON API を使用したユーザの認証
テナントの追加
- 例：XML API を使用したテナントの追加
- 例：JSON API を使用したテナントの追加
ユーザの追加
自分のユーザクレデンシャルの変更
3 層アプリケーションのエンドポイントグループおよびコントラクトの導入

一般的なタスクの実行

この章の内容は、次のとおりです。

一般的なタスクの実行
ログイン
テナントの追加
ユーザの追加
自分のユーザクレデンシャルの変更
3 層アプリケーションのエンドポイントグループおよびコントラクトの導入

一般的なタスクの実行

（注）

API を使用した多くの一般的なタスクの詳細な手順については、『Cisco APIC Getting Started Guide』で確認できます。

ここでは、テナントを作成し、アプリケーションを展開するのに必要な一般的なタスクの簡単な例を示します。これらは一般的な手順です。

ログイン：セッションを開き設定タスクを実行します。
テナントの作成：アプリケーションをホストするテナント会社のファブリック内でプライベートドメインを作成します。
ユーザの作成：テナントのアプリケーションを導入し維持するテナントの管理者のアカウントを作成します。
アプリケーションの導入：エンドポイントグループとコントラクトをテナントネットワーク内で設定し、アプリケーションをホストするのに必要なサーバを接続します。

（注）

この例では、JSON および XML 構造が読みやすいように改行、スペース、インデントで展開されています。

API セッションの認証と維持に説明するように、データ構造内の有効なユーザ名とパスワードを aaaLogin API メソッドに送信することによって APIC REST API にログインできます。ログイン成功後に、定期的にセッションを更新する必要があります。

次の例に、XML および JSON を使用して管理者としてログインし、設定時にセッションを更新し、ログアウトする方法を示します。

（注）

現時点で、aaaLogout メソッドは応答を返しますがセッションは終了しません。aaaRefresh メッセージの送信を停止する場合、セッションは更新タイムアウト後に終了します。

例：XML API を使用したユーザの認証
例：JSON API を使用したユーザの認証

例：XML API を使用したユーザの認証

次に、ユーザ名とパスワードを含む XML データ構造を使用してユーザをログインする例を示します。

POST https://192.0.20.123/api/aaaLogin.xml

<aaaUser name="georgewa" pwd="paSSword1"/>

次に、ログイン成功時の応答例を示します。

<imdata>
  <aaaLogin 
    token=
"mk/i+LHZMhFQ47YyMlfZOjmUQQV4PXwFAY/6Dyg5Bm7PC0SVdm
MVWeOlLw69AoNoRVziR8GQeNqPbX/Vu92PxWyPjGx7kOQpoTaUY
P4Y2NkBwRfl5fEDwUe5WnGl3VoBXF4nrc8QSG8N1UWCuIFIyt9O
OzgsLG58fTf4OPCUqQL=" 
    refreshTimeoutSeconds="300" lastName="Washington" firstName="George">
      <aaaUserDomain name="all" rolesR="0" rolesW="2">
        <aaaReadRoles/>
        <aaaWriteRoles>
          <role name="admin"/>
        </aaaWriteRoles>
      </aaaUserDomain>
      <aaaUserDomain name="common" rolesR="0" rolesW="1">
        <aaaReadRoles/>
        <aaaWriteRoles>
          <role name="read-only"/>
        </aaaWriteRoles>
      </aaaUserDomain>
    <DnDomainMapEntry dn="uni/tn-common" readPrivileges="0" writePrivileges="3"/>
  </aaaLogin>
</imdata>

応答には、ユーザに関するドメインとロール情報とともにセッションのタイムアウト時間とセッショントークンが含まれます。

次に、aaaRefresh API メソッドを使用してセッションをリフレッシュする例を示します。

GET https://192.0.20.123/api/aaaRefresh.xml

次に、セッションのリフレッシュが成功したときの応答例を示します。

<?xml version="1.0" encoding="UTF-8"?>
<imdata>
  <aaaLogin 
    token=
"mk/i+LHZMhFQ47YyMlfZOua51veZ5mdbJAbHG7vjKVJ7QAuUDW
YGGkAdwSxjjcPYK/4Hav3QdZN/E7zJ/Rhc87tmpihVWpkP42VqU
D4aeELVQULz97ZpKnGfF0ki9vqBYkCYRg0vMstXO8IhxNYLtlC8
rxzgZFti+6biMQ+boRx=" 
    refreshTimeoutSeconds="0" 
    lastName="" 
    firstName=""/>
</imdata>

次の例では、aaaLogout API メソッドを使用してユーザをログアウトします。

POST https://192.0.20.123/api/aaaLogout.xml

<aaaUser name="admin" />

次に、ログアウト成功時の応答例を示します。

<?xml version="1.0" encoding="UTF-8"?>
<imdata>
</imdata>

例：JSON API を使用したユーザの認証

次に、ユーザ名とパスワードを含む JSON データ構造を使用してユーザをログインする例を示します。

POST https://192.0.20.123/api/aaaLogin.json

{
  "aaaUser":{
    "attributes":{
      "name":"georgewa",
      "pwd":"paSSword1"
    }
  }
}

次に、ログイン成功時の応答例を示します。

{
  "imdata":[{
      "aaaLogin":{
        "attributes":{
          "token":"token": 
"GkZl5NLRZJl5+jqChouaZ9CYjgE58W/pMccR+LeXmdO0obG9NB
Iwo1VBo7+YC1oiJL9mS6I9qh62BkX+Xddhe0JYrTmSG4JcKZ4t3
bcP2Mxy3VBmgoJjwZ76ZOuf9V9AD6Xl83lyoR4bLBzqbSSU1R2N
IgUotCGWjZt5JX6CJF0=",
          "refreshTimeoutSeconds":"300",
          "lastName":"Washington",
          "firstName":"George"
        },
        "children":[{
            "aaaUserDomain":{
              "attributes":{
                "name":"all",
                "rolesR":"0",
                "rolesW":"2"
              },
              "children":[{
                  "aaaReadRoles":{
                    "attributes":{}
                  }
                }, {
                  "aaaWriteRoles":{
                    "attributes":{},
                    "children":[{
                        "role":{
                          "attributes":{
                            "name":"admin"
                          }
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }, {
            "aaaUserDomain":{
              "attributes":{
                "name":"common",
                "rolesR":"0",
                "rolesW":"1"
              },
              "children":[{
                  "aaaReadRoles":{
                    "attributes":{}
                  }
                }, {
                  "aaaWriteRoles":{
                    "attributes":{},
                    "children":[{
                        "role":{
                          "attributes":{
                            "name":"read-only"
                          }
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }, {
            "DnDomainMapEntry":{
              "attributes":{
                "dn":"uni/tn-common",
                "readPrivileges":"0",
                "writePrivileges":"3"
              }
            }
          }
        ]
      }
    }
  ]
}

応答には、ユーザに関するドメインとロール情報とともにセッションのタイムアウト時間とセッショントークンが含まれます。

次に、aaaRefresh API メソッドを使用してセッションをリフレッシュする例を示します。

GET https://192.0.20.123/api/aaaRefresh.json

次に、セッションのリフレッシュが成功したときの応答例を示します。

{
  "imdata":[{
      "aaaLogin":{
        "attributes":{
          "token":
"Zs8jf2rcseiiYydx9WbyRVOScWs6c0Orti7EBg1H02jt0JV9oe
icX1ULLquI+LCN/93cAf46AErXpT4kN0mrCQRcCMRAl6m0ObT/r
G4D9UTm6/NNnqzhntCWTKt9IovTFDpD8Ocx1oXn2jpmS6PYDBJt
Wp4rIAu11sdM8BA24g6=",
          "refreshTimeoutSeconds":"0",
          "lastName":"",
          "firstName":""
        }
      }
    }
  ]
}

次の例では、aaaLogout API メソッドを使用してユーザをログアウトします。

POST https://192.0.20.123/api/aaaLogout.json

{
  "aaaUser":{
    "attributes":{
      "name":"georgewa"
    }
  }
}

次に、ログアウト成功時の応答例を示します。

{
  "imdata":[]
}

テナントの追加

テナントは仮想ファブリック内のポリシー所有者です。テナントは、プライベートエンティティまたは共有エンティティにすることができます。たとえば、安全に分割されたプライベートテナントまたは他のテナントにより共有されるコンテキストおよびブリッジドメインを持つテナントを作成できます。テナントの共有タイプは通常、common、default または infra という名前が付いています。

管理情報モデルでは、テナントはクラス fv:Tenant の管理対象オブジェクト（MO）で表されます。『Cisco APIC Management Information Model Reference』に従って、fv:Tenant クラスのオブジェクトはポリシー解決のユニバース（uni）クラスの子で、uni/tn-[name] の識別名（DN）形式を持っています。

次の例に、XML および JSON を使用して ExampleCorp という名前の新しいテナントを追加する方法を示します。

例：XML API を使用したテナントの追加
例：JSON API を使用したテナントの追加

例：XML API を使用したテナントの追加

新しいテナントを作成するには、メッセージの本文または URI でクラスと十分な命名情報を指定する必要があります。

XML API を使用して ExampleCorp という名前の新しいテナントを作成するには、次の HTTP POST メッセージを送信します。

POST https://192.0.20.123/api/mo/uni.xml

<fvTenant name="ExampleCorp"/>

または、次の例のように URI でテナントに名前を付けることができます。

POST https://192.0.20.123/api/mo/uni/tn-ExampleCorp.xml

<fvTenant />

（?rsp-subtree=modified を POST URI に追加することで）応答が要求された場合は、成功した操作により次の応答本文が返されます。

<imdata>
    <fvTenant
        instanceId="0:0"
        childAction="deleteNonPresent"
        dn="uni/tn-ExampleCorp"
        lcOwn="local"
        name="ExampleCorp"
        replTs="never"
        rn="" 
        status="created"
    />
</imdata>

テナントを削除するには、次の HTTP DELETE メッセージを送信します。

DELETE https://192.0.20.123/api/mo/uni/tn-ExampleCorp.xml

または、次の例のように、fv:Tenant 属性内に十分な命名情報と status="deleted" が含まれる HTTP POST メッセージを送信できます。

POST https://192.0.20.123/api/mo/uni.xml

<fvTenant name="ExampleCorp" status="deleted"/>

例：JSON API を使用したテナントの追加

新しいテナントを作成するには、メッセージの本文または URI でクラスと十分な命名情報を指定する必要があります。

JSON API を使用して新しいテナントを作成するには、次の HTTP POST メッセージを送信します。

POST https://192.0.20.123/api/mo/uni.json

{
  "fvTenant" : {
    "attributes" : {
      "name" : "ExampleCorp"
    }
  }
}

または、次の例のように URI でテナントに名前を付けることができます。

POST https://192.0.20.123/api/mo/uni/tn-ExampleCorp.json

{
  "fvTenant" : {
    "attributes" : {
    }
  }
}

（?rsp-subtree=modified を POST URI に追加することで）応答が要求された場合は、成功した操作により次の応答本文が返されます。

{
  "imdata" :
  [{
      "fvTenant" : {
        "attributes" : {
          "instanceId" : "0:0",
          "childAction" : "deleteNonPresent",
          "dn" : "uni/tn-ExampleCorp",
          "lcOwn" : "local",
          "name" : "ExampleCorp",
          "replTs" : "never",
          "rn" : "",
          "status" : "created"
        }
      }
    }
  ]
}

テナントを削除するには、次の HTTP DELETE メッセージを送信します。

DELETE https://192.0.20.123/api/mo/uni/tn-ExampleCorp.json

または、次の例のように、fv:Tenant 属性内に十分な命名情報と "status" : "deleted" が含まれる HTTP POST メッセージを送信できます。

POST https://192.0.20.123/api/mo/uni.json

{
  "fvTenant" : {
    "attributes" : {
      "name" : "ExampleCorp",
      "status" : "deleted"
    }
  }
}

ユーザの追加

APIC ユーザアカウントには、名前とパスワードに加えて、ユーザの権限レベル（ロール）とファブリック内のユーザ制御の範囲（ドメイン）に関する情報が含まれます。たとえば、クラウドの管理者はテナントを作成して追加の管理者を割り当てる機能を含むグローバルな制御が可能な一方で、テナントの管理者は通常、テナントのドメインまたはネットワークに制限されます。ユーザアカウントを設定するときは、パスワードの有効期限ポリシーなどの追加の設定項目を指定したり、それらの項目を省略してデフォルトの設定を使用することができます。

管理情報モデルでは、APIC ユーザはクラス aaa:User の管理対象オブジェクト（MO）で表されます。『Cisco APIC Management Information Model Reference』に従って、aaa:User クラスのオブジェクトには uni/userext/user-[name] の識別名（DN）形式があります。aaa:User クラスの直接プロパティ（属性）には、ユーザドメインまたは権限レベルのフィールドが含まれませんが、このクラスのリファレンスは aaa:UserDomain の子クラス（サブツリー）を示し、それには aaa:UserRole の子クラスがあります。新しいユーザを追加する API コマンド構造には、次の階層でこれらの子クラスにユーザドメインおよび権限レベルの設定を含めることができます。

aaa:User：ユーザオブジェクトには、1 つ以上のユーザドメインの子オブジェクトを含めることができます。
- aaa:UserDomain：ユーザドメインオブジェクトには、1 つ以上のユーザロールオブジェクトを含めることができます。
  - aaa:UserRole：ユーザロールオブジェクトは、ユーザの権限レベルを指定します。

次の例に、XML および JSON を使用して新しいユーザを管理者権限を持つユーザドメイン ExampleCorp に追加する方法を示します。追加の例に、コマンドラインからタスクを実行するための cURL コマンドの使用方法を示します。

例：XML API を使用したユーザの追加
例：JSON API を使用したユーザの追加
例：cURL による JSON API を使用したユーザの追加

例：XML API を使用したユーザの追加

新しいオブジェクトを作成するには、URI またはメッセージの本文でクラスと十分な命名情報を指定する必要があります。この例では、URI には DN が含まれ、メッセージの本文にはオブジェクトクラスが含まれます。

XML API を使用して新しいユーザを作成および設定するには、次の HTTP POST メッセージを送信します。

POST https://192.0.20.123/api/mo/uni/userext/user-georgewa.xml

<aaaUser
  pwd="password1"
  firstName="George"
  lastName="Washington"
  phone="4085551212"
  email="georgewa@example.com" >
    <aaaUserDomain name="ExampleCorp" >
        <aaaUserRole name="admin" />
    </aaaUserDomain>
</aaaUser>

または、/api/mo.xml に POST 送信して DN 属性 dn="uni/userext/user-georgewa" を提供するか、または /api/mo/uni/userext.xml に POST 送信して名前属性 name="georgewa" を提供することができます。

このコマンド構造の子セクションでは、新しいユーザがそのユーザドメインの管理者ロールを持つ ExampleCorp ユーザドメイン内に配置されるように設定されます。新しいユーザを作成するときは、この例に示す情報より少ない情報または多い情報を指定できます。追加属性は、後続の操作で設定できます。

（?rsp-subtree=modified を POST URI に追加することで）応答が要求された場合は、成功した操作により次の応答本文が返されます。

<imdata>
  <aaaUser 
    instanceId="0:0" 
    accountStatus="active" 
    childAction="deleteNonPresent" 
    clearPwdHistory="no" 
    descr="" 
    dn="uni/userext/user-georgewa" 
    email="georgewa@example.com" 
    encPwd="" 
    expiration="never" 
    expires="no" 
    firstName="George" 
    intId="none" 
    lastName="Washington" 
    lcOwn="local" 
    name="georgewa" 
    phone="4085551212" 
    pwd="password1" 
    pwdLifeTime="no-password-expire" 
    pwdSet="no" 
    replTs="never" 
    rn="" 
    status="created" >
      <aaaUserDomain 
        instanceId="0:0" 
        childAction="deleteNonPresent" 
        descr="" intId="none" 
        lcOwn="local" 
        name="common" 
        replTs="never" 
        rn="userdomain-common" 
        status="created" >
          <aaaUserRole 
            instanceId="0:0" 
            childAction="deleteNonPresent" 
            descr="" 
            intId="none" 
            lcOwn="local" 
            name="read-only" 
            privType="readPriv" 
            replTs="never" 
            rn="role-read-only" 
            status="created" />
          </aaaUserDomain>
      <aaaUserDomain 
        instanceId="0:0" 
        childAction="deleteNonPresent" 
        descr="" 
        intId="none" 
        lcOwn="local" 
        name="ExampleCorp" 
        replTs="never" 
        rn="userdomain-ExampleCorp" 
        status="created" >
          <aaaUserRole 
            instanceId="0:0" 
            childAction="deleteNonPresent" 
            descr="" 
            intId="none" 
            lcOwn="local" 
            name="admin" 
            privType="readPriv" 
            replTs="never" 
            rn="role-admin" 
            status="created" />
      </aaaUserDomain>
  </aaaUser>
</imdata>

この応答は、ユーザが 2 つのユーザドメインに作成され追加されたことを示します。要求通りに、ユーザには ExampleCorp ユーザドメインでの管理者権限があります。デフォルトでは、ユーザには共通のユーザドメインでの読み取り専用権限もあります。

ユーザを削除するには、次の HTTP DELETE メッセージを送信します。

DELETE https://192.0.20.123/api/mo/uni/userext/user-georgewa.xml

または、次の例のように、aaa:User 属性内に十分な命名情報と status="deleted" が含まれる HTTP POST メッセージを送信できます。

POST https://192.0.20.123/api/mo.xml

<aaaUser dn="uni/userext/user-georgewa" status="deleted" />

例：JSON API を使用したユーザの追加

JSON API を使用して新しいユーザを作成および設定するには、次の HTTP POST メッセージを送信します。

POST https://192.0.20.123/api/mo/uni/userext/user-georgewa.json

{
  "aaaUser" : {
    "attributes" : {
      "pwd" : "password1",
      "firstName" : "George"
      "lastName" : "Washington",
      "phone" : "4085551212",
      "email" : "georgewa@example.com"
    },
    "children" : [{
        "aaaUserDomain" : {
          "attributes" : {
            "name" : "ExampleCorp"
          },
          "children" : [{
              "aaaUserRole" : {
                "attributes" : {
                  "name" : "admin"
                }
              }
            }
          ]
        }
      }
    ]
  }
}

または、/api/mo.json に POST 送信して DN 属性 "dn":"uni/userext/user-georgewa" を提供するか、または /api/mo/uni/userext.json に POST 送信して名前属性 "name":"georgewa" を提供することができます。

（?rsp-subtree=modified を POST URI に追加することで）応答が要求された場合は、成功した操作により次の応答本文が返されます。

{
  "imdata" : [{
      "aaaUser" : {
        "attributes" : {
          "instanceId" : "0:0",
          "accountStatus" : "active",
          "childAction" : "deleteNonPresent",
          "clearPwdHistory" : "no",
          "descr" : "",
          "dn" : "uni/userext/user-georgewa",
          "email" : "georgewa@example.com",
          "encPwd" : "",
          "expiration" : "never",
          "expires" : "no",
          "firstName" : "George",
          "intId" : "none",
          "lastName" : "Washington",
          "lcOwn" : "local",
          "name" : "georgewa",
          "phone" : "5551212",
          "pwd" : "password1",
          "pwdLifeTime" : "no-password-expire",
          "pwdSet" : "no",
          "replTs" : "never",
          "rn" : "",
          "status" : "created"
        },
        "children" : [{
            "aaaUserDomain" : {
              "attributes" : {
                "instanceId" : "0:0",
                "childAction" : "deleteNonPresent",
                "descr" : "",
                "dn" : "",
                "intId" : "none",
                "lcOwn" : "local",
                "name" : "common",
                "replTs" : "never",
                "rn" : "userdomain-common",
                "status" : "created"
              },
              "children" : [{
                  "aaaUserRole" : {
                    "attributes" : {
                      "instanceId" : "0:0",
                      "childAction" : "deleteNonPresent",
                      "descr" : "",
                      "dn" : "",
                      "intId" : "none",
                      "lcOwn" : "local",
                      "name" : "read-only",
                      "privType" : "readPriv",
                      "replTs" : "never",
                      "rn" : "role-read-only",
                      "status" : "created"
                    }
                  }
                }
              ]
            }
          }, {
            "aaaUserDomain" : {
              "attributes" : {
                "instanceId" : "0:0",
                "childAction" : "deleteNonPresent",
                "descr" : "",
                "dn" : "",
                "intId" : "none",
                "lcOwn" : "local",
                "name" : "ExampleCorp",
                "replTs" : "never",
                "rn" : "userdomain-ExampleCorp",
                "status" : "created"
              },
              "children" : [{
                  "aaaUserRole" : {
                    "attributes" : {
                      "instanceId" : "0:0",
                      "childAction" : "deleteNonPresent",
                      "descr" : "",
                      "dn" : "",
                      "intId" : "none",
                      "lcOwn" : "local",
                      "name" : "admin",
                      "privType" : "writePriv",
                      "replTs" : "never",
                      "rn" : "role-admin",
                      "status" : "created"
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

ユーザを削除するには、次の HTTP DELETE メッセージを送信します。

DELETE https://192.0.20.123/api/mo/uni/userext/user-georgewa.json

または、次の例のように、aaa:User 属性内に十分な命名情報と "status":"deleted" が含まれる HTTP POST メッセージを送信できます。

POST https://192.0.20.123/api/mo.json

{
  "aaaUser" : {
    "attributes" : {
      "dn" : "uni/userext/user-georgewa",
      "status" : "deleted"
    }
  }
}

例：cURL による JSON API を使用したユーザの追加

「例：JSON API を使用したユーザの追加」に示す形式で JSON 構造を含むローカルファイルを作成します。この例では、ファイル名は newuser.json で、そのファイルは別のディレクトリにあります。

cURL コマンドラインで、HTTP 方式（POST など）、ローカルファイルのパスと名前、および API 操作の URI を指定する必要があります。

curl コマンドを使用して、次の例のように POST メッセージ内の JSON ファイルを API に送信します。

curl -X POST --data "@../users/newuser.json" https://192.0.20.123/api/mo/uni/userext/user-georgewa.json

（注）

ファイル名の前に @ 記号を必ず入力してください。cURL ツールは無料でオープンソフトウェアです。cURL の使用に関する詳細情報はオンラインで確認できます。

（?rsp-subtree=modified を POST URI に追加することで）応答が要求された場合は、成功した操作により「例：JSON API を使用したユーザの追加」に示す応答本文が返されます。

ユーザを削除するには、JSON ファイルを編集して "status":"deleted" の aaaUser 属性を追加して、コマンドを再度送信します。

または、この HTTP DELETE メッセージを送信できます。

curl -X DELETE https://192.0.20.123/api/mo/uni/userext/user-georgewa.json

自分のユーザクレデンシャルの変更

APIC にログインすると、パスワード、SSH キー、X.509 証明書などの、自分のユーザクレデンシャルを変更できます。次の API メソッドが、ログインしたユーザのユーザクレデンシャルの変更用に提供されています。

changeSelfPassword
changeSelfSshKey
changeSelfX509Cert

（注）

これらのメソッドを使用して、自分がログインするアカウントのクレデンシャルだけを変更できます。

各メソッドのメッセージ本文には変更されるオブジェクトのプロパティが含まれています。プロパティを『Cisco APIC Management Information Model Reference』に示します。

パスワードの変更

パスワードを変更するには、aaa:changePassword オブジェクトを変更する changeSelfPassword API メソッドを送信します。次のオブジェクトプロパティがメッセージ本文に必要です。

userName：ログイン ID。
oldPassword：現在のパスワード。
newPassword：新しいパスワード。

この例では、User1 によって送信されると、User1 のパスワードが変更されます。

POST http://192.0.20.123/api/changeSelfPassword.json

{
  "aaaChangePassword" : {
    "attributes" : {
      "userName" : "User1",
      "oldPassword" : "p@$sw0rd",
      "newPassword" : "dr0ws$@p"
    }
  }
}

この例のように、正常に動作すると、空の imdata 要素が返されます。

{
    "totalCount" : "0",
    "imdata" : []
}

SSH キーの変更

SSH キーを変更するには、aaa:changeSshKey オブジェクトを変更する changeSelfSshKey API メソッドを送信します。次のオブジェクトプロパティがメッセージ本文に必要です。

userName：ログイン ID。
name：キーのシンボリック名。APIC はシングルユーザで最大 32 の SSH キーをサポートしています。
data：新しい SSH キー。

この例では、User1 によって送信されると、User1 の SSH キーが変更されます。

POST http://192.0.20.123/api/changeSelfSshKey.json

{
  "aaaChangeSshKey" : {
    "attributes" : {
      "userName" : "User1",
      "name" : "A",
      "data" : "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAuKxY5E4we6uCR2z== key@example.com"
    }
  }
}

正常に動作すると、空の imdata 要素が返されます。

X.509 証明書の変更

X.509 証明書を変更するには、aaa:changeX509Cert オブジェクトを変更する changeSelfX509Cert API メソッドを送信します。次のオブジェクトプロパティがメッセージ本文に必要です。

userName：ログイン ID。
name：証明書のシンボリック名。APIC はシングルユーザで最大 32 の X.509 証明書をサポートします。
data：新しい X.509 証明書のデータ本文全体。

この例では、User1 によって送信されると、User1 の X.509 証明書が変更されます。

POST http://192.0.20.123/api/changeSelfX509Cert.json

{
  "aaaChangeX509Cert" : { 
    "attributes" : {
      "userName" : "User1",
      "name" : "A",
      "data" : "-----BEGIN CERTIFICATE-----\nMIIE2TCCA8GgAwIBAgIKamlnsw

[EXAMPLE TRUNCATED]

       1BCIolblPFft6QKoSJFjB6thJksaE5/k3Npf\n-----END CERTIFICATE-----"
    }
  }
}

正常に動作すると、空の imdata 要素が返されます。

SSH キーまたは X.509 証明書の削除

キーまたは証明書を削除するには、削除するキーまたは証明書の名前を指定し、データ属性を空白にして、キーまたは証明書の変更メソッドを送信します。

この例では、User1 によって送信されると、User1 の SSH キーが削除されます。

POST http://192.0.20.123/api/changeSelfSshKey.json

{
  "aaaChangeSshKey" : {
    "attributes" : {
      "userName" : "User1",
      "name" : "A",
      "data" : ""
    }
  }
}

正常に動作すると、空の imdata 要素が返されます。

3 層アプリケーションのエンドポイントグループおよびコントラクトの導入

Cisco Application Centric Infrastructure（ACI）ファブリックの一般的な用途は、テナントネットワーク内で 3 層アプリケーションをホストすることです。APIC REST API を使用して、このようなアプリケーションのエンドポイントグループとコントラクトを設定できます。この例では、アプリケーションは、次の図に示すように 3 台のサーバ、Web サーバ、アプリケーションサーバ、およびデータベースサーバを使用して実装されます。

以下は、構成の主要コンポーネントです。

エンドポイントグループ（EPG）：各サーバは、各エンドポイントグループに関連付けられたコントラクトに従って他のエンドポイントグループからトラフィックを供給されるか消費するエンドポイントグループを表します。
コントラクト：エンドポイントで送受信されるトラフィックはコントラクトによって抑制され、コントラクトはエンドポイントから提供されたトラフィックとエンドポイントで消費されるトラフィックのフィルタセットを適用します。
フィルタ：フィルタは、フィルタを含むコントラクトにより許可または拒否されるデータプロトコルを指定します。

次のネットワークコンポーネントは、すでに存在すると想定されています。

ブリッジドメイン（BD）：レイヤ 3 コンテキストに関連付けられたレイヤ 2 ネットワーク
コンテキスト：サーバ間の通信用のレイヤ 3 プライベートネットワーク。
外部ポート：アプリケーションへの外部アクセス用のレイヤ 3 ネットワークポート。
Virtual Machine Manager（VMM）およびハイパーバイザコンポーネント
VLAN

（注）

3 層アプリケーションの導入に関する拡張された包括的な例については、『Cisco APIC Getting Started Guide』を参照してください。

構成情報は、テナントの識別名（DN）に送信される単一の XML 構造に含まれています。この例では、テナントの名前は ExampleCorp です。XML API を使用してアプリケーションを展開するには、次の HTTP POST メッセージを送信します。

POST https://192.0.20.123/api/mo/uni/tn-ExampleCorp.xml

次の XML 構造を POST メッセージの本文に含めます。

<fvTenant name="ExampleCorp">

    <fvAp name="OnlineStore">
        <fvAEPg name="web">
            <fvRsBd tnFvBDName="bd1"/>
            <fvRsCons tnVzBrCPName="rmi"/>
            <fvRsProv tnVzBrCPName="web"/>
            <fvRsDomAtt tDn="uni/vmmp-VMware/dom-datacenter"/>
        </fvAEPg>

        <fvAEPg name="db">
            <fvRsBd tnFvBDName="bd1"/>
            <fvRsProv tnVzBrCPName="sql"/>
            <fvRsDomAtt tDn="uni/vmmp-VMware/dom-datacenter"/>
        </fvAEPg>

        <fvAEPg name="app">
            <fvRsBd tnFvBDName="bd1"/>
            <fvRsProv tnVzBrCPName="rmi"/>
            <fvRsCons tnVzBrCPName="sql"/>
            <fvRsDomAtt tDn="uni/vmmp-VMware/dom-datacenter"/>
        </fvAEPg>
    </fvAp>
    
    <vzFilter name="http" >
        <vzEntry dFromPort="80" name="DPort-80" prot="tcp" etherT="ip" />
        <vzEntry dFromPort="443" name="DPort-443" prot="tcp" etherT="ip" />
    </vzFilter>
    
    <vzFilter name="rmi" >
        <vzEntry dFromPort="1099" name="DPort-1099" prot="tcp" etherT="ip" />
    </vzFilter>
    
    <vzFilter name="sql">
        <vzEntry dFromPort="1521" name="DPort-1521" prot="tcp" etherT="ip" />
    </vzFilter>
    
    <vzBrCP name="web">
        <vzSubj name="web">
            <vzRsSubjFiltAtt tnVzFilterName="http"/>
        </vzSubj>
    </vzBrCP>

    <vzBrCP name="rmi">
        <vzSubj name="rmi">
            <vzRsSubjFiltAtt tnVzFilterName="rmi"/>
        </vzSubj>
    </vzBrCP>

    <vzBrCP name="sql">
        <vzSubj name="sql">
           <vzRsSubjFiltAtt tnVzFilterName="sql"/>
        </vzSubj>
    </vzBrCP>    
</fvTenant>

XML 構造の最初の行は、ExampleCorp という名前のテナントを変更するかまたは必要に応じて作成します。

<fvTenant name="ExampleCorp">

次の行は、OnlineStore という名前のアプリケーションネットワークプロファイルを作成します。

<fvAp name="OnlineStore">

アプリケーションネットワークプロファイル内の要素は、3 つのエンドポイントグループを作成します（3 台のサーバそれぞれに 1 つずつ）。次の行は、web という名前のエンドポイントグループを作成し、bd1 という名前の既存のブリッジドメインに関連付けます。このエンドポイントグループは、rmi という名前のバイナリ契約で許可されたトラフィックのコンシューマまたは宛先であり、web という名前のバイナリ契約で許可されたトラフィックのプロバイダーまたは送信元です。エンドポイントグループは、datacenter という名前の VMM ドメインに関連付けられます。

<fvAEPg name="web">
    <fvRsBd tnFvBDName="bd1"/>
    <fvRsCons tnVzBrCPName="rmi"/>
    <fvRsProv tnVzBrCPName="web"/>
    <fvRsDomAtt tDn="uni/vmmp-VMware/dom-datacenter"/>
</fvAEPg>

残りの 2 つのエンドポイントグループは、アプリケーションサーバとデータベースサーバに対し、同様の方法で作成されます。

次の行は、TCP トラフィックのタイプ HTTP（ポート 80）および HTTPS（ポート 443）を指定する http という名前のトラフィックフィルタを定義します。

<vzFilter name="http">
    <vzEntry dFromPort="80" name="DPort-80" prot="tcp"  />
    <vzEntry dFromPort="443" name="DPort-443" prot="tcp"  />
</vzFilter>

残りの 2 つのフィルタは、アプリケーションのデータおよびデータベース（sql）のデータに対し、同様の方法で作成されます。

次の行は、http という名前のフィルタを組み込む web という名前のバイナリ契約を作成します。

<vzBrCP name="web">
    <vzSubj name="web">
        <vzRsSubjFiltAtt tnVzFilterName="http"/>
    </vzSubj>
</vzBrCP>

残りの 2 つの契約は、rmi および sql のデータプロトコルに対し、同様の方法で作成されます。

最後の行は、構造を閉じます。

</fvTenant>

このドキュメントは役に立ちましたか?

フィードバック

シスコに問い合わせ

サポートケースをオープン
(シスコサービス契約が必要です。)

Cisco APIC REST API ユーザ ガイド

偏向のない言語

翻訳について

検索結果

章のタイトル： 一般的なタスクの実行

一般的なタスクの実行

一般的なタスクの実行

ログイン

例：XML API を使用したユーザの認証

例：JSON API を使用したユーザの認証

テナントの追加

例：XML API を使用したテナントの追加

例：JSON API を使用したテナントの追加

ユーザの追加

例：XML API を使用したユーザの追加

例：JSON API を使用したユーザの追加

例：cURL による JSON API を使用したユーザの追加

自分のユーザ クレデンシャルの変更

パスワードの変更

SSH キーの変更

X.509 証明書の変更

SSH キーまたは X.509 証明書の削除

3 層アプリケーションのエンドポイント グループおよびコントラクトの導入

このドキュメントは役に立ちましたか?

シスコに問い合わせ

Cisco APIC REST API ユーザガイド

章のタイトル：一般的なタスクの実行

自分のユーザクレデンシャルの変更

3 層アプリケーションのエンドポイントグループおよびコントラクトの導入