Have an account?

  •   Personalized content
  •   Your products and support

Need an account?

Create an account

Cisco Managed Services Accelerator (MSX) 3.10 Platform User Guide

Book Contents
Find Matches in This Book
Available Languages
Download Options

Book Title

Cisco Managed Services Accelerator (MSX) 3.10 Platform User Guide

Chapter Title

Getting Started with Cisco Managed Services Accelerator

Results

Updated:
February 15, 2021

Chapter: Getting Started with Cisco Managed Services Accelerator

Getting Started with Cisco Managed Services Accelerator

Cisco Managed Services Accelerator (MSX) is an open software platform that enables service providers to create and manage services across physical and virtual network elements. The MSX solution utilizes network function virtualization and enables service providers to provide their customers a flexible selection of services that are easily customized through a self-service portal. It reduces the costs for service creation, customer acquisition, service fulfillment, time to repair, and maintenance. With Cisco MSX solution, you can automate end-to-end provisioning for different use cases and service topologies. Each release of the MSX provides out-of-box capabilities to orchestrate particular use cases, also called service packs (such as, Cisco MSX SD-WAN, Cisco MSX SD-Branch, and Cisco MSX Managed Devices). The MSX service packs are a suite of prepackaged software capabilities that fully automate the end-to-end service creation including ordering, service chaining, orchestration, service assurance, user self care, real time performance reporting, and user-defined policy changes. With these fully validated service level packages, end customers can quickly turn on, control, and ensure cloud-based managed services offered by the service provider. For detailed information about MSX solution, see Cisco Managed Services Accelerator (MSX) Solution Overview Guide.

For information on MSX platform or service pack installation, see the latest version of Cisco MSX Installation and Upgrade Guide on cisco.com.

This chapter contains the following topics:

Logging In and Out of the MSX Portal

To log into the MSX portal, enter the following URL in your web browser address field, where server-ip is the IP address or fully qualified domain name (FQDN) name of the MSX server:

https://<server-ip>/vms or https://<your_portal_fqdn>

Depending on your network configuration, the first time your browser connects to the Cisco MSX web server, you may have to update your client browser to trust the security certificate of the server. This ensures the security of the connection between your client and the Cisco MSX web server.

Your user account privileges determine what you can see and do in the user interface. For information on Cisco MSX users and the actions they can perform, see Managing User Roles.

If you are using any third-party applications with MSX, you can configure single-sign on (SSO) to access these applications from MSX. For more information about configuring single-sign on, see Configuring Single Sign-On (SSO).

To log out, in the left pane of the MSX portal, click Logout.

Configuring Integrations for Outbound APIs

Using this procedure, you can enter the configuration details for the Business Support Set (BSS), Representational State Transfer (REST), and outbound API calls.

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.

Step 2

From the left pane, choose Settings > BSS Integration.

The BSS Integration window is displayed.

Step 3

In the Global tab, enable or disable the following attributes:

  • Read only User View—This sets a flag that basic users are only allowed read only views.

  • Show Profile—This enables the user to see all their profile data. A link will appear in the upper right-hand user menu that lets them go to their profile.

  • Read only Tenant View—This enables a flag denoting a basic tenant only has read-only view of their services.
Step 4

Click the REST Configuration tab to set the authentication mode details for the Integrations system. Here you provide the BSS credentials to receive the API.

Step 5

Select Basic or OAuth 2 based on your requirement.

  • If you have selected Basic, enter the user ID and password of the Integrations system.
  • If you have selected OAuth 2, enter the client ID, password, Token request URL, HTTP Method, Token Validation header, Token header format, and other necessary details.
Step 6

Click Save to save the authentication details.

Step 7

In the Outbound API tab, under API Context, enter the base context URL for the outbound API calls in the Base Context attribute. It allows you to define the file path for APIs to BSS.

  1. Under APIs area, you can modify the Allowed Values, Pricing Options, Accessible Services, Service Cancellation, Notification URL of APIs. Click Update to save changes.

Step 8

The Service Pack API tab allows API payload validation by platform from service packs.

Configuring SMTP Parameters

Using this procedure, you can configure various SMTP parameters using SMTP settings. The Cisco MSX portal allows you to edit the SMTP settings after the installation.

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.
Step 2

