cloud-sdk-go is the Cisco pxGrid Cloud SDK for the Go programming language.
The SDK lets you easily create applications for Cisco pxGrid Cloud and consume pxGrid, ERS and OpenAPI services from Cisco Identity Services Engine (ISE) devices.
- Multi-tenancy support
- Create an instance of an application
- Link application with a Cisco DNA - Cloud tenant
- Receive pxGrid topic messages from Cisco ISE devices
- Invoke HTTP APIs on Cisco ISE devices
- pxGrid APIs
- ERS APIs
- OpenAPI APIs
Currently, there is only SDK for Go. For integration with other languages, the HTTP APIs and WebSocket are described here:
go get github.com/cisco-pxgrid/cloud-sdk-goimport (
"fmt"
sdk "github.com/cisco-pxgrid/cloud-sdk-go"
)
// activationHandler is invoked when the app gets activated for a new device for a tenant
func activationHandler(device *sdk.Device) {
fmt.Printf("New device activated: %s\n", device)
}
// deactivationHandler is invoked when the app gets deactivated for an existing device for a tenant
func deactivationHandler(device *sdk.Device) {
fmt.Printf("Device deactivated: %s\n", device)
}
// messageHandler is invoked when there's a new message received by the app for a device
func messageHandler(id string, device *sdk.Device, stream string, payload []byte) {
fmt.Printf("Device message: %s, %s\n", stream, string(p))
}
// getCredentials is invoked whenever the app needs to retrieve the app credentials
func getCredentials() (*sdk.Credentials, error) {
return &sdk.Credentials{
ApiKey: []byte("api-key-obtained-during-app-onboarding"),
}, nil
}
func main() {
// create app configuration required for creating a new app instance
config := sdk.Config{
ID: "pxgrid-cloud-sample-app",
GetCredentials: getCredentials,
RegionalFQDN: "regional.cloud.cisco.com",
GlobalFQDN: "global.cloud.cisco.com",
DeviceActivationHandler: activationHandler,
DeviceDeactivationHandler: deactivationHandler,
DeviceMessageHandler: messageHandler,
ReadStreamID: "app--pxgrid-cloud-sample-app-R",
WriteStreamID: "app--pxgrid-cloud-sample-app-W",
}
app, err := sdk.New(config)
if err != nil {
fmt.Printf("Failed to create new app: %v", err)
os.Exit(1)
}
// make sure to Close() the app instance to release resources acquired during app creation
defer func() {
if err := app.Close(); err != nil {
fmt.Printf("Disconnected with error: %v", err)
}
}()
// wait for any errors from the app instance created above
err = <- app.Error
if err != nil {
fmt.Printf("%s received an error: %v", app, err)
}
}tenant, err := app.LinkTenant("otp-obtained-from-cisco-dna-portal")
// Securely store tenant.ID(), tenant.Name() and tenant.ApiToken()
err = app.UnlinkTenant(tenant)If the app needs to be restarted, use the stored tenant info to re-link.
tenant, err := app.SetTenant("tenant-id", "tenant-name", "tenant-api-token")If the app is registered as multi-instance, create and delete app instances can be used.
// With the parent app object, create an app instance
appInstance, err = app.CreateAppInstance(ac.Name)
// Securely store appInstance.ID(), appInstance.ApiKey()
// appInstance can then be used to link multiple tenants
tenant, err = appInstance.LinkTenant("otp-obtained-from-cisco-dna-portal")
// Prior to deleting app instance,
// ensure all ISE are deactivated from the app instance.
// After deactivating all ISE devices, tenants can be unlinked.
appInstance.UnlinkTenant(tenant)
// When all are unlinked, delete app instance with parent app.
app.DeleteAppInstance(appInstance.ID())ERS and OpenAPI URLs start with "/ers" and "/api" respectively.
req, _ := http.NewRequest(http.MethodGet, "/ers/config/op/systemconfig/iseversion", nil)
resp, err := device.Query(req)pxGrid API URLs start with "/pxgrid".
In order to invoke pxGrid APIs directly on the device, ServiceLookup is not required. Instead map the service name to the keyword and append it to the URL along with pxgrid
| pxGrid Service | pxGrid Cloud Service |
|---|---|
| com.cisco.ise.session | session |
| com.cisco.ise.config.anc | anc |
| com.cisco.ise.mdm | mdm |
| com.cisco.ise.config.profiler | profiler |
| com.cisco.ise.radius | radius |
| com.cisco.ise.trustsec | trustsec |
| com.cisco.ise.config.trustsec | trustsec |
| com.cisco.ise.sxp | trustsec |
| com.cisco.ise.echo | echo |
| com.cisco.ise.endpoint | endpoint |
// getSecurityGroups is an API from com.cisco.cise.config.trustsec service, so trustsec is used in the URL
req, _ := http.NewRequest(http.MethodPost, "/pxgrid/trustsec/getSecurityGroups", strings.NewReader("{}"))
resp, err := device.Query(req)There is a limitation on both request and response body size
| Size | From ISE versions |
|---|---|
| 500KB | 3.1p3, 3.2 |
| 50MB | 3.2p2, 3.3 |
| 2GB | 3.2p3, 3.3p1, 3.4 |
These are the mappings of pxGrid Cloud stream names from pxGrid topic
| pxGrid Service | pxGrid property name | pxGrid Cloud stream name |
|---|---|---|
| com.cisco.ise.session | sessionTopic | pxcloud--session-sessions |
| com.cisco.ise.session | groupTopic | pxcloud--session-userGroups |
| com.cisco.ise.config.anc | statusTopic | pxcloud--anc-operationStatus |
| com.cisco.ise.mdm | endpointTopic | pxcloud--mdm-endpoints |
| com.cisco.ise.config.profiler | topic | pxcloud--profiler-profiles |
| com.cisco.ise.radius | failureTopic | pxcloud--radius-failures |
| com.cisco.ise.trustsec | policyDownloadTopic | pxcloud--trustsec-policyDownloads |
| com.cisco.ise.config.trustsec | securityGroupTopic | pxcloud--trustsec-securityGroups |
| com.cisco.ise.config.trustsec | securityGroupAclTopic | pxcloud--trustsec-securityGroupAcls |
| com.cisco.ise.sxp | bindingTopic | pxcloud--trustsec-bindings |
| com.cisco.ise.echo | echoTopic | pxcloud--echo-echo |
| com.cisco.ise.endpoint | topic | pxcloud--endpoint-endpoints |
App: An app represents an application that's available on the Cisco DNA - Cloud App Store.Tenant: A tenant represents a Cisco customer that subscribes to and intends to use services Cisco DNA - Cloud services.Device: A device represents an on-premise entity (an appliance, a VM, a deployment, a cluster, etc.) that is registered with the Cisco DNA - Cloud. Cisco ISE is such an example.