gounity

README

gounity

gounity work as the golang library for Unity Storage Systems.

Documentation

Overview

Package gounity provides the Golang API for Unity Storage Systems.

The library communicates with Unity with REST API.

Index

• type Unity
  • func New(ip, username, password string) (Unity, error)
  • func NewWithConn(conn *rsc.Connection) (Unity, error)

Types

type Unity

type Unity interface {
	// Ip returns the IP address of the connected system.
	Ip() string

	// Username returns the current user used for REST connection.
	Username() string

	// GetPoolList returns all pools on the system
	GetPoolList() *rsc.PoolList

	// GetPoolByName retrieves the storage pool instance by name.
	// Return nil if not found.
	GetPoolByName(name string) *rsc.Pool

	// GetPoolById retrieves the storage pool instance by id.
	// Returns nil if not found.
	GetPoolById(id string) *rsc.Pool

	// GetLunList returns all LUNs on the system
	GetLunList() *rsc.LunList

	// GetLunByName retrieves the LUN instance by name.
	// Returns nil if not found.
	GetLunByName(name string) *rsc.Lun

	// GetLunById retrieves the LUN instance by id.
	// Returns nil if not found.
	GetLunById(id string) *rsc.Lun

	// GetHostList retrieves all hosts available on the system.
	GetHostList() *rsc.HostList

	// GetHostById retrieves the host by id
	// Returns nil if not found.
	GetHostById(id string) *rsc.Host

	// GetHostByName retrieves the host by name
	// Returns nil if not found.
	GetHostByName(name string) *rsc.Host

	// CreateHost creates a host instance on the system
	CreateHost(name string) (*rsc.Host, error)
}

func New

func New(ip, username, password string) (Unity, error)

New creates a new Unity storage system instance.

func NewWithConn

func NewWithConn(conn *rsc.Connection) (Unity, error)