nsp release 2.0 r3 api differences guide - nokia … · network services platform . release 2.0 r3...

Network Services Platform Release 2.0 R3

API Differences Guide

Issue 1 November 2016

Nokia — Proprietary and confidential. Use pursuant to applicable agreements.

Network Services Platform

Issue 1 2

Nokia is a registered trademark of Nokia Corporation. Other products and company names mentioned herein may be trademarks or tradenames of their respective owners.

The information presented is subject to change without notice. No responsibility is assumed for inaccuracies contained herein.

© 2016 Nokia.

Contains proprietary/trade secret information which is the property of Nokia and must not be made available to, or copied or used by anyone outside Nokia without its written authorization. Not to be used or disclosed except in accordance with applicable agreements.

REST API Differences Guide

3 Issue 1

Contents 1 Introduction .......................................................................................................................................... 4

2 NSP SDN API v2 ................................................................................................................................ 4

2.1 Excluded entities ........................................................................................................................ 4

2.2 Exclusive entities ...................................................................................................................... 27

3 NSP NSD API v3 .............................................................................................................................. 29

3.1 Added entities ........................................................................................................................... 29

3.2 Removed entities ...................................................................................................................... 32


Issue 1 4

1 Introduction

The NSP APIs evolve with each release. This document describes the differences that have been introduced to the supported versions of the APIs in NSP Release 2.0 R3.

2 NSP SDN API v2

This section outlines the differences between Version 2 and Version 3 of the NSP SDN API in NSP Release 2.0 R3.

2.1 Excluded entities

The following table lists entities/attributes that are only present in Version 3 of the NSP SDN API in NSP Release 2.0 R3.

Affected methods New entities & attributes Generic API GET /api/v3/generic/applicationid/{id} PUT /api/v3/generic/applicationid/{id}/{appId} GET /api/v3/generic/{uuid}

The italicized text is only present in Version 3 of the NSP SDN API: BaseEntity {

adminState (string, optional): The current administrative state of the entity = ['MAINTENANCE', 'DOWN', 'UP'], ... externalIds (Array[ExternalId], optional), ... neDeploymentState (string, optional): The current deployment state of the entity = ['DEPLOYED', 'FAILED', 'PENDING', 'UNKNOWN'], operationalState (string, optional): The current operational state of the entity = ['PARTIALLY_DOWN', 'TRANSITION', 'DOWN', 'UNKNOWN', 'UP']

} ExternalId {

context (string, optional) = ['NODE' or 'OMS' or 'SAM']: The entity type that is managing this external-id, id (string, optional): The local identifier used on the entity., location (array[string], optional): The entity instance that is managing this external-id. This may be an IP address or a DNS name.

} POST /api/v3/generic/find-byexternal-id This method is only present in Version 3 of the NSP SDN API


5 Issue 1

IETF API GET /api/v3/ietf/te/link/{linkId} GET /api/v3/ietf/te/network/{networkId} GET /api/v3/ietf/te/networks GET /api/v3/ietf/te/node/{nodeId} GET /api/v3/ietf/te/termination-point/{tpId}

The API and its methods are only present in Version 3 of the NSP SDN API

Network element API GET /api/v3/ne GET /api/v3/ne/system/{systemId} GET /api/v3/ne/{uuid}

The italicized text is only present in Version 3 of the NSP SDN API: NetworkElement: {

adminState (string, optional): The current administrative state of the entity = ['MAINTENANCE', 'DOWN', 'UP'], … externalIds (Array[ExternalId], optional), … neDeploymentState (string, optional): The current deployment state of the entity = ['DEPLOYED', 'FAILED', 'PENDING', 'UNKNOWN'], operationalState (string, optional): The current operational state of the entity = ['PARTIALLY_DOWN', 'TRANSITION', 'DOWN', 'UNKNOWN', 'UP'], baseMacAddress (string, optional): The base MAC address for the network element , … platform (Platform, optional), …

} ExternalId: {

context (string, optional): The entity type that is managing this external-id = ['OMS', 'NODE', 'SAM'], id (string, optional): The local identifier used on the entity. , location (Array[string], optional): The entity instance that is managing this external-id. This may be an IP address or a DNS name.

} … Platform: {

machine (string, optional): A vendor-specific identifier string representing the hardware in use. , osName (string, optional): Unsupported - The name of the operating system in use - for example, 'Linux'. , osRelease (string, optional): Unsupported - The current release level of the operating system in use. This string MAY indicate the OS source code revision. , osVersion (string, optional): The current version level of the operating system in use. This string MAY indicate the specific OS build date and target variant


Issue 1 6

information. }

PUT /api/v3/ne/{id} This method is only present in Version 3 of the NSP SDN API Openflow API DELETE /api/v3/openflow/flows GET /api/v3/openflow/ports/{datapathId} GET /api/v3/openflow/switches GET /api/v3/openflow/switches/{id} GET /api/v3/openflow/tables/{datapathId} POST /api/v3/openflow/flows POST /api/v3/openflow/flows/search POST /api/v3/openflow/flows/search-by-id

These methods are only present in Version 3 of the NSP SDN API

Physical link API GET /api/v3/physicallinks GET /api/v3/physicallinks/{uuid}

The italicized text is only present in Version 3 of the NSP SDN API: PhysicalLink {

adminState (string, optional): The current administrative state of the entity = ['MAINTENANCE', 'DOWN', 'UP'], … externalIds (array[ExternalId], optional), … neDeploymentState (string, optional): The current deployment state of the entity = ['DEPLOYED', 'FAILED', 'PENDING', 'UNKNOWN'], operationalState (string, optional) : The current operational state of the entity = ['PARTIALLY_DOWN', 'TRANSITION', 'DOWN', 'UNKNOWN', 'UP'], …

} ExternalId {


} …

DELETE /api/v3/physicallinks/{linkId} POST /api/v3/physicallinks/{srcId}/{destId}


Policy API GET /api/v3/policy/tunnelselections PUT /api/v3/policy/tunnelselections/{policyId}

