Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

OAM CFM Profiles Management RESTful Web Services

 

The following operations can be performed using the Connectivity Services Director Operations, Administration, and Maintenance (OAM) Connectivity Fault Management (CFM) Profiles Management RESTful Web Services.

Get a CFM Action Profile By Service Definition ID

This request is used to retrieve the details of a particular CFM action profile, based on the service definition ID.

URI

/api/space/nsas/cfm-actionprofiles/service-management/

service-definitions/<serdef-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

service-definition+xml

Produces

Collects the details of a specific CFM action profile.

Output

Sample XML Output

Get All CFM Action Profiles

This request is used to retrieve all the configured CFM action profiles.

URI

/api/space/nsas/cfm-actionprofiles/service-management/

service-definitions/

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

service-definitions+xml

Produces

Collects all the configured CFM action profiles.

Output

Sample XML Output

Get a CFM Service Order By Service Order ID

This request is used to retrieve the details of a particular CFM service order, based on the service order ID.

URI

/api/space/nsas/cfm-actionprofiles/service-management/

service-orders/<service-order-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

service-order+xml

Produces

Collects the details of a specific CFM service order.

Output

Sample XML Output

Get All CFM Service Orders

This request is used to retrieve all the configured CFM service orders.

URI

/api/space/nsas/cfm-actionprofiles/service-management/

service-orders/

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

service-orders+xml

Produces

Collects all the configured CFM service orders.

Output

Sample XML Output

Create an SLA Profile

This request is used to create an SLA profile.

URI

/api/space/nsas/sla-iteratorprofiles/service-management/

service-definitions/

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

service-definition+xml

Consumes

application/vnd.net.juniper.space.service-management.

service-definition-status+xml

Produces

Creates an SLA profile.

Output

Sample XML Output

Get an SLA Iterator Profile By Service Definition ID

This request is used to retrieve the details of a particular SLA iterator profile, based on the service definition ID.

URI

/api/space/nsas//sla-iteratorprofiles/service-management/

service-definitions/<serdef-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

service-definition+xml

Produces

Collects the details of a specific SLA iterator profile.

Output

Sample XML Output

Get All SLA Iterator Profiles

This request is used to retrieve all the configured SLA iterator profiles.

URI

/api/space/nsas//sla-iteratorprofiles/service-management/

service-definitions/

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

service-definitions+xml

Produces

Collects all the configured SLA iterator profiles.

Output

Sample XML Output

Get a CFM Service By Service ID

This request is used to retrieve the details of a particular CFM service, based on the service ID.

URI

/api/space/nsas/cfm-actionprofiles/service-management/

services/<service-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.service+xml

Produces

Collects the details of a specific CFM service.

Output

Sample XML Output

Get All CFM Services

This request is used to retrieve all the configured CFM services.

URI

/api/space/nsas/cfm-actionprofiles/service-management/

services/

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.services+xml

Produces

Collects all the configured CFM services.

Output

Sample XML Output

Adds Local Devices to a CFM Profile

This request is used to add local devices to a CFM profile.

URI

api/space/nsas/cfm-profiles/service-management/

services/<serviceId>/add-devices

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

modify-service+xml

Consumes

application/vnd.net.juniper.space.service-management.

modify-service+xml

Produces

Adds local devices to CFM profiles.

Input

Sample XML Input

Output

Sample XML Output

Adds Remote Devices to a CFM Profile

This request is used to add remote devices to a CFM profile.

URI

api/space/nsas/cfm-profiles/service-management/

services/<serviceId>/add-devices

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

modify-service+xml

Consumes

application/vnd.net.juniper.space.service-management.

modify-service+xml

Produces

Adds remote devices to CFM profiles.

Input

Sample XML Input

Output

Sample XML Output

Deletes Local Devices from a CFM Profile

This request is used to delete local devices from a CFM profile.

URI

api/space/nsas/cfm-profiles/service-management/

services/<serviceId>/delete-devices

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

modify-service+xml

Consumes

application/vnd.net.juniper.space.service-management.

modify-service+xml

Produces

Deletes local devices from CFM profiles.

Input

Sample XML Input

Output

Sample XML Output

Deletes Remote Devices from a CFM Profile

This request is used to delete remote devices from a CFM profile.

URI

api/space/nsas/cfm-profiles/service-management/

services/<serviceId>/delete-devices

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

modify-service+xml

Consumes

application/vnd.net.juniper.space.service-management.

modify-service+xml

Produces

Deletes remote devices from CFM profiles.

