README v1.9.22 2025-07-29

1. General
   1.1 Extract the NED package
   1.2 Install the NED package
       1.2.1 Local install
       1.2.2 System install
   1.3 Configure the NED in NSO
2. Optional debug and trace setup
3. Dependencies
4. Sample device configuration
5. Built in live-status actions
6. Built in live-status show
7. Limitations
8. How to report NED issues and feature requests
9. How to rebuild a NED

    * /ned-settings/ciena-mcp/mcp-service-model-api VERSION_4_BSM_L2SERVICE

  admin@ncs(config)# show configuration devices device <dev-1> config services ?
  Possible completions:
      l2Service                 //adresses resourceType: bharti.resourceTypes.L2Service
      tdmServices               //adresses resourceType: bharti.resourceTypes.TDMService 

    module: tailf-ned-ciena-mcp
    +--rw services
    |  +--rw l2Service* [label]
    |  |  +--rw label         string
    |  |  +--rw productId?    string
    |  |  +--rw properties
    |  |     +--rw serviceType?           string
    |  |     +--rw customerName?          string
    |  |     +--rw customerSegment?       string
    |  |     +--rw service?               string
    |  |     +--rw transportProtection?   string
    |  |     +--rw cos
    |  |     |  +--rw ingressCosPolicy?   string
    |  |     +--rw serviceEndPointList* [interfaceType]
    |  |        +--rw interfaceType    string
    |  |        +--rw node?            string
    |  |        +--rw port?            string
    |  |        +--rw vlanIds?         string
    |  |        +--rw bwp
    |  |           +--rw cbs?   uint16
    |  |           +--rw cir?   uint64
    |  |           +--rw ebs?   uint32
    |  |           +--rw eir?   uint64
    |  +--rw tdmServices* [label]
    |     +--rw label         string
    |     +--rw productId?    string
    |     +--rw properties
    |        +--rw rate?                  string
    |        +--rw rollbackPatch?         boolean
    |        +--rw customerName?          string
    |        +--rw customerSegment?       string
    |        +--rw transportProtection?   string
    |        +--rw vlanId?                uint32
    |        +--rw services* [circuitLabel]
    |           +--rw circuitLabel               string
    |           +--rw reuseExistingPseudowire?   boolean
    |           +--rw serviceEndPointList* [klm]
    |              +--rw node?                string
    |              +--rw port?                string
    |              +--rw klm                  string
    |              +--rw clockRecoveryMode?   string
    |              +--rw rtpSetting?          string
    |              +--rw priority?            uint32
    |              +--rw jitterBuffer?        uint32

  * ned-settings ciena-mcp mcp-service-model-api VERSION_6_TSM

admin@ncs(config)# show configuration devices device dummy-1 config tsm ?
Possible completions:
    L1OTNSwitchingProtService   Resources of type: ifd.v6.resourceTypes.L1OTNSwitchingProtServiceIntentFacade
    L1OTNSwitchingService       Resources of type: ifd.v6.resourceTypes.L1OTNSwitchingServiceIntentFacade
    eLineServices               Resources of type: ifd.v6.resourceTypes.L2ServiceIntentFacade
    l1Services                  Resources of type: ifd.v6.resourceTypes.L1NCPClientServiceIntentFacade
    mplsTunnels                 Resources of type: ifd.v6.resourceTypes.MplsTunnelIntentFacade
    networkConstructs           List of networkConstructs found on Ciena MCP
    tdmCircuits                 Resources of type: ifd.v6.resourceTypes.TDMServiceIntentFacade        module: tailf-ned-ciena-mcp

    +--rw tsm
        +--rw L1OTNSwitchingProtService* [name]
            ...
        +--rw L1OTNSwitchingService* [name]
            ...
        +--rw eLineServices* [name]
            ...
        +--rw l1Services* [name]
            ...
        +--rw mplsTunnels* [name]
            ...
        +--rw networkConstructs* [name]
            ...
        +--rw tdmCircuits* [name]
            ...

+---------------------------+------------------------------------------------------------------------------+
| Name                      | Info                                                                         |
+---------------------------+------------------------------------------------------------------------------+
| README-ned-settings.md    | Information about all run time settings supported by this NED.               |
+---------------------------+------------------------------------------------------------------------------+

+---------------------------+-----------+------------------------------------------------------------------+
| Feature                   | Supported | Info                                                             |
+---------------------------+-----------+------------------------------------------------------------------+
| netsim                    | yes       | See README.md for further info on how to configure the NED to    |
|                           |           | use netsim as a RESTCONF target.                                 |
|                           |           |                                                                  |
| check-sync                | yes       | Disabled by default. Can be enabled on devices that meet certain |
|                           |           | requirements. See README-ned-settings.md for further info.       |
|                           |           |                                                                  |
| partial-sync-from         | yes       | Granular support only on particular nodes, as the REST API       |
|                           |           | allows it. Contact developer for more details                    |
|                           |           |                                                                  |
| live-status actions       | yes       | Multiple live status commands implemented for provisioning and   |
|                           |           | asynchronous APIs.                                               |
|                           |           |                                                                  |
| live-status show          | no        |                                                                  |
|                           |           |                                                                  |
| load-native-config        | no        |                                                                  |
+---------------------------+-----------+------------------------------------------------------------------+

