監視追加API―コンバージド インフラストラクチャ

最新情報を本社サイトでご確認ください。

このページでは、AddMonitor APIで、カテゴリ タイプがコンバージド インフラストラクチャの監視を追加する方法を説明します。サポートするコンバージド インフラストラクチャは次のとおりです。

Nutanix

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&port=[PORT]&username=[USER_NAME]&password=[PASS_WORD]&addtoGroup=[ADDTO_GROUP]&groupID=[GROUP_ID]&AddVMS=[MONITOR_VMS]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。あわせて共通リクエスト パラメーターのリストを参照ください。

フィールド 説明        
タイプ
 追加する監視のタイプです。値はNutanixにしてください。
host Nutanixを実行しているホストの名前です。
port Nutanixが動作するポート番号です。
password Nutanixデプロイへのアクセス権限を持つユーザーのパスワードを指定してください。
addtoGroup Nutanix監視を関連付ける監視グループの名前です。指定は必須ではありません。
groupID

Nutanix監視を関連付ける監視グループのIDです。指定は必須ではありません。
AddVMS

Nutanixインスタンスに存在するVMを監視するか、指定できます。指定値は、0はVMディスカバリを行わない、1はVMをディスカバリするがメトリック監視は行わない、2はディスカバリとVMメトリックの監視を行うを示します。

リクエスト サンプル

  1. ユーザー名/パスワードを使用するREST API
    http://localhost:9090/AppManager/xml/AddMonitor?apikey=ca986ad1a6b1a445d310670b5278129d&type=Nutanix&displayname=34.83.107.83&host=34.83.107.83&port=9440&username=admin&Password=jUPFS3H7!N&AddVMS=2
  2. 認証情報を用いたREST APIサンプル
    http://localhost:9090/AppManager/xml/AddMonitor?apikey=1f1741046689f3adcfc3ae2bdc874330&type=Nutanix&displayname=35.247.63.119&host=35.247.63.119&port=9440&credentialID=1&AddVMS=2&DiscoverNode=yes

Nutanix Multi-Cluster

構文

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=NutanixMultiCluster&displayname=[DISPLAYNAME]&host=[PRISM_CENTRAL_HOST]&port=[PRISM_CENTRAL_PORT]&UserName=[USERNAME]&Password=[PASSWORD]&credentialID=[CREDENTIALID]&discoveryFilter=[REGEX]&deleteAction=[RETAIN/UNMANAGE/DELETE]&discoverInterval=[DISCOVERY_INTERVAL]&pollInterval=[POLL_INTERVAL]&addToGroup=[GROUPNAME]&groupID=[GROUPID]

  • サポートされているHTTPメソッド：POST
  • 許可されているロール（権限）：管理者

リクエスト パラメーター

APIリクエストに含まれるパラメータの説明は以下の通りです。あわせて共通リクエスト パラメーターのリストを参照ください。

フィールド 説明        
type
 追加する監視のタイプです。値はNutanixMultiClusterにしてください。
displayname Nutanix Multi-Cluster監視の表示名です。
host Prism Centralのホスト名、またはIPアドレスです。
port Prism Centralのポート番号です。デフォルトは 9440です。
UserName Prism Centralへのアクセス権限を持つユーザー名です。
Password

上記ユーザーのパスワードです。（※credentialIDを使用する場合は不要です）
credentialID

認証に使用する、登録済みの認証情報のIDです。（※任意項目）

discoveryFilter 特定のNutanixクラスターのみを対象にするための、自動検出用の正規表現フィルターです。（※任意項目）
deleteAction 以前検出されたクラスターが、その後の検出で見つからなくなった場合に実行するアクションです。指定可能な値は以下の通りです。
  • Retain（維持する）
  • Unmanage（非管理にする）
  • Delete（削除する）
discoverInterval クラスターを自動検出する定期的な間隔（分単位）です。
pollInterval Prism Centralレベルの処理に対するポーリング（データ取得）間隔（分単位）です。
addToGroup

この監視を追加する監視グループの名前です。（※任意項目）
groupID

監視グループのIDです。（※任意項目）

リクエスト サンプル

  1. ユーザー名/パスワードを使用するREST API
    https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=NutanixMultiCluster&displayname=multiCluster01&host=pc-host&port=9440&UserName=admin&Password=admin123&discoverInterval=10&pollInterval=5&deleteAction=Unmanage
  2. 認証情報を用いたREST APIサンプル
    https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=NutanixMultiCluster&displayname=multiCluster01&host=pc-host&port=9440&credentialID=2&discoveryFilter=cluster.*&discoverInterval=10&pollInterval=5&deleteAction=Retain

監視されるパラメーター

Nutanix Multi-Cluster監視は、現時点でクラスターの自動検出のみを行います。この親（Prism Central）レベルの監視では、パフォーマンスメトリクスは取得できません。 すべてのメトリクスは、自動検出された後に作成される個々のNutanix （Prism Element）子監視の配下で確認することができます。

Cisco UCS

構文

http://[APM_HOST]:[APM_PORT]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&host=[HOST_NAME]&port=[PORT]&isSSLEnabled=[IS SSL ENABLED]&username=[USER_NAME]&password=[PASS_WORD]&timeout=[TIME_OUT]&displayname=[DISPLAY_NAME]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。

フィールド 説明        
タイプ
 追加する監視のタイプです。値はCiscoUCSにしてください。
host Cisco UCSサーバーを実行しているホストの名前です。
port Cisco UCSサーバーが動作するポート番号です。
username Cisco UCSサーバーのユーザー名です。
password Cisco UCSサーバーのパスワードです。
isSSLEnabled SSLを有効にするか否かを示します。trueかfalseにしてください。
timeout タイムアウト値を指定します（秒）。

リクエスト サンプル

http://localhost:9085/AppManager/xml/AddMonitor?apikey=8f1fa34b3aa5cf06a7d555b3cb6ef5f8&type=CiscoUCS&host=172.24.157.134&port=80&username=ucspe&password=ucspe&timeout=40&displayname=RestAPI&isSSLEnabled=true