The italicized text is only present in Version 3 of the NSP SDN API: TunnelSelectionTemplate {

… bgpPriority (integer, optional): Specifies the priority for selecting BGP tunnels. A lower value indicates a higher


7 Issue 1

priority, [0..7], … grePriority (integer, optional): Specifies the priority for selecting GRE tunnels. A lower value indicates a higher priority, [0..7], ldpPriority (integer, optional): Specifies the priority for selecting LDP tunnels. A lower value indicates a higher priority, [0..7], looseRsvpPriority (integer, optional): Specifies the priority for selecting loose RSVP tunnels. A lower value indicates a higher priority, [0..7], shouldAvoidOperStateDown (boolean, optional): Specifies whether or not the policy should avoid resource which their operational state is down, steeringParametersExcluded (array[SteeringParameter], optional), steeringParametersIncluded (array[SteeringParameter], optional), strictRsvpPriority (integer, optional): Specifies the priority for selecting strict RSVP tunnels. A lower value indicates a higher priority, [0..7]

} SteeringParameter {

name (UrlSafeString): The name of the steering paramter

} UrlSafeString {

string (string, optional) }

DELETE /api/v3/policy/steering-parameter/{steeringParameterName} DELETE /api/v3/policy/tunnel-selections/{policyId} GET /api/v3/policy/steering-parameters GET /api/v3/policy/tunnel-selections/{policyId} POST /api/v3/policy/steering-parameter POST /api/v3/policy/tunnel-selections


Port API GET /api/v3/ports/ne/{neUuid}/servicetype/{serviceType} GET /api/v3/ports/servicetype/{serviceType} GET /api/v3/ports/tenant/{tenantUuid} GET /api/v3/ports/{portUuid}

