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
  • Installation
  • Creating the InfiniBox Object
  • Authentication
  • Logging
  • Approving Dangerous Operations
  • Representing API Entities
  • Creating Objects
  • Object Attributes
  • Caching
  • Storage Capacity Handling
  • Querying Objects
  • Deleting Objects
  • Accessing HTTP/REST API Directly
• Querying Objects
  • Querying All Objects
  • Querying by Fields
  • Getting a Single Object
  • Advanced Queries
• 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
  • Getting System Name and Serial Number
  • Getting the System Model Name
  • Opening and Closing SSH Ports
• System Capacity
• Pools
  • Creating Pools
  • Updating Pools
  • Deleting Pools
  • Administered Pools
• Volumes
  • Creating and Modifying Volumes
  • Volume Serials
  • Moving Between Pools
  • Deleting Volumes
  • Example: Deleting All Volumes with Specific Name Prefix
• Filesystems
  • Creating a Filesystem
  • Moving Between Pools
  • Resizing Filesystems
  • Deleting Filesystems
  • Example: Deleting All Filesystems with Specific Name Prefix
• NFS Exports
  • Creating a Filesystem Export
  • Disabling an Export
  • Enabling an Export
  • Querying for Filesystem Exports
  • Export Permissions
  • Deleting an Export
  • Tree Quotas
• SMB Shares
  • Creating a Share
  • Share Permissions
• Working with Hosts, Clusters and Mappings
  • Creating Hosts
  • Adding/Removing FC Ports
  • Adding/Removing iSCSI IQNs
  • Querying Host by a Defined Port
  • Mapping and Unmapping Volumes and Snapshots
  • Querying Volume Mappings
  • Clusters and Hosts
• Snapshots
  • Creating Snapshots
  • Creating Group Snapshots
  • Querying Snapshots
  • Example: Deleting Snapshots by Creation Time
• Snapshot Policies
  • Creating a Policy
  • Creating a Schedule
  • Assigning Policies to Datasets
• Consistency Groups
  • Creating Consistency Groups
  • Adding and Removing Volumes
  • Creating Snapshot Groups
  • Restoring from Snapshot Group
  • Deleting Consistency Groups
• User Management
  • Users
  • LDAP Integration
• System Configuration
  • SMTP Configuration
  • SNMP Configuration
  • RSyslog Configuration
• Network Configuration
  • Network Spaces
• Replication
  • Creating Async Replicas
  • Replicating Consistency Groups
  • Creating Synchronous Replicas
  • Changing Replication Type
  • VVOL Replication
  • Initial Setup for VVOL Replication
  • Creating Replication Group
  • Creating a Replica (RgReplica)
• Using Object Metadata
  • Setting Metadata Keys
  • Getting Metadata Keys
  • Getting All Metadata Keys
  • Deleting (Unsetting) Metadata
• Events
  • Example: Getting all Events Newer than a Specific Sequence Number
• System Components
  • Nodes
  • Drives
  • FC Ports
  • Services
• Quality of Service
  • Introduction
  • Creation
  • Manipulation
  • Entities Assignment
  • Querying
  • Unassignment
  • Misc
• SMB Users and Groups
  • Creating a User
  • Creating a Group
  • Adding a User to a Group
  • Removing a User from a Group
  • Setting a User’s Primary Group
• Active Directory Domains
  • Joining a Domain
  • Leaving a Domain
• Extending InfiniSDK
  • Extending Objects with Methods
• Cookbook
  • Authentication
  • Objects
  • Error Handling
• Frequently Asked Questions
  • My Script is Performing Very Poorly. Why is That?
• 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
  • Query Preprocessors
  • Passing special values for fields
• Hooks
  • Overview
  • Available Hooks
• SMB Server Capabilities
  • Getting Current Server Capabilities
  • Updating Server Capabilities

Indices and tables

• Index

• Module Index

• Search Page