API名称

描述

方式

参数

模块名称: ncmsettings

listAllConfiglets

列出所有配置命令

get

apiKey - 用于访问您NCM服务器的API密钥

listExecutionHistory

列出配置命令的执行历史

get

apiKey - 用于访问您NCM服务器的API密钥

allSchedules

列出所有计划

get

apiKey - 用于访问您NCM服务器的API密钥
taskType - 任务类型

backupSchedules

列出备份计划

get

apiKey - 用于访问您NCM服务器的API密钥
taskType - 任务类型

allshowCommands

列出所有Show命令

get

apiKey - 用于访问您NCM服务器的API密钥

exportConfigs

根据操作类型列出导出配置历史记录

get

apiKey - 用于访问您NCM服务器的API密钥
OPERATION_TYPE - 操作类型

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密钥
resourceId - 设备ID
executionId - 执行ID

addDevice

添加非SNMP设备

post

apiKey - 用于访问您NCM服务器的API密钥
IPADDRESS - 设备的IP地址
DEVICE_BEHAVIOUR - 设备行为
SERIES - 系列
MODEL - 型号
COLUMNNAME1-COLUMNNAME1
COLUMNNAME2-COLUMNNAME2

assocCredential

将凭证关联到设备

post

apiKey - 用于访问您NCM服务器的API密钥
UPDATE_TYPE - 更新类型
BACKUP_STATUS - 备份状态(True或者Flase)
TEST_CRED - 测试凭证
RESOURCEID_LIST - 资源ID列表(以逗号分隔)
protocolCombinationList - 协议组合列表
SNMP_PROFILELIST - SNMP配置文件列表
SNMP_NATIP - SNMP NATIP地址
TELNET_PROFILELIST - Telnet配置文件列表
TELNET_NATIP - Telnet NATIP地址
SSH_PROFILELIST-SSH配置文件列表
SSH_NATIP - SSH NATIP地址
SNMP_VERSION - SNMP版本
SNMP_PORT - SNMP端口
SNMP_READCOMMUNITY - SNMP读取社区
SNMP_USERNAME - SNMP用户名称
SNMP_CONTEXTNAME - SNMP上下文名称
SNMP_AUTHPROTOCOL - SNMP身份验证协议
SNMP_AUTHPASSWORD - SNMP身份验证密码
SNMP_PRIVPROTOCOL - SNMP Priv协议
SNMP_PRIVPASSWORD - SNMP Priv密码
TELNET_LOGINNAME - Telnet登录名称
TELNET_PASSWORD - Telnet密码
TELNET_PROMPT - Telnet提示
TELNET_ENABLEUSERNAME - Telnet启用用户名
TELNET_ENABLEPASSWORD - Telnet启用密码
TELNET_ENABLEPROMPT - Telnet启用提示
TELNET_PORT - Telnet端口
TELNET_LOGINPROMPT - Telnet登录提示
TELNET_PASSWORDPROMPT - Telnet密码提示
TELNET_ENABLEUSERNAMEPROMPT - Telnet启用用户名提示
TELNET_ENABLEPASSWORDPROMPT - Telnet启用密码提示
SSH_LOGINNAME - SSH登录名称
SSH_PASSWORD - SSH密码
SSH_PROMPT - SSH提示
SSH_ENABLEUSERNAME - SSH启用用户名
SSH_ENABLEPASSWORD - SSH启用密码
SSH_ENABLEPROMPT - SSH启用提示
SSH_PORT - SSH端口
SSH_LOGINPROMPT - SSH登录提示
SSH_PASSWORDPROMPT - SSH密码提示
SSH_ENABLEUSERNAMEPROMPT - SSH启用用户名提示
SSH_ENABLEPASSWORDPROMPT - SSH启用密码提示

updateConfiglet

创建新的配置命令或更新现有的配置命令

post

apiKey - 用于访问您NCM服务器的API密钥
DESCRIPTION - 关于配置命令的说明
CONTENTS - 配置命令的内容
TEMPLATE_TYPE - 模板类型
TEMPLATE_ID - 模板ID
BACKUP_ENABLED - 启用备份
NAME - 模板名称
CUSTOM_TEMPLATE_MODIFIED - 修改的配置命令

deleteTemplate

删除配置命令

post

apiKey - 用于访问您NCM服务器的API密钥
CONFIGLETS - 配置命令ID

discoveryStatus

列出发现状态

get

apiKey - 用于访问您NCM服务器的API密钥

discoveryDetailsStatus

列出特定发现的详细状态

get

apiKey - 用于访问您NCM服务器的API密钥
taskId - 任务ID

addDiscovery

发现特定的IP地址或网络

post

apiKey - 用于访问您NCM服务器的API密钥
TIMEOUT - 发现超时
RETRIES - 发现的重试次数
DISC_TYPE - 发现类型
HOST - 主机名称
START_ADDR - 网络起始IP地址
END_ADDR - 网络结束IP地址

getSNMPProfiles

列出所有SNMP配置文件

get

apiKey - 用于访问您NCM服务器的API密钥

vendorList

列出NCM支持的所有供应商

get

apiKey - 用于访问您NCM服务器的API密钥

deviceType

列出特定供应商支持的所有设备类型

get

apiKey - 用于访问您NCM服务器的API密钥
VENDOR_NAME - 供应商名称

getDiscoveryInfo

使用调用时间获取发现状态

get

apiKey - 用于访问您NCM服务器的API密钥
taskId - 任务ID

checkDNSName

检查设备的DNS是否已解析

get

apiKey - 用于访问您NCM服务器的API密钥
IPADDRESS - IP地址

pingCheck

Ping特定的设备

get

apiKey - 用于访问您NCM服务器的API密钥
IPADDRESS - IP地址

getCredentials

获取特定设备的凭证

get

