Operation

post /eqm/cliRequest/processCLIRequest/{groupId}/{neId}
Executes the CLI command provided directly on the NE. (processCliCommandRequest : /eqm/cliRequest/processCLIRequest/{groupId}/{neId})
The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 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 CLI Command Request Data CLIRequestCommand ---

Return type
  • CLIRequestCommand
  • Responses

    Response Messages

    Schema

    200success CLIRequestCommand
    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/cliRequest/processCLIRequest/6601/2 Request Payload: <CLIRequestCommand> <neName>SVT-COMPOUND-1</neName> <ncName>100_SNA</ncName> <cliCommandText>show version</cliCommandText> </CLIRequestCommand>

    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
    <CLIRequestCommand> <cliCommandText>show version&#13; &#13;&#13; &#13;Software Version: 1830PSSECX-8.2-0&#13; &#13;&#13; &#13;SVT-COMPOUND-1#</cliCommandText> <opStatus>SUCCESS</opStatus> </CLIRequestCommand>
    Tags
    [ EQM ]

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

  • CLIRequestCommand

    Name

    Type

    Description

    Enum

    cliCommandText String string CL1 Command Text ---
    neName String string Network Element ID ---
    opStatus String string Operation Status ---
    ncName String string Group ID ---