--- api_metadata: apiVersion: "networking.k8s.io/v1alpha1" import: "k8s.io/api/networking/v1alpha1" kind: "ClusterCIDRConfig" content_type: "api_reference" description: "ClusterCIDRConfig is the Schema for the clustercidrconfigs API." title: "ClusterCIDRConfig v1alpha1" weight: 11 auto_generated: true --- `apiVersion: networking.k8s.io/v1alpha1` `import "k8s.io/api/networking/v1alpha1"` ## ClusterCIDRConfig {#ClusterCIDRConfig} ClusterCIDRConfig is the Schema for the clustercidrconfigs API.

- **apiVersion**: networking.k8s.io/v1alpha1 - **kind**: ClusterCIDRConfig - **metadata** (}}">ObjectMeta) Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - **spec** (}}">ClusterCIDRConfigSpec) Spec is the desired state of the ClusterCIDRConfig. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - **status** (}}">ClusterCIDRConfigStatus) Status is the current state of the ClusterCIDRConfig. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status ## ClusterCIDRConfigSpec {#ClusterCIDRConfigSpec} ClusterCIDRConfigSpec defines the desired state of ClusterCIDRConfig.

- **ipv4CIDR** (string) IPv4CIDR defines an IPv4 IP block in CIDR notation(e.g. "10.0.0.0/8"). This field is immutable. - **ipv6CIDR** (string) IPv6CIDR defines an IPv6 IP block in CIDR notation(e.g. "fd12:3456:789a:1::/64"). This field is immutable. - **nodeSelector** (NodeSelector) NodeSelector defines which nodes the config is applicable to. An empty or nil NodeSelector functions as a default that applies to all nodes. This field is immutable. *A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.* - **nodeSelector.nodeSelectorTerms** ([]NodeSelectorTerm), required Required. A list of node selector terms. The terms are ORed. *A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.* - **nodeSelector.nodeSelectorTerms.matchExpressions** ([]}}">NodeSelectorRequirement) A list of node selector requirements by node's labels. - **nodeSelector.nodeSelectorTerms.matchFields** ([]}}">NodeSelectorRequirement) A list of node selector requirements by node's fields. - **perNodeHostBits** (int32) PerNodeHostBits defines the number of host bits to be configured per node. A subnet mask determines how much of the address is used for network bits and host bits. For example and IPv4 address of 192.168.0.0/24, splits the address into 24 bits for the network portion and 8 bits for the host portion. For a /24 mask for IPv4 or a /120 for IPv6, configure PerNodeHostBits=8 This field is immutable. ## ClusterCIDRConfigStatus {#ClusterCIDRConfigStatus} ClusterCIDRConfigStatus defines the observed state of ClusterCIDRConfig.

## ClusterCIDRConfigList {#ClusterCIDRConfigList} ClusterCIDRConfigList contains a list of ClusterCIDRConfig.

- **apiVersion**: networking.k8s.io/v1alpha1 - **kind**: ClusterCIDRConfigList - **metadata** (}}">ListMeta) Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - **items** ([]}}">ClusterCIDRConfig), required Items is the list of ClusterCIDRConfigs. ## Operations {#Operations}

### `get` read the specified ClusterCIDRConfig #### HTTP Request GET /apis/networking.k8s.io/v1alpha1/clustercidrconfigs/{name} #### Parameters - **name** (*in path*): string, required name of the ClusterCIDRConfig - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">ClusterCIDRConfig): OK 401: Unauthorized ### `list` list or watch objects of kind ClusterCIDRConfig #### HTTP Request GET /apis/networking.k8s.io/v1alpha1/clustercidrconfigs #### Parameters - **allowWatchBookmarks** (*in query*): boolean }}">allowWatchBookmarks - **continue** (*in query*): string }}">continue - **fieldSelector** (*in query*): string }}">fieldSelector - **labelSelector** (*in query*): string }}">labelSelector - **limit** (*in query*): integer }}">limit - **pretty** (*in query*): string }}">pretty - **resourceVersion** (*in query*): string }}">resourceVersion - **resourceVersionMatch** (*in query*): string }}">resourceVersionMatch - **timeoutSeconds** (*in query*): integer }}">timeoutSeconds - **watch** (*in query*): boolean }}">watch #### Response 200 (}}">ClusterCIDRConfigList): OK 401: Unauthorized ### `create` create a ClusterCIDRConfig #### HTTP Request POST /apis/networking.k8s.io/v1alpha1/clustercidrconfigs #### Parameters - **body**: }}">ClusterCIDRConfig, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **fieldValidation** (*in query*): string }}">fieldValidation - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">ClusterCIDRConfig): OK 201 (}}">ClusterCIDRConfig): Created 202 (}}">ClusterCIDRConfig): Accepted 401: Unauthorized ### `update` replace the specified ClusterCIDRConfig #### HTTP Request PUT /apis/networking.k8s.io/v1alpha1/clustercidrconfigs/{name} #### Parameters - **name** (*in path*): string, required name of the ClusterCIDRConfig - **body**: }}">ClusterCIDRConfig, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **fieldValidation** (*in query*): string }}">fieldValidation - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">ClusterCIDRConfig): OK 201 (}}">ClusterCIDRConfig): Created 401: Unauthorized ### `patch` partially update the specified ClusterCIDRConfig #### HTTP Request PATCH /apis/networking.k8s.io/v1alpha1/clustercidrconfigs/{name} #### Parameters - **name** (*in path*): string, required name of the ClusterCIDRConfig - **body**: }}">Patch, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **fieldValidation** (*in query*): string }}">fieldValidation - **force** (*in query*): boolean }}">force - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">ClusterCIDRConfig): OK 201 (}}">ClusterCIDRConfig): Created 401: Unauthorized ### `delete` delete a ClusterCIDRConfig #### HTTP Request DELETE /apis/networking.k8s.io/v1alpha1/clustercidrconfigs/{name} #### Parameters - **name** (*in path*): string, required name of the ClusterCIDRConfig - **body**: }}">DeleteOptions - **dryRun** (*in query*): string }}">dryRun - **gracePeriodSeconds** (*in query*): integer }}">gracePeriodSeconds - **pretty** (*in query*): string }}">pretty - **propagationPolicy** (*in query*): string }}">propagationPolicy #### Response 200 (}}">Status): OK 202 (}}">Status): Accepted 401: Unauthorized ### `deletecollection` delete collection of ClusterCIDRConfig #### HTTP Request DELETE /apis/networking.k8s.io/v1alpha1/clustercidrconfigs #### Parameters - **body**: }}">DeleteOptions - **continue** (*in query*): string }}">continue - **dryRun** (*in query*): string }}">dryRun - **fieldSelector** (*in query*): string }}">fieldSelector - **gracePeriodSeconds** (*in query*): integer }}">gracePeriodSeconds - **labelSelector** (*in query*): string }}">labelSelector - **limit** (*in query*): integer }}">limit - **pretty** (*in query*): string }}">pretty - **propagationPolicy** (*in query*): string }}">propagationPolicy - **resourceVersion** (*in query*): string }}">resourceVersion - **resourceVersionMatch** (*in query*): string }}">resourceVersionMatch - **timeoutSeconds** (*in query*): integer }}">timeoutSeconds #### Response 200 (}}">Status): OK 401: Unauthorized