apiKey - 用于访问您NCM服务器的API密钥
resourceIds - 资源ID

addSharedProfile

添加共享配置文件

post

apiKey - 用于访问您NCM服务器的API密钥
IS_SNMP_PROFILE - 是SNMP配置文件
PROFILENAME - 配置文件名称
snmp_port - SNMP端口
snmp_version - SNMP版本
snmp_username - SNMP用户名称
snmp_contextname - SNMP上下文名称
snmp_authprotocol - SNMP身份验证协议
snmp_privprotocol - SNMP Priv协议
snmp_authpassword - SNMP身份验证密码
snmp_privpassword - SNMP Priv密码
snmp_readcommunity - SNMP读取社区
snmp_writecommunity - SNMP写社区
telnet_loginname - Telnet登录名
telnet_password - Telnet密码
telnet_prompt - Telnet提示
telnet_enableUserName - Telnet启用用户名
telnet_enablepassword - Telnet启用密码
telnet_enableprompt - Telnet启用提示
ssh_loginname - SSH登录名
ssh_password - SSH密码
ssh_prompt - SSH提示
ssh_enableUserName - SSH启用用户名
ssh_enablepassword - SSH启用密码
ssh_enableprompt - SSH启用提示
PROFILEDESCRIPTION - 配置文件描述

DelCustTempAudit

删除特定的配置命令审计

post

apiKey - 用于访问您NCM服务器的API密钥
EXECUTION_ID - 配置命令的执行ID

updateSchedule

更新特定的计划

post

apiKey - 用于访问您NCM服务器的API密钥
SCHEDULE_ID - 计划ID
TASK_TYPE - 任务类型
REPORT_TEMPLATE_NAME - 报表模板名称
REPORT_DURATION - 报表持续时间
REPORT_FILE_TYPE - 报表文件类型
START_ADDR - 网络起始IP地址
END_ADDR - 网络结束IP地址
ComponentSelection - 组件选择
valuesSelectionType - 值选择类型
DEVICEGROUPSELECTION - 设备组选择
FILENAME - 文件名称
SELECTEDDEVICES - 选择的设备
QUERYID - 查询ID
COMPLIANCE_SHOW_RESULT - 合规性显示结果
CUSTOM_TEMPLATE_ID - 配置ID
BACKUP_ENABLED - 启用备份
VAR_NAME - 变量名称
VARIABLES - 变量
EMAIL_RECIPIENTS - 电子邮件收件人
BKPNOTIF_CONDITION - 备份通知条件
BKPNOTIF_CONDITION_CONFIG_CHANGE - 备份通知配置更改条件
EXCLUDE_CONFIG_CHANGE_IN_MAIL - 排除邮件中的更改
COMPNOTIF_CONDITION - 合规性通知条件
SYNCNOTIF_CONDITION - 同步通知条件
SCHEDULE_TYPE - 计划类型
HOURLY_START_DATE - 每小时开始日期
HOURLY_START_TIME_HOUR - 每小时开始的时间，以小时为单位
HOURLY_START_TIME_MIN - 每小时开始的时间，以分钟为单位
HOURLY_INTERVAL - 每小时间隔
DAILY_START_DATE - 每日开始日期
DAILY_START_TIME_HOUR - 每日开始时间，以小时为单位
DAILY_START_TIME_MIN - 每日开始时间，以分钟为单位
WEEKLY_START_TIME_HOUR - 每周开始时间，以小时为单位
WEEKLY_START_TIME_MIN - 每周开始时间，以分钟为单位
WEEKLY_DAYS - 工作日
MONTHLY_START_TIME_HOUR - 每月开始时间，以小时为单位
MONTHLY_START_TIME_MIN - 每月开始时间，以分钟为单位
MONTHLY_MONTHS - 每月月份
MONTHLY_DATE_OF_MONTH - 每月一次的日期
ONCEONLY_START_TIME_HOUR - 单次开始时间，以小时为单位
ONCEONLY_START_TIME_MIN - 单次开始时间，以分钟为单位
ONCEONLY_START_DATE - 单次开始时间日期
CUSTOM_TEMPLATE_MODIFIED - 配置命令已修改
SCHEDULE_STATUS - 计划状态

updateSharedProfile

更新特定的共享配置文件

post

apiKey - 用于访问您NCM服务器的API密钥
PROFILEID - 配置文件ID
PROFILENAME - 配置文件名称
snmp_port - SNMP端口
snmp_version - SNMP版本
snmp_username - SNMP用户名
snmp_contextname - SNMP上下文名称
snmp_authprotocol - SNMP身份验证协议
snmp_privprotocol - SNMP Priv协议
snmp_authpassword - SNMP身份验证密码
snmp_privpassword - SNMP Priv密码
snmp_readcommunity - SNMP读取社区
snmp_writecommunity - SNMP写社区
telnet_loginname - Telnet登录名
telnet_password - Telnet密码
telnet_prompt - Telnet提示
telnet_enableUserName - Telnet启用用户名
telnet_enablepassword - Telnet启用密码
telnet_enableprompt - Telnet启用提示
ssh_loginname - SSH登录名
ssh_password - SSH密码
ssh_prompt - SSH提示
ssh_enableUserName - SSH启用用户名
ssh_enablepassword - SSH启用密码
ssh_enableprompt - SSH启用提示
PROFILEDESCRIPTION - 配置文件描述

deleteTemplateAudit

删除特定的配置命令审计

post

apiKey - 用于访问您NCM服务器的API密钥
EXECUTION_ID - 配置命令的执行ID

deleteScheduleAudit

删除特定的计划审计

post

apiKey - 用于访问您NCM服务器的API密钥
AUDIT_ID - 审计ID

deleteCredentials

删除特定的凭证

post

apiKey - 用于访问您NCM服务器的API密钥
PROFILEID - 配置文件ID