From the left pane, click Settings.

The Settings window is displayed.

Step 3

Click SMTP.

Step 4

Enter the following SMTP Basic information:

  • Host name

  • Port

  • Support email address

  • Write timeout (in milliseconds)

  • Connection timeout (in milliseconds)

  • Retry delay (in milliseconds)

  • Retries
Step 5

Enter the Security setting details that allows MSX to communicate to the SMTP server. The security setting has the following fields:

  • Require TLS—Check the check box in case you need to enable an SSL connection between MSX and the SMTP server.

  • Require Auth—Check the check box in case you need to configure a username and password to be used while connecting to the SMTP server. When you enable it, the following fields get enabled:

    • Username

    • Password

    • Confirm Password
Step 6

Click Save.

Enabling Multiple Subscriptions for a Tenant

Multiple orderings of a service allow service providers to customize the same service to meet different needs of a subscriber. For example, multiple WAN networks can be instantiated separately for security reasons to provide an air gap in the network by configuring a red network and a green network using WAN network.

As a user with an administrator role, you can enable this feature at the service definition time. Upon installing service packs, you need to do the necessary configuration at the service pack level to enable this feature on Cisco MSX Portal. To configure this feature, enable the multipleInstance metadata using the POST request in the Catalog Service API. For more information on this API, refer the Swagger documentation that can be accessed from MSX portal > Account Settings > Swagger > MSX Platform Catalog Service API. By default, only a single instance of a service can be ordered. After this feature is enabled, tenants can order more than one instance of a service. 


