AddMonitor API――ミドルウェア/ポータル
このページでは、AddMonitor APIで、カテゴリ タイプ「ミドルウェア/ポータル」の監視を追加する方法を説明します。製品では次の監視をサポートします。
- MS Office SharePoint
- WebLogic Integration
- IBM WebSphere MQ
- Microsoft Message Queue（MSMQ）
- RabbitMQ
- Microsoft BizTalk
- Oracle Tuxedo
- Microsoft Skype for Business
- Azure Service Bus
- Apache ActiveMQ
MS Office SharePoint
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&username=[USER_NAME]&password=[PASS_WORD]&version=[SHAREPOINT_VERSION]&SPType=[SHAREPOINT_TYPE]&Powershell=[IS POWERSHELL ENABLED]&Services=[SHAREPOINT_SERVICES]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| type | 追加する監視のタイプです。値はMSOfficeSharePointServerにしてください。 | ||||||||||||
| version | Microsoft Office SharePoint Serverのバージョンを指定します。値は、2007、2010、2013、2016から選択してください。 | ||||||||||||
| host | Office SharePoint Serverを実行しているホストの名前を指します。 | ||||||||||||
| username | SharePoint Serverのユーザー名です。 | ||||||||||||
| password | SharePoint Serverのパスワードです。 | ||||||||||||
| SPType | SharePoint Serverのタイプです。次の値を指定できます。
|
||||||||||||
| PowerShell（任意項目） | Powershellが有効かを示します。次の値を指定できます。
|
||||||||||||
| サービス（任意項目） |
|
リクエスト サンプル
http://prod-server5:9090/AppManager/xml/AddMonitor?apikey=4df5040d6db873dcdaf4359b259fd494&type=MSOfficeSharePointServer&displayname=ms&host=app-server&username=administrator&password=admin123&version=2010&SPType=SPServer&Powershell=True& Services=SharepointServices,ContentDB,WebApplication,TimerJobs,AccessServices,InfoPathServices,VisioWebAccess Services,ExcelServices,OfficeSearchGatherer
WebLogic Integration
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&port=[PORT]&username=[USER_NAME]&password=[PASS_WORD]&Version=[VERSION]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加する監視のタイプです。値はWebLogic Integrationにしてください。 |
| host | WebLogic Integrationサーバーを実行しているホストの名前を指します。 |
| port | WebLogic Integrationサーバーが動作するポート番号です。 |
| username | WebLogic Integrationサーバーのユーザー名です。 |
| password | WebLogic Integrationサーバーのパスワードです。 |
| version | WebLogic Integrationサーバーのバージョンです。8.1を指定します。 |
リクエスト サンプル
http://prod-server3:9090/AppManager/xml/AddMonitor?apikey=136edbeb3ccb83c6cc71df03ef273313&type=WebLogic Integration&displayname=apm&host=app-server&port=7001&username=weblogics&password=weblogic&version=8.1
IBM WebSphere MQ
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&listenerport=[PORT]&displayname=[DISPLAY_NAME]&serverconnectionchannel=[SERVER_CONNECTION?CHANNEL]&Queue%20Manager=[QUEUE_MANAGER]&AuthEnabled=[AUTH_ENABLED]&username=[USER_NAME]&password=[PASS_WORD]&MonitorBroker=[MONITOR_BROKER]&v10=[IS_V10]&BrokerPort=[BROKER_PORT]&BrokerAuthEnabled=[BROKER_AUTHENABLED]&brokerusername=[BROKER_USERNAME]&brokerpassword=[BROKER_PASSWORD]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加する監視のタイプです。値はIBM WebSphere MQにしてください。 |
| host | WebSphere MQサーバーを実行しているホストの名前を指します。 |
| listenerport | IBM WebSphere MQサーバーのリスニング ポート番号です。 |
| displayname | 監視の表示名です。 |
| serverconnectionchannel | WebSphere MQクライアントが通信に使うサーバー接続を指します。 |
| Queue Manager | WebSphere MQクライアントが通信に使うキュー マネージャーの名前です。 |
| SSLEnabled | SSL有効かを示します。trueかfalseを指定してください。 |
| SSLCipherSpec | SSL暗号方式の名前です。 |
| AuthEnabled | 認証が有効になっているか指定してください。trueかfalseにします。 |
| username | WebSphere MQキュー マネージャーに接続するユーザーの名前です。 |
| password | Websphere MQキュー マネージャーへの接続時のパスワードです。 |
| FilterSysObject | システム オブジェクトのフィルターです。trueかfalseにします。 |
| SysObjects | システム オブジェクト監視へ |
| MonitorBroker | メッセージ ブローカーが有効かを示します。trueかfalseにします。 |
| v10 IIB | バージョンが10以上かを示します。trueかfalseにします。 |
| BrokerPort | IBMIntegrationBus(MessageBroker)のポート番号です。適用外の場合は、0を指定してください。 |
| BrokerAuthEnabled | ブローカー認証が有効かを示します。trueかfalseにします。 |
| brokerusername | WebSphereメッセージ ブローカーへの接続に必要なユーザー名を指定してください。 |
| brokerpassword | WebSphereメッセージ ブローカーへの接続に必要なパスワードを指定してください。 |
リクエスト サンプル
http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=bc76b1abb8e9b209824a39d84578a194&type=IBM%20Websphere%20MQ&host=app-server&listenerport=1416&displayname=mqws&serverconnectionchannel=SCCHANEL1&Queue%20Manager=QMANAGER_QA1&AuthEnabled=true&username=test&password=test&&MonitorBroker=true&v10=true&BrokerPort=4416&BrokerAuthEnabled=true&brokerusername=test&brokerpassword=test
Microsoft Message Queue（MSMQ）
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&username=[USER_NAME]&password=[PASS_WORD]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加する監視のタイプです。値はMicrosoft MQにしてください。 |
| host | Microsoft MQサーバーを実行しているホストの名前を指します。 |
| username | MSSQサーバーのユーザー名です。 |
| password | MSSQサーバーのパスワードを指します。 |
リクエスト サンプル
http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=256d041620d0aee9901558b44706dc84&type=Microsoft MQ&displayname=msmq&host=app-server&username=administrator&password=password
RabbitMQ
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST] &port=[PORT]&username=[USER_NAME]&password=[PASS_WORD]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加する監視のカテゴリ タイプを表します。値は「RabbitMQ」にしてください。 |
| host | RabbitMQサーバーを実行しているホストの名前を指します。 |
| port | RabbitMQサーバーが動作するポート番号です。 |
| username | RabbitMQサーバーのユーザー名です。 |
| password | RabbitMQサーバーのパスワードです。 |
リクエスト サンプル
http://app-xp5:9090/AppManager/xml/AddMonitor?apikey=bc76b1abb8e9b209824a39d84578a194&type=VMware vFabric tc Server&displayname=vFabric&host=app-server&port=6969&username=admin&password=admin123&JNDIPath=/jmxrmi
Microsoft BizTalk
構文
http://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=BizTalkServer&displayname=[DISPLAY_NAME]&host=[BIZTALKHOST]&Version=[2013/2016]&username=[USER_NAME]&password=[PASS_WORD]&PowerShell=[true/false]&CredSSP=[YES/FALSE]&DBServer=[DBSERVERHOST]&DBName=[BIZTALKMANAGEMENTDBNAME]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加する監視のカテゴリ タイプです。値はBizTalkServerにします。 |
| host | BizTalkインストール先のホストの名前を指定します。 |
| version |
BizTalk Applicationのバージョンを指します。
|
| UserName | BizTalk Serverホスト マシンのユーザー名です。 |
| Password | BizTalk Serverホスト マシンのパスワードです。 |
| PowerShell | PowerShellが有効かを示します。次の値を指定できます。
|
| DBサーバー | 設定データベースの保存先サーバーの名前を指定してください（PowerShell有効の場合のみ必要）。 |
| DBName | 設定データベースの名前です（PowerShell有効の場合のみ必要）。 |
| CredSSP | PowerShell利用時にCredSSP認証を利用するか指定します（Credential Security Support Provider）。利用時は、yesで有効にしてください。 |
リクエスト サンプル
http://app-x5p:9400/AppManager/xml/AddMonitor?apikey=fcc04ce64410e0dd7ccf72371a79761c&type=BizTalkServer&displayname=BizTalk2016&host=apm-biz1-1&Version=2016&username=[USER_NAME]pm\administrator&Password=Pass123&PowerShell=True&CredSSP=False&DBServer=apm-biz1-1&DBName=BizTalkMgmtDb
http://app-x5p:9400/AppManager/xml/AddMonitor?apikey=ddc04ce64410e0dd7ccf72371a79761c&type=BizTalkServer&displayname=BizTalk2016&host=apm-biz16-1&Version=2013&username=[USER_NAME]pm\administrator&Password=Pass123&PowerShell=False&CredSSP=False
Oracle Tuxedo
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST] &SNMPport=[PORT]&snmpCommunityString=[COMMUNITYSTRING]&timeout=[TIME_OUT]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加する監視のカテゴリ タイプです。値はOracle Tuxedo | にしてください。
| host | Tuxedoインストール先のホストの名前を指定します。 |
| displayname | 監視の表示名です。 |
| SNMPport | Tuxedo SNMPエージェントを実行しているポートの番号です。デフォルトのポート番号は161です。 |
| snmpCommunityString | Tuxedo SNMPエージェントのSNMPコミュニティ文字列です。デフォルトの値は「public」です。最低限、読み込み専用権限のコミュニティ文字列が必要です。 |
| timeout | タイムアウトを指定します（秒）。 |
リクエスト サンプル
http://app-xp5:9090/AppManager/xml/AddMonitor?apikey=a169e7aa3b4656d0db29532fd4347&type=Oracle Tuxedo&displayname=Tuxedo&host=172.31.10.1&SNMPPORT=161&snmpCommunityString=public&timeout=40
Microsoft Skype for Business
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[LyncServer]&displayname=[DISPLAY_NAME]&host=[HOST]&username=[USER_NAME]&password=[PASS_WORD]&Roles=[Roles]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加する監視のカテゴリ タイプです。値はLyncServerにしてください。 |
| host | Skype for Business Serverを実行しているホストのホスト名やIPアドレスを指定します。 |
| displayname | 監視の表示名です。 |
| UserName | 監視Skype for Business Serverの監視に使うユーザー名です。アカウントにはSkype for Business Serverへのアクセス権限が必要です。 |
| password | 上記ユーザーのパスワードです。 |
| Roles | 監視する役割を、カンマ区切りで指定してください。
|
リクエスト サンプル
http://app-xp5:9090/AppManager/xml/AddMonitor?apikey=4787dvds8941bc5a7b0db85d43a5b789&type=LyncServer&displayname=LyncAPI&host=172.31.10.1&UserName=APM\administrator&Password=pass&Roles=FrontEndServer,A/V Conferencing Server,MediationServer
Azure Service Bus
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[AzureServiceBus]&displayname=[DISPLAY_NAME]&SubscriptionID=[SUBSCRIPTION_ID]&Namespace=[NAMESPACE]&timeout=[TIMEOUT]
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| SubscriptionID | Azureサブスクリプションで使うサブスクリプションIDです。 |
| Namespace | Service Busの名前空間を指定します。 |
| timeout | タイムアウトを指定します（秒）。 |
リクエスト サンプル
http://anne-2394:9096/AppManager/xml/AddMonitor?apikey=35eb5a8f77a1595f9d9e575a7c3575ad &type=AzureServiceBus&displayname=azureapmsbadmin&SubscriptionId=1591f1b0-6e8c-461f-8916-df7954193ec2&Namespace=applicationsmanager&Timeout=20
Apache ActiveMQ
構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=ApacheActiveMQ&displayname=[DISPLAY_NAME]&HostName=[HOST_NAME]&port=[PORT]&username=[USER_NAME]&password=[PASS_WORD]&JNDIPath=/jmxrmi
リクエスト パラメーター
APIリクエストにかかわるパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。
| フィールド | 説明 |
|---|---|
| type | 追加するデータベースのタイプです。値はApacheActiveMQにしてください。 |
| displayname | ActiveMQ監視の表示名です。 |
| hostname | ActiveMQ serverを実行しているホストの名前です。 |
| port | ActiveMQ serverが動作するポート番号です。 |
| username | Apache ActiveMQ serverへのアクセス権限があるユーザーの名前を指定します。 |
| JNDIPath | 利用するJNDIパスを指します。 |
リクエスト サンプル
http://prod-server8:9091/AppManager/xml/AddMonitor?apikey=ff5db35538c534e24dc2154cffbc7e6e&type=ApacheActiveMQ&displayname=Success&HostName=app-w8-aio-5&Port=1099&UserName=&Password=&JNDIPath=/jmxrmi