SnmpRefDevDet

列出SNMP引用的设备详细信息

get

apiKey - 用于访问您NCM服务器的API密钥
PROFILEID - 配置文件ID

addLabel

添加新的标签

post

apiKey - 用于访问您NCM服务器的API密钥
LABEL_NAME - 标签名称
DESCRIPTION - 标签描述

addReviewer

添加新的审阅者

post

apiKey - 用于访问您NCM服务器的API密钥
LOGIN_ID - 用户的登录ID
EMAIL_ID - 用户的电子邮件ID

deleteReviewer

删除特定的审阅者

post

apiKey - 用于访问您NCM服务器的API密钥
LOGIN_ID - 用户的登录ID

updateLabel

更新特定的标签

post

apiKey - 用于访问您NCM服务器的API密钥
LABEL_ID - 标签ID
DESCRIPTION - 标签描述

deleteLabel

删除特定的标签

post

apiKey - 用于访问您NCM服务器的API密钥
OPERATIONTYPE - 操作类型
LABEL_ID - 标签ID
FILE_ID - 文件ID

addShowCommand

添加新的show命令

post

apiKey - 用于访问您NCM服务器的API密钥
COMMAND_ID - 命令ID
ALIAS - 命令别名
COMMAND - 命令
VENDOR - 供应商

deleteShowCommand

删除特定的show命令

post

apiKey - 用于访问您NCM服务器的API密钥
COMMAND_ID - 命令ID

addCustomColumn

添加自定义列

post

apiKey - 用于访问您NCM服务器的API密钥
COLUMN_NAME1 - 列名称1
COLUMN_VALUE1 - 列值1
COLUMN_NAME2 - 列名称2
COLUMN_VALUE2 - 列值2
COLUMN_NAME3 - 列名称3
COLUMN_VALUE3 - 列值3

allSysOID

列出所有的SYSOID

get

apiKey - 用于访问您NCM服务器的API密钥

customSysOID

列出所有的自定义SYSOID

get

apiKey - 用于访问您NCM服务器的API密钥

execConfiglet

执行特定的配置命令

post

apiKey - 用于访问您NCM服务器的API密钥
EXEC_TYPE - 执行类型
TEMPLATE_NAME - 配置命令名称
TEMPLATE_TYPE - 配置命令类型
ASSIGNED_RESOURCES - 分配的资源
ComponentSelection - 组件选择
DEVICEGROUPSELECTION - 设备组选择
SELECTEDDEVICES - 选择的设备
TEMPLATE_ID - 配置命令ID
TEMPLATE_CONTENTS - 配置命令的内容
BACKUP_ENABLED - 启用备份
VAR_NAME - 变量名称
VARIABLES - 变量

detailedExecResult

获取详细的执行结果

get

apiKey - 用于访问您NCM服务器的API密钥
EXECUTION_ID - 执行ID

updateServerSettings

更新服务器设置

post

apiKey - 用于访问您NCM服务器的API密钥
TFTP_COMBO_IP - TFTP组合IP地址
TFTP_BOX_VISIBLE - TFTP组合可见
TFTP_OPERATIONS - TFTP操作
SCP_COMBO_IP - SCP组合IP地址
SCP_BOX_VISIBLE - SCP Box可见
SCP_OPERATIONS - SCP操作
SYSLOG_COMBO_IP - SYSLOG组合IP地址
SYSLOG_BOX_VISIBLE - SYSLOG Box可见
SYSLOG_OPERATIONS - SYSLOG Box操作
SYSLOG_PORT - SYSLOG端口
THREAD_COUNT - 线程计数

executeDBQuery

在NCM的数据库控制台中执行查询

post

apiKey - 用于访问您NCM服务器的API密钥
QUERY_STRING - 查询字符串

addExcludeCriteria

添加新的排除自定义条件

post

apiKey - 用于访问您NCM服务器的API密钥
DEV_TEMPLATE - 设备模板
EXCLUDE_EMAIL - 排除邮件
CRITERIA - 条件
CRITERIA_ID - 条件ID
SENDEMAIL - 发送邮件

personalityList

列出所有人员

get

apiKey - 用于访问您NCM服务器的API密钥

excludeCriteriaPreRenders

特定排除自定义条件的预渲染

get

apiKey - 用于访问您NCM服务器的API密钥
CRITERIA_ID - 条件ID

deleteExcludeCriteria

删除特定的自定义标准

post

apiKey - 用于访问您NCM服务器的API密钥
CRITERIA_ID - 条件ID

excludeCriteria

列出所有的排除标准

get

apiKey - 用于访问您NCM服务器的API密钥

findSysObjectId

查找特定设备的SYSObject ID

post

apiKey - 用于访问您NCM服务器的API密钥
hostname - 主机名称
community - 社区
timeout - 超时
retries - 重试
port - 端口
VER_TYPE - 版本类型

addSysOID

添加新的SYSOID

post

apiKey - 用于访问您NCM服务器的API密钥
DEVICE_BEHAVIOUR - 设备行为
SYSOID - SYSOID
MODEL - 模型
SERIES - 系列
SENDEMAIL - 发送邮件

updateSysLocationDesc

更新系统的位置和描述

post

apiKey - 用于访问您NCM服务器的API密钥
ComponentSelection - 组件选择
DEVICEGROUPSELECTION - 设备组选择
SELECTEDDEVICES - 选择的设备

deleteSysOID

删除SYSOID

post

apiKey - 用于访问您NCM服务器的API密钥
SYSOID - SYSOID

exportConfigets

以XML格式导出特定的配置命令

post

apiKey - 用于访问您NCM服务器的API密钥
TEMPLATE_IDS - 配置命令ID

getUsersToAddReviewer

将用户添加为审阅者

get

apiKey - 用于访问您NCM服务器的API密钥

