Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Optical Interfaces, OTUs, and ODUs Management RESTful Web Services

    The following operations can be performed using the Connectivity Services Director Optical Interfaces, Optical Transport Units (OTUs), and Optical Data Units (ODUs) Management RESTful Web Services.

    The optical channel data unit (ODU) overhead (OH) is added to the optical channel payload unit (OPU) to create the ODU. The ODU OH includes information for maintenance and operational functions to support optical channels. Optical channel transport unit (OTU) OH together with the FEC is added to form the OTU. The OTU OH includes information for operational functions to support the transport by way of one or more optical channel connections.

    You can view the optical interface specifications that are currently applied on the device, such as wavelength and power. Also, you can modify the existing parameters of the optical port and the ODU or the OTU parameters for 10-Gigabit Ethernet or 100-Gigabit Ethernet dense wavelength-division multiplexing (DWDM) interfaces, to suit your network needs or resolve any alarms caused by certain interface settings.

    Modify the OTN Configuration and Generate a Job ID

    This request is used to update the OTN configuration parameters, and generate a job ID for the task of updating the parameters. This request updates the OTN configuration for the specified device, layer and interface.

    URI

    /api/space/packet-optical/config-manager/
    devices/{device-id}/intf-name/layers/{layer}/otn-interface-config

    HTTP Method

    PUT

    Content Type

    application/vnd.net.juniper.space.
    job-management.task+json;version=1;q=0.01

    application/vnd.net.juniper.space.
    job-management.task+xml;version=1;q=0.01

    Consumes

    application/vnd.juniper.packet-optical.
    config-manager.otn-config+json;version=1;charset=UTF-8

    application/vnd.juniper.packet-optical.
    config-manager.otn-config+xml;version=1;charset=UTF-8

    Produces

    Updates the OTN configuration parameters, and generates a job ID.

    Table 1: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    layer

    String

    Path

    Name of layer: ‘Optics’ | ‘otu’ | ‘odu’

    Yes

    intf-name

    String

    Query

    Encoded interface name such as “et-0/0/0“ is “et-0%2f0%2f0%2f”

    Yes

    Input

    Request URL

    http://172.21.28.109:8080/api/space/packet-optical/config-manager/devices/786467/intf-name/layers/OPTICS/otn-interface-config?intf-name=et-0%2F1%2F0

    Sample XML Input

    {
       "otn-config": {
          "id": "/api/space/packet-optical/config-manager/devices/786467/intf-name/layers/OPTICS/otn-interface-config-et-0/1/0",
          "laser": "Disabled"
       }
    }
    

    Output

    Sample XML Output

    {
       "task": {
          "@href": "/api/space/job-management/jobs/1802267",
          "id": 1802267
       }
    }
    
    

    Get the OTN Configuration Details

    This request is used to retrieve all the OTN configuration details for the specified device, layer, and interface.

    URI

    /api/space/packet-optical/config-manager/
    devices/{device-id}/intf-name/layers/{layer}/otn-interface-config

    HTTP Method

    GET

    Content Type

    application/vnd.juniper.packet-optical.
    config-manager.otn-config+json;version=1;charset=UTF-8

    application/vnd.juniper.packet-optical.
    config-manager.otn-config+xml;version=1;charset=UTF-8

    Produces

    Collects the OTN configuration parameters.

    Table 2: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    layer

    String

    Path

    Name of layer: ‘Optics’ | ‘otu’ | ‘odu’

    Yes

    intf-name

    String

    Query

    Encoded interface name such as “et-0/0/0“ is “et-0%2f0%2f0%2f”

    Yes

    Output

    Sample XML Output

    Get the OTN Interface Status

    This request is used to retrieve the OTN interface status for the specified device, layer, and interface.

    URI

    /api/space/packet-optical/config-manager/
    otn-interface-status/devices/{device-id}/intf-name

    HTTP Method

    GET

    Content Type

    application/vnd.juniper.packet-optical.
    config-manager.status+xml;version=1;q=0.01

    application/vnd.juniper.packet-optical.
    config-manager.status+json;version=1;q=0.01

    Produces

    Collects the OTN interface status for the specified device, layer, and interface.

    Table 3: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    intf-name

    String

    Query

    Encoded interface name such as “et-0/0/0“ is “et-0%2f0%2f0%2f”

    Yes

    Output

    Sample XML Output

    Get the OTN PIC Status by SNMP Index

    This request is used to retrieve the OTN PIC status for the specified device and SNMP index.

    URI

    /api/space/packet-optical/config-manager/
    otnpic-status/devices/{device-id}/snmp-index

    HTTP Method

    GET

    Content Type

    application/vnd.juniper.packet-optical.
    config-manager.status+xml;version=1;q=0.01

    application/vnd.juniper.packet-optical.
    config-manager.status+json;version=1;q=0.01

    Produces

    Collects the OTN PIC status for the specified device and SNMP index.

    Table 4: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    snmp-index

    String

    Query

    SNMP Index of the FRU

    Yes

    Output

    Sample XML Output

    Get the OTN PIC Status by FRU Display Label

    This request is used to retrieve the OTN interface status for the specified device, SNMP index, and FRU display label.

    URI

    /api/space/packet-optical/config-manager/
    fru-status/devices/{device-id}/snmp-index/display-lable

    HTTP Method

    GET

    Content Type

    application/vnd.juniper.packet-optical.
    config-manager.status+xml;version=1;q=0.01

    application/vnd.juniper.packet-optical.
    config-manager.status+json;version=1;q=0.01

    Produces

    Collects the OTN PIC status for the specified device, SNMP index, and FRU display label.

    Table 5: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    snmp-index

    String

    Query

    SNMP Index of the FRU

    Yes

    display-label

    String

    Query

    Display label of FRU

    Yes

    Output

    Sample XML Output

    Get the PM Administration Details by Interface

    This request is used to retrieve the Performance Monitoring administration information for the specified device and interface.

    URI

    api/space/packet-optical/performance-manager/
    admin/devices/{device-id}/intf-name/pm-admin-info

    HTTP Method

    GET

    Content Type

    application/vnd.juniper.packet-optical.
    performance-manager.status+xml;version=1;q=0.01

    application/vnd.juniper.packet-optical.
    performance-manager.status+json;version=1;q=0.01

    Produces

    Collects the Performance Monitoring administration information for the specified device and interface.

    Table 6: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    intf-name

    String

    Query

    Encoded interface name URL

    Yes

    Output

    Sample XML Output

    Get the PM Administration Details of All Interfaces

    This request is used to retrieve the Performance Monitoring administration information for the specified device and all interfaces on the device.

    URI

    api/space/packet-optical/performance-manager/
    admin/devices/{device-id}/pm-admin-infos

    HTTP Method

    GET

    Content Type

    application/vnd.juniper.packet-optical.
    performance-manager.status+xml;version=1;q=0.01

    application/vnd.juniper.packet-optical.
    performance-manager.status+json;version=1;q=0.01

    Produces

    Collects the Performance Monitoring administration information for the specified device and all interfaces on the device.

    Table 7: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    Output

    Sample XML Output

    Enable the Collection of PM Statistics

    This request is used to enable the mechanism to collect performance monitoring (PM) statistics for the specified device and interface on the device.

    URI

    /api/space/packet-optical/performance-manager/admin/
    devices/{device-id}/intf-name/enable-pm-collection

    HTTP Method

    PUT

    Content Type

    application/vnd.juniper.packet-optical.
    performance-manager.status+xml;version=1;q=0.01

    application/vnd.juniper.packet-optical.
    performance-manager.status+json;version=1;q=0.01

    Produces

    Enable the PM mechanism for the specified device and interface on the device.

    Table 8: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    intf-name

    String

    Query

    Encoded interface name such as “et-0/0/0“ is “et-0%2f0%2f0%2f”

    Yes

    Input

    Sample XML Input

    Get the Current PM Details of an Optical Interface

    This request is used to retrieve the current performance monitoring information for the specified device and optical interface.

    URI

    /api/space/packet-optical/performance-manager/
    devices/{device-id}/intf-name/current-optics-pm-datas

    HTTP Method

    GET

    Content Type

    application/vnd.juniper.packet-optical.performance-manager.
    current-optics-pm-datas+json;version=1;q=0.01

    application/vnd.juniper.packet-optical.performance-manager.
    current-optics-pm-datas+xml;version=1;q=0.01

    Produces

    Collects the current performance monitoring details for an optical interface on a device.

    Table 9: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    intf-name

    String

    Query

    Encoded interface name such as “et-0/0/0“ is “et-0%2f0%2f0%2f”

    Yes

    mon-type

    String

    Query

    The PM monitor parameter

    Yes

    direction

    Integer

    Query

    The PM direction: 0 = “NONE”, 1 = “Tx”, 2 = “Rx”

    Yes

    Output

    Sample XML Output

    Get the Overview of Optical PM Data of an Interface

    This request is used to retrieve an overview of the optical performance monitoring data for an interface.

    URI

    /api/space/packet-optical/performance-manager/
    devices/{device-id}/intf-name/optics-overviews

    HTTP Method

    GET

    Content Type

    application/vnd.juniper.packet-optical.performance-manager.
    optics-overviews+json;version=1;q=0.01

    application/vnd.juniper.packet-optical.performance-manager.
    optics-overviews+xml;version=1;q=0.01

    Produces

    Collects an overview of the PM data for an optical interface on a device.

    Table 10: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    intf-name

    String

    Query

    Encoded interface name such as “et-0/0/0“ is “et-0%2f0%2f0%2f”

    Yes

    mon-type

    String

    Query

    The PM monitor parameter

    Yes

    direction

    Integer

    Query

    The PM direction: 0 = “NONE”, 1 = “Tx”, 2 = “Rx”

    Yes

    Input

    Sample XML Input

    http://172.21.28.109:8080/api/space/packet-optical/performance-manager/devices/786467/intf-name/optics-overviews?intf-name=et-0/1/0

    Output

    Sample XML Output

    {
       "optics-overviews": {
          "@uri": "/api/space/packet-optical/performance-manager/devices/786467/intf-name/optics-overviews",
          "@total": "40",
          "pm-gui-summary": [
             {
                "mpoint-name": "CD",
                "pre-interval": 0,
                "suspect-current": false,
                "suspect-day": false,
                "suspect-interval": false,
                "group-name": "Optical CD",
                "current-day": 0,
                "pre-day": 0,
                "device-id": 786467,
                "current": 1,
                "if-name": "et-0/1/0",
                "suspect-current-day": false
             },
             {
                "mpoint-name": "CD-Min",
                "pre-interval": 0,
                "tca-enabled": "NA",
                "suspect-current": false,
                "suspect-day": false,
                "suspect-interval": false,
                "group-name": "Optical CD",
                "tca-raised24hr": "NA",
                "current-day": 1,
                "tca-raised15min": "NA",
                "pre-day": 0,
                "device-id": 786467,
                "current": 1,
                "threshold24hr": 0,
                "threshold15min": 0,
                "if-name": "et-0/1/0",
                "suspect-current-day": false
             },
    	…
    	…
    	…
    

    Get the PM Details of an OTU of an Optical Interface

    This request is used to retrieve the current performance monitoring information for the OTU of a specified device and optical interface.

    URI

    /api/space/packet-optical/performance-manager/
    devices/{device-id}/intf-name/current-otn-pm-datas

    HTTP Method

    GET

    Content Type

    application/vnd.juniper.packet-optical.performance-manager.
    current-otn-pm-datas+json;version=1;q=0.01

    application/vnd.juniper.packet-optical.performance-manager.
    current-otn-pm-datas+xml;version=1;q=0.01

    Produces

    Collects the current performance monitoring details for an OTU on a device.

    Table 11: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    intf-name

    String

    Query

    Encoded interface name such as “et-0/0/0“ is “et-0%2f0%2f0%2f”

    Yes

    mon-type

    String

    Query

    The PM monitor parameter

    Yes

    direction

    Integer

    Query

    The PM direction: 0 = “NONE”, 1 = “Tx”, 2 = “Rx”

    Yes

    Output

    Sample XML Output

    Get the Overview of Optical PM Data of an OTU

    This request is used to retrieve an overview of the optical performance monitoring data for an OTU.

    URI

    /api/space/packet-optical/performance-manager/
    devices/{device-id}/intf-name/otn-overviews

    HTTP Method

    GET

    Content Type

    application/vnd.juniper.packet-optical.performance-manager.
    otn-overviews+json;version=1;q=0.01

    application/vnd.juniper.packet-optical.performance-manager.
    otn-overviews+xml;version=1;q=0.01

    Produces

    Collects an overview of the PM data for an OTU of an optical interface on a device.

    Table 12: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    intf-name

    String

    Query

    Encoded interface name such as “et-0/0/0“ is “et-0%2f0%2f0%2f”

    Yes

    mon-type

    String

    Query

    The PM monitor parameter

    Yes

    layer

    String

    Query

    The OTN layer:

    • 0 = "NONE"

    • 1 = "OTU"

    • 2 = "ODU"

    • 3 = “TCM"

    Yes

    direction

    Integer

    Query

    The PM direction: 0 = “NONE”, 1 = “Tx”, 2 = “Rx”

    Yes

    Input

    Sample XML Input

    http://172.21.28.109:8080/api/space/packet-optical/performance-manager/devices/786467/intf-name/otn-overviews?intf-name=et-0/1/0&layer=1

    Output

    Sample XML Output

    {
       "otn-overviews": {
          "@uri": "/api/space/packet-optical/performance-manager/devices/786467/intf-name/otn-overviews",
          "@total": "17",
          "pm-gui-summary": [
             {
                "mpoint-name": "OTU NE",
                "pre-interval": "NaN",
                "suspect-current": false,
                "suspect-day": false,
                "suspect-interval": false,
                "group-name": "OTU NE",
                "current-day": 0,
                "pre-day": "NaN",
                "device-id": 786467,
                "current": 0,
                "if-name": "et-0/1/0",
                "suspect-current-day": false
             },
             {
                "mpoint-name": "FEC NE",
                "pre-interval": "NaN",
                "suspect-current": false,
                "suspect-day": false,
                "suspect-interval": false,
                "group-name": "FEC NE",
                "current-day": 0,
                "pre-day": "NaN",
                "device-id": 786467,
                "current": 0,
                "if-name": "et-0/1/0",
                "suspect-current-day": false
             },
             {
    

    Get the Optical Groupings of PM Parameters

    This request is used to retrieve optical groupings of PM parameters for GUI representation.

    URI

    /api/space/packet-optical/performance-manager/
    devices/{device-id}/intf-name/optics-groupings

    HTTP Method

    GET

    Content Type

    application/vnd.juniper.packet-optical.performance-manager.
    optics-groupings+json;version=1;q=0.01

    application/vnd.juniper.packet-optical.performance-manager.
    optics-groupings+xml;version=1;q=0.01

    Produces

    Collects optical groupings of PM parameters for display in the GUI.

    Table 13: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    intf-name

    String

    Query

    Encoded interface name such as “et-0/0/0“ is “et-0%2f0%2f0%2f”

    Yes

    mon-type

    String

    Query

    The PM monitor parameter

    Yes

    dayinterval

    Integer

    Path

    Intervals as a measure of the number of days

    Yes

    intervals

    Integer

    Query

    Number of intervals

    Yes

    starttime

    Long Integer

    Query

    Time at which collection of PM statistics is started

    Yes

    endtime

    Long Integer

    Query

    Time at which collection of PM statistics is stopped

    Yes

    direction

    Integer

    Query

    The PM direction: 0 = “NONE”, 1 = “Tx”, 2 = “Rx”

    Yes

    Output

    Sample XML Output

    Get the Optical PM Parameters for an Interval

    This request is used to retrieve optical PM parameters of an interface for the specified interval.

    URI

    /api/space/packet-optical/performance-manager/
    devices/{device-id}/intf-name/optics-intervals

    HTTP Method

    GET

    Content Type

    application/vnd.juniper.packet-optical.performance-manager.
    optics-intervals+json;version=1;q=0.01

    application/vnd.juniper.packet-optical.performance-manager.
    optics-intervals+xml;version=1;q=0.01

    Produces

    Collects optical PM parameters of an interface for the specified interval.

    Table 14: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    intf-name

    String

    Query

    Encoded interface name such as “et-0/0/0“ is “et-0%2f0%2f0%2f”

    Yes

    mon-type

    String

    Query

    The PM monitor parameter

    Yes

    intervals

    Integer

    Query

    Number of intervals

    Yes

    starttime

    Long Integer

    Query

    Time at which collection of PM statistics is started

    Yes

    endtime

    Long Integer

    Query

    Time at which collection of PM statistics is stopped

    Yes

    direction

    Integer

    Query

    The PM direction: 0 = “NONE”, 1 = “Tx”, 2 = “Rx”

    Yes

    Output

    Sample XML Output

    Get the Optical PM Parameters of an Interface for the Previous Day

    This request is used to retrieve optical PM parameters of an interface for the previous day.

    URI

    /api/space/packet-optical/performance-manager/
    devices/{device-id}/intf-name/optics-prev-days

    HTTP Method

    GET

    Content Type

    application/vnd.juniper.packet-optical.performance-manager.
    optics-prev-days+json;version=1;q=0.01

    application/vnd.juniper.packet-optical.performance-manager.
    optics-prev-days+xml;version=1;q=0.01

    Produces

    Collects optical PM parameters of an interface for the previous day.

    Table 15: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    intf-name

    String

    Query

    Encoded interface name such as “et-0/0/0“ is “et-0%2f0%2f0%2f”

    Yes

    mon-type

    String

    Query

    The PM monitor parameter

    Yes

    days

    Integer

    Query

    Number of day intervals

    Yes

    starttime

    Long Integer

    Query

    Time at which collection of PM statistics is started

    Yes

    endtime

    Long Integer

    Query

    Time at which collection of PM statistics is stopped

    Yes

    direction

    Integer

    Query

    The PM direction: 0 = “NONE”, 1 = “Tx”, 2 = “Rx”

    Yes

    Output

    Sample XML Output

    Get the Optical TCA Details

    This request is used to retrieve threshold crossing alarms (TCAs) of an optical interface of a device.

    URI

    /api/space/packet-optical/performance-manager/
    devices/{device-id}/intf-name/optics-tcas

    HTTP Method

    GET

    Content Type

    application/vnd.juniper.packet-optical.performance-manager.
    optics-tcas+json;version=1;q=0.01

    application/vnd.juniper.packet-optical.performance-manager.
    optics-tcas+xml;version=1;q=0.01

    Produces

    Collects optical interface TCA details for an interface.

    Table 16: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    intf-name

    String

    Query

    Encoded interface name such as “et-0/0/0“ is “et-0%2f0%2f0%2f”

    Yes

    mon-type

    String

    Query

    The PM monitor parameter

    Yes

    Output

    Sample XML Output

    Get the OTN Groupings of PM Parameters

    This request is used to retrieve OTN groupings of PM parameters for GUI representation.

    URI

    /api/space/packet-optical/performance-manager/
    devices/{device-id}/intf-name/otn-groupings

    HTTP Method

    GET

    Content Type

    application/vnd.juniper.packet-optical.performance-manager.
    otn-groupings+json;version=1;q=0.01

    application/vnd.juniper.packet-optical.performance-manager.
    otn-groupings+xml;version=1;q=0.01

    Produces

    Collects OTN groupings of PM parameters for display in the GUI.

    Table 17: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    intf-name

    String

    Query

    Encoded interface name such as “et-0/0/0“ is “et-0%2f0%2f0%2f”

    Yes

    mon-type

    String

    Query

    The PM monitor parameter

    Yes

    layer

    String

    Query

    The OTN layer:

    • 0 = "NONE"

    • 1 = "OTU"

    • 2 = "ODU"

    • 3 = “TCM"

    Yes

    dayinterval

    Integer

    Path

    Intervals as a measure of the number of days

    Yes

    intervals

    Integer

    Query

    Number of intervals

    Yes

    starttime

    Long Integer

    Query

    Time at which collection of PM statistics is started

    Yes

    endtime

    Long Integer

    Query

    Time at which collection of PM statistics is stopped

    Yes

    direction

    Integer

    Query

    The PM direction: 0 = “NONE”, 1 = “Tx”, 2 = “Rx”

    Yes

    Output

    Sample XML Output

    Get the OTN PM Parameters for an Interval

    This request is used to retrieve OTN PM parameters of an interface for the specified interval.

    URI

    /api/space/packet-optical/performance-manager/
    devices/{device-id}/intf-name/otn-intervals

    HTTP Method

    GET

    Content Type

    application/vnd.juniper.packet-optical.performance-manager.
    otn-intervals+json;version=1;q=0.01

    application/vnd.juniper.packet-optical.performance-manager.
    otn-intervals+xml;version=1;q=0.01

    Produces

    Collects OTN PM parameters of an interface for the specified interval.

    Table 18: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    intf-name

    String

    Query

    Encoded interface name such as “et-0/0/0“ is “et-0%2f0%2f0%2f”

    Yes

    mon-type

    String

    Query

    The PM monitor parameter

    Yes

    layer

    String

    Query

    The OTN layer:

    • 0 = "NONE"

    • 1 = "OTU"

    • 2 = "ODU"

    • 3 = “TCM"

    Yes

    intervals

    Integer

    Query

    Number of intervals

    Yes

    starttime

    Long Integer

    Query

    Time at which collection of PM statistics is started

    Yes

    endtime

    Long Integer

    Query

    Time at which collection of PM statistics is stopped

    Yes

    direction

    Integer

    Query

    The PM direction: 0 = “NONE”, 1 = “Tx”, 2 = “Rx”

    Yes

    Output

    Sample XML Output

    Get the OTN PM Parameters of an Interface for the Previous Day

    This request is used to retrieve OTN PM parameters of an interface for the previous day.

    URI

    /api/space/packet-optical/performance-manager/
    devices/{device-id}/intf-name/otn-prev-days

    HTTP Method

    GET

    Content Type

    application/vnd.juniper.packet-optical.performance-manager.
    otn-prev-days+json;version=1;q=0.01

    application/vnd.juniper.packet-optical.performance-manager.
    otn-prev-days+xml;version=1;q=0.01

    Produces

    Collects OTN PM parameters of an interface for the previous day.

    Table 19: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    intf-name

    String

    Query

    Encoded interface name such as “et-0/0/0“ is “et-0%2f0%2f0%2f”

    Yes

    mon-type

    String

    Query

    The PM monitor parameter

    Yes

    layer

    String

    Query

    The OTN layer:

    • 0 = "NONE"

    • 1 = "OTU"

    • 2 = "ODU"

    • 3 = “TCM"

    Yes

    days

    Integer

    Query

    Number of day intervals

    Yes

    starttime

    Long Integer

    Query

    Time at which collection of PM statistics is started

    Yes

    endtime

    Long Integer

    Query

    Time at which collection of PM statistics is stopped

    Yes

    direction

    Integer

    Query

    The PM direction: 0 = “NONE”, 1 = “Tx”, 2 = “Rx”

    Yes

    Output

    Sample XML Output

    Get the OTN TCA Details

    This request is used to retrieve threshold crossing alarms (TCAs) of an OTN on the interface of a device.

    URI

    /api/space/packet-optical/performance-manager/
    devices/{device-id}/intf-name/otn-tcas

    HTTP Method

    GET

    Content Type

    application/vnd.juniper.packet-optical.performance-manager.
    otn-tcas+json;version=1;q=0.01

    application/vnd.juniper.packet-optical.performance-manager.
    otn-tcas+xml;version=1;q=0.01

    Produces

    Collects OTN TCA details for an interface.

    Table 20: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    intf-name

    String

    Query

    Encoded interface name such as “et-0/0/0“ is “et-0%2f0%2f0%2f”

    Yes

    mon-type

    String

    Query

    The PM monitor parameter

    Yes

    layer

    String

    Query

    The OTN layer:

    • 0 = "NONE"

    • 1 = "OTU"

    • 2 = "ODU"

    • 3 = “TCM"

    Yes

    direction

    Integer

    Query

    The PM direction: 0 = “NONE”, 1 = “Tx”, 2 = “Rx”

    Yes

    Output

    Sample XML Output

    Clear PM Counters and Return a Job ID

    This request is used to clear PM counters and provide a job ID.

    URI

    /api/space/packet-optical/performance-manager/
    devices/{device-id}/intf-name/clear-pm-counters

    HTTP Method

    PUT

    Content Type

    application/vnd.net.juniper.space.job-
    management.task+xml;version=1;q=0.01

    application/vnd.net.juniper.space.job-
    management.task+json;version=1;q=0.01

    Consumes

    application/vnd.juniper.packet-optical.performance-manager.
    clear-pm-counters-request+xml;version=1;charset=UTF-8

    application/vnd.juniper.packet-optical.performance-manager.
    clear-pm-counters-request+json;version=1;charset=UTF-8

    Produces

    Clears PM counters and provides a job ID.

    Table 21: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    intf-name

    String

    Query

    Encoded interface name such as “et-0/0/0“ is “et-0%2f0%2f0%2f”

    Yes

    clear-type

    String

    Query

    Type of PM to clear:

    • “opt_all” = All Optical PMs,

      “opt_c” = Current Optical PMs, •

      “opt_cday” = Current Optical Day PMs,

      “otn_all” = All OTN PMs,

      “otn_c” = Current OTN PMs, •

      “otn_cday” = Current OTN Day PMs

    Yes

    Input

    Sample XML Input

    http://172.21.28.109:8080/api/space/packet-optical/performance-manager/devices/786467/intf-name/clear-pm-counters?intf-name=et-0/1/0&clear-type=opt_c

    Output

    Sample XML Output

    {
       "task": {
          "@href": "/api/space/job-management/jobs/1802315",
          "id": 1802315
       }
    }
    

    Clear PM Counters Without Returning a Job ID

    This request is used to clear PM counters without providing a job ID.

    URI

    /api/space/packet-optical/performance-manager/
    devices/{device-id}/intf-name/clear-pm-counters

    HTTP Method

    PUT

    Consumes

    application/vnd.juniper.packet-optical.performance-manager.
    clear-pm-counters-request+xml;version=1;charset=UTF-8

    application/vnd.juniper.packet-optical.performance-manager.
    clear-pm-counters-request+json;version=1;charset=UTF-8

    Produces

    Clears PM counters and does not provide a job ID.

    Table 22: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    intf-name

    String

    Query

    Encoded interface name such as “et-0/0/0“ is “et-0%2f0%2f0%2f”

    Yes

    clear-type

    String

    Query

    Type of PM to clear:

    • “opt_all” = All Optical PMs,

      “opt_c” = Current Optical PMs, •

      “opt_cday” = Current Optical Day PMs,

      “otn_all” = All OTN PMs,

      “otn_c” = Current OTN PMs, •

      “otn_cday” = Current OTN Day PMs

    Yes

    Input

    Sample XML Input

    Output

    Sample XML Output

    Set a TCA Alert and Return a Job ID

    This request is used to define a TCA and provide a job ID.

    URI

    /api/space/packet-optical/performance-manager/
    set-otn-tca

    HTTP Method

    PUT

    Consumes

    application/vnd.juniper.packet-optical.performance-manager.
    set-otn-tca-request+xml;version=1;charset=UTF-8

    application/vnd.juniper.packet-optical.performance-manager.
    set-otn-tca+json;version=1;charset=UTF-8

    Content Type

    application/vnd.net.juniper.space.job-
    management.task+xml;version=1;q=0.01

    application/vnd.net.juniper.space.job-
    management.task+json;version=1;q=0.01

    URI Parameter

    None

    Produces

    Set a TCA and provide a job ID.

    Input

    Sample XML Input

    http://172.21.28.109:8080/api/space/packet-optical/performance-manager/set-otn-tca
    {
       "set-otn-tca-request": {
          "tcas": {
             "pm-config-tca": [
                {
                   "current": 0,
                   "current-day": 0,
                   "device-id": 786467,
                   "end-type": "NE",
                   "group-name": "Optical CFO",
                   "if-name": "et-0/1/0",
                   "layer-type": "Optical",
                   "mpoint-name": "CFO-Min",
                   "pre-day": 0,
                   "pre-interval": 0,
                   "suspect-current": false,
                   "suspect-current-day": false,
                   "suspect-day": false,
                   "suspect-interval": false,
                   "tca-enabled": true,
                   "tca-raised15min": "No",
                   "tca-raised24hr": "No",
                   "threshold15min": -5010,
                   "threshold24hr": -5050
                }
             ]
          }
       }
    }
    

    Output

    Sample XML Output

    {
       "task": {
          "@href": "/api/space/job-management/jobs/1802267",
          "id": 1802267
       }
    }
    

    Set a TCA Alert Without Returning a Job ID

    This request is used to define a TCA without providing a job ID.

    URI

    /api/space/packet-optical/performance-manager/
    set-otn-tca

    HTTP Method

    PUT

    Consumes

    application/vnd.juniper.packet-optical.performance-manager.
    set-otn-tca-request+xml;version=1;charset=UTF-8

    application/vnd.juniper.packet-optical.performance-manager.
    set-otn-tca+json;version=1;charset=UTF-8

    URI Parameter

    None

    Produces

    Set a TCA without providing a job ID.

    Input

    Sample XML Input

    http://172.21.28.109:8080/api/space/packet-optical/performance-manager/set-otn-tca
    {
       "set-otn-tca-request": {
          "tcas": {
             "pm-config-tca": [
                {
                   "current": 0,
                   "current-day": 0,
                   "device-id": 786467,
                   "end-type": "NE",
                   "group-name": "Optical CFO",
                   "if-name": "et-0/1/0",
                   "layer-type": "Optical",
                   "mpoint-name": "CFO-Min",
                   "pre-day": 0,
                   "pre-interval": 0,
                   "suspect-current": false,
                   "suspect-current-day": false,
                   "suspect-day": false,
                   "suspect-interval": false,
                   "tca-enabled": true,
                   "tca-raised15min": "No",
                   "tca-raised24hr": "No",
                   "threshold15min": -5010,
                   "threshold24hr": -5050
                }
             ]
          }
       }
    }
    

    Set the OTN PIC Attributes and Return a Job ID

    This request is used to set the OTN PIC configuration attributes and provide a job ID.

    URI

    /api/space/packet-optical/config-manager/
    devices/{device-id}/fpc/{fpcnum}/pic/{picnum}/pic-config

    HTTP Method

    PUT

    Content Type

    application/vnd.net.juniper.space.job-
    management.task+xml;version=1;q=0.01

    application/vnd.net.juniper.space.job-
    management.task+json;version=1;q=0.01

    Consumes

    application/vnd.juniper.packet-optical.config-manager.pic-
    config+xml;version=1;charset=UTF-8

    application/vnd.juniper.packet-optical.config-manager.pic-
    config+json;version=1;charset=UTF-8

    Produces

    Set the OTN PIC configuration parameters and return a job ID.

    Table 23: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    fpcnum

    Integer

    Path

    Slot number of the FPC

    Yes

    picnum

    Integer

    Integer

    Slot number of the PIC

    Yes

    Input

    Sample XML Input

    Output

    Sample XML Output

    Get the OTN PIC Attributes

    This request is used to retrieve the OTN PIC configuration attributes.

    URI

    /api/space/packet-optical/config-manager/
    devices/{device-id}/fpc/{fpcnum}/pic/{picnum}/pic-config

    HTTP Method

    PUT

    Content Type

    application/vnd.net.juniper.space.job-
    management.task+xml;version=1;q=0.01

    application/vnd.net.juniper.space.job-
    management.task+json;version=1;q=0.01

    Produces

    Obtains the OTN PIC configuration parameters.

    Table 24: URI Parameters

    Name

    Type

    URI Type

    Description

    Required

    device-id

    Integer

    Path

    ID of the device

    Yes

    fpcnum

    Integer

    Path

    Slot number of the FPC

    Yes

    picnum

    Integer

    Integer

    Slot number of the PIC

    Yes

    Output

    Sample XML Output

    Modified: 2017-09-13