Input

Sample XML Input

Output

Sample XML Output

Decommission a CFM Service

This request is used to decommission a previously created CFM service.

URI

api/space/cfm-profiles/service-management/

services/{serviceId}

HTTP Method

DELETE

Content-Type

application/vnd.net.juniper.space.service-management.

service+xml

Produces

Decommissions a previously created CFM service.

Input

Sample XML Input

Output

Sample XML Output

Run a Functional Audit of a CFM Service

This request is run a functional audit of a CFM service.

URI

api/space/cfm-profiles/service-management/

services/<service-id>

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.service+xml

The options for AuditNow and AuditLater can be provided in the Action element within the ?OperationSpecificData?.

Consumes

application/vnd.net.juniper.space.service-management.

service-status+xml

Produces

Performs a functional audit of a CFM service.

Input

Sample XML Input

Output

Sample XML Output

Run a Configuration Audit of a CFM Service

This request is run a configuration audit of a CFM service.

URI

api/space/cfm-profiles/service-management/

services/<service-id>

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.service+xml

The options for AuditNow and AuditLater can be provided in the Action element within the ?OperationSpecificData?.

Consumes

application/vnd.net.juniper.space.service-

management.service-status+xml

Produces

Performs a configuration audit of a CFM service.

Input

Sample XML Input

Output

Sample XML Output

View the Configuration Audit Results of a CFM Service (Version 1)

This request is display the configuration audit results of a CFM service in version 1 format.

URI

api/space/cfm-profiles/service-management

/services/view-configuration-audit/<service-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

config-audit+xml

Produces

Displays the configuration audit results of a CFM service.

Output

Sample XML Output

View the Configuration Audit Results of a CFM Service (Version 2)

This request is display the configuration audit results of a CFM service in version 2 format.

URI

api/space/cfm-profiles/service-management

/services/view-configuration-audit/<service-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

config-audit+xml

Produces

Displays the configuration audit results of a CFM service.

Output

Sample XML Output

View the Functional Audit Results of a CFM Service

This request is display the functional audit results of a CFM service.

URI

api/space/cfm-profiles/service-management/

services/view-functional-audit/<service-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-

management.functional-audit+xml

Produces

Displays the functional audit results of a CFM service.

Output

Sample XML Output

View the Service Configuration Change Results of a CFM Service

This request is display the service configuration changes of a CFM service.

URI

api/space/cfm-profiles/service-management/

services/view-serviceconfiguration-change/<service-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-

management.config-change+xml

Produces

Displays the service configuration change results of a CFM service.

Output

Sample XML Output

View the Monitoring and Troubleshooting Results of a CFM Service

This request is display the results of troubleshooting and monitoring operations of a CFM service.

URI

api/space/cfm-profiles/service-management/

services/view-troubleshoot-results/<service-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-

management.troubleshoot-results+xml

Produces

Displays the troubleshooting results of a CFM service.

Output

Sample XML Output

Get a CFM Profile By Service Definition ID

This request is used to retrieve the details of a particular CFM profile, based on the service definition ID.

URI

/api/space/nsas/cfm-profiles/service-management/

service-definitions/<serdef-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-

management.service-definition+xml

Produces

Collects the details of a specific CFM profile.

Output

Sample XML Output

Get All CFM Profiles

This request is used to retrieve all the configured CFM profiles.

URI

/api/space/nsas/cfm-profiles/service-management/

service-definitions/

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

service-definitions+xml

Produces

Collects all the configured CFM profiles.

Output

Sample XML Output

Delete an OAM Service Order

This request is used to delete an OAM service order.

URI

api/space/nsas/cfm-profiles/service-management/

service-orders/<id>

HTTP Method

DELETE

Consumes

application/vnd.net.juniper.space.service-

management.service-order+xml

Produces

Deletes an OAM service order.

Output

Sample XML Output

Create a CFM Profile

This request is used to create a CFM profile.

URI

/api/space/nsas/cfm-profiles/service-management/

service-definitions/

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

service-definition+xml

Produces

Creates a CFM profile.

Output

Sample XML Output

Create a CFM Service Order

This request is used to create a CFM service order.

URI

/api/space/nsas/cfm-profiles/service-management/

service-orders/

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

service-order+xml

Produces

Creates a CFM service order.

Output

Sample XML Output

Publish and Unpublish a CFM Profile

This request is used to publish or unpublish a CFM profile.

URI

api/space/nsas/cfm-profiles/service-management

/service-definitions/

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.service-management.

service-definition+xml

Consumes

application/vnd.net.juniper.space.service-

management.service-definition-status+xml

Action types are Publish and Unpublish.

Produces

Publishes or unpublishes a CFM profile.

Input

Sample XML Input

Create and Publish a CFM Profile

This request is used to create and publish a CFM profile.

URI

/api/space/nsas/cfm-profiles/service-management/

service-definitions/

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

service-definition+xml

Consumes

application/vnd.net.juniper.space.service-management.

service-definition-status+xml

Produces

Creates and publishes a CFM profile.

Input

Sample XML Input

Delete a CFM Profile

This request is used to delete a previously configured CFM profile.

URI

api/space/nsas/cfm-profiles/service-management/

service-definitions/<servicedefinition-id>

HTTP Method

DELETE

Consumes

application/vnd.net.juniper.space.service-

management.service-definition+xml

Produces

Deletes a CFM profile.

Input

Sample XML Input

Deploy, Validate, and Partially-Delete a CFM Service Order

This request is used to deploy, validate, or partially delete a previously created CFM service order.

URI

api/space/nsas/cfm-profiles/service-management/

service-orders/

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.service-management.service-order+xml

Consumes

application/vnd.net.juniper.space.service-management.

service-order-status+xml

The options must be specified in the Action Element inside OperationSpecificData. The various options are as follows:

  • DeployNow (Deploy an already created SO)

  • DeployLater (Deploy Later an already created SO)

  • ValidateNow (Validate now an already created SO)

  • ValidateLater (Validate later an already created SO)

  • PartialDeleteNow (Delete the partially created configuration now)

  • PartialDeleteLater (Delete the partially created configuration Later

Produces

Deploys, validates or, partially-deletes a previously created CFM service order.

Output

Sample XML Output

Get an LFM Profile By Service Definition ID

This request is used to retrieve the details of a particular LFM profile, based on the service definition ID.

URI

/api/space/nsas/lfm-profiles/service-management/

service-definitions/<serdef-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

service-definition+xml

Produces

Collects the details of a specific LFM profile.

Output

Sample XML Output

Get All LFM Profiles

This request is used to retrieve all the configured LFM profiles.

URI

/api/space/nsas/lfm-profiles/service-management/

service-definitions/

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

service-definitions+xml

Produces

Collects all the configured LFM profiles.

Output

Sample XML Output

Create an LFM Profile

This request is used to create an LFM profile.

URI

/api/space/nsas/lfm-profiles/service-management/

service-definitions/

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

service-definition+xml

Produces

Creates an LFM profile.

Input

Sample XML Input

Output

Sample XML Output

Publish and Unpublish an LFM Profile

This request is used to publish or unpublish an LFM profile.

URI

api/space/nsas/lfm-profiles/service-management/

service-definitions/

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.service-management.

service-definition+xml

Consumes

application/vnd.net.juniper.space.service-management.

service-definition-status+xml

Action types are Publish and Unpublish.

Produces

Publishes or unpublishes an LFM profile.

Input

Sample XML Input

Output

Sample XML Output

Delete an LFM Profile

This request is used to delete a previously configured LFM profile.

URI

api/space/nsas/lfm-profiles/service-management/

service-definitions/<servicedefinition-id>

HTTP Method

DELETE

Consumes

application/vnd.net.juniper.space.service-management.

service-definition+xml

Produces

Deletes an LFM profile.

Output

Sample XML Output

Get an LFM Action Profile By Service Definition ID

This request is used to retrieve the details of a particular LFM action profile, based on the service definition ID.

URI

/api/space/nsas/lfm-actionprofiles/service-management/

service-definitions/<serdef-id>

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

service-definition+xml

Produces

Collects the details of a specific LFM action profile.

Output

Sample XML Output

Get All LFM Action Profiles

This request is used to retrieve all the configured LFM action profiles.

URI

/api/space/nsas/lfm-actionprofiles/service-management/

service-definitions/

HTTP Method

GET

Consumes

application/vnd.net.juniper.space.service-management.

service-definitions+xml

Produces

Collects all the configured LFM action profiles.

Output

Sample XML Output

Create an LFM Action Profile

This request is used to create an LFM action profile.

URI

/api/space/nsas/lfm-actionprofiles/service-management/

service-definitions/

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

service-definition+xml

Produces

Creates an LFM action profile.

Input

Sample XML Input

Output

Sample XML Output

Publish and Unpublish an LFM Action Profile

This request is used to publish or unpublish an LFM action profile.

URI

api/space/nsas/lfm-actionprofiles/service-management/

service-definitions/

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.service-management.

service-definition+xml

Consumes

application/vnd.net.juniper.space.service-management.

service-definition-status+xml

Action types are Publish and Unpublish.

Produces

Publishes or unpublishes an LFM action profile.

Input

Sample XML Input

Output

Sample XML Output

Delete an LFM Action Profile

This request is used to delete a previously configured LFM action profile.

URI

api/space/nsas/lfm-actionprofiles/service-management/

service-definitions/<servicedefinition-id>

HTTP Method

DELETE

Consumes

application/vnd.net.juniper.space.service-management.

service-definition+xml

Produces

Deletes an LFM action profile.

Output

Sample XML Output

Create a CFM Action Profile

This request is used to create a CFM action profile.

URI

/api/space/nsas/cfm-actionprofiles/service-management/

service-definitions/

HTTP Method

POST

Content Type

application/vnd.net.juniper.space.service-management.

service-definition+xml

Produces

Creates a CFM action profile.

Input (Default Action)

Sample XML Input

Input (Config Event)

Sample XML Input

Output

Sample XML Output

Publish and Unpublish a CFM Action Profile

This request is used to publish or unpublish a CFM action profile.

URI

api/space/nsas/cfm-actionprofiles/

service-management/service-definitions/

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.service-management.

service-definition+xml

Consumes

application/vnd.net.juniper.space.service-management.

service-definition-status+xml

Action types are Publish and Unpublish.

Produces

Publishes or unpublishes a CFM action profile.

Input

Sample XML Input

Output

Sample XML Output

Delete a CFM Action Profile

This request is used to delete a previously configured CFM action profile.

URI

api/space/nsas/cfm-actionprofiles/service-management/

service-definitions/<servicedefinition-id>

HTTP Method

DELETE

Consumes

application/vnd.net.juniper.space.service-management.

service-definition+xml

Produces

Deletes a CFM action profile.

Output

Sample XML Output

Attach a CFM Action Profile

This request is used to attach a CFM action profile.

URI

/api/space/nsas/prestage-oam-device/

manage-devices/attach-profile

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.manage-devices.

oam-deviceprofile+xml

Consumes

application/vnd.net.juniper.space.manage-devices.

oam-devices+xml

Produces

Attaches a CFM action profile.

Input

Sample XML Input

Output

Sample XML Output

Attach an LFM Action Profile

This request is used to attach an LFM action profile.

URI

/api/space/nsas/prestage-oam-device/

manage-devices/attach-profile

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.manage-devices.

oam-deviceprofile+xml

Consumes

application/vnd.net.juniper.space.manage-devices.

oam-devices+xml

Produces

Attaches an LFM action profile.

Input

Sample XML Input

Output

Sample XML Output

Attach an SLA Iterator Profile

This request is used to attach an SLA iterator profile.

URI

/api/space/nsas/prestage-oam-device/

manage-devices/attach-profile

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.manage-devices.

oam-deviceprofile+xml

Consumes

application/vnd.net.juniper.space.manage-devices.

oam-devices+xml

Produces

Attaches an SLA iterator profile.

Input

Sample XML Input

Output

Sample XML Output

Detach a CFM Action Profile

This request is used to detach a CFM action profile.

URI

/api/space/nsas/prestage-oam-device/

manage-devices/attach-profile

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.manage-devices.

oam-deviceprofile+xml

Consumes

application/vnd.net.juniper.space.manage-devices.

oam-devices+xml

Produces

Detaches a CFM action profile.

Input

Sample XML Input

Output

Sample XML Output

Detach an LFM Action Profile

This request is used to detach an LFM action profile.

URI

/api/space/nsas/prestage-oam-device/

manage-devices/attach-profile

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.manage-devices.

oam-deviceprofile+xml

Consumes

application/vnd.net.juniper.space.manage-devices.

oam-devices+xml

Produces

Detaches an LFM action profile.

Input

Sample XML Input

Output

Sample XML Output

Detach an SLA Iterator Profile

This request is used to detach an SLA iterator profile.

URI

/api/space/nsas/prestage-oam-device/manage-

devices/attach-profile

HTTP Method

POST

Content-Type

application/vnd.net.juniper.space.manage-devices.

oam-deviceprofile+xml

Consumes

application/vnd.net.juniper.space.manage-devices.

oam-devices+xml

Produces

Detaches an SLA iterator profile.

Input

Sample XML Input

Output

Sample XML Output