Navigation
Supported Platforms
Related Documentation
APIs for the Cloud CPE Selfcare Application for MX Series Routers
The cCPE Selfcare application provides a representational state transfer API for cCPE monitoring and configuration tasks. It exposes all the service provider and subscriber self-care functionality available through the cCPE Selfcare application and can be used for OSS integration. The representational state transfer API consists of three distinct interfaces:
- Subscriber management API— The subscriber management
API provides the following functionality:
- Enables service providers to create, modify, delete, and retrieve customers and their associated sites and access links.
- Enables service providers to import customers associated with Layer 3 VPNs provisioned by Network Activate.
- Enables network administrators at the subscriber site to make configuration changes specific to their cCPE services, as well as provide easy-to-understand names and descriptions to sites and access links. The representational state transfer API hides all network specific information associated with the enterprise administrators access links to the service provider network.
- Configuration management API— The configuration
management API provides access to the cCPE configuration on the router.
Enterprise administrators can use this API to read, modify, and delete
router configuration. Service providers can use this API to provision
services on behalf of their subscribers. Using the configuration management
API, you can configure:
- Private IP addresses for an access link
- Static routes for a VPN site
- DHCP server and DHCP relay configuration for a VPN site
- SNMP configuration for a VPN Site
- Monitoring API — Service providers and enterprise
administrators can use this API to monitor and audit the health of
their cCPE services. It also enables the retrieval of graphs associated
with collected SNMP data. This API supports the following functionality:
- Functional audit — Enables the retrieval of functional audit results. Using the representational state transfer API, you can schedule functional audits to verify the connectivity between different sites of a particular subscriber.
- Status monitoring — Enables the retrieval of traffic counters for all access links or sites associated with a subscriber.
- Historical data — Enables the retrieval of graphical views for SNMP data using OpenNMS. Because OpenNMS is built into the Junos Space Network Management Platform, no additional software is required. You can specify the type of graph you want to display based on the selected MIB and time interval for the data.
