https://archive-os-3-27.netlify.app/assets/js/fc906300.8bebe826.js

1"use strict";(self.webpackChunktigera_docs=self.webpackChunktigera_docs||[]).push([["2276"],{35153:function(e,c,n){n.r(c),n.d(c,{default:()=>h,frontMatter:()=>t,metadata:()=>o,assets:()=>r,toc:()=>d,contentTitle:()=>a});var o=JSON.parse('{"id":"reference/calicoctl/node/overview","title":"calicoctl node","description":"Commands for calicoctl node.","source":"@site/calico_versioned_docs/version-3.27/reference/calicoctl/node/overview.mdx","sourceDirName":"reference/calicoctl/node","slug":"/reference/calicoctl/node/overview","permalink":"/calico/3.27/reference/calicoctl/node/overview","draft":false,"unlisted":false,"editUrl":"https://github.com/tigera/docs/edit/main/calico_versioned_docs/version-3.27/reference/calicoctl/node/overview.mdx","tags":[],"version":"3.27","frontMatter":{"description":"Commands for calicoctl node."},"sidebar":"calicoSidebar","previous":{"title":"node","permalink":"/calico/3.27/reference/calicoctl/node/"},"next":{"title":"calicoctl node run","permalink":"/calico/3.27/reference/calicoctl/node/run"}}'),i=n("85893"),l=n("50065");let t={description:"Commands for calicoctl node."},a="calicoctl node",r={},d=[{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}];function s(e){let c={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,l.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(c.header,{children:(0,i.jsx)(c.h1,{id:"calicoctl-node",children:"calicoctl node"})}),"\n",(0,i.jsxs)(c.p,{children:["This section describes the ",(0,i.jsx)(c.code,{children:"calicoctl node"})," commands."]}),"\n",(0,i.jsxs)(c.p,{children:["Read the ",(0,i.jsx)(c.a,{href:"/calico/3.27/reference/calicoctl/overview",children:"calicoctl Overview"}),"\nfor a full list of calicoctl commands."]}),"\n",(0,i.jsxs)(c.p,{children:["Note that if you run ",(0,i.jsx)(c.code,{children:"calicoctl"})," in a container, ",(0,i.jsx)(c.code,{children:"calicoctl node ..."})," commands will\nnot work (they need access to parts of the host filesystem)."]}),"\n",(0,i.jsx)(c.h2,{id:"displaying-the-help-text-for-calicoctl-node-commands",children:"Displaying the help text for 'calicoctl node' commands"}),"\n",(0,i.jsxs)(c.p,{children:["Run ",(0,i.jsx)(c.code,{children:"calicoctl node --help"})," to display the following help menu for the\ncommands."]}),"\n",(0,i.jsx)(c.pre,{children:(0,i.jsx)(c.code,{children:"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"})}),"\n",(0,i.jsx)(c.h2,{id:"node-specific-commands",children:"Node specific commands"}),"\n",(0,i.jsxs)(c.p,{children:["Details on the ",(0,i.jsx)(c.code,{children:"calicoctl node"})," commands are described in the documents linked below\norganized by sub command."]}),"\n",(0,i.jsxs)(c.ul,{children:["\n",(0,i.jsx)(c.li,{children:(0,i.jsx)(c.a,{href:"/calico/3.27/reference/calicoctl/node/run",children:"calicoctl node run"})}),"\n",(0,i.jsx)(c.li,{children:(0,i.jsx)(c.a,{href:"/calico/3.27/reference/calicoctl/node/status",children:"calicoctl node status"})}),"\n",(0,i.jsx)(c.li,{children:(0,i.jsx)(c.a,{href:"/calico/3.27/reference/calicoctl/node/diags",children:"calicoctl node diags"})}),"\n",(0,i.jsx)(c.li,{children:(0,i.jsx)(c.a,{href:"/calico/3.27/reference/calicoctl/node/checksystem",children:"calicoctl node checksystem"})}),"\n"]})]})}function h(e={}){let{wrapper:c}={...(0,l.a)(),...e.components};return c?(0,i.jsx)(c,{...e,children:(0,i.jsx)(s,{...e})}):s(e)}},50065:function(e,c,n){n.d(c,{Z:function(){return a},a:function(){return t}});var o=n(67294);let i={},l=o.createContext(i);function t(e){let c=o.useContext(l);return o.useMemo(function(){return"function"==typeof e?e(c):{...c,...e}},[c,e])}function a(e){let c;return c=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:t(e.components),o.createElement(l.Provider,{value:c},e.children)}}}]);