f5-rest-client

module
v1.0.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 19, 2024 License: BSD-3-Clause

README

f5-rest-client

GoDoc License

f5-rest-client implements a REST client to query the F5 Big IP API.

Installation

go get -u github.com/e-XpertSolutions/f5-rest-client/f5

Usage

package main

import (
	"log"

	"github.com/e-XpertSolutions/f5-rest-client/f5"
	"github.com/e-XpertSolutions/f5-rest-client/f5/ltm"
)

func main() {
	// setup F5 BigIP client
	f5Client, err := f5.NewBasicClient("https://url-to-bigip", "user", "password")
	if err != nil {
		log.Fatal(err)
	}

	// setup client for the LTM API
	ltmClient := ltm.New(f5Client)

	// query the /ltm/virtual API
	vsConfigList, err := ltmClient.Virtual().ListAll()
	if err != nil {
		log.Fatal(err)
	}
	log.Print(vsConfigList)
}

Features

  • Add support for HTTP Basic Authentication
  • Add support for token based authentication
  • Add support for authentication through external providers
  • Manage Virtual Server, pool, node, irules, monitors (/ltm)
  • Manage Cluster Management (/cm)
  • Manage interfaces, vlan, trunk, self ip, route, route domains (/net)
  • Manage system related stuffs (/sys)
  • Manage firewall, WAF and DOS profiles (/security)
  • Manage virtualization features (/vcmp)
  • Manage access policies (/apm)
  • Manage DNS and global load balancing servers (/gtm)
  • Add support for analytics read-only API (/analytics)
  • Add support for results pagination
  • Add support for transaction

Contributing

We appreciate any form of contribution (feature request, bug report, pull request, ...). We have no special requirements for Pull Request, just follow the standard GitHub way.

License

The sources are release under a BSD 3-Clause License. The full terms of that license can be found in LICENSE file of this repository.

Directories

Path Synopsis
cmd
resgen
resgen is a small CLI tool that automatically generates Resource from an API.
resgen is a small CLI tool that automatically generates Resource from an API.
f5
Package f5 provides a client for using the F5 API.
Package f5 provides a client for using the F5 API.
apm
asm
cm
gtm
ltm
Package ltm provides a REST client for the /tm/ltm F5 BigIP API.
Package ltm provides a REST client for the /tm/ltm F5 BigIP API.
net
sys

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL