Go library for VMware vSphere NSX API
Clone or download
Permalink
Failed to load latest commit information.
Godeps
api Adding firewall exclusion Jan 19, 2018
cli
docker
examples
vendor
.gitignore
CONTRIBUTING.md
Dockerfile
Jenkinsfile
LICENSE
Makefile Changed virtualwire create and update to take a struct and implemente… Jul 4, 2017
README.md
VERSION
client.go edgeinterface example updated (#21) Jun 28, 2017
client_dhcprelay_test.go
client_security_tags_test.go
client_test.go
client_tzone_test.go
client_virtualwire_test.go
docker-compose.yml

README.md

GoNSX - Go library for VMware vSphere NSX API

Overview

This project is a NSXClient library for talking to NSX API.

Features

Feature Create Read Update Delete
DHCP Relay Y Y Y Y
Edge Interface Y Y Y Y
Security Group Y Y Y Y
Security Policy Y Y Y Y
Security Tag Y Y Y Y
Security Tag Attachment Y Y Y Y
Service Y Y Y Y
Transport Zone N Y N N
Virtual Wire Y Y Y Y

Implementation of CRUD in above features is partial in some cases.

Security Policy features

Function Attribute Implemented Required
Common Name (String) Y Y
Description (String) Y Y
Inherit Security Policy (Boolean) N N/A
Parent Policy (String) N N/A
Weight/Precedence (Integer) Y Y
Guest Introspection Services List (String) N N/A
Name (String) N N/A
Action (String) N N/A
Service Type (String) N N/A
Service Name (String ) N N/A
Service Profile (String) N N/A
State (String) N N/A
Enforce (Boolean) N N/A
Firewall rule Name (String) Y Y
Description (String) Y Y
Action (String) Y Y
Policy Security Groups (String[]) Y Y
Negate Source (Boolean) N N
Destination (String[]) Y Y
Service (String[]) Y Y
*State (String) Y Y
Log (Boolean) N N/A
Network Introspection Service Name (String) N N/A
Description (String) N N/A
Action (String) N N/A
Service Name (String) N N/A
Profile (String) N N/A
Source (String[]) N N/A
NegateSource (Boolean) N N/A
Destination (String[]) N N/A
NegateDestination (Boolean) N N/A
Service (String) N N/A
State (String) N N/A
Log (Boolean) N N/A

*State is defaulted to true in all cases and can't be modified.

Security Group features

Apart from the basic CRUD functionality the Security Group supports the following

Component Funcionality Name GONSX
Security Group Add Multiple Dynamic Membership Criteria Y
OS Name Y
Computer Name Y
VM Name Y
Security Tag Y
Entity : This could be Y
- Another Security Group Y
- Cluster Y
- Logical Switch Y
- Logical Port Group Y
- vApp Y
- IP Sets Y
- Directory Group Y
- MAC Sets Y
- Security Tag Y
- vNic Y
- Virtual Machine Y
- Resource Pool Y
- Distributed Port Group Y
Security Group Add More than one Dynamic Membership criteria y
Security Group Operators for more than one Dynamic Membership criteria N
Security Group Static Membership (always add these ) N
Security Group N
Cluster N
Logical Switch N
Logical Port Group N
vApp N
Datacenter N
IP Sets N
MAC Sets N
Security Tag N
Directory Group N
vNic N
Virtual Machine N
Resource Pool N
Distributed Port Group N
Security Group Static Exclusions (always exclude these ) N
Security Group N
Cluster N
Logical Switch N
Logical Port Group N
vApp N
Datacenter N
IP Sets N
MAC Sets N
Security Tag N
Directory Group N
vNic N
Virtual Machine N
Resource Pool N
Distributed Port Group N
Security Group Static Exclusions (never include) N
Security Group N
Cluster N
Logical Switch N
Logical Port Group N
vApp N
Datacenter N
IP Sets N
MAC Sets N
Security Tag N
Directory Group N
vNic N
Virtual Machine N
Resource Pool N
Distributed Port Group N

NOTE:

Security Group - Add Multiple Dynamic Membership Criteria
This functionality is implemented partially, this is not accounted when creating , however we can do it while editing.

Usage

NSXClient

The NSXClient is the class used to send requests to the NSX host and pass through credentials.

Import the following files.

To create an NSX object run the following code, with the correct params.

import (
    "github.com/sky-uk/gonsx"
)

nsxclient := gonsx.NewNSXClient(url, username, password, ignoreSSL, debug)

The params used:

  • url: URL of NSX host

E.G. https://nsxhost.com

  • username: NSX username
  • password: NSX password
  • ignoreSSL: bool on whether to ignore ssl (default false)
  • debug: bool on whether to debug output (default false)

The client is also used run the api calls once you have created the resource object.

nsxclient.Do(my_resource_obj)

Virtual Wire(Logical Switch)

Virtual Wire resource. This resource will call the Virtual Wires api within NSX. Import the following class:

github.com/sky-uk/gonsx/api/virtualwire

Create:

 api := virtualwire.NewCreate(virtualWireCreateSpec, scopeID)
 nsxclient.Do(api)

Read:

api := virtualwire.NewGetAll(scopeID)
nsxclient.Do(api)
resp := api.GetResponse().FilterByName(virtualWireName)

Read single virtualwire:

api := virtualwire.NewGet(virtualwireID)
nsxclient.Do(api)
resp := api.GetResponse()

Update:

api := virtualwire.NewUpdate(name, desc, virtualwireID)
nsxclient.Do(api)

Delete:

api := virtualwire.NewDelete(virtualWireID)
nsxclient.Do(delete_api)

Edge Interface

Interface resource. This resource will call the interface api within NSX. Import the following class:

github.com/sky-uk/gonsx/api/edgeinterface

Create:

 api := edgeinterface.NewCreate(&edgeInterfaces, edgeId)
 nsxclient.Do(api)
 createdEdgeInterfaces := api.GetResponse()

Read:

api := edgeinterface.NewGet((edgeid, index)
nsxclient.Do(api)
edge := api.GetResponse()

Update:

api := edgeinterface.NewUpdate(edgeid, index, edge)
nsxclient.Do(api)

Delete:

api := edgeinterface.NewDelete(edgeid, index)
nsxclient.Do(api)

Dhcp Relay

DHCP resource. This resource will call the DHCP relay api within NSX. Import the following class:

github.com/sky-uk/gonsx/api/dhcprelay

The Dhcp relay behaves differently in the API and as such it doesn't have a create and only an update and delete. The delete function will remove the whole relay and all of its information. If you do not wish to do this and only remove interfaces from the DHCP relay, then you must run an update instead.

Read:

api := dhcp.NewGetAll(edgeId)
nsxclient.Do(api)

Update:

api := dhcprelay.NewUpdate(dhcpIpAddress, edgeId, relayAgentslist)
nsxclient.Do(api)

Delete:

api := dhcprelay.NewDelete(edgeId)
nsxclient.Do(api)

Security Tag

Security tag resource. This resource will call the security tag api within NSX. Import the following class:

github.com/sky-uk/gonsx/api/securitytag

Create:

api := securitytag.NewCreate(name, desc)
nsxclient.Do(api)

Read:

api := securitytag.NewGetAll()
nsxclient.Do(api)

Update:

Not yet implemented

Delete:

api := securitytag.NewDelete(securitytagID)
nsxclient.Do(api)

Detach:

api := securitytag.NewDetach(securityTagID, vmID)
nsxclient.Do(api)

Attach:

api := securitytag.NewAttach(securityTagID, vmID)
nsxclient.Do(api)

Service

Service resource. This resource will call the service api with NSX. Import the following class:

github.com/sky-uk/gonsx/api/service

Create:

api := service.NewCreate(scopeID, name, desc, proto, ports)
nsxclient.Do(api)

Read:

api := service.NewGetAll(scopeID)
nsxclient.Do(api)

Update:

Not yet implemented

Delete:

api := service.NewDelete(serviceID)
nsxclient.Do(api)

Security Group

Security Group resource. This resource will call the security group api with NSX. Import the following class:

github.com/sky-uk/gonsx/api/securitygroup

Create:

api := securitygroup.NewCreate(scopeID, name, setOperator, criteriaOperator, criteriaKey, criteriaValue, criteria)
nsxclient.Do(api)

Read:

api := securitygroup.NewGetAll(scopeID)
nsxclient.Do(api)

Update:

Not yet implemented

Delete:

api := securitygroup.NewDelete(serviceID)
nsxclient.Do(api)

Security Policy

Security Policy resource. This resource will call the security policy with NSX. Import the following class:

github.com/sky-uk/gonsx/api/securitypolicy

Create:

api := securitypolicy.NewCreate(name, precendence, desc, securityGroupsIDs, actions)
nsxclient.Do(api)

Read:

api := securitypolicy.NewGetAll()
nsxclient.Do(api)

Update:

Not yet implemented

Delete:

api := securitypolicy.NewDelete(securityPolicyID, force)
nsxclient.Do(api)

AddOutboundFirewall:

securityPolicyToModify := getAllAPI.GetResponse().FilterByName(securityPolicyName)

// we will use a help function to add a firewall rule.
securityPolicyToModify.AddOutboundFirewallAction(
	firewallName,
	action,
	direction,
	secGroupObjectIDs,
	serviceIDs,
)

updateAPI := securitypolicy.NewUpdate(securityPolicyToModify.ObjectID, securityPolicyToModify)
nsxclient.Do(updateAPI)

RemoveFirewall:

securityPolicyToModify := getAllAPI.GetResponse().FilterByName(securityPolicyName)

securityPolicyToModify.RemoveFirewallActionByName(firewallName)

updateAPI := securitypolicy.NewUpdate(securityPolicyToModify.ObjectID, securityPolicyToModify)
nsxclient.Do(updateAPI)