The italicized text is only present in Version 3 of the NSP SDN API: Port {

adminState (string, optional): The current administrative state of the entity = ['MAINTENANCE', 'DOWN', 'UP'], … externalIds (Array[ExternalId], optional), …


Issue 1 8

neDeploymentState (string, optional): The current deployment state of the entity = ['DEPLOYED', 'FAILED', 'PENDING', 'UNKNOWN'], operationalState (string, optional): The current operational state of the entity = ['PARTIALLY_DOWN', 'TRANSITION', 'DOWN', 'UNKNOWN', 'UP'], availableEgressBandwidth (integer, optional): Specifies the available egress bandwidth associated with a port , availableIngressBandwidth (integer, optional): Specifies the available ingress bandwidth associated with a port , ethernet (Ethernet, optional), interfaceId (integer, optional): The id of the port/interface , …

} ExternalId: {


} Ethernet: {

encapType (string, optional): The encapsulation type of the ethernet port = ['Null', 'Unknown', 'Dot1Q', 'QinQ'], lldpConfiguration (Array[LldpConfigurationInfo], optional), lldpRemotePeers (Array[LldpRemotePeerInfo], optional)

} LldpConfigurationInfo: {

administrativeStatus (string, optional): The LLDP administrative status for the port = ['DISABLED', 'TX_ONLY', 'TX_AND_RX', 'RX_ONLY'], configurationType (string, optional): Whether this configuration is for Nearest Bridge, Nearest Customer, or Nearest Non TPMR = ['NEAREST_NON_TPMR', 'NEAREST_CUSTOMER', 'NEAREST_BRIDGE']

} LldpRemotePeerInfo: {

capabilitiesEnabled (integer, optional): The capabilities that are enabled on the remote port , capabilitiesSupported (integer, optional): The


9 Issue 1

capabilities the remote port supports , portDescription (string, optional): The description of the remote port , remoteChassisId (string, optional): A string identifying the remote chassis , remoteChassisIdType (string, optional): The remote chassis id type = ['INTERFACE_ALIAS', 'INTERFACE_NAME', 'SUBNET', 'NETWORK_ADDRESS', 'LOCAL', 'PORT_COMPONENT', 'CHASSIS_COMPONENT', 'MAC_ADDRESS'], remoteIndex (integer, optional): The remote peer index , remoteManagementIpAddress (Array[IpAddress], optional), remotePeerType (string, optional): The remote peer type = ['NEAREST_NON_TPMR', 'NEAREST_CUSTOMER', 'NEAREST_BRIDGE'], remotePortId (string, optional): A string identifying the remote port , remotePortIdType (string, optional): The remote port id type = ['INTERFACE_ALIAS', 'INTERFACE_NAME', 'NETWORK_ADDRESS', 'LOCAL', 'PORT_COMPONENT', 'AGENT_CIRCUIT_ID', 'MAC_ADDRESS'], remoteSystemName (string, optional): The name of the remote system

} IpAddress: {

ipv4Address (Ipv4Address, optional), ipv6Address (Ipv6Address, optional)

} Ipv4Address: {

string (string, optional) } Ipv6Address: {


GET /api/v3/ports/ne/{neUuid}/servicetype/{serviceType} GET /api/v3/ports/servicetype/{serviceType}

The italicized text is only present in Version 3 of the NSP SDN API: ServiceType: "enum": [

"ELAN", "ELINE", "L3_VPN", "LAG", "OCH", "ODU", “PHYSICAL_LINK”, "TUNNEL"

],


Issue 1 10

GET /api/v3/ports/ne-all/{neId} This method is only present in Version 3 of the NSP SDN API Security API GET /api/v3/security/authentication POST /api/v3/security/token


Service API DELETE /api/v3/services/{serviceUuid}/endpoint/{endpointUuid} GET /api/v3/services/tunnels GET /api/v3/services/tunnel/{tunnelUuid} PATCH /api/v3/services/elines/{serviceUuid} PATCH /api/v3/services/l3-vpns/{serviceUuid}/endpoint/{endpointUuid} PATCH /api/v3/services/elines/{serviceUuid}/endpoint/{endpointUuid} PATCH /api/v3/services/elans/{serviceUuid} PATCH /api/v3/services/elans/{serviceUuid}/endpoint/{endpointUuid} PATCH /api/v3/services/l3-vpns/{serviceUuid} PATCH /api/v3/services/l3-vpns/{serviceUuid}/loopback-endpoint/{endpointUuid} POST /api/v3/services/l3-vpns/{serviceUuid}/endpoint POST /api/v3/services/l3-vpns/{serviceUuid}/loopback-endpoint POST /api/v3/services/elans/{serviceUuid}/endpoint PUT /api/v3/services/elans/{serviceUuid}/endpoint/{endpointUuid} PUT /api/v3/services/tunnel/{tunnelUuid} PUT /api/v3/services/l3-vpns/{serviceUuid}/endpoint/{endpointUuid} PUT /api/v3/services/l3-vpns/{serviceUuid}/loopback-endpoint/{endpointUuid} PUT /api/v3/services/elines/{serviceUuid}/endpoint/{endpointUuid} PUT /api/v3/services/optical/{serviceUuid}



11 Issue 1

GET /api/v3/services GET /api/v3/services/tenant/{uuid} GET /api/v3/services/{serviceUuid}/endpoints GET /api/v3/services/{uuid} POST /api/v3/services/elans POST /api/v3/services/elines POST /api/v3/services/l3-vpns POST /api/v3/services/lags POST /api/v3/services/optical PUT /api/v3/services/elans/{serviceUuid} PUT /api/v3/services/elines/{serviceUuid} PUT /api/v3/services/l3-vpns/{serviceUuid}

The italicized text is only present in Version 3 of the NSP SDN API: BaseService: {

adminState (string, optional): The current administrative state of the entity = ['MAINTENANCE', 'DOWN', 'UP'], ... externalIds (Array[ExternalId], optional), ... neDeploymentState (string, optional): The current deployment state of the entity = ['DEPLOYED', 'FAILED', 'PENDING', 'UNKNOWN'], operationalState (string, optional): The current operational state of the entity = ['PARTIALLY_DOWN', 'TRANSITION', 'DOWN', 'UNKNOWN', 'UP'], ... bw (integer, optional): Specifies the bandwidth required for the service. Unsupported for IP Services , ... groupId (string, optional): Specifies the identifier of the group to which this service should belong , lifeCycle (LifeCycle, optional), ... pathProfileId (string, optional): Specifies the identifier of the path profile to apply to the service , reverseBW (integer, optional): Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services , ... tunnelSelectionId (string, optional): Specifies the identifier of the tunnel selection profile to apply to the service

} ExternalId: {


} BaseServiceEndpoint: {

adminState (string, optional): The current administrative state of the entity = ['MAINTENANCE', 'DOWN', 'UP'], ... externalIds (Array[ExternalId], optional), ...


Issue 1 12

neDeploymentState (string, optional): The current deployment state of the entity = ['DEPLOYED', 'FAILED', 'PENDING', 'UNKNOWN'], operationalState (string, optional): The current operational state of the entity = ['PARTIALLY_DOWN', 'TRANSITION', 'DOWN', 'UNKNOWN', 'UP'], ...

} LifeCycle: {

phase (string, optional): The phase of the life cycle object = ['Deployment', 'Activation', 'Planning'], reason (string, optional): The reason for the current phase/state of the life cycle object , state (string, optional): The state of the life cycle object = ['Delete', 'DeploymentFailed', 'PartiallyDeployed', 'WaitingForDeployment', 'Deploying', 'RoutedAndSaved', 'Undeployed', 'RoutingFailed', 'Routing', 'Undeploy', 'Deployed', 'Planned']

} ...

POST /api/v3/services/elans PUT /api/v3/services/elans/{serviceUuid}

The italicized text is only present in Version 3 of the NSP SDN API: IpElanServiceRequest: {

adminState (string, optional): The current administrative state of the entity = ['MAINTENANCE', 'DOWN', 'UP'], ... customAttributes (Array[CustomAttribute], optional), customAttributesTemplateId (string, optional): Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template. , ... tenantId (string): Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API , ... groupId (string, optional): Specifies the identifier of the group to which this service should belong , ... pathProfileId (string, optional): Specifies the identifier of the path profile to apply to the service , ... tunnelSelectionId (string, optional): Specifies the identifier of the tunnel selection profile to apply to the service , mtu (integer, optional): The MTU for the service. For


13 Issue 1

L3 VPN services, the valid values are 0 or between 512 and 9000, and this is applied to all endpoints. For E-Line/E-LAN services, the valid values are between 0 and 9194. A value of 0 means to use the default MTU of the equipment (the default usually corresponds to the value of the underlying transport medium). Note that for a composite service this may result in the segments having incompatible MTU values. , ...

} CustomAttribute {

attributeName (string, optional): custom attribute name , attributeValue (string, optional): custom attribute value

} ... L2EndpointRequest: {

adminState (string, optional): The current administrative state of the entity = ['MAINTENANCE', 'DOWN', 'UP'], appId (string, optional): The client-defined, custom Application ID for the entity , customAttributes (Array[CustomAttribute], optional), customAttributesTemplateId (string, optional): Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template. , readOnly (boolean, optional): Specifies whether or not this request is read-only , tenantId (string): Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API , id (string, optional): The UUID of the port , name (string, optional): The name of the endpoint , innerTag (integer, optional): The inner tag. Applicable to Dot1Q or QinQ ports. , isHub (boolean, optional): Specifies whether or not the service endpoint is a hub for a hub-and-spoke topology. This influences the automatic route-target and route-distinguisher generation for L3 VPRN service. , outerTag (integer, optional): The outer tag. Applicable to Dot1Q or QinQ ports. , siteServiceQosProfile (SiteServiceQosProfile, optional)

} ...


Issue 1 14

SiteServiceQosProfile: { egressOverrideQueues (Array[Queue], optional), egressParam (EgressParam, optional), ingressOverrideQueues (Array[Queue], optional), ingressParam (IngressParam, optional), qosProfile (integer, optional): The ID reference to the Generic QoS Profile

} ... Queue {

cbs (integer, optional): The Committed Burst Size in KB. , cir (integer, optional): The Committed Information Rate in either Kbps or percentage (0..100). Default value, no override: set to -2; Max rate available: set to -1 , id (integer, optional): ID of the queue , mbs (integer, optional): The Maximum Burst Size in KB. , pir (integer, optional): The Peak Information Rate in either Kbps or percentage (1..100). Default value, no override: set to -2; Max rate available: set to -1 , queueType (string, optional): The type of the queue override. Default is Queue. = ['Policer', 'Queue'], rateType (string, optional): The type of the PIR/CIR rate. Default is Kbps. When set to percent, the value of the queue rate will be a percentage of the port rate = ['kbps', 'percent']

} EgressParam: {

tier1Scheduler (Tier1Scheduler, optional) } IngressParam: {

tier1Scheduler (Tier1Scheduler, optional) } Tier1Scheduler: {

scheduler (Scheduler, optional) } Scheduler {

cir (integer, optional): Scheduler CIR override in either Kbps or percentage (0..100), where -3 is sum of CIR, -2 is no override, -1 is maximum , pir (integer, optional): Scheduler PIR override in either Kbps or percentage (1..100), where -2 is no override, -1 is maximum , rateType (string, optional): The type of the PIR/CIR rate. Default is Kbps. When set to percent, the value of the scheduler rate will be a percentage of the port rate


15 Issue 1

= ['kbps', 'percent'], schedulerType (string, optional): The type of the scheduler override. Default is Scheduler. = ['Scheduler', 'Arbiter']

} POST /api/v3/services/elines PUT /api/v3/services/elines/{serviceUuid}

The italicized text is only present in Version 3 of the NSP SDN API: ElineRequestData: {

adminState (string, optional): The current administrative state of the entity = ['MAINTENANCE', 'DOWN', 'UP'], ... customAttributes (Array[CustomAttribute], optional), customAttributesTemplateId (string, optional): Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template. , ... tenantId (string): Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API , ... groupId (string, optional): Specifies the identifier of the group to which this service should belong , ... pathProfileId (string, optional): Specifies the identifier of the path profile to apply to the service , ... tunnelSelectionId (string, optional): Specifies the identifier of the tunnel selection profile to apply to the service , mtu (integer, optional): The MTU for the service. For L3 VPN services, the valid values are 0 or between 512 and 9000, and this is applied to all endpoints. For E-Line/E-LAN services, the valid values are between 0 and 9194. A value of 0 means to use the default MTU of the equipment (the default usually corresponds to the value of the underlying transport medium). Note that for a composite service this may result in the segments having incompatible MTU values. , ...

} CustomAttribute {


}


Issue 1 16

L2EndpointRequest: { adminState (string, optional): The current administrative state of the entity = ['MAINTENANCE', 'DOWN', 'UP'], appId (string, optional): The client-defined, custom Application ID for the entity , customAttributes (Array[CustomAttribute], optional), customAttributesTemplateId (string, optional): Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template. , readOnly (boolean, optional): Specifies whether or not this request is read-only , tenantId (string): Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API , id (string, optional): The UUID of the port , name (string, optional): The name of the endpoint , innerTag (integer, optional): The inner tag. Applicable to Dot1Q or QinQ ports. , isHub (boolean, optional): Specifies whether or not the service endpoint is a hub for a hub-and-spoke topology. This influences the automatic route-target and route-distinguisher generation for L3 VPRN service. , outerTag (integer, optional): The outer tag. Applicable to Dot1Q or QinQ ports. , siteServiceQosProfile (SiteServiceQosProfile, optional)

} SiteServiceQosProfile: {

egressOverrideQueues (Array[Queue], optional), egressParam (EgressParam, optional), ingressOverrideQueues (Array[Queue], optional), ingressParam (IngressParam, optional), qosProfile (integer, optional): The ID reference to the Generic QoS Profile

} Queue {

cbs (integer, optional): The Committed Burst Size in KB. , cir (integer, optional): The Committed Information Rate in either Kbps or percentage (0..100). Default value, no override: set to -2; Max rate available: set to -1 , id (integer, optional): ID of the queue , mbs (integer, optional): The Maximum Burst Size in KB. ,


17 Issue 1

pir (integer, optional): The Peak Information Rate in either Kbps or percentage (1..100). Default value, no override: set to -2; Max rate available: set to -1 , queueType (string, optional): The type of the queue override. Default is Queue. = ['Policer', 'Queue'], rateType (string, optional): The type of the PIR/CIR rate. Default is Kbps. When set to percent, the value of the queue rate will be a percentage of the port rate = ['kbps', 'percent']

} EgressParam: {




cir (integer, optional): Scheduler CIR override in either Kbps or percentage (0..100), where -3 is sum of CIR, -2 is no override, -1 is maximum , pir (integer, optional): Scheduler PIR override in either Kbps or percentage (1..100), where -2 is no override, -1 is maximum , rateType (string, optional): The type of the PIR/CIR rate. Default is Kbps. When set to percent, the value of the scheduler rate will be a percentage of the port rate = ['kbps', 'percent'] string Enum: "kbps", "percent" , schedulerType (string, optional): The type of the scheduler override. Default is Scheduler. = ['Scheduler', 'Arbiter']

} POST /api/v3/services/l3-vpns PUT /api/v3/services/l3-vpns/{serviceUuid}

The italicized text is only present in Version 3 of the NSP SDN API: IpL3ServiceRequest: {

adminState (string, optional): The current administrative state of the entity = ['MAINTENANCE', 'DOWN', 'UP'], ... customAttributes (Array[CustomAttribute], optional), customAttributesTemplateId (string, optional): Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template. ,


Issue 1 18

... tenantId (string): Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API , ... groupId (string, optional): Specifies the identifier of the group to which this service should belong , ... pathProfileId (string, optional): Specifies the identifier of the path profile to apply to the service , ... tunnelSelectionId (string, optional): Specifies the identifier of the tunnel selection profile to apply to the service , mtu (integer, optional): The MTU for the service. For L3 VPN services, the valid values are 0 or between 512 and 9000, and this is applied to all endpoints. For E-Line/E-LAN services, the valid values are between 0 and 9194. A value of 0 means to use the default MTU of the equipment (the default usually corresponds to the value of the underlying transport medium). Note that for a composite service this may result in the segments having incompatible MTU values. , ... loopbackEndpoints (Array[LoopbackEndpointRequest], optional)

} CustomAttribute {


} ... L3EndpointRequest {

adminState (string, optional): The current administrative state of the entity = ['MAINTENANCE', 'DOWN', 'UP'], appId (string, optional): The client-defined, custom Application ID for the entity , customAttributes (Array[CustomAttribute], optional), customAttributesTemplateId (string, optional): Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template. , readOnly (boolean, optional): Specifies whether or not this request is read-only ,


19 Issue 1

tenantId (string): Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API , id (string, optional): The UUID of the port , name (string, optional): The name of the endpoint , innerTag (integer, optional): The inner tag. Applicable to Dot1Q or QinQ ports. , isHub (boolean, optional): Specifies whether or not the service endpoint is a hub for a hub-and-spoke topology. This influences the automatic route-target and route-distinguisher generation for L3 VPRN service. , outerTag (integer, optional): The outer tag. Applicable to Dot1Q or QinQ ports. , siteServiceQosProfile (SiteServiceQosProfile, optional), primaryAddress (IpPrefix, optional), rd (string, optional): The route distinguisher for the service endpoint , routeTargets (Array[RouteTarget], optional), routingBgp (RoutingBgp, optional), routingStatic (RoutingStatic, optional), secondaryAddresses (Array[IpPrefix], optional): A list of secondary IP addresses assigned to the service endpoint

} LoopbackEndpointRequest: {

adminState (string, optional): The current administrative state of the entity = ['MAINTENANCE', 'DOWN', 'UP'], appId (string, optional): The client-defined, custom Application ID for the entity , customAttributes (Array[CustomAttribute], optional), customAttributesTemplateId (string, optional): Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template. , readOnly (boolean, optional): Specifies whether or not this request is read-only , tenantId (string): Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API , id (string, optional): The UUID of the port , name (string, optional): The name of the endpoint , primaryAddress (IpPrefix, optional)

} ...


Issue 1 20

SiteServiceQosProfile: egressOverrideQueues (Array[Queue], optional), egressParam (EgressParam, optional), ingressOverrideQueues (Array[Queue], optional), ingressParam (IngressParam, optional), qosProfile (integer, optional): The ID reference to the Generic QoS Profile

} ... RouteTarget {

rt (string, optional): The route target for the service , targetType (string, optional): The type of route target that is defined for the service. Can be either import or export = ['import_export', 'exp', 'imp']

} RoutingBgp: {

routes (Array[EbgpRoute], optional) } RoutingStatic { routes (Array[StaticRoute], optional) } ... Queue {


} EgressParam: {


tier1Scheduler (Tier1Scheduler, optional) }


