Jump To Close Expand all Collapse all Table of contents Console Developer Guide I. Introduction Expand section "I. Introduction" Collapse section "I. Introduction" 1. Introduction Expand section "1. Introduction" Collapse section "1. Introduction" 1.1. Representational State Transfer 1.2. Prerequisites 2. Authentication and Security Expand section "2. Authentication and Security" Collapse section "2. Authentication and Security" 2.1. TLS/SSL Certification 2.2. HTTP Authentication 2.3. Authentication Sessions 3. REST API Quick Start Examples Expand section "3. REST API Quick Start Examples" Collapse section "3. REST API Quick Start Examples" 3.1. Example: Access API Entry Point 3.2. Example: List Cluster Collection 3.3. Example: List Host Collection 3.4. Example: Add Host to Cluster 3.5. Example: Create Volume 3.6. Example: List Volume Collection 3.7. Example: Start Volume 3.8. Example: List Brick Collection 3.9. Example: Add Bricks to Volume 3.10. Example: Check System Events 4. Python Quick Start Example Expand section "4. Python Quick Start Example" Collapse section "4. Python Quick Start Example" 4.1. Python Quick Start Introduction 4.2. Example: Accessing the API Entry Point using Python II. REST Application Programming Interface Expand section "II. REST Application Programming Interface" Collapse section "II. REST Application Programming Interface" 5. Entry Point Expand section "5. Entry Point" Collapse section "5. Entry Point" 5.1. Product Information 5.2. Link elements 5.3. Summary element 5.4. RESTful Service Description Language (RSDL) 6. Capabilities Expand section "6. Capabilities" Collapse section "6. Capabilities" 6.1. Version-Dependent Capabilities 6.2. Current Version 6.3. Red Hat Storage Volume Types 6.4. Red Hat Storage Transport Types 6.5. Step Type 6.6. Gluster Hook Content Type 6.7. Gluster Hook Stage 6.8. Resource Status States 7. Common Features Expand section "7. Common Features" Collapse section "7. Common Features" 7.1. Representations 7.2. Collections Expand section "7.2. Collections" Collapse section "7.2. Collections" 7.2.1. Listing All Resources in a Collection 7.2.2. Listing Extended Resource Sub-Collections 7.2.3. Searching Collections with Queries 7.2.4. Creating a Resource in a Collection 7.3. Resources Expand section "7.3. Resources" Collapse section "7.3. Resources" 7.3.1. Retrieving a Resource 7.3.2. Updating a Resource 7.3.3. Deleting a Resource 7.3.4. Sub-Collection Relationships 7.3.5. XML Element Relationships 7.3.6. Actions 7.3.7. Permissions 7.3.8. Handling Errors 8. Clusters Expand section "8. Clusters" Collapse section "8. Clusters" 8.1. Networks Sub-Collection 8.2. Gluster Hooks Expand section "8.2. Gluster Hooks" Collapse section "8.2. Gluster Hooks" 8.2.1. Managing Gluster Hooks 9. Hosts Expand section "9. Hosts" Collapse section "9. Hosts" 9.1. Network Interface Sub-Collection Expand section "9.1. Network Interface Sub-Collection" Collapse section "9.1. Network Interface Sub-Collection" 9.1.1. Bonded Interfaces 9.1.2. Network Interface Statistics 9.1.3. Attach Action 9.1.4. Detach Action 9.2. Statistics Sub-Collection 9.3. Actions Expand section "9.3. Actions" Collapse section "9.3. Actions" 9.3.1. Install Action 9.3.2. Activate Action 9.3.3. Fence Action 9.3.4. Deactivate Action 9.3.5. Commit Network Configuration Action 10. Volumes Expand section "10. Volumes" Collapse section "10. Volumes" 10.1. Creating a Volume 10.2. Listing Volumes 10.3. Managing Volumes Expand section "10.3. Managing Volumes" Collapse section "10.3. Managing Volumes" 10.3.1. Starting a Volume 10.3.2. Stopping a Volume 10.3.3. Removing a Volume 10.3.4. Setting a Volume Option 10.3.5. Resetting a Volume Option 10.3.6. Resetting all Volume Options 10.3.7. Rebalancing Volume 10.4. Managing Bricks Expand section "10.4. Managing Bricks" Collapse section "10.4. Managing Bricks" 10.4.1. Listing of Bricks 10.4.2. Adding a Brick 10.4.3. Removing a Brick 11. Groups 12. Roles Expand section "12. Roles" Collapse section "12. Roles" 12.1. Permits Sub-Collection 13. Users 14. Events Expand section "14. Events" Collapse section "14. Events" 14.1. Searching Events 14.2. Paginating Events III. Python Software Development Kit Expand section "III. Python Software Development Kit" Collapse section "III. Python Software Development Kit" 15. Software Development Kit Overview Expand section "15. Software Development Kit Overview" Collapse section "15. Software Development Kit Overview" 15.1. Introduction to the Red Hat Storage Software Development Kit 15.2. Software Development Kit Prerequisites 15.3. Installing the Software Development Kit 16. Using the Software Development Kit Expand section "16. Using the Software Development Kit" Collapse section "16. Using the Software Development Kit" 16.1. Connecting to the API Using Python 16.2. Listing the Public Attributes of a Resource 16.3. Resources and Collections 16.4. Retrieving Resources from a Collection Expand section "16.4. Retrieving Resources from a Collection" Collapse section "16.4. Retrieving Resources from a Collection" 16.4.1. Retrieving a Specific Resource from a Collection 16.4.2. Retrieving a List of Resources from a Collection 16.5. Adding a Resource to a Collection 16.6. Updating a Resource in a Collection 16.7. Removing a Resource from a Collection 16.8. Handling Errors 17. Python Reference Documentation Expand section "17. Python Reference Documentation" Collapse section "17. Python Reference Documentation" 17.1. Python Reference Documentation A. SDK Examples Expand section "A. SDK Examples" Collapse section "A. SDK Examples" A.1. Common Functions and Wrappers A.2. Python SDK Example: Hosts A.3. Python SDK Example: Cluster A.4. Python SDK Example: Volumes A.5. Python SDK Example: Bricks A.6. Python SDK Example: Permissions A.7. Python SDK Example: Users A.8. Python SDK Example: Hooks B. API Usage with cURL C. Event Codes Expand section "C. Event Codes" Collapse section "C. Event Codes" C.1. Event Codes D. Java Keystores E. Certificates Expand section "E. Certificates" Collapse section "E. Certificates" E.1. Creating SSL/TLS Certificates E.2. Creating an SSL Certificate E.3. Configuring HTTPS Communication E.4. Network Security Services (NSS) Database E.5. Java Keystores F. Revision History Legal Notice Settings Close Language: English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Language and Page Formatting Options Language: English Format: Multi-page Single-page PDF Format: Multi-page Single-page PDF Red Hat Training A Red Hat training course is available for Red Hat Gluster Storage Part III. Python Software Development Kit Previous Next