github.com/vmware/go-vmware-nsxt@v0.0.0-20230223012718-d31b8a1ca05e/README.md (about)

     1  
     2  
     3  # go-vmware-nsxt
     4  
     5  ## Overview
     6  A Go library for [Vmware NSX-T](https://docs.vmware.com/en/VMware-NSX-T/index.html) REST APIs.
     7  The library covers communication with NSX Manager, NSX Policy and NSX Upgrader.
     8  
     9  Most codebase was generated by [swagger-codegen](https://github.com/swagger-api/swagger-codegen) based on NSX-T 2.0 release.
    10  ## Try it out
    11  
    12  ### Prerequisites
    13  
    14  * make sure Go is installed and [GOPATH](https://golang.org/doc/code.html) is set correctly
    15  
    16  ### Build & Run
    17  
    18  1. go get -u github.com/vmware/go-vmware-nsxt
    19  2. go build
    20  
    21  ## Documentation
    22  
    23  ## Usage example
    24  
    25  Please refer to [terraform provider nsxt](https://github.com/terraform-providers/terraform-provider-nsxt).
    26  
    27  A good starting point would be looking at code [initializing the provider](https://github.com/terraform-providers/terraform-provider-nsxt/blob/master/nsxt/provider.go#L225).
    28  
    29  ## Releases & Major Branches
    30  
    31  ## Limitations
    32  
    33  Some APIs where request or response structure rely on resource_type attribute offer limited support.
    34  
    35  ## Contributing
    36  
    37  The go-vmware-nsxt project team welcomes contributions from the community. Before you start working with go-vmware-nsxt, please read our [Developer Certificate of Origin](https://cla.vmware.com/dco). All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch. For more detailed information, refer to [CONTRIBUTING.md](CONTRIBUTING.md).
    38  
    39  ## License
    40  
    41  go-vmware-nsxt is available under BSD-2 license.