この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。
このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。
目次
この章は、次の項で構成されています。
認証により、XML API による CIMC との対話が可能になります。 認証を使用すると、権限を設定し、実行できる操作を制御できます。
(注) |
このマニュアルのほとんどのコード例では、用語 <real_cookie> は 1217377205/85f7ff49-e4ec-42fc-9437-da77a1a2c4bf などの実際の Cookie に置き換えられます。 XML API の Cookie は 47 文字の文字列です。これは、セッション情報を維持するために Web ブラウザがローカルに保存する Cookie とは種類が異なります。 |
ログインするために、XML API クライアントは CIMC HTTP(または HTTPS)サーバへの TCP 接続を確立し、aaaLogin メソッドを格納している XML ドキュメントをポストします。
次の例では、IP アドレス 192.0.20.72 で CIMC のポート 80 への TCP 接続を確立するために、Telnet ユーティリティを使用しています。 使用するパスは /nuova です。
$ telnet 192.0.20.72 80 POST /nuova HTTP/1.1 USER-Agent: lwp-request/2.06 HOST: 192.0.20.72 Content-Length: 62 Content-Type: application/x-www-form-urlencoded
次に、クライアントは aaaLogin メソッドを指定し、ユーザ名とパスワードを提供します。
<aaaLogin inName='admin' inPassword='password'> </aaaLogin>
(注) |
XML API ドキュメントに XML バージョンまたは DOCTYPE の行を含めないでください。 inName 属性と inPassword 属性はパラメータです。 |
各 XML API ドキュメントは、実行する操作を表します。 要求が XML API ドキュメントとして受け取られると、CIMC は要求を読み取り、メソッドで指定されているアクションを実行します。 CIMC は、XML ドキュメント形式のメッセージで応答し、要求の成否を示します。
次に、一般的な成功応答を示します。
1 <aaaLogin 2 response="yes" 3 outCookie="<real_cookie>" 4 outRefreshPeriod="600" 5 outPriv="admin"> 6 </aaaLogin>
応答の各行は、次のように解釈されます。
また、次の例に示すように XML API へのログインに cURL ユーティリティを使用できます。
curl -d "<aaaLogin inName='admin' inPassword='password'></aaaLogin>" http://192.0.20.72/nuova
HTTPS を有効にした場合は、次の例に示すように、cURL のコマンドで HTTPS を使用する必要があります。
curl -d "<aaaLogin inName='admin' inPassword='password'></aaaLogin>" https://192.0.20.72/nuova
セッションは、aaaLogin 応答または以前の更新から取得された 47 文字の Cookie を使用して、aaaRefresh メソッドで更新されます。
<aaaRefresh cookie="<real_cookie>" inCookie="<real_cookie>" inName='admin' inPassword='password'> </aaaRefresh>
セッションからログアウトするには、次のメソッドを使用します。
<aaaLogout cookie="<real_cookie>" inCookie="<real_cookie>" </aaaLogout>
失敗したログイン:
<aaaLogin cookie="" response="yes" errorCode="551" invocationResult="unidentified-fail" errorDescr="Authentication failed"> </aaaLogin>
存在しないオブジェクト(空白が返される場合は、指定した DN オブジェクトが存在しないことを示します):
<configResolveDn cookie="<real_cookie>" response="yes" dn="sys/rack-unit-1/adaptor-9999"> <outConfig> </outConfig> </configResolveDn>
不正な要求:
<configConfMo cookie="<real_cookie>" response="yes" dn="sys/rack-unit-1/adaptor-1/ext-eth-0"> errorCode="103“ invocationResult="unidentified-fail“ errorDescr="can't create; object already exists."> </configConfMo>
管理情報ツリーの子オブジェクトの解決時に、次のことに注意してください。
configResolveChildrenに示す要求または応答の例を参照してください。
クラスの解決時には、次のことに注意してください。
結果セットは大きくなることがあります。 結果セットは正確に定義してください。 たとえば、アダプタのリストだけを取得する場合は、クエリーで classId の属性値として adaptorUnit を使用します。 この例は、adaptorUnit クラスのすべてのインスタンスについて問い合わせます。
<configResolveClass
cookie="real_cookie"
inHierarchical="false"
classId="adaptorUnit"/>
configResolveClassに示す要求または応答の例を参照してください。
DN を解決するときは、次のことに注意してください。
configResolveDnに示す要求または応答の例を参照してください。
オブジェクトの親オブジェクトの解決時に、次のことに注意してください。
configResolveParentに示す要求または応答の例を参照してください。
目次
この章は、次の項で構成されています。
認証により、XML API による CIMC との対話が可能になります。 認証を使用すると、権限を設定し、実行できる操作を制御できます。
(注) |
このマニュアルのほとんどのコード例では、用語 <real_cookie> は 1217377205/85f7ff49-e4ec-42fc-9437-da77a1a2c4bf などの実際の Cookie に置き換えられます。 XML API の Cookie は 47 文字の文字列です。これは、セッション情報を維持するために Web ブラウザがローカルに保存する Cookie とは種類が異なります。 |
ログインするために、XML API クライアントは CIMC HTTP(または HTTPS)サーバへの TCP 接続を確立し、aaaLogin メソッドを格納している XML ドキュメントをポストします。
次の例では、IP アドレス 192.0.20.72 で CIMC のポート 80 への TCP 接続を確立するために、Telnet ユーティリティを使用しています。 使用するパスは /nuova です。
$ telnet 192.0.20.72 80 POST /nuova HTTP/1.1 USER-Agent: lwp-request/2.06 HOST: 192.0.20.72 Content-Length: 62 Content-Type: application/x-www-form-urlencoded
次に、クライアントは aaaLogin メソッドを指定し、ユーザ名とパスワードを提供します。
<aaaLogin inName='admin' inPassword='password'> </aaaLogin>
(注) |
XML API ドキュメントに XML バージョンまたは DOCTYPE の行を含めないでください。 inName 属性と inPassword 属性はパラメータです。 |
各 XML API ドキュメントは、実行する操作を表します。 要求が XML API ドキュメントとして受け取られると、CIMC は要求を読み取り、メソッドで指定されているアクションを実行します。 CIMC は、XML ドキュメント形式のメッセージで応答し、要求の成否を示します。
次に、一般的な成功応答を示します。
1 <aaaLogin 2 response="yes" 3 outCookie="<real_cookie>" 4 outRefreshPeriod="600" 5 outPriv="admin"> 6 </aaaLogin>
応答の各行は、次のように解釈されます。
また、次の例に示すように XML API へのログインに cURL ユーティリティを使用できます。
curl -d "<aaaLogin inName='admin' inPassword='password'></aaaLogin>" http://192.0.20.72/nuova
HTTPS を有効にした場合は、次の例に示すように、cURL のコマンドで HTTPS を使用する必要があります。
curl -d "<aaaLogin inName='admin' inPassword='password'></aaaLogin>" https://192.0.20.72/nuova
失敗したログイン:
<aaaLogin cookie="" response="yes" errorCode="551" invocationResult="unidentified-fail" errorDescr="Authentication failed"> </aaaLogin>
存在しないオブジェクト(空白が返される場合は、指定した DN オブジェクトが存在しないことを示します):
<configResolveDn cookie="<real_cookie>" response="yes" dn="sys/rack-unit-1/adaptor-9999"> <outConfig> </outConfig> </configResolveDn>
不正な要求:
<configConfMo cookie="<real_cookie>" response="yes" dn="sys/rack-unit-1/adaptor-1/ext-eth-0"> errorCode="103“ invocationResult="unidentified-fail“ errorDescr="can't create; object already exists."> </configConfMo>
管理情報ツリーの子オブジェクトの解決時に、次のことに注意してください。
configResolveChildrenに示す要求または応答の例を参照してください。
クラスの解決時には、次のことに注意してください。
結果セットは大きくなることがあります。 結果セットは正確に定義してください。 たとえば、アダプタのリストだけを取得する場合は、クエリーで classId の属性値として adaptorUnit を使用します。 この例は、adaptorUnit クラスのすべてのインスタンスについて問い合わせます。
<configResolveClass
cookie="real_cookie"
inHierarchical="false"
classId="adaptorUnit"/>
configResolveClassに示す要求または応答の例を参照してください。
DN を解決するときは、次のことに注意してください。
configResolveDnに示す要求または応答の例を参照してください。
オブジェクトの親オブジェクトの解決時に、次のことに注意してください。
configResolveParentに示す要求または応答の例を参照してください。