Discovery Type

Item

HTTP Requests

HTTP Method

Authentication

Token

/tron/api/v1/tokens

POST

Inventory 

ONE, Shelf, Card, Port, Power Supply, Fan

/tapi/data/tapi-common:context/tapi-equipment:physical-context/device/

GET

/tapi/data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node/

GET

/tapi/data/tapi-common:context/tapi-equipment:physical-context/equipment/

GET

/tapi/data/tapi-common:context/tapi-equipment:physical-context/equipmentholder/

GET

Topology

Links (OTS, OMS)

/tapi/data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/link/

GET

Links (NMC, OCH, OTU, ODU, ETH, RLogical, E Line, PW, LSP, LAG)

/tapi/data/tapi-common:context/tapi-connectivity:connectivity-context/connection/

GET

Ports (OTS, OMS, NMC, OCH, OTU, ODU, ETH, RLogical, RPhysical, MPLS-TP, UNI, VUNI)

/tapi/data/tapi-common:context/tapi-topology:topology-context/topology={uuid}/node-edge-point/

GET

/tapi/data/context/topology-context/topology={uuid}/connection-end-point/

GET

Service

Circuit-E-Line, Packet-E-Line, Wavelength, OTN-Line, SDH-Line

/tapi/data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service/ 

GET

Provisioning Endpoint (SIP)

/tapi/data/tapi-common:context/service-interface-point/

GET

Notifications

Get supported streams

/tapi/data/context/stream-context/supported-stream-type/

GET

Get available streams

/tapi/data/context/stream-context/available-stream/ 

GET

Establish WebSocket (per stream)

/tapi/data/context/stream-context/available-stream={uuid}

WSS

Stats

Get PMs

/pm/api/v2/query/metrics

POST

Provisioning

Service

/tapi/data/context/connectivity-ontext/provisioning/connectivity-service/

POST

/tapi/data/context/connectivity-context/provisioning/connectivity-service/{uuid}

DELETE

/tapi/data/tapi-common:context/tapi-connectivity:connectivity-context/connectivity-service={uuid}/requested-capacity  -- Circuit Eline ODUFlex Modify

PUT

Packet Eline Service Modification

Get Service ID: /bpocore/market/api/v1/resources?resourceTypeId=ifd.v6.resourceTypes.L2ServiceIntentFacade&q=properties.name:{service_name}

GET

Modify Service: /bpocore/market/api/v1/resources/{service-id}/operations

POST

Get modify_operation_id:

/bpocore/market/api/v1/resources/{service-id}/operations/{modify_id}

GET

Get Modification Status:

/bpocore/market/api/v1/resources/{service-id}/operations/{modify_operation_id}

GET

Name

Description

Default

Range

Enabled

Whether to enable/disable the adapter.

False

Logging Level

The logging level at which the discovery cycle will be reported in the adapter’s log.

Info

Critical, Error, Warning, Info, Debug

Adapter Properties

Provisioning Timeout [sec]

The provisioning timeout in seconds.

150

 [90: ]

Polling Cycle [sec]

Poll every X seconds.

3600

[90: ]

Connection Timeout [sec]

The connection timeout.

120

Max run time for a single discovery cycle[sec]

The maximum time for a discovery cycle. To prevent endless cycles which may put the adapter into a deadlock.

600

[30: ]

Minimal interval time between data updates [sec]

The minimum time between data updates. This is the period, for example 30 seconds, during which notifications are stored in the local adapter cache, after which discovery runs on the cache.  If this is set to 0 seconds (default) the discovery runs immediately.

0

[0: ]

Save persistor request to disk?

Whether to save the persistor request to disk.

false

Service Delegation

Allows ownership of existing services for service deletion. When enabled, the adapter discovers controller connectivity-service entries for "brownfield" services (those created outside of Cisco Crosswork Network Controller).

The Service Manager application recognizes these entries created by the adapter and adds them to the Point-to-Point table (in Service Manager). Users can then delete these "brownfield" services using Service Manager (even though they were created outside of Cisco Crosswork Network Controller).

false

Connection Properties

Host (including protocol, port, and URI prefix)

(http|https)://<server>[:<port>]

For example: https://10.1.2.3

Credentials

Credentials are defined in the “Credentials” tab of the Device Manager.

HTTP credentials

MCP API version

The MCP API version.

V5

[V5, V6]

Filter out non Ciena-devices

Whether or not to filter out non-Ciena devices.

false

Statistics Configuration

Enabled

Whether to enable/disable statistics collection.

true

Stats Interval Polling [sec]

Poll for statistics every X seconds.

900

 [300: ]

Concurrent Devices Stats Collection

The number of concurrent devices to collect statistics from.

10

 [1:30]

Notifications Configuration

Enabled

Should the notifications listener be initialized or not?

true

Idle Connection Refresh Time [sec]

Reset notification connection after this idle timeout.

3600

 [300: ]

Idle Connection Check Interval [sec]

Check for idle connection time after specified duration.

60

 [30: ]