ManageEngine® Applications Manager


凭证管理器

<< 上一页

主页

下一页 >>

凭证管理器API

 

凭证管理器REST API允许管理员通过提交需要的参数添加、更新、删除和列出凭证。凭证管理器API支持GET和POST请求：

 

添加凭证管理器

该API允许管理员用户在Applications Manager中添加凭证。关于执行该API请求的通用参数如下：

 

字段 描述        
credentialName 输入唯一的凭证名称
type 您需要指定凭证类型，应该是语法中提供的类型之一。
credentialDescr 凭证描述
credentialID Applications Manager为凭证设置的唯一标识符。

 

字段 描述        
服务器
远程登录

所需参数：

  • type
  • username
  • prompt
  • password

语法：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Telnet&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&username=[USERNAME]&prompt=$&password=[PASSWORD]

 

示例请求：
http://apm-server:9090/AppManager/xml/credential?apikey=05b4a12a5fc0747cfaa897850ae9a778&type=Telnet&credentialDescr=Test&credentialName=Telnet&username=test&prompt=$&password=test
SNMP v1/v2

所需参数：

  • type
  • snmpCommunityString
  • timeout

语法：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=SNMP v1v2&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&snmpCommunityString=[COMMUNITY STRING]&timeout=[MINUTES]

 

示例请求：
http://apm-server:9090/AppManager/xml/credential?apikey=05b4a12a5fc0747cfaa897850ae9a778&type=SNMP v1v2&credentialDescr=Test&credentialName=Credential-SNMPv2&snmpCommunityString=public&timeout=5
SNMP v3

所需参数：

  • type
  • snmpAuthProtocol
  • snmpContextName
  • snmpPrivPassword
  • snmpAuthPassword
  • snmpSecurityLevel
  • timeout
  • snmpUserName

语法：
https://apm-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&type=SNMP v3&snmpAuthProtocol=[MD5 or SHA]&credentialName=[CREDENTIAL NAME]&snmpContextName=[CONTEXT NAME]&snmpPrivPassword=[PRIVATE PASSWORD]&snmpSecurityLevel=[NOAUTHNOPRIV or AUTHNOPRIV or AUTHPRIV]&snmpAuthPassword=[AUTHENTICATION PASSWORD]&timeout=[MINUTES]&snmpUserName=[USERNAME]

 

示例请求：
https://apm-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&snmpAuthProtocol=MD5&credentialName=snmp-v3-1&snmpContextName=cusu4NfK6N0s6b&snmpPrivPassword=&snmpSecurityLevel=NOAUTHNOPRIV&snmpAuthPassword=&type=SNMP v3&timeout=5&snmpUserName=admin
SSH

所需参数：

  • type
  • username
  • passphrase
  • description
  • prompt
  • password
  • sshPKAuth

语法：
https://apm-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&type=SSH&credentialName=[CREDENTIAL NAME]&username=[USERNAME]&passphrase=[PASS PHRASE]&description=[PRIVATE KEY]&prompt=[PROMPT]&password=[PASSWORD]&sshPKAuth=on

 

示例请求：
https://apm-server:9090/AppManager/xml/credential/add?apikey=4dd329f4b42f64c29013c591138eac2a&credentialName=ssh-1&username=guest&passphrase=&description=&prompt=$&type=SSH&password=guest
WMI

所需参数：

  • type
  • username
  • password

语法：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=WMI&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&username=[USERNAME]&password=[PASSWORD]

 

示例请求：
http://apm-server:9090/AppManager/xml/credential?apikey=05b4a12a5fc0747cfaa897850ae9a778&type=WMI&credentialDescr=Test&credentialName=WMI&username=administrator&password=admin123
Application servers
GlassFish

所需参数：

  • type
  • Password
  • JNDIPath
  • UserName

语法：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=GlassFish&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&UserName=[USERNAME]&Password=[PASSWORD]&JNDIPath=[PATH]

 

示例请求：
http://apm-server:9090/AppManager/xml/credential?apikey=05b4a12a5fc0747cfaa897850ae9a778&type=GlassFish&credentialDescr=Test&credentialName=Glassfish1&UserName=admin&Password=adminadmin&JNDIPath=/jmxrmi
JBoss Server

所需参数：

  • type
  • username
  • password
  • sslenabled

语法：
https://apm-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&type=JBoss Server&credentialName=[CREDENTIAL NAME]&username=[USERNAME]&password=[PASSWORD]&sslenabled=on

 

示例请求：
https://apm-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&credentialName=jboss-2&username=admin&type=JBoss Server&password=password123&sslenabled=on
Microsoft .NET

所需参数：

  • type
  • username
  • password

语法：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Microsoft .NET&credentialName=[CREDENTIANL NAME]&username=[USERNAME]&password=[PASSWORD]&credentialDescr=[CREDENTIAL DESCRIPTION]

 

示例请求：
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=Microsoft .NET&credentialName=.Net1&username=administrator&password=password123&credentialDescr=This is .net credential.
VMware vFabric tc Server

所需参数：

  • type
  • Password
  • JNDIPath
  • UserName

语法：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=VMware vFabric tc Server&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&Password=[PASSWORD]&JNDIPath=[JNDI PATH]&UserName=[USERNAME]

 

示例请求：
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=VMware vFabric tc Server&credentialName=vFabric1&Password=springsource&JNDIPath=/jmxrmi&UserName=admin
WebLogic Server

所需参数：

  • type
  • username
  • password
  • version

语法：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=WebLogic Server&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&username=[USERNAME]&password=[PASSWORD]&version=[WLS_6_1 or WLS_7_0 or WLS_8_1 or WLS_9_0 or WLS_10_0]

 

示例请求：
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=WebLogic Server&credentialName=Weblogic6.1&username=weblogic&password=weblogic&version=WLS_6_1
WebSphere Server

所需参数：

  • type
  • soapport
  • username
  • authEnabled
  • password
  • sslenabled
  • version

语法：
https://apm-server:9090/AppManager/xml/credential?apikey=[APIKEY]&type=WebSphere Server&soapport=[SOAP PORT]&credentialName=[CREDENTIAL NAME]&username=[USERNAME]&authEnabled=on&password=[PASSWORD]&version=[5 or 6 or 7 or 8]&sslenabled=on

 

示例请求：
https://apm-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&type=WebSphere Server&soapport=8880&credentialName=websphere7.x&username=wasadmin&authEnabled=on&password=admin&version=8&sslenabled=on
Apache Server

所需参数：

  • type
  • username
  • authEnabled
  • password
  • sslenabled

语法：
https://apm-server:9090/AppManager/xml/credential?apikey=[APIKEY]&type=Apache Server&credentialName=[CREDENTIAL NAME]&username=[USERNAME]&authEnabled=on&password=[PASSWORD]&sslenabled=on

 

示例请求：
https://apm-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&type=Apache Server&credentialName=Apache-1&username=test&authEnabled=on&password=test&sslenabled=on
Tomcat Server

所需参数：

  • type
  • username
  • password
  • sslenabled
  • version
  • tomcatmanagerurl

语法：
https://apm-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&tomcatmanagerurl=[TOMCAT MANAGER URL]&credentialName=[CREDENTIAL NAME]&username=[USERNAME]&type=Tomcat Server&password=e6Lg48eOS0331s&sslenabled=on&version=[3 or 4 or 5 or 6 or 7]

 

示例请求：
https://apm-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&tomcatmanagerurl=/manager&credentialName=Tomcat6&username=tomcat&type=Tomcat Server&password=tomcat&sslenabled=on&version=7
Java/Transactions
Java Runtime

所需参数：

  • type
  • jndiurl
  • authEnabled
  • username
  • password

语法：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Java Runtime&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&jndiurl=[JNDIURL]&authEnabled=on&username=[USERNAME]&password=[PASSWORD]

 

示例请求：
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=Java Runtime&credentialName=JavaRuntime1&jndiurl=/jmxrmi&authEnabled=on&username=admin&password=admin
Database
DB2

所需参数：

  • type
  • username
  • password
  • instance

语法：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=DB2&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&username=[USERNAME]&password=[PASSWORD]&instance=[DB NAME]

 

示例请求：
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=DB2&credentialName=DB2 server1&username=db2admin&password=db2admin&instance=SAMPLE
MS SQL

所需参数：

  • type
  • namedInstance
  • username
  • authType
  • instance
  • password

语法：
https://apm-server:9090/AppManager/xml/credential?apikey=[APIKEY]=MS SQL&credentialName=[CREDENTIAL NAME]&username=[USERNAME]&namedInstance=on&authType=[SQL or Windows]&instance=[INSTANCE]&password=[PASSWORD]

 

示例请求：
https://apm-server:9090/AppManager/xml/credential?apikey=4dd329f4b42f64c29013c591138eac2a&type=MS SQL&credentialName=SQL Server1&username=sa&namedInstance=on&authType=SQL&instance=instance&password=password123
MySQL

所需参数：

  • type
  • username
  • password
  • instance

语法：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=MySQL&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&username=[USERNAME]&password=[PASSWORD]&instance=[DB NAME]

 

示例请求：
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=MySQL&credentialName=MySQL4&username=root&password=root&instance=test
Oracle

所需参数：

  • type
  • Password
  • UserName

语法：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Oracle&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&username=[USERNAME]&password=[PASSWORD]

 

示例请求：
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=Oracle&credentialName=Oracle11.0.4&username=system&password=password123
PostgreSQL

所需参数：

  • type
  • username
  • password
  • DBname

语法：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=PostgreSQL&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&UserName=[USERNAME]&Password=[PASSWORD]&DBname=[DB NAME]

 

