Conformance
Configuration Best Practices By Technology API
Configuration Best Practices By Technology API returns the count of unique Configuration Best Practices rules that are creating exceptions in the network. The result is shown by technology such that it lists all the technologies to which the rules belong and the corresponding count in each.
Request URL
GET : https://apx.cisco.com/cs/api/v1/conformance/configuration-best-practices-by-technology
Request Parameters
| Parameters | Data Type | Required | Description | Default Value |
|---|---|---|---|---|
| customerId | NUMBER | Yes | The unique company key value in NP. Users can find this value in any NP URL for a company. | Not applicable |
| groupName | STRING | No | The groupName value indicates the Network Profile (NP) group to be selected. These groups are defined by the NCE for specific accounts. | Entire Network |
| solution | NUMBER | No | solution is what the customer subscribes for. This takes on values in the range of 0 to 5 where each digit represents a specific solution. 0:All, 1:Route/ Switch, 2:Data Center Compute, 3:Data Center Storage, 4:Data Center Switches, 5:Wireless | 0 |
Response Parameters
| Parameters | Data Type | Description |
|---|---|---|
| technology | STRING | This indicates the technology name. |
| ruleCount | STRING | This indicates the rule count. |
| ### Sample JSON Response | ||
| ``` | ||
| { | ||
| "data": [ | ||
| { | ||
| "ruleCount": "2", | ||
| "technology": "Asynchronous Transfer Mode (ATM)" | ||
| }, | ||
| { | ||
| "ruleCount": "3", | ||
| "technology": "Wireless / Mobility" | ||
| } | ||
| ] | ||
| } | ||
| ``` |
Configuration Policy Conformance API
Configuration Policy Conformance API shows the overall conformance to Custom Configuration rules. It returns a percentage value, which is the ratio of all conforming devices to the total number of devices included in the scope of Custom Configuration templates.
Request URL
GET : https://apx.cisco.com/cs/api/v1/conformance/configuration-policy-conformance
Request Parameters
| Parameters | Data Type | Required | Description | Default Value |
|---|---|---|---|---|
| customerId | NUMBER | Yes | The unique company key value in NP. Users can find this value in any NP URL for a company. | Not applicable |
| groupName | STRING | No | The groupName value indicates the Network Profile (NP) group to be selected. These groups are defined by the NCE for specific accounts. | Entire Network |
| solution | NUMBER | No | solution is what the customer subscribes for. This takes on values in the range of 0 to 5 where each digit represents a specific solution. 0:All, 1:Route/ Switch, 2:Data Center Compute, 3:Data Center Storage, 4:Data Center Switches, 5:Wireless | 0 |
Response Parameters
| Parameters | Data Type | Description |
|---|---|---|
| configurationPolicyCompliancePercent | STRING | This indicates the shows the overall conformance to Custom Configuration rules.It returns a percentage value, which is the ratio of all conforming devices to the total number of devices included in the scope of Custom Configuration templates. |
Sample JSON Response
{
"data": [
{
"configurationPolicyCompliancePercent": "93"
}
]
}Software Conformance API
Software Conformance API shows the overall conformance to the recommended software version. It returns a percentage value, which is the ratio of all conforming devices to the total number of devices included in software tracks. A conforming device is one that runs the software version recommended in its respective software track.
Request URL
GET : https://apx.cisco.com/cs/api/v1/conformance/software-conformance
Request Parameters
| Parameters | Data Type | Required | Description | Default Value |
|---|---|---|---|---|
| customerId | NUMBER | Yes | The unique company key value in NP. Users can find this value in any NP URL for a company. | Not applicable |
| groupName | STRING | No | The groupName value indicates the Network Profile (NP) group to be selected. These groups are defined by the NCE for specific accounts. | Entire Network |
| solution | NUMBER | No | solution is what the customer subscribes for. This takes on values in the range of 0 to 5 where each digit represents a specific solution. 0:All, 1:Route/ Switch, 2:Data Center Compute, 3:Data Center Storage, 4:Data Center Switches, 5:Wireless | 0 |
Response Parameters
| Parameters | Data Type | Description |
|---|---|---|
| swCompliancePercent | STRING | This metric indicates the the overall conformance to the recommended software version. It returns a percentage value, which is the ratio of all conforming devices to the total number of devices included in software tracks. A conforming device is one that runs the software version recommended in its respective software track. |
Sample JSON Response
{
"data": [
{
"swCompliancePercent": "58"
}
]
}Software Conformance By Track API
Software Conformance By Track API shows the conformance by each software track. It returns a list of values where each item in the list contains the name of the track, the percentage of devices that are running the recommended software version, the percentage of devices that are running one of the two previous recommended versions, and the percentage of devices that are not running any of the recommended version.
Request URL
GET : https://apx.cisco.com/cs/api/v1/conformance/software-conformance-by-track
Request Parameters
| Parameters | Data Type | Required | Description | Default Value |
|---|---|---|---|---|
| customerId | NUMBER | Yes | The unique company key value in NP. Users can find this value in any NP URL for a company. | Not applicable |
| groupName | STRING | No | The groupName value indicates the Network Profile (NP) group to be selected. These groups are defined by the NCE for specific accounts. | Entire Network |
| solution | NUMBER | No | solution is what the customer subscribes for. This takes on values in the range of 0 to 5 where each digit represents a specific solution. 0:All, 1:Route/ Switch, 2:Data Center Compute, 3:Data Center Storage, 4:Data Center Switches, 5:Wireless | 0 |
| swTrackName | STRING | No | This indicates the name of the software track | All |
Response Parameters
| Parameters | Data Type | Description |
|---|---|---|
| swTrackName | STRING | This indicates the Software Track Name |
| nonCompliance | STRING | This indicates the non Compliance |
| previousStandardCompliance | STRING | This indicates the previous Standard Compliance |
| currentStandardCompliance | STRING | This indicates the current Standard Compliance |
Sample JSON Response
{
"data": [
{
"previousStandardCompliance": "0.00",
"currentStandardCompliance": "15.79",
"swTrackName": "Cisco 1900 Series ISRs",
"nonCompliance": "84.21"
},
{
"previousStandardCompliance": "50.41",
"currentStandardCompliance": "41.33",
"swTrackName": "Cisco 2900 Series ISR",
"nonCompliance": "8.26"
}
]
}Software Conformance Trend API
Software Conformance Trend API shows the conformance by track over a period of time for all tracks. The input parameters specify whether the trend is for weekly or monthly data points. For each track, the API returns a list of values with two data items. One is the percentage absolute conformance at a given point in time and other is the corresponding timestamp.
Request URL
GET : https://apx.cisco.com/cs/api/v1/conformance/software-conformance-trend
Request Parameters
| Parameters | Data Type | Required | Description | Default Value |
|---|---|---|---|---|
| customerId | NUMBER | Yes | The unique company key value in NP. Users can find this value in any NP URL for a company. | Not applicable |
| groupName | STRING | No | The groupName value indicates the Network Profile (NP) group to be selected. These groups are defined by the NCE for specific accounts. | Entire Network |
| solution | NUMBER | No | solution is what the customer subscribes for. This takes on values in the range of 0 to 5 where each digit represents a specific solution. 0:All, 1:Route/ Switch, 2:Data Center Compute, 3:Data Center Storage, 4:Data Center Switches, 5:Wireless | 0 |
| swTrackName | STRING | No | This indicates the software track name | All |
| interval | STRING | No | This indicates the desired interval namely weekly/monthly. | weekly |
| numberOfIntervals | NUMBER | No | This indicates the desired number of intervals. | 24 weeks |
Note- Data retrieval is subjected to data availability.
Response Parameters
| Parameters | Data Type | Description |
|---|---|---|
| time | STRING | This indicates the time interval for a specific data point. |
| intervals | ARRAY | This is an array of objects that contains conformance and time. |
| swTrackName | STRING | This indicates the software Track Name |
| conformance | STRING | This indicates the conformance percentage |
Sample JSON Response
{
"data": [
{
"swTrackName": "Cisco 1900 Series ISRs",
"intervals": [
{
"conformance": "15.00",
"time": "2018-08-18"
},
{
"conformance": "15.79",
"time": "2018-09-08"
}
]
}
]
}
Software Flexible Conformance Trend API
Software Flexible Conformance Trend API shows the flexible conformance by track over a period of time for all tracks. Flexible conformance includes devices running the previous recommended version as well as those running the current recommended version. For example, if there are 100 devices in the track, 50 on the recommended software version and 20 on one of the previous two recommended versions then the conformance will be 50% and flexible conformance will be 70%. The input parameters specify whether the trend is to be shown for weekly or monthly data points. For each track, the API returns a list of values with two data items. One is the percentage flexible conformance at a given point in time and other is the corresponding timestamp.
Request URL
GET : https://apx.cisco.com/cs/api/v1/conformance/software-flexible-conformance-trend
Request Parameters
| Parameters | Data Type | Required | Description | Default Value |
|---|---|---|---|---|
| customerId | STRING | Yes | The unique company key value in NP. Users can find this value in any NP URL for a company. | Not applicable |
| groupName | STRING | No | The groupName value indicates the Network Profile (NP) group to be selected. These groups are defined by the NCE for specific accounts. | Entire Network |
| solution | NUMBER | No | solution is what the customer subscribes for. This takes on values in the range of 0 to 5 where each digit represents a specific solution. 0:All, 1:Route/ Switch, 2:Data Center Compute, 3:Data Center Storage, 4:Data Center Switches, 5:Wireless | 0 |
| swTrackName | STRING | No | This indicates the name of the software track | All |
| interval | STRING | No | This indicates the desired interval namely weekly/monthly. | weekly |
| numberOfIntervals | NUMBER | No | This indicates the desired number of intervals. | 24 weeks |
Note- Data retrieval is subjected to data availability.
Response Parameters
| Parameters | Data Type | Description |
|---|---|---|
| time | STRING | This indicates the time interval for a specific data point. |
| intervals | ARRAY | This is an array of objects that contains conformance and time. |
| swTrackName | STRING | This indicates the software Track Name |
| conformance | STRING | This indicates the flexible conformance |
{
"data": [
{
"swTrackName": "Cisco 1900 Series ISRs",
"intervals": [
{
"conformance": "15.00",
"time": "2018-08-18"
},
{
"conformance": "15.79",
"time": "2018-09-08"
},
{
"conformance": "5.00",
"time": "2018-07-14"
},
{
"conformance": "0.00",
"time": "2018-06-23"
},
{
"conformance": "15.79",
"time": "2018-08-25"
},
{
"conformance": "15.79",
"time": "2018-09-15"
},
{
"conformance": "0.00",
"time": "2018-10-06"
}
]
}
]
}