Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

SyncE Services Management RESTful Web Services

 

The following operations can be performed using the Connectivity Services Director Synchronous Ethernet (SyncE) Services Management RESTful Web Services.

Get a SyncE Service By Service ID

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

URI

/api/space/nsas/sync-e/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 SyncE service.

Output

Sample XML Output

Get All SyncE Services

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

URI

/api/space/nsas/sync-e/service-management/services/

HTTP Method

GET

Consumes

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

Produces

Collects all the configured SyncE services.

Output

Sample XML Output

Modify a SyncE Service

This request is used to modify a SyncE service for addition of parameters.

URI

/api/space/nsas/sync-e/service-management/

services/<service-id>

HTTP Method

POST

Content Type

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

modify-service+xml

Consumes

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

service-status+xml

Produces

Modifies a SyncE service for addition of parameters.

Input

Sample XML Intput

Add Devices to a SyncE Service

This request is used to add local devices to a SyncE service.

URI

api/space/nsas/sync-e/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 SyncE services.

Input

Sample XML Input

Delete Devices from a SyncE Service

This request is used to delete local devices from a SyncE service.

URI

api/space/nsas/sync-e/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 SyncE services.

Input

Sample XML Input

Decommission a SyncE Service

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

URI

api/space/sync-e/service-management/

services/{serviceId}

HTTP Method

DELETE

Content-Type

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

Produces

Decommissions a previously created SyncE service.

Input

Sample XML Input

Run a Functional Audit of a SyncE Service

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

URI

api/space/sync-e/service-management/

/<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 SyncE service.

Input

Sample XML Input

Output

Sample XML Output

Run a Configuration Audit of a SyncE Service

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

URI

api/space/sync-e/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 SyncE service.

Input

Sample XML Input

Output

Sample XML Output

View the Functional Audit Results of a SyncE Service

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

URI

api/space/sync-e/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 SyncE service.

Output

Sample XML Output

View the Configuration Audit Results of a SyncE Service

This request is display the configuration audit results of a SyncE service.

URI

api/space/sync-e/service-management/services/view-

configuration-audit/<service-id>

HTTP Method

GET

Consumes

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

configuration-audit+xml

Produces

Displays the configuration audit results of a SyncE service.

Output

Sample XML Output

View the Service Configuration Change Results of a SyncE Service

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

URI

api/space/sync-e/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 SyncE service.

Output

Sample XML Output