mailSettings

更新邮件服务器设置

post

apiKey - 用于访问您NCM服务器的API密钥
FROM_ADDRESS - 发件人邮件ID
TO_ADDRESS - 收件人邮件ID
MAIL_SERVER_NAME - 邮件服务器名称
MAIL_SERVER_PORT - 邮件服务器端口
REQ_AUTH - 需要身份验证
MAIL_ACCOUNT_PASSWORD - 邮件账户密码
MAIL_ACCOUNT_NAME - 邮件帐户名称
TEST_MAIL_SERVER - 测试邮件服务器

labelConfigDetails

列出与特定标签关联的设备及其配置

get

apiKey - 用于访问您NCM服务器的API密钥
LabelId - 标签ID
RESOURCEIDS - 资源ID

saveandTestResult

保存凭证并对提供的凭证执行测试

get

apiKey - 用于访问您NCM服务器的API密钥
RESOURCEID - 资源ID
BACKUP_ENABLED - 启用备份
BACKUP_STATUS - 备份状态

rebranding

更新品牌重命名的详细信息

post

apiKey - 用于访问您NCM服务器的API密钥
RESTORE_DEFAULT - 恢复默认值
COMPANYNAME - 公司名称
BRANDNAME - 品牌名称
PRODUCTNAME - 产品名称
EMAILID - 电子邮件ID
PHNUMBER - 电话号码
WEBSITE - 网站
ENABLESUPPORT - 启用支持
ENABLELINKS - 启用链接

snmpTrapSettings

更新SNMP陷阱设置

post

apiKey - 用于访问您NCM服务器的API密钥
HOSTNAME - 主机名称
PORT - 端口
COMMUNITY - 社区

syslogForwarder

更新SYSLOG转发器

post

apiKey - 用于访问您NCM服务器的API密钥
SYSLOG_FRWD_IPS - SYSLOG转发器IP地址

proxySettings

更新代理服务器设置

post

apiKey - 用于访问您NCM服务器的API密钥
DIRECT_CONNECTION_TO_INTERNET - 直接连接到互联网
PROXY_HOST - 代理主机
PROXY_PORT - 代理端口
PROXY_USERNAME - 代理用户名
PROXY_PASSWORD - 代理密码

proxySettingsTest

测试代理服务器设置

post

apiKey - 用于访问您NCM服务器的API密钥
PROXY_HOST - 代理主机
PROXY_PORT - 代理端口
PROXY_USERNAME - 代理用户名
PROXY_PASSWORD - 代理密码
DIRECT_CONNECTION_TO_INTERNET - 直接连接到互联网

troubleTicket

更新故障工单设置

post

apiKey - 用于访问您NCM服务器的API密钥
TT_MAIL_ADDRESS - 故障工单邮件地址

databaseCleanup

更新数据库清理设置

post

apiKey - 用于访问您NCM服务器的API密钥
DELETE_VERSION_HISTORY - 删除版本历史
DELETE_AUDIT_HISTORY - 删除审计历史
DELETE_VERSION_HISTORY_DAYS - 删除版本历史天数
VERSION_HISTORY_SIZE - 版本历史大小
AUDIT_HISTORY_SIZE - 审计历史大小
VERSION_HISTORY_SIZE_DAYS - 版本历史的大小和天数

logLevel

更新日志级别设置

post

apiKey - 用于访问您NCM服务器的API密钥
LOG_LEVEL - 日志级别

approveRequest

批准上传请求

post

apiKey - 用于访问您NCM服务器的API密钥
ADMIN_COMMENTS - 管理评论
REQUEST_ID - 请求ID
REQUEST_APPROVED - 请求已获批准
SCHEDULE_TYPE - 计划类型
ONCEONLY_START_TIME_HOUR - 仅单次开始，以小时为单位
ONCEONLY_START_TIME_MIN - 仅单次开始，以分钟为单位
ONCEONLY_START_DATE - 仅单次开始日期

模块名称：ncmdevice

listAllDevices

列出所有设备

get

apiKey - 用于访问您NCM服务器的API密钥
PROFILEID - 配置文件ID
SEARCH_STRING - 搜索字符串
type - 类型
value - 值
TABLE_DATA - 表数据
OSVERSION - 操作系统版本
OSTYPE - 操作系统类型
DEVICE_TYPE - 设备类型
MODEL - 型号

listOSModelDevices

根据特定的操作系统型号列出设备

get

apiKey - 用于访问您NCM服务器的API密钥
TABLE_DATA - 表数据
OSVERSION - 操作系统版本
OSTYPE - 操作系统类型
DEVICE_TYPE - 设备类型
MODEL - 型号

devSummary

获取特定设备的详细信息

get

apiKey - 用于访问您NCM服务器的API密钥
deviceId - 资源ID
ip - 设备的IP地址

updateDevSummary

更新特定设备的详细信息

post

apiKey - 用于访问您NCM服务器的API密钥
RESOURCEID - 资源ID
HOSTNAME - 主机名称
IPADDRESS - IP地址
OSVERSION - 操作系统版本
OSTYPE - 操作系统类型
MODEL - 型号
SERIES - 系列
SYSTEMDESCRIPTION - 系统描述
SYSTEMLOCATION - 系统位置
COLUMNNAME1 - 列名称1
COLUMNNAME2 - 列名称2
COLUMNNAME3 - 列名称3
OLD_TEMPLATE_NAME - 旧模板名称
NEW_TEMPLATE_NAME - 新模板名称

getDevConfiglets

列出在特定设备上执行的配置命令历史记录

get

apiKey - 用于访问您NCM服务器的API密钥
deviceId - 资源ID

getCurrentConfig

列出特定设备的当前配置

get

apiKey - 用于访问您NCM服务器的API密钥
deviceId - 资源ID

deleteDevice

删除特定的设备

