https://archive-ce-3-14.netlify.app/assets/js/0c3ac51a.12f42e48.js

1"use strict";(self.webpackChunktigera_docs=self.webpackChunktigera_docs||[]).push([[357],{3905:(e,n,t)=>{t.d(n,{Zo:()=>d,kt:()=>u});var c=t(67294);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function r(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);n&&(c=c.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,c)}return t}function i(e){for(var n=1;n<arguments.length;n++){var t=null!=arguments[n]?arguments[n]:{};n%2?r(Object(t),!0).forEach((function(n){o(e,n,t[n])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):r(Object(t)).forEach((function(n){Object.defineProperty(e,n,Object.getOwnPropertyDescriptor(t,n))}))}return e}function l(e,n){if(null==e)return{};var t,c,o=function(e,n){if(null==e)return{};var t,c,o={},r=Object.keys(e);for(c=0;c<r.length;c++)t=r[c],n.indexOf(t)>=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(c=0;c<r.length;c++)t=r[c],n.indexOf(t)>=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var a=c.createContext({}),s=function(e){var n=c.useContext(a),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},d=function(e){var n=s(e.components);return c.createElement(a.Provider,{value:n},e.children)},p={inlineCode:"code",wrapper:function(e){var n=e.children;return c.createElement(c.Fragment,{},n)}},m=c.forwardRef((function(e,n){var t=e.components,o=e.mdxType,r=e.originalType,a=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),m=s(t),u=o,f=m["".concat(a,".").concat(u)]||m[u]||p[u]||r;return t?c.createElement(f,i(i({ref:n},d),{},{components:t})):c.createElement(f,i({ref:n},d))}));function u(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var r=t.length,i=new Array(r);i[0]=m;var l={};for(var a in n)hasOwnProperty.call(n,a)&&(l[a]=n[a]);l.originalType=e,l.mdxType="string"==typeof e?e:o,i[1]=l;for(var s=2;s<r;s++)i[s]=t[s];return c.createElement.apply(null,i)}return c.createElement.apply(null,t)}m.displayName="MDXCreateElement"},2440:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>i,default:()=>p,frontMatter:()=>r,metadata:()=>l,toc:()=>s});var c=t(87462),o=(t(67294),t(3905));const r={description:"Commands for calicoctl node."},i="calicoctl node",l={unversionedId:"reference/clis/calicoctl/node/overview",id:"version-3.14/reference/clis/calicoctl/node/overview",title:"calicoctl node",description:"Commands for calicoctl node.",source:"@site/calico-enterprise_versioned_docs/version-3.14/reference/clis/calicoctl/node/overview.mdx",sourceDirName:"reference/clis/calicoctl/node",slug:"/reference/clis/calicoctl/node/overview",permalink:"/calico-enterprise/3.14/reference/clis/calicoctl/node/overview",draft:!1,editUrl:"https://github.com/tigera/docs/edit/main/calico-enterprise_versioned_docs/version-3.14/reference/clis/calicoctl/node/overview.mdx",tags:[],version:"3.14",frontMatter:{description:"Commands for calicoctl node."},sidebar:"calicoEnterpriseSidebar",previous:{title:"node",permalink:"/calico-enterprise/3.14/reference/clis/calicoctl/node/"},next:{title:"calicoctl node run",permalink:"/calico-enterprise/3.14/reference/clis/calicoctl/node/run"}},a={},s=[{value:"Displaying the help text for &#39;calicoctl node&#39; commands",id:"displaying-the-help-text-for-calicoctl-node-commands",level:2},{value:"Node specific commands",id:"node-specific-commands",level:2}],d={toc:s};function p(e){let{components:n,...t}=e;return(0,o.kt)("wrapper",(0,c.Z)({},d,t,{components:n,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"calicoctl-node"},"calicoctl node"),(0,o.kt)("p",null,"This section describes the ",(0,o.kt)("inlineCode",{parentName:"p"},"calicoctl node")," commands."),(0,o.kt)("p",null,"Read the ",(0,o.kt)("a",{parentName:"p",href:"/calico-enterprise/3.14/reference/clis/calicoctl/overview"},"calicoctl Overview"),"\nfor a full list of calicoctl commands."),(0,o.kt)("p",null,"Note that if you run ",(0,o.kt)("inlineCode",{parentName:"p"},"calicoctl")," in a container, ",(0,o.kt)("inlineCode",{parentName:"p"},"calicoctl node ...")," commands will\nnot work (they need access to parts of the host filesystem)."),(0,o.kt)("h2",{id:"displaying-the-help-text-for-calicoctl-node-commands"},"Displaying the help text for 'calicoctl node' commands"),(0,o.kt)("p",null,"Run ",(0,o.kt)("inlineCode",{parentName:"p"},"calicoctl node --help")," to display the following help menu for the\ncommands."),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"}

1,"Usage:\n  calicoctl node <command> [<args>...]\n\n    run          Run the Calico node container image\n    status       View the current status of a Calico node.\n    diags        Gather a diagnostics bundle for a Calico node.\n    checksystem  Verify the compute host is able to run a Calico node instance.\n\nOptions:\n  -h --help      Show this screen.\n\nDescription:\n  Node specific commands for calicoctl.  These commands must be run directly on\n  the compute host running the Calico node instance.\n\n  See 'calicoctl node <command> --help' to read about a specific subcommand.\n")),(0,o.kt)("h2",{id:"node-specific-commands"},"Node specific commands"),(0,o.kt)("p",null,"Details on the ",(0,o.kt)("inlineCode",{parentName:"p"},"calicoctl node")," commands are described in the documents linked below\norganized by sub command."),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/calico-enterprise/3.14/reference/clis/calicoctl/node/run"},"calicoctl node run")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/calico-enterprise/3.14/reference/clis/calicoctl/node/status"},"calicoctl node status")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/calico-enterprise/3.14/reference/clis/calicoctl/node/diags"},"calicoctl node diags")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"/calico-enterprise/3.14/reference/clis/calicoctl/node/checksystem"},"calicoctl node checksystem"))))}p.isMDXComponent=!0}}]);