1"use strict";(self.webpackChunktigera_docs=self.webpackChunktigera_docs||[]).push([[4211],{15680:(e,t,n)=>{n.d(t,{xA:()=>s,yg:()=>f});var o=n(96540);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,o)}return n}function i(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?l(Object(n),!0).forEach((function(t){a(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):l(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function c(e,t){if(null==e)return{};var n,o,a=function(e,t){if(null==e)return{};var n,o,a={},l=Object.keys(e);for(o=0;o<l.length;o++)n=l[o],t.indexOf(n)>=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(o=0;o<l.length;o++)n=l[o],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var r=o.createContext({}),p=function(e){var t=o.useContext(r),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},s=function(e){var t=p(e.components);return o.createElement(r.Provider,{value:t},e.children)},m="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},u=o.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,r=e.parentName,s=c(e,["components","mdxType","originalType","parentName"]),m=p(n),u=a,f=m["".concat(r,".").concat(u)]||m[u]||d[u]||l;return n?o.createElement(f,i(i({ref:t},s),{},{components:n})):o.createElement(f,i({ref:t},s))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,i=new Array(l);i[0]=u;var c={};for(var r in t)hasOwnProperty.call(t,r)&&(c[r]=t[r]);c.originalType=e,c[m]="string"==typeof e?e:a,i[1]=c;for(var p=2;p<l;p++)i[p]=n[p];return o.createElement.apply(null,i)}return o.createElement.apply(null,n)}u.displayName="MDXCreateElement"},51298:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>r,contentTitle:()=>i,default:()=>d,frontMatter:()=>l,metadata:()=>c,toc:()=>p});var o=n(58168),a=(n(96540),n(15680));const l={description:"Command and options for splitting an existing IP pool"},i="calicoctl ipam split",c={unversionedId:"reference/calicoctl/ipam/split",id:"version-3.26/reference/calicoctl/ipam/split",title:"calicoctl ipam split",description:"Command and options for splitting an existing IP pool",source:"@site/calico_versioned_docs/version-3.26/reference/calicoctl/ipam/split.mdx",sourceDirName:"reference/calicoctl/ipam",slug:"/reference/calicoctl/ipam/split",permalink:"/calico/3.26/reference/calicoctl/ipam/split",draft:!1,editUrl:"https://github.com/tigera/docs/edit/main/calico_versioned_docs/version-3.26/reference/calicoctl/ipam/split.mdx",tags:[],version:"3.26",frontMatter:{description:"Command and options for splitting an existing IP pool"},sidebar:"calicoSidebar",previous:{title:"calicoctl ipam configure",permalink:"/calico/3.26/reference/calicoctl/ipam/configure"},next:{title:"node",permalink:"/calico/3.26/reference/calicoctl/node/"}},r={},p=[{value:"Display the help text for <code>calicoctl ipam split</code> command",id:"display-the-help-text-for-calicoctl-ipam-split-command",level:2},{value:"Prerequisites",id:"prerequisites",level:3},{value:"Examples",id:"examples",level:3},{value:"General options",id:"general-options",level:3},{value:"See also",id:"see-also",level:2}],s={toc:p},m="wrapper";function d(e){let{components:t,...n}=e;return(0,a.yg)(m,(0,o.A)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.yg)("h1",{id:"calicoctl-ipam-split"},"calicoctl ipam split"),(0,a.yg)("p",null,"This section describes the ",(0,a.yg)("inlineCode",{parentName:"p"},"calicoctl ipam split")," command."),(0,a.yg)("p",null,"Read the ",(0,a.yg)("a",{parentName:"p",href:"/calico/3.26/reference/calicoctl/overview"},"calicoctlOverview"),"\nfor a full list of calicoctl commands."),(0,a.yg)("h2",{id:"display-the-help-text-for-calicoctl-ipam-split-command"},"Display the help text for ",(0,a.yg)("inlineCode",{parentName:"h2"},"calicoctl ipam split")," command"),(0,a.yg)("p",null,"Run ",(0,a.yg)("inlineCode",{parentName:"p"},"calicoctl ipam split --help")," to display the following help menu for the command."),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre"},"Usage:\n <BINARY_NAME> ipam split <NUMBER> [--cidr=<CIDR>] [--name=<POOL_NAME>] [--config=<CONFIG>] [--allow-version-mismatch]\n\nOptions:\n -h --help Show this screen.\n -c --config=<CONFIG> Path to the file containing connection configuration in\n YAML or JSON format.\n [default: /etc/calico/calicoctl.cfg]\n --cidr=<CIDR> CIDR of the IP pool to split.\n --name=<POOL_NAME> Name of the IP pool to split.\n --allow-version-mismatch Allow client and cluster versions mismatch.\n\nDescription:\n The ipam split command splits an IP pool specified by the specified CIDR or name\n into the specified number of smaller IP pools. Each child IP pool will be of equal\n size. IP pools can only be split into a
1number of smaller pools that is a power\n of 2.\n\nExamples:\n # Split the IP pool specified by 172.0.0.0/8 into 2 smaller pools\n <BINARY_NAME> ipam split --cidr=172.0.0.0/8 2\n")),(0,a.yg)("h3",{id:"prerequisites"},"Prerequisites"),(0,a.yg)("p",null,"To split an IP pool, you will first need to lock the Calico database\nso that no IPAM data can change during the split. This is accomplished by using the\n",(0,a.yg)("a",{parentName:"p",href:"/calico/3.26/reference/calicoctl/datastore/migrate/lock"},(0,a.yg)("inlineCode",{parentName:"a"},"calicoctl datastore migrate lock")," command"),".\nTo continue normal IPAM operation, you will need to unlock the calico datastore\nafter the split with the\n",(0,a.yg)("a",{parentName:"p",href:"/calico/3.26/reference/calicoctl/datastore/migrate/unlock"},(0,a.yg)("inlineCode",{parentName:"a"},"calicoctl datastore migrate unlock")," command"),"."),(0,a.yg)("h3",{id:"examples"},"Examples"),(0,a.yg)("p",null,"Lock the Calico datastore."),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre",className:"language-bash"},"calicoctl datastore migrate lock\n")),(0,a.yg)("p",null,"Split the IP pool specified by 172.0.0.0/15 into 2 smaller pools."),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre",className:"language-bash"},"calicoctl ipam split --cidr=172.0.0.0/15 2\n")),(0,a.yg)("p",null,"This should create 2 IP pools, one covering CIDR ",(0,a.yg)("inlineCode",{parentName:"p"},"172.0.0.0/16"),"\nand one covering CIDR ",(0,a.yg)("inlineCode",{parentName:"p"},"172.1.0.0/16"),"."),(0,a.yg)("p",null,"Unlock the Calico datastore to restore normal IPAM operation."),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre",className:"language-bash"},"calicoctl datastore migrate unlock\n")),(0,a.yg)("h3",{id:"general-options"},"General options"),(0,a.yg)("pre",null,(0,a.yg)("code",{parentName:"pre"}," -c --config=<CONFIG> Path to the file containing connection configuration in\n YAML or JSON format.\n [default: /etc/calico/calicoctl.cfg]\n")),(0,a.yg)("h2",{id:"see-also"},"See also"),(0,a.yg)("ul",null,(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("a",{parentName:"li",href:"/calico/3.26/operations/calicoctl/install"},"Install calicoctl")),(0,a.yg)("li",{parentName:"ul"},(0,a.yg)("a",{parentName:"li",href:"/calico/3.26/reference/resources/overview"},"Resources")," for details on all valid resources, including file format\nand schema")))}d.isMDXComponent=!0}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.