1"use strict";(self.webpackChunktigera_docs=self.webpackChunktigera_docs||[]).push([[3393],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>f});var a=n(67294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function r(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?o(Object(n),!0).forEach((function(t){i(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):o(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function l(e,t){if(null==e)return{};var n,a,i=function(e,t){if(null==e)return{};var n,a,i={},o=Object.keys(e);for(a=0;a<o.length;a++)n=o[a],t.indexOf(n)>=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a<o.length;a++)n=o[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var c=a.createContext({}),p=function(e){var t=a.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},d=function(e){var t=p(e.components);return a.createElement(c.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},s=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,o=e.originalType,c=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),s=p(n),f=i,k=s["".concat(c,".").concat(f)]||s[f]||m[f]||o;return n?a.createElement(k,r(r({ref:t},d),{},{components:n})):a.createElement(k,r({ref:t},d))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=n.length,r=new Array(o);r[0]=s;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l.mdxType="string"==typeof e?e:i,r[1]=l;for(var p=2;p<o;p++)r[p]=n[p];return a.createElement.apply(null,r)}return a.createElement.apply(null,n)}s.displayName="MDXCreateElement"},22893:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>r,default:()=>m,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var a=n(87462),i=(n(67294),n(3905));const o={description:"The command line interface tool (CLI) to manage Calico network and security policy."},r="calicoctl user reference",l={unversionedId:"reference/calicoctl/overview",id:"version-3.24/reference/calicoctl/overview",title:"calicoctl user reference",description:"The command line interface tool (CLI) to manage Calico network and security policy.",source:"@site/calico_versioned_docs/version-3.24/reference/calicoctl/overview.mdx",sourceDirName:"reference/calicoctl",slug:"/reference/calicoctl/overview",permalink:"/calico/3.24/reference/calicoctl/overview",draft:!1,editUrl:"https://github.com/tigera/docs/edit/main/calico_versioned_docs/version-3.24/reference/calicoctl/overview.mdx",tags:[],version:"3.24",frontMatter:{description:"The command line interface tool (CLI) to manage Calico network and security policy."},sidebar:"calicoSidebar",previous:{title:"calicoctl",permalink:"/calico/3.24/reference/calicoctl/"},next:{title:"calicoctl create",permalink:"/calico/3.24/reference/calicoctl/create"}},c={},p=[{value:"Top level help",id:"top-level-help",level:2},{value:"Top level command line options",id:"top-level-command-line-options",level:2},{value:"Modifying low-level component configurations",id:"modifying-low-level-component-configurations",level:2},{value:"Supported resource definition aliases",id:"supported-resource-definition-aliases",level:2}],d={toc:p};
1function m(e){let{components:t,...n}=e;return(0,i.kt)("wrapper",(0,a.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"calicoctl-user-reference"},"calicoctl user reference"),(0,i.kt)("p",null,"The command line tool, ",(0,i.kt)("inlineCode",{parentName:"p"},"calicoctl"),", makes it easy to manage Calico\nnetwork and security policy, as well as other Calico configurations."),(0,i.kt)("p",null,"The full list of resources that can be managed, including a description of each,\nis described in the ",(0,i.kt)("a",{parentName:"p",href:"/calico/3.24/reference/resources/overview"},"Resource definitions"),"\nsection."),(0,i.kt)("admonition",{type:"note"},(0,i.kt)("p",{parentName:"admonition"},"This section provides full reference information for ",(0,i.kt)("inlineCode",{parentName:"p"},"calicoctl"),". To learn\nhow to install and configure ",(0,i.kt)("inlineCode",{parentName:"p"},"calicoctl"),", refer to\n",(0,i.kt)("a",{parentName:"p",href:"/calico/3.24/operations/calicoctl/install"},"Installing calicoctl"),".")),(0,i.kt)("p",null,"The calicoctl command line interface provides a number of resource management\ncommands to allow you to create, modify, delete, and view the different\nCalico resources. This section is a command line reference for\n",(0,i.kt)("inlineCode",{parentName:"p"},"calicoctl"),", organized based on the command hierarchy."),(0,i.kt)("h2",{id:"top-level-help"},"Top level help"),(0,i.kt)("p",null,"Run ",(0,i.kt)("inlineCode",{parentName:"p"},"calicoctl --help")," to display the following help menu for the top level\ncalicoctl commands."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre"},"Usage:\n calicoctl [options] <command> [<args>...]\n\n create Create a resource by file, directory or stdin.\n replace Replace a resource by file, directory or stdin.\n apply Apply a resource by file, directory or stdin. This creates a resource\n if it does not exist, and replaces a resource if it does exists.\n patch Patch a pre-existing resource in place.\n delete Delete a resource identified by file, directory, stdin or resource type and\n name.\n get Get a resource identified by file, directory, stdin or resource type and\n name.\n label Add or update labels of resources.\n convert Convert config files between different API versions.\n ipam IP address management.\n node Calico node management.\n version Display the version of calicoctl.\n\nOptions:\n -h --help Show this screen.\n -l --log-level=<level> Set the log level (one of panic, fatal, error,\n warn, info, debug) [default: panic]\n --context=<context> The name of the kubeconfig context to use.\n --allow-version-mismatch Allow client and cluster versions mismatch.\n\nDescription:\n The calicoctl command line tool is used to manage Calico network and security\n policy, to view and manage endpoint configuration, and to manage a Calico\n node instance.\n\n See 'calicoctl <command> --help' to read about a specific subcommand.\n")),(0,i.kt)("admonition",{type:"note"},(0,i.kt)("p",{parentName:"admonition"},"In a multi cluster environment if you have a ",(0,i.kt)("a",{parentName:"p",href:"https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/"},"kubeconfig")," file with multiple cluster contexts it is possible to directly change the context using calicoctl ",(0,i.kt)("inlineCode",{parentName:"p"},"--context")," argument.")),(0,i.kt)("admonition",{type:"note"},(0,i.kt)("p",{parentName:"admonition"},"The versions for Calico and calicoctl should be the same and calls to calicoctl will fail if the versions do not match. If needed, this can be overridden by using the ",(0,i.kt)("inlineCode",{parentName:"p"},"--allow-version-mismatch")," argument.")),(0,i.kt)("h2",{id:"top-level-command-line-options"},"Top level command line options"),(0,i.kt)("p",null,"Details on the ",(0,i.kt)("inlineCode",{parentName:"p"},"calicoctl")," commands are described in the documents linked below\norganized by top level command."),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/calico/3.24/reference/calicoctl/create"},"calicoctl create")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/calico/3.24/reference/calicoctl/replace"},"calicoctl replace")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/calico/3.24/reference/calicoctl/apply"},"calicoctl apply")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/calico/3.24/reference/calicoctl/patch"},"calicoctl patch")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/calico/3.24/reference/calicoctl/delete"},"calicoctl delete")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/calico/3.24/reference/calicoctl/get"},"calicoctl get")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/calico/3.24/reference/calicoctl/label"},"calicoctl label")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/calico/3.24/reference/calicoctl/convert"},"calicoctl convert")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/calico/3.24/reference/calicoctl/ipam/overview"},"calicoctl ipam")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/calico/3.24/reference/calicoctl/node/"},"calicoctl node")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"/calico/3.24/reference/calicoctl/version"},"calicoctl version"))),(0,i.kt)("h2",{id:"modifying-low-level-component-configurations"},"Modifying low-level component configurations"),(0,i.kt)("p",null,"In order to update low-level Felix or BGP settings (",(0,i.kt)("inlineCode",{parentName:"p"},"FelixConfiguration")," and ",(0,i.kt)("inlineCode",{parentName:"p"},"BGPConfiguration")," resource types):"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},"Get the appropriate resource and store the yaml output in a file using ",(0,i.kt)("inlineCode",{parentName:"li"},"calicoctl get <resource type> <resource name> -o yaml --export > config.yaml"),"."),(0,i.kt)("li",{parentName:"ol"},"Modify the saved resource file."),(0,i.kt)("li",{parentName:"ol"},"Update the resource using ",(0,i.kt)("inlineCode",{parentName:"li"},"apply")," or ",(0,i.kt)("inlineCode",{parentName:"li"},"replace")," command: ",(0,i.kt)("inlineCode",{parentName:"li"},"calicoctl replace -f config.yaml"),".")),(0,i.kt)("p",null,"See ",(0,i.kt)("a",{parentName:"p",href:"/calico/3.24/reference/felix/configuration"},"Configuring Felix")," for more details."),(0,i.kt)("h2",{id:"supported-resource-definition-aliases"},"Supported resource definition aliases"),(0,i.kt)("p",null,"The following table lists supported aliases for Calico resources when using ",(0,i.kt)("inlineCode",{parentName:"p"},"calicoctl"),". Note that all aliases\nare ",(0,i.kt)("strong",{parentName:"p"},"case insensitive"),"."),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"left"},"Resource definition"),(0,i.kt)("th",{parentName:"tr",align:"left"},"Supported calicoctl aliases"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},"BGP configuration"),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"bgpconfig"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"bgpconfigurations"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"bgpconfigs"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},"BGP peer"),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"bgppeer"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"bgppeers"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"bgpp"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"bgpps"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"bp"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"bps"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},"Felix configuration"),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"felixconfiguration"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"felixconfig"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"felixconfigurations"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"felixconfigs"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},"Global network policy"),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"globalnetworkpolicy"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"globalnetworkpolicies"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"gnp"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"gnps"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},"Global network set"),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"globalnetworkset"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"globalnetworksets"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},"Host endpoint"),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"hostendpoint"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"hostendpoints"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"hep"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"heps"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},"IP pool"),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"ippool"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"ippools"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"ipp"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"ipps"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"pool"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"pools"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},"IP reservation"),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"ipreservation"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"ipreservations"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"reservation"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"reservations"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},"Kubernetes controllers configuration"),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"kubecontrollersconfiguration"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"kubecontrollersconfig"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},"Network policy"),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"networkpolicy"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"networkpolicies"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"policy"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"np"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"policies"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"pol"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"pols"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},"Node"),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"node"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"nodes"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"no"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"nos"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},"Profiles"),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"profile"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"profiles"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"pro"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"pros"))),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"left"},"Workload endpoint"),(0,i.kt)("td",{parentName:"tr",align:"left"},(0,i.kt)("inlineCode",{parentName:"td"},"workloadendpoint"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"workloadendpoints"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"wep"),", ",(0,i.kt)("inlineCode",{parentName:"td"},"weps"))))))}m.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.