21 Issue 1

... EbgpRoute {

peerIpAddress (IpAddress), peerAS (integer): Autonomous System number for the remote peer. Mandatory for Post only

} ... Tier1Scheduler: {

scheduler (Scheduler, optional) } ... Scheduler {

cir (integer, optional): Scheduler CIR override in either Kbps or percentage (0..100), where -3 is sum of CIR, -2 is no override, -1 is maximum , pir (integer, optional): Scheduler PIR override in either Kbps or percentage (1..100), where -2 is no override, -1 is maximum , rateType (string, optional): The type of the PIR/CIR rate. Default is Kbps. When set to percent, the value of the scheduler rate will be a percentage of the port rate = ['kbps', 'percent'], schedulerType (string, optional): The type of the scheduler override. Default is Scheduler. = ['Scheduler', 'Arbiter']

} ...

POST /api/v3/services/lags

The italicized text is only present in Version 3 of the NSP SDN API: LagRequest: {

adminState (string, optional): The current administrative state of the entity = ['MAINTENANCE', 'DOWN', 'UP'], ... customAttributes (Array[CustomAttribute], optional), customAttributesTemplateId (string, optional): Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template. , ... tenantId (string): Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API , ... groupId (string, optional): Specifies the identifier of the group to which this service should belong , ...


Issue 1 22

pathProfileId (string, optional): Specifies the identifier of the path profile to apply to the service , ... tunnelSelectionId (string, optional): Specifies the identifier of the tunnel selection profile to apply to the service , ... restoration (string, optional): Specifies the recovery technique of a path after failure. = ['SBR', 'GR', 'None'], reversionMode (string, optional): Specifies how the path switches from the recovery to the the working path previously under failure condition. = ['softauto', 'auto', 'manual'], ...

} CustomAttribute {


} POST /api/v3/services/optical The italicized text is only present in Version 3 of the NSP SDN API:

