Contents |
REST APIs are used for adding and fetching data from Network Configuration Manager. Using these APIs, you can integrate Network Configuration Manager with different types of 3rd party IT management software.
The APIs work with an API key. The API key is unique for each Network Configuration Manager account and has to passed as a parameter in every API request made.
To generate an API key, go to Settings → REST API in Network Configuration Manager new fluidic web client and click on 'Generate Key'.
Sample URL: http://localhost:portnumber/api/json/<Module Name>/<API Name>?Parameter1=value
| API NAME | Description | Method | Parameter |
| Module Name : ncmsettings | |||
| listAllConfiglets | List all the Configlets | get | apiKey-API Key to access your NCM server |
| listExecutionHistory | List Execution History of Configlets | get | apiKey-API Key to access your NCM server |
| allSchedules | List all Schedules | get | apiKey-API Key to access your NCM server taskType-Task Type |
| backupSchedules | List Backup Schedules | get | apiKey-API Key to access your NCM server taskType-Task Type |
| allshowCommands | List All Show Commands | get | apiKey-API Key to access your NCM server |
| exportConfigs | List Export Configuration History Based on Operation Type | get | apiKey-API Key to access your NCM server OPERATION_TYPE-Operation Type |
| pendingRequests | List Pending Request for Approval | get | apiKey-API Key to access your NCM server |
| approvedRequests | List Approved Request | get | apiKey-API Key to access your NCM server |
| rejectedRequests | List Rejected Request | get | apiKey-API Key to access your NCM server |
| labelList | List All Labels | get | apiKey-API Key to access your NCM server |
| scheduleAudit | List All Execution Result of Schedules | get | apiKey-API Key to access your NCM server |
| reviewersList | List All Reviewers List | get | apiKey-API Key to access your NCM server |
| credProfList | List All Credential Profile List | get | apiKey-API Key to access your NCM server |
| detailedResult | Get Detailed Execution Result of Configlet | get | apiKey-API Key to access your NCM server resourceId-Device Id executionId-Execution Id |
| addDevice | Add Non SNMP Device | post | apiKey-API Key to access your NCM server IPADDRESS-IP Address of the Device DEVICE_BEHAVIOUR-Device Behaviour SERIES-Series MODEL-Model COLUMNNAME1-COLUMNNAME1 COLUMNNAME2-COLUMNNAME2 |
| assocCredential | Associates Credential to Devices | post | apiKey-API Key to access your NCM server UPDATE_TYPE-Update Type BACKUP_STATUS-Backup Status(True or Flase) TEST_CRED-Test Credential RESOURCEID_LIST-Resource Id List(Separated by comma) protocolCombinationList-Protocol Combination List SNMP_PROFILELIST-SNMP Profile List SNMP_NATIP-SNMP NATIP Address TELNET_PROFILELIST-Telnet Profile List TELNET_NATIP-Telnet NATIP Address SSH_PROFILELIST-SSH Profile List SSH_NATIP-SSH NATIP Address SNMP_VERSION-SNMP Version SNMP_PORT-SNMP Port SNMP_READCOMMUNITY-SNMP Read Community SNMP_USERNAME-SNMP UserName SNMP_CONTEXTNAME-SNMP Context Name SNMP_AUTHPROTOCOL-SNMP Auth Protocol SNMP_AUTHPASSWORD-SNMP Auth Password SNMP_PRIVPROTOCOL-SNMP Priv Protocol SNMP_PRIVPASSWORD-SNMP Priv Password TELNET_LOGINNAME-Telnet Login Name TELNET_PASSWORD-Telnet Password TELNET_PROMPT-Telnet Prompt TELNET_ENABLEUSERNAME-Telnet Enable User Name TELNET_ENABLEPASSWORD-Telnet Enable Password TELNET_ENABLEPROMPT-Telnet Enable Prompt TELNET_PORT-Telnet Port TELNET_LOGINPROMPT-Telnet Login Prompt TELNET_PASSWORDPROMPT-Telnet Password Prompt TELNET_ENABLEUSERNAMEPROMPT-Telnet Enable user Name Prompt TELNET_ENABLEPASSWORDPROMPT-Telnet Enable Password Prompt SSH_LOGINNAME-SSH Login Name SSH_PASSWORD-SSH Password SSH_PROMPT-SSH Prompt SSH_ENABLEUSERNAME-SSH Enable User Name SSH_ENABLEPASSWORD-SSH Enable Password SSH_ENABLEPROMPT-SSH Enable Prompt SSH_PORT-SSH Port SSH_LOGINPROMPT-SSH Login Prompt SSH_PASSWORDPROMPT-SSH Password Prompt SSH_ENABLEUSERNAMEPROMPT-SSH Enable User Name Prompt SSH_ENABLEPASSWORDPROMPT-SSH Enable Password Prompt |
| updateConfiglet | Create New Configlet or Update the Existing Configlet | post | apiKey-API Key to access your NCM server DESCRIPTION-Description about the Configlet CONTENTS-Contents of the Configlet TEMPLATE_TYPE-Template Type TEMPLATE_ID-Template Id BACKUP_ENABLED-Backup Enabled NAME-Name of the Template CUSTOM_TEMPLATE_MODIFIED-Configlet Modified |
| deleteTemplate | Delete Configlets | post | apiKey-API Key to access your NCM server CONFIGLETS-Configlet Ids |
| discoveryStatus | List Discovery Status | get | apiKey-API Key to access your NCM server |
| discoveryDetailsStatus | List Detailed Status of Particular Discovery | get | apiKey-API Key to access your NCM server taskId-Task Id |
| addDiscovery | Discover Particular IP Address or Network | post | apiKey-API Key to access your NCM server TIMEOUT-Timeout for Discovery RETRIES-Number of Retries for Discovery DISC_TYPE-Discovery Type HOST-Host Name START_ADDR-Network Start IP Address END_ADDR-Network End IP Address |
| getSNMPProfiles | List All SNMP Profiles | get | apiKey-API Key to access your NCM server |
| vendorList | List All Vendors Supported by NCM | get | apiKey-API Key to access your NCM server |
| deviceType | List All Device Type Supported for Particular Vendor | get | apiKey-API Key to access your NCM server VENDOR_NAME-Vendor Name |
| getDiscoveryInfo | Get Discovery Status with invoked time | get | apiKey-API Key to access your NCM server taskId-Task Id |
| checkDNSName | Checks Whether DNS is Resolved or Not For The Device | get | apiKey-API Key to access your NCM server IPADDRESS-IP Address |
| pingCheck | Ping The Particular Device | get | apiKey-API Key to access your NCM server IPADDRESS-IP Address |
| getCredentials | Get Credentials of Particular Devices | get | apiKey-API Key to access your NCM server resourceIds-Resource Ids |
| addSharedProfile | Add Shared Profile | post | apiKey-API Key to access your NCM server IS_SNMP_PROFILE-Is SNMP Profile PROFILENAME-Profile Name snmp_port-SNMP Port snmp_version-SNMP Version snmp_username-SNMP User Name snmp_contextname-SNMP Context Name snmp_authprotocol-SNMP Auth Protocol snmp_privprotocol-SNMP Priv Protocol snmp_authpassword-SNMP Auth Password snmp_privpassword-SNMP Priv Password snmp_readcommunity-SNMP Read Community snmp_writecommunity-SNMP Write Community telnet_loginname-Telnet Login Name telnet_password-Telnet Password telnet_prompt-Telnet Prompt telnet_enableUserName-Telnet Enable User Name telnet_enablepassword-Telnet Enable Password telnet_enableprompt-Telnet Enable Prompt ssh_loginname-SSH Login Name ssh_password-SSH Password ssh_prompt-SSH Prompt ssh_enableUserName-SSH Enable User Name ssh_enablepassword-SSH Enable Password ssh_enableprompt-SSH Enable Prompt PROFILEDESCRIPTION-Profile Description |
| DelCustTempAudit | Delete Particular Configlet Audit | post | apiKey-API Key to access your NCM server EXECUTION_ID-Execution Id of the Configlet |
| updateSchedule | Update the Particular Schedule | post | apiKey-API Key to access your NCM server SCHEDULE_ID-Schedule Id TASK_TYPE-Task Type REPORT_TEMPLATE_NAME-Report Template Name REPORT_DURATION-Report Duration REPORT_FILE_TYPE-Report File Type START_ADDR-Network Start IP Address END_ADDR-Network End IP Address ComponentSelection-Component Selection valuesSelectionType-Value Selection Type DEVICEGROUPSELECTION-Device Group Selection FILENAME-File Name SELECTEDDEVICES-Selected Devices QUERYID-Query Id COMPLIANCE_SHOW_RESULT-Compliance Show Result CUSTOM_TEMPLATE_ID-Configlet Id BACKUP_ENABLED-Backup Enabled VAR_NAME-Variable Name VARIABLES-Variables EMAIL_RECIPIENTS-Email Recipients BKPNOTIF_CONDITION-Backup Notify Condition BKPNOTIF_CONDITION_CONFIG_CHANGE-Backup Notify Configuration Change Condition EXCLUDE_CONFIG_CHANGE_IN_MAIL-Exclude Change in Mail COMPNOTIF_CONDITION-Compliance Notify Condition SYNCNOTIF_CONDITION-Synchronize Notify Condition SCHEDULE_TYPE-Schedule Type HOURLY_START_DATE-Hourly Start Date HOURLY_START_TIME_HOUR-Hourly Start Date Hour HOURLY_START_TIME_MIN-Hourly Start Date Minutes HOURLY_INTERVAL-Hourly Interval DAILY_START_DATE-Daily Start Date DAILY_START_TIME_HOUR-Daily Start Time Hour DAILY_START_TIME_MIN-Daily Start Time Minutes WEEKLY_START_TIME_HOUR-Weekly Start Time Hour WEEKLY_START_TIME_MIN-Weekly Start Time Minutes WEEKLY_DAYS-WeekDays MONTHLY_START_TIME_HOUR-Monthly Start Hour MONTHLY_START_TIME_MIN-Monthly Start Minutes MONTHLY_MONTHS-Monthly Month MONTHLY_DATE_OF_MONTH-Monthly Date of Month ONCEONLY_START_TIME_HOUR-Once Start Time Hour ONCEONLY_START_TIME_MIN-Once Start Time Minutes ONCEONLY_START_DATE-Once Start Time Date CUSTOM_TEMPLATE_MODIFIED-Configlet Modified SCHEDULE_STATUS-Schedule Status |
| updateSharedProfile | Update the Particular Shared Profile | post | apiKey-API Key to access your NCM server PROFILEID-Profile Id PROFILENAME-Profile Name snmp_port-SNMP Port snmp_version-SNMP Version snmp_username-SNMP User Name snmp_contextname-SNMP Context Name snmp_authprotocol-SNMP Auth Protocol snmp_privprotocol-SNMP Priv Protocol snmp_authpassword-SNMP Auth Password snmp_privpassword-SNMP Priv Password snmp_readcommunity-SNMP Read Community snmp_writecommunity-SNMP Write Community telnet_loginname-Telnet Login Name telnet_password-Telnet Password telnet_prompt-Telnet Prompt telnet_enableUserName-Telnet Enable User Name telnet_enablepassword-Telnet Enable Password telnet_enableprompt-Telnet Enable Prompt ssh_loginname-SSH Login Name ssh_password-SSH Password ssh_prompt-SSH Prompt ssh_enableUserName-SSH Enable User Name ssh_enablepassword-SSH Enable Password ssh_enableprompt-SSH Enable Prompt PROFILEDESCRIPTION-Profile Description |
| deleteTemplateAudit | Delete Particular Configlet Audit | post | apiKey-API Key to access your NCM server EXECUTION_ID-Execution Id of the Configlet |
| deleteScheduleAudit | Delete Specific Schedule Audit | post | apiKey-API Key to access your NCM server AUDIT_ID-Audit Id |
| deleteCredentials | Delete Specific Credential | post | apiKey-API Key to access your NCM server PROFILEID-Profile Id |
| SnmpRefDevDet | List SNMP Referred Devices Details | get | apiKey-API Key to access your NCM server PROFILEID-Profile Id |
| addLabel | Add New Label | post | apiKey-API Key to access your NCM server LABEL_NAME-Label Name DESCRIPTION-Label Descripition |
| addReviewer | Add New Reviewer | post | apiKey-API Key to access your NCM server LOGIN_ID-Login Id of the User EMAIL_ID-Email Id of the User |
| deleteReviewer | Delete Specific Reviewer | post | apiKey-API Key to access your NCM server LOGIN_ID-Login Id of the User |
| updateLabel | Update the Specific Label | post | apiKey-API Key to access your NCM server LABEL_ID-Label Id DESCRIPTION-Label Description |
| deleteLabel | Delete Specific Label | post | apiKey-API Key to access your NCM server OPERATIONTYPE-Operation Type LABEL_ID-Label Id FILE_ID-File Id |
| addShowCommand | Add New Show Command | post | apiKey-API Key to access your NCM server COMMAND_ID-Command Id ALIAS-Command Alias COMMAND-Command VENDOR-Vendor |
| deleteShowCommand | Delete Specific Show Command | post | apiKey-API Key to access your NCM server COMMAND_ID-Command Id |
| addCustomColumn | Add Custom Columns | post | apiKey-API Key to access your NCM server COLUMN_NAME1-Column Name 1 COLUMN_VALUE1-Column Value 1 COLUMN_NAME2-Column Name 2 COLUMN_VALUE2-Column Value 2 COLUMN_NAME3-Column Name 3 COLUMN_VALUE3-Column Value 3 |
| allSysOID | List All SYSOID | get | apiKey-API Key to access your NCM server |
| customSysOID | List All Custom SYSOID | get | apiKey-API Key to access your NCM server |
| execConfiglet | Execute Specific Configlet | post | apiKey-API Key to access your NCM server EXEC_TYPE-Execution Type TEMPLATE_NAME-Configlet Name TEMPLATE_TYPE-Configlet Type ASSIGNED_RESOURCES-Assigned Resources ComponentSelection-Component Selection DEVICEGROUPSELECTION-Device Group Selection SELECTEDDEVICES-Selected Devices TEMPLATE_ID-Configlet Id TEMPLATE_CONTENTS-Configlet Content BACKUP_ENABLED-Backup Enabled VAR_NAME-Variable Name VARIABLES-Variables |
| detailedExecResult | Get Detailed Execution Result | get | apiKey-API Key to access your NCM server EXECUTION_ID-Execution Id |
| updateServerSettings | Update the Server Settings | post | apiKey-API Key to access your NCM server TFTP_COMBO_IP-TFTP Combo IP Address TFTP_BOX_VISIBLE-TFTP Combo Visible TFTP_OPERATIONS-TFTP Operations SCP_COMBO_IP-SCP Combo IP Address SCP_BOX_VISIBLE-SCP Box Visible SCP_OPERATIONS-SCP Operations SYSLOG_COMBO_IP-SYSLOG Combo IP Address SYSLOG_BOX_VISIBLE-SYSLOG Box Visible SYSLOG_OPERATIONS-SYSLOG Box Operations SYSLOG_PORT-SYSLOG Port THREAD_COUNT-Thread Count |
| executeDBQuery | Execute the Query in Database Console Of NCM | post | apiKey-API Key to access your NCM server QUERY_STRING-Query String |
| addExcludeCriteria | Add New Exclude Custom Criteria | post | apiKey-API Key to access your NCM server DEV_TEMPLATE-Device Template EXCLUDE_EMAIL-Exclude Mail CRITERIA-Criteria CRITERIA_ID-Criteria Id SENDEMAIL-Send Mail |
| personalityList | List All Personlaity | get | apiKey-API Key to access your NCM server |
| excludeCriteriaPreRenders | Pre Rendering of Specific Exclude Custom Criteria | get | apiKey-API Key to access your NCM server CRITERIA_ID-Criteria Id |
| deleteExcludeCriteria | Delete Specific Custoom Criteria | post | apiKey-API Key to access your NCM server CRITERIA_ID-Criteria Id |
| excludeCriteria | List All Exclude Criteria | get | apiKey-API Key to access your NCM server |
| findSysObjectId | Find SYSObject Id for Particular Device | post | apiKey-API Key to access your NCM server hostname-Host Name community-Community timeout-Timeout retries-Retries port-Port VER_TYPE-Version Type |
| addSysOID | Add New SYSOID | post | apiKey-API Key to access your NCM server DEVICE_BEHAVIOUR-Device Behaviour SYSOID-SYSOID MODEL-Model SERIES-Series SENDEMAIL-Send Mail |
| updateSysLocationDesc | Update System Location and Description | post | apiKey-API Key to access your NCM server ComponentSelection-Component Selection DEVICEGROUPSELECTION-Device Group Selection SELECTEDDEVICES-Selected Devices |
| deleteSysOID | Delete SYSOID | post | apiKey-API Key to access your NCM server SYSOID-SYSOID |
| exportConfigets | Export Specific Configlets in XML Format | post | apiKey-API Key to access your NCM server TEMPLATE_IDS-Configlet Ids |
| getUsersToAddReviewer | Get Users to Add as Reviewer | get | apiKey-API Key to access your NCM server |
| mailSettings | Update Mail Server Settings | post | apiKey-API Key to access your NCM server FROM_ADDRESS-From Mail Id TO_ADDRESS-To Mail Id MAIL_SERVER_NAME-Mail Server Name MAIL_SERVER_PORT-Mail Server Port REQ_AUTH-Requires Authentication MAIL_ACCOUNT_PASSWORD-Mail Account Password MAIL_ACCOUNT_NAME-Mail Account Name TEST_MAIL_SERVER-Test Mail Server |
| labelConfigDetails | List Devices and its Configuration associated with Specific Label | get | apiKey-API Key to access your NCM server LabelId-Label Id RESOURCEIDS-Resource Ids |
| saveandTestResult | Save Credential and Perform Testing on Credentials Provided | get | apiKey-API Key to access your NCM server RESOURCEID-Resource Id BACKUP_ENABLED-Backup Enabled BACKUP_STATUS-Backup Status |
| rebranding | Update Re-Branding Details | post | apiKey-API Key to access your NCM server RESTORE_DEFAULT-Restore Default COMPANYNAME-Company Name BRANDNAME-Brand Name PRODUCTNAME-Product Name EMAILID-Email Id PHNUMBER-Phone Number WEBSITE-Website ENABLESUPPORT-Enable Support ENABLELINKS-Enable Links |
| snmpTrapSettings | Update SNMP Trap Settings | post | apiKey-API Key to access your NCM server HOSTNAME-Host Name PORT-Port COMMUNITY-Community |
| syslogForwarder | Update SYSLOG Forwarder | post | apiKey-API Key to access your NCM server SYSLOG_FRWD_IPS-SYSLOG Forwarder IP Address |
| proxySettings | Update Proxy Server Settings | post | apiKey-API Key to access your NCM server DIRECT_CONNECTION_TO_INTERNET-Direct Connection to Internet PROXY_HOST-Proxy Host PROXY_PORT-Proxy Port PROXY_USERNAME-Proxy UserName PROXY_PASSWORD-Proxy Password |
| proxySettingsTest | Test Proxy Server Settings | post | apiKey-API Key to access your NCM server PROXY_HOST-Proxy Host PROXY_PORT-Proxy Port PROXY_USERNAME-Proxy UserName PROXY_PASSWORD-Proxy Password DIRECT_CONNECTION_TO_INTERNET-Direct Connection to Internet |
| troubleTicket | Update Trouble Ticket Settings | post | apiKey-API Key to access your NCM server TT_MAIL_ADDRESS-Trouble Ticket Mail Address |
| databaseCleanup | Update Database CleanUp Settings | post | apiKey-API Key to access your NCM server DELETE_VERSION_HISTORY-Delete Version Hsitory DELETE_AUDIT_HISTORY-Delete Audit History DELETE_VERSION_HISTORY_DAYS-Delete Version History Days VERSION_HISTORY_SIZE-Version History Size AUDIT_HISTORY_SIZE-Audit History Size VERSION_HISTORY_SIZE_DAYS-Version History Size Days |
| logLevel | Update Log Level Settings | post | apiKey-API Key to access your NCM server LOG_LEVEL-Log Level |
| approveRequest | Approve the Upload Request | post | apiKey-API Key to access your NCM server ADMIN_COMMENTS-Admin Comments REQUEST_ID-Request Id REQUEST_APPROVED-Request Approved SCHEDULE_TYPE-Schedule Type ONCEONLY_START_TIME_HOUR-Once Only Start Hour ONCEONLY_START_TIME_MIN-Once Only Start Time Minutes ONCEONLY_START_DATE-Once Only Start Date |
| Module Name : ncmdevice | |||
| listAllDevices | List All Devices | get | apiKey-API Key to access your NCM server PROFILEID-Profile Id SEARCH_STRING-Search String type-Type value-Value TABLE_DATA-Table Data OSVERSION-OS Version OSTYPE-OS Type DEVICE_TYPE-Device Type MODEL-Model |
| listOSModelDevices | List Devices based on Specific OS Model | get | apiKey-API Key to access your NCM server TABLE_DATA-Table Data OSVERSION-OS Version OSTYPE-OS Type DEVICE_TYPE-Device Type MODEL-Model |
| devSummary | Fetches Specific Device Details | get | apiKey-API Key to access your NCM server deviceId-Resource Id ip-IP Address of the Device |
| updateDevSummary | Update Specific Device Details | post | apiKey-API Key to access your NCM server RESOURCEID-Resource Id HOSTNAME-Host Name IPADDRESS-IP Address OSVERSION-OS Version OSTYPE-OS Type MODEL-Model SERIES-Series SYSTEMDESCRIPTION-System Description SYSTEMLOCATION-System Location COLUMNNAME1-Column Name 1 COLUMNNAME2-Column Name 2 COLUMNNAME3-Column Name 3 OLD_TEMPLATE_NAME-Old Template Name NEW_TEMPLATE_NAME-New Template Name |
| getDevConfiglets | List History of Configlets Executed on Specific Device | get | apiKey-API Key to access your NCM server deviceId-Resource Id |
| getCurrentConfig | List Current Configuration of Specific Device | get | apiKey-API Key to access your NCM server deviceId-Resource Id |
| deleteDevice | Delete Specific Device | post | apiKey-API Key to access your NCM server DEVICE_IDS-Resource Ids |
| addDeviceGroup | Add New Device Group | post | apiKey-API Key to access your NCM server DEVICE_GROUP_NAME-Device Group Name DG_DESCRIPTION-Device Group Description SELECTEDDEVICES-Selected Devices GLOBAL_DEVICE_GROUP-Global Device Group IS_EDIT_VIEW-Is Edit View DEVICE_GROUP_ID-Device Group Id ComponentSelection-Component Selection QUERYID-Query Id CRITERIA_LIST-Criteria List([{"Condition":"condition","Field":"field","Comparator":"comparator","Value":"value"}]) Field-Field Value-Value Condition-Condition Comparator-Comparator |
| deleteDeviceGroup | Delete Specific Device Group | post | apiKey-API Key to access your NCM server DEVICE_GROUP_ID-Device Group Id |
| listDeviceGroup | List All Device Group | get | apiKey-API Key to access your NCM server DEVICE_GROUP_ID-Device Group Id |
| deviceGroupResources | List Devices which are Grouped under Specific Device Group | get | apiKey-API Key to access your NCM server DEVICE_GROUP_ID-Device Group Id PROFILEID-Profile Id SEARCH_STRING-Search String type-Type value-Value TABLE_DATA-Table Data OSVERSION-OS Version OSTYPE-OS Type DEVICE_TYPE-Device Type MODEL-Model |
| manage | Manage Device | post | apiKey-API Key to access your NCM server RESOURCEID-Resource Id |
| unmanage | Unmanage Device | post | apiKey-API Key to access your NCM server RESOURCEID-Resource Id |
| stopOperation | Stop Current Operation On Specific Device | post | apiKey-API Key to access your NCM server RESOURCEID-Resource Id |
| eolDataNotAvailable | List All EOL Data Not Available Devices | get | apiKey-API Key to access your NCM server |
| eolDevices | List All EOL Devices | get | apiKey-API Key to access your NCM server |
| eolAnnouncedDevices | List All EOL Announced Devices | get | apiKey-API Key to access your NCM server |
| updateIpAddress | Update IP Address for Specific Device | post | apiKey-API Key to access your NCM server RESOURCEIDS-Resource Ids |
| updateDNS | Update DNS for Specific Device | post | apiKey-API Key to access your NCM server RESOURCEID-Resource Id |
| getResourceIds | Fetches Resource Id for Specific IP Address | get | apiKey-API Key to access your NCM server IPADDRESS-IP Address |
| matchingDevices | Fetches Matching Devices on Specific Criteria | get | apiKey-API Key to access your NCM server IPADDRESS-IP Address CRITERIA_LIST-Criteria List([{"Condition":"condition","Field":"field","Comparator":"comparator","Value":"value"}]) Field-Field Value-Value Condition-Condtition Comparator-Comparator |
| getResourcesForGroups | Fetches Devices which are Grouped under Specific Device Group | get | apiKey-API Key to access your NCM server DEVICE_GROUP_ID-Device Group Id |
| searchResult | Fetches Search Result for Search String on Devices | get | apiKey-API Key to access your NCM server SEARCH_STRING-Search String |
| searchResultforConfig | Fetches Search Result for Search String on Configuration | get | apiKey-API Key to access your NCM server SEARCH_STRING-Search String |
| getDevInterfaces | List Interfaces on Specific Device | get | apiKey-API Key to access your NCM server deviceId-Resource Id |
| listDeviceGroups | List Device Group Based on Show Only Public Device Group | get | apiKey-API Key to access your NCM server SHOW_ONLY_PUBLIC_DEVICE_GROUP-Show Only Public Device Group |
| exeChangeDetection | Update Change Detection for Specific Device | post | apiKey-API Key to access your NCM server TRACKING_OPTION-Tracking Option SYSLOGSERVERIP-SYSLOG Server IP Address VENDORS-Vendors([{"name":"name","DEVICES":[Device1,Device2],"LOGGING_LEVEL":"Level"}]) LOGGING_LEVEL-Logging Level |
| exeLabelCurrConfig | Label Current Configuration | post | apiKey-API Key to access your NCM server SELECTED_DEVICES-Selected Devices LABEL_NAME-Label Name DESCRIPTION-Description NEW_LABEL_NAME-Label Name |
| performStatusCheck | Perform Status Check on Devices | get | apiKey-API Key to access your NCM server DEVICE_GROUP_ID-Device Group Id RESOURCEIDS-Resource Ids FUNCTIONALITY-Functionality |
| uploadConfigDevices | Upload Configuration on Specific Device | post | apiKey-API Key to access your NCM server LABEL_NAME-Label Name DEVICE_GROUP_ID-Device Group Id RESOURCE_ID-Resource Id DOWNLOAD_OPTION-Download Option SCHEDULE_DATE-Schedule Date SCHEDULE_HOUR-Schedule Hour SCHEDULE_MINUTE-Schedule Minute COMMENT-Comment |
| exeUploadConfig | Upload Configuration to Device | post | apiKey-API Key to access your NCM server CONFIG_ID-Config Id DOWNLOAD_TYPE-Download Type DOWNLOAD_AS-Download As COMMENT-Comment DOWNLOAD_OPTION-Download Option SCHEDULE_DATE-Schedule Date SCHEDULE_HOUR-Schedule Hour SCHEDULE_MINUTE-Schedule Minute |
| deviceTemplates | List All Device Templates | get | apiKey-API Key to access your NCM server |
| executeCommands | Execute Show Command | post | apiKey-API Key to access your NCM server DEVICEID-Resource Id COMMAND-Command IPADDRESS-IP Address |
| showCommandOutput | Shows the Output of Show Command | post | apiKey-API Key to access your NCM server RESOURCEID-Resource Id COMMAND-Command |
| isIPAvailable | Check Is IP Address Available | get | apiKey-API Key to access your NCM server IPADDRESS-IP Address |
| configConflicts | List Device Group Start Running Conflict in Short | get | apiKey-API Key to access your NCM server DG_ID-Device Group Id |
| configNoConflicts | Get Devices with out Startup Running Data in Device Group | get | apiKey-API Key to access your NCM server DG_ID-Device Group Id |
| configNotBackedUp | Get Devices without Backup Data in Device Group | get | apiKey-API Key to access your NCM server DG_ID-Device Group Id |
| markEOL | Marks the Devices as EOL | post | apiKey-API Key to access your NCM server RESOURCEID-Resource Id DISPLAYTYPE-Display Type MODEL-Model SERIES-Series |
| getResources | Get Devices available for User | get | apiKey-API Key to access your NCM server |
| getConfigContents | Get Configuration Content of the Device | get | apiKey-API Key to access your NCM server RESOURCEID-Resource Id FileType-File Type |
| pingTraceRouteResponse | Displays Result of Ping or Trace Route Command | get | apiKey-API Key to access your NCM server IPADDRESS-IP Address COMMAND-Command |
| Module Name : ncmcompliance | |||
| getDevComplianceList | Get Device Compliance List | get | apiKey-API Key to access your NCM server deviceId-Resource Id |
| getComplianceList | List All Compliance Policies | get | apiKey-API Key to access your NCM server |
| getAllGroups | List All Rule Group | get | apiKey-API Key to access your NCM server |
| getAllRules | List All Rules | get | apiKey-API Key to access your NCM server |
| getComplianceDetails | List Devices which are Violating Compliance Policies | get | apiKey-API Key to access your NCM server compolicyId-Compliance Policy Id type-Type value-Value |
| getRuleCompliances | List Rules in Compliance Policy with Violation Severity namely Critical, Major and Warning | get | apiKey-API Key to access your NCM server resPolicyId-Resource Policy Id severity-Severity compliant-Compliant |
| addRule | Add New Rule | post | apiKey-API Key to access your NCM server COMPRULE_NAME-Complaince Rule Name DUPL_RULE_NAME-Duplicate Rule Name COMPRULE_DESCR-Compliance Rule Descrition CRITERIA_TYPE-Criteria Type VIOLATION_SEVERITY-Violation Severity REMEDIATION_DESCR-Remediation Description REMEDIATION_TEMPLATE-Remediation Template START_BLOCK_CONFIG-Start Block Config END_BLOCK_CONFIG-End Block Config BLOCK_CONDITION-Block Condition BLOCK_CONDITION_VALUE-Block Condition Value COMPRULE_ID-Compliance Rule Id SIMPLE_CONDITION-Simple Condition SIMPLE_PATTERN-Simple Pattern SIMPLE_ALLOWED_COUNT-Simple Allowed Count CRITERIA_LIST-Criteria List([{"operator":"operator","condition":"condition","pattern":"pattern","allowedCount":"count"}]) condition-Condition operator-Operator pattern-Pattern Note: Condition Values are: should contain all lines = 10 should not contain any line = 20 should contain exact set = 30 should not contain exact set = 40 should contain = 80 should not contain = 90 |
| copyRule | Copy Existing Rule | post | apiKey-API Key to access your NCM server COMP_CLONE_RULES-Compliance Clone Rules |
| deleteRule | Delete Specific Rule | post | apiKey-API Key to access your NCM server COMPRULE_ID-Compliance Rule Id |
| addRuleGroup | Add New Rule Group | post | apiKey-API Key to access your NCM server COMPRULE_ID-Compliance Rule Id RULEGROUP_NAME-Rule Group Name RULEGROUP_DESCR-Rule Group Description COMPRULEGROUP_ID-Compliance Rule Group Id |
| deleteRuleGroup | Delete Specific Rule Group | post | apiKey-API Key to access your NCM server COMP_POLICYIDS-Compliance Policy Ids |
| addCompPolicy | Add New Compliance Policy | post | apiKey-API Key to access your NCM server COMPRULEGROUP_ID-Compliance Rule Group Id COMPPOLICY_NAME-Compliance Rule Group Name COMPPOLICY_DESCR-Compliance Policy Description CONFIG_TYPE-Configuration Type COMP_CRITERIA-Compliance Criteria COMPPOLICY_ID-Compliance Policy Id COMPRULEGROUP_ID-Compliance Rule Group Id |
| deleteCompPolicy | Delete Specific Compliance Policy | post | apiKey-API Key to access your NCM server COMP_POLICYIDS-Compliance Policy Ids |
| complainceCheck | Perform Compliance Check | get | apiKey-API Key to access your NCM server COMPPOLICY_IDS-Compliance Policy Ids RESOURCEID-Resource Id DEVICE_GROUP_ID-Device Group Id |
| getResPolicyInfo | Fetches Resource Policy Information | get | apiKey-API Key to access your NCM server resPolicyId-Resource Policy Id |
| policyAdhocResult | Fetches Compliance Policy Adhoc Test Result | get | apiKey-API Key to access your NCM server ComponentSelection-Component Selection DEVICEGROUPSELECTION-Device Group Selection SELECTEDDEVICES-Selected Devices CONFIG_TYPE-Configuration Type COMPPOLICY_ID-Compliance Policy Id |
| ruleAdhocTestResult | Fetches Compliance Rule Adhoc Test Result | get | apiKey-API Key to access your NCM server ComponentSelection-Compppponent Selection DEVICEGROUPSELECTION-Device Group Selection SELECTEDDEVICES-Selected Devcices CONFIG_TYPE-Configuration Type COMPRULE_ID-Compliance Rule Id COMPRULEGROUP_ID-Compliance Rule Group Id |
| exeAssocCompDev | Associate Compliance Policy to Devices | post | apiKey-API Key to access your NCM server COMPPOLICY_ID-Compliance Policy Id ASSIGNED_RESOURCES-Assigned Resources ASSIGNED_DEVICEGROUP-Assigned Device Group RUNCOMPCHECK_STATUS-Run Compliance Check Status |
| getAllReviews | List All Reviews | get | apiKey-API Key to access your NCM server REVIEWER_ID-Reviewer Id STATUS-Status |
| getMyReviews | List particular User Review | get | apiKey-API Key to access your NCM server STATUS-Status |
| getReviewDetails | List Review Details | get | apiKey-API Key to access your NCM server REVIEW_ID-Review Id |
| complianceStatus | Displays Compliance Status for Specific Device Group | get | apiKey-API Key to access your NCM server DG_ID-Device Group Id Status-Status |
| Module Name : ncmchanges | |||
| listAllConfigs | List All Configuration | get | apiKey-API Key to access your NCM server SEARCH_STRING-Search String type-Type value-Value |
| getAllVersions | List All Version | get | apiKey-API Key to access your NCM server deviceId-Resource Id SEARCH_STRING-Search String type-Type value-Value |
| getDevConfigs | List Configuration for Specific Device | get | apiKey-API Key to access your NCM server deviceId-Resource Id SEARCH_STRING-Search String type-Type value-Value |
| getDevChanges | List All Changes in Device | get | apiKey-API Key to access your NCM server deviceId-Device Id SEARCH_STRING-Search String type-Type value-Value |
| getRecentChangeList | List Recent Change List | get | apiKey-API Key to access your NCM server |
| getCurrentConfigFiles | List Current Configuration | get | apiKey-API Key to access your NCM server SEARCH_STRING-Search String type-Type value-Value |
| configChangeVersions | Fetches Configuration Change Details | get | apiKey-API Key to access your NCM server fileId-File Id |
| getDiffdetails | Fetches Diff Content in Configuration | get | apiKey-API Key to access your NCM server version1-Version 1 version2-Version 2 CONFIG_TYPE_1-Configuration Type 1 CONFIG_TYPE_2-Configuration Type 2 diffAlone-Diff Alone start-Start offset-Offset nextIndex-Next Index |
| startupRunningVersion | Get Startup and Running Version for Specific Resource | get | apiKey-API Key to access your NCM server RESOURCEID-Resource Id |
| getConfigFileDetails | Fetches Configuration File Details | get | apiKey-API Key to access your NCM server versionId-Version Id |
| getConfigSiblings | Fetches Details of Version | get | apiKey-API Key to access your NCM server versionId-Version Id |
| editConfigFileProp | Update Configuration File Properties | post | apiKey-API Key to access your NCM server VERSION_ID-Version Id AUTHCOMMENT_ID-Authorized Comment Id AUTHORIZE_CHANGES-Authorize Changes MESSAGE_BOX-Message Box ANNOTATION-Annotation CHANGEDBY-Changed By |
| exeConfSync | Copy Running to Startup Confiuration | post | apiKey-API Key to access your NCM server DEVICE_IDS-Device Ids |
| addChangeRule | Add New Change Rule | post | apiKey-API Key to access your NCM server RULE_NAME-Rule Name DEVICE_GROUP_ID-Device Group Id RESOURCEID-Resource Id RULE_DESCR-Rule Description RULE_ID-Rule Id SEND_EMAIL-Send Email SEND_TRAP-Send Trap GENERATE_TICKET-Generate Ticket ROLLBACK_CONFIG-Roll Back Configuration SEND_SYSLOGMSG-Send SYSLOG Messages CONDITION-Condition CHANGETYPECONDITION-Change Type Condition APPEND_DIFF-Append Diff EMAIL_FORMAT-Email Format EMAIL_SUBJECT-Email Subject EMAIL_MESSAGE-Email Message TO_ADDRESS-To Address TICKET_SUBJECT-Ticket Subject TICKET_MESSAGE-Ticket Message TICKET_TO_ADDRESS-Ticket To Address TICKET_APPEND_DIFF-Ticket Append Diff TICKET_EMAIL_FORMAT-Ticket Email Format HOST-Host PORT-Port COMMUNITY-Community SYSLOG_HOST-SYSLOG Host SYSLOG_PORT-SYSLOG Port ROLLBACK_CONFIG_TYPE-Roll Back Configuration |
| updateChangeRule | Update Change Rule | post | apiKey-API Key to access your NCM server ACTION_TYPE-Action Type RULE_ID-Rule Id CONTEXT-Context RESOURCEID-Resource Id DEVICE_GROUP_ID-Device Group Id |
| changeAssocDev | Associate Change Rule with Devices | post | apiKey-API Key to access your NCM server RULE_ID-Rule Id ASSIGNED_RESOURCES-Assigend Resources ASSIGNED_DEVICEGROUP-Assigned Device Group |
| newDraft | Add New Draft | post | apiKey-API Key to access your NCM server DRAFT_ID-Draft Id ANNOTATION-Annotation FILE_CONTENTS-File Contents DRAFT_NAME-Draft Name RESOURCEID-Resource Id VERSION_ID-Version Id |
| deleteDraft | Delete Specific Draft | post | apiKey-API Key to access your NCM server DRAFT_ID-Draft Id |
| getVersionDetails | Get Version Details | get | apiKey-API Key to access your NCM server VERSIONS-Versions |
| authorize | Authorize the Change | post | apiKey-API Key to access your NCM server VERSION_ID-Version Id AUTHORIZE_CHANGES-Authorize Changes MESSAGE_BOX-Message Box |
| assocLabel | Associate Label to Configuration | post | apiKey-API Key to access your NCM server VERSION_ID-Version Id SET_AS_BASELINE-Set as BaseLine LABEL_NAME-Label Name DESCRIPTION-Description NEW_LABEL_NAME-New Label Name |
| exportConfigVersion | Export Configuration Version in File Format | post | apiKey-API Key to access your NCM server VERSION_ID-Version Id DRAFT_ID-Draft Id |
| complianceCheck | Performs Compliance Check | get | apiKey-API Key to access your NCM server VERSION_ID-Version Id DRAFT_ID-Draft Id SELECTION_TYPE-Selection Type POLICY_ID-Policy Id CONFIG_TYPE-Config Type VERSION_NO-Version Number DRAFT_NAME-Draft Name |
| getLabelDetails | List Labels | get | apiKey-API Key to access your NCM server |
| exportConfigNow | Export Configuration Now | post | apiKey-API Key to access your NCM server |
| getDevDrafts | List Drafts Associated with Devices | get | apiKey-API Key to access your NCM server RESOURCEID-Resource Id |
| getAllDrafts | List All Drafts | get | apiKey-API Key to access your NCM server |
| getDraftDetails | Fetches Draft Details | get | apiKey-API Key to access your NCM server DRAFT_ID-Draft Id |
| getBaseLineConfig | Fetches Base Line Configuration | get | apiKey-API Key to access your NCM server versionId-Version Id |
| Module Name : ncmbackup | |||
| listAllBackups | List All Backup's | get | apiKey-API Key to access your NCM server type-Type value-Value |
| lastBackups | List Last Backup's | get | apiKey-API Key to access your NCM server |
| exeBackup | Execute Backup Operation on Specific Device | post | apiKey-API Key to access your NCM server DEVICE_IDS-Resource Ids IPADDRESS-IP Address |
| scheduleConfig | Add New Schedule for Configuration Backup | post | apiKey-API Key to access your NCM server TASK_TYPE-Task Type SCHEDULE_NAME-Schedule Name EMAIL_RECIPIENTS-Email Recipients SCHEDULE_TYPE-Schedule Type HOURLY_START_DATE-Hourly Start Date HOURLY_START_TIME_HOUR-Hourly Start Time Hour HOURLY_START_TIME_MIN-Hourly Start Time Minutes HOURLY_INTERVAL-Hourly Interval DAILY_START_DATE-Daily Start Date DAILY_START_TIME_HOUR-Daily Start Time Hour DAILY_START_TIME_MIN-Daily Start Time Minutes WEEKLY_START_TIME_HOUR-Daily Start Time Hour WEEKLY_START_TIME_MIN-Weekly Start Time Minutes WEEKLY_DAYS-Weekly Days MONTHLY_START_TIME_HOUR-Monthly Start Time Hour MONTHLY_START_TIME_MIN-Monthly Start Time Minutes MONTHLY_MONTHS-Monthly Months MONTHLY_DATE_OF_MONTH-Monthly Date of Month ONCEONLY_START_TIME_HOUR-Once Only Start Time Hour ONCEONLY_START_TIME_MIN-Once Only Start Time Minutes ONCEONLY_START_DATE-Once Only Start Date PRESELECT_TASK-Pre Select Task deviceGroupId-Device Group Id |
| getRecentBackups | List Recent Backup's | get | apiKey-API Key to access your NCM server type-Type value-Value |
| enableSchedule | Enable or Disable Schedule Configuration | post | apiKey-API Key to access your NCM server ACTION_TYPE-Action Type SCHEDULE_ID-Schedule Id |
| backupStatus | List Backed up Devices | get | apiKey-API Key to access your NCM server backup-Backup |
| notBackedup | List Not Backed Up Device List | get | apiKey-API Key to access your NCM server |
sec cont