ipam

Go API client for ipam

The IPAM/DHCP Application is a BloxOne DDI service providing IP address management and DHCP protocol features. The IPAM component provides visibility into and provisioning tools to manage networking spaces, monitoring and reporting of entire IP address infrastructures, and integration with DNS and DHCP protocols. The DHCP component provides DHCP protocol configuration service with on-prem host serving DHCP protocol. It is part of the full-featured, DDI cloud solution that enables customers to deploy large numbers of protocol servers to deliver DNS and DHCP throughout their enterprise network.

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.

• API version: v1
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

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 ipam "github.com/infobloxopen/bloxone-go-client"

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 sw.ContextServerIndex of type int.

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

Templated Server URL

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

ctx := context.WithValue(context.Background(), ipam.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 sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

All URIs are relative to http://csp.infoblox.com/api/ddi/v1

Class	Method	HTTP request	Description
AddressAPI	AddressCreate	Post /ipam/address	Create the IP address.
AddressAPI	AddressDelete	Delete /ipam/address/{id}	Move the IP address to the recycle bin.
AddressAPI	AddressList	Get /ipam/address	Retrieve IP addresses.
AddressAPI	AddressRead	Get /ipam/address/{id}	Retrieve the IP address.
AddressAPI	AddressUpdate	Patch /ipam/address/{id}	Update the IP address.
AddressBlockAPI	AddressBlockCopy	Post /ipam/address_block/{id}/copy	Copy the address block.
AddressBlockAPI	AddressBlockCreate	Post /ipam/address_block	Create the address block.
AddressBlockAPI	AddressBlockCreateNextAvailableAB	Post /ipam/address_block/{id}/nextavailableaddressblock	Create the Next Available Address Block object.
AddressBlockAPI	AddressBlockCreateNextAvailableIP	Post /ipam/address_block/{id}/nextavailableip	Allocate the next available IP address.
AddressBlockAPI	AddressBlockCreateNextAvailableSubnet	Post /ipam/address_block/{id}/nextavailablesubnet	Create the Next Available Subnet object.
AddressBlockAPI	AddressBlockDelete	Delete /ipam/address_block/{id}	Move the address block to the recycle bin.
AddressBlockAPI	AddressBlockList	Get /ipam/address_block	Retrieve the address blocks.
AddressBlockAPI	AddressBlockListNextAvailableAB	Get /ipam/address_block/{id}/nextavailableaddressblock	List Next Available Address Block objects.
AddressBlockAPI	AddressBlockListNextAvailableIP	Get /ipam/address_block/{id}/nextavailableip	Retrieve the next available IP address.
AddressBlockAPI	AddressBlockListNextAvailableSubnet	Get /ipam/address_block/{id}/nextavailablesubnet	List Next Available Subnet objects.
AddressBlockAPI	AddressBlockRead	Get /ipam/address_block/{id}	Retrieve the address block.
AddressBlockAPI	AddressBlockUpdate	Patch /ipam/address_block/{id}	Update the address block.
AsmAPI	AsmCreate	Post /ipam/asm	Update subnet and ranges for Automated Scope Management.
AsmAPI	AsmList	Get /ipam/asm	Retrieve suggested updates for Automated Scope Management.
AsmAPI	AsmRead	Get /ipam/asm/{id}	Retrieve the suggested update for Automated Scope Management.
DhcpHostAPI	DhcpHostList	Get /dhcp/host	Retrieve DHCP hosts.
DhcpHostAPI	DhcpHostListAssociations	Get /dhcp/host/{id}/associations	Retrieve DHCP host associations.
DhcpHostAPI	DhcpHostRead	Get /dhcp/host/{id}	Retrieve the DHCP host.
DhcpHostAPI	DhcpHostUpdate	Patch /dhcp/host/{id}	Update the DHCP hosts.
DnsUsageAPI	DnsUsageList	Get /ipam/dns_usage	Retrieve DNS usage for multiple objects.
DnsUsageAPI	DnsUsageRead	Get /ipam/dns_usage/{id}	Retrieve the DNS usage.
FilterAPI	FilterList	Get /dhcp/filter	Retrieve DHCP filters.
FixedAddressAPI	FixedAddressCreate	Post /dhcp/fixed_address	Create the fixed address.
FixedAddressAPI	FixedAddressDelete	Delete /dhcp/fixed_address/{id}	Move the fixed address to the recycle bin.
FixedAddressAPI	FixedAddressList	Get /dhcp/fixed_address	Retrieve fixed addresses.
FixedAddressAPI	FixedAddressRead	Get /dhcp/fixed_address/{id}	Retrieve the fixed address.
FixedAddressAPI	FixedAddressUpdate	Patch /dhcp/fixed_address/{id}	Update the fixed address.
GlobalAPI	GlobalRead	Get /dhcp/global	Retrieve the global configuration.
GlobalAPI	GlobalRead2	Get /dhcp/global/{id}	Retrieve the global configuration.
GlobalAPI	GlobalUpdate	Patch /dhcp/global	Update the global configuration.
GlobalAPI	GlobalUpdate2	Patch /dhcp/global/{id}	Update the global configuration.
HaGroupAPI	HaGroupCreate	Post /dhcp/ha_group	Create the HA group.
HaGroupAPI	HaGroupDelete	Delete /dhcp/ha_group/{id}	Delete the HA group.
HaGroupAPI	HaGroupList	Get /dhcp/ha_group	Retrieve HA groups.
HaGroupAPI	HaGroupRead	Get /dhcp/ha_group/{id}	Retrieve the HA group.
HaGroupAPI	HaGroupUpdate	Patch /dhcp/ha_group/{id}	Update the HA group.
HardwareFilterAPI	HardwareFilterCreate	Post /dhcp/hardware_filter	Create the hardware filter.
HardwareFilterAPI	HardwareFilterDelete	Delete /dhcp/hardware_filter/{id}	Move the hardware filter to the recycle bin.
HardwareFilterAPI	HardwareFilterList	Get /dhcp/hardware_filter	Retrieve hardware filters.
HardwareFilterAPI	HardwareFilterRead	Get /dhcp/hardware_filter/{id}	Retrieve the hardware filter.
HardwareFilterAPI	HardwareFilterUpdate	Patch /dhcp/hardware_filter/{id}	Update the hardware filter.
IpSpaceAPI	IpSpaceBulkCopy	Post /ipam/ip_space/bulk_copy	Copy the specified address block and subnets in the IP space.
IpSpaceAPI	IpSpaceCopy	Post /ipam/ip_space/{id}/copy	Copy the IP space.
IpSpaceAPI	IpSpaceCreate	Post /ipam/ip_space	Create the IP space.
IpSpaceAPI	IpSpaceDelete	Delete /ipam/ip_space/{id}	Move the IP space to the recycle bin.
IpSpaceAPI	IpSpaceList	Get /ipam/ip_space	Retrieve IP spaces.
IpSpaceAPI	IpSpaceRead	Get /ipam/ip_space/{id}	Retrieve the IP space.
IpSpaceAPI	IpSpaceUpdate	Patch /ipam/ip_space/{id}	Update the IP space.
IpamHostAPI	IpamHostCreate	Post /ipam/host	Create the IPAM host.
IpamHostAPI	IpamHostDelete	Delete /ipam/host/{id}	Move the IPAM host to the recycle bin.
IpamHostAPI	IpamHostList	Get /ipam/host	Retrieve the IPAM hosts.
IpamHostAPI	IpamHostRead	Get /ipam/host/{id}	Retrieve the IPAM host.
IpamHostAPI	IpamHostUpdate	Patch /ipam/host/{id}	Update the IPAM host.
LeasesCommandAPI	LeasesCommandCreate	Post /dhcp/leases_command	Perform actions like clearing DHCP lease(s).
OptionCodeAPI	OptionCodeCreate	Post /dhcp/option_code	Create the DHCP option code.
OptionCodeAPI	OptionCodeDelete	Delete /dhcp/option_code/{id}	Delete the DHCP option code.
OptionCodeAPI	OptionCodeList	Get /dhcp/option_code	Retrieve DHCP option codes.
OptionCodeAPI	OptionCodeRead	Get /dhcp/option_code/{id}	Retrieve the DHCP option code.
OptionCodeAPI	OptionCodeUpdate	Patch /dhcp/option_code/{id}	Update the DHCP option code.
OptionFilterAPI	OptionFilterCreate	Post /dhcp/option_filter	Create the DHCP option filter.
OptionFilterAPI	OptionFilterDelete	Delete /dhcp/option_filter/{id}	Move the DHCP option filter to the recycle bin.
OptionFilterAPI	OptionFilterList	Get /dhcp/option_filter	Retrieve DHCP option filters.
OptionFilterAPI	OptionFilterRead	Get /dhcp/option_filter/{id}	Retrieve the DHCP option filter.
OptionFilterAPI	OptionFilterUpdate	Patch /dhcp/option_filter/{id}	Update the DHCP option filter.
OptionGroupAPI	OptionGroupCreate	Post /dhcp/option_group	Create the DHCP option group.
OptionGroupAPI	OptionGroupDelete	Delete /dhcp/option_group/{id}	Move the DHCP option group to the recycle bin.
OptionGroupAPI	OptionGroupList	Get /dhcp/option_group	Retrieve DHCP option groups.
OptionGroupAPI	OptionGroupRead	Get /dhcp/option_group/{id}	Retrieve the DHCP option group.
OptionGroupAPI	OptionGroupUpdate	Patch /dhcp/option_group/{id}	Update the DHCP option group.
OptionSpaceAPI	OptionSpaceCreate	Post /dhcp/option_space	Create the DHCP option space.
OptionSpaceAPI	OptionSpaceDelete	Delete /dhcp/option_space/{id}	Move the DHCP option space to the recycle bin.
OptionSpaceAPI	OptionSpaceList	Get /dhcp/option_space	Retrieve DHCP option spaces.
OptionSpaceAPI	OptionSpaceRead	Get /dhcp/option_space/{id}	Retrieve the DHCP option space.
OptionSpaceAPI	OptionSpaceUpdate	Patch /dhcp/option_space/{id}	Update the DHCP option space.
RangeAPI	RangeCreate	Post /ipam/range	Create the range.
RangeAPI	RangeCreateNextAvailableIP	Post /ipam/range/{id}/nextavailableip	Allocate the next available IP address.
RangeAPI	RangeDelete	Delete /ipam/range/{id}	Move the range to the recycle bin.
RangeAPI	RangeList	Get /ipam/range	Retrieve ranges.
RangeAPI	RangeListNextAvailableIP	Get /ipam/range/{id}/nextavailableip	Retrieve the next available IP address.
RangeAPI	RangeRead	Get /ipam/range/{id}	Retrieve the range.
RangeAPI	RangeUpdate	Patch /ipam/range/{id}	Update the range.
ServerAPI	ServerCreate	Post /dhcp/server	Create the DHCP configuration profile.
ServerAPI	ServerDelete	Delete /dhcp/server/{id}	Move the DHCP configuration profile to the recycle bin.
ServerAPI	ServerList	Get /dhcp/server	Retrieve DHCP configuration profiles.
ServerAPI	ServerRead	Get /dhcp/server/{id}	Retrieve the DHCP configuration profile.
ServerAPI	ServerUpdate	Patch /dhcp/server/{id}	Update the DHCP configuration profile.
SubnetAPI	SubnetCopy	Post /ipam/subnet/{id}/copy	Copy the subnet.
SubnetAPI	SubnetCreate	Post /ipam/subnet	Create the subnet.
SubnetAPI	SubnetCreateNextAvailableIP	Post /ipam/subnet/{id}/nextavailableip	Allocate the next available IP address.
SubnetAPI	SubnetDelete	Delete /ipam/subnet/{id}	Move the subnet to the recycle bin.
SubnetAPI	SubnetList	Get /ipam/subnet	Retrieve subnets.
SubnetAPI	SubnetListNextAvailableIP	Get /ipam/subnet/{id}/nextavailableip	Retrieve the next available IP address.
SubnetAPI	SubnetRead	Get /ipam/subnet/{id}	Retrieve the subnet.
SubnetAPI	SubnetUpdate	Patch /ipam/subnet/{id}	Update the subnet.

Documentation For Models

• InheritanceAssignedHost
• InheritanceInheritedBool
• InheritanceInheritedFloat
• InheritanceInheritedIdentifier
• InheritanceInheritedString
• InheritanceInheritedUInt32
• InheritedDHCPConfigFilterList
• InheritedDHCPConfigIgnoreItemList
• IpamsvcASM
• IpamsvcASMConfig
• IpamsvcAccessFilter
• IpamsvcAddress
• IpamsvcAddressBlock
• IpamsvcAsmEnableBlock
• IpamsvcAsmGrowthBlock
• IpamsvcBulkCopyError
• IpamsvcBulkCopyIPSpace
• IpamsvcBulkCopyIPSpaceResponse
• IpamsvcCopyAddressBlock
• IpamsvcCopyAddressBlockResponse
• IpamsvcCopyIPSpace
• IpamsvcCopyIPSpaceResponse
• IpamsvcCopyResponse
• IpamsvcCopySubnet
• IpamsvcCopySubnetResponse
• IpamsvcCreateASMResponse
• IpamsvcCreateAddressBlockResponse
• IpamsvcCreateAddressResponse
• IpamsvcCreateFixedAddressResponse
• IpamsvcCreateHAGroupResponse
• IpamsvcCreateHardwareFilterResponse
• IpamsvcCreateIPSpaceResponse
• IpamsvcCreateIpamHostResponse
• IpamsvcCreateLeasesCommandResponse
• IpamsvcCreateNextAvailableABResponse
• IpamsvcCreateNextAvailableIPResponse
• IpamsvcCreateNextAvailableSubnetResponse
• IpamsvcCreateOptionCodeResponse
• IpamsvcCreateOptionFilterResponse
• IpamsvcCreateOptionGroupResponse
• IpamsvcCreateOptionSpaceResponse
• IpamsvcCreateRangeResponse
• IpamsvcCreateServerResponse
• IpamsvcCreateSubnetResponse
• IpamsvcDDNSBlock
• IpamsvcDDNSHostnameBlock
• IpamsvcDDNSUpdateBlock
• IpamsvcDDNSZone
• IpamsvcDHCPConfig
• IpamsvcDHCPInfo
• IpamsvcDHCPInheritance
• IpamsvcDHCPOptionsInheritance
• IpamsvcDHCPPacketStats
• IpamsvcDHCPUtilization
• IpamsvcDHCPUtilizationThreshold
• IpamsvcDNSUsage
• IpamsvcExclusionRange
• IpamsvcFilter
• IpamsvcFixedAddress
• IpamsvcFixedAddressInheritance
• IpamsvcGlobal
• IpamsvcHAGroup
• IpamsvcHAGroupHeartbeats
• IpamsvcHAGroupHost
• IpamsvcHardwareFilter
• IpamsvcHost
• IpamsvcHostAddress
• IpamsvcHostAssociatedServer
• IpamsvcHostAssociationsResponse
• IpamsvcHostName
• IpamsvcHostnameRewriteBlock
• IpamsvcIPSpace
• IpamsvcIPSpaceInheritance
• IpamsvcIgnoreItem
• IpamsvcInheritedASMConfig
• IpamsvcInheritedAsmEnableBlock
• IpamsvcInheritedAsmGrowthBlock
• IpamsvcInheritedDDNSBlock
• IpamsvcInheritedDDNSHostnameBlock
• IpamsvcInheritedDDNSUpdateBlock
• IpamsvcInheritedDHCPConfig
• IpamsvcInheritedDHCPOption
• IpamsvcInheritedDHCPOptionItem
• IpamsvcInheritedDHCPOptionList
• IpamsvcInheritedHostnameRewriteBlock
• IpamsvcIpamHost
• IpamsvcKerberosKey
• IpamsvcLeaseAddress
• IpamsvcLeaseRange
• IpamsvcLeaseSubnet
• IpamsvcLeasesCommand
• IpamsvcListASMResponse
• IpamsvcListAddressBlockResponse
• IpamsvcListAddressResponse
• IpamsvcListDNSUsageResponse
• IpamsvcListFilterResponse
• IpamsvcListFixedAddressResponse
• IpamsvcListHAGroupResponse
• IpamsvcListHardwareFilterResponse
• IpamsvcListHostResponse
• IpamsvcListIPSpaceResponse
• IpamsvcListIpamHostResponse
• IpamsvcListOptionCodeResponse
• IpamsvcListOptionFilterResponse
• IpamsvcListOptionGroupResponse
• IpamsvcListOptionSpaceResponse
• IpamsvcListRangeResponse
• IpamsvcListServerResponse
• IpamsvcListSubnetResponse
• IpamsvcName
• IpamsvcNameserver
• IpamsvcNextAvailableABResponse
• IpamsvcNextAvailableIPResponse
• IpamsvcNextAvailableSubnetResponse
• IpamsvcOptionCode
• IpamsvcOptionFilter
• IpamsvcOptionFilterRule
• IpamsvcOptionFilterRuleList
• IpamsvcOptionGroup
• IpamsvcOptionItem
• IpamsvcOptionSpace
• IpamsvcRange
• IpamsvcReadASMResponse
• IpamsvcReadAddressBlockResponse
• IpamsvcReadAddressResponse
• IpamsvcReadDNSUsageResponse
• IpamsvcReadFixedAddressResponse
• IpamsvcReadGlobalResponse
• IpamsvcReadHAGroupResponse
• IpamsvcReadHardwareFilterResponse
• IpamsvcReadHostResponse
• IpamsvcReadIPSpaceResponse
• IpamsvcReadIpamHostResponse
• IpamsvcReadOptionCodeResponse
• IpamsvcReadOptionFilterResponse
• IpamsvcReadOptionGroupResponse
• IpamsvcReadOptionSpaceResponse
• IpamsvcReadRangeResponse
• IpamsvcReadServerResponse
• IpamsvcReadSubnetResponse
• IpamsvcServer
• IpamsvcServerInheritance
• IpamsvcSubnet
• IpamsvcTSIGKey
• IpamsvcUpdateAddressBlockResponse
• IpamsvcUpdateAddressResponse
• IpamsvcUpdateFixedAddressResponse
• IpamsvcUpdateGlobalResponse
• IpamsvcUpdateHAGroupResponse
• IpamsvcUpdateHardwareFilterResponse
• IpamsvcUpdateHostResponse
• IpamsvcUpdateIPSpaceResponse
• IpamsvcUpdateIpamHostResponse
• IpamsvcUpdateOptionCodeResponse
• IpamsvcUpdateOptionFilterResponse
• IpamsvcUpdateOptionGroupResponse
• IpamsvcUpdateOptionSpaceResponse
• IpamsvcUpdateRangeResponse
• IpamsvcUpdateServerResponse
• IpamsvcUpdateSubnetResponse
• IpamsvcUtilization
• IpamsvcUtilizationThreshold
• IpamsvcUtilizationV6

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

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

Example

auth := context.WithValue(
		context.Background(),
		sw.ContextAPIKeys,
		map[string]sw.APIKey{
			"Authorization": {Key: "API_KEY_STRING"},
		},
	)
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