Skip to content

References

This document contains references and resources related to the VMware vRA CLI project, including official documentation, APIs, and community resources.

Official VMware/Broadcom Resources

API Documentation

  • Broadcom vRealize Orchestrator API
  • Complete REST API reference for vRealize Orchestrator
  • Workflow execution, management, and monitoring
  • Tag management and resource operations
  • Authentication and security best practices

  • VMware vRealize Automation 8.x API

  • Service Catalog APIs for catalog item management
  • Deployment lifecycle management APIs
  • Project and resource management endpoints
  • Integration patterns and examples

Documentation Centers

  • VMware vRealize Automation Documentation
  • Installation and configuration guides
  • Administrator and user guides
  • Troubleshooting and best practices
  • Release notes and compatibility matrices

  • Broadcom Support Portal

  • Knowledge base articles
  • Product downloads and patches
  • Community forums and discussions
  • Support case management

Development Resources

Python Libraries and Tools

  • Click Documentation
  • Command-line interface creation toolkit
  • Advanced features and patterns
  • Testing CLI applications

  • Pydantic Documentation

  • Data validation and serialization
  • Type hints and model validation
  • JSON schema generation

  • Requests Documentation

  • HTTP library for API interactions
  • Session management and authentication
  • Error handling and retries

  • Rich Documentation

  • Terminal formatting and display
  • Progress bars and status indicators
  • Tables and syntax highlighting

Testing and Quality

Community and Learning

VMware Community

Learning Resources

Standards and Specifications

REST API Standards

  • OpenAPI Specification
  • API design and documentation standards
  • Schema definitions and validation
  • Code generation tools

  • JSON Schema

  • Data validation specifications
  • Schema composition and referencing
  • Validation tools and libraries

Security Standards

Tools and Utilities

API Development and Testing

  • Postman
  • API development and testing platform
  • Collection sharing and collaboration
  • Automated testing and monitoring

  • HTTPie

  • Command-line HTTP client
  • Simple syntax for API testing
  • JSON and authentication support

Documentation Tools

  • MkDocs Material Theme
  • Material Design documentation theme
  • Advanced features and customization
  • Plugin ecosystem and extensions

  • Mermaid

  • Diagram and flowchart generation
  • Markdown integration
  • Various diagram types and styles

Version Information

This CLI tool is designed to work with:

  • VMware vRealize Automation: 8.x series
  • VMware vRealize Orchestrator: 8.x series
  • Python: 3.10+ (as per project requirements)
  • API Versions: Latest stable releases

Contributing to References

If you find additional resources that would benefit the community, please:

  1. Verify the resource is official and maintained
  2. Ensure it's relevant to VMware vRA CLI usage or development
  3. Submit a pull request with the new reference
  4. Include a brief description of the resource's value

This references page is maintained to provide developers and users with comprehensive resources for working with VMware vRealize Automation and related technologies.