OpticsRequest: { adminState (string, optional): The current administrative state of the entity = ['MAINTENANCE', 'DOWN', 'UP'], ... customAttributes (Array[CustomAttribute], optional), customAttributesTemplateId (string, optional): Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template. , ... tenantId (string): Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API , ... groupId (string, optional): Specifies the identifier of the group to which this service should belong , ... pathProfileId (string, optional): Specifies the identifier of the path profile to apply to the service , ... tunnelSelectionId (string, optional): Specifies the identifier of the tunnel selection profile to apply to the service , ...


23 Issue 1

restoration (string, optional): Specifies the recovery technique of a path after failure. = ['SBR', 'GR', 'None'], reversionMode (string, optional): Specifies how the path switches from the recovery to the the working path previously under failure condition. = ['softauto', 'auto', 'manual'] string Enum: "softauto", "auto", "manual" , ...

} CustomAttribute {


} Steering API DELETE /api/v3/steering/steer-as/{monitoredRouterId}/{asNumber} DELETE /api/v3/steering/next-hop-bundle/{id} DELETE /api/v3/steering/monitored-router/{id} DELETE /api/v3/steering/as/{asNumber} DELETE /api/v3/steering/monitored-router/{id}/ports GET /api/v3/steering/monitored-router/{id} GET /api/v3/steering/as/{asNumber}/subnets GET /api/v3/steering/monitored-router GET /api/v3/steering/next-hop-bundle/{id} GET /api/v3/steering/monitored-router/port/{monitoredPortId} GET /api/v3/steering/as/{asNumber} GET /api/v3/steering/monitored-router/port/{monitoredPortId}/historical-utilization/{timeStamp} GET /api/v3/steering/as GET /api/v3/steering/steer-as/{monitoredRouterId}/details/{asNumber} GET /api/v3/steering/next-hop-bundle GET /api/v3/steering/monitored-router/{id}/as-bandwidth GET /api/v3/steering/steer-as/{monitoredRouterId} GET



