https://archive-ce-3-14.netlify.app/assets/js/ea2cb7f2.d59f4a29.js

1"use strict";(self.webpackChunktigera_docs=self.webpackChunktigera_docs||[]).push([[4644],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>f});var a=r(67294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function c(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?c(Object(r),!0).forEach((function(t){n(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):c(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function i(e,t){if(null==e)return{};var r,a,n=function(e,t){if(null==e)return{};var r,a,n={},c=Object.keys(e);for(a=0;a<c.length;a++)r=c[a],t.indexOf(r)>=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(a=0;a<c.length;a++)r=c[a],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var o=a.createContext({}),s=function(e){var t=a.useContext(o),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},p=function(e){var t=s(e.components);return a.createElement(o.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,c=e.originalType,o=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),d=s(r),f=n,u=d["".concat(o,".").concat(f)]||d[f]||m[f]||c;return r?a.createElement(u,l(l({ref:t},p),{},{components:r})):a.createElement(u,l({ref:t},p))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var c=r.length,l=new Array(c);l[0]=d;var i={};for(var o in t)hasOwnProperty.call(t,o)&&(i[o]=t[o]);i.originalType=e,i.mdxType="string"==typeof e?e:n,l[1]=i;for(var s=2;s<c;s++)l[s]=r[s];return a.createElement.apply(null,l)}return a.createElement.apply(null,r)}d.displayName="MDXCreateElement"},95266:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>l,default:()=>m,frontMatter:()=>c,metadata:()=>i,toc:()=>s});var a=r(87462),n=(r(67294),r(3905));const c={description:"Command to release an IP address from Calico Enterprise IP management."},l="calicoctl ipam release",i={unversionedId:"reference/clis/calicoctl/ipam/release",id:"version-3.14/reference/clis/calicoctl/ipam/release",title:"calicoctl ipam release",description:"Command to release an IP address from Calico Enterprise IP management.",source:"@site/calico-enterprise_versioned_docs/version-3.14/reference/clis/calicoctl/ipam/release.mdx",sourceDirName:"reference/clis/calicoctl/ipam",slug:"/reference/clis/calicoctl/ipam/release",permalink:"/calico-enterprise/3.14/reference/clis/calicoctl/ipam/release",draft:!1,editUrl:"https://github.com/tigera/docs/edit/main/calico-enterprise_versioned_docs/version-3.14/reference/clis/calicoctl/ipam/release.mdx",tags:[],version:"3.14",frontMatter:{description:"Command to release an IP address from Calico Enterprise IP management."},sidebar:"calicoEnterpriseSidebar",previous:{title:"calicoctl ipam check",permalink:"/calico-enterprise/3.14/reference/clis/calicoctl/ipam/check"},next:{title:"calicoctl ipam show",permalink:"/calico-enterprise/3.14/reference/clis/calicoctl/ipam/show"}},o={},s=[{value:"Displaying the help text for &#39;calicoctl ipam release&#39; command",id:"displaying-the-help-text-for-calicoctl-ipam-release-command",level:2},{value:"Examples",id:"examples",level:3},{value:"General options",id:"general-options",level:3},{value:"See also",id:"see-also",level:2}],p={toc:s};

1function m(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("h1",{id:"calicoctl-ipam-release"},"calicoctl ipam release"),(0,n.kt)("p",null,"This section describes the ",(0,n.kt)("inlineCode",{parentName:"p"},"calicoctl ipam release")," command."),(0,n.kt)("p",null,"Read the ",(0,n.kt)("a",{parentName:"p",href:"/calico-enterprise/3.14/reference/clis/calicoctl/overview"},"calicoctl overview")," for a full list of calicoctl commands."),(0,n.kt)("h2",{id:"displaying-the-help-text-for-calicoctl-ipam-release-command"},"Displaying the help text for 'calicoctl ipam release' command"),(0,n.kt)("p",null,"Run ",(0,n.kt)("inlineCode",{parentName:"p"},"calicoctl ipam release --help")," to display the following help menu for the\ncommand."),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre"},"Usage:\n  calicoctl ipam release [--ip=<IP>] [--from-report=<REPORT>] [--config=<CONFIG>]\n\nOptions:\n  -h --help                   Show this screen.\n     --ip=<IP>                IP address to release.\n     --from-report=<REPORT>   Release all leaked addresses from the report.\n  -c --config=<CONFIG>        Path to the file containing connection configuration in\n                              YAML or JSON format.\n                              [default: /etc/calico/calicoctl.cfg]\n\nDescription:\n  The ipam release command releases an IP address from the Calico IP Address\n  Manager that was been previously assigned to an endpoint.  When an IP address\n  is released, it becomes available for assignment to any endpoint.\n\n  Note that this does not remove the IP from any existing endpoints that may be\n  using it, so only use this command to clean up addresses from endpoints that\n  were not cleanly removed from Calico.\n")),(0,n.kt)("h3",{id:"examples"},"Examples"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-bash"},"calicoctl ipam release --ip=192.168.1.2\n")),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-bash"},"calicoctl ipam release --from-report=./report.json\n")),(0,n.kt)("h3",{id:"general-options"},"General options"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre"},"-c --config=<CONFIG>      Path to the file containing connection\n                          configuration in YAML or JSON format.\n                          [default: /etc/calico/calicoctl.cfg]\n")),(0,n.kt)("h2",{id:"see-also"},"See also"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"/calico-enterprise/3.14/operations/clis/calicoctl/install"},"Installing calicoctl"))))}m.isMDXComponent=!0}}]);