Vertiv Avocent ACS800 User Manual
  1. Manuals
  2. Brands
  3. Vertiv Manuals
  4. Network Hardware
  5. Avocent ACS800
  6. User manual

Vertiv Avocent ACS800 User Manual

Advanced console system
Hide thumbs Also See for Avocent ACS800:
Table of Contents

Advertisement

Quick Links

Avocent® ACS800/8000
Advanced Console System
Application Programming Interface (API)
User Guide

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Avocent ACS800 and is the answer not in the manual?

Questions and answers

Related Manuals for Vertiv Avocent ACS800

Summary of Contents for Vertiv Avocent ACS800

  • Page 1 Avocent® ACS800/8000 Advanced Console System Application Programming Interface (API) User Guide...
  • Page 2 Technical Support Site If you encounter any installation or operational issues with your product, check the pertinent section of this manual to see if the issue can be resolved by following outlined procedures. Visit https://www.VertivCo.com/en-us/support/ for additional assistance.

  • Page 3: Table Of Contents

    2.2.8 /system/firmware/downloaded 2.2.9 /system/config/save 2.2.10 /system/config/restore 2.2.11 /system/dateAndTime 2.2.12 /system/dateAndTime/timezones 2.2.13 /system/general 2.3 Security Profile 2.3.1 /security 2.4 Network 2.4.1 /network/settings 2.4.2 /network/devices[/<INT>] 2.5 Serial Ports 2.5.1 /serialPorts[/<PORT#>] 2.6 Pluggable Devices Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...
  • Page 4 2.7.1 /authentication 2.7.2 /authentication/ldap 2.7.3 /authentication/radius 2.7.4 /authentication/tacacs 2.8 Users 2.8.1 /users[/<NAME>] 2.9 Resources 2.9.1 /resources Appendices Appendix A: cURL Appendix B: Python Appendix C: Helper Script Appendix D: Certificate Verification Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 5: Overview

    1.4 Query Parameters The fields query parameter is supported for many resources to enable the user to limit the fields that are returned. For example: GET /serialPorts?fields=pinout,speed. Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 6: Response Codes

    API will return a response body along with the 200 response code that contains a successful response message along with a list of keys that were ignored. This permits the caller to look for this information if so desired. "status": "success", "ignoredKeys": [ Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 7: Authentication

    In the RESTful examples throughout the document, what is sent in the request is shown in bold type including both URL components and message body. The response body is shown in normal type. For example: Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...
  • Page 8 POST /sessions/login {"username": "admin", "password": "avocent"} "token":"eyJhbGciOiJIUzI1NiIsInR…fVzCM" Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 9: Api Resources And Methods

    Return a list of attached pluggable devices and their details or return details on the /pluggableDevices/<NAME> named pluggable device. /pluggableDevices/<NAME>/eject POST Eject the specified device so that it is safe to remove. Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 10: Sessions

    PARAMETER DESCRIPTION username Valid username of an account on the appliance. (root, admin, etc.) password Valid password for the specified username. Query None Response Body JSON object Response Codes Not Authorized Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 11: Sessions/Logout

    Subsequent use of the web token will be unsuccessful. Methods POST Parameters None Query None Response Body JSON object Response Codes Failure Examples POST /sessions/logout "logout": "OK", "username": "root" Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 12: System

    Description of the cpu: ARMv7 Processor rev 0 (v71) cores Number of cores in the cpu: integer 2 Query Fields are supported for all parameters Response Body JSON object Response Codes Bad request Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 13: System/Reboot

    This action causes the appliance to reboot. Methods POST Parameters None Query None Response Body JSON object Response Codes Failure Examples POST /system/reboot "status": "initiated reboot" 2.2.3 /system/shutdown This action causes the appliance to shut down. Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 14: System/Factorydefault

    POST /system/shutdown "status": "initiated shutdown" 2.2.4 /system/factoryDefault This action restores the appliance to the factory default and reboots the appliance. Methods POST Parameters None Query None Response Body JSON object Response Codes Failure Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 15: System/Firmware/Version

    This action causes the appliance to download the firmware file specified in preparation for subsequent firmware updating. The action does not return until the file download has completed or fails. Depending Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...
  • Page 16 JSON object Response Codes Bad Request Examples POST /system/firmware/download "protocol": "ftp", "ipAddress": "10.20.30.80", "username": "anonymous", "password": "anonymous", "directory": "pub/firmware/", "filename": "firmware_acs8_1_2_9.fl" Response is: "status": "download successful", "firmware": { "version": "1.2.9.2449+540+23+11", "date": "03/01/17" Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 17: System/Firmware/Install

    Examples POST /system/firmware/install "status": "install successful", "firmware": { "version": "1.2.9.2449+540+23+11", "date": "03/01/17" 2.2.8 /system/firmware/downloaded This resource provides information about a firmware image that has previously been downloaded to the appliance. Methods Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 18: System/Config/Save

    Where to save the file, either to local appliance file system or a remote server: local/remote. protocol Protocol used to transfer the file to a remote server: ftp/scp/sftp. ipAddress IP Address of the remote server. username Username of the account to use on the remote server. Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 19: System/Config/Restore

    Response is: "status": "backup configuration saved as cli config filename: pub/myconfig.cli" 2.2.10 /system/config/restore Restores the appliance configuration from a specified file. NOTE: XML format is not supported in the API. Methods POST Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...
  • Page 20 The directory parameter is not actually needed in this case, as it is assumed to be blank if not provided. POST /system/config/restore "where": "local", "directory": "", "filename": "myconfig.cli" Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 21: System/Dateandtime

    Query Fields are supported for all parameters. Response Body JSON object Response Codes OK No Content (for a PUT or PATCH) Bad Request Examples GET /system/dateAndTime "time": "18:00:50", "date": "07/12/2017", "ntp": "enabled", "ntpSettings": { Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 22: System/Dateandtime/Timezones

    Gets a list of all the recognized timezones. These values can be used when setting the timezone via the /system/dateAndTime resource. Methods Parameters None Query None Response Body JSON object Response Codes Bad Request Examples GET /system/dateAndTime/timezones Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 23: System/General

    OK No Content (for a PUT or PATCH) Bad Request Examples GET /system/general "language": "english", "onlineHelp": "http://global.avocent.com/us/olh/acs8x/en/index.html", "banner": "enabled", "bannerText": "=================================================================== =======\n WARNING! The use of this system is restricted to Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 24: Security Profile

    Enables a user for data buffer management of a session: dataBufferManagement enabled/disabled restfulClientMenu Enables the restfulClient menu: enabled/disabled eraseFlash Control whether entire flash config is erased on a factory default: Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...
  • Page 25 HTTPS Port number (default 443): integer redirectHttp Redirect HTTP/HTTPS: enabled/disabled consolePort Appliance console port: enabled/disabled apiHttpAccess Allow RESTful API access via HTTP: enabled/disabled apiHttpSettings (only valid when apiHttpAccess is enabled) Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...
  • Page 26 NOTE: API changes made while using the API may terminate the API session. Examples GET /security "idleTimeout": 63955, "rpc": "disabled", "pluggableDevices": "enabled", "pluggableStorage": "disabled", "access": "all", "allAccessSettings": { "session": "multiple", "killMultiSession": "enabled", "sendMessageMultiSession": "enabled", "powerControl": "enabled", "dataBufferManagement": "enabled", "restfulClientMenu": "enabled" Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...
  • Page 27 "fips": "disabled", "dsview": "enabled" GET /security "idleTimeout": 63955, "rpc": "disabled", "pluggableDevices": "disabled", "access": "user_group", "eraseFlash": "disabled", "bootp": "disabled", "sshUserPass": "enabled", "profile": "open", "consolePort": "enabled", "apiHttpAccess": "disabled", "apiHttpsAccess": "disabled", "fips": "disabled", "dsview": "disabled" Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 28: Network

    Failover trigger: primary_interface_down/unreachable_primary_default_gateway/ unreachable_ip_ trigger address/unreachable_dsview unreachableIp IP Address to probe when trigger is unreachable_ip_address. dhcpv6Domain Get the IPv6 Domain name from DHCPv6: enabled/disabled Query Fields are supported for all parameters. Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 29: Network/Devices[/]

    Read-only name of the network interface: eth0, eth1, etc. isPrimary Read-only. Identifies if this is the primary interface: enabled/disabled status Status of the interface: enabled/disabled ipv4Method Method used to configure IPv4: dhcp/static/unconfigured ipv6Method Method used to configure IPv6: stateless/dhcpv6/static/unconfigured Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...
  • Page 30 IPv6 Prefix Length for static configuration. ipv6PrefixLength Example: 112 Query Fields are supported for all parameters. Response Body JSON object Response Codes OK No Content (for a PUT or PATCH) Bad Request Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 31: Serial Ports

    Read-only device name assigned by operating system. Examples: ttyS1, ttyUSB0, ttyACM0 status Port status: enabled/disabled physical (only valid when profile is cas, power or socket_client pinout Serial port pinout: auto/cisco/cyclades/rs422/rs485 speed Serial port speed: integer 1200/2400/4800/9600/19200/38400/57600/115200/230400 Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...
  • Page 32 Displays an information message when a target session is opened. enabled/disabled cas/dataBuffering (only valid when profile is cas) bufferingStatus Enables or disables data buffering. enabled/disabled Controls the type of data buffering: bufferingType Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...
  • Page 33 Configure the event that will trigger the establishment of the connection. dcd/always Query Fields are supported for all parameters. Response Body JSON object Response Codes OK No Content (for a PUT or PATCH) Bad Request Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 34: Pluggable Devices

    "code": "AE002", "message": "resource id not found", "detail": "75 is not a valid port id" 2.6 Pluggable Devices 2.6.1 /pluggableDevices[/<NAME>] Read information about the attached pluggable devices (USB, SD card). Methods Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...
  • Page 35 Current state of the device: inserted/unmounted/ejected port Serial port number assigned to this device if it is enabled as a console. Query Fields are supported for all parameters. Response Body JSON object Response Codes Bad Request Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 36: Pluggabledevices//Setconsole

    The serial port must then be configured appropriately. This can only be done for devices which show a deviceType of "console". Methods POST Parameters None Query None Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 37: Pluggabledevices//Eject

    Methods POST Parameters None Query None Response Body JSON object Response Codes Bad Request Examples POST /pluggableDevices/sda1/eject "status": "It is now safe to physically unplug the sda1 device" Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 38: Pluggabledevices//Delete

    / local / local|radius / local|tacacs+ / otp / otp|local / radius_down_local / radius / radius|local / tacacs+_down_ local / tacacs+ / tacacs+|local Query Fields are supported for all parameters. Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 39: Authentication/Ldap

    The database username. password The database password for the username. attributes Login attributes. Query Fields are supported for all parameters. Response Body JSON object Response Codes OK No Content (for a PUT or PATCH) Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 40: Authentication/Radius

    Authorization group name for Callback Login. callbackFramed Authorization group name for Callback Framed. outbound Authorization group name for Outbound. administrative Authorization group name for Administrative. Query Fields are supported for all parameters. Response Body JSON object Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 41: Authentication/Tacacs

    Secret word or passphrase, applies to both sets of servers. timeout Desired number of seconds for server timeout. retries Desired number of retries. version Version: v0 / v0_v1 / v1 / v1_v0 Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 42: Users

    2.8 Users 2.8.1 /users[/<NAME>] This resource provides the ability to view and edit user settings as well as add new users and delete existing users. Methods GET, PUT, PATCH, POST, DELETE Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...
  • Page 43 JSON object Response Codes Created OK No Content (for a PUT or PATCH) Bad Request Examples GET /users "users": [ "name": "admin", "settings": { "password": "", … "name": "root", … GET /users/admin Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 44: Resources

    "name": "bob", "settings": { "password": "password1234!", … 2.9 Resources 2.9.1 /resources This resource provides a list of the available resources and methods. Methods Parameters None Query None Response Body JSON object Response Codes Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...
  • Page 45 Failure Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...
  • Page 46 "POST /sessions/logout", "GET /sessions/refresh", "POST /system/config/restore", "POST /system/config/save", "GET /system/dateAndTime", "PATCH /system/dateAndTime", "PUT /system/dateAndTime", "GET /system/dateAndTime/timezones", "POST /system/factoryDefault", "POST /system/firmware/download", "GET /system/firmware/downloaded", "POST /system/firmware/install", "GET /system/firmware/version", "GET /system/general", "PATCH /system/general", "PUT /system/general", Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...
  • Page 47 "GET /system/info", "POST /system/reboot", "POST /system/shutdown", "GET /users", "POST /users", "DELETE /users/:NAME", "GET /users/:NAME", "PATCH /users/:NAME", "PUT /users/:NAME" Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...
  • Page 48 This page intentionally left blank. Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 49: Appendices

    $ curl -H "Content-Type: application/json" -H "Accept:application/json" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE1MDQxMTU2NzUsImlkIjoiYWRta W4iLCJvcmlnX2lhdCI6MTUwNDExMjA3NSwic2lkIjo4fQ.UYGXje5It2hAJryruP3etUaabSh5 pfiPP_sXXZF37og" http://10.20.30.40:8080/api/v1/system/info "serialNumber": "0012345678", "type": "ACS8048 with single power supply", "bootcode": "1.17", "firmware": "1.3.77.2909+551+28+11", "bootedFrom": "hardware", "powerSupply1": "on", "cpu": "ARMv7 Processor rev 0 (v7l)", "cores": 2 Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 50: Appendix B: Python

    RESTful API. These examples run on Python versions 2.7 and 3.5. They require the python "requests" module be installed on the system running python. An example can be run as follows: $ python acsapi_example_http.py Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 51: Appendix C: Helper Script

    Change your ACSHOST parameter to the ACS IP Address. For example:ACSHOST=192.168.161.10 GET /resource Example: GET /serialPorts/2 PUT /resource '{...json parameters...}' Example: PUT /serialPorts/2 '{"physical":{"speed":38400}}' PATCH /resource '{...json parameters...}' Example: PATCH /security '{"idleTimeout":0}' Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...

  • Page 52: Appendix D: Certificate Verification

    With cURL the "-k" option is used to disable certificate verification: $ curl -k -H "Content-Type: application/json" -H "Accept:application/json" https://10.20.30.40:48048/api/v1/sessions/login -d '{"username":"admin","password":"avocent"}' The restapi-helper script automatically includes the -k option on the underlying curl commands when using https. Vertiv | Avocent® ACS800/8000 Advanced Console System API Guide |...
  • Page 54 VertivCo.com | Vertiv Headquarters, 1050 Dearborn Drive, Columbus, OH, 43085, USA © 2017 Vertiv Co. All rights reserved. Vertiv and the Vertiv logo are trademarks or registered trademarks of Vertiv Co. All other names and logos referred to are trade names, trademarks or registered trademarks of their respective owners. While every precaution has been taken to ensure accuracy and completeness herein, Vertiv Co.

This manual is also suitable for:

Avocent acs8000

Table of Contents

Save PDF