{
"id": "f3e326cc-6545-11e7-6547-be2e65b06b65",
"name": "vbranch",
"label": "cisco.consume.service.vbranch.name",
"activeFlag": true,
"version": 1,
"displayOrder": 1,
"description": "cisco.consume.service.vbranch.description",
"image": "/services/vbranch/images/icons/image_vbranch_service.svg",
"multipleInstanceAllowed": true,
"configuration": {
"device": "false",
"parts": "2",
"showOffers": "true"
  },

Note
Multiple Service instance is supported for both Create and Update Subscription.

Enabling Notification for Events

You can either enable notifications for various events through email or REST API. Cisco MSX provides support to trigger notifications when certain events occur:


Note

  • Ensure you have configured Integrations, REST configuration details, and Outbound API details for sending REST notifications, if you want to use REST API rather than email notifications. For more information, see the section, Configure Integrations.

  • Both REST and Email communication modes are supported for all of the following list of events. However, only Email notification is supported (and not REST) for the event End User Password Reset Link.

  • Email notifications are sent only when you have configured email client.

Table 1. List of Events

Recipients

Events

Consumer, operator, or administrator

Password is reset.

Remote user

  • Remote user created or deleted.

  • User ID is activated or deactivated/suspended.

  • Password reset.

Service Provider

End User

  • Update Site

  • Delete Site

  • Add Site

  • Tenant Added.

  • Tenant Updated.

  • Tenant Deleted.

  • Approval Pending for Requester.

  • Approval Pending for Approver.

  • Service Approved or Rejected.

  • Device Added.

  • Device Deleted.

  • Device Only Purchase.

  • Device Updated.

  • Device Registered.

  • End User Added.

  • End User Deleted.

  • End User Password Reset Link (supports only Email notification).

Service Provider

End User

  • End User Password Success Confirmation.

  • End User Updated.

  • Confirmation for Service Order.

  • Service Order Failure.

  • Service Activation Success Confirmation.

  • Service Activation Failure.

  • Service Deprovisioned.

  • Service Deprovisioning Failure.

  • Service Unsubscribed.

  • Service Updated

  • Service Update Failure.

  • Configuration of Tenant VCE Required (indicating that the Cisco VCE is added to the Cloud VPN service).

  • SSL VPN User Added.

  • SSL VPN User Add Failure.

  • SSL VPN User Deleted.

  • SSL VPN User Password Reset Link (supports only Email notification).

  • SSL VPN Password Reset Success.

  • SSL VPN Password Reset Failure.

  • SSL VPN User Status Changed.

  • Enable Bandwidth Prioritization.

Using this procedure, you can enable notification for events.

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.
Step 2

From the left pane, click Notifications.

The Notifications window is displayed.

Events related to Provider and End Users are displayed when you click the Provider and End Users tab respectively.
Step 3

Using the Category drop-down list, you can further categorize events.

Step 4

For an event, you can edit the Template name, Communication Mode by clicking the Edit icon (located next to the Communication Mode value). You can also enable or disable the notification for a specific event.

Auditing an Event Log

Cisco MSX provides an auditing framework that allows you to capture Platform and Service Pack events.

Cisco MSX auditing framework is a microservice that monitors, collects, and publishes auditing events data. This framework also provides integration endpoints for third party systems to monitor real-time auditing events via technologies such as HTTP streams.

Cisco MSX auditing framework relies on Kafka to collect auditing events. Also, this framework is protected by Cisco MSX SSO.

Cisco MSX auditing framework has two components - the library and the collecting service that would expose a set of APIs and streaming of the components to expose the data collected. Streaming APIs is used for general purpose.

Currently, Cisco MSX supports three types of events:

  • General-purpose audit events—Publish general-purpose events via an Auditing API

  • Device logging events—Publish device logging events via an Auditing API

  • Auditing events—Publish auditing events via an Auditing API

For more information on the Auditing API, refer the Swagger documentation that can be accessed from MSX portal > Account Settings > Swagger > Auditing Microservice API.

Defining Terms and Conditions for a Service

Using this procedure, you can define and maintain the terms for a service.

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.
Step 2

From the left pane, choose Settings > Service Configuration.

The Service Configuration window is displayed.

Select the service pack.
Step 3

Click Terms & Conditions.

Step 4

Select one of the service packs offers from the Offers drop-down list.

Step 5

Select the desired format for the font.

Step 6

Enter details required for acceptance by a consumer while purchasing a service. This information is displayed while the consumer places an order for the service. The terms and conditions are defined specific to an offer in a service.

Step 7

Click Save.

Configuring an Announcement

Using this procedure, you can create an announcement text to display the alert messages such as planned maintenance alert and technical issues. These announcements are displayed for users upon login.

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.
Step 2

From the left pane, choose Settings > Announcements.

The Announcements window is displayed.

Step 3

Enter the title and the message to be communicated.

Step 4

Choose an announcement style - Danger, Warning, Info, or Success from the Visual Style drop-down list, depending on the criticality or type of announcement to make.

Step 5

Optionally select the Start Time and End Time for the announcement.

If Start Time is not specified, the announcement is displayed immediately after it is saved. If an End Time is not specified, the announcement is displayed indefinitely after start time - You need to resolve the message for it to stop displaying.
Step 6

Choose either Page Header Announcement or Ticker Announcement to select the Announcement Type.

Step 7

Click Save.

The newly added announcements are listed.

Once the issue is resolved, you can select the announcement that you want to delete from the list.

Viewing Permissions Mapping

The API permissions viewer allows you to view API endpoints for all MSX microservices and permissions required to execute these API endpoints.

Using this procedure, you can view the permissions mapping.

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.
Step 2

From the left pane, choose Settings > API Permissions.

The API Permissions Viewer window is displayed.

You can view the permissions by:

  • Microservice—Click By Microservice to list all the Cisco MSX services. Select a microservice to display microservice to API endpoint mapping. Click on the API endpoint to further display the permissions required for the selected API endpoint.

  • Permission—Click By Permission to list all the MSX permissions. Select permission to display microservice. Click on the microservice to further display the API endpoint.

  • Path—Click By Path to list all the MSX APIs. Select an API to display the type of microservice. Click on the microservice to further display the permissions.

Note 

  • You can also search for any permission by using the search bar.

  • Some APIs may not have permissions.

Uploading a New Network Element Driver (NED) Package

The NED is uploaded to Cisco Network Services Orchestrator (NSO) to enable network connectivity of different device types and services. Cisco MSX allows you to add, replace, and delete NED for device management.

You can add a new NED at any time after the Cisco MSX is installed and deployed into production.

To support this feature for all the service packs, you must have the ability to upload a NED package to NSO, and NSO must appropriately get restarted to take on that new NED.

Using this procedure, you can upload a new NED package using the MSX portal.

Before you begin

  • Download the NED from the URL. Use your Cisco credentials to log in.

  • The downloaded NED package contains the following files:
    README.signature
cisco_x509_verify_release.py
ncs-4.7.6-juniper-junos-4.5.13.signed.bin
ncs-4.7.6-juniper-junos-4.5.13.tar.gz
ncs-4.7.6-juniper-junos-4.5.13.tar.gz.signature
tailf.cer
Table 2. NED Package Files

Downloaded NED Package Files

Name of Each NED files

ncs-4.7.6-juniper-junos-4.5.13.tar.gz

Main NED file

ncs-4.7.6-juniper-junos-4.5.13.tar.gz.signature

Signature File

tailf.cer

Certificate File

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.
Step 2

From the left pane, choose Settings > NED Management.

The NED Management window is displayed with a table.

All the NEDs installed in different service packs are displayed in this table.
Step 3

Click Add NED.

The Upload NED File dialog box is displayed.

Step 4

Upload the downloaded NED package files in their respective fields:

  • Upload NED Package

    • Choose file—Select the main NED file from the downloaded NED package and upload it.

      Note 

      The same NED file cannot be uploaded more than once unless we delete the existing file.

  • Verify NED Package—After the NED package is uploaded, a back-end process verifies the correctness of the file.

    • Choose file—Select the Signature file from the downloaded NED package and upload it.

    • Choose file—Select the Certificate file from the downloaded NED package and upload it.

    Note 

    You will get a popup message stating whether the validation was successful or had any error.

  • Install NED Package—After the NED package is verified, it gets installed to the NSO.

    • Service Pack—Select the Service Pack from the Service Pack drop-down list.

      Note 

      NSO pods are restarted, and the new NED package becomes active.
Step 5

Click Upload.

The Upload NED confirmation dialog box is displayed for you to confirm the upload.

Step 6

Click Upload again.

Note 

Now the NSO POD restarts; during this time, the device operations are unavailable. So, do not navigate away from the window.

The Validating and Installing NED file popup is displayed. The installation process takes a few minutes to complete.

After a while, the popup message Success appears if the validation is successful, else the popup message An Error Occurred is dispayed if the validation is not successful.

Step 7

Click Close.

Now you can see the NED in the NED Management window.

Deleting a NED Package

You can delete an uploaded NED package at any time after the Cisco MSX is installed and deployed into production.

Using this procedure, you can delete a NED package using the MSX portal.

Before you begin

  • Ensure to delete all the sites that are using the NED.

  • On deleting NED, the device models that use NED namespace cannot be used in the service pack anymore.

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.
Step 2

From the left pane, choose Settings > NED Management.

The NED Management window is displayed with a table.

This table displays all the NEDs installed in different service packs.
Step 3

Select the NED, and click ellipsis (…) > Delete.

The Delete NED confirmation dialog box is displayed for you to confirm the delete.

Step 4

Click Delete.

Note 

Now the NSO POD restarts; during this time, the device operations are unavailable. So, do not navigate away from the page.

The Deleting and Uninstalling NED file dialog box is displayed. The deletion process takes a few minutes to complete. Then the popup message Success is displayed.

Step 5

Click Close.

Replacing a NED Package

Cisco MSX allows you to replace NED for device management. The replace option is used to upgrade or change an existing version of the NED package.

Using this procedure, you can replace a NED package using the MSX portal.

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.
Step 2

From the left pane, choose Settings > NED Management.

The NED Management window is displayed with a table.

This table displays all the NEDs that are currently installed in different service packs.
Step 3

Select the NED, and click ellipsis (…) > Replace.

The Replace NED File dialog box is displayed.

Step 4

Upload the downloaded NED package files in their respective fields:

  • Upload New NED Package

    • Choose file—Select the main NED file from the downloaded NED package and upload it.

  • Verify NED Package—After the NED package is uploaded, a back-end process verifies the correctness of the file.

    • Choose file—Select the Signature file from the downloaded NED package and upload it.

    • Choose file—Select the Certificate file from the downloaded NED package and upload it.

    Note 

    You will get a pop-up message stating whether the validation was successful or had any error.

  • Install NED Package—After the NED package is verified, it replaces the already installed NED.

    Note 

    • The Service Pack is selected by default.

    • NSO pods are restarted, and the new NED package is replaced.
Step 5

Click Replace.

The Replace NED confirmation dialog box is displayed for you to confirm the replace.

Step 6

Click Replace again.

Note 

Now the NSO POD restarts; during this time, the device operations are unavailable. So, do not navigate away from the page.

The Validating and Replacing NED file pop-up is displayed. The replacement process takes a few minutes to complete.

After a while, the pop-up message Success is displayed, if the validation is successful, else the pop-up message An Error Occurred is dispayed, if the validation is not successful.

Step 7

Click Close.

Building New Services Using MSX Platform SDK

Cisco MSX Platform SDK allows you to build new services for MSX. These new services can be:

  • platform extensions that add functionality to the platform, or

  • service packs that implement new products apart from the service packs provided by MSX. MSX provides SD-Branch, SD-WAN, Cloud UTD, Managed Devices, and Enterprise Access service packs. For more information on the service packs available with Cisco MSX, see Cisco MSX Solution Overview Guide.

Cisco MSX supports the following APIs integrated as part of the platform SDK:

  • User Management Service

  • Catalog Service

  • Manage Service

  • Monitor Service

  • Workflow Service

For more information on these APIs, refer to the Swagger documentation that can be accessed from MSX portal > Account Settings > Swagger.

Managing Service Chains in Cisco MSX

Using the MSX CRUD APIs, you can manage configurations for the following entities for the service chains in Cisco MSX:

  • SD-Branch Catalog

  • Service virtual network function descriptor (VNFD)—VNFDs describe the requirements of a particular VNF on its execution environment. For example, a given VNF might need a fixed set of virtual CPUs and a certain amount of memory and disk space.

  • Service network service descriptor (NSD)—NSDs describe the relationship between a set of VNFDs such that they become a network service. Typically, this entails a service chain of connected VNFDs with parameters for how they function together. For example, the NSD could specify the options for scaling up the service if utilization passes a certain threshold.

    Descriptors are templates to instantiate VNFs and services. After being instantiated, these are represented as records: NSR and VNFR.

  • Service network service information (NS Info)—In the latest ETSI specifications, NSR and VNFR are renamed as NS Info and VNF info elements.

For more information on these APIs, refer to the Swagger documentation that can be accessed from MSX portal > Account Settings > Swagger > Orchestration API.

Important Notes:

  • Any configuration changes to the service chains must be executed only using these service chain APIs.

  • Only users with NSO Configuration/Data (Manage) permission can execute these service chain APIs. This permission can be found under the Services, Configurations, and Devices category.

  • MSX provides two sets of service chain APIs for SD-Branch Catalog, VNFD, and NSD. One set of APIs needs ‘ShardID’ as input, whereas the other set of APIs requires ‘servicetype’ as an input.

    Use only the API that requires ‘servicetype’ as an input to make these configuration changes because the “ShardID” are deprecated.

Standardizing Device Listing and Status

Cisco MSX allows you to create a centralized place for device listing and the visualizing associated site status through a defined API across all the service packs that are deployed within MSX.

The capabilities of Device API (/v4/devices) are to:

  • Create a device

    • Create a device with and without having a prior subscription ID and a service instance ID.

    • Create a device with and without having a prior serial key (This is optional).

    • Set initial status to a new device created.

    • Create non-NSO devices, such as Meraki.

  • Delete one device by ID

  • Get one device by ID

  • Get paginated devices by filters (multiple filters, that is, AND combination is supported at a time to get the desired result)

  • Get count of the total number of devices by filters (Multiple filters, that is, AND combination is supported at a time to get the desired result)

  • Update the device status

MSX supports three types of v4 devices for creating and deleting devices:

  • Atomic devices­—When you create/delete a device, the device gets created/deleted in the platform and does not need further processing by any system, like NSO or Meraki.

  • Non-atomic devices (NSO-specific devices)—When you create/delete a device in the platform, it expects to be processed by other devices. This is used by Cisco MSX SD-Branch and Managed Device service pack.

  • Non-atomic devices (Viptela and Meraki-specific devices)—When you create/delete a device in the platform, it expects to be processed by other devices.

Only users with Device Settings (Manage) permission can execute these Device APIs. This permission can be found under the Services, Configurations, and Devices category.

To enable this feature, use the Devices (/v4/devices) API in the Device Controller section of the Manage Service API. For more information on these APIs, refer to the Swagger documentation that can be accessed from MSX portal > Account Settings > Swagger > Manage Service API.

Deploying Service Pack

The Cisco MSX allows service providers to deploy and manage third-party services or service pack components into MSX. You can enable this functionality from the Cisco MSX portal or by using the Service Lifecycle Management (SLM) API. The new service can be any service, including platform extension, which can run within the Cisco MSX infrastructure after the platform is deployed.

Each component can provide one or more APIs and applications. Applications must be published to the MSX Service Catalog before subscribing to it.

The capabilities of SLM API are:

  • Upload a third-party component (in parts if required)

  • Get component details

  • Get component Kubernetes deployment status

  • Get a list of components

  • Delete a component

To enable this feature using API, use the Service Lifecycle Management Controller section of the SLM API.

From the Services, Configurations, and Devices category, assign the Service Lifecycle Management (View and Manage) permission to a user to run this API.

For more information on these API, refer to the Swagger documentation that can be accessed from MSX portal > Account Settings > Swagger > Service Lifecycle Management API.

Using this procedure, the service providers can deploy the service or service pack components into Cisco MSX from the MSX portal.

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.

Step 2

From the left pane, click Settings > Component Management.

Step 3

Add a service or service pack component.

  1. Click the Add Component icon that is located on the far right on the Component Management window.

    The Add Component dialog box is displayed.

  2. Choose the component tar file from your local storage.

  3. Click Upload.

    The components is uploaded into Cisco MSX.
Step 4

Create an application.

  1. Click Publish Application.

    The Add Application dialog box is displayed.

  2. Enter the Name, Label, and Description.

  3. Click Save.

    The newly added application is displayed on the Application window.

Step 5

Click the ellipsis (...) that is located on the far right in the same row of the application and then choose Offer.

The Offer window is displayed.

Step 6

Create an offer.

  1. Click Create Offer.

    The Add Offer window is displayed.

  2. Enter the Name, Label, and Description.

  3. Click Save.

    The newly added offer is displayed on the Offer window.

Step 7

From the left pane, choose Tenant Workspace > Offer Catalog.

The Offer Catalog window is displayed

Step 8

Click the Continue to Offers icon located on the offer.

The selected offer window is displayed.
Step 9

Click Get Started.

The Confirm Subscription window is displayed.

Step 10

Click Subscribe.

The service pack offer is displayed on the Offer Catalog window.

What to do next

The Cisco MSX service provides can manage the service offers. For more information, see Managing Offers.

Managing Offers

Using this procedure, the service providers can manage the offers from the Cisco MSX portal.

Before you begin

Create a new service offer. For more information, see Deploying Service Pack

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.

Step 2

From the left pane, choose Settings > Component Management.

Step 3

Click the ellipsis (...) that is located on the far right in the same row of the application that needs to be edited or duplicated.

Step 4

Choose Offer.

The Offer window is displayed.

Step 5

Edit an offer.

  1. Click the ellipsis (...) that is located on the far right in the same row of the existing list of offers and choose Edit.

    The Edit Offer dialog box is displayed.

  2. Enter the Name, Label, Description, Terms and Condition, and Price Plan.

  3. Click Save.

Step 6

Duplicate an offer.

  1. Click the ellipsis (...) that is located on the far right in the same row of the existing list of offers and then choose Duplicate.

    The Add Offer dialog box is displayed.

  2. Enter the Name, Label, Description, Terms and Condition, and Price Plan.

  3. Click Save.

Deleting Service Pack Component

Using this procedure, you can delete the service or service pack component.

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.

Step 2

From the left pane, choose Settings > Component Management.

The Component Management window is displayed.

Step 3

Click the ellipsis (...) that is located on the far right in the same row of the component that you need to delete and then choose View Application.

Step 4

Click the ellipsis (...) that is located on the far right in the same row of the component that you need to delete and then choose Delete.

The Delete Component confirmation dialog box is displayed. Confirm the deletion of that component from Cisco MSX.

Note 

You can delete a component, only when you unsubscribe from that particular component. Choose Tenant Workspace > Services. Click the Unsubscribe icon that is located on the far right on the exact component pane that needs to be deleted.

Step 5

Click Delete.

The component is deleted.

Assigning Service Pack Offers to Tenants

The Cisco MSX platform now provides the ability to hide or show service offerings for a tenant or a group of tenants. You can enable this functionality from the Cisco MSX portal or by using the MSX Platform Catalog Services API. Only tenants with required permissions can subscribe to the service offerings visible to them.

Use MSX Platform Catalog Services API to create, update, cancel, close, and delete service offerings.

You can manage the configurations of services and offers using MSX Platform Catalog Services API:

  • To manage the services configuration, use the Service Controller section of the MSX Platform Catalog Services API.

  • To manage the offers configuration, use the Service Offer Controller section of the MSX Platform Catalog Services API.

From the Services, Configurations, and Devices category, assign the following permissions to a user to run this API.

  • Subscribed Services (View)

  • Import Service and Offer Definitions (Manage)

For more information on these API, refer to the Swagger documentation that can be accessed from MSX portal > Account Settings > Swagger > MSX Platform Catalog Services API.

The service providers can assign the service offers to a specific or all tenants from the Cisco MSX portal.

Using this procedure, you can assign a service pack offer to the tenant.

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.

Step 2

From the left pane, click Offer Management.

The Offer Management window is displayed.

Step 3

Select a service pack offer.

The service pack offer details window is displayed with Variant Details and Tenant Assignments.

The Variant Details section allows you to view the details of the service pack offers.

The Tenant Assignments section allows you to restrict the service pack offers to the specific tenants.

Step 4

Edit the service pack offer or variants in the Variant Details section.

  1. To edit the title, description, and image of a service offer, click the Edit icon that is located on the top right of the window.

  2. To edit the title, description, and pricing details of the variants, click the Edit icon that is located on the top right of the window.

  3. Click Save to update the latest changes of the service offers or variants.

Step 5

Assign service pack offer to tenant.

Note 

The service offers are available to all tenants. To restrict, assign the offer only to the specific tenants.

  1. Click the Assign icon that is located on the top right of the window and then do one of the following:

    Note 

    The tenants, who are already assigned with a service offer cannot be assigned with this same service offer again. Assigned tenants are displayed in the Tenant Assignments section. Add only new tenants to this offer.

    • Click the Specific Tenants radio button and select the tenants.

    • Click the All Tenants radio button to select all the tenants.

  2. Click >.

    The Confirm Assignment dialog box is displayed. Confirm the assignation of the offer to the specific tenants or all the tenants.

  3. Click >.

    The Tenants Assignment dialog box is displayed with the information that tenants are added.

    Note 

    If the tenant assignment fails, the failure message and number of tenants failed to be assigned are displayed.

  4. Click Close to exit.

  5. (Optional) Click View Tenants to see the list of tenants to whom the offer is assigned on the Tenant Assignments section.

What to do next

Tenants can view the assigned service pack offers by clicking Tenant Workspace > Offer Catalog. The list of all the assigned service offers are displayed on the Offer Catalog window for the tenants to subscribe to the available service offers. To get more information, see Subscribing the Service Pack Offer from Tenant Workspace.

Subscribing the Service Pack Offer from Tenant Workspace

Using this procedure, tenants can subscribe to the service offers.

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.

Step 2

From the left pane, choose Tenant Workspace > Offer Catalog.

The Offer Catalog window is displayed with all the available service offers assigned by the service provider for the tenants.

Step 3

Select a service pack offer.
Step 4

Click Subscribe.

The Confirm Subscription dialog box is displayed to confirm the subscription.

Step 5

Click Subscribe.

The confirmation dialog box is displayed.
Step 6

To continue the subcription, click Continue.

This will take the tenant to the Tenant Workspace, where they can now view their offer.

If you want to exit this process, click Close.

Unassigning Service Pack From Tenant

Using this procedure, you can unassign service pack offer from tenant.

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.

Step 2

From the left pane, click Offer Management.

The Offer Management window is displayed with all the available service pack offers.

Step 3

Select a service pack offer.

The Offer Details window is displayed. The Variant Details section lists the available variants and the Tenants Assignments section that lists the tenant to whom the service pack offer was assigned.

Step 4

Select the tenant to unassign the service pack offer.
Step 5

Click the x icon in the Unassign column of the Tenants Assignment section.

Note 

If a tenant had already assigned to this service pack offer, the Unassign icon appears to be disabled.

The Unassign Tenant dialog box is displayed.

Step 6

Click Unassign.

The Tenant Unassigned dialog box is displayed.

Step 7

Click Close to exit.

Step 8

(Optional) Click View Tenants to view the tenants list in the Tenants Assignment section.

Managing the Region Using API

The Cisco MSX platform provides Administration Microservice API to create, update, delete, and get configurations of the region. This API manages the PnP and VPN configurations of the region.

You can manage the configurations of the Administration Microservice API as follows:

  • To manage the region configuration, use the Region Controller section of the Administration Microservice API.

  • To manage the PnP configuration, use the PnP Controller section of the Administration Microservice API.

  • To manage the VPN configuration, use the VPN Controller section of the Administration Microservice API.

From the Integrations, Settings, and Logs category, assign these permissions to a user to run this API.

  • Region (View and Manage)

  • PnP (View and Manage)

  • VPN (View and Manage)

For more information on these API, refer to the Swagger documentation that can be accessed from MSX portal > Account Settings > Swagger > Administration Microservice API.

Integrating Incident Tracking System with Cisco MSX

The Cisco MSX platform provides Incident Microservice API that enable you to integrate the MSX platform with an incident tracking system. Using this API, you can create, update, cancel, close, and delete an incident using the access token.

You can manage the configurations of the Incident Microservice API as follows:

  • To provide the authentication settings that helps to establish handshake with an incident tracking system, use the Configuration Controller section of the Incident Microservice API.

  • To manage the incident, use the Incident Controller section of the Incident Microservice API.

From the Integrations, Settings, and Logs category, assign the Incidents (View and Manage) permission to a user to run this API.

For more information on these API, refer to the Swagger documentation that can be accessed from MSX portal > Account Settings > Swagger > Incident Microservice API.

Managing the Billing

The Cisco MSX platform now provides the ability to identify, track, and report the various subscription billing activities that happen across the MSX system using Billing Microservices API. Using Billing Microservices API, inventory reports can also be generated. You can manage the billing for several items such as devices, sites, control plane, and services.

You can manage the configurations of the events and prices using Billing Microservices API:

  • To manage the event configuration, use Event Controller section of the Billing Microservices API.

  • To manage the price definition, use Price Controller section of the Billing Microservices API.

From the Billing/Metering category, assign the following permissions to a user to run this API.

  • Event (View)

  • Price (View and Manage)

For more information on these API, refer to the Swagger documentation that can be accessed from MSX portal > Account Settings > Swagger > Billing Microservices API

Using this procedure, you can manage the various billing activities across Cisco MSX system.

Procedure

Step 1

Log in to the Cisco MSX portal using your credentials.
Step 2

From the left pane, choose Tenant Workspace > Billing.

The Billing window is displayed.

Note 

Cisco MSX 3.10 Release uses new GUI that includes a MSX Dashboard and Tenant Workspace. The Tenant Workspace is visible only if users have subscribed to the Cisco MSX Enterprise Access (EA) service pack.

Step 3

Select a tenant.

Note 

Assign a service pack offer, if the tenant had not subscribed to any of the offers. For more information, see Subscribing the Service Pack Offer from Tenant Workspace.

Step 4

View the billing summary of the assigned service pack offers.

  1. Select a service pack offer to get the expanded view of the offer price and other billing events (such as create site and add device) summary for each month.

    The total billing amount of all the subscribed service offers for each month are displayed on the right pane.

    Figure 1. Billing Window

Was this Document Helpful?

FeedbackFeedback

Contact Cisco

Related Cisco Community Discussions

About Us
Contact Us
Work with Us