Operation

post /eqm/tl1Request/processTL1Request/{groupId}/{neId}
Executes the TL1 command provided directly on the NE. (processTL1RequestCommand : /eqm/tl1Request/processTL1Request/{groupId}/{neId})
The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any TL1 Network Element retrieved from the call /data/npr/nes.

Path parameters

Name

IsRequired

Description

Enum

groupId required EML Group ID ---
neId required EML Network Element ID ---
Request body

Name

IsRequired

Description

Data Type

Enum

body required TL1 Command Request Data TL1ReqRespCommand ---

Return type
  • TL1ReqRespCommand
  • Responses

    Response Messages

    Schema

    200success TL1ReqRespCommand
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    REST call: /eqm/tl1Request/processTL1Request/6601/2 Request Payload: <TL1ReqRespCommand> <neName>2</neName> <ncName>6601_SNA</ncName> <tl1CommandText>RTRV-EQPT::SHELF-1-1:::;</tl1CommandText> </TL1ReqRespCommand>

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/xml
    Example Response Data
    <TL1ReqRespCommand> <tl1CommandText>PSS010010119008 16-02-23 06:58:38&#13; M 009100 COMPLD&#13; "SHELF-1-1::PROVISIONEDTYPE=PSS64,ACTUALTYPE=PSS64,APPL=OCS,TRUAID=NONE,ALMPROF=LBL-ASAPEQPT-SYSDFLT,MTXSIZE=3840,SWITCHCAP1=1920&amp;1872&amp;48, SWITCHCAP2=1920&amp;1920&amp;0,SWITCHCAPSTH=640&amp;0&amp;640:IS"&#13; /* RTRV-EQPT::SHELF-1-1:009100:: [009100] (8) */&#13; ;</tl1CommandText> <opStatus>SUCCESS</opStatus> </TL1ReqRespCommand>
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /eqm/tl1Request/processTL1Request
    Executes the TL1 command provided directly on the NE. (processTL1RequestCommandForNeName : /eqm/tl1Request/processTL1Request)
    The 'neName' field values can be obtained from the 'guiLabel' field of Network Element retrieved from the call /data/npr/nes.Following commands are supported for PHN Nes :
    RTRV-COND-COM
    RTRV-OMS
    RTRV-OMSWAVELENGTHSET
    RTRV-OPTLINE
    RTRV-IFGROUP
    RTRV-DYNAMIC-CONN
    RTRV-OCH
    RTRV-OTU
    RTRV-OMSOCHIF
    RTRV-CLIENT
    RTRV-ODU

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required TL1 Command Request Data TL1ReqRespCommand ---

    Return type
  • TL1ReqRespCommand
  • Responses

    Response Messages

    Schema

    200success TL1ReqRespCommand
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/xml
    Example Request Data

    REST call: /eqm/tl1Request/processTL1Request Request Payload: <TL1ReqRespCommand> <neName>Node-BH-2</neName> <tl1CommandText>RTRV-EQPT::ALL:c111;</tl1CommandText> </TL1ReqRespCommand>

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/xml
    Example Response Data
    <TL1ReqRespCommand> <tl1CommandText>Node-BH-2 16-09-22 09:50:35&#13; M c111 COMPLD&#13; "SYSTEM:SYSTEM:DESCR=\"\":"&#13; "SHELF-1:UNV_SHELF:DESCR=\"\",ACTUALTYPE=UNV_SHELF,NAME=\"Master Shelf\",CLKSRC=AUTO,SHELFAINS=NO,EXPECTED_AMPS=50,EXPECTED_VOLTS=48,HIGHVOLTTH=57.00,LOWVOLTTH=40.50,VOLTTOL=2,SHELFVFLOOR=39.0,CALCLOAD=11.13,AIRFILTMAINTMONITOR=OFF,AIRFILTMAINTINTERVAL=26,AIRFILTMAINTSTART=1970-01-01:"&#13; "EC-1-1:EC:DESCR=\"\",HIGHTEMPTH=90,LOWTEMPTH=-5,TEMPTOL=3,TEMPERATURE=0,ACTUALTYPE=EC,NAME=\"Card-1-1\",PMAX=43.00,IMAX=1.10:IS-NR,ACT&amp;NBK"&#13; "SLOT-1-2:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-3:::OOS-AUMA,UEQ&amp;UAS"&#13; "AHPHG-1-4:AHPHG:DESCR=\"\",HIGHTEMPTH=90,LOWTEMPTH=-5,TEMPTOL=3,TEMPERATURE=0,ACTUALTYPE=AHPHG,NAME=\"Card-1-4\",CLKSRC=AUTO,CLKSEL=PF19,EDFAPUMP1TEMP=25,EDFAPUMP2TEMP=25,EDFAPUMP3TEMP=25,EDFAPUMP1LBC=0,EDFAPUMP2LBC=0,EDFAPUMP3LBC=0,PMAX=31.00,IMAX=0.79:IS-NR"&#13; "SFD-1-5:SFD5A:DESCR=\"\",ACTUALTYPE=UNPLUGGED,NAME=\"Card-1-5\",PMAX=0.00,IMAX=0.01:OOS-AU,UEQ"&#13; "11STAR1A-1-6:11STAR1A:DESCR=\"\",HIGHTEMPTH=90,LOWTEMPTH=-5,TEMPTOL=3,TEMPERATURE=0,ACTUALTYPE=11STAR1A,NAME=\"Card-1-6\",PMAX=48.00,IMAX=1.23:IS-NR"&#13; "SLOT-1-7:::OOS-AUMA,UEQ&amp;UAS"&#13; "AHPHG-1-8:AHPHG:DESCR=\"\",HIGHTEMPTH=90,LOWTEMPTH=-5,TEMPTOL=3,ACTUALTYPE=UNPLUGGED,NAME=\"Card-1-8\",CLKSRC=AUTO,CLKSEL=,PMAX=31.00,IMAX=0.79:OOS-AU,UEQ"&#13; "SLOT-1-9:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-10:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-11:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-12:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-13:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-14:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-15:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-16:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-17:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-18:::OOS-AUMA,UEQ&amp;UAS"&#13; "PF-1-19:PF:DESCR=\"\",HIGHTEMPTH=90,LOWTEMPTH=-5,TEMPTOL=3,TEMPERATURE=0,ACTUALTYPE=PF,NAME=\"Power Filter-1-A\",PMAX=10.00,IMAX=0.26,AMPS=50:IS-NR"&#13; "SLOT-1-20:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-21:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-22:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-23:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-24:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-25:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-26:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-27:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-28:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-29:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-30:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-31:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-32:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-33:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-34:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-35:::OOS-AUMA,UEQ&amp;UAS"&#13; "PF-1-36:PF:DESCR=\"\",HIGHTEMPTH=90,LOWTEMPTH=-5,TEMPTOL=3,TEMPERATURE=0,ACTUALTYPE=PF,NAME=\"Power Filter-1-B\",PMAX=10.00,IMAX=0.26,AMPS=50:IS-NR"&#13; "FAN-1-37:FAN:DESCR=\"\",HIGHTEMPTH=90,LOWTEMPTH=-5,TEMPTOL=3,TEMPERATURE=0,ACTUALTYPE=FAN,FANSPEED=NORMAL,NAME=\"Fan-1\",PMAX=255.00,IMAX=6.54:IS-NR"&#13; "SLOT-1-38:::OOS-AUMA,UEQ&amp;UAS"&#13; "SLOT-1-39:::OOS-AUMA,UEQ&amp;UAS"&#13; "USRPNL-1-40:USRPNL:DESCR=\"\",ACTUALTYPE=USRPNL,NAME=\"User Interface Panel-1\",PMAX=6.00,IMAX=0.15:IS-NR"&#13; /* RTRV-EQPT [c111] (104) */&#13; ; </tl1CommandText> <opStatus>SUCCESS</opStatus> </TL1ReqRespCommand>
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • TL1ReqRespCommand

    Name

    Type

    Description

    Enum

    tl1CommandText String string TL1 Command Text ---
    neName String string Network Element ID or Name ---
    opStatus String string Operation Status ---
    ncName String string Group ID ---