+---------------------------+-----------------+--------+---------------------------------------------------+
| Model                     | Version         | OS     | Info                                              |
+---------------------------+-----------------+--------+---------------------------------------------------+
| CIENA BLUEPLANET MCP      | artifactory.cie | BLUEPL | Ciena mcp:4.x                                     |
|                           | na.com.blueplan | ANET   |                                                   |
|                           | et.platform:18. | MCP    |                                                   |
|                           | 06              |        |                                                   |
|                           |                 |        |                                                   |
| CIENA BLUEPLANET MCP      | artifactory.cie | BLUEPL | Ciena mcp:5.x                                     |
|                           | na.com.blueplan | ANET   |                                                   |
|                           | et.mcp:5.x      | MCP    |                                                   |
|                           |                 |        |                                                   |
| CIENA BLUEPLANET MCP      | ['artifactory.c | BLUEPL | Ciena mcp:6.x                                     |
|                           | iena.com.bluepl | ANET   |                                                   |
|                           | anet.platform:2 | MCP    |                                                   |
|                           | 2.08', 'artifac |        |                                                   |
|                           | tory.ciena.com. |        |                                                   |
|                           | blueplanet.mcp: |        |                                                   |
|                           | 6.2']           |        |                                                   |
+---------------------------+-----------------+--------+---------------------------------------------------+

> export NSO_RUNDIR=~/nso-lab-rundir

  > ncs-setup --package ncs-6.0-ciena-mcp-1.0.1.tar.gz --dest $NSO_RUNDIR
  > ncs_cli -C -u admin
  admin@ncs# packages reload
  reload-result {
    package ciena-mcp-gen-1.0
    result true
 }

> export NED_ROOT_DIR=$NSO_RUNDIR/packages/ciena-mcp-gen-1.0

admin@ncs(config-device-netsim-0)# ned-settings ciena-mcp managed-lag?
Possible completions:
  managed-lag   TSM Specific: enable to manage LAG section

devices authgroups group ciena-auth
 default-map remote-name admin
 default-map remote-password $8$AEF7NqMC9u7dc3qOkwAhW4/12345689abcdef=
!

devices device ciena-lab1
 address   123.456.789.123
 port      443
 authgroup ciena-auth
 device-type generic ned-id ciena-mcp-gen-1.8
 trace     raw
 ned-settings ciena-mcp connection remote-protocol https
 ned-settings ciena-mcp connection ssl accept-any true
 ned-settings ciena-mcp logger level debug
 ned-settings ciena-mcp logger java true
 ned-settings ciena-mcp developer progress-verbosity debug
 ned-settings ciena-mcp mcp-service-model-api VERSION_6_TSM
 ned-settings ciena-mcp tsm-global-limit 1000
 ned-settings use-transaction-id false
 state admin-state unlocked
!

    admin@ncs(config)# devices device <device-name> config tsm ?
    Possible completions:
      L0ServiceIntentFacade       Resources of type: ifd.v6.resourceTypes.L0ServiceIntentFacade
      L1OTNSwitchingProtService   Resources of type: ifd.v6.resourceTypes.L1OTNSwitchingProtServiceIntentFacade
      L1OTNSwitchingService       Resources of type: ifd.v6.resourceTypes.L1OTNSwitchingServiceIntentFacade
      eLineServices               Resources of type: ifd.v6.resourceTypes.L2ServiceIntentFacade
      l1Services                  Resources of type: ifd.v6.resourceTypes.L1NCPClientServiceIntentFacade
      mplsTunnels                 Resources of type: ifd.v6.resourceTypes.MplsTunnelIntentFacade
      networkConstructs           List of networkConstructs found on Ciena MCP
      tdmCircuits                 Resources of type: ifd.v6.resourceTypes.TDMServiceIntentFacade

module: tailf-ned-ciena-mcp
  +--rw tsm
     +--rw mplsTunnels* [name]
     |  +--rw name          string
     |  +--rw label?        string
     |  +--rw productId?    string
     |  +--rw properties
     |     +--rw backupPathName?          string
     |     +--rw customerName?            string
     |     +--rw turnUpDateTime?          string
     |     +--rw protectionType?          string
     |     +--rw interactive_mode?        string
     |     +--rw bfdInterval?             string
     |     +--rw aisRefreshTimer?         string
     |     +--rw autoReversionPossible?   boolean
     |     +--rw waitToRevertDelay?       uint32
     |     +--rw reversionTimeUnit?       string
     |     +--rw globalDiversity
     |     |  +--rw diversityLevel?      string
     |     |  +--rw selectionCriteria?   string
     |     +--rw bandwidth
     |     |  +--rw assignedBandwidth?       uint32
     |     |  +--rw bandwidthLockout?        boolean
     |     |  +--rw assignedBandwidthUnit?   string
     |     |  +--rw bookingFactor?           union
     |     +--rw endPointA
     |     |  +--rw networkElement
     |     |  |  +--rw name?   string
     |     |  +--rw primary
     |     |  |  +--rw port?      string
     |     |  |  +--rw shelf?     string
     |     |  |  +--rw slot?      string
     |     |  |  +--rw eqptGrp?   string
     |     |  +--rw backup
     |     |     +--rw port?      string
     |     |     +--rw shelf?     string
     |     |     +--rw slot?      string
     |     |     +--rw eqptGrp?   string
     |     +--rw endPointZ
     |     |  +--rw networkElement
     |     |  |  +--rw name?   string
     |     |  +--rw primary
     |     |  |  +--rw port?      string
     |     |  |  +--rw shelf?     string
     |     |  |  +--rw slot?      string
     |     |  |  +--rw eqptGrp?   string
     |     |  +--rw backup
     |     |     +--rw port?      string
     |     |     +--rw shelf?     string
     |     |     +--rw slot?      string
     |     |     +--rw eqptGrp?   string
     |     +--rw routingConstraints* [index]
     |        +--rw index                  uint16
     |        +--rw endPoints*             string
     |        +--rw includeRouteObjects* [index]
     |           +--rw index             uint16
     |           +--rw objectType?       string
     |           +--rw constraintType?   string
     |           +--rw value*            string
     |           +--rw locations* [nodeName]
     |              +--rw nodeName         string
     |              +--rw interfaceName?   string
     |              +--rw shelf?           string
     |              +--rw slot?            string
     |              +--rw port?            string
     |              +--rw eqptGrp?         string

module: tailf-ned-ciena-mcp
  +--rw tsm
     +--rw eLineServices* [name]
     |  +--rw name          string
     |  +--rw label?        string
     |  +--rw productId?    string
     |  +--rw discovered?   boolean
     |  +--rw properties
     |     +--rw type?                  string
     |     +--rw structure?             string
     |     +--rw serviceType?           string
     |     +--rw userLabel?             string
     |     +--rw customerName?          string
     |     +--rw protectedPseudowire?   boolean
     |     +--rw oamEnabled?            boolean
     |     +--rw linearOnly?            boolean
     |     +--rw allowQinQSpur?         boolean
     |     +--rw interactive_mode?      string
     |     +--rw ccmInterval?           string
     |     +--rw ccmPriority?           uint32
     |     +--rw turnUpDateTime?        string
     |     +--rw coreSvid?              uint32
     |     +--rw routeMeta
     |     |  +--rw originator?   string
     |     +--rw constraints
     |     |  +--rw transport
     |     |  |  +--rw directionality?   string
     |     |  +--rw routes* [directionFrom directionTo]
     |     |     +--rw directionFrom          enumeration
     |     |     +--rw directionTo            enumeration
     |     |     +--rw protection?            string
     |     |     +--rw objectType?            string
     |     |     +--rw constraintType?        string
     |     |     +--rw includeRouteObjects* [index]
     |     |        +--rw index             uint16
     |     |        +--rw objectType?       string
     |     |        +--rw constraintType?   string
     |     |        +--rw locations* [nodeName]
     |     |           +--rw nodeName    string
     |     |           +--rw lspName?    string
     |     +--rw endpoints* [node role]
     |     |  +--rw role        string
     |     |  +--rw node        string
     |     |  +--rw settings
     |     |     +--rw oamEnabled?           boolean
     |     |     +--rw ccmTransmitEnabled?   boolean
     |     |     +--rw dmmEnabled?           boolean
     |     |     +--rw dmmPriority?          uint32
     |     |     +--rw dmmCount?             uint32
     |     |     +--rw dmmInterval?          string
     |     |     +--rw dmmFrameSize?         uint32
     |     |     +--rw dmmIterate?           uint32
     |     |     +--rw dmmRepeatDelay?       uint32
     |     |     +--rw slmEnabled?           boolean
     |     |     +--rw slmPriority?          uint32
     |     |     +--rw slmCount?             uint32
     |     |     +--rw slmInterval?          string
     |     |     +--rw slmFrameSize?         uint32
     |     |     +--rw slmIterate?           uint32
     |     |     +--rw slmRepeatDelay?       uint32
     |     |     +--rw details* [index]
     |     |        +--rw index           uint16
     |     |        +--rw flowSettings* [index]
     |     |           +--rw index                               uint16
     |     |           +--rw vlliState?                          string
     |     |           +--rw controlFrameTunneling?              string
     |     |           +--rw controlFrameTunnelingProfileName?   string
     |     |           +--rw filter
     |     |           |  +--rw outerVLANEthertype?   string
     |     |           |  +--rw outerVlanId*          uint16
     |     |           +--rw profiles* [profileName]
     |     |           |  +--rw profileName    string
     |     |           |  +--rw profileType?   string
     |     |           +--rw location
     |     |           |  +--rw shelf?     string
     |     |           |  +--rw slot?      string
     |     |           |  +--rw port?      string
     |     |           |  +--rw eqptGrp?   string
     |     |           |  +--rw lagName?   string
     |     |           +--rw ingressPolicer
     |     |           |  +--rw cbs?   uint32
     |     |           |  +--rw cir?   uint64
     |     |           |  +--rw ebs?   uint32
     |     |           |  +--rw eir?   uint64
     |     |           +--rw ingressCosSetting
     |     |              +--rw ingressCosPbit?     uint32
     |     |              +--rw ingressCosPolicy?   string
     |     +--rw profiles* [index]
     |     |  +--rw index          uint16
     |     |  +--rw profileName?   string
     |     |  +--rw profileType?   string
     |     +--rw note
     |        +--rw lastUpdatedBy?     string
     |        +--rw lastUpdatedTime?   string
     |        +--rw noteMsg?           string

module: tailf-ned-ciena-mcp
  +--rw tsm 
     +--rw l1Services* [name]
     |  +--rw name          string
     |  +--rw label?        string
     |  +--rw productId?    string
     |  +--rw properties
     |     +--rw customerName?             string
     |     +--rw turnUpDateTime?           string
     |     +--rw directionality?           string
     |     +--rw layerRate?                string
     |     +--rw interactive_mode?         string
     |     +--rw endPoints* [index]
     |     |  +--rw index                 uint16
     |     |  +--rw networkElement
     |     |  |  +--rw name?   string
     |     |  +--rw name?                 string
     |     |  +--rw ains?                 string
     |     |  +--rw shelf?                string
     |     |  +--rw port?                 string
     |     |  +--rw signalConditioning?   string
     |     |  +--rw slot?                 string
     |     +--rw primaryPathConstraints
     |     |  +--rw includeRouteObjects* [nodeName]
     |     |  |  +--rw nodeName          string
     |     |  |  +--rw objectType?       string
     |     |  |  +--rw constraintType?   string
     |     |  +--rw excludeRouteObjects* [nodeName]
     |     |     +--rw nodeName          string
     |     |     +--rw objectType?       string
     |     |     +--rw constraintType?   string
     |     +--rw note
     |        +--rw lastUpdatedBy?     string
     |        +--rw lastUpdatedTime?   string
     |        +--rw noteMsg?           string

module: tailf-ned-ciena-mcp
  +--rw tsm  
     +--rw tdmCircuits* [name]
     |  +--rw name          string
     |  +--rw productId?    string
     |  +--rw properties
     |     +--rw type?                      string
     |     +--rw structure?                 string
     |     +--rw customerName?              string
     |     +--rw routeMeta
     |     |  +--rw originator?   string
     |     +--rw serviceType?               string
     |     +--rw protectedPseudowire?       boolean
     |     +--rw oamEnabled?                boolean
     |     +--rw linearOnly?                boolean
     |     +--rw allowQinQSpur?             boolean
     |     +--rw reuseExistingPseudowire?   boolean
     |     +--rw interactive_mode?          string
     |     +--rw tdm
     |     |  +--rw layerRate?   string
     |     |  +--rw endPoints* [index]
     |     |     +--rw index             uint16
     |     |     +--rw networkElement
     |     |     |  +--rw name?   string
     |     |     +--rw tdmCosSettings
     |     |     |  +--rw pcp?   uint16
     |     |     +--rw rtpSetting?       string
     |     |     +--rw port?             string
     |     |     +--rw signalIndex?      string
     |     +--rw endpoints* [node role]
     |     |  +--rw role        string
     |     |  +--rw node        string
     |     |  +--rw settings
     |     |     +--rw details* [index]
     |     |        +--rw index           uint16
     |     |        +--rw flowSettings* [index]
     |     |           +--rw index       uint16
     |     |           +--rw filter
     |     |           |  +--rw outerVlanId*   uint16
     |     |           +--rw profiles* [profileName]
     |     |           |  +--rw profileName    string
     |     |           |  +--rw profileType?   string
     |     |           +--rw location
     |     |              +--rw port?   string
     |     +--rw globalDiversity
     |     |  +--rw diversityLevel?      string
     |     |  +--rw selectionCriteria?   string
     |     +--rw primaryPathConstraints
     |     |  +--rw includeRouteObjects* [nodeName]
     |     |     +--rw nodeName          string
     |     |     +--rw lspName?          string
     |     |     +--rw objectType?       string
     |     |     +--rw constraintType?   string
     |     +--rw note
     |        +--rw lastUpdatedBy?     string
     |        +--rw lastUpdatedTime?   string
     |        +--rw noteMsg?           string

module: tailf-ned-ciena-mcp
  +--rw tsm      
     +--rw L1OTNSwitchingProtService* [name]
     |  +--rw name          string
     |  +--rw label?        string
     |  +--rw productId?    string
     |  +--rw properties
     |     +--rw layerRate?              string
     |     +--rw interactive_mode?       string
     |     +--rw directionality?         string
     |     +--rw endPointA
     |     |  +--rw protServiceEndpoint
     |     |     +--rw networkElement
     |     |     |  +--rw name?   string
     |     |     +--rw port?             string
     |     |     +--rw shelf?            string
     |     |     +--rw slot?             string
     |     +--rw endPointZ
     |     |  +--rw protServiceEndpoint
     |     |     +--rw networkElement
     |     |     |  +--rw name?   string
     |     |     +--rw port?             string
     |     |     +--rw shelf?            string
     |     |     +--rw slot?             string
     |     +--rw workSncAttributes
     |     |  +--rw controlPlanePackage
     |     |  |  +--rw resiliencyType?   string
     |     |  +--rw primaryPathConstraints
     |     |     +--rw pathConstraint
     |     |        +--rw pathConstraintOption?   string
     |     |        +--rw costCriteria?           string
     |     +--rw protectSncAttributes
     |        +--rw controlPlanePackage
     |        |  +--rw resiliencyType?   string
     |        +--rw primaryPathConstraints
     |           +--rw pathConstraint
     |              +--rw pathConstraintOption?   string
     |              +--rw costCriteria?           string

module: tailf-ned-ciena-mcp
  +--rw tsm   
     +--rw L1OTNSwitchingService* [name]
        +--rw name          string
        +--rw label?        string
        +--rw productId?    string
        +--rw properties
           +--rw layerRate?          string
           +--rw interactive_mode?   string
           +--rw directionality?     string
           +--rw routingType?        string
           +--rw diversityType?      string
           +--rw endPointA
           |  +--rw networkElement
           |  |  +--rw name?   string
           |  +--rw ains?                 string
           |  +--rw signalConditioning?   string
           |  +--rw port?                 string
           |  +--rw shelf?                string
           |  +--rw slot?                 string
           +--rw endPointZ
           |  +--rw networkElement
           |  |  +--rw name?   string
           |  +--rw ains?                 string
           |  +--rw signalConditioning?   string
           |  +--rw port?                 string
           |  +--rw shelf?                string
           |  +--rw slot?                 string
           +--rw sncAttributes
              +--rw controlPlanePackage
              |  +--rw resiliencyType?      string
              |  +--rw dtlSetExclusivity?   string
              |  +--rw regroomAllowed?      boolean
              +--rw primaryPathConstraints
                 +--rw pathConstraint
                    +--rw pathConstraintOption?   string

     +--r networkConstructs* [neName]
        +--r neName              string
        +--r ncid?               string
        +--r typegroup?          string
        +--r sessionid?          string
        +--r softwareVersion?    string
        +--r deviceType?         string
        +--r resourceType?       string
        +--r group?              string
        +--r shelf?              string
        +--r ethernetPortMgmt
           +--rw lag* [aggName]
              +--rw aggName            string
              +--rw aggMode?           string
              +--rw primaryPorts*      string
              +--rw protectionPorts*   string

     +--rw L0ServiceIntentFacade* [label]
     |  +--rw label         string
     |  +--rw productId?    string
     |  +--rw properties
     |     +--rw name?                     string
     |     +--rw customerName?             string
     |     +--rw maximizeCapacity?         boolean
     |     +--rw directionality?           string
     |     +--rw osrpEnabled?              boolean
     |     +--rw centerFrequency?          string
     |     +--rw interactive_mode?         string
     |     +--rw turnUpDateTime?           string
     |     +--rw transponder_source?       string
     |     +--rw totalCapacity
     |     |  +--rw isForMultipleRoutes?   boolean
     |     |  +--rw unit?                  string
     |     |  +--rw value?                 string
     |     +--rw endPoints* [index]
     |     |  +--rw index             uint16
     |     |  +--rw networkElement
     |     |  |  +--rw name?   string
     |     |  +--rw shelf?            string
     |     |  +--rw port?             string
     |     |  +--rw slot?             string
     |     |  +--rw photonicTpeId?    string
     |     +--rw primaryPathConstraints
     |     |  +--rw includeRouteObjects* [nodeName]
     |     |  |  +--rw nodeName          string
     |     |  |  +--rw objectType?       string
     |     |  |  +--rw constraintType?   string
     |     |  +--rw excludeRouteObjects* [nodeName]
     |     |  |  +--rw nodeName          string
     |     |  |  +--rw objectType?       string
     |     |  |  +--rw constraintType?   string
     |     |  +--rw pathConstraint
     |     |     +--rw pathConstraintOption?   string
     |     +--rw note
     |        +--rw lastUpdatedBy?     string
     |        +--rw lastUpdatedTime?   string
     |        +--rw noteMsg?           string

admin@ncs(config)# java-vm java-logging logger net.schmizz.sshj level level-all
admin@ncs(config)# commit

devices device netsim-0
 config
  services
   l2Service NED-EVPL-1.2.1
    productId 5e43210d-ce79-44c5-aecc-1a2b34c5d6
    properties serviceType EVPL
    properties customerName TEST-CX-1
    properties customerSegment Mobility
    properties service  P2P
    properties transportProtection PROTECTED_BEST_EFFORT
    properties cos
     ingressCosPolicy L3DscpCos
    !
    properties serviceEndPointList interfaceType A_UNI
     node    LAB_A_3928
     port    100/GigE-1
     vlanIds 121
     bwp
      cbs 64
      cir 10001
      ebs 64
      eir 10002
     !
    !
    properties serviceEndPointList interfaceType Z_UNI
     node    LAB_B_3928
     port    100/GigE-2
     vlanIds 121
     bwp
      cbs 64
      cir 10001
      ebs 64
      eir 10002
     !
    !
   !
  !
 !
!

admin@ncs(config-device-deviceName01)# live-status exec l23-service get-services label NED-EPL-1.5.2
result {
    requestStatus passed
}
response {
    items {
        label NED-EPL-1.5.2
        id 5ea6a1f1-b27b-46ab-be1f-9ec299121cd1
        resourceTypeId <cxDependent>.resourceTypes.L2Service
        productId 5e43210d-ce79-44c5-aecc-1a2b34c5d6
        tenantId 7488eaff-a7fb-4dd8-b4da-48fa3e2c0318
        subDomainId 7fd5144c-552f-39a3-9464-08d3b9cfb251
        orchState active
        reason
        properties {
            serviceType EPL
            provisionStatus AWAITING-ACTION
            transportProtection PROTECTED_BEST_EFFORT
        }
    }
}

admin@ncs(config-device-deviceName01)# live-status exec l23-service get-services
result {
    requestStatus passed
}
response {
    items {
        label NED-EVPL-1.2.1
        id 5ea6a082-7d94-4e41-8b5d-2339b5f4eaf5
        resourceTypeId <cxDependent>.resourceTypes.L2Service
        productId 5e43210d-ce79-44c5-aecc-1a2b34c5d6
        tenantId 7488eaff-a7fb-4dd8-b4da-48fa3e2c0318
        subDomainId 7fd5144c-552f-39a3-9464-08d3b9cfb251
        orchState active
        reason
        properties {
            serviceType EVPL
            provisionStatus AWAITING-ACTION
            transportProtection PROTECTED_BEST_EFFORT
        }
    }
    items {
        label NED-DH-EVPL-1.4.1
        id 5ea6a09f-45b4-467b-96e7-14ed7945dcac
        resourceTypeId <cxDependent>.resourceTypes.L2Service
        productId 5e43210d-ce79-44c5-aecc-1a2b34c5d6
        tenantId 7488eaff-a7fb-4dd8-b4da-48fa3e2c0318
        subDomainId 7fd5144c-552f-39a3-9464-08d3b9cfb251
        orchState active
        reason
        properties {
            serviceType EVPL
            provisionStatus AWAITING-ACTION
            transportProtection PROTECTED_BEST_EFFORT
        }
    }
    items {
        label NED-EPL-1.5.2
        id 5ea6a1f1-b27b-46ab-be1f-9ec299121cd1
        resourceTypeId <cxDependent>.resourceTypes.L2Service
        productId 5e43210d-ce79-44c5-aecc-1a2b34c5d6
        tenantId 7488eaff-a7fb-4dd8-b4da-48fa3e2c0318
        subDomainId 7fd5144c-552f-39a3-9464-08d3b9cfb251
        orchState active
        reason
        properties {
            serviceType EPL
            provisionStatus AWAITING-ACTION
            transportProtection PROTECTED_BEST_EFFORT
        }
    }
}

admin@ncs(config-config)# services l2Service NED-EPL-1.5.2
admin@ncs(config-l2Service-NED-EPL-1.5.2)# show full
devices device netsim-0
 config
  services
   l2Service NED-EPL-1.5.2
    productId 5e43210d-ce79-44c5-aecc-1a2b34c5d6
    properties serviceType EPL
    properties customerName TEST-CX-4
    properties customerSegment Mobility
    properties service  P2MP
    properties transportProtection PROTECTED_BEST_EFFORT
    properties cos
     ingressCosPolicy L3DscpCos
    !
    properties serviceEndPointList interfaceType A_ENNI
     node    LAB_A_3928
     port    100/GigE-1
     vlanIds 1531
     bwp
      cbs 64
      cir 1234
      ebs 64
      eir 4567
     !
    !
    properties serviceEndPointList interfaceType Z_ENNI
     node    LAB_B_3928
     port    100/GigE-2
     vlanIds 1531
     bwp
      cbs 64
      cir 7890
      ebs 64
      eir 1234
     !
    !
    properties serviceEndPointList interfaceType Z_PRIME_ENNI
     node    LAB_A_3928
     port    GigE-5
     vlanIds 1531
     bwp
      cbs 64
      cir 7890
      ebs 64
      eir 1234
     !
    !
   !
  !
 !
!

admin@ncs(config-l2Service-NED-EPL-1.5.2)# properties serviceEndPointList interfaceType A_ENNI bwp ebs 1234

admin@ncs(config-bwp)# commit dry-run
cli {
    local-node {
        data  devices {
                    device deviceName01 {
                        config {
                            services {
                                l2Service NED-EPL-1.5.2 {
                                    properties {
                                        serviceEndPointList A_ENNI {
                                            bwp {
                -                                ebs 64;
                +                                ebs 1234;
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
    }
}

admin@ncs(config-bwp)# commit dry-run outformat native
native {
    device {
        name deviceName01
        data PATCH : /bpocore/market/api/v1/resources/5ea6a1f1-b27b-46ab-be1f-9ec299121cd1?validate=false&obfuscate=true
                {
                    "label":"NED-EPL-1.5.2",
                    "productId":"5e43210d-ce79-44c5-aecc-1a2b34c5d6",
                    "properties":{
                        "serviceType":"EPL",
                        "customerName":"TEST-CX-4",
                        "customerSegment":"Mobility",
                        "service":"P2MP",
                        "transportProtection":"PROTECTED_BEST_EFFORT",
                        "cos":{
                            "ingressCosPolicy":"L3DscpCos"
                        },
                        "serviceEndPointList":[{
                            "interfaceType":"A_ENNI",
                            "node":"LAB_A_3928",
                            "port":"100/GigE-1",
                            "vlanIds":"1531",
                            "bwp":{
                                "cbs":64,
                                "cir":1234,
                                "ebs":1234,
                                "eir":4567
                            }
                        },{
                            "interfaceType":"Z_ENNI",
                            "node":"LAB_B_3928",
                            "port":"100/GigE-2",
                            "vlanIds":"1531",
                            "bwp":{
                                "cbs":64,
                                "cir":7890,
                                "ebs":64,
                                "eir":1234
                            }
                        },{
                            "interfaceType":"Z_PRIME_ENNI",
                            "node":"LAB_A_3928",
                            "port":"GigE-5",
                            "vlanIds":"1531",
                            "bwp":{
                                "cbs":64,
                                "cir":7890,
                                "ebs":64,
                                "eir":1234
                            }
                        }]
                    },
                    "id":"5ea6a1f1-b27b-46ab-be1f-9ec299121cd1"
                }
    }
}

admin@ncs(config-bwp)# commit

admin@ncs(config-config)# no services l2Service NED-EPL-1.5.2
admin@ncs(config)# commit dry-run outformat native
native {
    device {
        name deviceName01
        data DELETE : /bpocore/market/api/v1/resources/5ea6a1f1-b27b-46ab-be1f-9ec299121cd1?validate=false
    }
}
admin@ncs(config)# commit

admin@ncs(config-device-deviceName01)# config tsm ?
Possible completions:
  L1OTNSwitchingProtService   Resources of type: ifd.v6.resourceTypes.L1OTNSwitchingProtServiceIntentFacade
  L1OTNSwitchingService       Resources of type: ifd.v6.resourceTypes.L1OTNSwitchingServiceIntentFacade
  eLineServices               Resources of type: ifd.v6.resourceTypes.L2ServiceIntentFacade
  l1Services                  Resources of type: ifd.v6.resourceTypes.L1NCPClientServiceIntentFacade
  mplsTunnels                 Resources of type: ifd.v6.resourceTypes.MplsTunnelIntentFacade
  tdmCircuits                 Resources of type: ifd.v6.resourceTypes.TDMServiceIntentFacade

admin@ncs(config-mplsTunnels-MPLS_TUNNEL_TEST_001)# show full
devices device deviceName01
 config
  tsm mplsTunnels name MPLS_TUNNEL_TEST_001
   productId 012d3cba-9f33-11ec-8c39-4fd50172ad0b
   properties
    backupPathName        MPLS_TUNNEL_TEST_001_BAK
    turnUpDateTime        2022-11-22T05:32:42
    protectionType        PROTECTED
    interactive_mode      true
    bfdInterval           10msec
    aisRefreshTimer       10sec
    autoReversionPossible false
    globalDiversity diversityLevel LINK_DIVERSE
    globalDiversity selectionCriteria BEST_EFFORT
    bandwidth assignedBandwidth 1
    bandwidth bandwidthLockout false
    bandwidth assignedBandwidthUnit mbps
    bandwidth bookingFactor 1
    endPointA
     networkElement name FRED5171-0101
     primary port 2
     primary slot 1
     backup port 32
    !
    endPointZ
     networkElement name FRED5142-0101
     primary port 23
     backup port 23
    !
    routingConstraints 0
     includeRouteObjects 0
      objectType     NODE_NAME
      constraintType HARD
      locations nodeName FRED6500-0301
      !
     !
    !
    routingConstraints 1
     includeRouteObjects 0
      objectType     NODE_NAME
      constraintType HARD
      locations nodeName FRED6500-0101
      !
     !
    !
   !
  !
 !
!

admin@ncs(config-eLineServices-EPL_SERVICE_001)# show full
devices device deviceName01
 config
  tsm eLineServices name EPL_SERVICE_001
   productId  9876abcd-9f33-11ec-8c39-4fd50172ad0b
   discovered false
   properties
    type                FDFR
    structure           P2P
    serviceType         EPL
    userLabel           "test LABEL"
    protectedPseudowire false
    oamEnabled          true
    allowQinQSpur       true
    interactive_mode    true
    routeMeta originator BP2
    constraints
     transport directionality bidirectional
     routes A Z
      protection unprotected
      includeRouteObjects 0
       objectType     LSP_NAME
       constraintType HARD
       locations nodeName FRED5142-0101
        lspName EPL_SERVICE_LSP_NAME
       !
      !
     !
    !
    endpoints node FRED5142-0101 role A_UNI
     settings
      oamEnabled         true
      ccmTransmitEnabled true
      dmmEnabled         true
      slmEnabled         true
      details 0
       flowSettings 0
        controlFrameTunneling            enabled
        controlFrameTunnelingProfileName Default_Tunnel-All
        location
         port 2
        !
        ingressPolicer
         cbs 5
         cir 100000
         ebs 0
         eir 0
        !
        ingressCosSetting
         ingressCosPbit   0
         ingressCosPolicy fixed
        !
       !
      !
     !
    !
    endpoints node FRED5171-0101 role Z_UNI
     settings
      oamEnabled         true
      ccmTransmitEnabled true
      dmmEnabled         true
      slmEnabled         false
      details 0
       flowSettings 0
        controlFrameTunneling            enabled
        controlFrameTunnelingProfileName Default_Tunnel-All
        location
         port 1
        !
        ingressPolicer
         cbs 5
         cir 100000
         ebs 0
         eir 0
        !
        ingressCosSetting
         ingressCosPbit   0
         ingressCosPolicy fixed
        !
       !
      !
     !
    !
   !
  !
 !
!

admin@ncs(config-l1Services-L1-SERVICE-001)# show full
devices device deviceName01
 config
  tsm l1Services name L1-SERVICE-001
   label     L1-SERVICE-001
   productId 5f3f55aa-9a05-479a-bb10-8dc27ccc4562
   properties
    customerName     CustomerName
    turnUpDateTime   2021-02-12T03:25:06.989881+0000
    directionality   bidirectional
    layerRate        DSR_10GE
    interactive_mode true
    endPoints 0
     networkElement name TEB4-C6500-0001
     ains               ACTIVE
     shelf              1
     port               1
     signalConditioning NONE
     slot               12
    !
    endPoints 1
     networkElement name TEB4-C6500-0002
     ains               ACTIVE
     shelf              1
     port               1
     signalConditioning NONE
     slot               5
    !
   !
  !
 !
!

admin@ncs(config-tdmCircuits-TDM-CIRCUIT-001)# show full
devices device deviceName01
 config
  tsm tdmCircuits TDM-CIRCUIT-001
   productId abc1a2b3c-1a94-4e70-958a-375ca97f830d
   properties routeMeta originator BP2
   properties serviceType  EVPL
   properties protectedPseudowire false
   properties oamEnabled   false
   properties linearOnly   false
   properties allowQinQSpur true
   properties reuseExistingPseudowire false
   properties interactive_mode true
   properties tdm layerRate E1
   properties tdm endPoints 0
    networkElement name NE-C5142-0001
    tdmCosSettings pcp 5
    port        10
    signalIndex None
   !
   properties tdm endPoints 1
    networkElement name NE-C5142-0002
    tdmCosSettings pcp 5
    port        8
    signalIndex 3
   !
   properties endpoints node NE-C5142-0001 role A_UNI
    settings
     details 0
      flowSettings 0
       filter
        outerVlanId [ 100 ]
       !
       profiles profileName VLAN
        profileType filter
       !
       location
        port FTP
       !
      !
     !
    !
   !
   properties endpoints node NE-C5142-0002 role Z_UNI
    settings
     details 0
      flowSettings 0
       filter
        outerVlanId [ 100 ]
       !
       profiles profileName VLAN
        profileType filter
       !
       location
        port FTP
       !
      !
     !
    !
   !
   properties globalDiversity diversityLevel LINK_DIVERSE
   properties globalDiversity selectionCriteria MANDATORY
   properties primaryPathConstraints includeRouteObjects nodeName NE-C5142-0001
    lspName        LSP_NAME-003
    objectType     LSP_NAME
    constraintType HARD
   !
  !
 !
!

admin@ncs(config-L1OTNSwitchingService-L1OTN-SW-001)# show full
devices device deviceName01
 config
  tsm L1OTNSwitchingService name L1OTN-SW-001
   label     L1OTN-SW-001
   productId 12ab34cd-201a-4b1b-af74-e599d7dc6738
   properties
    layerRate        DSR_100GE
    interactive_mode true
    directionality   bidirectional
    routingType      MCP_DEFINED
    diversityType    NONE
    endPointA
     networkElement name NENAME00001
     ains               ACTIVE
     signalConditioning NONE
     port               2
     shelf              1
     slot               1
    !
    endPointZ
     networkElement name NENAME00002
     ains               ACTIVE
     signalConditioning NONE
     port               2
     shelf              1
     slot               1
    !
    sncAttributes
     controlPlanePackage resiliencyType MESH_RESTORABLE
     controlPlanePackage dtlSetExclusivity Working
     controlPlanePackage regroomAllowed true
     controlPlanePackage rhp false
     sncResiliencyController autoReversionType delay
     sncResiliencyController waitToRevertDelay 300
     primaryPathConstraints pathConstraint pathConstraintOption MIN_HOP
     restorationPathConstraints pathConstraint pathConstraintOption MIN_HOP
     numberOfRestorationPaths 0
    !
   !
  !
 !
!

admin@ncs(config-L1OTNSwitchingProtService-L1_OTN_PROT_001)# show full
devices device deviceName01
 config
  tsm L1OTNSwitchingProtService name L1_OTN_PROT_001
   label     L1_OTN_PROT_001
   productId 60b73c20-37d8-4b7d-8b7c-a045c9960bd7
   properties
    layerRate        OC3
    interactive_mode false
    directionality   bidirectional
    endPointA
     protServiceEndpoint networkElement name G5821-2-NEE-00001
     protServiceEndpoint port 1
     protServiceEndpoint shelf 2
     protServiceEndpoint slot 3
    !
    endPointZ
     protServiceEndpoint networkElement name G5821-2-NEE-00002
     protServiceEndpoint port 2
     protServiceEndpoint shelf 3
     protServiceEndpoint slot 4
    !
    workSncAttributes
     controlPlanePackage resiliencyType PERMANENT
     primaryPathConstraints pathConstraint pathConstraintOption ADMIN_WT
     primaryPathConstraints pathConstraint costCriteria DISABLED
    !
    protectSncAttributes
     controlPlanePackage resiliencyType PERMANENT
     primaryPathConstraints pathConstraint pathConstraintOption ADMIN_WT
     primaryPathConstraints pathConstraint costCriteria DISABLED
    !
   !
  !
 !
!

admin@ncs(config-device-deviceName01)# config tsm networkConstructs neName FRED5142-0001
admin@ncs(config-networkConstructs-FRED5142-0001)# show full
devices device deviceName01
 config
  tsm networkConstructs neName FRED5142-0101
   ncid            d53bcf8e-2e8e-3b5e-ade7-368eabb12b34
   typegroup       PN6x
   sessionid       acca4fd3-2bbe-4679-849d-7c2e34843e56
   softwareVersion saos-06-20-00-0206
   deviceType      "5142 Service Aggregation Switch"
   resourceType    5142
   ethernetPortMgmt
    lag LAG_Name-01
     primaryPorts    [ 12 34 ]
    !
    lag LAG_Name-02
     primaryPorts [ 24/4 ]
    !
    lag LAG_Name-03
     primaryPorts    [ 22 23 ]
     protectionPorts [ 10 24/0 ]
    !
   !
  !
 !
!

admin@ncs(config-networkConstructs-FRED6500-1234)# show full
devices device mcp-model
 config
  ...
  tsm networkConstructs neName FRED6500-1234
   ncid            _network_construct_ID_
   typegroup       Ciena6500
   sessionid       _session_management_id_
   softwareVersion 12.85
   deviceType      "6500 32-Slot Packet-Optical Shelf Assembly"
   resourceType    6500
   group           9
   shelf           1
   ethernetPortMgmt
    lag LAG_TEST-001
     primaryPorts [ 24/3 24/4 ]
    !
   !
  !
  ...
  ...
  ...
 !
! 

    neName FRED6500-1234 
    ncid _network_construct_ID_ 
    typegroup Ciena6500 
    sessionid _session_management_id_ 
    softwareVersion 12.85 
    deviceType "6500 32-Slot Packet-Optical Shelf Assembly" 
    resourceType 6500 
    group 9 
    shelf 1

live-status exec tsm get-ethernet-port-status neName FRED6500-1234 ncid _network_construct_ID_ typegroup Ciena6500 sessionid _session_management_id_ softwareVersion 12.85 deviceType "6500 32-Slot Packet-Optical Shelf Assembly" resourceType 6500 group 9 shelf 1

live-status exec tsm update-ethernet-port-state query { neName FRED6500-1234 ncid _network_construct_ID_ typegroup Ciena6500 sessionid _session_management_id_ softwareVersion 12.85 deviceType "6500 32-Slot Packet-Optical Shelf Assembly" resourceType 6500 group 9 shelf 1 } linkState Disabled port 24/3

live-status exec tsm update-ethernet-port-state query { neName FRED6500-1234 ncid _network_construct_ID_ typegroup Ciena6500 sessionid _session_management_id_ softwareVersion 12.85 deviceType "6500 32-Slot Packet-Optical Shelf Assembly" resourceType 6500 group 9 shelf 1 } linkState Enabled port 24/4

live-status exec tsm manage-lag resync-components managementSessionId _session_management_id_

config tsm networkConstructs neName FRED6500-1234 ethernetPortMgmt lag LAG_NSO-2305 primaryPorts [ 24/3 24/4 ]
commit dry-run
commit dry-run outformat native
commit

live-status exec tsm manage-lag get-interfacemanagement-values neName FRED6500-1234 ncid _network_construct_ID_ typegroup Ciena6500 sessionid _session_management_id_ softwareVersion 12.85 deviceType "6500 32-Slot Packet-Optical Shelf Assembly" resourceType 6500 group 9 shelf 1

live-status exec tsm manage-lag get-interfacemanagement-values neName FRED6500-1234 ncid _network_construct_ID_ typegroup Ciena6500 sessionid _session_management_id_ softwareVersion 12.85 deviceType "6500 32-Slot Packet-Optical Shelf Assembly" resourceType 6500 group 9 shelf 1 interfaceName IP-IF_LAG-001

live-status exec tsm manage-lag create-interfacemanagement neName FRED6500-1234 ncid _network_construct_ID_ typegroup Ciena6500 sessionid _session_management_id_ softwareVersion 12.85 deviceType "6500 32-Slot Packet-Optical Shelf Assembly" resourceType 6500 value { group 9 shelf 1 interfaceName IP-IF_LAG-230 subnetmask 30 interfaceIfMtu 1500 interfaceIpAddr 10.0.110.1 vlan 1720 vsName VS_LAG-2305 port LAG_NSO-2305 }

live-status exec tsm manage-lag get-interfacemanagement-values neName FRED6500-1234 ncid _network_construct_ID_ typegroup Ciena6500 sessionid _session_management_id_ softwareVersion 12.85 deviceType "6500 32-Slot Packet-Optical Shelf Assembly" resourceType 6500 group 9 shelf 1 interfaceName IP-IF_LAG-230

live-status exec tsm manage-lag get-interfacemanagement-values neName FRED6500-1234 ncid _network_construct_ID_ typegroup Ciena6500 sessionid _session_management_id_ softwareVersion 12.85 deviceType "6500 32-Slot Packet-Optical Shelf Assembly" resourceType 6500 group 9 shelf 1 

live-status exec tsm manage-lag resync-components managementSessionId _session_management_id_

live-status exec tsm manage-lag update-interfacemanagement neName FRED6500-1234 ncid _network_construct_ID_ typegroup Ciena6500 sessionid _session_management_id_ softwareVersion 12.85 deviceType "6500 32-Slot Packet-Optical Shelf Assembly" resourceType 6500 value { interfaceName IP-IF_LAG-230 vlan 1721 shelf 1 group 9 }

live-status exec tsm manage-lag update-interfacemanagement neName FRED6500-1234 ncid _network_construct_ID_ typegroup Ciena6500 sessionid _session_management_id_ softwareVersion 12.85 deviceType "6500 32-Slot Packet-Optical Shelf Assembly" resourceType 6500 value { interfaceName IP-IF_LAG-230 shelf 1 group 9 interfaceState disabled }

live-status exec tsm manage-lag update-interfacemanagement neName FRED6500-1234 ncid _network_construct_ID_ typegroup Ciena6500 sessionid _session_management_id_ softwareVersion 12.85 deviceType "6500 32-Slot Packet-Optical Shelf Assembly" resourceType 6500 value { interfaceName IP-IF_LAG-230 shelf 1 group 9 interfaceState enabled }

live-status exec tsm manage-lag update-interfacemanagement neName FRED6500-1234 ncid _network_construct_ID_ typegroup Ciena6500 sessionid _session_management_id_ softwareVersion 12.85 deviceType "6500 32-Slot Packet-Optical Shelf Assembly" resourceType 6500 value { interfaceName IP-IF_LAG-230 shelf 1 group 9 interfaceState disabled }

live-status exec tsm manage-lag delete-interfacemanagement neName FRED6500-1234 ncid _network_construct_ID_ typegroup Ciena6500 sessionid _session_management_id_ softwareVersion 12.85 deviceType "6500 32-Slot Packet-Optical Shelf Assembly" resourceType 6500 group 9 shelf 1 ROW_ID IP-IF_LAG-230

live-status exec tsm manage-lag delete-interfacemanagement neName FRED6500-1234 ncid _network_construct_ID_ typegroup Ciena6500 sessionid _session_management_id_ softwareVersion 12.85 deviceType "6500 32-Slot Packet-Optical Shelf Assembly" resourceType 6500 group 9 shelf 1 ROW_ID 1::::9::::IP-IF_LAG-230

live-status exec tsm update-ethernet-port-state query { neName FRED6500-1234 ncid _network_construct_ID_ typegroup Ciena6500 sessionid _session_management_id_ softwareVersion 12.85 deviceType "6500 32-Slot Packet-Optical Shelf Assembly" resourceType 6500 group 9 shelf 1 } linkState Disabled port 24/3

live-status exec tsm update-ethernet-port-state query { neName FRED6500-1234 ncid _network_construct_ID_ typegroup Ciena6500 sessionid _session_management_id_ softwareVersion 12.85 deviceType "6500 32-Slot Packet-Optical Shelf Assembly" resourceType 6500 group 9 shelf 1 } linkState Disabled port 24/4

live-status exec tsm manage-lag update-lag-entry neName FRED6500-1234 ncid _network_construct_ID_ typegroup Ciena6500 sessionid _session_management_id_ softwareVersion 12.85 deviceType "6500 32-Slot Packet-Optical Shelf Assembly" resourceType 6500 group 9 shelf 1 lagName LAG_NSO-2305 operation removeports value { primaryPorts [ 24/3 24/4 ] }

config tsm networkConstructs neName FRED6500-1234 
no ethernetPortMgmt lag LAG_NSO-2305
commit dry-run
commit dry-run outformat native
commit

live-status exec tsm manage-lag manage-virtualswitch-entry query { neName FRED6500-1234 ncid _network_construct_ID_ typegroup Ciena6500 sessionid _session_management_id_ softwareVersion 12.85 deviceType "6500 32-Slot Packet-Optical Shelf Assembly" resourceType 6500 } virtualSwitchName VS_LAG-2305 operation get

live-status exec tsm manage-lag manage-virtualswitch-entry query { neName FRED6500-1234 ncid _network_construct_ID_ typegroup Ciena6500 sessionid _session_management_id_ softwareVersion 12.85 deviceType "6500 32-Slot Packet-Optical Shelf Assembly" resourceType 6500 } virtualSwitchName VS_LAG-2305 operation delete

admin@ncs(config-device-lab)# show full-configuration devices device lab01 config tsm L0ServiceIntentFacade
devices device lab01
config
  tsm L0ServiceIntentFacade label TEST-SERVICE-ABC-100
   productId 2267b0e0-a352-11ed-8f50-c7aa620abcde
   properties
    name               TEST-SERVICE-ABC-100
    maximizeCapacity   false
    directionality     bidirectional
    osrpEnabled        false
    centerFrequency    123.45
    interactive_mode   false
    transponder_source Ciena
    totalCapacity isForMultipleRoutes false
    totalCapacity unit  GBPS
    totalCapacity value 100
    endPoints 0
     networkElement name ABCD-ROADM-0101
     shelf         1
     port          1
     slot          3
     photonicTpeId abcd96ad-1234-1234-1234-ef1492e3b8e6::TPE_abcd96ad-1234-1234-1234-ef1492e3b8e6::EQPT_2_84-59-PTP
    !
    endPoints 1
     networkElement name EFGH-ROADM-0101
     shelf         1
     port          1
     slot          5
     photonicTpeId efgh241a-1234-1234-1234-9ed4bd31c2d6::TPE_abcd96ad-1234-1234-1234-ef1492e3b8e6::EQPT_2_84-59-PTP
    !
    primaryPathConstraints includeRouteObjects nodeName IJKL-ROADM-0101
     objectType     NODE_NAME
     constraintType HARD
    !
    primaryPathConstraints pathConstraint pathConstraintOption MIN_HOP
    note lastUpdatedBy userName
    note lastUpdatedTime 2023-06-01T00:00:01
    note noteMsg    noteMessage
   !
  !

% request devices device **device-name** live-status exec **command** **arg** **argValue**
result {
    resultString    <...>             // Raw Http api response string received from device
    errorMessage    <...>             // Error message, if available within the http response or if within exception captured
    errorCode       <...>             // Error code, if available
    requestStatus   <failed|passed>   // <passed> or <failed> general status of the request
    ...
    nedMessage      <...>             // Custom message generated inside the NED trying to clarify status
}
response {                            // response section ONLY if successful response available
<...>
}

result {
    <...>
    requestStatus   passed           // <passed> general status of the processed request should be passed to have some relevant data in response section
    <...>
}
response {                           // response section ONLY if successful response available
    <...>                            // custom parameters parsed at output per each call.
    data <...>                       // most of the responses content are parsed under 'data' container
}

  admin@ncs(config-device-netsim-0)# live-status exec
  Possible completions:
  audits                             Actions needed for Audit report handling and updates
  get-jobId-status                   Command to fetch the status and data available for a previously scheduled jobId
  get-network-construct-id           Command to fetch the Network Construct element id
  get-network-element-availability   Command to verify the port status of the Network Construct element
  get-network-element-content        Command to verify the parameters of the given element name
  get-network-element-userLabel      Command to retrieve userLabel of the nw element if available
  l23-service                        Actions needed for L2 L3 Service provisioning
  push-mcp-configuration             Command to Push Configuration to MCP server
  show-constructs-elements-ids       Show id of all elements belonging to given network construct id
  upload-custom-script               Command to Upload Custom Script
  upload-empty-profile               Command to Upload Custom Script

  admin@ncs(config-device-netsim-0)# live-status exec audits
  Possible completions:
  create-schedule              Command to Create Audit Schedule
  execute-audit                Command to Execute audit operation on given resource id; Modeled for type 'string'.resourceTypes.Audit
  get-compliance-reports       Command to get audit reports for all resources or by resource id for type <string>.resourceTypes.NonCompliant
  get-schedule                 Command to get Audit Schedule - default type: EPTConfig
  update-schedule-properties   Command to update EPTConfig Audit Schedule Properties by resource id

  admin@ncs(config-device-netsim-0)# live-status exec l23-service
  Possible completions:
  create-service-profile      Command to create service profile
  delete-resource             Command to delete L2Service or Service profile or any other resource by id
  get-resources-nodes         Command to get Nodes by given resourceTypeId;
  get-resources-nodes-ports   Command to get given node ports by resourceTypeId;
  get-service-product-id      Command to get L2Service products
  get-service-profiles        Command to get service profiles
  get-services                Command to get L2 Services
  provision-service           Command to request L2Service provisioning to MCP by service id
  unprovision-service         Command to request L2Service un-provisioning to MCP by service id

Params:
    elementName    Name of the network element port to get the id for; Accepts 'any'

      % request devices device <device-name> live-status exec get-network-construct-id name <networkConstructName>
          or
      % request devices device <device-name> live-status exec get-network-construct-id name any

    constructId   Unique ID of the network construct for element to search for (Obtained at show-port-id)
    elementName   Name of the network element port to search for; Accepts 'any' to fetch all TPEs filtered content

    % request devices device <device-name> live-status exec get-network-element-availability constructId <constructId> elementName <elementName>
         or
    % request devices device <device-name> live-status exec get-network-element-availability constructId <constructId> elementName any

    constructId   Unique ID of the network construct for element to search for (Obtained at show-port-id)
    elementName   Name of the network element port to search for

      % request devices device <device-name> live-status exec get-network-element-content constructId <constructId> elementName <elementName>

    protocolType   Protocol type;     tl1|cli
    scriptContent  Full content of the script to be created, then loaded                  !!! Check [WARNING] subsection below
    scriptFile     Full canonical path of the script to be loaded
    scriptName     Script short Name; if left empty, config file short name will be used
                    ** Providing just the scriptFile without a scriptName, will result in extracting the scriptName from the scriptFile given at input.
                    ** Providing just the scriptName without a scriptFile, will result in creating the scriptFile at the path defined in 'mcp-scripts-folder' under ned-settings.
    typeGroup      Script type group; Ciena6500|Waveserver

  scriptContent
      -> Input string with the content of the script should have all special characters carefully escaped, so that NSO will be able to accept the content on the input leaf of type string (RFC 6020).
      -> Most of the cautions to be considered for double commas (") and escape (\) chars and newlines
          -> i.e.
              ->> commas char  "   escaped to:   \"
              ->> escape char  \   escaped to:   \\
              ->> escaping escaped commas  :  \\\"
              ->> new line   represented with:   \n
          -> Whole content must be given on single line, with clear text encoded newline separators ( \n );

{
    "commands":[
    "INTF-INTF1:ELEM.LAB:INTF1-2-3:123:::SOME_PARAM=ENABLED,SOME_PARAM_2=\"SOME_STRING\",,:,;"
    ]
}

        "{\n  \"commands\":[\n    \"INTF-INTF1:ELEM.LAB:INTF1-2-3:123:::SOME_PARAM=ENABLED,SOME_PARAM_2=\\\"SOME_STRING\\\",,:,;\"\n  ]\n}"

    % request devices device <device-name> live-status exec upload-custom-script protocolType <tl1|cli> typeGroup <Ciena6500|Waveserver> scriptFile </full/path/to/script.txt> scriptName <script.txt>

    % request devices device <device-name> live-status exec upload-custom-script protocolType <tl1|cli> typeGroup <Ciena6500|Waveserver> scriptFile </full/path/to/script.txt>

    % request devices device <device-name> live-status exec upload-custom-script protocolType <tl1|cli> typeGroup <Ciena6500|Waveserver> scriptFile </full/path/to/script.txt> scriptName <script.txt> scriptContent <string[a-zA-Z_-:;,.[]() ] with simple escaped quote \" or double escaped quote \\\" and newline as \n">

    % request devices device <device-name> live-status exec upload-custom-script protocolType <tl1|cli> typeGroup <Ciena6500|Waveserver> scriptName <script.txt> scriptContent <string[a-zA-Z_-:;,.[]() ] with simple escaped quote \" or double escaped quote \\\" and newline as \n">

    % request devices device <device-name> live-status exec upload-custom-script protocolType <tl1|cli> typeGroup <Ciena6500|Waveserver> scriptFile </full/path/to/script.txt> scriptContent <string[a-zA-Z_-:;,.[]() ] with simple escaped quote \" or double escaped quote \\\" and newline as \n">

    emptyProfilePath   Full canonical path of the empty profile script to be loaded
                        ** If none provided, no-profile.txt will be created at the path defined in 'mcp-scripts-folder' under ned-settings.

    % request devices device <device-name> live-status exec upload-empty-profile emptyProfilePath </path/to/no-profile.txt>

  cmdPushJsonContent
      -> same cautions must be applied as for the upload-custom-script/scriptContent
      -> Input string with the content of the script should have all special characters carefully escaped,
          so that NSO will be able to accept the content on the input leaf of type string (RFC 6020).
      -> Most of the cautions to be considered for double commas (") and escape (\) chars and newlines
          -> i.e.
          ->> commas char  "   escaped to:   \"
          ->> escape char  \   escaped to:   \\
              ->> escaping escaped commas  :  \\\"
          ->> new line   represented with:   \n
      -> Whole content must be given on single line, with clear text encoded newline separators ( \n );

    cmdPushJsonContent   Raw content of json script to be loaded for pushing the config
    cmdPushJsonFile      Full canonical path of the json script whose content is to be loaded for pushing the config

% request devices device <device-name> live-status exec push-mcp-configuration cmdPushJsonFile </path/to/file/configFile.json>

% request devices device <device-name> live-status exec push-mcp-configuration cmdPushJsonContent <string[a-zA-Z_-:;,.[]() ] with simple escaped quote \" or double escaped quote \\\" and newline as \n">

    networkConstructId   Enter networkConstructId to fetch network element ids for; Accepts 'any' to fetch them all
                            If 'any' or empty string is given, returns all ids for all constructs

    constructId   Unique ID of the network construct for element to search for (Obtained at show-port-id)
        elementName   Name of the network element port to search for

    jobId       Scheduled jobId to fetch the data for

admin@ncs(config-device-netsim-0)# live-status exec l23-service ?
Possible completions:
    create-service-profile      Command to create service profile
    delete-resource             Command to delete L2Service or Service profile or any other resource by id
    get-resources-nodes         Command to show existing Nodes by given resourceTypeId;
    get-resources-nodes-ports   Command to show given node ports by resourceTypeId;
    get-service-product-id      Command to show L2Service products
    get-service-profiles        Command to show service profiles
    get-services                Command to show L2 Services
    provision-service           Command to request L2Service provisioning to MCP by service id
    unprovision-service         Command to request L2Service un-provisioning to MCP by service id

admin@ncs(config)# devices device <device-name> live-status exec l23-service get-resources-nodes
result {
    requestStatus passed
}
response {
    items {
        label <LABEL-NAME>
        id <NODE_ID>
        resourceTypeId tosca.resourceTypes.NetworkConstruct
        productId <PRODUCT_ID>
        tenantId <TENANT_ID>
        subDomainId <SUBDOMAIN_ID>
    }
}

admin@ncs(config)# devices device <device-name> live-status exec l23-service get-resources-nodes-ports nodeLabel <LABEL-NAME>
result {
    requestStatus passed
}
response {
    items {
        label <LABEL-NAME>_PTP_<INTERFACE_TYPE>
        id <NODE_PORT_ID>
        resourceTypeId tosca.resourceTypes.TPE
        productId <NODE_PRODUCT_ID>
        tenantId <TENANT_ID>
        subDomainId <SUBDOMAIN_ID>
    }
}

admin@ncs(config)# devices device <device-name> live-status exec l23-service get-services
result {
    requestStatus passed
}
response {
    items {
        label <SERVICE_LABEL>
        id <SERVICE_ID>
        resourceTypeId {cxDependent}.resourceTypes.L2Service
        productId <SERVICE_PRODUCT_ID>
        tenantId <TENANT_ID>
        subDomainId <SUBDOMAIN_ID>
        orchState <ORCH STATE>
        reason <failure reason if any>
        properties {
            serviceType <EPL|EVPL|DH...>
            provisionStatus <PROVISION_STATUS>
            transportProtection <TRANSPORT_PROTECTION_MODE>
        }
    }
    items {
        label <SERVICE_LABEL>
        id <SERVICE_ID>
        resourceTypeId {cxDependent}.resourceTypes.L2Service
        productId <SERVICE_PRODUCT_ID>
        tenantId <TENANT_ID>
        subDomainId <SUBDOMAIN_ID>
        orchState <ORCH STATE>
        reason <failure reason if any
        properties {
            serviceType E-LINE EVPL
            provisionStatus <PROVISION_STATUS>
            transportProtection <TRANSPORT_PROTECTION_MODE>
        }
    }
    ...
}

admin@ncs(config)# devices device <device-name> live-status exec l23-service get-services label <SERVICE_LABEL>
result {
    requestStatus passed
}
response {
    items {
        label <SERVICE_LABEL>
        id <SERVICE_ID>
        resourceTypeId {cxDependent}.resourceTypes.L2Service
        productId <SERVICE_PRODUCT_ID>
        tenantId <TENANT_ID>
        subDomainId <SUBDOMAIN_ID>
        orchState <ORCH STATE>
        reason <failure reason if any>
        properties {
            serviceType <EPL|EVPL|DH...>
            provisionStatus <PROVISION_STATUS>
            transportProtection <TRANSPORT_PROTECTION_MODE>
        }
    }
}

admin@ncs(config)# devices device <device-name> live-status exec l23-service get-service-profiles
result {
    requestStatus passed
}
response {
    items {
        label <SERVICE_PROFILE_LABEL>
        id <SERVICE_PROFILE_ID>
        resourceTypeId {cxDependent}.resourceTypes.ServiceProfile
        productId <SERVICE_PROFILE_PRODUCT_ID>
        tenantId <TENANT_ID>
        subDomainId <SUBDOMAIN_ID>
        properties {
            serviceType E-LINE EPL
        }

    }
    items {
        label <SERVICE_PROFILE_LABEL>
        id 5dc1ade5-388d-4cbf-821a-b98cac70dbce
        resourceTypeId {cxDependent}.resourceTypes.ServiceProfile
        productId <SERVICE_PROFILE_PRODUCT_ID>
        tenantId <TENANT_ID>
        subDomainId <SUBDOMAIN_ID>
        properties {
            serviceType E-LINE EVPL
        }
    }
    ...
}