InfiniSDK User’s Guide¶
Overview¶
InfiniSDK is Infinidat’s Official Python SDK for interacting with Infinidat storage products. It provides a clean interface for creating, deleting, querying and manipulating API objects.
Compatibility¶
InfiniSDK is designed to be compatible with the currently shipped version of InfiniBox, as well as prior releases which are under active support. Compatibility with future version is guaranteed only to a limited extent, especially regarding new or changed functionality.
Contents:
- Getting Started
- Querying Objects
- Efficient Querying
- The relationship with InfiniBox REST API
- Logging the REST API the script uses
- Improvement #1: Always use the find() function when querying for objects
- Improvement #2: Fetching necessary fields only
- Improvement #3: Fetching all necessary fields
- Improvement #4: Retrieve only necessary objects
- Improvement #5: Retrieve as many object with each API request as possible
- Improvement #6: Retrieve the top-most objects
- Improvement #7: Retrieve a single object
- The InfiniBox Object
- System Capacity
- Pools
- Volumes
- Filesystems
- NFS Exports
- SMB Shares
- Working with Hosts, Clusters and Mappings
- Snapshots
- Snapshot Policies
- Consistency Groups
- User Management
- System Configuration
- Network Configuration
- Replication
- Using Object Metadata
- Events
- System Components
- Quality of Service
- SMB Users and Groups
- Active Directory Domains
- Extending InfiniSDK
- Cookbook
- Frequently Asked Questions
- API Reference
- infinibox
- infinibox.api
- infinibox.datasets
- infinibox.volumes
- infinibox.filesystems
- infinibox.exports
- infinibox.shares
- infinibox.shares.permissions
- infinibox.replication_groups
- infinibox.rg_replicas
- infinibox.pools
- infinibox.hosts
- infinibox.clusters
- infinibox.replicas
- infinibox.links
- infinibox.network_spaces
- infinibox.events
- infinibox.users
- infinibox.ldap_configs
- infinibox.notification_targets
- infinibox.cons_groups
- infinibox.components
- infinibox.qos_policies
- infinibox.tenants
- infinibox.smb_groups
- infinibox.smb_users
- infinibox.snapshot_policies
- infinibox.snapshot_policies.schedules
- infinibox.active_directory_domains
- Base Objects
- Infinibox Utilities
- Core Facilities
- Exceptions
- Advanced Usage
- Hooks
- SMB Server Capabilities