gounity

README

gounity

A portable Go library for unity related operations such as create-volume, list-volume, etc.__

[TBD]

Documentation

Overview

Copyright (c) 2019 Dell EMC Corporation All Rights Reserved

Copyright (c) 2019 Dell EMC Corporation All Rights Reserved

Copyright (c) 2019 Dell EMC Corporation All Rights Reserved

Copyright (c) 2019 Dell EMC Corporation All Rights Reserved

Copyright (c) 2019 Dell EMC Corporation All Rights Reserved

Index

• Constants
• Variables
• func NewFilesystem(client *Client) *filesystem
• func NewHost(client *Client) *host
• func NewIpInterface(client *Client) *ipinterface
• func NewSnapshot(client *Client) *snapshot
• func NewStoragePool(client *Client) *storagepool
• func NewVolume(client *Client) *volume
• type AccessType
• type Client
  • func NewClient(ctx context.Context) (client *Client, err error)
  • func NewClientWithArgs(ctx context.Context, endpoint string, insecure bool) (client *Client, err error)
  • func (c *Client) Authenticate(ctx context.Context, configConnect *ConfigConnect) error
  • func (c *Client) GetToken() string
  • func (c *Client) SetToken(token string)
• type ConfigConnect
• type LicenseType
• type NFSShareDefaultAccess

Constants

const (
	ReadOnlyAccessType      = AccessType("READ_ONLY")
	ReadWriteAccessType     = AccessType("READ_WRITE")
	ReadOnlyRootAccessType  = AccessType("READ_ONLY_ROOT")
	ReadWriteRootAccessType = AccessType("READ_WRITE_ROOT")
)

const (
	NoneDefaultAccess          = NFSShareDefaultAccess("0")
	ReadOnlyDefaultAccess      = NFSShareDefaultAccess("1")
	ReadWriteDefaultAccess     = NFSShareDefaultAccess("2")
	ReadOnlyRootDefaultAccess  = NFSShareDefaultAccess("3")
	ReadWriteRootDefaultAccess = NFSShareDefaultAccess("4")
)

const (
	FsNameMaxLength = 63
)

Variables

var (
	HostNotFoundError          = errors.New("unable to find host")
	MultipleHostFoundError     = errors.New("Found multiple hosts with same name. Delete the duplicate entries on the array")
	MultipleHostFoundErrorCode = "0x7d13158"
)

var FilesystemNotFoundError = errors.New("Unable to find filesystem")

var VolumeNotFoundError = errors.New("Unable to find volume")

Functions

func NewFilesystem

func NewFilesystem(client *Client) *filesystem

func NewHost

func NewHost(client *Client) *host

func NewIpInterface

func NewIpInterface(client *Client) *ipinterface

func NewSnapshot

func NewSnapshot(client *Client) *snapshot

func NewStoragePool

func NewStoragePool(client *Client) *storagepool

func NewVolume

func NewVolume(client *Client) *volume

Types

type AccessType

type AccessType string

type Client

type Client struct {
	// contains filtered or unexported fields
}

Struct holds the configuration & REST Client.

func NewClient

func NewClient(ctx context.Context) (client *Client, err error)

NewClient initialize the new REST Client with default options.

func NewClientWithArgs

func NewClientWithArgs(ctx context.Context, endpoint string, insecure bool) (client *Client, err error)

NewClientWithArgs initialize the new REST Client with the given arguments.

func (*Client) Authenticate

func (c *Client) Authenticate(ctx context.Context, configConnect *ConfigConnect) error

Authenticate make a REST API call [/loginSessionInfo] to Unity to get authenticate the given credentials. The response contains the EMC-CSRF-TOKEN and the client caches it for further communication.

func (*Client) GetToken

func (c *Client) GetToken() string

func (*Client) SetToken

func (c *Client) SetToken(token string)

type ConfigConnect

type ConfigConnect struct {
	Endpoint string
	Username string
	Password string
}

Struct holds the endpoint & credential info.

type LicenseType

type LicenseType string

const (
	LunNameMaxLength             = 63
	ThinProvisioning LicenseType = "THIN_PROVISIONING"
	DataReduction    LicenseType = "DATA_REDUCTION"
)

type NFSShareDefaultAccess

type NFSShareDefaultAccess string