post

apiKey - 用于访问您NCM服务器的API密钥
DEVICE_IDS - 资源ID

addDeviceGroup

添加新的设备组

post

apiKey - 用于访问您NCM服务器的API密钥
DEVICE_GROUP_NAME - 设备组名称
DG_DESCRIPTION - 设备组描述
SELECTEDDEVICES - 选择的设备
GLOBAL_DEVICE_GROUP - 全局设备组
IS_EDIT_VIEW - 是编辑视图
DEVICE_GROUP_ID - 设备组ID
ComponentSelection - 组件选择
QUERYID - 查询ID
CRITERIA_LIST - 标准列表([{"Condition":"condition","Field":"field","Comparator":"comparator","Value":"value"}])
Field - 字段
Value - 值
Condition - 条件
Comparator - 比较器

deleteDeviceGroup

删除特定的设备组

post

apiKey - 用于访问您NCM服务器的API密钥
DEVICE_GROUP_ID - 设备组ID

listDeviceGroup

列出所有设备组

get

apiKey - 用于访问您NCM服务器的API密钥
DEVICE_GROUP_ID - 设备组ID

deviceGroupResources

列出按特定设备组进行分组的设备

get

apiKey - 用于访问您NCM服务器的API密钥
DEVICE_GROUP_ID - 设备组ID
PROFILEID - 配置文件ID
SEARCH_STRING - 搜索字符串
type - 类型
value - 值
TABLE_DATA - 表数据
OSVERSION - 操作系统版本
OSTYPE - 操作系统类型
DEVICE_TYPE - 设备类型
MODEL - 型号

manage

管理设备

post

apiKey - 用于访问您NCM服务器的API密钥
RESOURCEID - 资源ID

unmanage

取消管理设备

post

apiKey - 用于访问您NCM服务器的API密钥
RESOURCEID - 资源ID

stopOperation

停止特定设备上的当前操作

post

apiKey - 用于访问您NCM服务器的API密钥
RESOURCEID - 资源ID

eolDataNotAvailable

列出所有EOL数据不可用的设备

get

apiKey - 用于访问您NCM服务器的API密钥

eolDevices

列出所有EOL设备

get

apiKey - 用于访问您NCM服务器的API密钥

eolAnnouncedDevices

列出所有EOL已宣布的设备

get

apiKey - 用于访问您NCM服务器的API密钥

updateIpAddress

更新特定设备的IP地址

post

apiKey - 用于访问您NCM服务器的API密钥
RESOURCEIDS - 资源ID

updateDNS

更新特定设备的DNS

post

apiKey - 用于访问您NCM服务器的API密钥
RESOURCEIDS - 资源ID

getResourceIds

获取特定IP地址的资源ID

get

apiKey - 用于访问您NCM服务器的API密钥
IPADDRESS - IP地址

matchingDevices

根据特定条件获取匹配的设备

get

apiKey - 用于访问您NCM服务器的API密钥
IPADDRESS - IP地址
CRITERIA_LIST - 标准列表([{"Condition":"condition","Field":"field","Comparator":"comparator","Value":"value"}])
Field - 字段
Value - 值
Condition - 条件
Comparator - 比较器

getResourcesForGroups

获取按特定设备组进行分组的设备

get

apiKey - 用于访问您NCM服务器的API密钥
DEVICE_GROUP_ID - 设备组ID

searchResult

获取设备上搜索字符串的搜索结果

get

apiKey - 用于访问您NCM服务器的API密钥
SEARCH_STRING - 搜索字符串

searchResultforConfig

获取配置中搜索字符串的搜索结果

get

apiKey - 用于访问您NCM服务器的API密钥
SEARCH_STRING - 搜索字符串

getDevInterfaces

列出特定设备上的接口

get

apiKey - 用于访问您NCM服务器的API密钥
deviceId - 资源ID

listDeviceGroups

根据仅显示公共设备组列出设备组

get

apiKey - 用于访问您NCM服务器的API密钥
SHOW_ONLY_PUBLIC_DEVICE_GROUP - 仅显示公共设备组

exeChangeDetection

更新特定设备的更改检测

post

apiKey - 用于访问您NCM服务器的API密钥
TRACKING_OPTION - 跟踪选项
SYSLOGSERVERIP - SYSLOG服务器的IP地址
VENDORS - 供应商([{"name":"name","DEVICES":[Device1,Device2],"LOGGING_LEVEL":"Level"}])
LOGGING_LEVEL - 记录级别

exeLabelCurrConfig

标记当前配置

post

apiKey - 用于访问您NCM服务器的API密钥
SELECTED_DEVICES - 选择的设备
LABEL_NAME - 标签名称
DESCRIPTION - 描述
NEW_LABEL_NAME - 标签名称

performStatusCheck

对设备执行状态检查

get

apiKey - 用于访问您NCM服务器的API密钥
DEVICE_GROUP_ID - 设备组ID
RESOURCEIDS - 资源ID
FUNCTIONALITY - 功能

uploadConfigDevices

在特定设备上上传配置

post

apiKey - 用于访问您NCM服务器的API密钥
LABEL_NAME - 标签名称
DEVICE_GROUP_ID - 设备组ID
RESOURCE_ID - 资源ID
DOWNLOAD_OPTION - 下载选项
SCHEDULE_DATE - 计划日期
SCHEDULE_HOUR - 计划，以小时为单位
SCHEDULE_MINUTE - 计划，以分钟为单位
COMMENT - 评论

exeUploadConfig

将配置上传到设备

post

apiKey - 用于访问您NCM服务器的API密钥
CONFIG_ID - 配置命令ID
DOWNLOAD_TYPE - 下载类型
DOWNLOAD_AS - 下载为
COMMENT - 评论
DOWNLOAD_OPTION - 下载选项
SCHEDULE_DATE - 计划日期
SCHEDULE_HOUR - 计划，以小时为单位
SCHEDULE_MINUTE - 计划，以分钟为单位