Issue 1 24

/api/v3/steering/monitored-router/{id}/ports POST /api/v3/steering/monitored-router/{id}/ports POST /api/v3/steering/next-hop-bundle POST /api/v3/steering/monitored-router POST /api/v3/steering/as/{asNumber} POST /api/v3/steering/steer-as/{monitoredRouterId}/{asNumber} PUT /api/v3/steering/monitored-router/{id} PUT /api/v3/steering/monitored-router/port/{monitoredPortId}/heartbeat PUT /api/v3/steering/as/{asNumber}/refresh PUT /api/v3/steering/as/{asNumber} System API GET /api/v3/system/version These methods are only present in Version 3 of the NSP SDN API Template API GET /api/v3/template/custom-attributes/{templateId} GET /api/v3/template/path-profiles/{templateId} GET /api/v3/template/generic-qos GET /api/v3/template/generic-qos/{id} GET /api/v3/template/path-profiles GET /api/v3/template/custom-attributes POST /api/v3/template/custom-attributes POST /api/v3/template/path-profiles PUT /api/v3/template/path-profiles/{templateId} PUT /api/v3/template/custom-attributes/{templateId}


GET /api/v3/template/elan-services POST /api/v3/template/elan-services GET /api/v3/template/elan-services/{templateId} PUT /api/v3/template/elan-services/{templateId}

The italicized text is only present in Version 3 of the NSP SDN API: ElanServiceCreationTemplate: {

... adminState (string, optional): The administrative state required for the service. = ['MAINTENANCE', 'DOWN', 'UP'], mtu (integer, optional): The MTU for the service. The valid values are between 0 and 9194. , ... tunnelSelectionId (string, optional): The ID of the Tunnel Selection template associated with the service

}


25 Issue 1

GET /api/v3/template/eline-services POST /api/v3/template/eline-services GET /api/v3/template/eline-services/{templateId} PUT /api/v3/template/eline-services/{templateId}

The italicized text is only present in Version 3 of the NSP SDN API: ElineServiceCreationTemplate: {

... adminState (string, optional): The administrative state required for the service. = ['MAINTENANCE', 'DOWN', 'UP'], mtu (integer, optional): The MTU for the service. The valid values are between 0 and 9194. , ... tunnelSelectionId (string, optional): The ID of the Tunnel Selection template associated with the service

} POST /api/v3/template/l3-vpn-services GET /api/v3/template/l3-vpn-services PUT /api/v3/template/l3-vpn-services/{templateId} GET /api/v3/template/l3-vpn-services/{templateId}

