Cisco Hardware CommandRunner API

The CommandRunner API from Cisco Hardware — 1 operation(s) for commandrunner.

OpenAPI Specification

cisco-hardware-commandrunner-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Cisco Catalyst Center (DNA Center) Intent Authentication CommandRunner API
  description: 'The Cisco Catalyst Center (formerly DNA Center) Intent API provides

    programmatic management of Cisco enterprise network hardware, including

    discovery, inventory, provisioning, assurance, software image

    management, sites, and command runner. Authentication uses a basic-auth

    token exchange against /dna/system/api/v1/auth/token; the returned

    token is sent on subsequent requests as the X-Auth-Token header.

    '
  version: 1.0.0
  contact:
    name: Cisco DevNet
    url: https://developer.cisco.com/docs/dna-center/
servers:
- url: https://{controllerHost}
  variables:
    controllerHost:
      default: sandboxdnac.cisco.com
      description: Host of the Catalyst Center controller
security:
- tokenAuth: []
tags:
- name: CommandRunner
paths:
  /dna/intent/api/v1/network-device-poller/cli/read-request:
    post:
      tags:
      - CommandRunner
      summary: Run a read-only CLI command against devices
      operationId: runCliCommand
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                commands:
                  type: array
                  items:
                    type: string
                deviceUuids:
                  type: array
                  items:
                    type: string
                description:
                  type: string
                name:
                  type: string
                timeout:
                  type: integer
      responses:
        '202':
          description: Task accepted
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    tokenAuth:
      type: apiKey
      in: header
      name: X-Auth-Token