deviceTemplates

列出所有设备模板

get

apiKey - 用于访问您NCM服务器的API密钥

executeCommands

执行Show命令

post

apiKey - 用于访问您NCM服务器的API密钥
DEVICEID - 资源ID
COMMAND - 命令
IPADDRESS - IP地址

showCommandOutput

显示Show命令的输出

post

apiKey - 用于访问您NCM服务器的API密钥
DEVICEID - 资源ID
COMMAND - 命令

isIPAvailable

检查IP地址是否可用

get

apiKey - 用于访问您NCM服务器的API密钥
IPADDRESS - IP地址

configConflicts

快速列出设备组开始运行的冲突

get

apiKey - 用于访问您NCM服务器的API密钥
DG_ID - 设备组ID

configNoConflicts

获取设备组中没有启动运行数据的设备

get

apiKey - 用于访问您NCM服务器的API密钥
DG_ID - 设备组ID

configNotBackedUp

获取设备组中没有备份数据的设备

get

apiKey - 用于访问您NCM服务器的API密钥
DG_ID - 设备组ID

markEOL

将设备标记为EOL

post

apiKey - 用于访问您NCM服务器的API密钥
RESOURCEID - 资源ID
DISPLAYTYPE - 显示类型
MODEL - 型号
SERIES - 系列

getResources

获取可供用户使用的设备

get

apiKey - 用于访问您NCM服务器的API密钥

getConfigContents

获取设备的配置内容

get

apiKey - 用于访问您NCM服务器的API密钥
RESOURCEID - 资源ID
FileType - 文件类型

pingTraceRouteResponse

显示Ping或跟踪路径命令的结果

get

apiKey - 用于访问您NCM服务器的API密钥
IPADDRESS - IP地址
COMMAND - 命令

模块名称：ncmcompliance

getDevComplianceList

获取设备合规性列表

get

apiKey - 用于访问您NCM服务器的API密钥
deviceId - 资源ID

getComplianceList

列出所有合规策略

get

apiKey - 用于访问您NCM服务器的API密钥

getAllGroups

列出所有规则组

get

apiKey - 用于访问您NCM服务器的API密钥

getAllRules

列出所有规则

get

apiKey - 用于访问您NCM服务器的API密钥

getComplianceDetails

列出违反合规策略的设备

get

apiKey - 用于访问您NCM服务器的API密钥
compolicyId - 合规策略ID
type - 类型
value - 值

getRuleCompliances

在合规政策中列出违规严重程度的规则，包含严重的，主要的和告警

get

apiKey - 用于访问您NCM服务器的API密钥
resPolicyId - 资源策略ID
severity - 严重程度
compliant - 合规的

addRule

添加新的规则

post

apiKey - 用于访问您NCM服务器的API密钥
COMPRULE_NAME - 合规性规则名称
DUPL_RULE_NAME - 副本规则名称
COMPRULE_DESCR - 合规性规则说明
CRITERIA_TYPE - 标准类型
VIOLATION_SEVERITY - 违反的严重程度
REMEDIATION_DESCR - 补救说明
REMEDIATION_TEMPLATE - 补救模板
START_BLOCK_CONFIG - 启动块配置命令
END_BLOCK_CONFIG - 结束块配置命令
BLOCK_CONDITION - 块条件
BLOCK_CONDITION_VALUE - 块条件值
COMPRULE_ID - 合规性规则ID
SIMPLE_CONDITION - 简单条件
SIMPLE_PATTERN - 简单模式
SIMPLE_ALLOWED_COUNT - 简单允许计数
CRITERIA_LIST - 标准列表([{"operator":"operator","condition":"condition","pattern":"pattern","allowedCount":"count"}])
condition - 条件
operator - 操作员
pattern - 图案

注意：
条件值为：
应包含所有行=10
不应包含任何行=20
应包含精确集=30
不应包含精确集=40
应包含=80
不应包含=90

copyRule

复制现有规则

post

apiKey - 用于访问您NCM服务器的API密钥
COMP_CLONE_RULES - 合规性克隆规则

deleteRule

删除特定规则

post

apiKey - 用于访问您NCM服务器的API密钥
COMPRULE_ID - 合规性规则ID

addRuleGroup

添加新的规则组

post

apiKey - 用于访问您NCM服务器的API密钥
COMPRULE_ID - 合规性规则ID
RULEGROUP_NAME - 规则组名称
RULEGROUP_DESCR - 规则组描述
COMPRULEGROUP_ID - 合规性规则组ID

deleteRuleGroup

删除特定规则组

post

apiKey - 用于访问您NCM服务器的API密钥
COMP_POLICYIDS - 合规性规则ID

addCompPolicy

添加新的合规策略

post

apiKey - 用于访问您NCM服务器的API密钥
COMPRULEGROUP_ID - 合规性规则组ID
COMPPOLICY_NAME - 合规规则组名称
COMPPOLICY_DESCR - 合规策略说明
CONFIG_TYPE - 配置类型
COMP_CRITERIA - 合规性标准
COMPPOLICY_ID - 合规性策略ID
COMPRULEGROUP_ID - 合规规则组ID

deleteCompPolicy

删除特定的合规性策略

post

apiKey - 用于访问您NCM服务器的API密钥
COMP_POLICYIDS - 合规性策略ID

complainceCheck

执行合规性检查

get

apiKey - 用于访问您NCM服务器的API密钥
COMPPOLICY_IDS - 合规性策略ID
RESOURCEID - 资源ID
DEVICE_GROUP_ID - 设备组ID

getResPolicyInfo

获取资源策略信息

get

apiKey - 用于访问您NCM服务器的API密钥
resPolicyId - 资源策略ID

policyAdhocResult

获取合规性策略的临时测试结果

get

apiKey - 用于访问您NCM服务器的API密钥
ComponentSelection - 组件选择
DEVICEGROUPSELECTION - 设备组选择
SELECTEDDEVICES - 选择的设备
CONFIG_TYPE - 配置类型
COMPPOLICY_ID - 资源策略ID

ruleAdhocTestResult

获取合规性规则的临时测试结果

get

apiKey - 用于访问您NCM服务器的API密钥
ComponentSelection - 组件选择
DEVICEGROUPSELECTION - 设备组选择
SELECTEDDEVICES - 选择的设备
CONFIG_TYPE - 配置类型
COMPRULE_ID - 合规性规则ID
COMPRULEGROUP_ID - 合规性规则组ID

exeAssocCompDev

将合规政策与设备相关联

post

apiKey - 用于访问您NCM服务器的API密钥
COMPPOLICY_ID - 合规性策略ID
ASSIGNED_RESOURCES - 分配的资源
ASSIGNED_DEVICEGROUP - 分配的设备组
RUNCOMPCHECK_STATUS - 运行合规检查状态

getAllReviews

列出所有审核

get

apiKey - 用于访问您NCM服务器的API密钥
REVIEWER_ID - 审核者ID
STATUS - 状态

getMyReviews

列出特定的用户审核

get

apiKey - 用于访问您NCM服务器的API密钥
STATUS - 状态

getReviewDetails

列出审查的详细信息

get

apiKey - 用于访问您NCM服务器的API密钥
REVIEW_ID - 审核者ID

reviewPCI

审核PCI

post

apiKey - 用于访问您NCM服务器的API密钥
REVIEW_ID - 审核ID
RESOURCEID - 资源ID
REVIEW_COMMENTS - 审核评论

complianceStatus

显示特定设备组的合规性状态

get

apiKey - 用于访问您NCM服务器的API密钥
DG_ID - 设备组ID
Status - 状态

pciReviewStatus

根据状态列出PCI审查

get

apiKey - 用于访问您NCM服务器的API密钥
Status - 状态

模块名称：ncmchanges

listAllConfigs

列出所有配置

get

apiKey - 用于访问您NCM服务器的API密钥
SEARCH_STRING - 搜索字符串
type - 类型
value - 值

getAllVersions

列出所有版本

get

apiKey - 用于访问您NCM服务器的API密钥
deviceId - 设备ID
SEARCH_STRING - 搜索字符串
type - 类型
value - 值

getDevConfigs

针对特定设备的列表配置

get

apiKey - 用于访问您NCM服务器的API密钥
deviceId - 设备ID
SEARCH_STRING - 搜索字符串
type - 类型
value - 值

getDevChanges

列出设备中的所有变更

get

apiKey - 用于访问您NCM服务器的API密钥
deviceId - 设备ID
SEARCH_STRING - 搜索字符串
type - 类型
value - 值

getRecentChangeList

列出最近的变更列表

get

apiKey - 用于访问您NCM服务器的API密钥

getCurrentConfigFiles

列出当前配置

get

apiKey - 用于访问您NCM服务器的API密钥
SEARCH_STRING - 搜索字符串
type - 类型
value - 值

configChangeVersions

获取配置变更的详细信息

get

apiKey - 用于访问您NCM服务器的API密钥
fileId - 文件ID

getDiffdetails

获取配置中的差异内容

get

apiKey - 用于访问您NCM服务器的API密钥
version1 - 版本1
version2 - 版本2
CONFIG_TYPE_1 - 配置类型1
CONFIG_TYPE_2 - 配置类型2
diffAlone - 单独不同
start - 启动
offset - 偏移量
nextIndex - 下一个索引

startupRunningVersion

获取特定资源的启动和运行版本

get

apiKey - 用于访问您NCM服务器的API密钥
RESOURCEID - 资源ID

getConfigFileDetails

获取配置文件的详细信息

get

apiKey - 用于访问您NCM服务器的API密钥
versionId - 版本ID

getConfigSiblings

获取版本的详细信息

get

apiKey - 用于访问您NCM服务器的API密钥
versionId - 版本ID

editConfigFileProp

更新配置文件属性

post

apiKey - 用于访问您NCM服务器的API密钥
VERSION_ID - 版本ID
AUTHCOMMENT_ID - 授权评论ID
AUTHORIZE_CHANGES - 授权更改
MESSAGE_BOX - 消息框
ANNOTATION - 注释
CHANGEDBY - 更改者

exeConfSync

将运行复制到启动配置

post

apiKey - 用于访问您NCM服务器的API密钥
DEVICE_IDS - 设备ID

addChangeRule

添加新的变更规则

post

apiKey - 用于访问您NCM服务器的API密钥
RULE_NAME - 规则名称
DEVICE_GROUP_ID - 设备组ID
RESOURCEID - 资源ID
RULE_DESCR - 规则描述
RULE_ID - 规则ID
SEND_EMAIL - 发送电子邮件
SEND_TRAP - 发送陷阱
GENERATE_TICKET - 生成工单
ROLLBACK_CONFIG - 回滚配置
SEND_SYSLOGMSG - 发送SYSLOG消息
CONDITION - 条件
CHANGETYPECONDITION - 变更类型条件
APPEND_DIFF - 附加差异
EMAIL_FORMAT - 电子邮件格式
EMAIL_SUBJECT - 电子邮件主题
EMAIL_MESSAGE - 电子邮件消息
TO_ADDRESS - 送达的地址
TICKET_SUBJECT - 工单主题
TICKET_MESSAGE - 工单消息
TICKET_TO_ADDRESS - 送达工单的地址
TICKET_APPEND_DIFF - 工单附加差异
TICKET_EMAIL_FORMAT - 工单电子邮件格式
HOST - 主机
PORT - 端口
COMMUNITY - 社区
SYSLOG_HOST - SYSLOG主机
SYSLOG_PORT - SYSLOG端口
ROLLBACK_CONFIG_TYPE - 回滚配置