The italicized text is only present in Version 3 of the NSP SDN API: L3vpnServiceCreationTemplate: {

... adminState (string, optional): The administrative state required for the service = ['MAINTENANCE', 'DOWN', 'UP'], autobind (string, optional): The type of autobind to be used for the service = ['rsvp_te', 'ldp', 'gre', 'none'], mtu (integer, optional): The MTU for the service. The valid values are 0 (which means to use the port's MTU) or between 512 and 9000. Applied to all endpoints. , ... tunnelSelectionId (string, optional): The ID of the Tunnel Selection template associated with the service

} POST /api/v3/template/och-services GET /api/v3/template/och-services GET /api/v3/template/och-services/{templateId} PUT /api/v3/template/och-services/{templateId}

The italicized text is only present in Version 3 of the NSP SDN API: OchServiceCreationTemplate: {

... restoration (string, optional): Specifies the recovery technique of a path after failure. = ['SBR', 'GR', 'None'], reversionMode (string, optional): Specifies how the path switches from the recovery to the the working path previously under failure condition. = ['softauto', 'auto', 'manual']

} GET /api/v3/template/qos POST /api/v3/template/qos GET /api/v3/template/qos/{templateId} PUT /api/v3/template/qos/{templateId}

The italicized text is only present in Version 3 of the NSP SDN API: QosTemplate: {

... egressParam (EgressParam, optional), egressQueueOverride (Array[Queue], optional), ingressParam (IngressParam, optional), ingressQueueOverride (Array[Queue], optional), qosProfile (integer, optional): The ID of the default Generic QoS profile associated with the quality of service template

}


Issue 1 26

EgressParam: { tier1Scheduler (Tier1Scheduler, optional)

} Queue {


} IngressParam: {



cir (integer, optional): Scheduler CIR override in either Kbps or percentage (0..100), where -3 is sum of CIR, -2 is no override, -1 is maximum , pir (integer, optional): Scheduler PIR override in either Kbps or percentage (1..100), where -2 is no override, -1 is maximum , rateType (string, optional): The type of the PIR/CIR rate. Default is Kbps. When set to percent, the value of the scheduler rate will be a percentage of the port rate = ['kbps', 'percent'], schedulerType (string, optional): The type of the scheduler override. Default is Scheduler. = ['Scheduler', 'Arbiter']

} GET /api/v3/template/tunnel-creations PUT /api/v3/template/tunnel-creations/{templateId}

The italicized text is only present in Version 3 of the NSP SDN API: TunnelCreationTemplate: {

... protection (boolean, optional): Specifies whether or


27 Issue 1

not the tunnel has a protection path. Protection path is only signalled after the primary path fails. , protectionType (string, optional): Specifies path protection type. Protection path is pre-signalled and available for immediate recovery after a primary path failure. = ['SECONDARY', 'STANDBY']

} Tenant API GET /api/v3/tenants/{tenantUuid}/resources The italicized text is only present in Version 3 of the NSP SDN API:

BaseEntity { adminState (string, optional): The current administrative state of the entity = ['MAINTENANCE', 'DOWN', 'UP'], ... externalIds (Array[ExternalId], optional), ... neDeploymentState (string, optional): The current deployment state of the entity = ['DEPLOYED', 'FAILED', 'PENDING', 'UNKNOWN'], operationalState (string, optional): The current operational state of the entity = ['PARTIALLY_DOWN', 'TRANSITION', 'DOWN', 'UNKNOWN', 'UP']

} ExternalId: {


} User API PUT /api/v3/users/{userUuid} This method is only present in Version 3 of the NSP SDN API

2.2 Exclusive entities

The following table lists entities/attributes that are only present in Version 2 of the NSP SDN API in NSP Release 2.0 R3.

Affected methods Removed entities & attributes Service API POST /api/v2/services This method is only present in Version 2 of the NSP SDN API. DELETE /api/v3/services/{uuid} GET /api/v3/services GET /api/v3/services/tenant/{uuid} GET /api/v3/services/{serviceUuid}/endpoints

The italicized text is only present in Version 2 of the NSP SDN API: BaseServiceEndpoint {

… egressCir (integer, optional): The Egress Committed


Issue 1 28

GET /api/v3/services/{uuid} POST /api/v3/services/elans POST /api/v3/services/elines POST /api/v3/services/l3-vpns POST /api/v3/services/lags POST /api/v3/services/optical PUT /api/v3/services/elans/{serviceUuid} PUT /api/v3/services/elines/{serviceUuid} PUT /api/v3/services/l3-vpns/{serviceUuid}

Information Rate in Kbps. Default value, no override: set to -2; Max rate available: set to -1, egressPir (integer, optional): The Egress Peak Information Rate in Kbps. Default value, no override: set to -2; Max rate available: set to -1, ingressCir (integer, optional): The Ingress Committed Information Rate in Kbps. Default value, no override: set to -2; Max rate available: set to -1, ingressPir (integer, optional): The Ingress Peak Information Rate in Kbps. Default value, no override: set to -2; Max rate available: set to -1, innerTag (integer, optional): The inner tag. Applicable to Dot1Q or QinQ ports., … outerTag (integer, optional): The outer tag. Applicable to Dot1Q or QinQ ports., …

} Template API GET /api/v3/template/qos GET /api/v3/template/qos/{templateId} POST /api/v3/template/qos

The italicized text is only present in Version 2 of the NSP SDN API: QosTemplate { ...

egressCir (integer, optional): The Egress Committed Information Rate (CIR) in Kbps. Value can be -2 or between 0 and 100000000, inclusive. Egress CIR can not be greater than Egress PIR, egressPir (integer, optional): The Egress Peak Information Rate (PIR) in Kbps. Value can be -2, -1, or between 0 and 100000000, inclusive, ... ingressCir (integer, optional): The Ingress Committed Information Rate (CIR) in Kbps. Value can be -2 or between 0 and 100000000, inclusive. Ingress CIR can not be greater than Ingress PIR, ingressPir (integer, optional): The Ingress Peak Information Rate (PIR) in Kbps. Value can be -2, -1, or between 0 and 100000000, inclusive, ...

}


29 Issue 1

3 NSP NSD API v3

This section outlines the changes made to Version 3 of the NSP SDN API in NSP Release 2.0 R3.

3.1 Added entities

The following table lists entities/attributes that were added to Version 3 of the NSP SDN API in NSP Release 2.0 R3.

Affected methods New entities & attributes IETF API GET /api/v3/ietf/te/link/{linkId} GET /api/v3/ietf/te/network/{networkId} GET /api/v3/ietf/te/networks GET /api/v3/ietf/te/node/{nodeId} GET /api/v3/ietf/te/termination-point/{tpId}

The API and its methods are newly introduced in NSP Release 2.0 R3

Network element API PUT /api/v3/ne/{id} This method is newly introduced in NSP Release 2.0 R3 Openflow API DELETE /api/v3/openflow/flows POST /api/v3/openflow/flows POST /api/v3/openflow/flows/search

The italicized text is newly introduced in NSP Release 2.0 R3 OpenflowFlowEntry {

... auditstate (string, optional): The audit state of the flow. = ['SUCCESS', 'NOT_DONE', 'FAILURE'], ...

}:

POST /api/v3/openflow/flows/search-by-id This method is newly introduced in NSP Release 2.0 R3 Port API GET /api/v3/ports/ne/{neUuid}/servicetype/{serviceType} GET /api/v3/ports/servicetype/{serviceType} GET /api/v3/ports/tenant/{tenantUuid} GET /api/v3/ports/{portUuid}

The italicized text is newly introduced in NSP Release 2.0 R3: Port: {

... availableEgressBandwidth (integer, optional): Specifies the available egress bandwidth associated with a port , availableIngressBandwidth (integer, optional): Specifies the available ingress bandwidth associated with a port , ... interfaceId (integer, optional): The id of the port/interface , ...

} ... Ethernet: {

... lldpConfiguration (Array[LldpConfigurationInfo], optional),


Issue 1 30

lldpRemotePeers (Array[LldpRemotePeerInfo], optional) } LldpConfigurationInfo: {

administrativeStatus (string, optional): The LLDP administrative status for the port = ['DISABLED', 'TX_ONLY', 'TX_AND_RX', 'RX_ONLY'], configurationType (string, optional): Whether this configuration is for Nearest Bridge, Nearest Customer, or Nearest Non TPMR = ['NEAREST_NON_TPMR', 'NEAREST_CUSTOMER', 'NEAREST_BRIDGE']

} LldpRemotePeerInfo: {

capabilitiesEnabled (integer, optional): The capabilities that are enabled on the remote port , capabilitiesSupported (integer, optional): The capabilities the remote port supports , portDescription (string, optional): The description of the remote port , remoteChassisId (string, optional): A string identifying the remote chassis , remoteChassisIdType (string, optional): The remote chassis id type = ['INTERFACE_ALIAS', 'INTERFACE_NAME', 'SUBNET', 'NETWORK_ADDRESS', 'LOCAL', 'PORT_COMPONENT', 'CHASSIS_COMPONENT', 'MAC_ADDRESS'], remoteIndex (integer, optional): The remote peer index , remoteManagementIpAddress (Array[IpAddress], optional), remotePeerType (string, optional): The remote peer type = ['NEAREST_NON_TPMR', 'NEAREST_CUSTOMER', 'NEAREST_BRIDGE'], remotePortId (string, optional): A string identifying the remote port , remotePortIdType (string, optional): The remote port id type = ['INTERFACE_ALIAS', 'INTERFACE_NAME', 'NETWORK_ADDRESS', 'LOCAL', 'PORT_COMPONENT', 'AGENT_CIRCUIT_ID', 'MAC_ADDRESS'], remoteSystemName (string, optional): The name of the remote system

} IpAddress:{

ipv4Address (Ipv4Address, optional), ipv6Address (Ipv6Address, optional)

} Ipv4Address: {

string (string, optional) } Ipv6Address: {


31 Issue 1


Service API PUT /api/v3/services/optical/{serviceUuid} This method is newly introduced in NSP Release 2.0 R3 PUT /api/v3/services/tunnel/{tunnelUuid} GET /api/v3/services/tunnel/{tunnelUuid} GET /api/v3/services/tunnels

The italicized text is newly introduced in NSP Release 2.0 R3: ServiceTunnel: {

... tunnelSelectionId (string, optional): Specifies the identifier of the tunnel selection profile to apply to the service , availableBw (integer, optional): Specifies the available bandwidth on the service , ...

} ...

Steering API DELETE /api/v3/steering/steer-as/{monitoredRouterId}/{asNumber} DELETE /api/v3/steering/next-hop-bundle/{id} DELETE /api/v3/steering/monitored-router/{id} DELETE /api/v3/steering/as/{asNumber} DELETE /api/v3/steering/monitored-router/{id}/ports GET /api/v3/steering/monitored-router/{id} GET /api/v3/steering/as/{asNumber}/subnets GET /api/v3/steering/monitored-router GET /api/v3/steering/next-hop-bundle/{id} GET /api/v3/steering/monitored-router/port/{monitoredPortId} GET /api/v3/steering/as/{asNumber} GET /api/v3/steering/monitored-router/port/{monitoredPortId}/historical-utilization/{timeStamp} GET /api/v3/steering/as GET /api/v3/steering/steer-as/{monitoredRouterId}/details/{asNumber} GET /api/v3/steering/next-hop-bundle GET /api/v3/steering/monitored-router/{id}/as-bandwidth GET /api/v3/steering/steer-as/{monitoredRouterId} GET

The API and its methods are newly introduced in NSP Release 2.0 R3


Issue 1 32

/api/v3/steering/monitored-router/{id}/ports POST /api/v3/steering/monitored-router/{id}/ports POST /api/v3/steering/next-hop-bundle POST /api/v3/steering/monitored-router POST /api/v3/steering/as/{asNumber} POST /api/v3/steering/steer-as/{monitoredRouterId}/{asNumber} PUT /api/v3/steering/monitored-router/{id} PUT /api/v3/steering/monitored-router/port/{monitoredPortId}/heartbeat PUT /api/v3/steering/as/{asNumber}/refresh PUT /api/v3/steering/as/{asNumber} System API GET /api/v3/system/version This methods is newly introduced in NSP Release 2.0 R3

3.2 Removed entities

The following table lists entities/attributes that removed from Version 3 of the NSP SDN API in NSP Release 2.0 R3.

Affected methods Removed entities & attributes Openflow API DELETE /api/v3/openflow/flows POST /api/v3/openflow/flows POST /api/v3/openflow/flows/search

The italicized text is newly introduced in NSP Release 2.0 R3 OpenflowFlowEntry {

... cookieMask (string, optional): The hexadecimal bit mask for the cookie. , ...

} OpenflowError: {

errorDescription (string, optional): Detailed description of the error. , errorStatus (string, optional): The error status information. = ['INVALID_OPERATION', 'NO_ERROR', 'SWITCH_NOT_FOUND', 'TIMED_OUT', 'UNKNOWN_ERROR', 'UNSUPPORTED_ACTION', 'UNSUPPORTED_MATCH', 'VALIDATION_ERROR'] string Enum: "INVALID_OPERATION", "NO_ERROR", "SWITCH_NOT_FOUND", "TIMED_OUT", "UNKNOWN_ERROR", "UNSUPPORTED_ACTION", "UNSUPPORTED_MATCH", "VALIDATION_ERROR" , errorSubcode (string, optional): More information about


33 Issue 1

the error status. = ['DEST_ADDRESS_REQUIRES_ETHERNET_TYPE', 'DEST_PORT_REQUIRES_PROTOCOL_TYPE', 'EXPERIMENTER_ADDRESS_REQUIRES_ETHERNET_TYPE', 'EXPERIMENTER_REQUIRES_WRITE', 'INVALID_COOKIE', 'INVALID_DEST_ADDRESS', 'INVALID_DEST_ADDRESS_MASK', 'INVALID_ETHERNET_TYPE', 'INVALID_EXPERIMENTER_ADDRESS', 'INVALID_EXPERIMENTER_BODY', 'INVALID_OUTPORT_PORTID', 'INVALID_PRIORITY', 'INVALID_PROTOCOL_TYPE', 'INVALID_SRC_ADDRESS', 'INVALID_SRC_ADDRESS_MASK', 'NO_ERROR', 'SRC_ADDRESS_REQUIRES_ETHERNET_TYPE', 'SRC_PORT_REQUIRES_PROTOCOL_TYPE', 'UNKNOWN_ERROR']

}

nsp release 2.0 r3 api differences guide - nokia … · network services platform . release 2.0 r3...

Documents