README
¶
mso-go-client
This repository contains the golang client SDK to interact with Cisco MSO/NDO using REST API calls. This SDK is used by terraform-provider-mso.
Installation
Use go get to retrieve the SDK to add it to your GOPATH workspace, or project's Go module dependencies.
$go get github.com/ciscoecosystem/mso-go-client
There are no additional dependancies needed to be installed.
Overview
-
client :- This package contains the HTTP Client configuration as well as service methods which serves the CRUD operations on the configuration objects in Cisco MSO/NDO.
-
models :- This package contains all the models structs and utility methods for the same.
-
tests :- This package contains the unit tests for the CRUD operations that can be performed on the configuration objects.
How to Use
import the client in your go application and retrive the client object by calling client.GetClient() method.
import github.com/ciscoecosystem/mso-go-client/client
client.GetClient("URL", "Username", client.Password("Password"), client.Insecure(true/false))
mso-go-client also supports running against NDO or ND-based MSO. To use against an ND based authentication call the GetClient method as follows.
client.GetClient("URL", "Username", client.Password("Password"), client.Insecure(true/false), client.Platform("nd"))
Use that client object to call the service methods to perform the CRUD operations on the configuration objects.
Example,
client.Save("api/v1/tenants", models.NewTenant(TenantAttributes))
# TenantAttributes is struct present in models/tenant.go
Directories