示例请求：
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=PostgreSQL&credentialName=PostgreSQL3&UserName=postgres&Password=postgres&DBname=postgre
Sybase

所需参数：

  • type
  • username
  • instance
  • password

语法：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Sybase&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&username=[USERNAME]&instance=[INSTANCE NAME]&password=[PASSWORD]

 

示例请求：
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=Sybase&credentialName=Sybase server 4&username=sa&instance=test&password=test123
MongoDB

所需参数：

  • type
  • authreq
  • username
  • password

语法：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=MongoDB&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&authreq=on&username=USERNAME&password=[PASSWORD]

 

示例请求：
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&credentialName=MongoDB7&authreq=on&type=MongoDB&username=root&password=root
Cassandra

所需参数：

  • type
  • username
  • authreq
  • password type=Cassandra

语法：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Cassandra&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&username=USERNAME&authreq=on&password=[PASSWORD]

 

示例请求：
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=Cassandra&credentialName=Cassandra1&username=cassandra&authreq=on&password=cassandra
Middleware/Portal
Microsoft MQ (MSMQ)

所需参数：

  • type
  • Password
  • UserName

语法：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=Microsoft MQ (MSMQ)&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&Password=d6pM4M2&UserName=USERNAME

 

示例请求：
http://apm-server:9090/AppManager/xml/credential?apikey=a864e174c664b8661e7d8c3a07692b0e&type=Microsoft MQ (MSMQ)&credentialName=MSMQ4&Password=Admin123&UserName=administrator
MS Office SharePoint

所需参数：

  • type
  • Password
  • UserName

语法：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=MS Office SharePoint&credentialDescr=[CREDENTIAL_DESCRIPTION]&credentialName=[CREDENTIANL_NAME]&Password=[PASSWORD]&UserName=[USERNAME]

 

示例请求：
http://apm-server:9090/AppManager/xml/credential?apikey=05b4a12a5fc0747cfaa897850ae9a778&type=MS Office SharePoint&credentialDescr=Test&credentialName=MS Sharepoint3&Password=Password123&UserName=administrator
RabbitMQ

所需参数：

  • type
  • Password
  • UserName

语法：
http://[HOST]:[PORT]/AppManager/xml/credential?apikey=[APIKEY]&type=RabbitMQ&credentialDescr=[CREDENTIAL DESCRIPTION]&credentialName=[CREDENTIANL NAME]&Password=[PASSWORD]&UserName=[USERNAME]

 

示例请求：
http://apm-server:9090/AppManager/xml/credential?apikey=05b4a12a5fc0747cfaa897850ae9a778&type=RabbitMQ&credentialDescr=Test&credentialName=RabbitMQ5&Password=guest&UserName=guest

 

编辑/更新凭证

该API允许管理员用户通过提供所需参数编辑已有凭证。

 

语法

对于XML响应：

http://[ APM Host ]:[ APM Port ]/AppManager/xml/credential?apikey=[APIKEY]&credentialID=[CREDENTIAL_ID]&..

 

对于JSON响应：

http://[ APM Host ]:[ APM Port ]/AppManager/json/credential?apikey=[APIKEY]&credentialID=[CREDENTIAL_ID]&..

示例

http://app-windows:59090/AppManager/xml/credential?apikey=05b4a12a5fc0747cfaa897850ae9a778&credentialID=10&password=newpassword

 

删除凭证

我们可以通过给出凭证ID来删除凭证，凭证ID必须是整数。

 

语法

对于XML响应：

http://[ APM Host ]:[ APM Port ]/AppManager/xml/credential?apikey=[APIKEY]&type=[TYPE]&credentialID=[CREDENTIAL_ID]&TO_DELETE=true

 

对于JSON响应：

http://[ APM Host ]:[ APM Port ]/AppManager/json/credential?apikey=[APIKEY]&type=[TYPE]&credentialID=[CREDENTIAL_ID]&TO_DELETE=true

示例

http://app-windows:59090/AppManager/xml/credential?apikey=05b4a12a5fc0747cfaa897850ae9a778&credentialID=10&TO_DELETE=true

凭证列表

该API允许管理员用户在Applications Manager中列出凭证。格式为xml和json。类型的值为“所有”或一个指定的类型。

 

语法

对于XML响应：

http://[ APM Host ]:[ APM Port ]/AppManager/xml/credential/list?apikey=[APIKEY]&type=[TYPE]

 

对于JSON响应：

http://[ APM Host ]:[ APM Port ]/AppManager/json/credential/list?apikey=[APIKEY]&type=[TYPE]

示例

http://app-windows:59090/AppManager/xml/credential/list?apikey=05b4a12a5fc0747cfaa897850ae9a778&type=all

页首

<< 上一页

主页

下一页 >>

配置告警

域配置

IT管理解决方案  |  Applications Manager
版权所有 © 2016 - ZOHO Corp.保留所有权利