Add a new block exclude criteria
addBlockExcludeCriteria
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/addBlockExcludeCriteria?apiKey=XXXXXXXXXXYYY&DEV_TEMPLATE=1&blockCondition=None&CRITERIA_ID=1&SENDEMAIL=true
DEV_TEMPLATE
Device template
long
No
1
EXCLUDE_FROM_EMAIL
Mail From address
emailid
No
blockStartCriteria
Start criteria of block
String
Yes
blockEndCriteria
End criteria of block
String
Yes
criteriaName
Name of the criteria
text_basic_symbols_two_byte_support
Yes
blockCondition
Additional block condition
^(None|Contains|NotContains)$
No
None
blockCondition_value
Block condition value
String
No
CRITERIA_ID
ID of the block criteria
long
No
1
SENDEMAIL
Send mail notification
boolean
No
true
EXCLUDE_TO_EMAIL
Mail To address
(^[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2})(,[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2}))*)
No
Update custom column details
addCustomColumn
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/addCustomColumn?apiKey=XXXXXXXXXXYYY&COLUMN_NAME1=Adress1&COLUMN_VALUE1=INDIA1st_Floor&COLUMN_NAME2=Adress2&COLUMN_VALUE2=Nelson_Road&COLUMN_NAME3=Adress3&COLUMN_VALUE3=1st_Floor
COLUMN_NAME1
Custom Column Name 1
customColumnRegex
No
Adress1
COLUMN_VALUE1
Custom Column Value 1
customColumnRegex
No
INDIA1st_Floor
COLUMN_NAME2
Custom Column Name 2
customColumnRegex
No
Adress2
COLUMN_VALUE2
Custom Column Value 2
customColumnRegex
No
Nelson_Road
COLUMN_NAME3
Custom Column Name 3
customColumnRegex
No
Adress3
COLUMN_VALUE3
Custom Column Value 3
customColumnRegex
No
1st_Floor
Add a device
addDevice
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/addDevice?apiKey=XXXXXXXXXXYYY&DEVICE_BEHAVIOUR=Cisco IOS Router&ISMANUALADDITION=true&SERIES=2800&MODEL=2801&COLUMNNAME1=test1&COLUMNNAME2=test2&COLUMNNAME3=test3&IPADDRESS=2.3.2.1&VENDOR_NAME=Cisco&DISCOVERY_PROFILE_ID=1&ARE_FAILED_DISCOVERY_DEVICES=true&TAG_ID=1
DEVICE_BEHAVIOUR
Device Behaviour
ncmAllowedNameChars
No
Cisco IOS Router
ISMANUALADDITION
boolean
No
true
SERIES
Device Series
ncmSeriesModel
No
2800
MODEL
Device Model
ncmSeriesModel
No
2801
COLUMNNAME1
Custom Column Name 1
customColumnRegex
No
test1
COLUMNNAME2
Custom Column Name 2
customColumnRegex
No
test2
COLUMNNAME3
Custom Column Name 3
customColumnRegex
No
test3
BULKIPADDRESSES
Bulk IPAddresses from Discovery
JSONArray
ipJson
No
IPADDRESS
IPAddress
ncmHostOrIPAllowedChar
No
2.3.2.1
VENDOR_NAME
Device Vendor Name
ncmVendorName
No
Cisco
DISCOVERY_PROFILE_ID
Discovery Progress Profile Id
long
No
1
ARE_FAILED_DISCOVERY_DEVICES
Add failed Discovery Devices
boolean
No
true
TAG_ID
ID of the tag to be associated
long
No
1
Add a device template
addDeviceTemplate
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/addDeviceTemplate?apiKey=XXXXXXXXXXYYY&multiConfigTemplate=true
sysoids
List of sysoids
JSONArray
sysoidJson
No
DEVICETEMPLATEID
ID of the device template
long
No
templateName
Name of the template
ncmAllowedNameChars
Yes
share_to_community
Share device template to community
boolean
No
vendorName
Name of the vendor
ncmVendorDispName
No
personalityName
Name of the personality
ncmPersonalityName
Yes
sharedBy
Shared by details
text_basic_symbols
No
templateDescription
Description of the device template
ncmBasicTextChars
No
templateDesc
Description of the device template
ncmBasicTextChars
No
templateOSType
OS type
ncmOSType
No
vendorId
ID of the vendor
long
Yes
personalityId
ID of the personality
long
Yes
configuration
Commands of the device template
String
No
clonesysoid
Clone existing sysoid or not
boolean
No
multiConfigTemplate
boolean
No
true
baseTemplateName
ncmAllowedNameChars
No
Add discovered devices to NCM
addDiscoveredResources
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/addDiscoveredResources?apiKey=XXXXXXXXXXYYY&PROFILEID=1
REPORTIDS
Report Id(s)
JSONArray
longJson
No
PROFILEID
ID of the discovery profile
long
No
1
Add a exclude criteria
addExcludeCriteria
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/addExcludeCriteria?apiKey=XXXXXXXXXXYYY&DEV_TEMPLATE=Cisco IOS XR&EXCLUDE_FROM_EMAIL=test@test.com&CRITERIA=clock&ENC_CRITERIA=clock&CRITERIA_ID=1&SENDEMAIL=false&EXCLUDE_TO_EMAIL=test@test.com
DEV_TEMPLATE
Device Template
ncmAllowedNameChars
No
Cisco IOS XR
EXCLUDE_FROM_EMAIL
Exclude From Mail
emailid
No
test@test.com
CRITERIA
Criteria
String
No
clock
ENC_CRITERIA
Encoded Criteria
String
No
clock
CRITERIA_ID
Criteria Id
long
No
1
SENDEMAIL
Send Mail
boolean
No
false
EXCLUDE_TO_EMAIL
Exclude To Mail
(^[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2})(,[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2}))*)
No
test@test.com
Associate a flow configlet to device template
addFlowConfiglets
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/addFlowConfiglets?apiKey=XXXXXXXXXXYYY&TEMPLATE_ID=["16","10"]&DEVICETEMPLATEID=20
TEMPLATE_ID
Configlet Id
JSONArray
longJson
Yes
["16","10"]
DEVICETEMPLATEID
Device Template Id
long
Yes
20
Get render details of flow configlets
addFlowConfigletsPreRender
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/addFlowConfigletsPreRender?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=20
DEVICETEMPLATEID
Device Template Id
long
Yes
20
Add a label
addLabel
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/addLabel?apiKey=XXXXXXXXXXYYY&LABEL_NAME=Current Version&DESCRIPTION=Label for current configuration
LABEL_NAME
Name of the label
ncmBasicTextChars
Yes
Current Version
DESCRIPTION
Descripition of the label
ncmBasicTextChars
No
Label for current configuration
Add a PCI reviewer
addReviewer
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/addReviewer?apiKey=XXXXXXXXXXYYY&LOGIN_ID=2&EMAIL_ID=user1@testing.com
LOGIN_ID
Login Id of the User
long
Yes
2
EMAIL_ID
Email Id of the User
(^[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2})(,[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2}))*)
No
user1@testing.com
Add a credential profile
addSharedProfile
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/addSharedProfile?apiKey=XXXXXXXXXXYYY
IS_SNMP_PROFILE
SNMP profile or CLI profile
boolean
No
PROFILENAME
Name of the profile
text_basic_symbols_two_byte_support
No
snmp_port
SNMP port number
int
No
snmp_version
SNMP version
int
No
snmp_username
SNMP User name
String
No
snmp_contextname
SNMP Context name
String
No
snmp_authprotocol
SNMP Auth protocol
^(20|21|22)$
No
snmp_privprotocol
SNMP Priv protocol
^(49|50|51)$
No
snmp_authpassword
SNMP Auth password
String
No
snmp_privpassword
SNMP Priv password
String
No
snmp_readcommunity
SNMP Read community
String
No
snmp_writecommunity
SNMP Write community
String
No
telnet_loginname
Telnet Login name
String
No
telnet_password
Telnet Password
String
No
telnet_prompt
Telnet Prompt
String
No
telnet_enableUserName
Telnet User name
String
No
telnet_enablepassword
Telnet Enable password
String
No
telnet_enablepasswordType
Telnet Enable password type
^(enablePassword|noEnablePassword|emptyEnablePassword)$
No
telnet_enableprompt
Telnet Enable prompt
String
No
ssh_loginname
SSH Login name
String
No
ssh_password
SSH Password
String
No
ssh_prompt
SSH Prompt
String
No
ssh_enableUserName
SSH Enable user name
String
No
ssh_enablepassword
SSH Enable password
String
No
ssh_enablepasswordType
SSH Enable password type
^(enablePassword|noEnablePassword|emptyEnablePassword)$
No
ssh_enableprompt
SSH Enable prompt
String
No
PROFILEDESCRIPTION
Description of the profile
ncmBasicTextChars
No
Add or update show command
addShowCommand
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/addShowCommand?apiKey=XXXXXXXXXXYYY&COMMAND_ID=73&ALIAS=show version&COMMAND=/system resource print&VENDOR=57
COMMAND_ID
ID of the show command
long
No
73
ALIAS
Command Alias
text_basic_symbols_two_byte_support
Yes
show version
COMMAND
Command
text_basic_symbols_two_byte_support
Yes
/system resource print
VENDOR
Vendor
ncmVendorDispName
Yes
57
Add a sysoid
addSysOID
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/addSysOID?apiKey=XXXXXXXXXXYYY&SENDEMAIL=false&DEVICE_BEHAVIOUR=Cisco IOS Router&MODEL=C2951&SERIES=2951
SENDEMAIL
Send Mail
boolean
No
false
DEVICE_BEHAVIOUR
Device Behaviour
ncmAllowedNameChars
Yes
Cisco IOS Router
SYSOID
SYSOID
ncmSysoid
Yes
MODEL
Model
ncmSeriesModel
No
C2951
SERIES
Series
ncmSeriesModel
No
2951
Get all schedules
allSchedules
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/allSchedules?apiKey=XXXXXXXXXXYYY&taskType=Configuration Backup
taskType
Type of schedules that needs to be listed. All schedules will be listed if this parameter is empty
^(Configuration Backup|Compliance Check|Sync Configuration|Report Generation|Custom Template|PCI Review|Device Discovery)$
No
Configuration Backup
Get all show commands
allshowCommands
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/allshowCommands?apiKey=XXXXXXXXXXYYY
Get all sysobject ids
allSysOID
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/allSysOID?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=20
DEVICETEMPLATEID
ID of the device template
long
No
20
Get approved requests
approvedRequests
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/approvedRequests?apiKey=XXXXXXXXXXYYY
Approve a pending request
approveRequest
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/approveRequest?apiKey=XXXXXXXXXXYYY&ADMIN_COMMENTS=Approved&REQUEST_ID=1&REQUEST_APPROVED=true&SCHEDULE_TYPE=Now&IS_APPROVE_ONLY=true&ONCEONLY_START_TIME_HOUR=08&ONCEONLY_START_TIME_MIN=30&ONCEONLY_START_DATE=08/20/2019
ADMIN_COMMENTS
Admin Comments
ncmBasicTextChars
No
Approved
REQUEST_ID
ID of the approval request
long
Yes
1
REQUEST_APPROVED
Is Request Approved
boolean
Yes
true
SCHEDULE_TYPE
Schedule Type
^(Once Only|Now)$
No
Now
IS_APPROVE_ONLY
Is Approve only
boolean
No
true
ONCEONLY_START_TIME_HOUR
Once Only Start Time Hours
int
No
08
ONCEONLY_START_TIME_MIN
Once Only Start Time Minutes
int
No
30
ONCEONLY_START_DATE
Once Only Start Date
dateforapproval
No
08/20/2019
Associate credential to device
assocCredential
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/assocCredential?apiKey=XXXXXXXXXXYYY&authMode=sshKey&UPDATE_TYPE=UPDATE&BACKUP_STATUS=true&TEST_CRED=true&RESOURCEID_LIST=10&SNMP_VERSION=0&SNMP_PORT=161&SNMP_READCOMMUNITY=public&SNMP_WRITECOMMUNITY=password&SNMP_USERNAME=user1&SNMP_CONTEXTNAME=context1&SNMP_AUTHPROTOCOL=20&SNMP_AUTHPASSWORD=fakepassword&SNMP_PRIVPROTOCOL=49&SNMP_PRIVPASSWORD=fakepassword&SNMP_NATIP=1.1.1.1&TELNET_LOGINNAME=tempuser&TELNET_PASSWORD=temppassword&TELNET_PROMPT=:&TELNET_ENABLEUSERNAME=tempuser&TELNET_ENABLEPASSWORD=temppassword&TELNET_ENABLEPROMPT=:&TELNET_NATIP=1.1.1.1&TELNET_PORT=50&TELNET_LOGINPROMPT=:&TELNET_PASSWORDPROMPT=#&TELNET_ENABLEUSERNAMEPROMPT=>&TELNET_ENABLEPASSWORDPROMPT=?&TELNET_ENABLEPASSWORDTYPE=enablePassword&SSH_LOGINNAME=user&SSH_PASSWORD=r&SSH_PROMPT=>|#&SSH_ENABLEUSERNAME=tempuser&SSH_ENABLEPASSWORD=temppassword&SSH_ENABLEPROMPT=>|#&SSH_NATIP=1.1.1.1&SSH_PORT=22&SSH_LOGINPROMPT=>|#&SSH_PASSWORDPROMPT=>|#&SSH_ENABLEUSERNAMEPROMPT=>|#&SSH_ENABLEPASSWORDPROMPT=>|#&SSH_ENABLEPASSWORDTYPE=enablePassword
authMode
SSH authentication mode
^(sshKey|password)$
No
sshKey
SSH_PRIVATEKEYID
ID of the SSH Key
alphanumeric_basic
No
UPDATE_TYPE
Update Type of Credentials
^(UPDATE)$
No
UPDATE
BACKUP_STATUS
Backup the Device immediately
boolean
No
true
TEST_CRED
Test the Credential after Saving
boolean
No
true
RESOURCEID_LIST
Resource Id List (Separated by comma)
((\d+)(,\d+)*)
Yes
10
SNMP_PROFILELIST
SNMP Profile List
text_basic_symbols_two_byte_support
No
SNMP_VERSION
SNMP Version
^(0|1|3)$
No
0
SNMP_PORT
SNMP Port
ncmPortRegex
No
161
SNMP_READCOMMUNITY
SNMP Read Community
String
No
public
SNMP_WRITECOMMUNITY
SNMP Write Community
String
No
password
SNMP_USERNAME
SNMP User Name
String
No
user1
SNMP_CONTEXTNAME
SNMP Context Name
String
No
context1
SNMP_AUTHPROTOCOL
SNMP Auth Protocol (20=None, 21=MD5 and 22=SHA)
^(20|21|22)$
No
20
SNMP_AUTHPASSWORD
SNMP Auth Password
String
No
fakepassword
SNMP_PRIVPROTOCOL
SNMP Priv Protocol (49=AES 128, 50=DES and 51=None)
^(49|50|51)$
No
49
SNMP_PRIVPASSWORD
SNMP Priv Password
String
No
fakepassword
SNMP_NATIP
SNMP Network Address Translated IP Address
ipAddress
No
1.1.1.1
TELNET_PROFILELIST
TELNET Profile List
text_basic_symbols_two_byte_support
No
TELNET_LOGINNAME
TELNET Login Name
String
No
tempuser
TELNET_PASSWORD
TELNET Login Password
String
No
temppassword
TELNET_PROMPT
TELNET Prompt
String
No
:
TELNET_ENABLEUSERNAME
TELNET Enable UserName
String
No
tempuser
TELNET_ENABLEPASSWORD
TELNET Enable Password
String
No
temppassword
TELNET_ENABLEPROMPT
TELNET Enable Prompt
String
No
:
TELNET_NATIP
TELNET Network Address Translated IP Address
ipAddress
No
1.1.1.1
TELNET_PORT
TELNET Port
ncmPortRegex
No
50
TELNET_LOGINPROMPT
TELNET Login Prompt
String
No
:
TELNET_PASSWORDPROMPT
TELNET Password Prompt
String
No
#
TELNET_ENABLEUSERNAMEPROMPT
TELNET Enable User Prompt
String
No
>
TELNET_ENABLEPASSWORDPROMPT
TELNET Enable Password Prompt
String
No
?
TELNET_ENABLEPASSWORDTYPE
Telnet Enable Password Type
^(enablePassword|noEnablePassword|emptyEnablePassword)$
No
enablePassword
SSH_PROFILELIST
SSH Profile List
text_basic_symbols_two_byte_support
No
SSH_LOGINNAME
SSH Login Name
String
No
user
SSH_PASSWORD
SSH Login Password
String
No
r
SSH_PROMPT
SSH Prompt
String
No
>|#
SSH_ENABLEUSERNAME
SSH Enable UserName
String
No
tempuser
SSH_ENABLEPASSWORD
SSH Enable Password
String
No
temppassword
SSH_ENABLEPROMPT
SSH Enable Prompt
String
No
>|#
SSH_NATIP
SSH Network Address Translated IP Address
ipAddress
No
1.1.1.1
SSH_PORT
SSH Port
ncmPortRegex
No
22
SSH_LOGINPROMPT
SSH Login Prompt
String
No
>|#
SSH_PASSWORDPROMPT
SSH Password Prompt
String
No
>|#
SSH_ENABLEUSERNAMEPROMPT
SSH Enable User Prompt
String
No
>|#
SSH_ENABLEPASSWORDPROMPT
SSH Enable Password Prompt
String
No
>|#
SSH_ENABLEPASSWORDTYPE
SSH Enable Password Type
^(enablePassword|noEnablePassword|emptyEnablePassword)$
No
enablePassword
protocolCombinationList
Combination of Protocols
^(TELNET|TELNET - TFTP|SSH|SSH - TFTP|SSH - SCP|SSH - SFTP|SNMP - TFTP|REST API)$
No
REST_API_PARAMS
REST API Parameters
JSONArray
restAPICredentialJSON
No
Get backup schedules
backupSchedules
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/backupSchedules?apiKey=XXXXXXXXXXYYY
Check DNS is resolved or not
checkDNSName
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/checkDNSName?apiKey=XXXXXXXXXXYYY&IPADDRESS=2.3.2.1
IPADDRESS
IP Address
ncmHostOrIPAllowedChar
Yes
2.3.2.1
Clone and export device template
cloneExportSimpleDeviceTemplate
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/cloneExportSimpleDeviceTemplate?apiKey=XXXXXXXXXXYYY&multiConfigTemplate=true
sysoids
List of sysoids
JSONArray
sysoidJsonExportDT
No
DEVICETEMPLATEID
ID of the device template
long
No
templateName
Name of the template
ncmAllowedNameChars
Yes
share_to_community
Share device template to community
boolean
No
vendorName
Name of the vendor
ncmVendorDispName
No
personalityName
Name of the personality
ncmPersonalityName
Yes
sharedBy
Shared by details
text_basic_symbols
No
templateDescription
Description of the device template
ncmBasicTextChars
No
templateDesc
Description of the device template
ncmBasicTextChars
No
templateOSType
OS type
ncmOSType
No
vendorId
ID of the vendor
long
Yes
personalityId
ID of the personality
long
Yes
configuration
Commands of the device template
String
No
clonesysoid
Clone existing sysoid or not
boolean
No
multiConfigTemplate
boolean
No
true
baseTemplateName
ncmAllowedNameChars
No
Clone a device template
cloneSimpleDeviceTemplate
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/cloneSimpleDeviceTemplate?apiKey=XXXXXXXXXXYYY&multiConfigTemplate=true
sysoids
List of sysoids
JSONArray
sysoidJson
No
DEVICETEMPLATEID
ID of the device template
long
No
templateName
Name of the template
ncmAllowedNameChars
Yes
share_to_community
Share device template to community
boolean
No
vendorName
Name of the vendor
ncmVendorDispName
No
personalityName
Name of the personality
ncmPersonalityName
Yes
sharedBy
Shared by details
text_basic_symbols
No
templateDescription
Description of the device template
ncmBasicTextChars
No
templateDesc
Description of the device template
ncmBasicTextChars
No
templateOSType
OS type
ncmOSType
No
vendorId
ID of the vendor
long
Yes
personalityId
ID of the personality
long
Yes
configuration
Commands of the device template
String
No
clonesysoid
Clone existing sysoid or not
boolean
No
multiConfigTemplate
boolean
No
true
baseTemplateName
ncmAllowedNameChars
No
Get show command details
commandPreRender
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/commandPreRender?apiKey=XXXXXXXXXXYYY&commandId=73
commandId
ID of the show command
long
No
73
Get configlet details
configletPreRenders
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/configletPreRenders?apiKey=XXXXXXXXXXYYY&TEMPLATE_ID=4&DEVICETEMPLATEID=20
TEMPLATE_ID
ID of the configlet
long
No
4
DEVICETEMPLATEID
ID of the device template
long
No
20
Get render details of configlet during schedule
configletSchedPreRenders
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/configletSchedPreRenders?apiKey=XXXXXXXXXXYYY&TEMPLATE_ID=4
TEMPLATE_ID
ID of the configlet
long
Yes
4
Get credential details
credentialPreRenders
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/credentialPreRenders?apiKey=XXXXXXXXXXYYY&PROFILEID=303&PROFILENAME=temp
PROFILEID
Profile Id
long
No
303
PROFILENAME
Profile Name
text_basic_symbols
No
temp
Get all credential profiles
credProfList
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/credProfList?apiKey=XXXXXXXXXXYYY
Get custom sysobject ids
customSysOID
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/customSysOID?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=20
DEVICETEMPLATEID
ID of the device template
long
No
20
Get configuration export details
databaseBackupPreRender
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/databaseBackupPreRender?apiKey=XXXXXXXXXXYYY&OPERATION_TYPE=CONFIG_EXPORT
OPERATION_TYPE
Operation Type
^(CONFIG_EXPORT)$
Yes
CONFIG_EXPORT
Update database cleanup settings
databaseCleanup
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/databaseCleanup?apiKey=XXXXXXXXXXYYY&DELETE_VERSION_HISTORY=true&DELETE_AUDIT_HISTORY=true&DELETE_VERSION_HISTORY_DAYS=true&VERSION_HISTORY_SIZE=30&AUDIT_HISTORY_SIZE=20&VERSION_HISTORY_SIZE_DAYS=1&cleanupUserAudit=true&ncm.cleanup.hour=08&ncm.cleanup.minute=30&SYSOG_MSG_HISTORY_SIZE_CHK=true&SYSOG_MSG_HISTORY_SIZE=30&FV_HISTORY_RETAIN_DAYS=1
DELETE_VERSION_HISTORY
Delete Version History
boolean
No
true
DELETE_AUDIT_HISTORY
Delete Audit History
boolean
No
true
DELETE_VERSION_HISTORY_DAYS
Delete Version History Days
boolean
No
true
VERSION_HISTORY_SIZE
Version History Size
int
No
30
AUDIT_HISTORY_SIZE
Audit History Size
int
No
20
VERSION_HISTORY_SIZE_DAYS
Version History Size Days
int
No
1
cleanupUserAudit
Is User Audit Cleanup Enabled
boolean
No
true
ncm.cleanup.hour
Database Cleanup Time Hours
int
No
08
ncm.cleanup.minute
Database Cleanup Time Minutes
int
No
30
SYSOG_MSG_HISTORY_SIZE_CHK
Whether to delete syslog message trend history
boolean
No
true
SYSOG_MSG_HISTORY_SIZE
No. of days after which history must be deleted
int
No
30
FV_HISTORY_RETAIN_DAYS
No. of days firmware history can be retained
int
No
1
Get database cleanup settings
databaseCleanupPreRender
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/databaseCleanupPreRender?apiKey=XXXXXXXXXXYYY
Delete configlet audit
DelCustTempAudit
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/DelCustTempAudit?apiKey=XXXXXXXXXXYYY&EXECUTION_ID=1
EXECUTION_ID
Execution Id of the Configlet
JSONArray
longJson
Yes
1
Delete block criteria(s)
deleteBlockExcludeCriteria
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/deleteBlockExcludeCriteria?apiKey=XXXXXXXXXXYYY
CRITERIA_ID
ID of the block criteria
JSONArray
longJson
Yes
Delete credential profile(s)
deleteCredentials
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/deleteCredentials?apiKey=XXXXXXXXXXYYY&PROFILEID=303
PROFILEID
ID of the credential profile
JSONArray
longJson
Yes
303
Delete device template(s)
deleteDeviceTemplate
POST
Allowed
Allowed
Restricted
http://server-url:8060/api/json/ncmsettings/deleteDeviceTemplate?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=20
DEVICETEMPLATEID
Device Template Id
long
Yes
20
Delete exclude criteria(s)
deleteExcludeCriteria
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/deleteExcludeCriteria?apiKey=XXXXXXXXXXYYY&CRITERIA_ID=["1"]
CRITERIA_ID
Criteria Id
JSONArray
longJson
Yes
["1"]
Delete a specific configuration from label
deleteLabel
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/deleteLabel?apiKey=XXXXXXXXXXYYY&LABEL_ID=["301"]
LABEL_ID
ID of the label
JSONArray
longJson
No
["301"]
Delete a specific configuration from label
deleteLabel
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/deleteLabel?apiKey=XXXXXXXXXXYYY&LABEL_ID=["301"]
LABEL_ID
ID of the label
long
No
["301"]
FILE_ID
ID of the configuration file
JSONArray
longJson
No
Delete a PCI reviewer
deleteReviewer
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/deleteReviewer?apiKey=XXXXXXXXXXYYY&LOGIN_ID=2
LOGIN_ID
Login Id of the User
long
Yes
2
Delete schedule audit(s)
deleteScheduleAudit
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/deleteScheduleAudit?apiKey=XXXXXXXXXXYYY&AUDIT_ID=["307"]
AUDIT_ID
ID of the schedule audit
JSONArray
longJson
No
["307"]
Delete show command(s)
deleteShowCommand
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/deleteShowCommand?apiKey=XXXXXXXXXXYYY&COMMAND_ID=73
COMMAND_ID
Command Id
JSONArray
longJson
Yes
73
Delete SSH key profile(s)
deleteSSHKey
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/deleteSSHKey?apiKey=XXXXXXXXXXYYY
sshKeys
ID of the SSH key
JSONArray
longJson
No
Delete configlet(s)
deleteTemplate
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/deleteTemplate?apiKey=XXXXXXXXXXYYY&CONFIGLETS=[{"id":"71","name":"Alcatel_FlowExport"}]
CONFIGLETS
Configlet Id(s)
JSONArray
delConfigletJson
No
[{"id":"71","name":"Alcatel_FlowExport"}]
Demote configlet(s)
demoteConfiglets
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/demoteConfiglets?apiKey=XXXXXXXXXXYYY&TEMPLATE_ID=4&DEVICETEMPLATEID=40
TEMPLATE_ID
ID of the configlet
long
Yes
4
DEVICETEMPLATEID
ID of the device template
long
Yes
40
Get device execution details of the executed configlet
detailedExecResult
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/detailedExecResult?apiKey=XXXXXXXXXXYYY&EXECUTION_ID=1
EXECUTION_ID
ID of the configlet audit
long
Yes
1
Get detailed configlet result
detailedResult
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/detailedResult?apiKey=XXXXXXXXXXYYY&resourceId=2&executionId=1
resourceId
Resource Id of the Host Device
long
Yes
2
executionId
Configlet Execution Id
long
Yes
1
Get all device types
deviceType
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/deviceType?apiKey=XXXXXXXXXXYYY&VENDOR_NAME=Cisco
VENDOR_NAME
Vendor Name
ncmVendorName
Yes
Cisco
Edit a device template
editDeviceTemplate
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/editDeviceTemplate?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=1
DEVICETEMPLATEID
ID of the device template
long
No
1
protocolCommands
Protocol and commands
String
No
devProtocolIds
IDs of the protocol
JSONArray
longJson
No
Get all exclude criterias
excludeCriteria
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/excludeCriteria?apiKey=XXXXXXXXXXYYY
Get exclude criteria details
excludeCriteriaPreRenders
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/excludeCriteriaPreRenders?apiKey=XXXXXXXXXXYYY&CRITERIA_ID=2
CRITERIA_ID
Criteria Id
long
No
2
Execute a configlet
execConfiglet
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/execConfiglet?apiKey=XXXXXXXXXXYYY&DEVICEGROUPSELECTION=1&TEMPLATE_ID=4&ComponentSelection=SpecificDevice&SELECTEDDEVICES=["2"]&BACKUP_ENABLED=false
DEVICEGROUPSELECTION
ID of the device group
long
No
1
EXEC_TYPE
Execution Type
^(REMEDIATION_\d+)
No
TEMPLATE_ID
ID of the configlet
long
No
4
ComponentSelection
Device or device group selection
^(DeviceGroup|SpecificDevice)$
No
SpecificDevice
SELECTEDDEVICES
Resource ids of the devices
JSONArray
longJson
No
["2"]
BACKUP_ENABLED
Execute backup before and after configlet execution
boolean
No
false
VARIABLES
Name of the configlet script variables
JSONObject
configletVarJSON
No
VAR_NAME
Variable Name
JSONArray
alphaNumericJSON
No
Get render details of executable request
executableRequestPrerender
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/executableRequestPrerender?apiKey=XXXXXXXXXXYYY&REQUEST_ID=1
REQUEST_ID
ID of the executable request
long
Yes
1
Execute a approved request
executeApprovedRequest
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/executeApprovedRequest?apiKey=XXXXXXXXXXYYY
approved_req_id
ID of the approval request
long
Yes
Get render details of execute configlet
exeTemplatePreRenders
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/exeTemplatePreRenders?apiKey=XXXXXXXXXXYYY&TEMPLATE_ID=4&TEMPLATE_NAME=test&IS_REMEDIATION=true&comprule_id=1&policy_id=1
TEMPLATE_ID
ID of the configlet
long
No
4
TEMPLATE_NAME
Name of the configlet
text_basic_symbols
No
test
IS_REMEDIATION
Is Remediation
boolean
No
true
comprule_id
ID of the rule
long
No
1
policy_id
ID of the compliance policy
long
No
1
Export configlets
exportConfigets
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/exportConfigets?apiKey=XXXXXXXXXXYYY&TEMPLATE_IDS=["7","27","54","73"]
TEMPLATE_IDS
IDs of the configlet
JSONArray
longJson
Yes
["7","27","54","73"]
Render export configuration settings
exportConfigPreRender
GET
Allowed
Restricted
Restricted
http://server-url:8060/api/json/ncmsettings/exportConfigPreRender?apiKey=XXXXXXXXXXYYY&OPERATION_TYPE=CONFIG_EXPORT
OPERATION_TYPE
Operation Type
String
Yes
CONFIG_EXPORT
Get configuration export history
exportConfigs
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/exportConfigs?apiKey=XXXXXXXXXXYYY
Export device template
exportDeviceTemplate
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/exportDeviceTemplate?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=20
DEVICETEMPLATEID
ID of the device template
long
Yes
20
Export flow configuration
exportFlowConfig
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/exportFlowConfig?apiKey=XXXXXXXXXXYYY&RESOURCE_IDS=["17"]&Configlets=[{"Description":"Flow Export command for Cisco","TemplateName":"Cisco_CommonFlexible_FlowExport","Id":16,"TemplateType":"COMMAND_LINE_MODE","TemplateContents":"config t\nflow exporter NFAexporter\ndestination 12.1.2.3\nsource 2.3.2.1\nexport-protocol version-9\ntransport udp 9996\ntemplate data timeout 60\nexit\n\nflow monitor NFAmonitor\nrecord netflow-original\nexporter NFAexporter\ncache timeout active 60\ncache timeout inactive 15\nexit"}]
RESOURCE_IDS
Resource ids of the devices
JSONArray
longJson
No
["17"]
Configlets
IDs of the configlet
JSONArray
configletJson
No
[{"Description":"Flow Export command for Cisco","TemplateName":"Cisco_CommonFlexible_FlowExport","Id":16,"TemplateType":"COMMAND_LINE_MODE","TemplateContents":"config t\nflow exporter NFAexporter\ndestination 12.1.2.3\nsource 2.3.2.1\nexport-protocol version-9\ntransport udp 9996\ntemplate data timeout 60\nexit\n\nflow monitor NFAmonitor\nrecord netflow-original\nexporter NFAexporter\ncache timeout active 60\ncache timeout inactive 15\nexit"}]
Export shared template
exportSharedTemplate
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/exportSharedTemplate?apiKey=XXXXXXXXXXYYY&ID=40
ID
ID of the device template
String
Yes
40
Find sysobjectid for a device
findSysObjectId
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/findSysObjectId?apiKey=XXXXXXXXXXYYY&hostname=1.2.3.1&port=50&VER_TYPE=1&userName=tempuser&contextName=tempcontext&authProtocol=20&authPassword=temppassword&privProtocol=49&privPassword=temppassword&snmpv3Debug=true&timeout=20&retries=5&snmpSelection=snmpProfile&selectedProfile=Public
hostname
Host Name
ncmHostOrIPAllowedChar
Yes
1.2.3.1
port
Port
ncmPortRegex
No
50
VER_TYPE
Version Type
^(0|1|3)$
No
1
userName
User Name
String
No
tempuser
contextName
Context Name
String
No
tempcontext
authProtocol
Auth Protocol (20=None, 21=MD5 and 22=SHA)
^(20|21|22|23|24)$
No
20
authPassword
Auth Password
String
No
temppassword
privProtocol
Priv Protocol (49=AES 128, 50=DES and 51=None
^(47|48|49|50|51)$
No
49
privPassword
Priv Password
String
No
temppassword
snmpv3Debug
Is SNMP Version 3 Debug
boolean
No
true
community
Community
String
No
timeout
Timeout
int
No
20
retries
Number of Retries
int
No
5
snmpSelection
SNMP Selection
^(snmpProfile|manualCred)$
No
snmpProfile
selectedProfile
Selected Profile
String
No
Public
Get executable requests
getApprovedList
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/getApprovedList?apiKey=XXXXXXXXXXYYY
getBaseTemplateDetails
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/getBaseTemplateDetails?apiKey=XXXXXXXXXXYYY
Get details of block exclude criteria
getBlockExcludeCriteria
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/getBlockExcludeCriteria?apiKey=XXXXXXXXXXYYY&CRITERIA_ID=1
CRITERIA_ID
ID of the block criteria
long
No
1
Get details of client-server settings
getClientServerConfiguration
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/getClientServerConfiguration?apiKey=XXXXXXXXXXYYY
Get configlets for vendor
getConfiglet
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/getConfiglet?apiKey=XXXXXXXXXXYYY
VENDOR_NAME
Vendor Name
ncmVendorDispName
Yes
Get credential details for a device
getCredentials
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/getCredentials?apiKey=XXXXXXXXXXYYY&resourceIds=["17"]
resourceIds
Resource ids of the devices
JSONArray
longJson
Yes
["17"]
Get custom column details
getCustColumns
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/getCustColumns?apiKey=XXXXXXXXXXYYY
Get database sync settings
getDBSyncSettings
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/getDBSyncSettings?apiKey=XXXXXXXXXXYYY
Get devices for vendor
getDevicesforVendor
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/getDevicesforVendor?apiKey=XXXXXXXXXXYYY
VENDOR_NAME
Vendor Name
ncmVendorDispName
Yes
Get device SNMP mapping
getDeviceSNMPMapping
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/getDeviceSNMPMapping?apiKey=XXXXXXXXXXYYY
Get device sysoid mapping
getDeviceSysOIDMapping
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/getDeviceSysOIDMapping?apiKey=XXXXXXXXXXYYY
Get device template details
getDeviceTemplateDetails
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/getDeviceTemplateDetails?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=20&IS_CLONE=true
DEVICETEMPLATEID
Device Template Id
long
Yes
20
IS_CLONE
Is Clone Device Template
boolean
No
true
Get device template name
getDeviceTemplateName
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/getDeviceTemplateName?apiKey=XXXXXXXXXXYYY
DEVICETEMPLATEID
ID of the device template
long
Yes
Get profile discovery details
getDiscoveryDetails
GET
Allowed
Restricted
Restricted
http://server-url:8060/api/json/ncmsettings/getDiscoveryDetails?apiKey=XXXXXXXXXXYYY&profileId=1
profileId
ID of the discovery profile
long
Yes
1
Get profile discovery status
getDiscoveryStatus
GET
Allowed
Restricted
Restricted
http://server-url:8060/api/json/ncmsettings/getDiscoveryStatus?apiKey=XXXXXXXXXXYYY&isServiceNow=true
isServiceNow
Discovery status of normal discovery / servicenow
boolean
No
true
Get profile discovery summary
getDiscoverySummary
GET
Allowed
Restricted
Restricted
http://server-url:8060/api/json/ncmsettings/getDiscoverySummary?apiKey=XXXXXXXXXXYYY&profileId=5
profileId
ID of the discovery profile
long
Yes
5
Get flow export configlets for device
getExportConfiglet
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/getExportConfiglet?apiKey=XXXXXXXXXXYYY&deviceId=5
deviceId
Resource id of the device
long
Yes
5
IF_NAMES
Interface Names for Flow Export
JSONArray
strJson
No
Export device template
getExportedSimpleDeviceTemplate
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/getExportedSimpleDeviceTemplate?apiKey=XXXXXXXXXXYYY
fileName
File name
([\p{L}\p{N}\P{InBasicLatin}\-_\s\.]+).xml
No
Get credential id for SNMP profile
getNCMCredentialIDForSNMP
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/getNCMCredentialIDForSNMP?apiKey=XXXXXXXXXXYYY&credentialName=Public
credentialName
Profile Name of SNMP Credential
String
Yes
Public
Get configuration difference limit
getNCMDiffLimit
GET
Allowed
Restricted
Restricted
http://server-url:8060/api/json/ncmsettings/getNCMDiffLimit?apiKey=XXXXXXXXXXYYY
Get non-inventoried devices
getNCMNonInventoriedDevices
GET
Allowed
Restricted
Restricted
http://server-url:8060/api/json/ncmsettings/getNCMNonInventoriedDevices?apiKey=XXXXXXXXXXYYY
getNearSysOID
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/getNearSysOID?apiKey=XXXXXXXXXXYYY
IPADDRESS
NCM_IP_V4_AND_V6_Address
No
Get new device template render details
getNewDeviceTemplate
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/getNewDeviceTemplate?apiKey=XXXXXXXXXXYYY
Get nipper detailed result in schedule audit
getNipperDetailedExecResult
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/getNipperDetailedExecResult?apiKey=XXXXXXXXXXYYY&EXECUTION_ID=1
EXECUTION_ID
Execution Id
String
No
1
Get PMP settings
getPasswordSyncDetails
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/getPasswordSyncDetails?apiKey=XXXXXXXXXXYYY
Get resource ids for ipaddress
getResourceIdsForIps
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/getResourceIdsForIps?apiKey=XXXXXXXXXXYYY&IPADDRESS=["2.3.1.3"]
IPADDRESS
IPAddress
JSONArray
ipAddrJson
Yes
["2.3.1.3"]
Get schedule audits
getscheduleAudit
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/getscheduleAudit?apiKey=XXXXXXXXXXYYY
Get SCP settings
getSCPDetails
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/getSCPDetails?apiKey=XXXXXXXXXXYYY
serverDetails
Server details
boolean
No
Get shared device template details
getSharedDeviceTemplate
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/getSharedDeviceTemplate?apiKey=XXXXXXXXXXYYY&ID=40
ID
ID of the device template
String
Yes
40
Get render details of share device template
getShareTemplateDetails
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/getShareTemplateDetails?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=20
DEVICETEMPLATEID
Device Template Id
long
Yes
20
Get SNMP profiles
getSNMPProfiles
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/getSNMPProfiles?apiKey=XXXXXXXXXXYYY
Get details of SSH settings
getSSHSettings
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/getSSHSettings?apiKey=XXXXXXXXXXYYY
Get syslog blocked devices
getSysLogBlockedHosts
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/getSysLogBlockedHosts?apiKey=XXXXXXXXXXYYY
Get users to add PCI reviewer
getUsersToAddReviewer
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/getUsersToAddReviewer?apiKey=XXXXXXXXXXYYY
Get mail server settings
hasPrimaryMailSettings
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/hasPrimaryMailSettings?apiKey=XXXXXXXXXXYYY
Import configlets via file
importConfiglets
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/importConfiglets?apiKey=XXXXXXXXXXYYY
Import devices via file
importDevices
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/importDevices?apiKey=XXXXXXXXXXYYY
Import shared template
importSharedTemplate
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/importSharedTemplate?apiKey=XXXXXXXXXXYYY&ID=40
ID
ID of the device template
String
Yes
40
Import SSH key via file
importSSHKey
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/importSSHKey?apiKey=XXXXXXXXXXYYY
keyName
Name for SSH key
alphanumeric_basic
Yes
passphrase
SSH Key Passphrase
String
No
comment
Description of SSH Key
alphanumeric_basic
No
Get configurations associated to a label
labelConfigDetails
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/labelConfigDetails?apiKey=XXXXXXXXXXYYY&LabelId=["301"]&RESOURCEIDS=["17"]
LabelId
ID of the label
long
Yes
["301"]
RESOURCEIDS
Resource ids of the devices
JSONArray
longJson
No
["17"]
Get all labels
labelList
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/labelList?apiKey=XXXXXXXXXXYYY
Get label details
labelPreRenders
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/labelPreRenders?apiKey=XXXXXXXXXXYYY&LABEL_ID=["301"]
LABEL_ID
ID of the label
long
No
["301"]
Get all block criteria
listAllBlockExcludeCriteria
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/listAllBlockExcludeCriteria?apiKey=XXXXXXXXXXYYY
Get all configlets
listAllConfiglets
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/listAllConfiglets?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=323&FILTER_TYPE=PROMOTE&INCLUDE_FLOW_CONFILGETS=true
DEVICETEMPLATEID
Device Template Id
long
No
323
FILTER_TYPE
Filter Type of Configlet
^(PROMOTE|FLOW)$
No
PROMOTE
INCLUDE_FLOW_CONFILGETS
Include flow configlets or not
boolean
No
true
Get supported templates for device type
listExcludeCriteriaGridTemplates
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/listExcludeCriteriaGridTemplates?apiKey=XXXXXXXXXXYYY
deviceType
Device type
ncmPersonalityDisplayName
Yes
Get configlets history
listExecutionHistory
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/listExecutionHistory?apiKey=XXXXXXXXXXYYY
Get all SSH keys
listNCMSSHKeys
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/listNCMSSHKeys?apiKey=XXXXXXXXXXYYY
Get render details of log level
logLevelPreRender
GET
Allowed
Restricted
Restricted
http://server-url:8060/api/json/ncmsettings/logLevelPreRender?apiKey=XXXXXXXXXXYYY
Get mail server settings
mailSettingsPreRender
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/mailSettingsPreRender?apiKey=XXXXXXXXXXYYY
Get probe details for the device
ncmeeGetProbeDetailsForDevice
GET
Restricted
Allowed
Restricted
http://server-url:8060/api/json/ncmsettings/ncmeeGetProbeDetailsForDevice?apiKey=XXXXXXXXXXYYY&DEVICE_ID=1
DEVICE_ID
Resource id of the device
long
Yes
1
Get probe name for the device
ncmeeGetProbeForDevice
GET
Restricted
Allowed
Restricted
http://server-url:8060/api/json/ncmsettings/ncmeeGetProbeForDevice?apiKey=XXXXXXXXXXYYY&DEVICE_ID=1
DEVICE_ID
Resource id of the device
long
Yes
1
Get probe status
ncmeeGetProbeStatus
GET
Restricted
Allowed
Restricted
http://server-url:8060/api/json/ncmsettings/ncmeeGetProbeStatus?apiKey=XXXXXXXXXXYYY
selectedProbe
Probe name
String
Yes
Get all probes
ncmeeListProbes
GET
Restricted
Allowed
Restricted
http://server-url:8060/api/json/ncmsettings/ncmeeListProbes?apiKey=XXXXXXXXXXYYY
Share custom column to probes
ncmeeShareCustomColumn
POST
Restricted
Allowed
Restricted
http://server-url:8060/api/json/ncmsettings/ncmeeShareCustomColumn?apiKey=XXXXXXXXXXYYY
selectedProbes
Selected probes
String
Yes
Get REST configlet execution details
NCMPopulateRestConfigletExecDetails
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/NCMPopulateRestConfigletExecDetails?apiKey=XXXXXXXXXXYYY&resourceId=1&executionId=1
resourceId
Resource ID on which the operation was performed
long
Yes
1
executionId
Execution ID for which the details are required
long
Yes
1
Get render details of pending requests
pendingRequestPrerender
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/pendingRequestPrerender?apiKey=XXXXXXXXXXYYY&REQUEST_ID=1
REQUEST_ID
ID of the pending request
long
Yes
1
Get pending approval requests
pendingRequests
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/pendingRequests?apiKey=XXXXXXXXXXYYY
Ping a device
pingCheck
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/pingCheck?apiKey=XXXXXXXXXXYYY&IPADDRESS=2.3.2.1&fromAddDevice=true
IPADDRESS
IP Address
ncmHostOrIPAllowedChar
Yes
2.3.2.1
fromAddDevice
Is Add device
boolean
No
true
populateCliCommandsByOperName
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/populateCliCommandsByOperName?apiKey=XXXXXXXXXXYYY
OPERATION
^(Backup|Upload)$
No
PROTOCOLNAME
protocolList
No
Promote configlet(s)
promoteConfiglets
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/promoteConfiglets?apiKey=XXXXXXXXXXYYY&TEMPLATE_ID=["4"]&DEVICETEMPLATEID=Cisco Integrated Services Router ISR
TEMPLATE_ID
ID of the configlet
JSONArray
longJson
Yes
["4"]
DEVICETEMPLATEID
ID of the device template
ncmAllowedNameChars
Yes
Cisco Integrated Services Router ISR
DEVICETEMPLATEIDS
List of Device Template Id(s)
JSONArray
dtNameJson
No
Get render details of promote configlets
promoteConfigletsPreRender
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/promoteConfigletsPreRender?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=20
DEVICETEMPLATEID
Device Template Id
long
Yes
20
Get rebranding details
rebrandingPreRender
GET
Allowed
Restricted
Restricted
http://server-url:8060/api/json/ncmsettings/rebrandingPreRender?apiKey=XXXXXXXXXXYYY
Get rejected requests
rejectedRequests
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/rejectedRequests?apiKey=XXXXXXXXXXYYY
Disassociate flow configlets from device template
removeFlowConfiglets
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/removeFlowConfiglets?apiKey=XXXXXXXXXXYYY&TEMPLATE_ID=90&DEVICETEMPLATEID=40
TEMPLATE_ID
ID of the configlet
long
Yes
90
DEVICETEMPLATEID
ID of the device template
long
Yes
40
Remove devices from syslog blocked devices
removeSysLogBlocedHosts
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/removeSysLogBlocedHosts?apiKey=XXXXXXXXXXYYY&HOSTID=["5","2"]
HOSTID
Host Device ID(s)
JSONArray
longJson
Yes
["5","2"]
Get all PCI reviewers
reviewersList
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/reviewersList?apiKey=XXXXXXXXXXYYY
Execute a schedule
runSchedule
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/runSchedule?apiKey=XXXXXXXXXXYYY&scheduleIds=["302"]
scheduleIds
Schedule Id(s)
JSONArray
longJson
Yes
["302"]
Save and test credential
saveandTestResult
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/saveandTestResult?apiKey=XXXXXXXXXXYYY&RESOURCEID=23&BACKUP_STATUS=true
RESOURCEID
Resource id of the device
long
Yes
23
BACKUP_STATUS
Backup Status
boolean
No
true
Get schedule details
schedulePreRenders
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/schedulePreRenders?apiKey=XXXXXXXXXXYYY&SCHEDULE_ID=327&CONFIGLETID=1&REPORT_ID=1
SCHEDULE_ID
Schedule Id
long
No
327
SELECTEDDEVICES
Resource ids of the devices
JSONArray
longJson
No
CONFIGLETID
Associated Configlet ID
long
No
1
REPORT_TYPE
ADVANCED_REPORT
No
Get server settings
serverSettings
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/serverSettings?apiKey=XXXXXXXXXXYYY
Share device template to NCM support
shareDeviceTemplate
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/shareDeviceTemplate?apiKey=XXXXXXXXXXYYY&DEVICETEMPLATEID=20&sharedBy=user1@testing.com&templateDescription=For all Cisco IOS Routers&templateName=Cisco_IOS_Router&vendorName=Cisco&osType=IOS
DEVICETEMPLATEID
Device Template Id
long
Yes
20
sharedBy
Shared User E-mail Id
text_basic_symbols
No
user1@testing.com
templateDescription
Device Template Description
ncmBasicTextChars
No
For all Cisco IOS Routers
templateName
Device Template Name
ncmAllowedNameChars
No
Cisco_IOS_Router
vendorName
Device Vendor Name
String
No
Cisco
osType
Device OS Type
ncmOSType
No
IOS
Update SNMP trap settings
snmpTrapSettings
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/snmpTrapSettings?apiKey=XXXXXXXXXXYYY&HOSTNAME=27.1.1.27&PORT=162&COMMUNITY=public
HOSTNAME
Host Name
ncmHostOrIPAllowedChar
No
27.1.1.27
COMMUNITY
Community
String
No
public
Get SNMP trap settings details
snmpTrapSettingsPreRender
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/snmpTrapSettingsPreRender?apiKey=XXXXXXXXXXYYY
Sync service now devices with NCM
syncServiceNowDevicesWithNCM
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/syncServiceNowDevicesWithNCM?apiKey=XXXXXXXXXXYYY
Get render details of syslocation update
sysLocDescPreRender
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/sysLocDescPreRender?apiKey=XXXXXXXXXXYYY
Update syslog forwarder
syslogForwarder
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/syslogForwarder?apiKey=XXXXXXXXXXYYY&SYSLOG_FRWD_IPS=27.1.1.27
SYSLOG_FRWD_IPS
SYSLOG Forwarder IP Address
IPNetOrRangeWithComma
No
27.1.1.27
Get syslog forwarder details
syslogForwarderPreRender
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/syslogForwarderPreRender?apiKey=XXXXXXXXXXYYY
Get sysobjectid details
sysOIDPreRender
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/sysOIDPreRender?apiKey=XXXXXXXXXXYYY
Update trouble ticket details
troubleTicket
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/troubleTicket?apiKey=XXXXXXXXXXYYY&TT_MAIL_ADDRESS=user1@testing.com
TT_MAIL_ADDRESS
Trouble Ticket Mail Address
(^[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2})(,[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2}))*)
No
user1@testing.com
Get render details of trouble ticket
troubleTicketPreRender
GET
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/troubleTicketPreRender?apiKey=XXXXXXXXXXYYY
Update client-server settings
updateClientServerConfiguration
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/updateClientServerConfiguration?apiKey=XXXXXXXXXXYYY&configurations={"NCM_DIFF_LIMIT":"500","ncm.templates.visibletoall":true,"operator.configlet.restriction":true}
configurations
Changes to be updated
JSONObject
clientServerConfigJson
Yes
{"NCM_DIFF_LIMIT":"500","ncm.templates.visibletoall":true,"operator.configlet.restriction":true}
Add a new configlet
updateConfiglet
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/updateConfiglet?apiKey=XXXXXXXXXXYYY&DESCRIPTION=Getting version info for Cisco devices&CONTENTS=show version&TEMPLATE_TYPE=COMMAND_LINE_MODE&TEMPLATE_ID=4&NAME=Cisco_Show_Version_Script&DEVICETEMPLATEID=20&VENDOR_NAME=Cisco&TAG_ID=1
DESCRIPTION
Description of the Configlet
text_basic_symbols_two_byte_support
No
Getting version info for Cisco devices
CONTENTS
Contents of the Configlet
String
No
show version
TEMPLATE_TYPE
Template Type of the Configlet
^(COMMAND_LINE_MODE|TFTP_FILE_TRANSFER_MODE|ADVANCED_COMMAND_LINE_MODE)$
Yes
COMMAND_LINE_MODE
TEMPLATE_ID
Configlet Id
long
No
4
BACKUP_ENABLED
Perform Configuration Backup before and after Configlet Execution
boolean
No
NAME
Name of the Configlet
text_basic_symbols_two_byte_support
No
Cisco_Show_Version_Script
DEVICETEMPLATEID
Device Template Id
long
No
20
VENDOR_NAME
Name of the vendor
ncmVendorName
No
Cisco
TAG_ID
ID of the tag associated with the configlet
long
No
1
Update a label
updateLabel
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/updateLabel?apiKey=XXXXXXXXXXYYY&LABEL_ID=["301"]&DESCRIPTION=This label is used for most stable configuration
LABEL_ID
ID of the label
long
Yes
["301"]
DESCRIPTION
Descripition of the label
ncmBasicTextChars
No
This label is used for most stable configuration
Update configuration difference limit
updateNCMDiffLimit
POST
Allowed
Restricted
Restricted
http://server-url:8060/api/json/ncmsettings/updateNCMDiffLimit?apiKey=XXXXXXXXXXYYY&NCM_DIFF_LIMIT=30
NCM_DIFF_LIMIT
Diff Content Limit
String
No
30
Update probe server settings
updateProbeServerSettings
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/updateProbeServerSettings?apiKey=XXXXXXXXXXYYY&configurations={"ncmee.probe.restrict.distribution":"true"}
configurations
Configuration that needs to be updated
JSONObject
probeServerConfigJson
Yes
{"ncmee.probe.restrict.distribution":"true"}
Update a schedule
updateSchedule
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/updateSchedule?apiKey=XXXXXXXXXXYYY&SCHEDULE_ID=327&REPORT_ID=1&IS_ADVANCED_REPORT=true
SCHEDULE_ID
Schedule Id
long
No
327
TASK_TYPE
Task type
^(Configuration Backup|Compliance Check|Sync Configuration|Report Generation|Custom Template|PCI Review|Device Discovery)$
No
EMAIL_RECIPIENTS
Email address
(^[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2})(,[\w]([\w\-\.\+\'\/]*)@([\w\-\.]*)(\.[a-zA-Z]{2,22}(\.[a-zA-Z]{2}){0,2}))*)
No
IP_RANGE
Range of IPAddress
ncmIPRangeAllowedChar
No
SNMP_PROFILELIST
Profile names
String
No
ComponentSelection
Device or device group selection
^(SpecificDevice|DeviceGroup)$
No
DEVICEGROUPSELECTION
ID of the device group
long
No
SELECTEDDEVICES
Resource ids of the devices
JSONArray
longJson
No
BKPNOTIF_CONDITION
Notify if there is a failure in backing up a device
boolean
No
BKPNOTIF_CONDITION_CONFIG_CHANGE
Notify if there is a change in configuration
boolean
No
EXCLUDE_CONFIG_CHANGE_IN_MAIL
Exclude configuration difference from notification
boolean
No
COMPNOTIF_CONDITION
Notify only if there is a policy violation
boolean
No
REPORT_FILE_TYPE
Type of the report
^(PDF|CSV|TXT|XLSX)$
No
COMPLIANCE_SHOW_RESULT
Compliance report rule condition
^(VIOLATED_RULES_ONLY|COMPLIANT_RULES_ONLY|ALL_RULES)$
No
REPORT_TEMPLATE_NAME
Name of the report
ncmSchedReportTemplate
No
REPORT_DURATION
Duration of the report
^(today|yesterday|last_30_days|last_7_days|last_week|last_month|this_week|this_month)$
No
REVIEWER_ID
ID of the PCI reviewer
long
No
SYNCNOTIF_CONDITION
Notify only if there is a failure in sync configuration operation
boolean
No
IS_ADD
Add report or not
boolean
No
TAG_ID
ID of the tag to be associated
long
No
ScheduleMailSubject
Mail subject
text_basic_symbols_two_byte_support
No
SKIP_MAIL
Skip mail notification
boolean
Yes
IS_PUBLIC
Public or private schedule
boolean
Yes
IS_ADVANCED_REPORT
boolean
No
true
SCHEDULE_TYPE
Schedule type
^(Hourly|Daily|Weekly|Monthly|Once Only)$
Yes
HOURLY_START_DATE
Hourly start date
schStart_date
No
HOURLY_START_TIME_HOUR
Hourly start hour
hours
No
HOURLY_START_TIME_MIN
Hourly start minutes
minutes
No
HOURLY_INTERVAL
Hourly interval
long
No
DAILY_START_DATE
Daily start date
schStart_date
No
DAILY_START_TIME_HOUR
Daily start hour
hours
No
DAILY_START_TIME_MIN
Daily start minutes
minutes
No
WEEKLY_START_TIME_HOUR
Weekly start hour
hours
No
WEEKLY_START_TIME_MIN
Weekly start minutes
minutes
No
WEEKLY_DAYS
Days on the week
JSONArray
day_dateJson
No
MONTHLY_START_TIME_HOUR
Monthly start hour
hours
No
MONTHLY_START_TIME_MIN
Monthly start minutes
minutes
No
MONTHLY_MONTHS
Months on the year
JSONArray
day_dateJson
No
MONTHLY_DATE_OF_MONTH
Date on the month
int
No
ONCEONLY_START_TIME_HOUR
Once only start hour
hours
No
ONCEONLY_START_TIME_MIN
Once only start minutes
minutes
No
ONCEONLY_START_DATE
Once only start date
schStart_date
No
WEEKLY_START_DATE
Weekly start date
schStart_date
No
MONTHLY_START_DATE
Monthly start date
schStart_date
No
CUSTOM_TEMPLATE_ID
ID of the configlet
long
No
BACKUP_ENABLED
Execute backup before and after configlet execution
boolean
No
FILEUPLOADCONFIGLET
Is configlet value uploaded via file
boolean
No
VARIABLES
Name of the configlet script variables
String
No
FILENAME
Name of the configlet value file
ncmFileNameChars
No
VAR_NAME
Configlet value variable name
String
No
Update SCP settings
updateSCPDetails
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/updateSCPDetails?apiKey=XXXXXXXXXXYYY
scp_username
SCP user name
text_basic_symbols_two_byte_support
No
scp_currentPwd
Current SCP password
String
No
scp_password
New SCP password
String
No
SCP_BINDTO_IP
Bind to IPAddress
server_combo
No
SCP_SERVER_IP
SCP server IP
ipAddress
No
SCP_START_SERVICE
Start or Stop SCP service
boolean
No
Update server settings
updateServerSettings
POST
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/updateServerSettings?apiKey=XXXXXXXXXXYYY&TFTP_COMBO_IP=localhost&TFTP_BOX_VISIBLE=12.2.3.1&TFTP_BOX_HIDDEN=12.2.3.1&TFTP_OPERATIONS=starttftp&SCP_COMBO_IP=localhost&SCP_BOX_VISIBLE=12.2.3.1&SCP_BOX_HIDDEN=12.2.3.1&SCP_OPERATIONS=startscp&SYSLOG_COMBO_IP=localhost&SYSLOG_BOX_VISIBLE=12.2.3.1&SYSLOG_BOX_HIDDEN=12.2.3.1&SYSLOG_OPERATIONS=startsyslog&SYSLOG_PORT=514,519&THREAD_COUNT=20
TFTP_COMBO_IP
TFTP Combo IP Address
server_combo
Yes
localhost
TFTP_BOX_VISIBLE
TFTP Combo Visible
ipAddress
Yes
12.2.3.1
TFTP_BOX_HIDDEN
TFTP Combo Hidden
ipAddress
Yes
12.2.3.1
TFTP_OPERATIONS
TFTP Operations
^(starttftp|stoptftp)$
Yes
starttftp
SCP_COMBO_IP
SCP Combo IP Address
server_combo
Yes
localhost
SCP_BOX_VISIBLE
SCP Box Visible
ipAddress
Yes
12.2.3.1
SCP_BOX_HIDDEN
SCP Box Hidden
ipAddress
Yes
12.2.3.1
SCP_OPERATIONS
SCP Operations
^(startscp|stopscp)$
Yes
startscp
SYSLOG_COMBO_IP
SYSLOG Combo IP Address
server_combo
Yes
localhost
SYSLOG_BOX_VISIBLE
SYSLOG Box Visible
ipAddress
Yes
12.2.3.1
SYSLOG_BOX_HIDDEN
SYSLOG Box Hidden
ipAddress
Yes
12.2.3.1
SYSLOG_OPERATIONS
SYSLOG Box Operations
^(startsyslog|stopsyslog)$
Yes
startsyslog
SYSLOG_PORT
SYSLOG Port
comma_port
Yes
514,519
THREAD_COUNT
Thread Count
int
Yes
20
Update a credential profile
updateSharedProfile
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/updateSharedProfile?apiKey=XXXXXXXXXXYYY&PROFILEID=303
PROFILEID
ID of the profile
long
Yes
303
IS_SNMP_PROFILE
SNMP profile or CLI profile
boolean
No
PROFILENAME
Name of the profile
text_basic_symbols_two_byte_support
No
snmp_port
SNMP port number
int
No
snmp_version
SNMP version
int
No
snmp_username
SNMP User name
String
No
snmp_contextname
SNMP Context name
String
No
snmp_authprotocol
SNMP Auth protocol
^(20|21|22)$
No
snmp_privprotocol
SNMP Priv protocol
^(49|50|51)$
No
snmp_authpassword
SNMP Auth password
String
No
snmp_privpassword
SNMP Priv password
String
No
snmp_readcommunity
SNMP Read community
String
No
snmp_writecommunity
SNMP Write community
String
No
telnet_loginname
Telnet Login name
String
No
telnet_password
Telnet Password
String
No
telnet_prompt
Telnet Prompt
String
No
telnet_enableUserName
Telnet User name
String
No
telnet_enablepassword
Telnet Enable password
String
No
telnet_enablepasswordType
Telnet Enable password type
^(enablePassword|noEnablePassword|emptyEnablePassword)$
No
telnet_enableprompt
Telnet Enable prompt
String
No
ssh_loginname
SSH Login name
String
No
ssh_password
SSH Password
String
No
ssh_prompt
SSH Prompt
String
No
ssh_enableUserName
SSH Enable user name
String
No
ssh_enablepassword
SSH Enable password
String
No
ssh_enablepasswordType
SSH Enable password type
^(enablePassword|noEnablePassword|emptyEnablePassword)$
No
ssh_enableprompt
SSH Enable prompt
String
No
PROFILEDESCRIPTION
Description of the profile
ncmBasicTextChars
No
Update SSH settings
updateSSHSettings
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/updateSSHSettings?apiKey=XXXXXXXXXXYYY&configurations={"ncm.ssh.blockCipherSuites":"arcfour256","ncm.ssh.allowKeyExchanges":"diffie-hellman-group-exchange-sha256","ncm.ssh.blockHmacs":"hmac-sha1-96"}
configurations
Changes to be updated
JSONObject
cipherJSON
Yes
{"ncm.ssh.blockCipherSuites":"arcfour256","ncm.ssh.allowKeyExchanges":"diffie-hellman-group-exchange-sha256","ncm.ssh.blockHmacs":"hmac-sha1-96"}
Update system location and description
updateSysLocationDesc
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/updateSysLocationDesc?apiKey=XXXXXXXXXXYYY&DEVICEGROUPSELECTION=1&SELECTEDDEVICES=["2"]&SELECTEDPROFILES=["Public"]&ComponentSelection=DeviceGroup
DEVICEGROUPSELECTION
ID of the device group
long
No
1
SELECTEDDEVICES
Resource ids of the devices
JSONArray
longJson
No
["2"]
SELECTEDPROFILES
Selected Profiles
JSONArray
strJson
No
["Public"]
ComponentSelection
Component Selection
^(DeviceGroup|SpecificDevice)$
Yes
DeviceGroup
Update sysobjectid for devices
updateSysOIDForResources
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/updateSysOIDForResources?apiKey=XXXXXXXXXXYYY&DEVICEGROUPSELECTION=1&SELECTEDDEVICES=["2"]&ComponentSelection=DeviceGroup
DEVICEGROUPSELECTION
ID of the device group
long
No
1
SELECTEDDEVICES
Resource ids of the devices
JSONArray
longJson
No
["2"]
SELECTEDPROFILES
Selected Profiles
JSONArray
strJson
No
ComponentSelection
Component Selection
^(DeviceGroup|SpecificDevice)$
Yes
DeviceGroup
Upload configlet script values via file
uploadConfigletFile
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/uploadConfigletFile?apiKey=XXXXXXXXXXYYY&TEMPLATE_ID=4&IS_SCHEDULE=true&USE_FIRSTVALUE_FORALL=true&SCHEDULE_ID=327&BACKUP_ENABLED=true
TEMPLATE_ID
ID of the configlet
long
No
4
IS_SCHEDULE
Is Scheduled
boolean
No
true
USE_FIRSTVALUE_FORALL
Should use First value for all Devices
boolean
No
true
SCHEDULE_ID
ID of the schedule
^(new|\d+)$
No
327
BACKUP_ENABLED
Is Backup Enabled
boolean
No
true
Preview of uploaded configlet via file
uploadConfigletPreView
POST
Allowed
Restricted
Allowed
http://server-url:8060/api/json/ncmsettings/uploadConfigletPreView?apiKey=XXXXXXXXXXYYY&TEMPLATE_ID=4&USE_FIRSTVALUE_FORALL=true
TEMPLATE_ID
ID of the configlet
long
No
4
USE_FIRSTVALUE_FORALL
Should use First value for all Devices
boolean
No
true
Get all vendors
vendorList
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/vendorList?apiKey=XXXXXXXXXXYYY&IS_PRERENDER=false
IS_PRERENDER
List is requested for prerendering
boolean
No
false
Get vendor details
vendorMap
GET
Allowed
Allowed
Allowed
http://server-url:8060/api/json/ncmsettings/vendorMap?apiKey=XXXXXXXXXXYYY
