FixedAddressAPI

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

Method	HTTP request	Description
Create	Post /dhcp/fixed_address	Create the fixed address.
Delete	Delete /dhcp/fixed_address/{id}	Move the fixed address to the recycle bin.
List	Get /dhcp/fixed_address	Retrieve fixed addresses.
Read	Get /dhcp/fixed_address/{id}	Retrieve the fixed address.
Update	Patch /dhcp/fixed_address/{id}	Update the fixed address.

Create

CreateFixedAddressResponse Create(ctx).Body(body).Inherit(inherit).Execute()

Create the fixed address.

Example

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/infobloxopen/bloxone-go-client/ipam"
)

func main() {
	body := *ipam.NewFixedAddress("192.168.1.10", "mac", "00:0a:95:9d:68:16") // FixedAddress | 

	apiClient := ipam.NewAPIClient()
	resp, r, err := apiClient.FixedAddressAPI.Create(context.Background()).Body(body).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `FixedAddressAPI.Create``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `Create`: CreateFixedAddressResponse
	fmt.Fprintf(os.Stdout, "Response from `FixedAddressAPI.Create`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a FixedAddressAPICreateRequest struct via the builder pattern

Name	Type	Description	Notes
body	FixedAddress
inherit	string	This parameter is used for getting inheritance_sources. Allowed values: * none, * partial, * full. Defaults to _none

Return type

CreateFixedAddressResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Delete

Delete(ctx, id).Execute()

Move the fixed address to the recycle bin.

Example

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/infobloxopen/bloxone-go-client/ipam"
)

func main() {
	id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource

	apiClient := ipam.NewAPIClient()
	r, err := apiClient.FixedAddressAPI.Delete(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `FixedAddressAPI.Delete``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	An application specific resource identity of a resource

Other Parameters

Other parameters are passed through a pointer to a FixedAddressAPIDeleteRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

List

ListFixedAddressResponse List(ctx).Filter(filter).OrderBy(orderBy).Fields(fields).Offset(offset).Limit(limit).PageToken(pageToken).TorderBy(torderBy).Tfilter(tfilter).Inherit(inherit).Execute()

Retrieve fixed addresses.

Example

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/infobloxopen/bloxone-go-client/ipam"
)

func main() {

	apiClient := ipam.NewAPIClient()
	resp, r, err := apiClient.FixedAddressAPI.List(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `FixedAddressAPI.List``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `List`: ListFixedAddressResponse
	fmt.Fprintf(os.Stdout, "Response from `FixedAddressAPI.List`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a FixedAddressAPIListRequest struct via the builder pattern

Name	Type	Description	Notes
filter	string	A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions:	Op
orderBy	string	A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order.
fields	string	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names.
offset	int32	The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'.
limit	int32	The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value.
pageToken	string	The service-defined string used to identify a page of resources. A null value indicates the first page.
torderBy	string	This parameter is used for sorting by tags.
tfilter	string	This parameter is used for filtering by tags.
inherit	string	This parameter is used for getting inheritance_sources. Allowed values: * none, * partial, * full. Defaults to _none

Return type

ListFixedAddressResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Read

ReadFixedAddressResponse Read(ctx, id).Fields(fields).Inherit(inherit).Execute()

Retrieve the fixed address.

Example

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/infobloxopen/bloxone-go-client/ipam"
)

func main() {
	id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource

	apiClient := ipam.NewAPIClient()
	resp, r, err := apiClient.FixedAddressAPI.Read(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `FixedAddressAPI.Read``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `Read`: ReadFixedAddressResponse
	fmt.Fprintf(os.Stdout, "Response from `FixedAddressAPI.Read`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	An application specific resource identity of a resource

Other Parameters

Other parameters are passed through a pointer to a FixedAddressAPIReadRequest struct via the builder pattern

Name	Type	Description	Notes
fields	string	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names.
inherit	string	This parameter is used for getting inheritance_sources. Allowed values: * none, * partial, * full. Defaults to _none

Return type

ReadFixedAddressResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Update

UpdateFixedAddressResponse Update(ctx, id).Body(body).Inherit(inherit).Execute()

Update the fixed address.

Example

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/infobloxopen/bloxone-go-client/ipam"
)

func main() {
	id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource
	body := *ipam.NewFixedAddress("192.168.1.10", "mac", "00:0a:95:9d:68:16") // FixedAddress | 

	apiClient := ipam.NewAPIClient()
	resp, r, err := apiClient.FixedAddressAPI.Update(context.Background(), id).Body(body).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `FixedAddressAPI.Update``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `Update`: UpdateFixedAddressResponse
	fmt.Fprintf(os.Stdout, "Response from `FixedAddressAPI.Update`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	An application specific resource identity of a resource

Other Parameters

Other parameters are passed through a pointer to a FixedAddressAPIUpdateRequest struct via the builder pattern

Name	Type	Description	Notes
body	FixedAddress
inherit	string	This parameter is used for getting inheritance_sources. Allowed values: * none, * partial, * full. Defaults to _none

Return type

UpdateFixedAddressResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

FixedAddressAPI.md

Latest commit

History

FixedAddressAPI.md

File metadata and controls

FixedAddressAPI

Create

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Delete

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

List

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Read

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

Update

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers