RADKit Logo

About Cisco RADKit

  • Introduction
    • High-level architecture
    • Installation process
    • Installation options
  • Release Notes
    • 2.0.3
    • 2.0.2
    • 2.0.1
    • 1.9.11
    • 1.9.10
    • 1.9.9
    • 1.9.8
    • 1.9.6
    • 1.9.5
    • 1.9.4
    • 1.9.3
    • 1.9.2
    • 1.9.1
    • 1.9.0
    • 1.8.10
    • 1.8.9
    • 1.8.8
    • 1.8.7
    • 1.8.5
    • 1.8.3
    • 1.8.1
    • Earlier releases
      • 1.7.6
      • 1.7.5
      • 1.7.4
      • 1.7.3
      • 1.7.2
      • 1.7.1
      • 1.7.0
      • 1.6.12
      • 1.6.11
      • 1.6.10
      • 1.6.9
      • 1.6.8
      • 1.6.6
      • 1.6.5
      • 1.6.4
      • 1.6.3
      • 1.6.2
      • 1.6.1
      • 1.6.0
      • 1.5.12
      • 1.5.11
      • 1.5.10
      • 1.5.9
      • 1.5.8
      • 1.5.7
      • 1.5.5
      • 1.5.4
      • 1.5.3
      • 1.5.2
      • 1.5.1
      • 1.4.12
      • 1.4.11
      • 1.4.10
      • 1.4.9
      • 1.4.8
      • 1.4.7
      • 1.4.6
      • 1.4.5
      • 1.4.4
      • 1.4.3
      • 1.4.2
      • 1.4.1
      • 1.4.0
      • 1.3.9
      • 1.3.7
      • 1.3.2
      • 1.3.1
      • 1.3.0
      • 1.2.2
      • 1.2.1
      • 1.2.0
      • 1.1.5
      • 1.1.4
      • 1.0.6
      • 1.0.5
      • 1.0.4
      • 1.0.2
      • 1.0.0
  • Compatibility
    • Supported Python versions
    • Supported OSes & architectures
    • Supported browsers
    • Hardware & OS requirements
    • Device & platform support
  • Quick start guide
    • Downloading and installing RADKit
    • RADKit Service
      • Starting RADKit Service on Windows/macOS
      • Starting RADKit Service on Linux
      • Bootstrapping RADKit Service
      • Enrolling RADKit Service
      • Communicating the Service ID
      • Adding devices
      • Adding remote users
    • RADKit Client
      • Starting RADKit Client on Windows/macOS
      • Starting RADKit Client on Linux
      • Authenticating
      • Connecting to a Service
      • What’s next ?

Installation

  • Downloads
  • Installation guides
    • Windows installer
      • Installing RADKit
      • RADKit as a Windows service
      • Starting RADKit
      • Directory layout
      • Updating RADKit
      • Uninstalling RADKit
    • macOS installer
      • Installing RADKit
      • Starting RADKit
      • Directory layout
      • Updating RADKit
      • Uninstalling RADKit
    • Linux installer
      • Installation type
      • Downloading RADKit
      • Installing RADKit
      • Bootstrapping RADKit Service
      • Updating RADKit
      • Uninstalling RADKit
      • Customizing the installation
      • Troubleshooting
    • pip installation
      • Python environment
      • Installing from PyPI
      • Installing from tarballs
      • xcrun error on macOS
      • Starting RADKit
      • Upgrading RADKit
      • Uninstalling RADKit
    • Docker installation
      • Container-based options
      • Downloading the images
      • Installing the images

Components

  • RADKit Service
    • Service bootstrap
      • Using the Service GUI
      • Using the Service WebUI
      • Using RADKit Control
      • Using the Service CLI
    • Service enrollment
      • Using the WebUI
      • Using the command line
      • Using REST API
    • Authentication and Authorization
      • External sources
      • Administrator authentication
      • Remote users authentication
      • Device authentication
      • Next up
    • Administrator authentication
      • Local authentication
      • External authentication
    • Administrator Role-Based Access Control (RBAC)
      • Overview
      • Built-in Roles
      • Available Permissions (Claims)
      • Permission Hierarchy
      • Creating Custom Roles
      • Assigning Roles to Administrators
      • Role Management via Control API
      • Permission Enforcement
      • System Administrator Privileges
    • Remote user authentication
      • Cloud connection
      • Direct connection
      • End-to-end user authentication
    • RBAC using labels
      • Creating labels using Service WebUI
      • Assigning labels to a user
      • Assigning labels to a device
    • Remote service management
      • Overview
      • Enabling remote management
      • Access control
      • Security considerations
    • External sources
      • TACACS+
      • OIDC Server
      • Static Credentials
      • Static Credentials Mapping
      • HashiCorp Vault
      • CyberArk
      • Keyboard Interactive Challenge
      • Plugin
    • Device Templates
      • Adding a New Device Template
      • Default Variables
      • Complete YAML Example with Defaults
      • Supported YAML Tags
      • Example Of Adding A New Template
      • Using Device Templates in Devices
    • Custom startup of RADKit Service
      • RADKIT_SERVICE_SUPERADMIN_PASSWORD_FILE
      • CREDENTIALS_DIRECTORY
      • RADKIT_SERVICE_SUPERADMIN_PASSWORD_BASE64
      • RADKIT_SERVICE_SUPERADMIN_PASSWORD_FD
    • Setting up RADKit Service as a Windows service
      • Read this first !
      • Manual setup
      • RADKit directory
      • Installation options
      • Starting the service
      • Stopping the service
      • Removing the service
    • Running Service in Docker
      • Using a pre-built Service image
      • Building your own Service image
      • Things to know
      • Docker run interactive
      • Docker run non-interactive
      • Docker Compose
      • Passing CLI arguments through the environment
    • Service database
      • Storage backends
      • Import and export as JSON
      • Snapshots
      • Database constraints
    • Telemetry
  • RADKit Client
    • Introduction to RADKit Client
      • The radkit-interactive tool
      • Client and Service
      • To be continued…
    • Advanced Client setup
      • Enrolling the Client
      • Non-interactive authentication
      • Controlling/Monitoring Automatic Certificate Renewal
    • Client user guide
      • Starting RADKit Client
      • The RADKit Client Python interpreter
      • RADKit Client objects
      • Service object
      • Device Object
      • Multiple devices
      • Request object
      • Pipe commands
      • Feature guides
    • Integrated mode
      • Bootstrapping an integrated Service
      • Starting the integrated Service
      • Scripting with Integrated mode
  • RADKit Network Console
    • Starting the Network Console
      • Using the command line
      • Using the application shortcut
    • The Network Console prompt
    • Commands
      • login
      • service-cloud
      • service
      • service-direct-with-sso
      • service-direct
      • show
      • interactive
      • snmp
      • update_inventory
      • update-inventory
      • reauthenticate
      • download
      • download cxd
      • upload
      • proxy
      • session_logs
      • session-logs
      • platform
    • Stopping the Network Console
  • RADKit Control
    • Control CLI
      • Command structure
      • --help option guide
      • Command output
      • Control CLI reference
    • Control CLI cookbook
      • Prerequisites
      • Bootstrap the Service
      • Set up Control
      • Enroll the Service
      • Create an admin account
      • Create a remote user
      • Create, update and interact with a device
      • Create multiple devices in bulk from a CSV source with terminal defined

General documentation

  • Security
    • Service Hardening Guide
      • Administrator Users
      • Remote Users
      • Global RADKit Settings
      • System Management
      • Operating System Security
      • Hardening Checklist
    • Code signing
      • Windows installer
      • macOS installer
      • Linux installer
      • Docker images
      • Python wheels
      • Verifying .sig256 signatures
    • Cloud Connectivity
      • RADKit Cloud Endpoints
      • SR Attachment Endpoints
      • Endpoints API
    • Cryptography
      • Database & secrets
      • TLS
      • Identity certificates
    • Certificate validation
      • Truststores and Certificate Bundles
      • Example use-cases
      • Certificate revocation
    • End-to-end encryption and session verification
      • How it works
      • Enabling E2EE on the service
      • Enabling E2EE session verification on the service
      • Enabling end-to-end encryption and verification on the client
      • Extra notes
  • Settings
    • Proxy settings
      • Proxy support in RADKit
      • Scopes
      • Proxy settings
      • Derivation logic
      • Configuration examples
      • SSO login
    • Settings management
      • General
      • TOML settings
      • Client API
      • Environment variables
    • Domain settings
      • Domain tree
      • How domains are resolved
      • Role of accept_domains
      • Default values
      • Common scenarios
      • Fallback on missing identity
    • Settings reference
      • Special settings
      • Common settings
      • Client settings
      • Network Console settings
      • Service settings
      • Control settings
      • LLM settings
  • Features
    • Terminal & SFTP/SCP
      • Service configuration
      • Client operation
    • Command execution
      • Client operation
    • ExecSequence
      • Usage on InteractiveConnection
      • Uploading to CXD
      • ExecSequence methods
      • Procedures
      • Composing multiple ExecSequence objects together
    • Prompt Detection Strategies
      • Overview
      • Available Strategies
      • Using Strategies with Device.exec()
      • Performance Considerations
      • Best Practices
      • Troubleshooting
      • Related Features
    • Netconf/YANG
      • Service configuration
      • Client operation
    • Swagger/OpenAPI
      • Service configuration
      • Client operation
    • Raw HTTP API
      • Service configuration
      • Client operation
      • Authentication support
    • SNMP
      • Service configuration
      • Client operation
    • Port forwarding, SOCKS5 & HTTP proxy
      • Service configuration
      • Client operation
    • SSH Forwarding
      • Client Operation
      • Host Key
      • Usage
    • ControlAPI integration with the Client
      • Service configuration
      • Integration with the Client
    • SysLog Logging
      • Configuration
      • Message Format
      • Error Handling
      • Troubleshooting
      • Security Considerations
  • Integrations
    • RADKit Ansible Collection
      • Requirements
      • Installation
      • Using the collection
      • Inventory Plugin
      • Connection Plugins (DEPRECATED)
      • Modules
      • SSH Proxy Module Details
      • Quick Start Examples
      • Ansible Automation Controller (Ansible Tower/AWX)
      • Links & Resources
    • Parsing outputs with Genie
      • Deriving the Genie OS
      • Genie parse
      • Genie learn
      • radkit_genie API reference
    • Adding Custom Genie Parsers
      • 1. Create a Skeleton Python Module
      • 2. Create a Parser
      • 3. Point Genie to your Parser Module
      • Simple Parser Example
    • RADKit LLM Integration
      • Installation
      • Using as an MCP Server with GitHub Copilot
      • Using as a Standalone CLI Agent
      • Using the Simple MCP Server
      • Architecture
      • Sandbox Implementations
    • CX Drive (CXD)
      • CXD Introduction
      • CXD in RADKit
    • BDB Scripts (BDB)
      • The bdb function
      • Get BDB tasks
      • Run BDB task in BDB
      • Upload a local file to your BDB sandbox
      • Upload a string to a file in your BDB sandbox
      • Import a Connected Diagnostic IC task stored in BDB into your local radkit-client

API references

  • Client API
    • Stand-alone Client scripts
      • Connection types
      • Creation of the Client instance
      • Authentication methods
      • HTTP Proxy (Cloud-only)
      • In the REPL
      • In a Jupyter Notebook
      • In a web application (e.g., FastAPI)
    • Concurrency & joining requests
      • Joining multiple requests/tasks (with context manager)
      • Without context manager / in the REPL
      • Iterating over requests as they complete
      • Objects that can be joined together
    • Client API reference
      • Importing the Client API
      • Basic settings
      • Creation of a Client
      • Basic types
      • Login
      • Connection-related enums
      • Client
      • Certificates
      • Service
      • Integrated
      • Device
      • DeviceDict
      • Command execution
      • Terminal and SCP/SFTP
      • PromptDetectionStrategy
      • Upload parameters
      • CXD integration
      • Netconf
      • SNMP
      • Swagger and HTTP
      • Proxying
      • Device flow
      • Requests
      • Joining
      • Pipes
  • Control API
    • Control API reference
      • User operations
      • Label operations
      • Admin operations
      • Role operations
      • Service operations
      • Data types
  • Access API
    • Access API user guide
      • 1. How authentication works
      • 2. Getting a session token
      • 3. Using the session token
      • 4. Getting long-lived credentials
      • 5. Revoking tokens
      • 6. Token introspection and refresh
      • 7. JWKS and OIDC discovery
      • 8. Public API endpoints
      • 9. Common errors
      • 10. Appendix

Miscellaneous

  • Data & privacy
  • License information
    • Copyright
    • End-user license agreement (EULA)
    • Third-party software
RADKit
  • Client API

Client API

  • Stand-alone Client scripts
    • Connection types
    • Creation of the Client instance
    • Authentication methods
    • HTTP Proxy (Cloud-only)
    • In the REPL
    • In a Jupyter Notebook
    • In a web application (e.g., FastAPI)
  • Concurrency & joining requests
    • Joining multiple requests/tasks (with context manager)
    • Without context manager / in the REPL
    • Iterating over requests as they complete
    • Objects that can be joined together
  • Client API reference
    • Importing the Client API
    • Basic settings
    • Creation of a Client
    • Basic types
    • Login
    • Connection-related enums
    • Client
    • Certificates
    • Service
    • Integrated
    • Device
    • DeviceDict
    • Command execution
    • Terminal and SCP/SFTP
    • PromptDetectionStrategy
    • Upload parameters
    • CXD integration
    • Netconf
    • SNMP
    • Swagger and HTTP
    • Proxying
    • Device flow
    • Requests
    • Joining
    • Pipes
Previous Next

© Copyright 2018-2026 by Cisco Systems, Inc..

Built with Sphinx using a theme provided by Read the Docs.