Quickstart

catalystcenter-go-sdk is a Go client library for Catalyst Center Platform.

Usage

import catalyst "github.com/cisco-en-programmability/catalystcenter-go-sdk/v3/sdk"

Introduction

The catalystcenter-go-sdk makes it easier to work with the Catalyst Center Platform RESTFul APIs from Go.

It supports version 2.3.7.6, but it is backward compatible with other versions as long as those versions use the same URLs and options as version 2.3.7.6.

Getting started

The first step is to generate an API client. There are two options to do it:

1. Parameters
2. Environment variables

Parameters

The following parameters could generate the client:

• baseURL: The base URL, FQDN or IP, of the Catalyst Center instance.
• username: The username for the API authentication and authorization.
• password: The password for the API authentication and authorization.
• debug: Boolean to enable debugging
• sslVerify: Boolean to enable or disable SSL certificate verification.
• waitTimeToManyRequest: Time in minutes SDK will wait after API responds with 429 status code (to many requests) it defaults is in 1 minute.

Client, err = catalyst.NewClientWithOptions("https://sandboxdnac.cisco.com",
    "devnetuser", "Cisco123!",
    "false", "false", nil)
devicesCount, _, err := Client.Devices.GetDeviceCount()

Using environment variables

You can configure the client using the environment variables:

• CATALYST_BASE_URL: The base URL, FQDN or IP, of the Catalyst Center instance.
• CATALYST_USERNAME: The username for the API authentication and authorization.
• CATALYST_PASSWORD: The password for the API authentication and authorization.
• CATALYST_DEBUG: Boolean to enable debugging
• CATALYST_SSL_VERIFY: Boolean to enable or disable SSL certificate verification.
• CATALYST_WAIT_TIME: Time in minutes SDK will wait after API responds with 429 status code (to many requests) it defaults is in 1 minute.

Client, err = catalyst.NewClient()
devicesCount, _, err := Client.Devices.GetDeviceCount()

Examples

Here is an example of how we can generate a client, get a device count and then a list of devices filtering them using query params.

Client, err = catalyst.NewClientWithOptions("https://sandboxdnac.cisco.com",
    "devnetuser", "Cisco123!",
    "false", "false",nil)
devicesCount, _, err := Client.Devices.GetDeviceCount()
if err != nil {
    fmt.Println(err)
}
fmt.Println("Device Count:", devicesCount.Response)
getDeviceListQueryParams = &catalyst.GetDeviceListQueryParams{
    PlatformID: []string{"C9300-24UX"},
}
fmt.Println("Printing device list  ... PlatformID is C9300-24UX")
devices, _, err = Client.Devices.GetDeviceList(getDeviceListQueryParams)
if err != nil {
    fmt.Println(err)
}
if devices.Response != nil {
    for id, device := range *devices.Response {
        fmt.Println("GET:", id, device.ID, device.MacAddress, device.ManagementIPAddress, device.PlatformID)
    }
}

Documentation

catalystcenter-go-sdk/v2

catalystcenter-go-sdk

Compatibility matrix

Changelog

All notable changes to this project will be documented in the CHANGELOG file.

The development team may make additional name changes as the library evolves with the Catalyst Center APIs.

License

This library is distributed under the MIT license found in the LICENSE file.