updateChangeRule

更新变更规则

post

apiKey - 用于访问您NCM服务器的API密钥
ACTION_TYPE - 动作类型
RULE_ID - 规则ID
CONTEXT - 上下文
RESOURCEID - 资源ID
DEVICE_GROUP_ID - 设备组ID

changeAssocDev

将变更规则与设备相关联

post

apiKey - 用于访问您NCM服务器的API密钥
RULE_ID - 规则ID
ASSIGNED_RESOURCES - 分配的资源
ASSIGNED_DEVICEGROUP - 分配的设备组

newDraft

添加新草稿

post

apiKey - 用于访问您NCM服务器的API密钥
DRAFT_ID - 草稿ID
ANNOTATION - 注释
FILE_CONTENTS - 文件内容
DRAFT_NAME - 草稿名称
RESOURCEID - 资源ID
VERSION_ID - 版本ID

deleteDraft

删除特定的草稿

post

apiKey - 用于访问您NCM服务器的API密钥
DRAFT_ID - 草稿ID

getVersionDetails

获取版本的详细信息

get

apiKey - 用于访问您NCM服务器的API密钥
VERSIONS - 版本

authorize

授权变更

post

apiKey - 用于访问您NCM服务器的API密钥
VERSION_ID - 版本ID
AUTHORIZE_CHANGES - 授权变更
MESSAGE_BOX - 消息框

assocLabel

将标签与配置相关联

post

apiKey - 用于访问您NCM服务器的API密钥
VERSION_ID - 版本ID
SET_AS_BASELINE - 设置为基线
LABEL_NAME - 标签名称
DESCRIPTION - 描述
NEW_LABEL_NAME - 新的标签名称

exportConfigVersion

以文件格式导出配置版本

post

apiKey - 用于访问您NCM服务器的API密钥
VERSION_ID - 版本ID
DRAFT_ID - 草稿ID

complianceCheck

执行合规性检查

get

apiKey - 用于访问您NCM服务器的API密钥
VERSION_ID - 版本ID
DRAFT_ID - 草稿ID
SELECTION_TYPE - 选择类型
POLICY_ID - 策略ID
CONFIG_TYPE - 配置类型
VERSION_NO - 版本号
DRAFT_NAME - 草稿名称

getLabelDetails

列出标签

get

apiKey - 用于访问您NCM服务器的API密钥

exportConfigNow

立即导出配置

post

apiKey - 用于访问您NCM服务器的API密钥

getDevDrafts

列出与设备关联的草稿

get

apiKey - 用于访问您NCM服务器的API密钥
RESOURCEID - 资源ID

getAllDrafts

列出所有草稿

get

apiKey - 用于访问您NCM服务器的API密钥

getDraftDetails

获取草稿详细信息

get

apiKey - 用于访问您NCM服务器的API密钥
DRAFT_ID - 草稿ID

getBaseLineConfig

获取基线配置

get

apiKey - 用于访问您NCM服务器的API密钥
versionId - 版本ID

模块名称：ncmbackup

列出所有备份

get

apiKey - 用于访问您NCM服务器的API密钥
type - 类型
value - 值

getLastBackupsList

列出上次备份

get

apiKey - 用于访问您NCM服务器的API密钥

exeBackup

在特定设备上执行备份操作

post

apiKey - 用于访问您NCM服务器的API密钥
DEVICE_IDS - 资源ID
IPADDRESS - IP地址

addScheduleforConfig

为配置备份添加新的计划

post

apiKey - 用于访问您NCM服务器的API密钥
TASK_TYPE - 任务类型
SCHEDULE_NAME - 计划名称
EMAIL_RECIPIENTS - 电子邮件收件人
SCHEDULE_TYPE - 计划类型
HOURLY_START_DATE - 每小时开始的日期
HOURLY_START_TIME_HOUR - 每小时开始时间，以小时为单位
HOURLY_START_TIME_MIN - 每小时开始时间，以分钟为单位
HOURLY_INTERVAL - 每小时间隔
DAILY_START_DATE - 每日开始日期
DAILY_START_TIME_HOUR - 每日开始时间，以小时为单位
DAILY_START_TIME_MIN - 每日开始时间，以分钟为单位
WEEKLY_START_TIME_HOUR - 每周开始时间，以小时为单位
WEEKLY_START_TIME_MIN - 每周开始时间，以分钟为单位
WEEKLY_DAYS - 每周天数
MONTHLY_START_TIME_HOUR - 每月开始时间，以小时为单位
MONTHLY_START_TIME_MIN - 每月开始时间，以分钟为单位
MONTHLY_MONTHS - 每月月份
MONTHLY_DATE_OF_MONTH -每月一次的日期
ONCEONLY_START_TIME_HOUR - 单次开始时间，以小时为单位
ONCEONLY_START_TIME_MIN - 单次开始时间，以分钟为单位
ONCEONLY_START_DATE - 单次开始的日期
PRESELECT_TASK - 预选任务
deviceGroupId - 设备组ID

getRecentBackups

列出最近的备份

get

apiKey - 用于访问您NCM服务器的API密钥
type - 类型
value - 值

enableSceduleConfig

启用或禁用计划配置

post

apiKey - 用于访问您NCM服务器的API密钥
ACTION_TYPE - 动作类型
SCHEDULE_ID - 计划ID

exeBackedupDeviceList

列出备份的设备

get

apiKey - 用于访问您NCM服务器的API密钥
backup - 备份

getNotBackedupDeviceList

列出未备份的设备列表

get

apiKey - 用于访问您NCM服务器的API密钥