目录 |
REST APIs用于从Network Configuration Manager添加和获取数据。使用这些API,您可以将Network Configuration Manager与不同类型的第三方IT管理软件集成。
API需要使用API密钥。API密钥对于每个Network Configuration Manager帐户都是唯一的,并且必须在发出的每个API请求中作为参数传递。
要生成API密钥,请在Network Configuration Manager流畅的新客户端中进入设置 → REST API,然后点击“生成密钥”。
示例URL:http://localhost:portnumber/api/json/
API名称 |
描述 |
方式 |
参数 |
模块名称: ncmsettings |
|||
listAllConfiglets |
列出所有配置命令 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
listExecutionHistory |
列出配置命令的执行历史 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
allSchedules |
列出所有计划 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
backupSchedules |
列出备份计划 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
allshowCommands |
列出所有Show命令 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
exportConfigs |
根据操作类型列出导出配置历史记录 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
pendingRequests |
列出待批准的请求 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
approvedRequests |
列出已批准的请求 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
rejectedRequests |
列出拒绝的请求 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
labelList |
列出所有标签 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
scheduleAudit |
列出进度计划的所有执行结果 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
reviewersList |
列出所有审阅者列表 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
credProfList |
列出所有凭证配置文件列表 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
detailedResult |
获取配置命令的详细执行结果 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
addDevice |
添加非SNMP设备 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
assocCredential |
将凭证关联到设备 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
updateConfiglet |
创建新的配置命令或更新现有的配置命令 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
deleteTemplate |
删除配置命令 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
discoveryStatus |
列出发现状态 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
discoveryDetailsStatus |
列出特定发现的详细状态 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
addDiscovery |
发现特定的IP地址或网络 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
getSNMPProfiles |
列出所有SNMP配置文件 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
vendorList |
列出NCM支持的所有供应商 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
deviceType |
列出特定供应商支持的所有设备类型 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getDiscoveryInfo |
使用调用时间获取发现状态 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
checkDNSName |
检查设备的DNS是否已解析 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
pingCheck |
Ping特定的设备 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getCredentials |
获取特定设备的凭证 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
addSharedProfile |
添加共享配置文件 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
DelCustTempAudit |
删除特定的配置命令审计 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
updateSchedule |
更新特定的计划 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
updateSharedProfile |
更新特定的共享配置文件 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
deleteTemplateAudit |
删除特定的配置命令审计 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
deleteScheduleAudit |
删除特定的计划审计 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
deleteCredentials |
删除特定的凭证 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
SnmpRefDevDet |
列出SNMP引用的设备详细信息 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
addLabel |
添加新的标签 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
addReviewer |
添加新的审阅者 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
deleteReviewer |
删除特定的审阅者 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
updateLabel |
更新特定的标签 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
deleteLabel |
删除特定的标签 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
addShowCommand |
添加新的show命令 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
deleteShowCommand |
删除特定的show命令 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
addCustomColumn |
添加自定义列 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
allSysOID |
列出所有的SYSOID |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
customSysOID |
列出所有的自定义SYSOID |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
execConfiglet |
执行特定的配置命令 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
detailedExecResult |
获取详细的执行结果 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
updateServerSettings |
更新服务器设置 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
executeDBQuery |
在NCM的数据库控制台中执行查询 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
addExcludeCriteria |
添加新的排除自定义条件 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
personalityList |
列出所有人员 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
excludeCriteriaPreRenders |
特定排除自定义条件的预渲染 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
deleteExcludeCriteria |
删除特定的自定义标准 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
excludeCriteria |
列出所有的排除标准 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
findSysObjectId |
查找特定设备的SYSObject ID |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
addSysOID |
添加新的SYSOID |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
updateSysLocationDesc |
更新系统的位置和描述 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
deleteSysOID |
删除SYSOID |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
exportConfigets |
以XML格式导出特定的配置命令 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
getUsersToAddReviewer |
将用户添加为审阅者 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
mailSettings |
更新邮件服务器设置 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
labelConfigDetails |
列出与特定标签关联的设备及其配置 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
saveandTestResult |
保存凭证并对提供的凭证执行测试 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
rebranding |
更新品牌重命名的详细信息 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
snmpTrapSettings |
更新SNMP陷阱设置 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
syslogForwarder |
更新SYSLOG转发器 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
proxySettings |
更新代理服务器设置 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
proxySettingsTest |
测试代理服务器设置 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
troubleTicket |
更新故障工单设置 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
databaseCleanup |
更新数据库清理设置 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
logLevel |
更新日志级别设置 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
approveRequest |
批准上传请求 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
模块名称:ncmdevice |
|||
listAllDevices |
列出所有设备 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
listOSModelDevices |
根据特定的操作系统型号列出设备 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
devSummary |
获取特定设备的详细信息 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
updateDevSummary |
更新特定设备的详细信息 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
getDevConfiglets |
列出在特定设备上执行的配置命令历史记录 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getCurrentConfig |
列出特定设备的当前配置 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
deleteDevice |
删除特定的设备 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
addDeviceGroup |
添加新的设备组 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
deleteDeviceGroup |
删除特定的设备组 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
listDeviceGroup |
列出所有设备组 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
deviceGroupResources |
列出按特定设备组进行分组的设备 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
manage |
管理设备 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
unmanage |
取消管理设备 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
stopOperation |
停止特定设备上的当前操作 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
eolDataNotAvailable |
列出所有EOL数据不可用的设备 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
eolDevices |
列出所有EOL设备 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
eolAnnouncedDevices |
列出所有EOL已宣布的设备 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
updateIpAddress |
更新特定设备的IP地址 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
updateDNS |
更新特定设备的DNS |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
getResourceIds |
获取特定IP地址的资源ID |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
matchingDevices |
根据特定条件获取匹配的设备 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getResourcesForGroups |
获取按特定设备组进行分组的设备 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
searchResult |
获取设备上搜索字符串的搜索结果 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
searchResultforConfig |
获取配置中搜索字符串的搜索结果 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getDevInterfaces |
列出特定设备上的接口 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
listDeviceGroups |
根据仅显示公共设备组列出设备组 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
exeChangeDetection |
更新特定设备的更改检测 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
exeLabelCurrConfig |
标记当前配置 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
performStatusCheck |
对设备执行状态检查 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
uploadConfigDevices |
在特定设备上上传配置 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
exeUploadConfig |
将配置上传到设备 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
deviceTemplates |
列出所有设备模板 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
executeCommands |
执行Show命令 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
showCommandOutput |
显示Show命令的输出 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
isIPAvailable |
检查IP地址是否可用 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
configConflicts |
快速列出设备组开始运行的冲突 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
configNoConflicts |
获取设备组中没有启动运行数据的设备 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
configNotBackedUp |
获取设备组中没有备份数据的设备 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
markEOL |
将设备标记为EOL |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
getResources |
获取可供用户使用的设备 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getConfigContents |
获取设备的配置内容 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
pingTraceRouteResponse |
显示Ping或跟踪路径命令的结果 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
模块名称:ncmcompliance |
|||
getDevComplianceList |
获取设备合规性列表 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getComplianceList |
列出所有合规策略 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getAllGroups |
列出所有规则组 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getAllRules |
列出所有规则 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getComplianceDetails |
列出违反合规策略的设备 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getRuleCompliances |
在合规政策中列出违规严重程度的规则,包含严重的,主要的和告警 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
addRule |
添加新的规则 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
copyRule |
复制现有规则 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
deleteRule |
删除特定规则 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
addRuleGroup |
添加新的规则组 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
deleteRuleGroup |
删除特定规则组 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
addCompPolicy |
添加新的合规策略 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
deleteCompPolicy |
删除特定的合规性策略 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
complainceCheck |
执行合规性检查 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getResPolicyInfo |
获取资源策略信息 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
policyAdhocResult |
获取合规性策略的临时测试结果 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
ruleAdhocTestResult |
获取合规性规则的临时测试结果 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
exeAssocCompDev |
将合规政策与设备相关联 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
getAllReviews |
列出所有审核 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getMyReviews |
列出特定的用户审核 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getReviewDetails |
列出审查的详细信息 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
reviewPCI |
审核PCI |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
complianceStatus |
显示特定设备组的合规性状态 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
pciReviewStatus |
根据状态列出PCI审查 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
模块名称:ncmchanges |
|||
listAllConfigs |
列出所有配置 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getAllVersions |
列出所有版本 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getDevConfigs |
针对特定设备的列表配置 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getDevChanges |
列出设备中的所有变更 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getRecentChangeList |
列出最近的变更列表 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getCurrentConfigFiles |
列出当前配置 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
configChangeVersions |
获取配置变更的详细信息 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getDiffdetails |
获取配置中的差异内容 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
startupRunningVersion |
获取特定资源的启动和运行版本 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getConfigFileDetails |
获取配置文件的详细信息 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getConfigSiblings |
获取版本的详细信息 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
editConfigFileProp |
更新配置文件属性 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
exeConfSync |
将运行复制到启动配置 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
addChangeRule |
添加新的变更规则 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
updateChangeRule |
更新变更规则 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
changeAssocDev |
将变更规则与设备相关联 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
newDraft |
添加新草稿 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
deleteDraft |
删除特定的草稿 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
getVersionDetails |
获取版本的详细信息 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
authorize |
授权变更 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
assocLabel |
将标签与配置相关联 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
exportConfigVersion |
以文件格式导出配置版本 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
complianceCheck |
执行合规性检查 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getLabelDetails |
列出标签 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
exportConfigNow |
立即导出配置 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
getDevDrafts |
列出与设备关联的草稿 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getAllDrafts |
列出所有草稿 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getDraftDetails |
获取草稿详细信息 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getBaseLineConfig |
获取基线配置 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
模块名称:ncmbackup |
|||
getBackupsList
|
列出所有备份 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getLastBackupsList |
列出上次备份 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
exeBackup |
在特定设备上执行备份操作 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
addScheduleforConfig |
为配置备份添加新的计划 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
getRecentBackups |
列出最近的备份 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
enableSceduleConfig |
启用或禁用计划配置 |
post |
apiKey - 用于访问您NCM服务器的API密钥 |
exeBackedupDeviceList |
列出备份的设备 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |
getNotBackedupDeviceList
|
列出未备份的设备列表 |
get |
apiKey - 用于访问您NCM服务器的API密钥 |