Chapter 15. IPAddress [ipam.cluster.x-k8s.io/v1beta1]


Description
IPAddress is the Schema for the ipaddress API.
Type
object

15.1. Specification

PropertyTypeDescription

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

IPAddressSpec is the desired state of an IPAddress.

15.1.1. .spec

Description
IPAddressSpec is the desired state of an IPAddress.
Type
object
Required
  • address
  • claimRef
  • poolRef
  • prefix
PropertyTypeDescription

address

string

Address is the IP address.

claimRef

object

ClaimRef is a reference to the claim this IPAddress was created for.

gateway

string

Gateway is the network gateway of the network the address is from.

poolRef

object

PoolRef is a reference to the pool that this IPAddress was created from.

prefix

integer

Prefix is the prefix of the address.

15.1.2. .spec.claimRef

Description
ClaimRef is a reference to the claim this IPAddress was created for.
Type
object
PropertyTypeDescription

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

15.1.3. .spec.poolRef

Description
PoolRef is a reference to the pool that this IPAddress was created from.
Type
object
Required
  • kind
  • name
PropertyTypeDescription

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

string

Kind is the type of resource being referenced

name

string

Name is the name of resource being referenced

15.2. API endpoints

The following API endpoints are available:

  • /apis/ipam.cluster.x-k8s.io/v1beta1/ipaddresses

    • GET: list objects of kind IPAddress
  • /apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddresses

    • DELETE: delete collection of IPAddress
    • GET: list objects of kind IPAddress
    • POST: create an IPAddress
  • /apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddresses/{name}

    • DELETE: delete an IPAddress
    • GET: read the specified IPAddress
    • PATCH: partially update the specified IPAddress
    • PUT: replace the specified IPAddress

15.2.1. /apis/ipam.cluster.x-k8s.io/v1beta1/ipaddresses

HTTP method
GET
Description
list objects of kind IPAddress
Table 15.1. HTTP responses
HTTP codeReponse body

200 - OK

IPAddressList schema

401 - Unauthorized

Empty

15.2.2. /apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddresses

HTTP method
DELETE
Description
delete collection of IPAddress
Table 15.2. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list objects of kind IPAddress
Table 15.3. HTTP responses
HTTP codeReponse body

200 - OK

IPAddressList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create an IPAddress
Table 15.4. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 15.5. Body parameters
ParameterTypeDescription

body

IPAddress schema

 
Table 15.6. HTTP responses
HTTP codeReponse body

200 - OK

IPAddress schema

201 - Created

IPAddress schema

202 - Accepted

IPAddress schema

401 - Unauthorized

Empty

15.2.3. /apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddresses/{name}

Table 15.7. Global path parameters
ParameterTypeDescription

name

string

name of the IPAddress

HTTP method
DELETE
Description
delete an IPAddress
Table 15.8. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Table 15.9. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified IPAddress
Table 15.10. HTTP responses
HTTP codeReponse body

200 - OK

IPAddress schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified IPAddress
Table 15.11. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 15.12. HTTP responses
HTTP codeReponse body

200 - OK

IPAddress schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified IPAddress
Table 15.13. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Table 15.14. Body parameters
ParameterTypeDescription

body

IPAddress schema

 
Table 15.15. HTTP responses
HTTP codeReponse body

200 - OK

IPAddress schema

201 - Created

IPAddress schema

401 - Unauthorized

Empty

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.