Skip to content

EfficientIP-Labs/solidserver-go-client

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
sdsclient
sdsclient
 
 
.gitignore
.gitignore
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
go.mod
go.mod
 
 
go.sum
go.sum
 
 

Repository files navigation

Go API client for sdsclient

OpenAPI 3.0.2 API definition for SOLIDserver service from EfficientIP.

Copyright © 2000-2024 EfficientIP

All specifications and information regarding the products in this document are subject to change without notice and should not be construed as a commitment by EfficientIP. EfficientIP assumes no responsibility or liability for any mistakes or inaccuracies that may appear in this document. All statements and recommendations in this document are believed to be accurate but are presented without warranty. Users must take full responsibility for their application of any product.

This document aims at detailing EfficientIP proprietary solutions. As our solutions rely on several third-party products, created by other companies or organizations, it may redirect readers to third-party websites and documentation for further information. In such a case, EfficientIP cannot be liable or expected to provide said information on products they do maintain or created.

Generated (Friday 4th of October 2024 03:41:11 PM)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import "github.com/efficientIP-Labs/solidserver-go-client/sdsclient"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sdsclient.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sdsclient.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sdsclient.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sdsclient.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sdsclient.ContextOperationServerIndices and sdsclient.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sdsclient.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sdsclient.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://sds-ip-or-name:443/api/v2.0

Class Method HTTP request Description
AppAPI AppApplicationAdd Post /app/application/add Add an application
AppAPI AppApplicationCount Get /app/application/count Count the number of applications
AppAPI AppApplicationDelete Delete /app/application/delete Delete an application
AppAPI AppApplicationEdit Put /app/application/edit Edit an application
AppAPI AppApplicationInfo Get /app/application/info Display the properties of an application
AppAPI AppApplicationList Get /app/application/list List the applications
AppAPI AppNodeAdd Post /app/node/add Add a node
AppAPI AppNodeCount Get /app/node/count Count the number of nodes
AppAPI AppNodeDelete Delete /app/node/delete Delete a node
AppAPI AppNodeEdit Put /app/node/edit Edit a node
AppAPI AppNodeInfo Get /app/node/info Display the properties of a node
AppAPI AppNodeList Get /app/node/list List the nodes
AppAPI AppPoolAdd Post /app/pool/add Add a pool
AppAPI AppPoolCount Get /app/pool/count Count the number of pools
AppAPI AppPoolDelete Delete /app/pool/delete Delete a pool
AppAPI AppPoolEdit Put /app/pool/edit Edit a pool
AppAPI AppPoolInfo Get /app/pool/info Display the properties of a pool
AppAPI AppPoolList Get /app/pool/list List the pools
DeviceAPI DeviceDeviceAdd Post /device/device/add Add a Device Manager device
DeviceAPI DeviceDeviceCount Get /device/device/count Count the number of Device Manager devices
DeviceAPI DeviceDeviceDelete Delete /device/device/delete Delete a Device Manager device
DeviceAPI DeviceDeviceEdit Put /device/device/edit Add a Device Manager device
DeviceAPI DeviceDeviceInfo Get /device/device/info Display the properties of a Device Manager device
DeviceAPI DeviceDeviceList Get /device/device/list List the Device Manager devices
DeviceAPI DeviceInterfaceAdd Post /device/interface/add Add a Device Manager port or interface
DeviceAPI DeviceInterfaceCount Get /device/interface/count Count the number Device Manager ports & interfaces
DeviceAPI DeviceInterfaceDelete Delete /device/interface/delete Delete a Device Manager port or interface
DeviceAPI DeviceInterfaceEdit Put /device/interface/edit Add a Device Manager port or interface
DeviceAPI DeviceInterfaceInfo Get /device/interface/info Display the properties of a Device Manager port or interface
DeviceAPI DeviceInterfaceList Get /device/interface/list List the Device Manager ports & interfaces
DeviceAPI DeviceLinkAdd Post /device/link/add Link two Device Manager devices using their ports and/or interfaces
DeviceAPI DeviceLinkCount Get /device/link/count Count the number of links between Device Manager devices
DeviceAPI DeviceLinkDelete Delete /device/link/delete Delete a link between two Device Manager devices
DeviceAPI DeviceLinkEdit Put /device/link/edit Link two Device Manager devices using their ports and/or interfaces
DeviceAPI DeviceLinkList Get /device/link/list List Device Manager ports & interfaces
DhcpAPI DhcpAcl6Count Get /dhcp/acl6/count Count the number of DHCPv6 ACLs
DhcpAPI DhcpAcl6Info Get /dhcp/acl6/info Display the properties of a DHCPv6 ACL
DhcpAPI DhcpAcl6List Get /dhcp/acl6/list List the DHCPv6 ACLs
DhcpAPI DhcpAclCount Get /dhcp/acl/count Count the number of DHCP ACLs
DhcpAPI DhcpAclInfo Get /dhcp/acl/info Display the properties of a DHCP ACL
DhcpAPI DhcpAclList Get /dhcp/acl/list List the DHCP ACLs
DhcpAPI DhcpAclentry6Count Get /dhcp/aclentry6/count Count the number of DHCPv6 ACL entries
DhcpAPI DhcpAclentry6Info Get /dhcp/aclentry6/info Display the properties of a DHCPv6 ACL entry
DhcpAPI DhcpAclentry6List Get /dhcp/aclentry6/list List the DHCPv6 ACL entries
DhcpAPI DhcpAclentryCount Get /dhcp/aclentry/count Count the number of DHCP ACL entries
DhcpAPI DhcpAclentryInfo Get /dhcp/aclentry/info Display the properties of a DHCP ACL entry
DhcpAPI DhcpAclentryList Get /dhcp/aclentry/list List the DHCP ACL entries
DhcpAPI DhcpFailoverCount Get /dhcp/failover/count Count the number of DHCPv4 failover channels
DhcpAPI DhcpFailoverInfo Get /dhcp/failover/info Display the properties of a DHCPv4 failover channel
DhcpAPI DhcpFailoverList Get /dhcp/failover/list List the DHCPv4 failover channels
DhcpAPI DhcpGroup6List Get /dhcp/group6/list List the DHCPv6 groups
DhcpAPI DhcpGroupAdd Post /dhcp/group/add Add a DHCPv4 group
DhcpAPI DhcpGroupCount Get /dhcp/group/count Count the number of DHCPv4 groups
DhcpAPI DhcpGroupDelete Delete /dhcp/group/delete Delete a DHCPv4 group
DhcpAPI DhcpGroupEdit Put /dhcp/group/edit Add a DHCPv4 group
DhcpAPI DhcpGroupInfo Get /dhcp/group/info Display the properties of a DHCPv4 group
DhcpAPI DhcpGroupList Get /dhcp/group/list List the DHCPv4 groups
DhcpAPI DhcpLease6Count Get /dhcp/lease6/count Count the number of DHCPv6 leases
DhcpAPI DhcpLease6List Get /dhcp/lease6/list List the DHCPv6 leases
DhcpAPI DhcpLeaseCount Get /dhcp/lease/count Count the number of DHCPv4 leases
DhcpAPI DhcpLeaseInfo Get /dhcp/lease/info Display the properties of a DHCPv4 lease
DhcpAPI DhcpLeaseList Get /dhcp/lease/list List the DHCPv4 leases
DhcpAPI DhcpRange6Add Post /dhcp/range6/add Add a DHCPv6 range
DhcpAPI DhcpRange6Count Get /dhcp/range6/count Count the number of DHCPv6 ranges
DhcpAPI DhcpRange6Delete Delete /dhcp/range6/delete Delete a DHCPv6 range
DhcpAPI DhcpRange6Edit Put /dhcp/range6/edit Edit a DHCPv6 range
DhcpAPI DhcpRange6Info Get /dhcp/range6/info Display the properties of a DHCPv6 range
DhcpAPI DhcpRange6List Get /dhcp/range6/list List the DHCPv6 ranges
DhcpAPI DhcpRangeAdd Post /dhcp/range/add Add a DHCPv4 range
DhcpAPI DhcpRangeCount Get /dhcp/range/count Count the number of DHCPv4 ranges
DhcpAPI DhcpRangeDelete Delete /dhcp/range/delete Delete a DHCPv4 range
DhcpAPI DhcpRangeEdit Put /dhcp/range/edit Edit a DHCPv4 range
DhcpAPI DhcpRangeInfo Get /dhcp/range/info Display the properties of a DHCPv4 range
DhcpAPI DhcpRangeList Get /dhcp/range/list List the DHCPv4 ranges
DhcpAPI DhcpScope6Add Post /dhcp/scope6/add Add a DHCPv6 scope
DhcpAPI DhcpScope6Count Get /dhcp/scope6/count Count the number of DHCPv6 scopes
DhcpAPI DhcpScope6Delete Delete /dhcp/scope6/delete Delete a DHCPv6 scope
DhcpAPI DhcpScope6Edit Put /dhcp/scope6/edit Edit a DHCPv6 scope
DhcpAPI DhcpScope6Info Get /dhcp/scope6/info Display the properties of a DHCPv6 scope
DhcpAPI DhcpScope6List Get /dhcp/scope6/list List the DHCPv6 scopes
DhcpAPI DhcpScopeAdd Post /dhcp/scope/add Add a DHCPv4 scope
DhcpAPI DhcpScopeCount Get /dhcp/scope/count Count the number of DHCPv4 scopes
DhcpAPI DhcpScopeDelete Delete /dhcp/scope/delete Delete a DHCPv4 scope
DhcpAPI DhcpScopeEdit Put /dhcp/scope/edit Edit a DHCPv4 scope
DhcpAPI DhcpScopeInfo Get /dhcp/scope/info Display the properties of a DHCPv4 scope
DhcpAPI DhcpScopeList Get /dhcp/scope/list List the DHCPv4 scopes
DhcpAPI DhcpServer6Count Get /dhcp/server6/count Count the number of DHCPv6 servers
DhcpAPI DhcpServer6Info Get /dhcp/server6/info Display the properties of a DHCPv6 server
DhcpAPI DhcpServer6List Get /dhcp/server6/list List the DHCPv6 servers
DhcpAPI DhcpServerCount Get /dhcp/server/count Count the number of DHCPv4 servers
DhcpAPI DhcpServerInfo Get /dhcp/server/info Display the properties of a DHCPv4 server
DhcpAPI DhcpServerList Get /dhcp/server/list List the DHCPv4 servers
DhcpAPI DhcpSharednetwork6Add Post /dhcp/sharednetwork6/add Add a DHCPv6 shared network
DhcpAPI DhcpSharednetwork6Count Get /dhcp/sharednetwork6/count Count the number of DHCPv6 shared networks
DhcpAPI DhcpSharednetwork6Delete Delete /dhcp/sharednetwork6/delete Delete a DHCPv6 Shared Network
DhcpAPI DhcpSharednetwork6Edit Put /dhcp/sharednetwork6/edit Edit a DHCPv6 shared network
DhcpAPI DhcpSharednetwork6Info Get /dhcp/sharednetwork6/info Display the properties of a DHCPv6 shared network
DhcpAPI DhcpSharednetwork6List Get /dhcp/sharednetwork6/list List the DHCPv6 shared networks
DhcpAPI DhcpSharednetworkAdd Post /dhcp/sharednetwork/add Add a DHCPv4 shared network
DhcpAPI DhcpSharednetworkCount Get /dhcp/sharednetwork/count Count the number of DHCPv4 shared networks
DhcpAPI DhcpSharednetworkDelete Delete /dhcp/sharednetwork/delete Delete a DHCPv4 Shared Network
DhcpAPI DhcpSharednetworkEdit Put /dhcp/sharednetwork/edit Edit a DHCPv4 shared network
DhcpAPI DhcpSharednetworkInfo Get /dhcp/sharednetwork/info Display the properties of a DHCPv4 shared network
DhcpAPI DhcpSharednetworkList Get /dhcp/sharednetwork/list List the DHCPv4 shared networks
DhcpAPI DhcpStatic6Add Post /dhcp/static6/add Add a DHCPv6 static
DhcpAPI DhcpStatic6Count Get /dhcp/static6/count Count the number of DHCPv6 statics
DhcpAPI DhcpStatic6Delete Delete /dhcp/static6/delete Delete a DHCPv6 static
DhcpAPI DhcpStatic6Edit Put /dhcp/static6/edit Edit a DHCPv6 static
DhcpAPI DhcpStatic6Info Get /dhcp/static6/info Display the properties of a DHCPv6 static
DhcpAPI DhcpStatic6List Get /dhcp/static6/list List the DHCPv6 statics
DhcpAPI DhcpStaticAdd Post /dhcp/static/add Add a DHCPv4 static
DhcpAPI DhcpStaticCount Get /dhcp/static/count Count the number of DHCPv4 statics
DhcpAPI DhcpStaticDelete Delete /dhcp/static/delete Delete a DHCPv4 static
DhcpAPI DhcpStaticEdit Put /dhcp/static/edit Edit a DHCPv4 static
DhcpAPI DhcpStaticInfo Get /dhcp/static/info Display the properties of a DHCPv4 static
DhcpAPI DhcpStaticList Get /dhcp/static/list List the DHCPv4 statics
DnsAPI DnsAclAdd Post /dns/acl/add Add a DNS ACL
DnsAPI DnsAclCount Get /dns/acl/count Count the number of DNS ACLs
DnsAPI DnsAclDelete Delete /dns/acl/delete Delete a DNS ACL
DnsAPI DnsAclEdit Put /dns/acl/edit Edit a DNS ACL
DnsAPI DnsAclInfo Get /dns/acl/info Display the properties of a DNS ACL
DnsAPI DnsAclList Get /dns/acl/list List the DNS ACLs
DnsAPI DnsRrAdd Post /dns/rr/add Add a resource record
DnsAPI DnsRrCount Get /dns/rr/count Count the number of resource records
DnsAPI DnsRrDelete Delete /dns/rr/delete Delete a resource record
DnsAPI DnsRrEdit Put /dns/rr/edit Edit a resource record
DnsAPI DnsRrInfo Get /dns/rr/info Display the properties of a resource record
DnsAPI DnsRrList Get /dns/rr/list List the resource records
DnsAPI DnsServerCount Get /dns/server/count Count the number of DNS servers
DnsAPI DnsServerInfo Get /dns/server/info Display the properties of a DNS server
DnsAPI DnsServerList Get /dns/server/list List the DNS servers
DnsAPI DnsViewAdd Post /dns/view/add Add a view
DnsAPI DnsViewCount Get /dns/view/count Count the number of views
DnsAPI DnsViewDelete Delete /dns/view/delete Delete a view
DnsAPI DnsViewEdit Put /dns/view/edit Edit a view
DnsAPI DnsViewInfo Get /dns/view/info Display the properties of a view
DnsAPI DnsViewList Get /dns/view/list List the views
DnsAPI DnsViewparamAdd Post /dns/viewparam/add Add a DNS option on a view
DnsAPI DnsViewparamCount Get /dns/viewparam/count Count the number of DNS options of a view
DnsAPI DnsViewparamDelete Delete /dns/viewparam/delete Delete a DNS option from a view
DnsAPI DnsViewparamEdit Put /dns/viewparam/edit Edit a DNS option on a view
DnsAPI DnsViewparamInfo Get /dns/viewparam/info Display the properties of a DNS option set on a view
DnsAPI DnsViewparamList Get /dns/viewparam/list List the DNS options of a view
DnsAPI DnsZoneAdd Post /dns/zone/add Add a zone
DnsAPI DnsZoneCount Get /dns/zone/count Count the number of zones
DnsAPI DnsZoneDelete Delete /dns/zone/delete Delete a zone
DnsAPI DnsZoneEdit Put /dns/zone/edit Edit a zone
DnsAPI DnsZoneInfo Get /dns/zone/info Display the properties of a zone
DnsAPI DnsZoneList Get /dns/zone/list List the DNS options of a zone
DnsAPI DnsZoneparamAdd Post /dns/zoneparam/add Add a DNS option on a zone
DnsAPI DnsZoneparamCount Get /dns/zoneparam/count Count the number of DNS options of a zone
DnsAPI DnsZoneparamDelete Delete /dns/zoneparam/delete Delete a DNS option from a zone
DnsAPI DnsZoneparamEdit Put /dns/zoneparam/edit Edit a DNS option on a zone
DnsAPI DnsZoneparamInfo Get /dns/zoneparam/info Display the properties of a DNS option set on a zone
DnsAPI DnsZoneparamList Get /dns/zoneparam/list List the DNS options of a zone
GuardianAPI GuardianPolicyAdd Post /guardian/policy/add Add a policy
GuardianAPI GuardianPolicyCount Get /guardian/policy/count Count the number of policies
GuardianAPI GuardianPolicyDelete Delete /guardian/policy/delete Delete a policy
GuardianAPI GuardianPolicyEdit Put /guardian/policy/edit Edit a policy
GuardianAPI GuardianPolicyInfo Get /guardian/policy/info Display the properties of a policy
GuardianAPI GuardianPolicyList Get /guardian/policy/list List the policies
IpamAPI IpamAddress6Add Post /ipam/address6/add Add an IPv6 address
IpamAPI IpamAddress6Count Get /ipam/address6/count Count the number of IPv6 addresses
IpamAPI IpamAddress6Delete Delete /ipam/address6/delete Delete an IPv6 address
IpamAPI IpamAddress6Edit Put /ipam/address6/edit Edit an IPv6 address
IpamAPI IpamAddress6Info Get /ipam/address6/info Display the properties of an IPv6 address
IpamAPI IpamAddress6List Get /ipam/address6/list List the IPv6 addresses
IpamAPI IpamAddressAdd Post /ipam/address/add Add an IPv4 address
IpamAPI IpamAddressCount Get /ipam/address/count Count the number of IPv4 addresses
IpamAPI IpamAddressDelete Delete /ipam/address/delete Delete an IPv4 address
IpamAPI IpamAddressEdit Put /ipam/address/edit Edit an IPv4 address
IpamAPI IpamAddressInfo Get /ipam/address/info Display the properties of an IPv4 address
IpamAPI IpamAddressList Get /ipam/address/list List the IPv4 addresses
IpamAPI IpamAlias6Add Post /ipam/alias6/add Add an IPv6 address alias
IpamAPI IpamAlias6Count Get /ipam/alias6/count Count the number of aliases of an IPv6 address
IpamAPI IpamAlias6Delete Delete /ipam/alias6/delete Delete an IPv6 address alias
IpamAPI IpamAlias6Edit Put /ipam/alias6/edit Edit an IPv6 address alias
IpamAPI IpamAlias6List Get /ipam/alias6/list List the aliases of an IPv6 address
IpamAPI IpamAliasAdd Post /ipam/alias/add Add an IPv4 address alias
IpamAPI IpamAliasCount Get /ipam/alias/count Count the number of aliases of an IPv4 address
IpamAPI IpamAliasDelete Delete /ipam/alias/delete Delete an IPv4 address alias
IpamAPI IpamAliasEdit Put /ipam/alias/edit Edit an IPv4 address alias
IpamAPI IpamAliasList Get /ipam/alias/list List the aliases of an IPv4 address
IpamAPI IpamNetwork6Add Post /ipam/network6/add Add an IPv6 block/subnet-type network
IpamAPI IpamNetwork6Count Get /ipam/network6/count Count the number of IPv6 block/subnet-type networks
IpamAPI IpamNetwork6Delete Delete /ipam/network6/delete Delete an IPv6 block/subnet-type network
IpamAPI IpamNetwork6Edit Put /ipam/network6/edit Edit an IPv6 block/subnet-type network
IpamAPI IpamNetwork6Info Get /ipam/network6/info Display the properties of an IPv6 block/subnet-type network
IpamAPI IpamNetwork6List Get /ipam/network6/list List the IPv6 block/subnet-type networks
IpamAPI IpamNetworkAdd Post /ipam/network/add Add an IPv4 block/subnet-type network
IpamAPI IpamNetworkCount Get /ipam/network/count Count the number of IPv4 block/subnet-type networks
IpamAPI IpamNetworkDelete Delete /ipam/network/delete Delete an IPv4 block/subnet-type network
IpamAPI IpamNetworkEdit Put /ipam/network/edit Edit an IPv4 block/subnet-type network
IpamAPI IpamNetworkInfo Get /ipam/network/info Display the properties of an IPv4 block/subnet-type network
IpamAPI IpamNetworkList Get /ipam/network/list List the IPv4 block/subnet-type networks
IpamAPI IpamPool6Add Post /ipam/pool6/add Add an IPv6 pool
IpamAPI IpamPool6Count Get /ipam/pool6/count Count the number of IPv6 pools
IpamAPI IpamPool6Delete Delete /ipam/pool6/delete Delete an IPv6 pool
IpamAPI IpamPool6Edit Put /ipam/pool6/edit Edit an IPv6 pool
IpamAPI IpamPool6Info Get /ipam/pool6/info Display the properties of an IPv6 pool
IpamAPI IpamPool6List Get /ipam/pool6/list List the IPv6 pools
IpamAPI IpamPoolAdd Post /ipam/pool/add Add an IPv4 pool
IpamAPI IpamPoolCount Get /ipam/pool/count Count the number of IPv4 pools
IpamAPI IpamPoolDelete Delete /ipam/pool/delete Delete an IPv4 pool
IpamAPI IpamPoolEdit Put /ipam/pool/edit Edit an IPv4 pool
IpamAPI IpamPoolInfo Get /ipam/pool/info Display the properties of an IPv4 pool
IpamAPI IpamPoolList Get /ipam/pool/list List the IPv4 pools
IpamAPI IpamSpaceAdd Post /ipam/space/add Add a space
IpamAPI IpamSpaceCount Get /ipam/space/count Count the number of spaces
IpamAPI IpamSpaceDelete Delete /ipam/space/delete Delete a space
IpamAPI IpamSpaceEdit Put /ipam/space/edit Edit a space
IpamAPI IpamSpaceInfo Get /ipam/space/info Display the properties of a space
IpamAPI IpamSpaceList Get /ipam/space/list List the spaces
VlanAPI VlanDomainAdd Post /vlan/domain/add Add a VLAN domain
VlanAPI VlanDomainCount Get /vlan/domain/count Count the number of VLAN domains
VlanAPI VlanDomainDelete Delete /vlan/domain/delete Delete a VLAN domain
VlanAPI VlanDomainEdit Put /vlan/domain/edit Edit a VLAN domain
VlanAPI VlanDomainInfo Get /vlan/domain/info Display the properties of a VLAN domain
VlanAPI VlanDomainList Get /vlan/domain/list List the VLAN domains
VlanAPI VlanRangeAdd Post /vlan/range/add Add a VLAN range
VlanAPI VlanRangeCount Get /vlan/range/count Count the number of VLAN ranges
VlanAPI VlanRangeDelete Delete /vlan/range/delete Delete a VLAN range
VlanAPI VlanRangeEdit Put /vlan/range/edit Edit a VLAN range
VlanAPI VlanRangeInfo Get /vlan/range/info Display the properties of a VLAN range
VlanAPI VlanRangeList Get /vlan/range/list List the VLAN ranges
VlanAPI VlanVlanAdd Post /vlan/vlan/add Add a VLAN
VlanAPI VlanVlanCount Get /vlan/vlan/count Count the number of VLANs
VlanAPI VlanVlanDelete Delete /vlan/vlan/delete Delete a VLAN
VlanAPI VlanVlanEdit Put /vlan/vlan/edit Edit a VLAN
VlanAPI VlanVlanInfo Get /vlan/vlan/info Display the properties of a VLAN
VlanAPI VlanVlanList Get /vlan/vlan/list List the VLANs

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BasicAuth

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sdsclient.ContextBasicAuth, sdsclient.BasicAuth{
	UserName: "username",
	Password: "password",
})
r, err := client.Service.Operation(auth, args)

HttpHeaderLoginKey

  • Type: API key
  • API key parameter name: X-IPM-Username
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: X-IPM-Username and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		sdsclient.ContextAPIKeys,
		map[string]sdsclient.APIKey{
			"X-IPM-Username": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

HttpHeaderPasswordKey

  • Type: API key
  • API key parameter name: X-IPM-Password
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: X-IPM-Password and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		sdsclient.ContextAPIKeys,
		map[string]sdsclient.APIKey{
			"X-IPM-Password": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

EipApiTokenAuth

  • Type: EipApiTokenAuth

Example

auth := context.WithValue(
            context.Background(),
            sdsclient.ContextEipApiTokenAuth,
            sdsclient.EipApiTokenAuth{
                Token:  "TOKEN",
                Secret: "SECRET",
            },
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

support-api@efficientip.com

About

EfficientIP SOLIDserver client library for Go language

Resources

Readme

License

MIT license
Activity

Stars

5 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases 2

v1.8.4-1 Latest
Oct 9, 2024
+ 1 release

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •